2024-07-11 17:52:26 +02:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > PSR-15 Queue< / title >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< base href = "../../" >
< link rel = "icon" href = "images/favicon.ico" / >
< link rel = "stylesheet" href = "css/normalize.css" >
< link rel = "stylesheet" href = "css/base.css" >
< link rel = "preconnect" href = "https://fonts.gstatic.com" >
< link href = "https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel = "stylesheet" >
< link href = "https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel = "stylesheet" >
< link rel = "stylesheet" href = "css/template.css" >
< link rel = "stylesheet" href = "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity = "sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin = "anonymous" / >
< link rel = "stylesheet" href = "https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css" >
< link rel = "stylesheet" href = "https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css" >
< link rel = "stylesheet" href = "https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css" >
< script src = "https://cdn.jsdelivr.net/npm/fuse.js@3.4.6" > < / script >
< script src = "https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2" > < / script >
< script src = "js/template.js" > < / script >
< script src = "js/search.js" > < / script >
< script defer src = "js/searchIndex.js" > < / script >
< / head >
< body id = "top" >
< header class = "phpdocumentor-header phpdocumentor-section" >
< h1 class = "phpdocumentor-title" > < a href = "" class = "phpdocumentor-title__link" > PSR-15 Queue< / a > < / h1 >
< input class = "phpdocumentor-header__menu-button" type = "checkbox" id = "menu-button" name = "menu-button" / >
< label class = "phpdocumentor-header__menu-icon" for = "menu-button" >
< i class = "fas fa-bars" > < / i >
< / label >
< section data-search-form class = "phpdocumentor-search" >
< label >
< span class = "visually-hidden" > Search for< / span >
< svg class = "phpdocumentor-search__icon" width = "21" height = "20" viewBox = "0 0 21 20" fill = "none" xmlns = "http://www.w3.org/2000/svg" >
< circle cx = "7.5" cy = "7.5" r = "6.5" stroke = "currentColor" stroke-width = "2" / >
< line x1 = "12.4892" y1 = "12.2727" x2 = "19.1559" y2 = "18.9393" stroke = "currentColor" stroke-width = "3" / >
< / svg >
< input type = "search" class = "phpdocumentor-field phpdocumentor-search__field" placeholder = "Loading .." disabled / >
< / label >
< / section >
< nav class = "phpdocumentor-topnav" >
< ul class = "phpdocumentor-topnav__menu" >
< li class = "phpdocumentor-topnav__menu-item -menu" >
< a href = "https://packagist.org/packages/opencultureconsulting/basics" >
< span >
< i class = "fab fa-php" > < / i >
< / span >
< / a >
< / li >
< li class = "phpdocumentor-topnav__menu-item -menu" >
< a href = "https://github.com/opencultureconsulting/php-basics" >
< span >
< i class = "fab fa-github" > < / i >
< / span >
< / a >
< / li >
< / ul >
< / nav >
< / header >
< main class = "phpdocumentor" >
< div class = "phpdocumentor-section" >
< input class = "phpdocumentor-sidebar__menu-button" type = "checkbox" id = "sidebar-button" name = "sidebar-button" / >
< label class = "phpdocumentor-sidebar__menu-icon" for = "sidebar-button" >
Menu
< / label >
< aside class = "phpdocumentor-column -three phpdocumentor-sidebar" >
< section class = "phpdocumentor-sidebar__category -documentation" >
< h2 class = "phpdocumentor-sidebar__category-header" > Documentation< / h2 >
< h4 class = "phpdocumentor-sidebar__root-namespace" >
< a href = "guides/overview/index.html#overview" class = "" > Overview< / a >
< / h4 >
< ul class = "phpdocumentor-list" >
< li >
< a href = "guides/overview/queuerequesthandler.html#queuerequesthandler" class = "" > QueueRequestHandler< / a >
< / li >
< li >
< a href = "guides/overview/middlewarequeue.html#middlewarequeue" class = "" > MiddlewareQueue< / a >
< / li >
< li >
< a href = "guides/overview/abstractmiddleware.html#abstractmiddleware" class = "" > AbstractMiddleware< / a >
< / li >
< / ul >
< h4 class = "phpdocumentor-sidebar__root-namespace" >
< a href = "guides/usage/index.html#user-guide" class = "" > User Guide< / a >
< / h4 >
< ul class = "phpdocumentor-list" >
< li >
< a href = "guides/usage/requirements.html#requirements" class = "" > Requirements< / a >
< / li >
< li >
< a href = "guides/usage/installation.html#installation" class = "" > Installation< / a >
< / li >
< li >
< a href = "guides/usage/usage.html#usage" class = "" > Usage< / a >
< / li >
< / ul >
< h4 class = "phpdocumentor-sidebar__root-namespace" >
< a href = "guides/changelog.html#changelog" class = "" > Changelog< / a >
< / h4 >
< / section >
< section class = "phpdocumentor-sidebar__category -namespaces" >
< h2 class = "phpdocumentor-sidebar__category-header" > Namespaces< / h2 >
< h4 class = "phpdocumentor-sidebar__root-namespace" >
< a href = "namespaces/occ.html" class = "" > OCC< / a >
< / h4 >
< ul class = "phpdocumentor-list" >
< li >
< a href = "namespaces/occ-psr15.html" class = "" > PSR15< / a >
< / li >
< / ul >
< / section >
< section class = "phpdocumentor-sidebar__category -packages" >
< h2 class = "phpdocumentor-sidebar__category-header" > Packages< / h2 >
< h4 class = "phpdocumentor-sidebar__root-namespace" >
< a href = "packages/PSR15.html" class = "" > PSR15< / a >
< / h4 >
< / section >
< section class = "phpdocumentor-sidebar__category -reports" >
< h2 class = "phpdocumentor-sidebar__category-header" > Reports< / h2 >
< h3 class = "phpdocumentor-sidebar__root-package" > < a href = "reports/deprecated.html" > Deprecated< / a > < / h3 >
< h3 class = "phpdocumentor-sidebar__root-package" > < a href = "reports/errors.html" > Errors< / a > < / h3 >
< h3 class = "phpdocumentor-sidebar__root-package" > < a href = "reports/markers.html" > Markers< / a > < / h3 >
< / section >
< section class = "phpdocumentor-sidebar__category -indices" >
< h2 class = "phpdocumentor-sidebar__category-header" > Indices< / h2 >
< h3 class = "phpdocumentor-sidebar__root-package" > < a href = "indices/files.html" > Files< / a > < / h3 >
< / section >
< / aside >
< div class = "phpdocumentor-column -nine phpdocumentor-content" >
< div class = "section" id = "abstractmiddleware" >
< h1 > AbstractMiddleware< / h1 >
2024-07-13 15:21:05 +02:00
< div class = "admonition-wrapper" >
< div class = "admonition admonition-sidebar" > < p class = "sidebar-title" > Table of Contents< / p >
< div class = "contents" >
< ul class = "phpdocumentor-list" >
< li class = "toc-item" >
< a href = "guides/overview/abstractmiddleware.html#properties" > Properties< / a >
< / li >
< li class = "toc-item" >
< a href = "guides/overview/abstractmiddleware.html#methods" > Methods< / a >
< ul class = "section-level-2" >
< li class = "toc-item" >
< a href = "guides/overview/abstractmiddleware.html#processing-a-request" > Processing a Request< / a >
< / li >
< li class = "toc-item" >
< a href = "guides/overview/abstractmiddleware.html#processing-a-response" > Processing a Response< / a >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< / div >
< / div >
< p > The < code > AbstractMiddleware< / code >
is a little helper for creating your own middlewares. It processes the incoming request before
handing it over to the next middleware in line, and later processes the response before returning it to the previous
middleware. Originally both methods just return their argument unchanged, so you should implement either one of them or
both as needed.< / p >
< p > The < code > AbstractMiddleware< / code >
implements the
< a href = "https://www.php-fig.org/psr/psr-15/#22-psrhttpservermiddlewareinterface" > Psr\Http\Server\MiddlewareInterface< / a >
following PHP-FIG' s recommendation < a href = "https://www.php-fig.org/psr/psr-15/" > PSR-15: HTTP Server Request Handlers< / a > .< / p >
< div class = "section" id = "properties" >
< h2 > Properties< / h2 >
< p > The < code > AbstractMiddleware< / code >
has a single protected property < code > AbstractMiddleware::requestHandler< / code >
referencing the request
handler which called the middleware. This can be used to access the request and/or response object (as properties of
< a href = "guides/overview/queuerequesthandler.html" > QueueRequestHandler< / a > ) when they are otherwise not available.< / p >
< / div >
< div class = "section" id = "methods" >
< h2 > Methods< / h2 >
< p > The < code > AbstractMiddleware< / code >
provides one public API method and two protected methods. While the former is final and makes
sure it implements the < code > Psr\Http\Server\MiddlewareInterface< / code >
, the latter are intended to be extended in your own class.< / p >
< p > The main < a href = "classes/OCC-PSR15-AbstractMiddleware.html#method_process" > < abbr title = "\OCC\PSR15\AbstractMiddleware::process()" > AbstractMiddleware::process()< / abbr > < / a >
method implements the interface and is also called when
invoking the middleware object directly. It first passes the incoming request to the
< a href = "classes/OCC-PSR15-AbstractMiddleware.html#method_processRequest" > < abbr title = "\OCC\PSR15\AbstractMiddleware::processRequest()" > AbstractMiddleware::processRequest()< / abbr > < / a >
method, then hands over the result to the request handler
to receive a response, which is then processed by < a href = "classes/OCC-PSR15-AbstractMiddleware.html#method_processResponse" > < abbr title = "\OCC\PSR15\AbstractMiddleware::processResponse()" > AbstractMiddleware::processResponse()< / abbr > < / a >
before
returning it back to the request handler again.< / p >
< div class = "section" id = "processing-a-request" >
< h3 > Processing a Request< / h3 >
< p > The default method of < code > AbstractMiddleware< / code >
just returns the request unchanged. If you need to process the request, you
have to implement your own < code > processRequest()< / code >
method. It takes a request object as only argument and must return a
valid request object as well. Just make sure it follows PHP-FIG' s standard recommendation
< a href = "https://www.php-fig.org/psr/psr-7/" > PSR-7: HTTP Message Interfaces< / a > and implements the
< a href = "https://www.php-fig.org/psr/psr-7/#321-psrhttpmessageserverrequestinterface" > Psr\Http\Message\ServerRequestInterface< / a > .< / p >
< / div >
< div class = "section" id = "processing-a-response" >
< h3 > Processing a Response< / h3 >
< p > The default method of < code > AbstractMiddleware< / code >
just returns the response unchanged. If you need to process the response,
you have to implement your own < code > processResponse()< / code >
method. It takes a response object as only argument and must return
a valid response object as well. Just make sure it follows PHP-FIG' s standard recommendation
< a href = "https://www.php-fig.org/psr/psr-7/" > PSR-7: HTTP Message Interfaces< / a > and implements the
< a href = "https://www.php-fig.org/psr/psr-7/#33-psrhttpmessageresponseinterface" > Psr\Http\Message\ResponseInterface< / a > .< / p >
< / div >
< / div >
2024-07-11 17:52:26 +02:00
< / div >
< / div >
< section data-search-results class = "phpdocumentor-search-results phpdocumentor-search-results--hidden" >
< section class = "phpdocumentor-search-results__dialog" >
< header class = "phpdocumentor-search-results__header" >
< h2 class = "phpdocumentor-search-results__title" > Search results< / h2 >
< button class = "phpdocumentor-search-results__close" > < i class = "fas fa-times" > < / i > < / button >
< / header >
< section class = "phpdocumentor-search-results__body" >
< ul class = "phpdocumentor-search-results__entries" > < / ul >
< / section >
< / section >
< / section >
< / div >
< a href = "#top" class = "phpdocumentor-back-to-top" > < i class = "fas fa-chevron-circle-up" > < / i > < / a >
< / main >
< script >
cssVars({});
< / script >
< script src = "https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js" > < / script >
< script src = "https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js" > < / script >
< script src = "https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js" > < / script >
< script src = "https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js" > < / script >
< / body >
< / html >
