| Next revision | Previous revision |
| scriptlog:lib:controller:queryapicontroller [2026/09/26 09:09] – admin admin | scriptlog:lib:controller:queryapicontroller [2026/09/26 09:34] (current) – admin admin |
|---|
| ======= Inheritance ======= | ======= Inheritance ======= |
| |
| ^ Relation ^ Type ^ Meaning ^ | ^ Relation ^ Type ^ Meaning ^ |
| | extends | [[scriptlog:lib:controller:apicontroller|''ApiController'']] | parent class/interface | | | extends | [[scriptlog:lib:controller:apicontroller|''ApiController'']] | parent class/interface | |
| |
| ======= Constants (0) ======= | ======= Constants (0) ======= |
| //None.// | //None.// |
| |
| ======= Properties (0) ======= | ======= Properties (1) ======= |
| |
| //None declared.// | ^ Visibility ^ Type ^ Name ^ Default ^ Line ^ |
| | | ''private'' | ''(untyped)'' | ''$postService'' | | 44 | |
| |
| ======= Methods (5) ======= | ======= Methods (5) ======= |
| |
| ^ Visibility ^ Method ^ Summary ^ Line ^ | ^ Visibility ^ Method ^ Summary ^ Line ^ |
| | public | ''__construct()'' | Constructor | 49 | | | public | ''__construct()'' | Constructor | 49 | |
| | public | ''index()'' | Generic query endpoint. | 68 | | | public | ''index()'' | Generic query endpoint. | 68 | |
| | public | ''posts()'' | Query posts only. | 109 | | | public | ''posts()'' | Query posts only. | 109 | |
| | public | ''pages()'' | Query pages only. | 140 | | | public | ''pages()'' | Query pages only. | 140 | |
| | private | ''executeQuery()'' | Execute a query based on keyword and type. | 170 | | | private | ''executeQuery()'' | Execute a query based on keyword and type. | 170 | |
| |
| |
| that would be impractical to encode as URI query parameters. | that would be impractical to encode as URI query parameters. |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$_params'' | ''(untyped)'' | ''[]'' | //none// | | | ''$_params'' | ''(untyped)'' | ''[]'' | //none// | |
| |
| **Returns:** ''(none declared)'' — void | **Returns:** ''(none declared)'' — void |
| QUERY /api/v1/query/posts | QUERY /api/v1/query/posts |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$_params'' | ''(untyped)'' | ''[]'' | //none// | | | ''$_params'' | ''(untyped)'' | ''[]'' | //none// | |
| |
| **Returns:** ''(none declared)'' — void | **Returns:** ''(none declared)'' — void |
| QUERY /api/v1/query/pages | QUERY /api/v1/query/pages |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$_params'' | ''(untyped)'' | ''[]'' | //none// | | | ''$_params'' | ''(untyped)'' | ''[]'' | //none// | |
| |
| **Returns:** ''(none declared)'' — void | **Returns:** ''(none declared)'' — void |
| Execute a query based on keyword and type. | Execute a query based on keyword and type. |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$keyword'' | ''(untyped)'' | //required// | //none// | | | ''$keyword'' | ''(untyped)'' | //required// | //none// | |
| | ''$type'' | ''(untyped)'' | //required// | //none// | | | ''$type'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' — array | **Returns:** ''(none declared)'' — array |
| ======= Imports ======= | ======= Imports ======= |
| |
| ^ Alias ^ Fully-qualified name ^ | ^ Alias ^ Fully-qualified name ^ |
| | ''ApiController'' | [[scriptlog:lib:controller:apicontroller|''Scriptlog\Controller\ApiController'']] | | | ''ApiController'' | [[scriptlog:lib:controller:apicontroller|''Scriptlog\Controller\ApiController'']] | |
| | ''ApiHateoas'' | [[scriptlog:lib:core:apihateoas|''Scriptlog\Core\ApiHateoas'']] | | | ''ApiHateoas'' | [[scriptlog:lib:core:apihateoas|''Scriptlog\Core\ApiHateoas'']] | |
| | ''ApiResponse'' | [[scriptlog:lib:core:apiresponse|''Scriptlog\Core\ApiResponse'']] | | | ''ApiResponse'' | [[scriptlog:lib:core:apiresponse|''Scriptlog\Core\ApiResponse'']] | |
| | ''FormValidator'' | [[scriptlog:lib:core:formvalidator|''Scriptlog\Core\FormValidator'']] | | | ''FormValidator'' | [[scriptlog:lib:core:formvalidator|''Scriptlog\Core\FormValidator'']] | |
| | ''Sanitize'' | [[scriptlog:lib:core:sanitize|''Scriptlog\Core\Sanitize'']] | | | ''Sanitize'' | [[scriptlog:lib:core:sanitize|''Scriptlog\Core\Sanitize'']] | |
| | ''PostDao'' | [[scriptlog:lib:dao:postdao|''Scriptlog\Dao\PostDao'']] | | | ''PostDao'' | [[scriptlog:lib:dao:postdao|''Scriptlog\Dao\PostDao'']] | |
| | ''PostService'' | [[scriptlog:lib:service:postservice|''Scriptlog\Service\PostService'']] | | | ''PostService'' | [[scriptlog:lib:service:postservice|''Scriptlog\Service\PostService'']] | |
| |
| |
