<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Documentation</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=Source+Sans+Pro:wght@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/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">Documentation</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"> </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 -four phpdocumentor-sidebar"> <section class="phpdocumentor-sidebar__category"> <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/indexlite.html" class="">IndexLite</a> </h4> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/jsonstream.html" class="">JSONStream</a> </h4> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/lime.html" class="">Lime</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="namespaces/lime-helper.html" class="">Helper</a> </li> </ul> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/memorystorage.html" class="">MemoryStorage</a> </h4> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/mongohybrid.html" class="">MongoHybrid</a> </h4> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/mongolite.html" class="">MongoLite</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="namespaces/mongolite-aggregation.html" class="">Aggregation</a> </li> </ul> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/psr.html" class="">Psr</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="namespaces/psr-cache.html" class="">Cache</a> </li> <li> <a href="namespaces/psr-container.html" class="">Container</a> </li> <li> <a href="namespaces/psr-http.html" class="">Http</a> </li> <li> <a href="namespaces/psr-log.html" class="">Log</a> </li> </ul> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/baconqrcode.html" class="">BaconQrCode</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="namespaces/baconqrcode-common.html" class="">Common</a> </li> <li> <a href="namespaces/baconqrcode-encoder.html" class="">Encoder</a> </li> <li> <a href="namespaces/baconqrcode-exception.html" class="">Exception</a> </li> <li> <a href="namespaces/baconqrcode-renderer.html" class="">Renderer</a> </li> </ul> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/claviska.html" class="">claviska</a> </h4> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/colinodell.html" class="">ColinODell</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="namespaces/colinodell-json5.html" class="">Json5</a> </li> </ul> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/composer.html" class="">Composer</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="namespaces/composer-autoload.html" class="">Autoload</a> </li> </ul> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/dasprid.html" class="">DASPRiD</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="namespaces/dasprid-enum.html" class="">Enum</a> </li> </ul> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/doctrine.html" class="">Doctrine</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="namespaces/doctrine-common.html" class="">Common</a> </li> </ul> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/firebase.html" class="">Firebase</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="namespaces/firebase-jwt.html" class="">JWT</a> </li> </ul> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/guzzlehttp.html" class="">GuzzleHttp</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="namespaces/guzzlehttp-cookie.html" class="">Cookie</a> </li> <li> <a href="namespaces/guzzlehttp-exception.html" class="">Exception</a> </li> <li> <a href="namespaces/guzzlehttp-handler.html" class="">Handler</a> </li> <li> <a href="namespaces/guzzlehttp-promise.html" class="">Promise</a> </li> <li> <a href="namespaces/guzzlehttp-psr7.html" class="">Psr7</a> </li> </ul> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/jean85.html" class="">Jean85</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="namespaces/jean85-exception.html" class="">Exception</a> </li> </ul> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/league.html" class="">League</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="namespaces/league-colorextractor.html" class="">ColorExtractor</a> </li> <li> <a href="namespaces/league-flysystem.html" class="">Flysystem</a> </li> <li> <a href="namespaces/league-mimetypedetection.html" class="">MimeTypeDetection</a> </li> </ul> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/zipstream.html" class="">ZipStream</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="namespaces/zipstream-exception.html" class="">Exception</a> </li> </ul> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/mongodb.html" class="">MongoDB</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="namespaces/mongodb-command.html" class="">Command</a> </li> <li> <a href="namespaces/mongodb-exception.html" class="">Exception</a> </li> <li> <a href="namespaces/mongodb-gridfs.html" class="">GridFS</a> </li> <li> <a href="namespaces/mongodb-model.html" class="">Model</a> </li> <li> <a href="namespaces/mongodb-operation.html" class="">Operation</a> </li> </ul> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/phpmailer.html" class="">PHPMailer</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="namespaces/phpmailer-phpmailer.html" class="">PHPMailer</a> </li> </ul> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/robthree.html" class="">RobThree</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="namespaces/robthree-auth.html" class="">Auth</a> </li> </ul> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/testsdependency.html" class="">TestsDependency</a> </h4> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/symfony.html" class="">Symfony</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="namespaces/symfony-component.html" class="">Component</a> </li> <li> <a href="namespaces/symfony-polyfill.html" class="">Polyfill</a> </li> <li> <a href="namespaces/symfony-contracts.html" class="">Contracts</a> </li> </ul> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/graphql.html" class="">GraphQL</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="namespaces/graphql-error.html" class="">Error</a> </li> <li> <a href="namespaces/graphql-exception.html" class="">Exception</a> </li> <li> <a href="namespaces/graphql-executor.html" class="">Executor</a> </li> <li> <a href="namespaces/graphql-experimental.html" class="">Experimental</a> </li> <li> <a href="namespaces/graphql-language.html" class="">Language</a> </li> <li> <a href="namespaces/graphql-server.html" class="">Server</a> </li> <li> <a href="namespaces/graphql-type.html" class="">Type</a> </li> <li> <a href="namespaces/graphql-utils.html" class="">Utils</a> </li> <li> <a href="namespaces/graphql-validator.html" class="">Validator</a> </li> </ul> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/openapi.html" class="">OpenApi</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="namespaces/openapi-annotations.html" class="">Annotations</a> </li> <li> <a href="namespaces/openapi-logger.html" class="">Logger</a> </li> <li> <a href="namespaces/openapi-processors.html" class="">Processors</a> </li> </ul> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/app.html" class="">App</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="namespaces/app-command.html" class="">Command</a> </li> <li> <a href="namespaces/app-controller.html" class="">Controller</a> </li> <li> <a href="namespaces/app-graphql.html" class="">GraphQL</a> </li> <li> <a href="namespaces/app-helper.html" class="">Helper</a> </li> <li> <a href="namespaces/app-restapi.html" class="">RestApi</a> </li> </ul> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/assets.html" class="">Assets</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="namespaces/assets-controller.html" class="">Controller</a> </li> <li> <a href="namespaces/assets-helper.html" class="">Helper</a> </li> </ul> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/colorthief.html" class="">ColorThief</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="namespaces/colorthief-exception.html" class="">Exception</a> </li> <li> <a href="namespaces/colorthief-image.html" class="">Image</a> </li> </ul> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/content.html" class="">Content</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="namespaces/content-controller.html" class="">Controller</a> </li> </ul> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/collections.html" class="">Collections</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="namespaces/collections-helper.html" class="">Helper</a> </li> </ul> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/system.html" class="">System</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="namespaces/system-controller.html" class="">Controller</a> </li> <li> <a href="namespaces/system-helper.html" class="">Helper</a> </li> </ul> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/yxorp.html" class="">yxorP</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="namespaces/yxorp-app.html" class="">app</a> </li> <li> <a href="namespaces/yxorp-plugin.html" class="">plugin</a> </li> </ul> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="namespaces/phpdocumentormarkdown.html" class="">PhpDocumentorMarkdown</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="namespaces/phpdocumentormarkdown-example.html" class="">Example</a> </li> <li> <a href="namespaces/phpdocumentormarkdown-extension.html" class="">Extension</a> </li> </ul> </section> <section class="phpdocumentor-sidebar__category"> <h2 class="phpdocumentor-sidebar__category-header">Packages</h2> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="packages/Application.html" class="">Application</a> </h4> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="packages/Lime.html" class="">Lime</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="packages/Lime-Helper.html" class="">Helper</a> </li> </ul> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="packages/Authentication.html" class="">Authentication</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="packages/Authentication-JWT.html" class="">JWT</a> </li> </ul> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="packages/PHPMailer.html" class="">PHPMailer</a> </h4> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="packages/PHPMailerSomeFrenchpunctuationrequiresathinnon.html" class="">PHPMailerSomeFrenchpunctuationrequiresathinnon</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="packages/PHPMailerSomeFrenchpunctuationrequiresathinnon-breakingspaceU202Fcharacterbeforeitforexamplebeforeacolonorexclamationmark.html" class="">breakingspaceU202Fcharacterbeforeitforexamplebeforeacolonorexclamationmark</a> </li> </ul> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="packages/App.html" class="">App</a> </h4> <h4 class="phpdocumentor-sidebar__root-namespace"> <a href="packages/enshrined.html" class="">enshrined</a> </h4> <ul class="phpdocumentor-list"> <li> <a href="packages/enshrined-svgSanitize.html" class="">svgSanitize</a> </li> </ul> </section> <section class="phpdocumentor-sidebar__category"> <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"> <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 -eight phpdocumentor-content"> <ul class="phpdocumentor-breadcrumbs"> <li class="phpdocumentor-breadcrumb"><a href="namespaces/app.html">App</a></li> <li class="phpdocumentor-breadcrumb"><a href="namespaces/app-restapi.html">RestApi</a></li> </ul> <article class="phpdocumentor-element -class"> <h2 class="phpdocumentor-content__title"> Query <span class="phpdocumentor-element__extends"> extends <a href="classes/Lime-AppAware.html"><abbr title="\Lime\AppAware">AppAware</abbr></a> </span> <div class="phpdocumentor-element__package"> in package <ul class="phpdocumentor-breadcrumbs"> <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li> </ul> </div> </h2> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="app/modules/App/RestApi/Query.php"><a href="files/app-modules-app-restapi-query.html"><abbr title="app/modules/App/RestApi/Query.php">Query.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">7</span> </aside> <section class="phpdocumentor-description"></section> <h3 id="toc"> Table of Contents <a href="#toc" class="headerlink"><i class="fas fa-link"></i></a> </h3> <dl class="phpdocumentor-table-of-contents"> <dt class="phpdocumentor-table-of-contents__entry -property -public"> <a href="classes/Lime-AppAware.html#property_app">$app</a> <span> : <a href="classes/Lime-App.html"><abbr title="\Lime\App">App</abbr></a> </span> </dt> <dd></dd> <dt class="phpdocumentor-table-of-contents__entry -property -public"> <a href="classes/Lime-AppAware.html#property_context">$context</a> <span> : mixed </span> </dt> <dd></dd> <dt class="phpdocumentor-table-of-contents__entry -property -protected"> <a href="classes/App-RestApi-Query.html#property_endpoints">$endpoints</a> <span> : array<string|int, mixed> </span> </dt> <dd></dd> <dt class="phpdocumentor-table-of-contents__entry -property -protected"> <a href="classes/App-RestApi-Query.html#property_initialized">$initialized</a> <span> : bool </span> </dt> <dd></dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/Lime-AppAware.html#method___call">__call()</a> <span> : mixed </span> </dt> <dd></dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/Lime-AppAware.html#method___construct">__construct()</a> <span> : mixed </span> </dt> <dd></dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/Lime-AppAware.html#method___get">__get()</a> <span> : mixed </span> </dt> <dd></dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/Lime-AppAware.html#method___invoke">__invoke()</a> <span> : mixed </span> </dt> <dd></dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/App-RestApi-Query.html#method_addEndPoint">addEndPoint()</a> <span> : mixed </span> </dt> <dd></dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/App-RestApi-Query.html#method_init">init()</a> <span> : mixed </span> </dt> <dd></dd> <dt class="phpdocumentor-table-of-contents__entry -method -public"> <a href="classes/App-RestApi-Query.html#method_process">process()</a> <span> : mixed </span> </dt> <dd></dd> <dt class="phpdocumentor-table-of-contents__entry -method -protected"> <a href="classes/App-RestApi-Query.html#method_getRegex">getRegex()</a> <span> : mixed </span> </dt> <dd></dd> <dt class="phpdocumentor-table-of-contents__entry -method -protected"> <a href="classes/Lime-AppAware.html#method_initialize">initialize()</a> <span> : mixed </span> </dt> <dd></dd> <dt class="phpdocumentor-table-of-contents__entry -method -protected"> <a href="classes/App-RestApi-Query.html#method_isPathMatching">isPathMatching()</a> <span> : mixed </span> </dt> <dd></dd> </dl> <section class="phpdocumentor-properties"> <h3 class="phpdocumentor-elements__header" id="properties"> Properties <a href="classes/App-RestApi-Query.html#properties" class="headerlink"><i class="fas fa-link"></i></a> </h3> <article class=" phpdocumentor-element -property -public " > <h4 class="phpdocumentor-element__name" id="property_app"> $app <a href="classes/Lime-AppAware.html#property_app" class="headerlink"><i class="fas fa-link"></i></a> <span class="phpdocumentor-element__modifiers"> </span> </h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="lib/Lime/App.php"><a href="files/app-lib-lime-app.html"><abbr title="lib/Lime/App.php">App.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">1247</span> </aside> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__type"><a href="classes/Lime-App.html"><abbr title="\Lime\App">App</abbr></a></span> <span class="phpdocumentor-signature__name">$app</span> </code> <section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section> </article> <article class=" phpdocumentor-element -property -public " > <h4 class="phpdocumentor-element__name" id="property_context"> $context <a href="classes/Lime-AppAware.html#property_context" class="headerlink"><i class="fas fa-link"></i></a> <span class="phpdocumentor-element__modifiers"> </span> </h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="lib/Lime/App.php"><a href="files/app-lib-lime-app.html"><abbr title="lib/Lime/App.php">App.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">1248</span> </aside> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__type">mixed</span> <span class="phpdocumentor-signature__name">$context</span> </code> <section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section> </article> <article class=" phpdocumentor-element -property -protected " > <h4 class="phpdocumentor-element__name" id="property_endpoints"> $endpoints <a href="classes/App-RestApi-Query.html#property_endpoints" class="headerlink"><i class="fas fa-link"></i></a> <span class="phpdocumentor-element__modifiers"> </span> </h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="app/modules/App/RestApi/Query.php"><a href="files/app-modules-app-restapi-query.html"><abbr title="app/modules/App/RestApi/Query.php">Query.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">9</span> </aside> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">protected</span> <span class="phpdocumentor-signature__type">array<string|int, mixed></span> <span class="phpdocumentor-signature__name">$endpoints</span> = <span class="phpdocumentor-signature__default-value">[]</span></code> <section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section> </article> <article class=" phpdocumentor-element -property -protected " > <h4 class="phpdocumentor-element__name" id="property_initialized"> $initialized <a href="classes/App-RestApi-Query.html#property_initialized" class="headerlink"><i class="fas fa-link"></i></a> <span class="phpdocumentor-element__modifiers"> </span> </h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="app/modules/App/RestApi/Query.php"><a href="files/app-modules-app-restapi-query.html"><abbr title="app/modules/App/RestApi/Query.php">Query.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">10</span> </aside> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">protected</span> <span class="phpdocumentor-signature__type">bool</span> <span class="phpdocumentor-signature__name">$initialized</span> = <span class="phpdocumentor-signature__default-value">false</span></code> <section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section> </article> </section> <section class="phpdocumentor-methods"> <h3 class="phpdocumentor-elements__header" id="methods"> Methods <a href="classes/App-RestApi-Query.html#methods" class="headerlink"><i class="fas fa-link"></i></a> </h3> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method___call"> __call() <a href="classes/Lime-AppAware.html#method___call" class="headerlink"><i class="fas fa-link"></i></a> </h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="lib/Lime/App.php"><a href="files/app-lib-lime-app.html"><abbr title="lib/Lime/App.php">App.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">1259</span> </aside> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">__call</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$name</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$arguments</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$name</span> : <span class="phpdocumentor-signature__argument__return-type">mixed</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"></section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$arguments</span> : <span class="phpdocumentor-signature__argument__return-type">mixed</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"></section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">mixed</span> — </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method___construct"> __construct() <a href="classes/Lime-AppAware.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a> </h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="lib/Lime/App.php"><a href="files/app-lib-lime-app.html"><abbr title="lib/Lime/App.php">App.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">1250</span> </aside> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/Lime-App.html"><abbr title="\Lime\App">App</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$app</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$context</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$app</span> : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/Lime-App.html"><abbr title="\Lime\App">App</abbr></a></span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"></section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$context</span> : <span class="phpdocumentor-signature__argument__return-type">mixed</span> = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"></section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">mixed</span> — </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method___get"> __get() <a href="classes/Lime-AppAware.html#method___get" class="headerlink"><i class="fas fa-link"></i></a> </h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="lib/Lime/App.php"><a href="files/app-lib-lime-app.html"><abbr title="lib/Lime/App.php">App.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">1273</span> </aside> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">__get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$name</span> : <span class="phpdocumentor-signature__argument__return-type">mixed</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"></section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">mixed</span> — </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method___invoke"> __invoke() <a href="classes/Lime-AppAware.html#method___invoke" class="headerlink"><i class="fas fa-link"></i></a> </h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="lib/Lime/App.php"><a href="files/app-lib-lime-app.html"><abbr title="lib/Lime/App.php">App.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">1267</span> </aside> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">__invoke</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$helper</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$helper</span> : <span class="phpdocumentor-signature__argument__return-type">mixed</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"></section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">mixed</span> — </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_addEndPoint"> addEndPoint() <a href="classes/App-RestApi-Query.html#method_addEndPoint" class="headerlink"><i class="fas fa-link"></i></a> </h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="app/modules/App/RestApi/Query.php"><a href="files/app-modules-app-restapi-query.html"><abbr title="app/modules/App/RestApi/Query.php">Query.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">61</span> </aside> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">addEndPoint</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$methods</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$path</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"></section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$methods</span> : <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span> = <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"></section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">mixed</span> — </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_init"> init() <a href="classes/App-RestApi-Query.html#method_init" class="headerlink"><i class="fas fa-link"></i></a> </h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="app/modules/App/RestApi/Query.php"><a href="files/app-modules-app-restapi-query.html"><abbr title="app/modules/App/RestApi/Query.php">Query.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">12</span> </aside> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">init</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">mixed</span> — </article> <article class="phpdocumentor-element -method -public " > <h4 class="phpdocumentor-element__name" id="method_process"> process() <a href="classes/App-RestApi-Query.html#method_process" class="headerlink"><i class="fas fa-link"></i></a> </h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="app/modules/App/RestApi/Query.php"><a href="files/app-modules-app-restapi-query.html"><abbr title="app/modules/App/RestApi/Query.php">Query.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">20</span> </aside> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__name">process</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$method</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">'GET'</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string|null </span><span class="phpdocumentor-signature__argument__name">$apiKey</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$path</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"></section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$method</span> : <span class="phpdocumentor-signature__argument__return-type">string</span> = <span class="phpdocumentor-signature__argument__default-value">'GET'</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"></section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$apiKey</span> : <span class="phpdocumentor-signature__argument__return-type">string|null</span> = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"></section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">mixed</span> — </article> <article class="phpdocumentor-element -method -protected " > <h4 class="phpdocumentor-element__name" id="method_getRegex"> getRegex() <a href="classes/App-RestApi-Query.html#method_getRegex" class="headerlink"><i class="fas fa-link"></i></a> </h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="app/modules/App/RestApi/Query.php"><a href="files/app-modules-app-restapi-query.html"><abbr title="app/modules/App/RestApi/Query.php">Query.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">90</span> </aside> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">protected</span> <span class="phpdocumentor-signature__name">getRegex</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$pattern</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$pattern</span> : <span class="phpdocumentor-signature__argument__return-type">mixed</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"></section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">mixed</span> — </article> <article class="phpdocumentor-element -method -protected " > <h4 class="phpdocumentor-element__name" id="method_initialize"> initialize() <a href="classes/Lime-AppAware.html#method_initialize" class="headerlink"><i class="fas fa-link"></i></a> </h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="lib/Lime/App.php"><a href="files/app-lib-lime-app.html"><abbr title="lib/Lime/App.php">App.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">1257</span> </aside> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">protected</span> <span class="phpdocumentor-signature__name">initialize</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">mixed</span> — </article> <article class="phpdocumentor-element -method -protected " > <h4 class="phpdocumentor-element__name" id="method_isPathMatching"> isPathMatching() <a href="classes/App-RestApi-Query.html#method_isPathMatching" class="headerlink"><i class="fas fa-link"></i></a> </h4> <aside class="phpdocumentor-element-found-in"> <abbr class="phpdocumentor-element-found-in__file" title="app/modules/App/RestApi/Query.php"><a href="files/app-modules-app-restapi-query.html"><abbr title="app/modules/App/RestApi/Query.php">Query.php</abbr></a></abbr> : <span class="phpdocumentor-element-found-in__line">66</span> </aside> <code class="phpdocumentor-code phpdocumentor-signature "> <span class="phpdocumentor-signature__visibility">protected</span> <span class="phpdocumentor-signature__name">isPathMatching</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$path</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$pattern</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__reference-operator">&</span><span class="phpdocumentor-signature__argument__name">$params</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code> <section class="phpdocumentor-description"></section> <h5 class="phpdocumentor-argument-list__heading">Parameters</h5> <dl class="phpdocumentor-argument-list"> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$path</span> : <span class="phpdocumentor-signature__argument__return-type">mixed</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"></section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$pattern</span> : <span class="phpdocumentor-signature__argument__return-type">mixed</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"></section> </dd> <dt class="phpdocumentor-argument-list__entry"> <span class="phpdocumentor-signature__argument__name">$params</span> : <span class="phpdocumentor-signature__argument__return-type">mixed</span> = <span class="phpdocumentor-signature__argument__default-value">null</span> </dt> <dd class="phpdocumentor-argument-list__definition"> <section class="phpdocumentor-description"></section> </dd> </dl> <h5 class="phpdocumentor-return-value__heading">Return values</h5> <span class="phpdocumentor-signature__response_type">mixed</span> — </article> </section> <script type="text/javascript"> function loadExternalCodeSnippets(line) { Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => { var src = pre.getAttribute('data-src').replace( /\\/g, '/'); var extension = (src.match(/\.(\w+)$/) || [, ''])[1]; var language = 'php'; var code = document.createElement('code'); code.className = 'language-' + language; pre.textContent = ''; pre.setAttribute('data-line', line) code.textContent = 'Loading…'; pre.appendChild(code); var xhr = new XMLHttpRequest(); xhr.open('GET', src, true); xhr.onreadystatechange = function () { if (xhr.readyState == 4) { if (xhr.status < 400 && xhr.responseText) { code.textContent = xhr.responseText; Prism.highlightElement(code); } else if (xhr.status >= 400) { code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText; } else { code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost'; } } }; xhr.send(null); }); } var modals = document.querySelectorAll("[data-modal]"); modals.forEach(function (trigger) { trigger.addEventListener("click", function (event) { //event.preventDefault(); const modal = document.getElementById(trigger.dataset.modal); modal.classList.add("phpdocumentor-modal__open"); loadExternalCodeSnippets(trigger.dataset.line) const exits = modal.querySelectorAll("[data-exit-button]"); exits.forEach(function (exit) { exit.addEventListener("click", function (event) { event.preventDefault(); modal.classList.remove("phpdocumentor-modal__open"); }); }); }); }); </script> </article> <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> </div> <a href="classes/App-RestApi-Query.html#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>