| Next revision | Previous revision |
| scriptlog:lib:core:handlerequest [2026/09/26 09:09] – admin admin | scriptlog:lib:core:handlerequest [2026/09/26 09:34] (current) – admin admin |
|---|
| ======= Docblock Metadata ======= | ======= Docblock Metadata ======= |
| |
| ^ Tag ^ Value ^ | ^ Tag ^ Value ^ |
| | ''@category'' | Core Class | | | ''@category'' | Core Class | |
| | ''@author'' | M.Noermoehammad | | | ''@author'' | M.Noermoehammad | |
| | ''@license'' | MIT | | | ''@license'' | MIT | |
| | ''@version'' | 1.1 | | | ''@version'' | 1.1 | |
| | ''@since'' | Since Release 1.0 | | | ''@since'' | Since Release 1.0 | |
| |
| ======= Inheritance ======= | ======= Inheritance ======= |
| //None.// | //None.// |
| |
| ======= Properties (0) ======= | ======= Properties (4) ======= |
| |
| //None declared.// | ^ Visibility ^ Type ^ Name ^ Default ^ Line ^ |
| | | ''private static'' | ''static'' | ''$queryStringParsed'' | | 41 | |
| | | ''private static'' | ''static'' | ''$requestPathProcessed'' | | 48 | |
| | | ''private static'' | ''static'' | ''$frontHelper'' | | 56 | |
| | | ''private static'' | ''static ?ThemeRendererInterface'' | ''$themeRenderer'' | ''null'' | 63 | |
| |
| ======= Methods (22) ======= | ======= Methods (22) ======= |
| |
| ^ Visibility ^ Method ^ Summary ^ Line ^ | ^ Visibility ^ Method ^ Summary ^ Line ^ |
| | public static | ''setThemeRenderer()'' | Set the ThemeRendererInterface instance | 70 | | | public static | ''setThemeRenderer()'' | Set the ThemeRendererInterface instance | 70 | |
| | public static | ''handleFrontHelper()'' | handleFrontHelper | 86 | | | public static | ''handleFrontHelper()'' | handleFrontHelper | 86 | |
| | public static | ''findRequestToRules()'' | findRequestToRules | 104 | | | public static | ''findRequestToRules()'' | findRequestToRules | 104 | |
| | private static | ''findRequestToPath()'' | findRequestToPath() | 134 | | | private static | ''findRequestToPath()'' | findRequestToPath() | 134 | |
| | private static | ''isRequestToPathValid()'' | isRequestToPathValid() | 166 | | | private static | ''isRequestToPathValid()'' | isRequestToPathValid() | 166 | |
| | public static | ''isMatchedUriRequested()'' | isMatchedUriRequested() | 187 | | | public static | ''isMatchedUriRequested()'' | isMatchedUriRequested() | 187 | |
| | public static | ''isQueryStringRequested()'' | isQueryStringRequested() | 204 | | | public static | ''isQueryStringRequested()'' | isQueryStringRequested() | 204 | |
| | public static | ''checkMatchUriRequested()'' | checkMatchUriRequested() | 226 | | | public static | ''checkMatchUriRequested()'' | checkMatchUriRequested() | 226 | |
| | public static | ''allowedPathRequested()'' | allowedPathRequested | 247 | | | public static | ''allowedPathRequested()'' | allowedPathRequested | 247 | |
| | private static | ''renderTemplate()'' | renderTemplate | 269 | | | private static | ''renderTemplate()'' | renderTemplate | 269 | |
| | private static | ''deliverQuerySearch()'' | deliverQuerySearch | 293 | | | private static | ''deliverQuerySearch()'' | deliverQuerySearch | 293 | |
| | private static | ''handleDownloadRequest()'' | handleDownloadRequest | 333 | | | private static | ''handleDownloadRequest()'' | handleDownloadRequest | 333 | |
| | private static | ''handlePathBasedDownload()'' | handlePathBasedDownload | 356 | | | private static | ''handlePathBasedDownload()'' | handlePathBasedDownload | 356 | |
| | private static | ''getDownloadController()'' | (undocumented) | 382 | | | private static | ''getDownloadController()'' | (undocumented) | 382 | |
| | public static | ''deliverQueryString()'' | deliverQueryString | 398 | | | public static | ''deliverQueryString()'' | deliverQueryString | 398 | |
| | private static | ''deliverQueryPost()'' | deliverQueryPost | 450 | | | private static | ''deliverQueryPost()'' | deliverQueryPost | 450 | |
| | private static | ''deliverQueryCategory()'' | deliverQueryCategory | 473 | | | private static | ''deliverQueryCategory()'' | deliverQueryCategory | 473 | |
| | private static | ''deliverQueryPage()'' | deliverQueryPage | 496 | | | private static | ''deliverQueryPage()'' | deliverQueryPage | 496 | |
| | private static | ''deliverQueryArchive()'' | deliverQueryArchive | 519 | | | private static | ''deliverQueryArchive()'' | deliverQueryArchive | 519 | |
| | private static | ''deliverQueryTag()'' | deliverQueryTag | 535 | | | private static | ''deliverQueryTag()'' | deliverQueryTag | 535 | |
| | private static | ''deliverQueryDownload()'' | deliverQueryDownload | 551 | | | private static | ''deliverQueryDownload()'' | deliverQueryDownload | 551 | |
| | private static | ''deliverDefaultQuery()'' | deliverDefaultQuery | 569 | | | private static | ''deliverDefaultQuery()'' | deliverDefaultQuery | 569 | |
| |
| |
| Set the ThemeRendererInterface instance | Set the ThemeRendererInterface instance |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$renderer'' | [[scriptlog:lib:core:themerendererinterface|''?ThemeRendererInterface'']] | //required// | //none// | | | ''$renderer'' | [[scriptlog:lib:core:themerendererinterface|''?ThemeRendererInterface'']] | //required// | //none// | |
| |
| **Returns:** ''void'' | **Returns:** ''void'' |
| return the first match's captured parameters. | return the first match's captured parameters. |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$rules'' | ''(untyped)'' | //required// | List of route regex patterns. | | | ''$rules'' | ''(untyped)'' | //required// | List of route regex patterns. | |
| |
| **Returns:** ''(none declared)'' — array The captured matches for the first matching rule, or an empty array when no rule matches. | **Returns:** ''(none declared)'' — array The captured matches for the first matching rule, or an empty array when no rule matches. |
| isRequestToPathValid() | isRequestToPathValid() |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$args'' | ''(untyped)'' | //required// | Zero-based segment index into the request path. | | | ''$args'' | ''(untyped)'' | //required// | Zero-based segment index into the request path. | |
| |
| **Returns:** ''(none declared)'' — string|boolean The basename of the requested segment, or false when the segment does not exist. | **Returns:** ''(none declared)'' — string|boolean The basename of the requested segment, or false when the segment does not exist. |
| the whitelist, or the request targets the site root. | the whitelist, or the request targets the site root. |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$path'' | ''(untyped)'' | //required// | Whitelist of allowed first path segments. | | | ''$path'' | ''(untyped)'' | //required// | Whitelist of allowed first path segments. | |
| |
| **Returns:** ''(none declared)'' — bool True when the request may proceed, false otherwise. | **Returns:** ''(none declared)'' — bool True when the request may proceed, false otherwise. |
| the legacy global theme functions when no renderer is available. | the legacy global theme functions when no renderer is available. |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$template'' | ''(untyped)'' | //required// | Template name (without .php extension). | | | ''$template'' | ''(untyped)'' | //required// | Template name (without .php extension). | |
| | ''$statusCode'' | ''(untyped)'' | ''200'' | HTTP status code used by the legacy fallback. | | | ''$statusCode'' | ''(untyped)'' | ''200'' | HTTP status code used by the legacy fallback. | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| streams the file; otherwise the download landing page is rendered. | streams the file; otherwise the download landing page is rendered. |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$identifier'' | ''(untyped)'' | //required// | Download identifier (UUID). | | | ''$identifier'' | ''(untyped)'' | //required// | Download identifier (UUID). | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| an additional '/file' path segment. | an additional '/file' path segment. |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$firstSegment'' | ''(untyped)'' | //required// | First path segment of the request. | | | ''$firstSegment'' | ''(untyped)'' | //required// | First path segment of the request. | |
| |
| **Returns:** ''(none declared)'' — bool True when the request was handled as a download, false otherwise so the caller can continue dispatching. | **Returns:** ''(none declared)'' — bool True when the request was handled as a download, false otherwise so the caller can continue dispatching. |
| ======= Imports ======= | ======= Imports ======= |
| |
| ^ Alias ^ Fully-qualified name ^ | ^ Alias ^ Fully-qualified name ^ |
| | ''DownloadController'' | [[scriptlog:lib:controller:downloadcontroller|''Scriptlog\Controller\DownloadController'']] | | | ''DownloadController'' | [[scriptlog:lib:controller:downloadcontroller|''Scriptlog\Controller\DownloadController'']] | |
| | ''MediaDao'' | [[scriptlog:lib:dao:mediadao|''Scriptlog\Dao\MediaDao'']] | | | ''MediaDao'' | [[scriptlog:lib:dao:mediadao|''Scriptlog\Dao\MediaDao'']] | |
| | ''HandlerRegistry'' | [[scriptlog:lib:handler:handlerregistry|''Scriptlog\Handler\HandlerRegistry'']] | | | ''HandlerRegistry'' | [[scriptlog:lib:handler:handlerregistry|''Scriptlog\Handler\HandlerRegistry'']] | |
| | ''DownloadModel'' | [[scriptlog:lib:model:downloadmodel|''Scriptlog\Model\DownloadModel'']] | | | ''DownloadModel'' | [[scriptlog:lib:model:downloadmodel|''Scriptlog\Model\DownloadModel'']] | |
| | ''DownloadService'' | [[scriptlog:lib:service:downloadservice|''Scriptlog\Service\DownloadService'']] | | | ''DownloadService'' | [[scriptlog:lib:service:downloadservice|''Scriptlog\Service\DownloadService'']] | |
| | ''FrontService'' | [[scriptlog:lib:service:frontservice|''Scriptlog\Service\FrontService'']] | | | ''FrontService'' | [[scriptlog:lib:service:frontservice|''Scriptlog\Service\FrontService'']] | |
| |
| |
