diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index e2090ce3..00000000 --- a/.gitattributes +++ /dev/null @@ -1,18 +0,0 @@ -/.build export-ignore -/.github export-ignore -/.idea export-ignore -/.phan export-ignore -/.phpdoc export-ignore -/docs export-ignore -/examples export-ignore -/tests export-ignore -/.editorconfig export-ignore -/.gitattributes export-ignore -/.gitignore export-ignore -/.readthedocs.yml export-ignore -/phpcs.xml.dist export-ignore -/phpdoc.xml.dist export-ignore -/phpmd.xml.dist export-ignore -/phpunit.xml.dist export-ignore - -*.php diff=php diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml deleted file mode 100644 index fc89a673..00000000 --- a/.github/FUNDING.yml +++ /dev/null @@ -1 +0,0 @@ -ko_fi: codemasher diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml deleted file mode 100644 index 07f4cc27..00000000 --- a/.github/workflows/ci.yml +++ /dev/null @@ -1,131 +0,0 @@ -# https://help.github.com/en/categories/automating-your-workflow-with-github-actions -# https://github.com/sebastianbergmann/phpunit/blob/master/.github/workflows/ci.yml - -on: - push: - branches: - - main - pull_request: - branches: - - main - -name: "CI" - -env: - PHP_EXTENSIONS: curl, fileinfo, intl, json, mbstring, simplexml, sodium, zlib - PHP_INI_VALUES: memory_limit=-1, error_reporting=-1, display_errors=On - -jobs: - - static-code-analysis: - name: "Static Code Analysis" - - runs-on: ubuntu-latest - - strategy: - fail-fast: true - matrix: - php-version: - - "8.1" - - "8.2" - - "8.3" - - env: - PHAN_ALLOW_XDEBUG: 0 - PHAN_DISABLE_XDEBUG_WARN: 1 - - steps: - - name: "Checkout" - uses: actions/checkout@v4 - - - name: "Install PHP" - uses: shivammathur/setup-php@v2 - with: - php-version: ${{ matrix.php-version }} - extensions: ast, ${{ env.PHP_EXTENSIONS }} - ini-values: ${{ env.PHP_INI_VALUES }} - coverage: none - - - name: "Update dependencies with composer" - uses: ramsey/composer-install@v3 - - - name: "Run phan" - run: php vendor/bin/phan --target-php-version=${{ matrix.php-version }} - - - tests: - name: "Unit Tests" - needs: static-code-analysis - runs-on: ${{ matrix.os }} - - strategy: - fail-fast: false - matrix: - os: - - ubuntu-latest - - windows-latest - php-version: - - "8.1" - - "8.2" - - "8.3" - - steps: - - name: "Checkout" - uses: actions/checkout@v4 - - - name: "Fetch cacert.pem from curl.se" - run: curl -o ./tests/cacert.pem https://curl.se/ca/cacert.pem - - - name: "Install PHP with extensions" - uses: shivammathur/setup-php@v2 - with: - php-version: ${{ matrix.php-version }} - extensions: ${{ env.PHP_EXTENSIONS }} - ini-values: ${{ env.PHP_INI_VALUES }} - coverage: pcov - - - name: "Install dependencies with composer" - uses: ramsey/composer-install@v3 - - - name: "Run tests with phpunit" - run: php vendor/phpunit/phpunit/phpunit --configuration=phpunit.xml.dist - - - name: "Send code coverage report to Codecov.io" - uses: codecov/codecov-action@v4 - with: - token: ${{ secrets.CODECOV_TOKEN }} - files: .build/coverage/clover.xml - - - name: "Send code coverage report to Codacy" - uses: codacy/codacy-coverage-reporter-action@v1 - with: - project-token: ${{ secrets.CODACY_PROJECT_TOKEN }} - coverage-reports: .build/coverage/clover.xml - - - build-docs: - name: "Build and publish Docs" - - runs-on: ubuntu-latest - - steps: - - name: "Checkout sources" - uses: actions/checkout@v4 - - - name: "Install PHP" - uses: shivammathur/setup-php@v2 - with: - php-version: "8.3" - tools: phpDocumentor - extensions: simplexml - coverage: none - - - name: "Build Docs" - run: phpdoc --config=phpdoc.xml.dist - - - name: "Publish Docs to gh-pages" - uses: JamesIves/github-pages-deploy-action@v4 - with: - BRANCH: gh-pages - FOLDER: docs - CLEAN: true diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 4893a7ce..00000000 --- a/.gitignore +++ /dev/null @@ -1,10 +0,0 @@ -.build/* -.docs/* -.idea/* -vendor/* -composer.lock -*cacert.pem -phpcs.xml -phpdoc.xml -phpmd.xml -phpunit.xml diff --git a/.phan/config.php b/.phan/config.php deleted file mode 100644 index ab045b67..00000000 --- a/.phan/config.php +++ /dev/null @@ -1,59 +0,0 @@ - null, - 'minimum_target_php_version' => '8.1', - - // A list of directories that should be parsed for class and - // method information. After excluding the directories - // defined in exclude_analysis_directory_list, the remaining - // files will be statically analyzed for errors. - // - // Thus, both first-party and third-party code being used by - // your application should be included in this list. - 'directory_list' => [ - 'examples', - 'src', - 'tests', - 'vendor', - ], - - // A regex used to match every file name that you want to - // exclude from parsing. Actual value will exclude every - // "test", "tests", "Test" and "Tests" folders found in - // "vendor/" directory. - 'exclude_file_regex' => '@^vendor/.*/(tests?|Tests?)/@', - - // A directory list that defines files that will be excluded - // from static analysis, but whose class and method - // information should be included. - // - // Generally, you'll want to include the directories for - // third-party code (such as "vendor/") in this list. - // - // n.b.: If you'd like to parse but not analyze 3rd - // party code, directories containing that code - // should be added to both the `directory_list` - // and `exclude_analysis_directory_list` arrays. - 'exclude_analysis_directory_list' => [ - 'tests', - 'vendor', - ], - 'suppress_issue_types' => [ - 'PhanAccessMethodInternal', - 'PhanTypeInvalidThrowsIsInterface', - ], -]; diff --git a/LICENSE.md b/LICENSE.md deleted file mode 100644 index f7229548..00000000 --- a/LICENSE.md +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2018 smiley - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/README.md b/README.md deleted file mode 100644 index 683ddc59..00000000 --- a/README.md +++ /dev/null @@ -1,218 +0,0 @@ -# chillerlan/php-httpinterface - -A [PSR-7](https://www.php-fig.org/psr/psr-7/)/[PSR-17](https://www.php-fig.org/psr/psr-17/)/[PSR-18](https://www.php-fig.org/psr/psr-18/) HTTP message/client implementation. - -[![PHP Version Support][php-badge]][php] -[![version][packagist-badge]][packagist] -[![license][license-badge]][license] -[![Continuous Integration][gh-action-badge]][gh-action] -[![Coverage][coverage-badge]][coverage] -[![Codacy][codacy-badge]][codacy] -[![Packagist downloads][downloads-badge]][downloads] - -[php-badge]: https://img.shields.io/packagist/php-v/chillerlan/php-httpinterface?logo=php&color=8892BF -[php]: https://www.php.net/supported-versions.php -[packagist-badge]: https://img.shields.io/packagist/v/chillerlan/php-httpinterface.svg?logo=packagist -[packagist]: https://packagist.org/packages/chillerlan/php-httpinterface -[license-badge]: https://img.shields.io/github/license/chillerlan/php-httpinterface.svg -[license]: https://github.com/chillerlan/php-httpinterface/blob/main/LICENSE -[gh-action-badge]: https://img.shields.io/github/actions/workflow/status/chillerlan/php-httpinterface/ci.yml?branch=main&logo=github -[gh-action]: https://github.com/chillerlan/php-httpinterface/actions/workflows/ci.yml?query=branch%3Amain -[coverage-badge]: https://img.shields.io/codecov/c/github/chillerlan/php-httpinterface.svg?logo=codecov -[coverage]: https://codecov.io/github/chillerlan/php-httpinterface -[codacy-badge]: https://img.shields.io/codacy/grade/0ad3a5f9abe547cca5d5b3dff0ba3383?logo=codacy -[codacy]: https://app.codacy.com/gh/chillerlan/php-httpinterface/dashboard -[downloads-badge]: https://img.shields.io/packagist/dt/chillerlan/php-httpinterface.svg?logo=packagist -[downloads]: https://packagist.org/packages/chillerlan/php-httpinterface/stats - - -# Documentation - -An API documentation created with [phpDocumentor](https://www.phpdoc.org/) can be found at https://chillerlan.github.io/php-httpinterface/ (WIP). - - -## Requirements -- PHP 8.1+ - - [`ext-curl`](https://www.php.net/manual/book.curl.php) - - from dependencies: - - [`ext-fileinfo`](https://www.php.net/manual/book.fileinfo.php) - - [`ext-intl`](https://www.php.net/manual/book.intl.php) - - [`ext-json`](https://www.php.net/manual/book.json.php) - - [`ext-mbstring`](https://www.php.net/manual/book.mbstring.php) - - [`ext-simplexml`](https://www.php.net/manual/book.simplexml.php) - - [`ext-zlib`](https://www.php.net/manual/book.zlib.php) - - -## Installation with [composer](https://getcomposer.org) - -### Terminal - -``` -composer require chillerlan/php-httpinterface -``` - -### composer.json - -```json -{ - "require": { - "php": "^8.1", - "chillerlan/php-httpinterface": "dev-main#" - } -} -``` -Note: replace `dev-main` with a [version constraint](https://getcomposer.org/doc/articles/versions.md#writing-version-constraints), e.g. `^6.0` - see [releases](https://github.com/chillerlan/php-httpinterface/releases) for valid versions. - -Profit! - - -## Quickstart - -The HTTP clients `CurlClient` and `StreamClient` are invoked with a `ResponseFactoryInterface` instance -as the first parameter, followed by optional `HTTPOptions` and PSR-3 `LoggerInterface` instances. -You can then send a request via the implemented PSR-18 method `ClientInterface::sendRequest()`, -using a PSR-7 `RequestInterface` and expect a PSR-7 `ResponseInterface`. - - -### `CurlClient`, `StreamClient` - -```php -$options = new HTTPOptions; -$options->ca_info = '/path/to/cacert.pem'; -$options->user_agent = 'my cool user agent 1.0'; -$options->dns_over_https = 'https://cloudflare-dns.com/dns-query'; - -$httpClient = new CurlClient($responseFactory, $options, $logger); -$request = $requestFactory->createRequest('GET', 'https://www.example.com?foo=bar'); - -$httpClient->sendRequest($request); -``` - - -### `CurlMultiClient` - -The `CurlMultiClient` client implements asynchronous multi requests (["rolling-curl"](https://code.google.com/archive/p/rolling-curl/)). -It needs a `MultiResponseHandlerInterface` that parses the incoming responses, the callback may return a failed request to the stack: - -```php -$handler = new class () implements MultiResponseHandlerInterface{ - - public function handleResponse( - ResponseInterface $response, // the incoming response - RequestInterface $request, // the corresponding request - int $id, // the request id - array|null $curl_info, // the curl_getinfo() result for this request - ):RequestInterface|null{ - - if($response->getStatusCode() !== 200){ - // return the failed request back to the stack - return $request; - } - - try{ - $body = $response->getBody(); - - // the response body is empty for some reason, we pretend that's fine and exit - if($body->getSize() === 0){ - return null; - } - - // parse the response body, store the result etc. - $data = $body->getContents(); - - // save data to file, database or whatever... - // ... - - } - catch(Throwable){ - // something went wrong, return the request to the stack for another try - return $request; - } - - // everything ok, nothing to return - return null; - } - -}; -``` - -You can then invoke the multi request client - the `MultiResponseHandlerInterface` and `ResponseFactoryInterface` are mandatory, -`HTTPOptions` and `LoggerInterface` are optional: - -```php -$options = new HTTPOptions; -$options->ca_info = '/path/to/cacert.pem'; -$options->user_agent = 'my cool user agent 1.0'; -$options->sleep = 750000; // microseconds, see usleep() -$options->window_size = 5; -$options->retries = 1; - -$multiClient = new CurlMultiClient($handler, $responseFactory, $options, $logger); - -// create and add the requests -foreach(['..', '...', '....'] as $item){ - $multiClient->addRequest($factory->createRequest('GET', $endpoint.'/'.$item)); -} - -// process the queue -$multiClient->process(); -``` - - -### `URLExtractor` - -The `URLExtractor` wraps a PSR-18 `ClientInterface` to extract and follow shortened URLs to their original location. - -```php -$options = new HTTPOptions; -$options->user_agent = 'my cool user agent 1.0'; -$options->ssl_verifypeer = false; -$options->curl_options = [ - CURLOPT_FOLLOWLOCATION => false, - CURLOPT_MAXREDIRS => 25, -]; - -$httpClient = new CurlClient($responseFactory, $options, $logger); -$urlExtractor = new URLExtractor($httpClient, $responseFactory); - -$request = $factory->createRequest('GET', 'https://t.co/ZSS6nVOcVp'); - -$urlExtractor->sendRequest($request); // -> response from the final location - -// you can retrieve an array with all followed locations afterwards -$responses = $this->http->getResponses(); // -> ResponseInterface[] - -// if you just want the URL of the final location, you can use the extract method: -$url = $this->http->extract('https://t.co/ZSS6nVOcVp'); // -> https://api.guildwars2.com/v2/build -``` - - -### `LoggingClient` - -The `LoggingClient` wraps a `ClientInterface` and outputs the HTTP messages in a readable way through a `LoggerInterface` (do NOT use in production!). - -```php -$loggingClient = new LoggingClient($httpClient, $logger); - -$loggingClient->sendRequest($request); // -> log to output given via logger -``` - - -### Auto generated API documentation - -The API documentation can be auto generated with [phpDocumentor](https://www.phpdoc.org/). -There is an [online version available](https://chillerlan.github.io/php-httpinterface/) via the [gh-pages branch](https://github.com/chillerlan/php-httpinterface/tree/gh-pages) that is [automatically deployed](https://github.com/chillerlan/php-httpinterface/deployments) on each push to main. - -Locally created docs will appear in the directory `.build/phpdocs/`. If you'd like to create local docs, please follow these steps: - -- [download phpDocumentor](https://github.com/phpDocumentor/phpDocumentor/releases) v3+ as .phar archive -- run it in the repository root directory: - - on Windows `c:\path\to\php.exe c:\path\to\phpDocumentor.phar --config=phpdoc.xml` - - on Linux just `php /path/to/phpDocumentor.phar --config=phpdoc.xml` -- open [index.html](./.build/phpdocs/index.html) in a browser -- profit! - - -## Disclaimer - -Use at your own risk! diff --git a/classes/chillerlan-HTTP-ClientException.html b/classes/chillerlan-HTTP-ClientException.html new file mode 100644 index 00000000..ced921eb --- /dev/null +++ b/classes/chillerlan-HTTP-ClientException.html @@ -0,0 +1,308 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
+

Documentation

+ + + + + +
+ +
+
+ + + + +
+
+ + +
+

+ ClientException + + + extends Exception + + +
+ in package + +
+ + + implements + ClientExceptionInterface + +

+ +
+ + +
+ + + + + + + + + +

+ Table of Contents + + +

+ + + +

+ Interfaces + + +

+
+
ClientExceptionInterface
+ + + + + + + + + + + + + + + + +
+
+
+
+

+        
+ +
+
+ + + +
+
+
+ +
+ On this page + +
    +
  • Table Of Contents
  • +
  • +
      +
    +
  • + + +
+
+ +
+
+
+
+
+

Search results

+ +
+
+
    +
    +
    +
    +
    + + +
    + + + + + + + + diff --git a/classes/chillerlan-HTTP-CurlClient.html b/classes/chillerlan-HTTP-CurlClient.html new file mode 100644 index 00000000..2c2f7b94 --- /dev/null +++ b/classes/chillerlan-HTTP-CurlClient.html @@ -0,0 +1,854 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
    +

    Documentation

    + + + + + +
    + +
    +
    + + + + +
    +
    + + +
    +

    + CurlClient + + + extends HTTPClientAbstract + + +
    + in package + +
    + + +

    + +
    + + +
    + + + +

    A "simple" cURL http client

    + + + + + + +

    + Table of Contents + + +

    + + + + + + + + + +

    + Properties + + +

    +
    +
    + $logger + +  : LoggerInterface +
    + +
    + $options + +  : HTTPOptions|SettingsContainerInterface +
    + +
    + $responseFactory + +  : ResponseFactoryInterface +
    + +
    + $streamFactory + +  : StreamFactoryInterface|null +
    + +
    + +

    + Methods + + +

    +
    +
    + __construct() + +  : mixed +
    +
    HTTPClientAbstract constructor.
    + +
    + sendRequest() + +  : ResponseInterface +
    + +
    + setLogger() + +  : static +
    +
    Sets a PSR-3 Logger
    + +
    + setResponseFactory() + +  : static +
    +
    Sets a PSR-17 response factory
    + +
    + setStreamFactory() + +  : static +
    +
    Sets a PSR-17 stream factory
    + +
    + + + + + + + +
    +

    + Properties + + +

    +
    +

    + $logger + + + + +

    + + + + + protected + LoggerInterface + $logger + = new NullLogger() + + + + + +
    +
    +

    + $options + + + + +

    + + + + + protected + HTTPOptions|SettingsContainerInterface + $options + = new HTTPOptions() + + + + + +
    +
    +

    + $responseFactory + + + + +

    + + + + + protected + ResponseFactoryInterface + $responseFactory + + + + + + +
    +
    +

    + $streamFactory + + + + +

    + + + + + protected + StreamFactoryInterface|null + $streamFactory + = null + + + + + +
    +
    + +
    +

    + Methods + + +

    +
    +

    + __construct() + + +

    + + +

    HTTPClientAbstract constructor.

    + + + public + __construct(ResponseFactoryInterface $responseFactory[, HTTPOptions|SettingsContainerInterface $options = new HTTPOptions() ][, LoggerInterface $logger = new NullLogger() ]) : mixed + +
    +
    + +
    Parameters
    +
    +
    + $responseFactory + : ResponseFactoryInterface +
    +
    + +
    +
    + $options + : HTTPOptions|SettingsContainerInterface + = new HTTPOptions()
    +
    + +
    +
    + $logger + : LoggerInterface + = new NullLogger()
    +
    + +
    +
    + + + + +
    +
    +

    + sendRequest() + + +

    + + + + + public + sendRequest(RequestInterface $request) : ResponseInterface + +
    +
    + +
    Parameters
    +
    +
    + $request + : RequestInterface +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + inheritDoc +
    +
    + + +
    +
    + +
    +
    Return values
    + ResponseInterface +
    + +
    +
    +

    + setLogger() + + +

    + + +

    Sets a PSR-3 Logger

    + + + public + setLogger(LoggerInterface $logger) : static + +
    +
    + +
    Parameters
    +
    +
    + $logger + : LoggerInterface +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + inheritDoc +
    +
    + + +
    +
    + codeCoverageIgnore +
    +
    + + +
    +
    + +
    +
    Return values
    + static +
    + +
    +
    +

    + setResponseFactory() + + +

    + + +

    Sets a PSR-17 response factory

    + + + public + setResponseFactory(ResponseFactoryInterface $responseFactory) : static + +
    +
    + +
    Parameters
    +
    +
    + $responseFactory + : ResponseFactoryInterface +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + inheritDoc +
    +
    + + +
    +
    + codeCoverageIgnore +
    +
    + + +
    +
    + +
    +
    Return values
    + static +
    + +
    +
    +

    + setStreamFactory() + + +

    + + +

    Sets a PSR-17 stream factory

    + + + public + setStreamFactory(StreamFactoryInterface $streamFactory) : static + +
    +
    + +
    Parameters
    +
    +
    + $streamFactory + : StreamFactoryInterface +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + inheritDoc +
    +
    + + +
    +
    + codeCoverageIgnore +
    +
    + + +
    +
    + +
    +
    Return values
    + static +
    + +
    +
    + +
    +
    +
    +
    +
    
    +        
    + +
    +
    + + + +
    +
    +
    + +
    + On this page + + +
    + +
    +
    +
    +
    +
    +

    Search results

    + +
    +
    +
      +
      +
      +
      +
      + + +
      + + + + + + + + diff --git a/classes/chillerlan-HTTP-CurlHandle.html b/classes/chillerlan-HTTP-CurlHandle.html new file mode 100644 index 00000000..aed0e19e --- /dev/null +++ b/classes/chillerlan-HTTP-CurlHandle.html @@ -0,0 +1,1681 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
      +

      Documentation

      + + + + + +
      + +
      +
      + + + + +
      +
      + + +
      +

      + CurlHandle + + +
      + in package + +
      + + +

      + +
      + +
      FinalYes
      + + +
      + + + +

      Implements a cURL connection object

      + + + + + + +

      + Table of Contents + + +

      + + + + + + + +

      + Constants + + +

      +
      +
      + CURL_NETWORK_ERRORS + +  = [\CURLE_COULDNT_RESOLVE_PROXY, \CURLE_COULDNT_RESOLVE_HOST, \CURLE_COULDNT_CONNECT, \CURLE_OPERATION_TIMEOUTED, \CURLE_SSL_CONNECT_ERROR, \CURLE_GOT_NOTHING] +
      + +
      + NEVER_OVERWRITE + +  = [\CURLOPT_CAINFO, \CURLOPT_CAPATH, \CURLOPT_DOH_URL, \CURLOPT_CUSTOMREQUEST, \CURLOPT_HTTPHEADER, \CURLOPT_NOBODY, \CURLOPT_FORBID_REUSE, \CURLOPT_FRESH_CONNECT] +
      + +
      + + +

      + Properties + + +

      +
      +
      + $curl + +  : CurlHandle +
      + +
      + $curlOptions + +  : array<string|int, mixed> +
      + +
      + $handleID + +  : int +
      + +
      + $initialized + +  : bool +
      + +
      + $options + +  : HTTPOptions|SettingsContainerInterface +
      + +
      + $request + +  : RequestInterface +
      + +
      + $requestBody + +  : StreamInterface +
      + +
      + $response + +  : ResponseInterface +
      + +
      + $responseBody + +  : StreamInterface +
      + +
      + +

      + Methods + + +

      +
      +
      + __construct() + +  : mixed +
      +
      CurlHandle constructor.
      + +
      + __destruct() + +  : mixed +
      +
      close an existing cURL handle on exit
      + +
      + close() + +  : self +
      +
      closes the handle
      + +
      + exec() + +  : int +
      +
      executes the current cURL instance and returns the error number
      + +
      + getCurlOptions() + +  : array<string|int, mixed> +
      + +
      + getCurlResource() + +  : CurlHandle +
      +
      returns the internal cURL resource in its current state
      + +
      + getError() + +  : string +
      +
      returns a string containing the last error
      + +
      + getHandleID() + +  : int +
      +
      returns the handle ID (cURL resource id)
      + +
      + getInfo() + +  : array<string|int, mixed>|null +
      +
      returns the result from `curl_getinfo()` or `null` in case of an error
      + +
      + getRequest() + +  : RequestInterface +
      + +
      + getResponse() + +  : ResponseInterface +
      + +
      + init() + +  : CurlHandle|null +
      + +
      + guessCA() + +  : string +
      +
      Check default locations for the CA bundle
      + +
      + setCA() + +  : void +
      + +
      + setRequestOptions() + +  : void +
      + +
      + + + + + +
      +

      + Constants + + +

      +
      +

      + CURL_NETWORK_ERRORS + + +

      + + + + + + public + mixed + CURL_NETWORK_ERRORS + = [\CURLE_COULDNT_RESOLVE_PROXY, \CURLE_COULDNT_RESOLVE_HOST, \CURLE_COULDNT_CONNECT, \CURLE_OPERATION_TIMEOUTED, \CURLE_SSL_CONNECT_ERROR, \CURLE_GOT_NOTHING] + + + + + + + +
      +
      +

      + NEVER_OVERWRITE + + +

      + + + + + + private + mixed + NEVER_OVERWRITE + = [\CURLOPT_CAINFO, \CURLOPT_CAPATH, \CURLOPT_DOH_URL, \CURLOPT_CUSTOMREQUEST, \CURLOPT_HTTPHEADER, \CURLOPT_NOBODY, \CURLOPT_FORBID_REUSE, \CURLOPT_FRESH_CONNECT] + + + + + + + +
      +
      + + +
      +

      + Properties + + +

      +
      +

      + $curl + + + + +

      + + + + + private + CurlHandle + $curl + + + + + + +
      +
      +

      + $curlOptions + + + + +

      + + + + + private + array<string|int, mixed> + $curlOptions + = [] + + + + + +
      +
      +

      + $handleID + + + + +

      + + + + + private + int + $handleID + + + + + + +
      +
      +

      + $initialized + + + + +

      + + + + + private + bool + $initialized + = false + + + + + +
      +
      +

      + $options + + + + +

      + + + + + private + HTTPOptions|SettingsContainerInterface + $options + + + + + + +
      +
      +

      + $request + + + + +

      + + + + + private + RequestInterface + $request + + + + + + +
      +
      +

      + $requestBody + + + + +

      + + + + + private + StreamInterface + $requestBody + + + + + + +
      +
      +

      + $response + + + + +

      + + + + + private + ResponseInterface + $response + + + + + + +
      +
      +

      + $responseBody + + + + +

      + + + + + private + StreamInterface + $responseBody + + + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      CurlHandle constructor.

      + + + public + __construct(RequestInterface $request, ResponseInterface $response, HTTPOptions|SettingsContainerInterface $options[, StreamInterface|null $stream = null ]) : mixed + +
      +
      + +
      Parameters
      +
      +
      + $request + : RequestInterface +
      +
      + +
      +
      + $response + : ResponseInterface +
      +
      + +
      +
      + $options + : HTTPOptions|SettingsContainerInterface +
      +
      + +
      +
      + $stream + : StreamInterface|null + = null
      +
      + +
      +
      + + + + +
      +
      +

      + __destruct() + + +

      + + +

      close an existing cURL handle on exit

      + + + public + __destruct() : mixed + +
      +
      + + + + + +
      +
      +

      + close() + + +

      + + +

      closes the handle

      + + + public + close() : self + +
      +
      + + + + +
      +
      Return values
      + self +
      + +
      +
      +

      + exec() + + +

      + + +

      executes the current cURL instance and returns the error number

      + + + public + exec() : int + +
      +
      + + + +
      + Tags + + +
      +
      +
      + see +
      +
      + curl_exec() + + +
      +
      + see +
      +
      + curl_errno() + + +
      +
      + +
      +
      Return values
      + int +
      + +
      +
      +

      + getCurlOptions() + + +

      + + + + + public + getCurlOptions() : array<string|int, mixed> + +
      +
      + + + +
      + Tags + + +
      +
      +
      + codeCoverageIgnore +
      +
      + + +
      +
      + +
      +
      Return values
      + array<string|int, mixed> +
      + +
      +
      +

      + getCurlResource() + + +

      + + +

      returns the internal cURL resource in its current state

      + + + public + getCurlResource() : CurlHandle + +
      +
      + + + +
      + Tags + + +
      +
      +
      + codeCoverageIgnore +
      +
      + + +
      +
      + +
      +
      Return values
      + CurlHandle +
      + +
      +
      +

      + getError() + + +

      + + +

      returns a string containing the last error

      + + + public + getError() : string + +
      +
      + + + +
      + Tags + + +
      +
      +
      + see +
      +
      + curl_error() + + +
      +
      + +
      +
      Return values
      + string +
      + +
      +
      +

      + getHandleID() + + +

      + + +

      returns the handle ID (cURL resource id)

      + + + public + getHandleID() : int + +
      +
      + + + +
      + Tags + + +
      +
      +
      + codeCoverageIgnore +
      +
      + + +
      +
      + +
      +
      Return values
      + int +
      + +
      +
      +

      + getInfo() + + +

      + + +

      returns the result from `curl_getinfo()` or `null` in case of an error

      + + + public + getInfo() : array<string|int, mixed>|null + +
      +
      + + + +
      + Tags + + +
      +
      +
      + see +
      +
      + curl_getinfo() + + +
      +
      + see +
      +
      + https://www.php.net/manual/function.curl-getinfo.php#111678 + + +
      +
      + see +
      +
      + https://www.openssl.org/docs/manmaster/man1/verify.html#VERIFY_OPERATION + + +
      +
      + see +
      +
      + https://github.com/openssl/openssl/blob/91cb81d40a8102c3d8667629661be8d6937db82b/include/openssl/x509_vfy.h#L99-L189 + + +
      +
      + +
      +
      Return values
      + array<string|int, mixed>|null +
      + +
      +
      +

      + getRequest() + + +

      + + + + + public + getRequest() : RequestInterface + +
      +
      + + + +
      + Tags + + +
      +
      +
      + codeCoverageIgnore +
      +
      + + +
      +
      + +
      +
      Return values
      + RequestInterface +
      + +
      +
      +

      + getResponse() + + +

      + + + + + public + getResponse() : ResponseInterface + +
      +
      + + + +
      + Tags + + +
      +
      +
      + codeCoverageIgnore +
      +
      + + +
      +
      + +
      +
      Return values
      + ResponseInterface +
      + +
      + + +
      +

      + setCA() + + +

      + + + + + private + setCA() : void + +
      +
      + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + ClientException + + +
      +
      + + +
      +
      +

      + setRequestOptions() + + +

      + + + + + private + setRequestOptions() : void + +
      +
      + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + ClientException + + +
      +
      + + +
      +
      + +
      +
      +
      +
      +
      
      +        
      + +
      +
      + + + +
      +
      +
      + +
      + On this page + + +
      + +
      +
      +
      +
      +
      +

      Search results

      + +
      +
      +
        +
        +
        +
        +
        + + +
        + + + + + + + + diff --git a/classes/chillerlan-HTTP-CurlMultiClient.html b/classes/chillerlan-HTTP-CurlMultiClient.html new file mode 100644 index 00000000..d19571a1 --- /dev/null +++ b/classes/chillerlan-HTTP-CurlMultiClient.html @@ -0,0 +1,1213 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
        +

        Documentation

        + + + + + +
        + +
        +
        + + + + +
        +
        + + +
        +

        + CurlMultiClient + + +
        + in package + +
        + + +

        + +
        + + +
        + + + +

        Curl multi http client

        + + + + + + +

        + Table of Contents + + +

        + + + + + + + + + +

        + Properties + + +

        +
        +
        + $counter + +  : int +
        +
        the request counter (request ID/order in multi response handler)
        + +
        + $curl_multi + +  : CurlMultiHandle +
        +
        the cURL multi handle instance
        + +
        + $handles + +  : array<string|int, mixed> +
        +
        the stack of running handles
        + +
        + $logger + +  : LoggerInterface +
        + +
        + $multiResponseHandler + +  : MultiResponseHandlerInterface +
        + +
        + $options + +  : HTTPOptions|SettingsContainerInterface +
        + +
        + $requests + +  : array<string|int, mixed> +
        +
        An array of RequestInterface to run
        + +
        + $responseFactory + +  : ResponseFactoryInterface +
        + +
        + +

        + Methods + + +

        +
        +
        + __construct() + +  : mixed +
        +
        CurlMultiClient constructor.
        + +
        + __destruct() + +  : mixed +
        +
        close an existing cURL multi handle on exit
        + +
        + addRequest() + +  : static +
        +
        adds a request to the stack
        + +
        + addRequests() + +  : static +
        +
        adds multiple requests to the stack
        + +
        + close() + +  : static +
        +
        closes the handle
        + +
        + process() + +  : static +
        +
        processes the stack
        + +
        + setLogger() + +  : static +
        + +
        + createHandle() + +  : void +
        +
        creates a new request handle
        + +
        + initCurlMultiOptions() + +  : void +
        + +
        + resolve() + +  : void +
        +
        resolves the handle, calls the response handler callback and creates the next handle
        + +
        + + + + + + + +
        +

        + Properties + + +

        +
        +

        + $counter + + + + +

        + + +

        the request counter (request ID/order in multi response handler)

        + + + protected + int + $counter + = 0 + + + + + +
        +
        +

        + $curl_multi + + + + +

        + + +

        the cURL multi handle instance

        + + + protected + CurlMultiHandle + $curl_multi + + + + + + +
        +
        +

        + $handles + + + + +

        + + +

        the stack of running handles

        + + + protected + array<string|int, mixed> + $handles + = [] + +

        cURL instance id => [counter, retries, handle]

        +
        + + + + +
        +
        +

        + $logger + + + + +

        + + + + + protected + LoggerInterface + $logger + = new NullLogger() + + + + + +
        + +
        +

        + $options + + + + +

        + + + + + protected + HTTPOptions|SettingsContainerInterface + $options + = new HTTPOptions() + + + + + +
        +
        +

        + $requests + + + + +

        + + +

        An array of RequestInterface to run

        + + + protected + array<string|int, mixed> + $requests + = [] + + + + + +
        +
        +

        + $responseFactory + + + + +

        + + + + + protected + ResponseFactoryInterface + $responseFactory + + + + + + +
        +
        + +
        +

        + Methods + + +

        +
        +

        + __construct() + + +

        + + +

        CurlMultiClient constructor.

        + + + public + __construct(MultiResponseHandlerInterface $multiResponseHandler, ResponseFactoryInterface $responseFactory[, HTTPOptions|SettingsContainerInterface $options = new HTTPOptions() ][, LoggerInterface $logger = new NullLogger() ]) : mixed + +
        +
        + +
        Parameters
        +
        +
        + $multiResponseHandler + : MultiResponseHandlerInterface +
        +
        + +
        +
        + $responseFactory + : ResponseFactoryInterface +
        +
        + +
        +
        + $options + : HTTPOptions|SettingsContainerInterface + = new HTTPOptions()
        +
        + +
        +
        + $logger + : LoggerInterface + = new NullLogger()
        +
        + +
        +
        + + + + +
        +
        +

        + __destruct() + + +

        + + +

        close an existing cURL multi handle on exit

        + + + public + __destruct() : mixed + +
        +
        + + + + + +
        +
        +

        + addRequest() + + +

        + + +

        adds a request to the stack

        + + + public + addRequest(RequestInterface $request) : static + +
        +
        + +
        Parameters
        +
        +
        + $request + : RequestInterface +
        +
        + +
        +
        + + + +
        +
        Return values
        + static +
        + +
        +
        +

        + addRequests() + + +

        + + +

        adds multiple requests to the stack

        + + + public + addRequests(array<string|int, RequestInterface$stack) : static + +
        +
        + +
        Parameters
        +
        +
        + $stack + : array<string|int, RequestInterface> +
        +
        + +
        +
        + + + +
        +
        Return values
        + static +
        + +
        +
        +

        + close() + + +

        + + +

        closes the handle

        + + + public + close() : static + +
        +
        + + + + +
        +
        Return values
        + static +
        + +
        +
        +

        + process() + + +

        + + +

        processes the stack

        + + + public + process() : static + +
        +
        + + + +
        + Tags + + +
        +
        +
        + throws +
        +
        + ClientExceptionInterface + + +
        +
        + +
        +
        Return values
        + static +
        + +
        +
        +

        + setLogger() + + +

        + + + + + public + setLogger(LoggerInterface $logger) : static + +
        +
        + +
        Parameters
        +
        +
        + $logger + : LoggerInterface +
        +
        + +
        +
        + + +
        + Tags + + +
        +
        +
        + inheritDoc +
        +
        + + +
        +
        + codeCoverageIgnore +
        +
        + + +
        +
        + +
        +
        Return values
        + static +
        + +
        +
        +

        + createHandle() + + +

        + + +

        creates a new request handle

        + + + protected + createHandle([RequestInterface|null $request = null ][, int|null $counter = null ][, int|null $retries = null ]) : void + +
        +
        + +
        Parameters
        +
        +
        + $request + : RequestInterface|null + = null
        +
        + +
        +
        + $counter + : int|null + = null
        +
        + +
        +
        + $retries + : int|null + = null
        +
        + +
        +
        + + + + +
        +
        +

        + initCurlMultiOptions() + + +

        + + + + + protected + initCurlMultiOptions() : void + +
        +
        + + + + + +
        +
        +

        + resolve() + + +

        + + +

        resolves the handle, calls the response handler callback and creates the next handle

        + + + protected + resolve(int $handleID) : void + +
        +
        + +
        Parameters
        +
        +
        + $handleID + : int +
        +
        + +
        +
        + + + + +
        +
        + +
        +
        +
        +
        +
        
        +        
        + +
        +
        + + + +
        +
        +
        + +
        + On this page + + +
        + +
        +
        +
        +
        +
        +

        Search results

        + +
        +
        +
          +
          +
          +
          +
          + + +
          + + + + + + + + diff --git a/classes/chillerlan-HTTP-HTTPClientAbstract.html b/classes/chillerlan-HTTP-HTTPClientAbstract.html new file mode 100644 index 00000000..eb396eca --- /dev/null +++ b/classes/chillerlan-HTTP-HTTPClientAbstract.html @@ -0,0 +1,796 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
          +

          Documentation

          + + + + + +
          + +
          +
          + + + + +
          +
          + + +
          +

          + HTTPClientAbstract + + +
          + in package + +
          + + + implements + HTTPClientInterface + +

          + +
          + + +
          AbstractYes
          + +
          + + + + + + + + + +

          + Table of Contents + + +

          + + + +

          + Interfaces + + +

          +
          +
          HTTPClientInterface
          + + + + + + +

          + Properties + + +

          +
          +
          + $logger + +  : LoggerInterface +
          + +
          + $options + +  : HTTPOptions|SettingsContainerInterface +
          + +
          + $responseFactory + +  : ResponseFactoryInterface +
          + +
          + $streamFactory + +  : StreamFactoryInterface|null +
          + +
          + +

          + Methods + + +

          +
          +
          + __construct() + +  : mixed +
          +
          HTTPClientAbstract constructor.
          + +
          + setLogger() + +  : static +
          +
          Sets a PSR-3 Logger
          + +
          + setResponseFactory() + +  : static +
          +
          Sets a PSR-17 response factory
          + +
          + setStreamFactory() + +  : static +
          +
          Sets a PSR-17 stream factory
          + +
          + + + + + + + +
          +

          + Properties + + +

          +
          +

          + $logger + + + + +

          + + + + + protected + LoggerInterface + $logger + = new NullLogger() + + + + + +
          +
          +

          + $options + + + + +

          + + + + + protected + HTTPOptions|SettingsContainerInterface + $options + = new HTTPOptions() + + + + + +
          +
          +

          + $responseFactory + + + + +

          + + + + + protected + ResponseFactoryInterface + $responseFactory + + + + + + +
          +
          +

          + $streamFactory + + + + +

          + + + + + protected + StreamFactoryInterface|null + $streamFactory + = null + + + + + +
          +
          + +
          +

          + Methods + + +

          +
          +

          + __construct() + + +

          + + +

          HTTPClientAbstract constructor.

          + + + public + __construct(ResponseFactoryInterface $responseFactory[, HTTPOptions|SettingsContainerInterface $options = new HTTPOptions() ][, LoggerInterface $logger = new NullLogger() ]) : mixed + +
          +
          + +
          Parameters
          +
          +
          + $responseFactory + : ResponseFactoryInterface +
          +
          + +
          +
          + $options + : HTTPOptions|SettingsContainerInterface + = new HTTPOptions()
          +
          + +
          +
          + $logger + : LoggerInterface + = new NullLogger()
          +
          + +
          +
          + + + + +
          +
          +

          + setLogger() + + +

          + + +

          Sets a PSR-3 Logger

          + + + public + setLogger(LoggerInterface $logger) : static + +
          +
          + +
          Parameters
          +
          +
          + $logger + : LoggerInterface +
          +
          + +
          +
          + + +
          + Tags + + +
          +
          +
          + inheritDoc +
          +
          + + +
          +
          + codeCoverageIgnore +
          +
          + + +
          +
          + +
          +
          Return values
          + static +
          + +
          +
          +

          + setResponseFactory() + + +

          + + +

          Sets a PSR-17 response factory

          + + + public + setResponseFactory(ResponseFactoryInterface $responseFactory) : static + +
          +
          + +
          Parameters
          +
          +
          + $responseFactory + : ResponseFactoryInterface +
          +
          + +
          +
          + + +
          + Tags + + +
          +
          +
          + inheritDoc +
          +
          + + +
          +
          + codeCoverageIgnore +
          +
          + + +
          +
          + +
          +
          Return values
          + static +
          + +
          +
          +

          + setStreamFactory() + + +

          + + +

          Sets a PSR-17 stream factory

          + + + public + setStreamFactory(StreamFactoryInterface $streamFactory) : static + +
          +
          + +
          Parameters
          +
          +
          + $streamFactory + : StreamFactoryInterface +
          +
          + +
          +
          + + +
          + Tags + + +
          +
          +
          + inheritDoc +
          +
          + + +
          +
          + codeCoverageIgnore +
          +
          + + +
          +
          + +
          +
          Return values
          + static +
          + +
          +
          + +
          +
          +
          +
          +
          
          +        
          + +
          +
          + + + +
          +
          +
          + +
          + On this page + + +
          + +
          +
          +
          +
          +
          +

          Search results

          + +
          +
          +
            +
            +
            +
            +
            + + +
            + + + + + + + + diff --git a/classes/chillerlan-HTTP-HTTPClientInterface.html b/classes/chillerlan-HTTP-HTTPClientInterface.html new file mode 100644 index 00000000..9c5f2b51 --- /dev/null +++ b/classes/chillerlan-HTTP-HTTPClientInterface.html @@ -0,0 +1,469 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
            +

            Documentation

            + + + + + +
            + +
            +
            + + + + +
            +
            + + +
            +

            + HTTPClientInterface + + extends + ClientInterface +
            + in + +
            +

            + + + + + + + + + +

            + Table of Contents + + +

            + + + + + + + + + + +

            + Methods + + +

            +
            +
            + setLogger() + +  : static +
            +
            Sets a PSR-3 Logger
            + +
            + setResponseFactory() + +  : static +
            +
            Sets a PSR-17 response factory
            + +
            + setStreamFactory() + +  : static +
            +
            Sets a PSR-17 stream factory
            + +
            + + + + + + +
            +

            + Methods + + +

            +
            +

            + setLogger() + + +

            + + +

            Sets a PSR-3 Logger

            + + + public + setLogger(LoggerInterface $logger) : static + +
            +
            + +
            Parameters
            +
            +
            + $logger + : LoggerInterface +
            +
            + +
            +
            + + + +
            +
            Return values
            + static +
            + +
            +
            +

            + setResponseFactory() + + +

            + + +

            Sets a PSR-17 response factory

            + + + public + setResponseFactory(ResponseFactoryInterface $responseFactory) : static + +
            +
            + +
            Parameters
            +
            +
            + $responseFactory + : ResponseFactoryInterface +
            +
            + +
            +
            + + + +
            +
            Return values
            + static +
            + +
            +
            +

            + setStreamFactory() + + +

            + + +

            Sets a PSR-17 stream factory

            + + + public + setStreamFactory(StreamFactoryInterface $streamFactory) : static + +
            +
            + +
            Parameters
            +
            +
            + $streamFactory + : StreamFactoryInterface +
            +
            + +
            +
            + + + +
            +
            Return values
            + static +
            + +
            +
            + +
            +
            +
            +
            +
            
            +        
            + +
            +
            + + + +
            +
            +
            + +
            + On this page + + +
            + +
            +
            +
            +
            +
            +

            Search results

            + +
            +
            +
              +
              +
              +
              +
              + + +
              + + + + + + + + diff --git a/classes/chillerlan-HTTP-HTTPOptions.html b/classes/chillerlan-HTTP-HTTPOptions.html new file mode 100644 index 00000000..90aaeef3 --- /dev/null +++ b/classes/chillerlan-HTTP-HTTPOptions.html @@ -0,0 +1,1109 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
              +

              Documentation

              + + + + + +
              + +
              +
              + + + + +
              +
              + + +
              +

              + HTTPOptions + + + extends SettingsContainerAbstract + + +
              + in package + +
              + + + + Uses + HTTPOptionsTrait +

              + +
              + + +
              + + + + + + + + + +

              + Table of Contents + + +

              + + + + + + + + + +

              + Properties + + +

              +
              +
              + $ca_info + +  : string|null +
              +
              CA Root Certificates for use with CURL/SSL
              + +
              + $curl_check_OCSP + +  : bool +
              +
              cURL extra hardening
              + +
              + $curl_multi_options + +  : array<string|int, mixed> +
              +
              options for the curl multi instance
              + +
              + $curl_options + +  : array<string|int, mixed> +
              +
              options for each curl instance
              + +
              + $dns_over_https + +  : string|null +
              +
              Sets a DNS-over-HTTPS provider URL
              + +
              + $retries + +  : int +
              +
              Number of retries (multi fetch)
              + +
              + $sleep + +  : int +
              +
              sleep timer (microseconds) between each fired multi request on startup
              + +
              + $ssl_verifypeer + +  : bool +
              +
              see CURLOPT_SSL_VERIFYPEER +requires either HTTPOptions::$ca_info or a properly working system CA file
              + +
              + $timeout + +  : int +
              +
              Timeout value
              + +
              + $user_agent + +  : string +
              +
              A custom user agent string
              + +
              + $window_size + +  : int +
              +
              maximum of concurrent requests for curl_multi
              + +
              + +

              + Methods + + +

              +
              +
              + set_curl_options() + +  : void +
              + +
              + set_dns_over_https() + +  : void +
              + +
              + set_user_agent() + +  : void +
              + +
              + + + + + + + +
              +

              + Properties + + +

              + +
              +

              + $curl_check_OCSP + + + + +

              + + +

              cURL extra hardening

              + + + protected + bool + $curl_check_OCSP + = false + +

              When set to true, cURL validates that the server staples an OCSP response during the TLS handshake.

              +

              Use with caution as cURL will refuse a connection if it doesn't receive a valid OCSP response - +this does not necessarily mean that the TLS connection is insecure.

              +
              + + + +
              + Tags + + +
              +
              +
              + see +
              +
              + CURLOPT_SSL_VERIFYSTATUS + + +
              +
              + +
              + +
              +

              + $curl_options + + + + +

              + + +

              options for each curl instance

              + + + protected + array<string|int, mixed> + $curl_options + = [] + +

              this array is being merged into the default options as the last thing before curl_exec(). +none of the values (except existence of the CA file) will be checked - that's up to the implementation.

              +
              + + + + +
              + +
              +

              + $retries + + + + +

              + + +

              Number of retries (multi fetch)

              + + + protected + int + $retries + = 3 + + + + + +
              +
              +

              + $sleep + + + + +

              + + +

              sleep timer (microseconds) between each fired multi request on startup

              + + + protected + int + $sleep + = 0 + + + + + +
              + +
              +

              + $timeout + + + + +

              + + +

              Timeout value

              + + + protected + int + $timeout + = 10 + + + + +
              + Tags + + +
              +
              +
              + see +
              +
              + CURLOPT_TIMEOUT + + +
              +
              + +
              +
              +

              + $user_agent + + + + +

              + + +

              A custom user agent string

              + + + protected + string + $user_agent + = 'chillerlanHttpInterface/6.0 +https://github.com/chillerlan/php-httpinterface' + + + + + +
              +
              +

              + $window_size + + + + +

              + + +

              maximum of concurrent requests for curl_multi

              + + + protected + int + $window_size + = 5 + + + + + +
              +
              + +
              +

              + Methods + + +

              +
              +

              + set_curl_options() + + +

              + + + + + protected + set_curl_options(array<string|int, mixed> $curl_options) : void + +
              +
              + +
              Parameters
              +
              +
              + $curl_options + : array<string|int, mixed> +
              +
              + +
              +
              + + + + +
              +
              +

              + set_dns_over_https() + + +

              + + + + + protected + set_dns_over_https(string|null $dns_over_https) : void + +
              +
              + +
              Parameters
              +
              +
              + $dns_over_https + : string|null +
              +
              + +
              +
              + + +
              + Tags + + +
              +
              +
              + throws +
              +
              + ClientException + + +
              +
              + + +
              +
              +

              + set_user_agent() + + +

              + + + + + protected + set_user_agent(string $user_agent) : void + +
              +
              + +
              Parameters
              +
              +
              + $user_agent + : string +
              +
              + +
              +
              + + +
              + Tags + + +
              +
              +
              + throws +
              +
              + ClientExceptionInterface + + +
              +
              + + +
              +
              + +
              +
              +
              +
              +
              
              +        
              + +
              +
              + + + +
              +
              +
              + +
              + On this page + + +
              + +
              +
              +
              +
              +
              +

              Search results

              + +
              +
              +
                +
                +
                +
                +
                + + +
                + + + + + + + + diff --git a/classes/chillerlan-HTTP-HTTPOptionsTrait.html b/classes/chillerlan-HTTP-HTTPOptionsTrait.html new file mode 100644 index 00000000..dd0a7a60 --- /dev/null +++ b/classes/chillerlan-HTTP-HTTPOptionsTrait.html @@ -0,0 +1,1086 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                +

                Documentation

                + + + + + +
                + +
                +
                + + + + +
                +
                + + +
                +

                + HTTPOptionsTrait +

                + + + + + + + + + +

                + Table of Contents + + +

                + + + + + + + + + +

                + Properties + + +

                +
                +
                + $ca_info + +  : string|null +
                +
                CA Root Certificates for use with CURL/SSL
                + +
                + $curl_check_OCSP + +  : bool +
                +
                cURL extra hardening
                + +
                + $curl_multi_options + +  : array<string|int, mixed> +
                +
                options for the curl multi instance
                + +
                + $curl_options + +  : array<string|int, mixed> +
                +
                options for each curl instance
                + +
                + $dns_over_https + +  : string|null +
                +
                Sets a DNS-over-HTTPS provider URL
                + +
                + $retries + +  : int +
                +
                Number of retries (multi fetch)
                + +
                + $sleep + +  : int +
                +
                sleep timer (microseconds) between each fired multi request on startup
                + +
                + $ssl_verifypeer + +  : bool +
                +
                see CURLOPT_SSL_VERIFYPEER +requires either HTTPOptions::$ca_info or a properly working system CA file
                + +
                + $timeout + +  : int +
                +
                Timeout value
                + +
                + $user_agent + +  : string +
                +
                A custom user agent string
                + +
                + $window_size + +  : int +
                +
                maximum of concurrent requests for curl_multi
                + +
                + +

                + Methods + + +

                +
                +
                + set_curl_options() + +  : void +
                + +
                + set_dns_over_https() + +  : void +
                + +
                + set_user_agent() + +  : void +
                + +
                + + + + + + + +
                +

                + Properties + + +

                + +
                +

                + $curl_check_OCSP + + + + +

                + + +

                cURL extra hardening

                + + + protected + bool + $curl_check_OCSP + = false + +

                When set to true, cURL validates that the server staples an OCSP response during the TLS handshake.

                +

                Use with caution as cURL will refuse a connection if it doesn't receive a valid OCSP response - +this does not necessarily mean that the TLS connection is insecure.

                +
                + + + +
                + Tags + + +
                +
                +
                + see +
                +
                + CURLOPT_SSL_VERIFYSTATUS + + +
                +
                + +
                + +
                +

                + $curl_options + + + + +

                + + +

                options for each curl instance

                + + + protected + array<string|int, mixed> + $curl_options + = [] + +

                this array is being merged into the default options as the last thing before curl_exec(). +none of the values (except existence of the CA file) will be checked - that's up to the implementation.

                +
                + + + + +
                + +
                +

                + $retries + + + + +

                + + +

                Number of retries (multi fetch)

                + + + protected + int + $retries + = 3 + + + + + +
                +
                +

                + $sleep + + + + +

                + + +

                sleep timer (microseconds) between each fired multi request on startup

                + + + protected + int + $sleep + = 0 + + + + + +
                + +
                +

                + $timeout + + + + +

                + + +

                Timeout value

                + + + protected + int + $timeout + = 10 + + + + +
                + Tags + + +
                +
                +
                + see +
                +
                + CURLOPT_TIMEOUT + + +
                +
                + +
                +
                +

                + $user_agent + + + + +

                + + +

                A custom user agent string

                + + + protected + string + $user_agent + = 'chillerlanHttpInterface/6.0 +https://github.com/chillerlan/php-httpinterface' + + + + + +
                +
                +

                + $window_size + + + + +

                + + +

                maximum of concurrent requests for curl_multi

                + + + protected + int + $window_size + = 5 + + + + + +
                +
                + +
                +

                + Methods + + +

                +
                +

                + set_curl_options() + + +

                + + + + + protected + set_curl_options(array<string|int, mixed> $curl_options) : void + +
                +
                + +
                Parameters
                +
                +
                + $curl_options + : array<string|int, mixed> +
                +
                + +
                +
                + + + + +
                +
                +

                + set_dns_over_https() + + +

                + + + + + protected + set_dns_over_https(string|null $dns_over_https) : void + +
                +
                + +
                Parameters
                +
                +
                + $dns_over_https + : string|null +
                +
                + +
                +
                + + +
                + Tags + + +
                +
                +
                + throws +
                +
                + ClientException + + +
                +
                + + +
                +
                +

                + set_user_agent() + + +

                + + + + + protected + set_user_agent(string $user_agent) : void + +
                +
                + +
                Parameters
                +
                +
                + $user_agent + : string +
                +
                + +
                +
                + + +
                + Tags + + +
                +
                +
                + throws +
                +
                + ClientExceptionInterface + + +
                +
                + + +
                +
                + +
                +
                +
                +
                +
                
                +        
                + +
                +
                + + + +
                +
                +
                + +
                + On this page + + +
                + +
                +
                +
                +
                +
                +

                Search results

                + +
                +
                +
                  +
                  +
                  +
                  +
                  + + +
                  + + + + + + + + diff --git a/classes/chillerlan-HTTP-MultiResponseHandlerInterface.html b/classes/chillerlan-HTTP-MultiResponseHandlerInterface.html new file mode 100644 index 00000000..30032673 --- /dev/null +++ b/classes/chillerlan-HTTP-MultiResponseHandlerInterface.html @@ -0,0 +1,396 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                  +

                  Documentation

                  + + + + + +
                  + +
                  +
                  + + + + +
                  +
                  + + +
                  +

                  + MultiResponseHandlerInterface +
                  + in + +
                  +

                  + + + +

                  The multi response handler. (Schrödinger's cat state handler)

                  + + + + + + +

                  + Table of Contents + + +

                  + + + + + + + + + + +

                  + Methods + + +

                  +
                  +
                  + handleResponse() + +  : RequestInterface|null +
                  +
                  This method will be called within a loop in MultiRequest::processStack().
                  + +
                  + + + + + + +
                  +

                  + Methods + + +

                  +
                  +

                  + handleResponse() + + +

                  + + +

                  This method will be called within a loop in MultiRequest::processStack().

                  + + + public + handleResponse(ResponseInterface $response, RequestInterface $request, int $id, array<string|int, mixed>|null $curl_info) : RequestInterface|null + +
                  +
                  +

                  It may return a RequestInterface object (e.g. as a replacement for a failed request), +which then will be re-added to the running queue, otherwise NULL.

                  +
                  + +
                  Parameters
                  +
                  +
                  + $response + : ResponseInterface +
                  +
                  +

                  the response

                  +
                  + +
                  +
                  + $request + : RequestInterface +
                  +
                  +

                  the original request

                  +
                  + +
                  +
                  + $id + : int +
                  +
                  +

                  the request ID (order of outgoing requests)

                  +
                  + +
                  +
                  + $curl_info + : array<string|int, mixed>|null +
                  +
                  +

                  curl_info() result for the current request, +empty array on curl_info() failure

                  +
                  + +
                  +
                  + + + +
                  +
                  Return values
                  + RequestInterface|null + — +

                  an optional replacement request if the previous request failed

                  +
                  + +
                  + +
                  +
                  + +
                  +
                  +
                  +
                  +
                  
                  +        
                  + +
                  +
                  + + + +
                  +
                  +
                  + +
                  + On this page + + +
                  + +
                  +
                  +
                  +
                  +
                  +

                  Search results

                  + +
                  +
                  +
                    +
                    +
                    +
                    +
                    + + +
                    + + + + + + + + diff --git a/classes/chillerlan-HTTP-NetworkException.html b/classes/chillerlan-HTTP-NetworkException.html new file mode 100644 index 00000000..0d4068e6 --- /dev/null +++ b/classes/chillerlan-HTTP-NetworkException.html @@ -0,0 +1,520 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                    +

                    Documentation

                    + + + + + +
                    + +
                    +
                    + + + + +
                    +
                    + + +
                    +

                    + NetworkException + + + extends ClientException + + +
                    + in package + +
                    + + + implements + NetworkExceptionInterface + +

                    + +
                    + + +
                    + + + + + + +
                    + Tags + + +
                    +
                    +
                    + codeCoverageIgnore +
                    +
                    + + +
                    +
                    + + + +

                    + Table of Contents + + +

                    + + + +

                    + Interfaces + + +

                    +
                    +
                    NetworkExceptionInterface
                    + + + + + + +

                    + Properties + + +

                    +
                    +
                    + $request + +  : RequestInterface +
                    + +
                    + +

                    + Methods + + +

                    +
                    +
                    + __construct() + +  : mixed +
                    + +
                    + getRequest() + +  : RequestInterface +
                    + +
                    + + + + + + + +
                    +

                    + Properties + + +

                    +
                    +

                    + $request + + + + +

                    + + + + + protected + RequestInterface + $request + + + + + + +
                    +
                    + +
                    +

                    + Methods + + +

                    +
                    +

                    + __construct() + + +

                    + + + + + public + __construct(string $message, RequestInterface $request[, Throwable|null $previous = null ]) : mixed + +
                    +
                    + +
                    Parameters
                    +
                    +
                    + $message + : string +
                    +
                    + +
                    +
                    + $request + : RequestInterface +
                    +
                    + +
                    +
                    + $previous + : Throwable|null + = null
                    +
                    + +
                    +
                    + + + + +
                    +
                    +

                    + getRequest() + + +

                    + + + + + public + getRequest() : RequestInterface + +
                    +
                    + + + +
                    + Tags + + +
                    +
                    +
                    + inheritDoc +
                    +
                    + + +
                    +
                    + +
                    +
                    Return values
                    + RequestInterface +
                    + +
                    +
                    + +
                    +
                    +
                    +
                    +
                    
                    +        
                    + +
                    +
                    + + + +
                    +
                    +
                    + +
                    + On this page + + +
                    + +
                    +
                    +
                    +
                    +
                    +

                    Search results

                    + +
                    +
                    +
                      +
                      +
                      +
                      +
                      + + +
                      + + + + + + + + diff --git a/classes/chillerlan-HTTP-RequestException.html b/classes/chillerlan-HTTP-RequestException.html new file mode 100644 index 00000000..a663cca5 --- /dev/null +++ b/classes/chillerlan-HTTP-RequestException.html @@ -0,0 +1,520 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                      +

                      Documentation

                      + + + + + +
                      + +
                      +
                      + + + + +
                      +
                      + + +
                      +

                      + RequestException + + + extends ClientException + + +
                      + in package + +
                      + + + implements + RequestExceptionInterface + +

                      + +
                      + + +
                      + + + + + + +
                      + Tags + + +
                      +
                      +
                      + codeCoverageIgnore +
                      +
                      + + +
                      +
                      + + + +

                      + Table of Contents + + +

                      + + + +

                      + Interfaces + + +

                      +
                      +
                      RequestExceptionInterface
                      + + + + + + +

                      + Properties + + +

                      +
                      +
                      + $request + +  : RequestInterface +
                      + +
                      + +

                      + Methods + + +

                      +
                      +
                      + __construct() + +  : mixed +
                      + +
                      + getRequest() + +  : RequestInterface +
                      + +
                      + + + + + + + +
                      +

                      + Properties + + +

                      +
                      +

                      + $request + + + + +

                      + + + + + protected + RequestInterface + $request + + + + + + +
                      +
                      + +
                      +

                      + Methods + + +

                      +
                      +

                      + __construct() + + +

                      + + + + + public + __construct(string $message, RequestInterface $request[, Throwable|null $previous = null ]) : mixed + +
                      +
                      + +
                      Parameters
                      +
                      +
                      + $message + : string +
                      +
                      + +
                      +
                      + $request + : RequestInterface +
                      +
                      + +
                      +
                      + $previous + : Throwable|null + = null
                      +
                      + +
                      +
                      + + + + +
                      +
                      +

                      + getRequest() + + +

                      + + + + + public + getRequest() : RequestInterface + +
                      +
                      + + + +
                      + Tags + + +
                      +
                      +
                      + inheritDoc +
                      +
                      + + +
                      +
                      + +
                      +
                      Return values
                      + RequestInterface +
                      + +
                      +
                      + +
                      +
                      +
                      +
                      +
                      
                      +        
                      + +
                      +
                      + + + +
                      +
                      +
                      + +
                      + On this page + + +
                      + +
                      +
                      +
                      +
                      +
                      +

                      Search results

                      + +
                      +
                      +
                        +
                        +
                        +
                        +
                        + + +
                        + + + + + + + + diff --git a/classes/chillerlan-HTTP-StreamClient.html b/classes/chillerlan-HTTP-StreamClient.html new file mode 100644 index 00000000..072c72cd --- /dev/null +++ b/classes/chillerlan-HTTP-StreamClient.html @@ -0,0 +1,1043 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                        +

                        Documentation

                        + + + + + +
                        + +
                        +
                        + + + + +
                        +
                        + + +
                        +

                        + StreamClient + + + extends HTTPClientAbstract + + +
                        + in package + +
                        + + +

                        + +
                        + + +
                        + + + +

                        A http client via PHP streams

                        + +

                        (I'm not exactly sure why I'm keeping this - use CurlClient in production)

                        +
                        + + +
                        + Tags + + +
                        +
                        +
                        + see +
                        +
                        + file_get_contents() + + +
                        +
                        + see +
                        +
                        + stream_context_create() + + +
                        +
                        + + + +

                        + Table of Contents + + +

                        + + + + + + + + + +

                        + Properties + + +

                        +
                        +
                        + $logger + +  : LoggerInterface +
                        + +
                        + $options + +  : HTTPOptions|SettingsContainerInterface +
                        + +
                        + $responseFactory + +  : ResponseFactoryInterface +
                        + +
                        + $streamFactory + +  : StreamFactoryInterface|null +
                        + +
                        + +

                        + Methods + + +

                        +
                        +
                        + __construct() + +  : mixed +
                        +
                        HTTPClientAbstract constructor.
                        + +
                        + sendRequest() + +  : ResponseInterface +
                        + +
                        + setLogger() + +  : static +
                        +
                        Sets a PSR-3 Logger
                        + +
                        + setResponseFactory() + +  : static +
                        +
                        Sets a PSR-17 response factory
                        + +
                        + setStreamFactory() + +  : static +
                        +
                        Sets a PSR-17 stream factory
                        + +
                        + createResponse() + +  : ResponseInterface +
                        + +
                        + getContextOptions() + +  : array<string|int, mixed> +
                        + +
                        + getRequestHeaders() + +  : array<string|int, mixed> +
                        + +
                        + + + + + + + +
                        +

                        + Properties + + +

                        +
                        +

                        + $logger + + + + +

                        + + + + + protected + LoggerInterface + $logger + = new NullLogger() + + + + + +
                        +
                        +

                        + $options + + + + +

                        + + + + + protected + HTTPOptions|SettingsContainerInterface + $options + = new HTTPOptions() + + + + + +
                        +
                        +

                        + $responseFactory + + + + +

                        + + + + + protected + ResponseFactoryInterface + $responseFactory + + + + + + +
                        +
                        +

                        + $streamFactory + + + + +

                        + + + + + protected + StreamFactoryInterface|null + $streamFactory + = null + + + + + +
                        +
                        + +
                        +

                        + Methods + + +

                        +
                        +

                        + __construct() + + +

                        + + +

                        HTTPClientAbstract constructor.

                        + + + public + __construct(ResponseFactoryInterface $responseFactory[, HTTPOptions|SettingsContainerInterface $options = new HTTPOptions() ][, LoggerInterface $logger = new NullLogger() ]) : mixed + +
                        +
                        + +
                        Parameters
                        +
                        +
                        + $responseFactory + : ResponseFactoryInterface +
                        +
                        + +
                        +
                        + $options + : HTTPOptions|SettingsContainerInterface + = new HTTPOptions()
                        +
                        + +
                        +
                        + $logger + : LoggerInterface + = new NullLogger()
                        +
                        + +
                        +
                        + + + + +
                        +
                        +

                        + sendRequest() + + +

                        + + + + + public + sendRequest(RequestInterface $request) : ResponseInterface + +
                        +
                        + +
                        Parameters
                        +
                        +
                        + $request + : RequestInterface +
                        +
                        + +
                        +
                        + + +
                        + Tags + + +
                        +
                        +
                        + inheritDoc +
                        +
                        + + +
                        +
                        + throws +
                        +
                        + Exception|ClientException + + +
                        +
                        + +
                        +
                        Return values
                        + ResponseInterface +
                        + +
                        +
                        +

                        + setLogger() + + +

                        + + +

                        Sets a PSR-3 Logger

                        + + + public + setLogger(LoggerInterface $logger) : static + +
                        +
                        + +
                        Parameters
                        +
                        +
                        + $logger + : LoggerInterface +
                        +
                        + +
                        +
                        + + +
                        + Tags + + +
                        +
                        +
                        + inheritDoc +
                        +
                        + + +
                        +
                        + codeCoverageIgnore +
                        +
                        + + +
                        +
                        + +
                        +
                        Return values
                        + static +
                        + +
                        +
                        +

                        + setResponseFactory() + + +

                        + + +

                        Sets a PSR-17 response factory

                        + + + public + setResponseFactory(ResponseFactoryInterface $responseFactory) : static + +
                        +
                        + +
                        Parameters
                        +
                        +
                        + $responseFactory + : ResponseFactoryInterface +
                        +
                        + +
                        +
                        + + +
                        + Tags + + +
                        +
                        +
                        + inheritDoc +
                        +
                        + + +
                        +
                        + codeCoverageIgnore +
                        +
                        + + +
                        +
                        + +
                        +
                        Return values
                        + static +
                        + +
                        +
                        +

                        + setStreamFactory() + + +

                        + + +

                        Sets a PSR-17 stream factory

                        + + + public + setStreamFactory(StreamFactoryInterface $streamFactory) : static + +
                        +
                        + +
                        Parameters
                        +
                        +
                        + $streamFactory + : StreamFactoryInterface +
                        +
                        + +
                        +
                        + + +
                        + Tags + + +
                        +
                        +
                        + inheritDoc +
                        +
                        + + +
                        +
                        + codeCoverageIgnore +
                        +
                        + + +
                        +
                        + +
                        +
                        Return values
                        + static +
                        + +
                        +
                        +

                        + createResponse() + + +

                        + + + + + protected + createResponse(array<string|int, string> $headers) : ResponseInterface + +
                        +
                        + +
                        Parameters
                        +
                        +
                        + $headers + : array<string|int, string> +
                        +
                        + +
                        +
                        + + + +
                        +
                        Return values
                        + ResponseInterface +
                        + +
                        +
                        +

                        + getContextOptions() + + +

                        + + + + + protected + getContextOptions(RequestInterface $request) : array<string|int, mixed> + +
                        +
                        + +
                        Parameters
                        +
                        +
                        + $request + : RequestInterface +
                        +
                        + +
                        +
                        + + + +
                        +
                        Return values
                        + array<string|int, mixed> +
                        + +
                        +
                        +

                        + getRequestHeaders() + + +

                        + + + + + protected + getRequestHeaders(RequestInterface $request) : array<string|int, mixed> + +
                        +
                        + +
                        Parameters
                        +
                        +
                        + $request + : RequestInterface +
                        +
                        + +
                        +
                        + + + +
                        +
                        Return values
                        + array<string|int, mixed> +
                        + +
                        +
                        + +
                        +
                        +
                        +
                        +
                        
                        +        
                        + +
                        +
                        + + + +
                        +
                        +
                        + +
                        + On this page + + +
                        + +
                        +
                        +
                        +
                        +
                        +

                        Search results

                        + +
                        +
                        +
                          +
                          +
                          +
                          +
                          + + +
                          + + + + + + + + diff --git a/classes/chillerlan-HTTPTest-ClientFactories-CurlClientFactory.html b/classes/chillerlan-HTTPTest-ClientFactories-CurlClientFactory.html new file mode 100644 index 00000000..3c0c8d54 --- /dev/null +++ b/classes/chillerlan-HTTPTest-ClientFactories-CurlClientFactory.html @@ -0,0 +1,387 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                          +

                          Documentation

                          + + + + + +
                          + +
                          +
                          + + + + +
                          +
                          + + +
                          +

                          + CurlClientFactory + + +
                          + in package + +
                          + + + implements + HttpClientFactoryInterface + +

                          + +
                          + +
                          FinalYes
                          + + +
                          + + + + + + + + + +

                          + Table of Contents + + +

                          + + + +

                          + Interfaces + + +

                          +
                          +
                          HttpClientFactoryInterface
                          + + + + + + + +

                          + Methods + + +

                          +
                          +
                          + getClient() + +  : ClientInterface +
                          + +
                          + + + + + + + + +
                          +

                          + Methods + + +

                          +
                          +

                          + getClient() + + +

                          + + + + + public + getClient(string $cacert, ResponseFactoryInterface $responseFactory) : ClientInterface + +
                          +
                          + +
                          Parameters
                          +
                          +
                          + $cacert + : string +
                          +
                          + +
                          +
                          + $responseFactory + : ResponseFactoryInterface +
                          +
                          + +
                          +
                          + + + +
                          +
                          Return values
                          + ClientInterface +
                          + +
                          +
                          + +
                          +
                          +
                          +
                          +
                          
                          +        
                          + +
                          +
                          + + + +
                          +
                          +
                          + +
                          + On this page + + +
                          + +
                          +
                          +
                          +
                          +
                          +

                          Search results

                          + +
                          +
                          +
                            +
                            +
                            +
                            +
                            + + +
                            + + + + + + + + diff --git a/classes/chillerlan-HTTPTest-ClientFactories-CurlClientNoCAFactory.html b/classes/chillerlan-HTTPTest-ClientFactories-CurlClientNoCAFactory.html new file mode 100644 index 00000000..e75dca80 --- /dev/null +++ b/classes/chillerlan-HTTPTest-ClientFactories-CurlClientNoCAFactory.html @@ -0,0 +1,387 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                            +

                            Documentation

                            + + + + + +
                            + +
                            +
                            + + + + +
                            +
                            + + +
                            +

                            + CurlClientNoCAFactory + + +
                            + in package + +
                            + + + implements + HttpClientFactoryInterface + +

                            + +
                            + +
                            FinalYes
                            + + +
                            + + + + + + + + + +

                            + Table of Contents + + +

                            + + + +

                            + Interfaces + + +

                            +
                            +
                            HttpClientFactoryInterface
                            + + + + + + + +

                            + Methods + + +

                            +
                            +
                            + getClient() + +  : ClientInterface +
                            + +
                            + + + + + + + + +
                            +

                            + Methods + + +

                            +
                            +

                            + getClient() + + +

                            + + + + + public + getClient(string $cacert, ResponseFactoryInterface $responseFactory) : ClientInterface + +
                            +
                            + +
                            Parameters
                            +
                            +
                            + $cacert + : string +
                            +
                            + +
                            +
                            + $responseFactory + : ResponseFactoryInterface +
                            +
                            + +
                            +
                            + + + +
                            +
                            Return values
                            + ClientInterface +
                            + +
                            +
                            + +
                            +
                            +
                            +
                            +
                            
                            +        
                            + +
                            +
                            + + + +
                            +
                            +
                            + +
                            + On this page + + +
                            + +
                            +
                            +
                            +
                            +
                            +

                            Search results

                            + +
                            +
                            +
                              +
                              +
                              +
                              +
                              + + +
                              + + + + + + + + diff --git a/classes/chillerlan-HTTPTest-ClientFactories-StreamClientFactory.html b/classes/chillerlan-HTTPTest-ClientFactories-StreamClientFactory.html new file mode 100644 index 00000000..3c720692 --- /dev/null +++ b/classes/chillerlan-HTTPTest-ClientFactories-StreamClientFactory.html @@ -0,0 +1,387 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                              +

                              Documentation

                              + + + + + +
                              + +
                              +
                              + + + + +
                              +
                              + + +
                              +

                              + StreamClientFactory + + +
                              + in package + +
                              + + + implements + HttpClientFactoryInterface + +

                              + +
                              + +
                              FinalYes
                              + + +
                              + + + + + + + + + +

                              + Table of Contents + + +

                              + + + +

                              + Interfaces + + +

                              +
                              +
                              HttpClientFactoryInterface
                              + + + + + + + +

                              + Methods + + +

                              +
                              +
                              + getClient() + +  : ClientInterface +
                              + +
                              + + + + + + + + +
                              +

                              + Methods + + +

                              +
                              +

                              + getClient() + + +

                              + + + + + public + getClient(string $cacert, ResponseFactoryInterface $responseFactory) : ClientInterface + +
                              +
                              + +
                              Parameters
                              +
                              +
                              + $cacert + : string +
                              +
                              + +
                              +
                              + $responseFactory + : ResponseFactoryInterface +
                              +
                              + +
                              +
                              + + + +
                              +
                              Return values
                              + ClientInterface +
                              + +
                              +
                              + +
                              +
                              +
                              +
                              +
                              
                              +        
                              + +
                              +
                              + + + +
                              +
                              +
                              + +
                              + On this page + + +
                              + +
                              +
                              +
                              +
                              +
                              +

                              Search results

                              + +
                              +
                              +
                                +
                                +
                                +
                                +
                                + + +
                                + + + + + + + + diff --git a/classes/chillerlan-HTTPTest-ClientFactories-StreamClientNoCAFactory.html b/classes/chillerlan-HTTPTest-ClientFactories-StreamClientNoCAFactory.html new file mode 100644 index 00000000..a87c9795 --- /dev/null +++ b/classes/chillerlan-HTTPTest-ClientFactories-StreamClientNoCAFactory.html @@ -0,0 +1,387 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                +

                                Documentation

                                + + + + + +
                                + +
                                +
                                + + + + +
                                +
                                + + +
                                +

                                + StreamClientNoCAFactory + + +
                                + in package + +
                                + + + implements + HttpClientFactoryInterface + +

                                + +
                                + +
                                FinalYes
                                + + +
                                + + + + + + + + + +

                                + Table of Contents + + +

                                + + + +

                                + Interfaces + + +

                                +
                                +
                                HttpClientFactoryInterface
                                + + + + + + + +

                                + Methods + + +

                                +
                                +
                                + getClient() + +  : ClientInterface +
                                + +
                                + + + + + + + + +
                                +

                                + Methods + + +

                                +
                                +

                                + getClient() + + +

                                + + + + + public + getClient(string $cacert, ResponseFactoryInterface $responseFactory) : ClientInterface + +
                                +
                                + +
                                Parameters
                                +
                                +
                                + $cacert + : string +
                                +
                                + +
                                +
                                + $responseFactory + : ResponseFactoryInterface +
                                +
                                + +
                                +
                                + + + +
                                +
                                Return values
                                + ClientInterface +
                                + +
                                +
                                + +
                                +
                                +
                                +
                                +
                                
                                +        
                                + +
                                +
                                + + + +
                                +
                                +
                                + +
                                + On this page + + +
                                + +
                                +
                                +
                                +
                                +
                                +

                                Search results

                                + +
                                +
                                +
                                  +
                                  +
                                  +
                                  +
                                  + + +
                                  + + + + + + + + diff --git a/classes/chillerlan-HTTPTest-CurlClientNoCATest.html b/classes/chillerlan-HTTPTest-CurlClientNoCATest.html new file mode 100644 index 00000000..18ffbc28 --- /dev/null +++ b/classes/chillerlan-HTTPTest-CurlClientNoCATest.html @@ -0,0 +1,549 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                  +

                                  Documentation

                                  + + + + + +
                                  + +
                                  +
                                  + + + + +
                                  +
                                  + + +
                                  +

                                  + CurlClientNoCATest + + + extends HTTPClientTestAbstract + + +
                                  + in package + +
                                  + + +

                                  + +
                                  + +
                                  FinalYes
                                  + + +
                                  + + + + + + + + + +

                                  + Table of Contents + + +

                                  + + + + + + + +

                                  + Constants + + +

                                  +
                                  +
                                  + USER_AGENT + +  = 'chillerlanHttpTest/2.0' +
                                  + +
                                  + + +

                                  + Properties + + +

                                  +
                                  +
                                  + $HTTP_CLIENT_FACTORY + +  : string +
                                  + +
                                  + +

                                  + Methods + + +

                                  +
                                  +
                                  + testNetworkError() + +  : void +
                                  + +
                                  + testSendRequest() + +  : void +
                                  + +
                                  + setUp() + +  : void +
                                  + +
                                  + + + + + +
                                  +

                                  + Constants + + +

                                  +
                                  +

                                  + USER_AGENT + + +

                                  + + + + + + public + mixed + USER_AGENT + = 'chillerlanHttpTest/2.0' + + + + + + + +
                                  +
                                  + + +
                                  +

                                  + Properties + + +

                                  +
                                  +

                                  + $HTTP_CLIENT_FACTORY + + + + +

                                  + + + + + protected + string + $HTTP_CLIENT_FACTORY + = \chillerlan\HTTPTest\ClientFactories\CurlClientNoCAFactory::class + + + + + +
                                  +
                                  + +
                                  +

                                  + Methods + + +

                                  +
                                  +

                                  + testNetworkError() + + +

                                  + + + + + public + testNetworkError() : void + +
                                  +
                                  + + + + + +
                                  +
                                  +

                                  + testSendRequest() + + +

                                  + + + + + public + testSendRequest() : void + +
                                  +
                                  + + + + + +
                                  + +
                                  + +
                                  +
                                  +
                                  +
                                  +
                                  
                                  +        
                                  + +
                                  +
                                  + + + +
                                  +
                                  +
                                  + +
                                  + On this page + + +
                                  + +
                                  +
                                  +
                                  +
                                  +
                                  +

                                  Search results

                                  + +
                                  +
                                  +
                                    +
                                    +
                                    +
                                    +
                                    + + +
                                    + + + + + + + + diff --git a/classes/chillerlan-HTTPTest-CurlClientTest.html b/classes/chillerlan-HTTPTest-CurlClientTest.html new file mode 100644 index 00000000..a66718fc --- /dev/null +++ b/classes/chillerlan-HTTPTest-CurlClientTest.html @@ -0,0 +1,587 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                    +

                                    Documentation

                                    + + + + + +
                                    + +
                                    +
                                    + + + + +
                                    +
                                    + + +
                                    +

                                    + CurlClientTest + + + extends HTTPClientTestAbstract + + +
                                    + in package + +
                                    + + +

                                    + +
                                    + +
                                    FinalYes
                                    + + +
                                    + + + + + + + + + +

                                    + Table of Contents + + +

                                    + + + + + + + +

                                    + Constants + + +

                                    +
                                    +
                                    + USER_AGENT + +  = 'chillerlanHttpTest/2.0' +
                                    + +
                                    + + +

                                    + Properties + + +

                                    +
                                    +
                                    + $HTTP_CLIENT_FACTORY + +  : string +
                                    + +
                                    + +

                                    + Methods + + +

                                    +
                                    +
                                    + testNetworkError() + +  : void +
                                    + +
                                    + testRequestError() + +  : void +
                                    + +
                                    + testSendRequest() + +  : void +
                                    + +
                                    + setUp() + +  : void +
                                    + +
                                    + + + + + +
                                    +

                                    + Constants + + +

                                    +
                                    +

                                    + USER_AGENT + + +

                                    + + + + + + public + mixed + USER_AGENT + = 'chillerlanHttpTest/2.0' + + + + + + + +
                                    +
                                    + + +
                                    +

                                    + Properties + + +

                                    +
                                    +

                                    + $HTTP_CLIENT_FACTORY + + + + +

                                    + + + + + protected + string + $HTTP_CLIENT_FACTORY + = \chillerlan\HTTPTest\ClientFactories\CurlClientFactory::class + + + + + +
                                    +
                                    + +
                                    +

                                    + Methods + + +

                                    +
                                    +

                                    + testNetworkError() + + +

                                    + + + + + public + testNetworkError() : void + +
                                    +
                                    + + + + + +
                                    +
                                    +

                                    + testRequestError() + + +

                                    + + + + + public + testRequestError() : void + +
                                    +
                                    + + + + + +
                                    +
                                    +

                                    + testSendRequest() + + +

                                    + + + + + public + testSendRequest() : void + +
                                    +
                                    + + + + + +
                                    + +
                                    + +
                                    +
                                    +
                                    +
                                    +
                                    
                                    +        
                                    + +
                                    +
                                    + + + +
                                    +
                                    +
                                    + +
                                    + On this page + + +
                                    + +
                                    +
                                    +
                                    +
                                    +
                                    +

                                    Search results

                                    + +
                                    +
                                    +
                                      +
                                      +
                                      +
                                      +
                                      + + +
                                      + + + + + + + + diff --git a/classes/chillerlan-HTTPTest-CurlHandleTest.html b/classes/chillerlan-HTTPTest-CurlHandleTest.html new file mode 100644 index 00000000..af00c687 --- /dev/null +++ b/classes/chillerlan-HTTPTest-CurlHandleTest.html @@ -0,0 +1,959 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                      +

                                      Documentation

                                      + + + + + +
                                      + +
                                      +
                                      + + + + +
                                      +
                                      + + +
                                      +

                                      + CurlHandleTest + + + extends TestCase + + +
                                      + in package + +
                                      + + + + Uses + HttpFactoryTrait +

                                      + +
                                      + + +
                                      + + + + + + + + + +

                                      + Table of Contents + + +

                                      + + + + + + + + + +

                                      + Properties + + +

                                      +
                                      +
                                      + $HTTP_CLIENT_FACTORY + +  : string +
                                      + +
                                      + +

                                      + Methods + + +

                                      +
                                      +
                                      + caOptionProvider() + +  : array<string|int, mixed> +
                                      + +
                                      + invalidCaOptionProvider() + +  : array<string|int, mixed> +
                                      + +
                                      + requestMethodProvider() + +  : array<string|int, mixed> +
                                      + +
                                      + requestMethodWithBodyProvider() + +  : array<string|int, mixed> +
                                      + +
                                      + testCaInfoFile() + +  : void +
                                      + +
                                      + testInvalidCAException() + +  : void +
                                      + +
                                      + testLargeBody() + +  : void +
                                      + +
                                      + testRequestMethods() + +  : void +
                                      + +
                                      + testRequestMethodsWithFormBody() + +  : void +
                                      + +
                                      + testRequestMethodsWithJsonBody() + +  : void +
                                      + +
                                      + createHandle() + +  : CurlHandle +
                                      + +
                                      + setUp() + +  : void +
                                      + +
                                      + + + + + + + +
                                      +

                                      + Properties + + +

                                      +
                                      +

                                      + $HTTP_CLIENT_FACTORY + + + + +

                                      + + + + + protected + string + $HTTP_CLIENT_FACTORY + = \chillerlan\HTTPTest\ClientFactories\CurlClientFactory::class + + + + + +
                                      +
                                      + +
                                      +

                                      + Methods + + +

                                      +
                                      +

                                      + caOptionProvider() + + +

                                      + + + + + public + static caOptionProvider() : array<string|int, mixed> + +
                                      +
                                      + + + + +
                                      +
                                      Return values
                                      + array<string|int, mixed> +
                                      + +
                                      +
                                      +

                                      + invalidCaOptionProvider() + + +

                                      + + + + + public + static invalidCaOptionProvider() : array<string|int, mixed> + +
                                      +
                                      + + + + +
                                      +
                                      Return values
                                      + array<string|int, mixed> +
                                      + +
                                      +
                                      +

                                      + requestMethodProvider() + + +

                                      + + + + + public + static requestMethodProvider() : array<string|int, mixed> + +
                                      +
                                      + + + + +
                                      +
                                      Return values
                                      + array<string|int, mixed> +
                                      + +
                                      +
                                      +

                                      + requestMethodWithBodyProvider() + + +

                                      + + + + + public + static requestMethodWithBodyProvider() : array<string|int, mixed> + +
                                      +
                                      + + + + +
                                      +
                                      Return values
                                      + array<string|int, mixed> +
                                      + +
                                      +
                                      +

                                      + testCaInfoFile() + + +

                                      + + + + + public + testCaInfoFile(string $option, mixed $value, string $expectedPath, int $curl_opt, int $curl_opt_not) : void + +
                                      +
                                      + +
                                      Parameters
                                      +
                                      +
                                      + $option + : string +
                                      +
                                      + +
                                      +
                                      + $value + : mixed +
                                      +
                                      + +
                                      +
                                      + $expectedPath + : string +
                                      +
                                      + +
                                      +
                                      + $curl_opt + : int +
                                      +
                                      + +
                                      +
                                      + $curl_opt_not + : int +
                                      +
                                      + +
                                      +
                                      + + + + +
                                      +
                                      +

                                      + testInvalidCAException() + + +

                                      + + + + + public + testInvalidCAException(string $option, mixed $value) : void + +
                                      +
                                      + +
                                      Parameters
                                      +
                                      +
                                      + $option + : string +
                                      +
                                      + +
                                      +
                                      + $value + : mixed +
                                      +
                                      + +
                                      +
                                      + + + + +
                                      +
                                      +

                                      + testLargeBody() + + +

                                      + + + + + public + testLargeBody() : void + +
                                      +
                                      + + + + + +
                                      +
                                      +

                                      + testRequestMethods() + + +

                                      + + + + + public + testRequestMethods(string $method) : void + +
                                      +
                                      + +
                                      Parameters
                                      +
                                      +
                                      + $method + : string +
                                      +
                                      + +
                                      +
                                      + + + + +
                                      +
                                      +

                                      + testRequestMethodsWithFormBody() + + +

                                      + + + + + public + testRequestMethodsWithFormBody(string $method) : void + +
                                      +
                                      + +
                                      Parameters
                                      +
                                      +
                                      + $method + : string +
                                      +
                                      + +
                                      +
                                      + + + + +
                                      +
                                      +

                                      + testRequestMethodsWithJsonBody() + + +

                                      + + + + + public + testRequestMethodsWithJsonBody(string $method) : void + +
                                      +
                                      + +
                                      Parameters
                                      +
                                      +
                                      + $method + : string +
                                      +
                                      + +
                                      +
                                      + + + + +
                                      +
                                      +

                                      + createHandle() + + +

                                      + + + + + protected + createHandle(HTTPOptions $options[, string $method = 'GET' ]) : CurlHandle + +
                                      +
                                      + +
                                      Parameters
                                      +
                                      +
                                      + $options + : HTTPOptions +
                                      +
                                      + +
                                      +
                                      + $method + : string + = 'GET'
                                      +
                                      + +
                                      +
                                      + + + +
                                      +
                                      Return values
                                      + CurlHandle +
                                      + +
                                      +
                                      +

                                      + setUp() + + +

                                      + + + + + protected + setUp() : void + +
                                      +
                                      + + + + + +
                                      +
                                      + +
                                      +
                                      +
                                      +
                                      +
                                      
                                      +        
                                      + +
                                      +
                                      + + + +
                                      +
                                      +
                                      + +
                                      + On this page + + +
                                      + +
                                      +
                                      +
                                      +
                                      +
                                      +

                                      Search results

                                      + +
                                      +
                                      +
                                        +
                                        +
                                        +
                                        +
                                        + + +
                                        + + + + + + + + diff --git a/classes/chillerlan-HTTPTest-CurlMultiClientTest.html b/classes/chillerlan-HTTPTest-CurlMultiClientTest.html new file mode 100644 index 00000000..1a222ac4 --- /dev/null +++ b/classes/chillerlan-HTTPTest-CurlMultiClientTest.html @@ -0,0 +1,621 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                        +

                                        Documentation

                                        + + + + + +
                                        + +
                                        +
                                        + + + + +
                                        +
                                        + + +
                                        +

                                        + CurlMultiClientTest + + + extends TestCase + + +
                                        + in package + +
                                        + + + + Uses + HttpFactoryTrait +

                                        + +
                                        + +
                                        FinalYes
                                        + + +
                                        + + + + + + + + + +

                                        + Table of Contents + + +

                                        + + + + + + + + + +

                                        + Properties + + +

                                        +
                                        +
                                        + $http + +  : CurlMultiClient +
                                        + +
                                        + $multiResponseHandler + +  : MultiResponseHandlerInterface +
                                        + +
                                        + +

                                        + Methods + + +

                                        +
                                        +
                                        + testEmptyStackException() + +  : void +
                                        + +
                                        + testMultiRequest() + +  : void +
                                        + +
                                        + setUp() + +  : void +
                                        + +
                                        + getRequests() + +  : array<string|int, mixed> +
                                        + +
                                        + getTestResponseHandler() + +  : MultiResponseHandlerInterface +
                                        + +
                                        + + + + + + + +
                                        +

                                        + Properties + + +

                                        + + +
                                        + +
                                        +

                                        + Methods + + +

                                        +
                                        +

                                        + testEmptyStackException() + + +

                                        + + + + + public + testEmptyStackException() : void + +
                                        +
                                        + + + + + +
                                        +
                                        +

                                        + testMultiRequest() + + +

                                        + + + + + public + testMultiRequest() : void + +
                                        +
                                        + + + + + +
                                        + +
                                        +

                                        + getRequests() + + +

                                        + + + + + private + getRequests() : array<string|int, mixed> + +
                                        +
                                        + + + + +
                                        +
                                        Return values
                                        + array<string|int, mixed> +
                                        + +
                                        + +
                                        + +
                                        +
                                        +
                                        +
                                        +
                                        
                                        +        
                                        + +
                                        +
                                        + + + +
                                        +
                                        +
                                        + +
                                        + On this page + + +
                                        + +
                                        +
                                        +
                                        +
                                        +
                                        +

                                        Search results

                                        + +
                                        +
                                        +
                                          +
                                          +
                                          +
                                          +
                                          + + +
                                          + + + + + + + + diff --git a/classes/chillerlan-HTTPTest-HTTPClientTestAbstract.html b/classes/chillerlan-HTTPTest-HTTPClientTestAbstract.html new file mode 100644 index 00000000..c194ee50 --- /dev/null +++ b/classes/chillerlan-HTTPTest-HTTPClientTestAbstract.html @@ -0,0 +1,492 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                          +

                                          Documentation

                                          + + + + + +
                                          + +
                                          +
                                          + + + + +
                                          +
                                          + + +
                                          +

                                          + HTTPClientTestAbstract + + + extends TestCase + + +
                                          + in package + +
                                          + + + + Uses + HttpFactoryTrait +

                                          + +
                                          + + +
                                          AbstractYes
                                          + +
                                          + + + + + + + + + +

                                          + Table of Contents + + +

                                          + + + + + + + +

                                          + Constants + + +

                                          +
                                          +
                                          + USER_AGENT + +  = 'chillerlanHttpTest/2.0' +
                                          + +
                                          + + + +

                                          + Methods + + +

                                          +
                                          +
                                          + testNetworkError() + +  : void +
                                          + +
                                          + testSendRequest() + +  : void +
                                          + +
                                          + setUp() + +  : void +
                                          + +
                                          + + + + + +
                                          +

                                          + Constants + + +

                                          +
                                          +

                                          + USER_AGENT + + +

                                          + + + + + + public + mixed + USER_AGENT + = 'chillerlanHttpTest/2.0' + + + + + + + +
                                          +
                                          + + + +
                                          +

                                          + Methods + + +

                                          +
                                          +

                                          + testNetworkError() + + +

                                          + + + + + public + testNetworkError() : void + +
                                          +
                                          + + + + + +
                                          +
                                          +

                                          + testSendRequest() + + +

                                          + + + + + public + testSendRequest() : void + +
                                          +
                                          + + + + + +
                                          + +
                                          + +
                                          +
                                          +
                                          +
                                          +
                                          
                                          +        
                                          + +
                                          +
                                          + + + +
                                          +
                                          +
                                          + +
                                          + On this page + + +
                                          + +
                                          +
                                          +
                                          +
                                          +
                                          +

                                          Search results

                                          + +
                                          +
                                          +
                                            +
                                            +
                                            +
                                            +
                                            + + +
                                            + + + + + + + + diff --git a/classes/chillerlan-HTTPTest-HTTPOptionsTest.html b/classes/chillerlan-HTTPTest-HTTPOptionsTest.html new file mode 100644 index 00000000..b5dfcf5c --- /dev/null +++ b/classes/chillerlan-HTTPTest-HTTPOptionsTest.html @@ -0,0 +1,434 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                            +

                                            Documentation

                                            + + + + + +
                                            + +
                                            +
                                            + + + + +
                                            +
                                            + + +
                                            +

                                            + HTTPOptionsTest + + + extends TestCase + + +
                                            + in package + +
                                            + + +

                                            + +
                                            + +
                                            FinalYes
                                            + + +
                                            + + + + + + + + + +

                                            + Table of Contents + + +

                                            + + + + + + + + + + +

                                            + Methods + + +

                                            +
                                            +
                                            + testInvalidUserAgentException() + +  : void +
                                            + +
                                            + testSetDnsOverHttpsURL() + +  : void +
                                            + +
                                            + testSetDnsOverHttpsURLException() + +  : void +
                                            + +
                                            + + + + + + + + +
                                            +

                                            + Methods + + +

                                            +
                                            +

                                            + testInvalidUserAgentException() + + +

                                            + + + + + public + testInvalidUserAgentException() : void + +
                                            +
                                            + + + + + +
                                            +
                                            +

                                            + testSetDnsOverHttpsURL() + + +

                                            + + + + + public + testSetDnsOverHttpsURL() : void + +
                                            +
                                            + + + + + +
                                            +
                                            +

                                            + testSetDnsOverHttpsURLException() + + +

                                            + + + + + public + testSetDnsOverHttpsURLException() : void + +
                                            +
                                            + + + + + +
                                            +
                                            + +
                                            +
                                            +
                                            +
                                            +
                                            
                                            +        
                                            + +
                                            +
                                            + + + +
                                            +
                                            +
                                            + +
                                            + On this page + + +
                                            + +
                                            +
                                            +
                                            +
                                            +
                                            +

                                            Search results

                                            + +
                                            +
                                            +
                                              +
                                              +
                                              +
                                              +
                                              + + +
                                              + + + + + + + + diff --git a/classes/chillerlan-HTTPTest-StreamClientNoCATest.html b/classes/chillerlan-HTTPTest-StreamClientNoCATest.html new file mode 100644 index 00000000..35d6a6a7 --- /dev/null +++ b/classes/chillerlan-HTTPTest-StreamClientNoCATest.html @@ -0,0 +1,549 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                              +

                                              Documentation

                                              + + + + + +
                                              + +
                                              +
                                              + + + + +
                                              +
                                              + + +
                                              +

                                              + StreamClientNoCATest + + + extends HTTPClientTestAbstract + + +
                                              + in package + +
                                              + + +

                                              + +
                                              + +
                                              FinalYes
                                              + + +
                                              + + + + + + + + + +

                                              + Table of Contents + + +

                                              + + + + + + + +

                                              + Constants + + +

                                              +
                                              +
                                              + USER_AGENT + +  = 'chillerlanHttpTest/2.0' +
                                              + +
                                              + + +

                                              + Properties + + +

                                              +
                                              +
                                              + $HTTP_CLIENT_FACTORY + +  : string +
                                              + +
                                              + +

                                              + Methods + + +

                                              +
                                              +
                                              + testNetworkError() + +  : void +
                                              + +
                                              + testSendRequest() + +  : void +
                                              + +
                                              + setUp() + +  : void +
                                              + +
                                              + + + + + +
                                              +

                                              + Constants + + +

                                              +
                                              +

                                              + USER_AGENT + + +

                                              + + + + + + public + mixed + USER_AGENT + = 'chillerlanHttpTest/2.0' + + + + + + + +
                                              +
                                              + + +
                                              +

                                              + Properties + + +

                                              +
                                              +

                                              + $HTTP_CLIENT_FACTORY + + + + +

                                              + + + + + protected + string + $HTTP_CLIENT_FACTORY + = \chillerlan\HTTPTest\ClientFactories\StreamClientNoCAFactory::class + + + + + +
                                              +
                                              + +
                                              +

                                              + Methods + + +

                                              +
                                              +

                                              + testNetworkError() + + +

                                              + + + + + public + testNetworkError() : void + +
                                              +
                                              + + + + + +
                                              +
                                              +

                                              + testSendRequest() + + +

                                              + + + + + public + testSendRequest() : void + +
                                              +
                                              + + + + + +
                                              + +
                                              + +
                                              +
                                              +
                                              +
                                              +
                                              
                                              +        
                                              + +
                                              +
                                              + + + +
                                              +
                                              +
                                              + +
                                              + On this page + + +
                                              + +
                                              +
                                              +
                                              +
                                              +
                                              +

                                              Search results

                                              + +
                                              +
                                              +
                                                +
                                                +
                                                +
                                                +
                                                + + +
                                                + + + + + + + + diff --git a/classes/chillerlan-HTTPTest-StreamClientTest.html b/classes/chillerlan-HTTPTest-StreamClientTest.html new file mode 100644 index 00000000..ad169e14 --- /dev/null +++ b/classes/chillerlan-HTTPTest-StreamClientTest.html @@ -0,0 +1,549 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                +

                                                Documentation

                                                + + + + + +
                                                + +
                                                +
                                                + + + + +
                                                +
                                                + + +
                                                +

                                                + StreamClientTest + + + extends HTTPClientTestAbstract + + +
                                                + in package + +
                                                + + +

                                                + +
                                                + +
                                                FinalYes
                                                + + +
                                                + + + + + + + + + +

                                                + Table of Contents + + +

                                                + + + + + + + +

                                                + Constants + + +

                                                +
                                                +
                                                + USER_AGENT + +  = 'chillerlanHttpTest/2.0' +
                                                + +
                                                + + +

                                                + Properties + + +

                                                +
                                                +
                                                + $HTTP_CLIENT_FACTORY + +  : string +
                                                + +
                                                + +

                                                + Methods + + +

                                                +
                                                +
                                                + testNetworkError() + +  : void +
                                                + +
                                                + testSendRequest() + +  : void +
                                                + +
                                                + setUp() + +  : void +
                                                + +
                                                + + + + + +
                                                +

                                                + Constants + + +

                                                +
                                                +

                                                + USER_AGENT + + +

                                                + + + + + + public + mixed + USER_AGENT + = 'chillerlanHttpTest/2.0' + + + + + + + +
                                                +
                                                + + +
                                                +

                                                + Properties + + +

                                                +
                                                +

                                                + $HTTP_CLIENT_FACTORY + + + + +

                                                + + + + + protected + string + $HTTP_CLIENT_FACTORY + = \chillerlan\HTTPTest\ClientFactories\StreamClientFactory::class + + + + + +
                                                +
                                                + +
                                                +

                                                + Methods + + +

                                                +
                                                +

                                                + testNetworkError() + + +

                                                + + + + + public + testNetworkError() : void + +
                                                +
                                                + + + + + +
                                                +
                                                +

                                                + testSendRequest() + + +

                                                + + + + + public + testSendRequest() : void + +
                                                +
                                                + + + + + +
                                                + +
                                                + +
                                                +
                                                +
                                                +
                                                +
                                                
                                                +        
                                                + +
                                                +
                                                + + + +
                                                +
                                                +
                                                + +
                                                + On this page + + +
                                                + +
                                                +
                                                +
                                                +
                                                +
                                                +

                                                Search results

                                                + +
                                                +
                                                +
                                                  +
                                                  +
                                                  +
                                                  +
                                                  + + +
                                                  + + + + + + + + diff --git a/composer.json b/composer.json deleted file mode 100644 index bc0469a3..00000000 --- a/composer.json +++ /dev/null @@ -1,67 +0,0 @@ -{ - "name": "chillerlan/php-httpinterface", - "description": "A PSR-7/17/18 http message/client implementation", - "license": "MIT", - "type": "library", - "keywords": [ - "http", "request", "response", "message", "client", "factory", "psr-7", "psr-17", "psr-18" - ], - "authors": [ - { - "name": "smiley", - "email": "smiley@chillerlan.net", - "homepage": "https://github.com/codemasher" - } - ], - "support": { - "issues": "https://github.com/chillerlan/php-httpinterface/issues", - "source": "https://github.com/chillerlan/php-httpinterface" - }, - "provide": { - "psr/http-client-implementation": "1.0", - "psr/http-factory-implementation": "1.0", - "psr/http-message-implementation": "1.0" - }, - "minimum-stability": "stable", - "prefer-stable": true, - "require": { - "php": "^8.1", - "ext-curl": "*", - "chillerlan/php-http-message-utils": "^2.2", - "chillerlan/php-settings-container": "^3.1.1", - "chillerlan/psr-7": "^1.0", - "psr/http-client": "^1.0", - "psr/http-message": "^1.1 || ^2.0", - "psr/http-factory": "^1.0", - "psr/log": "^1.1 || ^2.0 || ^3.0" - }, - "require-dev": { - "chillerlan/phpunit-http": "^1.0", - "phan/phan": "^5.4", - "phpmd/phpmd": "^2.15", - "phpunit/phpunit": "^10.5", - "squizlabs/php_codesniffer": "^3.9" - }, - "suggest": { - "chillerlan/php-oauth": "A PSR-7 OAuth client/handler that also acts as PSR-18 HTTP client" - }, - "autoload": { - "psr-4": { - "chillerlan\\HTTP\\": "src/" - } - }, - "autoload-dev": { - "psr-4": { - "chillerlan\\HTTPTest\\": "tests/" - } - }, - "scripts": { - "phpunit": "@php vendor/bin/phpunit", - "phan": "@php vendor/bin/phan" - }, - "config": { - "lock": false, - "sort-packages": true, - "platform-check": true - } -} diff --git a/css/base.css b/css/base.css new file mode 100644 index 00000000..55594cfe --- /dev/null +++ b/css/base.css @@ -0,0 +1,1231 @@ + + +:root { + /* Typography */ + --font-primary: 'Open Sans', Helvetica, Arial, sans-serif; + --font-secondary: 'Open Sans', Helvetica, Arial, sans-serif; + --font-monospace: 'Source Code Pro', monospace; + --line-height--primary: 1.6; + --letter-spacing--primary: .05rem; + --text-base-size: 1em; + --text-scale-ratio: 1.2; + + --text-xxs: calc(var(--text-base-size) / var(--text-scale-ratio) / var(--text-scale-ratio) / var(--text-scale-ratio)); + --text-xs: calc(var(--text-base-size) / var(--text-scale-ratio) / var(--text-scale-ratio)); + --text-sm: calc(var(--text-base-size) / var(--text-scale-ratio)); + --text-md: var(--text-base-size); + --text-lg: calc(var(--text-base-size) * var(--text-scale-ratio)); + --text-xl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio)); + --text-xxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio)); + --text-xxxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio)); + --text-xxxxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio)); + --text-xxxxxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio)); + + --color-hue-red: 4; + --color-hue-pink: 340; + --color-hue-purple: 291; + --color-hue-deep-purple: 262; + --color-hue-indigo: 231; + --color-hue-blue: 207; + --color-hue-light-blue: 199; + --color-hue-cyan: 187; + --color-hue-teal: 174; + --color-hue-green: 122; + --color-hue-phpdocumentor-green: 96; + --color-hue-light-green: 88; + --color-hue-lime: 66; + --color-hue-yellow: 54; + --color-hue-amber: 45; + --color-hue-orange: 36; + --color-hue-deep-orange: 14; + --color-hue-brown: 16; + + /* Colors */ + --primary-color-hue: var(--color-hue-deep-purple, --color-hue-phpdocumentor-green); + --primary-color-saturation: 57%; + --primary-color: hsl(var(--primary-color-hue), var(--primary-color-saturation), 60%); + --primary-color-darken: hsl(var(--primary-color-hue), var(--primary-color-saturation), 40%); + --primary-color-darker: hsl(var(--primary-color-hue), var(--primary-color-saturation), 25%); + --primary-color-darkest: hsl(var(--primary-color-hue), var(--primary-color-saturation), 10%); + --primary-color-lighten: hsl(var(--primary-color-hue), calc(var(--primary-color-saturation) - 20%), 85%); + --primary-color-lighter: hsl(var(--primary-color-hue), calc(var(--primary-color-saturation) - 45%), 97.5%); + --dark-gray: #d1d1d1; + --light-gray: #f0f0f0; + + --text-color: var(--primary-color-darkest); + + --header-height: var(--spacing-xxxxl); + --header-bg-color: var(--primary-color); + --code-background-color: var(--primary-color-lighter); + --code-border-color: --primary-color-lighten; + --button-border-color: var(--primary-color-darken); + --button-color: transparent; + --button-color-primary: var(--primary-color); + --button-text-color: #555; + --button-text-color-primary: white; + --popover-background-color: rgba(255, 255, 255, 0.75); + --link-color-primary: var(--primary-color-darker); + --link-hover-color-primary: var(--primary-color-darkest); + --form-field-border-color: var(--dark-gray); + --form-field-color: #fff; + --admonition-success-color: var(--primary-color); + --admonition-border-color: silver; + --table-separator-color: var(--primary-color-lighten); + --title-text-color: var(--primary-color); + + --sidebar-border-color: var(--primary-color-lighten); + + /* Grid */ + --container-width: 1400px; + + /* Spacing */ + --spacing-base-size: 1rem; + --spacing-scale-ratio: 1.5; + + --spacing-xxxs: calc(var(--spacing-base-size) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio)); + --spacing-xxs: calc(var(--spacing-base-size) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio)); + --spacing-xs: calc(var(--spacing-base-size) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio)); + --spacing-sm: calc(var(--spacing-base-size) / var(--spacing-scale-ratio)); + --spacing-md: var(--spacing-base-size); + --spacing-lg: calc(var(--spacing-base-size) * var(--spacing-scale-ratio)); + --spacing-xl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio)); + --spacing-xxl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio)); + --spacing-xxxl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio)); + --spacing-xxxxl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio)); + + --border-radius-base-size: 3px; +} + +/* Base Styles +-------------------------------------------------- */ +body { + color: var(--text-color); + font-family: var(--font-primary); + font-size: var(--text-md); + letter-spacing: var(--letter-spacing--primary); + line-height: var(--line-height--primary); + width: 100%; +} + +.phpdocumentor h1, +.phpdocumentor h2, +.phpdocumentor h3, +.phpdocumentor h4, +.phpdocumentor h5, +.phpdocumentor h6 { + margin-bottom: var(--spacing-lg); + margin-top: var(--spacing-lg); + font-weight: 600; +} + +.phpdocumentor h1 { + font-size: var(--text-xxxxl); + letter-spacing: var(--letter-spacing--primary); + line-height: 1.2; + margin-top: 0; +} + +.phpdocumentor h2 { + font-size: var(--text-xxxl); + letter-spacing: var(--letter-spacing--primary); + line-height: 1.25; +} + +.phpdocumentor h3 { + font-size: var(--text-xxl); + letter-spacing: var(--letter-spacing--primary); + line-height: 1.3; +} + +.phpdocumentor h4 { + font-size: var(--text-xl); + letter-spacing: calc(var(--letter-spacing--primary) / 2); + line-height: 1.35; + margin-bottom: var(--spacing-md); +} + +.phpdocumentor h5 { + font-size: var(--text-lg); + letter-spacing: calc(var(--letter-spacing--primary) / 4); + line-height: 1.5; + margin-bottom: var(--spacing-md); + margin-top: var(--spacing-md); +} + +.phpdocumentor h6 { + font-size: var(--text-md); + letter-spacing: 0; + line-height: var(--line-height--primary); + margin-bottom: var(--spacing-md); + margin-top: var(--spacing-md); +} +.phpdocumentor h1 .headerlink, +.phpdocumentor h2 .headerlink, +.phpdocumentor h3 .headerlink, +.phpdocumentor h4 .headerlink, +.phpdocumentor h5 .headerlink, +.phpdocumentor h6 .headerlink +{ + display: none; +} + +@media (min-width: 550px) { + .phpdocumentor h1 .headerlink, + .phpdocumentor h2 .headerlink, + .phpdocumentor h3 .headerlink, + .phpdocumentor h4 .headerlink, + .phpdocumentor h5 .headerlink, + .phpdocumentor h6 .headerlink { + display: inline; + transition: all .3s ease-in-out; + opacity: 0; + text-decoration: none; + color: silver; + font-size: 80%; + } + + .phpdocumentor h1:hover .headerlink, + .phpdocumentor h2:hover .headerlink, + .phpdocumentor h3:hover .headerlink, + .phpdocumentor h4:hover .headerlink, + .phpdocumentor h5:hover .headerlink, + .phpdocumentor h6:hover .headerlink { + opacity: 1; + } +} +.phpdocumentor p { + margin-top: 0; + margin-bottom: var(--spacing-md); +} +.phpdocumentor figure { + margin-bottom: var(--spacing-md); +} + +.phpdocumentor figcaption { + text-align: center; + font-style: italic; + font-size: 80%; +} + +.phpdocumentor-uml-diagram svg { + max-width: 100%; + height: auto !important; +} +.phpdocumentor-line { + border-top: 1px solid #E1E1E1; + border-width: 0; + margin-bottom: var(--spacing-xxl); + margin-top: var(--spacing-xxl); +} +.phpdocumentor-section { + box-sizing: border-box; + margin: 0 auto; + max-width: var(--container-width); + padding: 0 var(--spacing-sm); + position: relative; + width: 100%; +} + +@media (min-width: 550px) { + .phpdocumentor-section { + padding: 0 var(--spacing-lg); + } +} + +@media (min-width: 1200px) { + .phpdocumentor-section { + padding: 0; + width: 95%; + } +} +.phpdocumentor-column { + box-sizing: border-box; + float: left; + width: 100%; +} + +@media (min-width: 550px) { + .phpdocumentor-column { + margin-left: 4%; + } + + .phpdocumentor-column:first-child { + margin-left: 0; + } + + .-one.phpdocumentor-column { + width: 4.66666666667%; + } + + .-two.phpdocumentor-column { + width: 13.3333333333%; + } + + .-three.phpdocumentor-column { + width: 22%; + } + + .-four.phpdocumentor-column { + width: 30.6666666667%; + } + + .-five.phpdocumentor-column { + width: 39.3333333333%; + } + + .-six.phpdocumentor-column { + width: 48%; + } + + .-seven.phpdocumentor-column { + width: 56.6666666667%; + } + + .-eight.phpdocumentor-column { + width: 65.3333333333%; + } + + .-nine.phpdocumentor-column { + width: 74.0%; + } + + .-ten.phpdocumentor-column { + width: 82.6666666667%; + } + + .-eleven.phpdocumentor-column { + width: 91.3333333333%; + } + + .-twelve.phpdocumentor-column { + margin-left: 0; + width: 100%; + } + + .-one-third.phpdocumentor-column { + width: 30.6666666667%; + } + + .-two-thirds.phpdocumentor-column { + width: 65.3333333333%; + } + + .-one-half.phpdocumentor-column { + width: 48%; + } + + /* Offsets */ + .-offset-by-one.phpdocumentor-column { + margin-left: 8.66666666667%; + } + + .-offset-by-two.phpdocumentor-column { + margin-left: 17.3333333333%; + } + + .-offset-by-three.phpdocumentor-column { + margin-left: 26%; + } + + .-offset-by-four.phpdocumentor-column { + margin-left: 34.6666666667%; + } + + .-offset-by-five.phpdocumentor-column { + margin-left: 43.3333333333%; + } + + .-offset-by-six.phpdocumentor-column { + margin-left: 52%; + } + + .-offset-by-seven.phpdocumentor-column { + margin-left: 60.6666666667%; + } + + .-offset-by-eight.phpdocumentor-column { + margin-left: 69.3333333333%; + } + + .-offset-by-nine.phpdocumentor-column { + margin-left: 78.0%; + } + + .-offset-by-ten.phpdocumentor-column { + margin-left: 86.6666666667%; + } + + .-offset-by-eleven.phpdocumentor-column { + margin-left: 95.3333333333%; + } + + .-offset-by-one-third.phpdocumentor-column { + margin-left: 34.6666666667%; + } + + .-offset-by-two-thirds.phpdocumentor-column { + margin-left: 69.3333333333%; + } + + .-offset-by-one-half.phpdocumentor-column { + margin-left: 52%; + } +} +.phpdocumentor a { + color: var(--link-color-primary); +} + +.phpdocumentor a:hover { + color: var(--link-hover-color-primary); +} +.phpdocumentor-button { + background-color: var(--button-color); + border: 1px solid var(--button-border-color); + border-radius: var(--border-radius-base-size); + box-sizing: border-box; + color: var(--button-text-color); + cursor: pointer; + display: inline-block; + font-size: var(--text-sm); + font-weight: 600; + height: 38px; + letter-spacing: .1rem; + line-height: 38px; + padding: 0 var(--spacing-xxl); + text-align: center; + text-decoration: none; + text-transform: uppercase; + white-space: nowrap; + margin-bottom: var(--spacing-md); +} + +.phpdocumentor-button .-wide { + width: 100%; +} + +.phpdocumentor-button:hover, +.phpdocumentor-button:focus { + border-color: #888; + color: #333; + outline: 0; +} + +.phpdocumentor-button.-primary { + background-color: var(--button-color-primary); + border-color: var(--button-color-primary); + color: var(--button-text-color-primary); +} + +.phpdocumentor-button.-primary:hover, +.phpdocumentor-button.-primary:focus { + background-color: var(--link-color-primary); + border-color: var(--link-color-primary); + color: var(--button-text-color-primary); +} +.phpdocumentor form { + margin-bottom: var(--spacing-md); +} + +.phpdocumentor-field { + background-color: var(--form-field-color); + border: 1px solid var(--form-field-border-color); + border-radius: var(--border-radius-base-size); + box-shadow: none; + box-sizing: border-box; + height: 38px; + padding: var(--spacing-xxxs) var(--spacing-xxs); /* The 6px vertically centers text on FF, ignored by Webkit */ + margin-bottom: var(--spacing-md); +} + +/* Removes awkward default styles on some inputs for iOS */ +input[type="email"], +input[type="number"], +input[type="search"], +input[type="text"], +input[type="tel"], +input[type="url"], +input[type="password"], +textarea { + -moz-appearance: none; + -webkit-appearance: none; + appearance: none; +} + +.phpdocumentor-textarea { + min-height: 65px; + padding-bottom: var(--spacing-xxxs); + padding-top: var(--spacing-xxxs); +} + +.phpdocumentor-field:focus { + border: 1px solid var(--button-color-primary); + outline: 0; +} + +label.phpdocumentor-label { + display: block; + margin-bottom: var(--spacing-xs); +} + +.phpdocumentor-fieldset { + border-width: 0; + padding: 0; +} + +input[type="checkbox"].phpdocumentor-field, +input[type="radio"].phpdocumentor-field { + display: inline; +} +.phpdocumentor-column ul, +div.phpdocumentor-list > ul, +ul.phpdocumentor-list { + list-style: circle; +} + +.phpdocumentor-column ol, +div.phpdocumentor-list > ol, +ol.phpdocumentor-list { + list-style: decimal; +} + + +.phpdocumentor-column ul, +div.phpdocumentor-list > ul, +ol.phpdocumentor-list, +ul.phpdocumentor-list { + margin-top: 0; + padding-left: var(--spacing-md); + margin-bottom: var(--spacing-sm); +} + +.phpdocumentor-column ul.-clean, +div.phpdocumentor-list > ul.-clean, +ul.phpdocumentor-list.-clean { + list-style: none; + padding-left: 0; +} + +dl { + margin-bottom: var(--spacing-md); +} + +.phpdocumentor-column ul ul, +div.phpdocumentor-list > ul ul, +ul.phpdocumentor-list ul.phpdocumentor-list, +ul.phpdocumentor-list ol.phpdocumentor-list, +ol.phpdocumentor-list ol.phpdocumentor-list, +ol.phpdocumentor-list ul.phpdocumentor-list { + font-size: var(--text-sm); + margin: 0 0 0 calc(var(--spacing-xs) * 2); +} + +.phpdocumentor-column ul li, +.phpdocumentor-list li { + padding-bottom: var(--spacing-xs); +} + +.phpdocumentor dl dt { + margin-bottom: var(--spacing-xs); +} + +.phpdocumentor dl dd { + margin-bottom: var(--spacing-md); +} +.phpdocumentor pre { + margin-bottom: var(--spacing-md); +} + +.phpdocumentor-code { + font-family: var(--font-monospace); + background: var(--code-background-color); + border: 1px solid var(--code-border-color); + border-radius: var(--border-radius-base-size); + font-size: var(--text-sm); + padding: var(--spacing-sm) var(--spacing-md); + width: 100%; + box-sizing: border-box; +} + +.phpdocumentor-code.-dark { + background: var(--primary-color-darkest); + color: var(--light-gray); + box-shadow: 0 2px 3px var(--dark-gray); +} + +pre > .phpdocumentor-code { + display: block; + white-space: pre; +} +.phpdocumentor blockquote { + border-left: 4px solid var(--primary-color-darken); + margin: var(--spacing-md) 0; + padding: var(--spacing-xs) var(--spacing-sm); + color: var(--primary-color-darker); + font-style: italic; +} + +.phpdocumentor blockquote p:last-of-type { + margin-bottom: 0; +} +.phpdocumentor table { + margin-bottom: var(--spacing-md); +} + +th.phpdocumentor-heading, +td.phpdocumentor-cell { + border-bottom: 1px solid var(--table-separator-color); + padding: var(--spacing-sm) var(--spacing-md); + text-align: left; +} + +th.phpdocumentor-heading:first-child, +td.phpdocumentor-cell:first-child { + padding-left: 0; +} + +th.phpdocumentor-heading:last-child, +td.phpdocumentor-cell:last-child { + padding-right: 0; +} +.phpdocumentor-label-line { + display: flex; + flex-direction: row; + gap: 1rem +} + +.phpdocumentor-label { + background: #f6f6f6; + border-radius: .25rem; + font-size: 80%; + display: inline-block; + overflow: hidden +} + +/* +It would be better if the phpdocumentor-element class were to become a flex element with a gap, but for #3337 that +is too big a fix and needs to be done in a new design iteration. +*/ +.phpdocumentor-signature + .phpdocumentor-label-line .phpdocumentor-label { + margin-top: var(--spacing-sm); +} + +.phpdocumentor-label span { + display: inline-block; + padding: .125rem .5rem; +} + +.phpdocumentor-label--success span:last-of-type { + background: #abe1ab; +} + +.phpdocumentor-header { + display: flex; + flex-direction: row; + align-items: stretch; + flex-wrap: wrap; + justify-content: space-between; + height: auto; + padding: var(--spacing-md) var(--spacing-md); +} + +.phpdocumentor-header__menu-button { + position: absolute; + top: -100%; + left: -100%; +} + +.phpdocumentor-header__menu-icon { + font-size: 2rem; + color: var(--primary-color); +} + +.phpdocumentor-header__menu-button:checked ~ .phpdocumentor-topnav { + max-height: 250px; + padding-top: var(--spacing-md); +} + +@media (min-width: 1000px) { + .phpdocumentor-header { + flex-direction: row; + padding: var(--spacing-lg) var(--spacing-lg); + min-height: var(--header-height); + } + + .phpdocumentor-header__menu-icon { + display: none; + } +} + +@media (min-width: 1000px) { + .phpdocumentor-header { + padding-top: 0; + padding-bottom: 0; + } +} +@media (min-width: 1200px) { + .phpdocumentor-header { + padding: 0; + } +} +.phpdocumentor-title { + box-sizing: border-box; + color: var(--title-text-color); + font-size: var(--text-xxl); + letter-spacing: .05rem; + font-weight: normal; + width: auto; + margin: 0; + display: flex; + align-items: center; +} + +.phpdocumentor-title.-without-divider { + border: none; +} + +.phpdocumentor-title__link { + transition: all .3s ease-out; + display: flex; + color: var(--title-text-color); + text-decoration: none; + font-weight: normal; + white-space: nowrap; + transform: scale(.75); + transform-origin: left; +} + +.phpdocumentor-title__link:hover { + transform: perspective(15rem) translateX(.5rem); + font-weight: 600; +} + +@media (min-width: 1000px) { + .phpdocumentor-title { + width: 22%; + border-right: var(--sidebar-border-color) solid 1px; + } + + .phpdocumentor-title__link { + transform-origin: left; + } +} + +@media (min-width: 1000px) { + .phpdocumentor-title__link { + transform: scale(.85); + } +} + +@media (min-width: 1200px) { + .phpdocumentor-title__link { + transform: scale(1); + } +} +.phpdocumentor-topnav { + display: flex; + align-items: center; + margin: 0; + max-height: 0; + overflow: hidden; + transition: max-height 0.2s ease-out; + flex-basis: 100%; +} + +.phpdocumentor-topnav__menu { + text-align: right; + list-style: none; + margin: 0; + padding: 0; + flex: 1; + display: flex; + flex-flow: row wrap; + justify-content: center; +} + +.phpdocumentor-topnav__menu-item { + margin: 0; + width: 100%; + display: inline-block; + text-align: center; + padding: var(--spacing-sm) 0 +} + +.phpdocumentor-topnav__menu-item.-social { + width: auto; + padding: var(--spacing-sm) +} + +.phpdocumentor-topnav__menu-item a { + display: inline-block; + color: var(--text-color); + text-decoration: none; + font-size: var(--text-lg); + transition: all .3s ease-out; + border-bottom: 1px dotted transparent; + line-height: 1; +} + +.phpdocumentor-topnav__menu-item a:hover { + transform: perspective(15rem) translateY(.1rem); + border-bottom: 1px dotted var(--text-color); +} + +@media (min-width: 1000px) { + .phpdocumentor-topnav { + max-height: none; + overflow: visible; + flex-basis: auto; + } + + .phpdocumentor-topnav__menu { + display: flex; + flex-flow: row wrap; + justify-content: flex-end; + } + + .phpdocumentor-topnav__menu-item, + .phpdocumentor-topnav__menu-item.-social { + width: auto; + display: inline; + text-align: right; + padding: 0 0 0 var(--spacing-md) + } +} +.phpdocumentor-sidebar { + margin: 0; + overflow: hidden; + max-height: 0; +} + +.phpdocumentor .phpdocumentor-sidebar .phpdocumentor-list { + padding: var(--spacing-xs) var(--spacing-md); + list-style: none; + margin: 0; +} + +.phpdocumentor .phpdocumentor-sidebar li { + white-space: nowrap; + text-overflow: ellipsis; + overflow: hidden; + padding: 0 0 var(--spacing-xxxs) var(--spacing-md); +} + +.phpdocumentor .phpdocumentor-sidebar abbr, +.phpdocumentor .phpdocumentor-sidebar a { + text-decoration: none; + border-bottom: none; + color: var(--text-color); + font-size: var(--text-md); + padding-left: 0; + transition: padding-left .4s ease-out; +} + +.phpdocumentor .phpdocumentor-sidebar a:hover, +.phpdocumentor .phpdocumentor-sidebar a.-active { + padding-left: 5px; + font-weight: 600; +} + +.phpdocumentor .phpdocumentor-sidebar__category > * { + border-left: 1px solid var(--primary-color-lighten); +} + +.phpdocumentor .phpdocumentor-sidebar__category { + margin-bottom: var(--spacing-lg); +} + +.phpdocumentor .phpdocumentor-sidebar__category-header { + font-size: var(--text-md); + margin-top: 0; + margin-bottom: var(--spacing-xs); + color: var(--link-color-primary); + font-weight: 600; + border-left: 0; +} + +.phpdocumentor .phpdocumentor-sidebar__root-package, +.phpdocumentor .phpdocumentor-sidebar__root-namespace { + font-size: var(--text-md); + margin: 0; + padding-top: var(--spacing-xs); + padding-left: var(--spacing-md); + color: var(--text-color); + font-weight: normal; +} + +@media (min-width: 550px) { + .phpdocumentor-sidebar { + border-right: var(--sidebar-border-color) solid 1px; + } +} + +.phpdocumentor-sidebar__menu-button { + position: absolute; + top: -100%; + left: -100%; +} + +.phpdocumentor-sidebar__menu-icon { + font-size: var(--text-md); + font-weight: 600; + background: var(--primary-color); + color: white; + margin: 0 0 var(--spacing-lg); + display: block; + padding: var(--spacing-sm); + text-align: center; + border-radius: 3px; + text-transform: uppercase; + letter-spacing: .15rem; +} + +.phpdocumentor-sidebar__menu-button:checked ~ .phpdocumentor-sidebar { + max-height: 100%; + padding-top: var(--spacing-md); +} + +@media (min-width: 550px) { + .phpdocumentor-sidebar { + overflow: visible; + max-height: 100%; + } + + .phpdocumentor-sidebar__menu-icon { + display: none; + } +} +.phpdocumentor-admonition { + border: 1px solid var(--admonition-border-color); + border-radius: var(--border-radius-base-size); + border-color: var(--primary-color-lighten); + background-color: var(--primary-color-lighter); + padding: var(--spacing-lg); + margin: var(--spacing-lg) 0; + display: flex; + flex-direction: row; + align-items: flex-start; +} + +.phpdocumentor-admonition p:last-of-type { + margin-bottom: 0; +} + +.phpdocumentor-admonition--success, +.phpdocumentor-admonition.-success { + border-color: var(--admonition-success-color); +} + +.phpdocumentor-admonition__icon { + margin-right: var(--spacing-md); + color: var(--primary-color); + max-width: 3rem; +} +.phpdocumentor ul.phpdocumentor-breadcrumbs { + font-size: var(--text-md); + list-style: none; + margin: 0; + padding: 0; +} + +.phpdocumentor ul.phpdocumentor-breadcrumbs a { + color: var(--text-color); + text-decoration: none; +} + +.phpdocumentor ul.phpdocumentor-breadcrumbs > li { + display: inline-block; + margin: 0; +} + +.phpdocumentor ul.phpdocumentor-breadcrumbs > li + li:before { + color: var(--dark-gray); + content: "\\\A0"; + padding: 0; +} +.phpdocumentor .phpdocumentor-back-to-top { + position: fixed; + bottom: 2rem; + font-size: 2.5rem; + opacity: .25; + transition: all .3s ease-in-out; + right: 2rem; +} + +.phpdocumentor .phpdocumentor-back-to-top:hover { + color: var(--link-color-primary); + opacity: 1; +} +.phpdocumentor-search { + position: relative; + display: none; /** disable by default for non-js flow */ + opacity: .3; /** white-out default for loading indication */ + transition: opacity .3s, background .3s; + margin: var(--spacing-sm) 0; + flex: 1; + min-width: 100%; +} + +.phpdocumentor-search label { + display: flex; + align-items: center; + flex: 1; +} + +.phpdocumentor-search__icon { + color: var(--primary-color); + margin-right: var(--spacing-sm); + width: 1rem; + height: 1rem; +} + +.phpdocumentor-search--enabled { + display: flex; +} + +.phpdocumentor-search--active { + opacity: 1; +} + +.phpdocumentor-search input:disabled { + background-color: lightgray; +} + +.phpdocumentor-search__field:focus, +.phpdocumentor-search__field { + margin-bottom: 0; + border: 0; + border-bottom: 2px solid var(--primary-color); + padding: 0; + border-radius: 0; + flex: 1; +} + +@media (min-width: 1000px) { + .phpdocumentor-search { + min-width: auto; + max-width: 20rem; + margin: 0 0 0 auto; + } +} +.phpdocumentor-search-results { + backdrop-filter: blur(5px); + background: var(--popover-background-color); + position: fixed; + top: 0; + left: 0; + right: 0; + bottom: 0; + padding: 0; + opacity: 1; + pointer-events: all; + + transition: opacity .3s, background .3s; +} + +.phpdocumentor-search-results--hidden { + background: transparent; + backdrop-filter: blur(0); + opacity: 0; + pointer-events: none; +} + +.phpdocumentor-search-results__dialog { + width: 100%; + background: white; + max-height: 100%; + display: flex; + flex-direction: column; +} + +.phpdocumentor-search-results__body { + overflow: auto; +} + +.phpdocumentor-search-results__header { + padding: var(--spacing-lg); + display: flex; + justify-content: space-between; + background: var(--primary-color-darken); + color: white; + align-items: center; +} + +.phpdocumentor-search-results__close { + font-size: var(--text-xl); + background: none; + border: none; + padding: 0; + margin: 0; +} + +.phpdocumentor .phpdocumentor-search-results__title { + font-size: var(--text-xl); + margin-bottom: 0; +} + +.phpdocumentor-search-results__entries { + list-style: none; + padding: 0 var(--spacing-lg); + margin: 0; +} + +.phpdocumentor-search-results__entry { + border-bottom: 1px solid var(--table-separator-color); + padding: var(--spacing-sm) 0; + text-align: left; +} + +.phpdocumentor-search-results__entry a { + display: block; +} + +.phpdocumentor-search-results__entry small { + margin-top: var(--spacing-xs); + margin-bottom: var(--spacing-md); + color: var(--primary-color-darker); + display: block; + word-break: break-word; +} + +.phpdocumentor-search-results__entry h3 { + font-size: var(--text-lg); + margin: 0; +} + +@media (min-width: 550px) { + .phpdocumentor-search-results { + padding: 0 var(--spacing-lg); + } + + .phpdocumentor-search-results__entry h3 { + font-size: var(--text-xxl); + } + + .phpdocumentor-search-results__dialog { + margin: var(--spacing-xl) auto; + max-width: 40rem; + background: white; + border: 1px solid silver; + box-shadow: 0 2px 5px silver; + max-height: 40rem; + border-radius: 3px; + } +} +.phpdocumentor-modal { + position: fixed; + width: 100vw; + height: 100vh; + opacity: 0; + visibility: hidden; + transition: all 0.3s ease; + top: 0; + left: 0; + display: flex; + align-items: center; + justify-content: center; + z-index: 1; +} + +.phpdocumentor-modal__open { + visibility: visible; + opacity: 1; + transition-delay: 0s; +} + +.phpdocumentor-modal-bg { + position: absolute; + background: gray; + opacity: 50%; + width: 100%; + height: 100%; +} + +.phpdocumentor-modal-container { + border-radius: 1em; + background: #fff; + position: relative; + padding: 2em; + box-sizing: border-box; + max-width:100vw; +} + +.phpdocumentor-modal__close { + position: absolute; + right: 0.75em; + top: 0.75em; + outline: none; + appearance: none; + color: var(--primary-color); + background: none; + border: 0px; + font-weight: bold; + cursor: pointer; +} +.phpdocumentor-on-this-page__sidebar { + display: none; +} + +.phpdocumentor-on-this-page__title { + display: block; + font-weight: bold; + margin-bottom: var(--spacing-sm); + color: var(--link-color-primary); +} + +@media (min-width: 1000px) { + .phpdocumentor-on-this-page__sidebar { + display: block; + position: relative; + } + + .phpdocumentor-on-this-page__content::-webkit-scrollbar, + [scrollbars]::-webkit-scrollbar { + height: 8px; + width: 8px; + } + + .phpdocumentor-on-this-page__content::-webkit-scrollbar-corner, + [scrollbars]::-webkit-scrollbar-corner { + background: 0; + } + + .phpdocumentor-on-this-page__content::-webkit-scrollbar-thumb, + [scrollbars]::-webkit-scrollbar-thumb { + background: rgba(128,134,139,0.26); + border-radius: 8px; + } + + .phpdocumentor-on-this-page__content { + position: sticky; + height: calc(100vh - var(--header-height)); + overflow-y: auto; + border-left: 1px solid var(--sidebar-border-color); + padding-left: var(--spacing-lg); + font-size: 90%; + top: -1px; /* Needed for the javascript to make the .-stuck trick work */ + flex: 0 1 auto; + width: 15vw; + } + + .phpdocumentor-on-this-page__content.-stuck { + height: 100vh; + } + + .phpdocumentor-on-this-page__content li { + word-break: break-all; + line-height: normal; + } +} + +/* Used for screen readers and such */ +.visually-hidden { + display: none; +} + +.float-right { + float: right; +} + +.float-left { + float: left; +} diff --git a/css/normalize.css b/css/normalize.css new file mode 100644 index 00000000..653dc00a --- /dev/null +++ b/css/normalize.css @@ -0,0 +1,427 @@ +/*! normalize.css v3.0.2 | MIT License | git.io/normalize */ + +/** + * 1. Set default font family to sans-serif. + * 2. Prevent iOS text size adjust after orientation change, without disabling + * user zoom. + */ + +html { + font-family: sans-serif; /* 1 */ + -ms-text-size-adjust: 100%; /* 2 */ + -webkit-text-size-adjust: 100%; /* 2 */ +} + +/** + * Remove default margin. + */ + +body { + margin: 0; +} + +/* HTML5 display definitions + ========================================================================== */ + +/** + * Correct `block` display not defined for any HTML5 element in IE 8/9. + * Correct `block` display not defined for `details` or `summary` in IE 10/11 + * and Firefox. + * Correct `block` display not defined for `main` in IE 11. + */ + +article, +aside, +details, +figcaption, +figure, +footer, +header, +hgroup, +main, +menu, +nav, +section, +summary { + display: block; +} + +/** + * 1. Correct `inline-block` display not defined in IE 8/9. + * 2. Normalize vertical alignment of `progress` in Chrome, Firefox, and Opera. + */ + +audio, +canvas, +progress, +video { + display: inline-block; /* 1 */ + vertical-align: baseline; /* 2 */ +} + +/** + * Prevent modern browsers from displaying `audio` without controls. + * Remove excess height in iOS 5 devices. + */ + +audio:not([controls]) { + display: none; + height: 0; +} + +/** + * Address `[hidden]` styling not present in IE 8/9/10. + * Hide the `template` element in IE 8/9/11, Safari, and Firefox < 22. + */ + +[hidden], +template { + display: none !important; +} + +/* Links + ========================================================================== */ + +/** + * Remove the gray background color from active links in IE 10. + */ + +a { + background-color: transparent; +} + +/** + * Improve readability when focused and also mouse hovered in all browsers. + */ + +a:active, +a:hover { + outline: 0; +} + +/* Text-level semantics + ========================================================================== */ + +/** + * Address styling not present in IE 8/9/10/11, Safari, and Chrome. + */ + +abbr[title] { + border-bottom: 1px dotted; +} + +/** + * Address style set to `bolder` in Firefox 4+, Safari, and Chrome. + */ + +b, +strong { + font-weight: bold; +} + +/** + * Address styling not present in Safari and Chrome. + */ + +dfn { + font-style: italic; +} + +/** + * Address variable `h1` font-size and margin within `section` and `article` + * contexts in Firefox 4+, Safari, and Chrome. + */ + +h1 { + font-size: 2em; + margin: 0.67em 0; +} + +/** + * Address styling not present in IE 8/9. + */ + +mark { + background: #ff0; + color: #000; +} + +/** + * Address inconsistent and variable font size in all browsers. + */ + +small { + font-size: 80%; +} + +/** + * Prevent `sub` and `sup` affecting `line-height` in all browsers. + */ + +sub, +sup { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; +} + +sup { + top: -0.5em; +} + +sub { + bottom: -0.25em; +} + +/* Embedded content + ========================================================================== */ + +/** + * Remove border when inside `a` element in IE 8/9/10. + */ + +img { + border: 0; +} + +/** + * Correct overflow not hidden in IE 9/10/11. + */ + +svg:not(:root) { + overflow: hidden; +} + +/* Grouping content + ========================================================================== */ + +/** + * Address margin not present in IE 8/9 and Safari. + */ + +figure { + margin: 1em 40px; +} + +/** + * Address differences between Firefox and other browsers. + */ + +hr { + -moz-box-sizing: content-box; + box-sizing: content-box; + height: 0; +} + +/** + * Contain overflow in all browsers. + */ + +pre { + overflow: auto; +} + +/** + * Address odd `em`-unit font size rendering in all browsers. + */ + +code, +kbd, +pre, +samp { + font-family: var(--font-monospace); + font-size: 1em; +} + +/* Forms + ========================================================================== */ + +/** + * Known limitation: by default, Chrome and Safari on OS X allow very limited + * styling of `select`, unless a `border` property is set. + */ + +/** + * 1. Correct color not being inherited. + * Known issue: affects color of disabled elements. + * 2. Correct font properties not being inherited. + * 3. Address margins set differently in Firefox 4+, Safari, and Chrome. + */ + +button, +input, +optgroup, +select, +textarea { + color: inherit; /* 1 */ + font: inherit; /* 2 */ + margin: 0; /* 3 */ +} + +/** + * Address `overflow` set to `hidden` in IE 8/9/10/11. + */ + +button { + overflow: visible; +} + +/** + * Address inconsistent `text-transform` inheritance for `button` and `select`. + * All other form control elements do not inherit `text-transform` values. + * Correct `button` style inheritance in Firefox, IE 8/9/10/11, and Opera. + * Correct `select` style inheritance in Firefox. + */ + +button, +select { + text-transform: none; +} + +/** + * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` + * and `video` controls. + * 2. Correct inability to style clickable `input` types in iOS. + * 3. Improve usability and consistency of cursor style between image-type + * `input` and others. + */ + +button, +html input[type="button"], /* 1 */ +input[type="reset"], +input[type="submit"] { + -webkit-appearance: button; /* 2 */ + cursor: pointer; /* 3 */ +} + +/** + * Re-set default cursor for disabled elements. + */ + +button[disabled], +html input[disabled] { + cursor: default; +} + +/** + * Remove inner padding and border in Firefox 4+. + */ + +button::-moz-focus-inner, +input::-moz-focus-inner { + border: 0; + padding: 0; +} + +/** + * Address Firefox 4+ setting `line-height` on `input` using `!important` in + * the UA stylesheet. + */ + +input { + line-height: normal; +} + +/** + * It's recommended that you don't attempt to style these elements. + * Firefox's implementation doesn't respect box-sizing, padding, or width. + * + * 1. Address box sizing set to `content-box` in IE 8/9/10. + * 2. Remove excess padding in IE 8/9/10. + */ + +input[type="checkbox"], +input[type="radio"] { + box-sizing: border-box; /* 1 */ + padding: 0; /* 2 */ +} + +/** + * Fix the cursor style for Chrome's increment/decrement buttons. For certain + * `font-size` values of the `input`, it causes the cursor style of the + * decrement button to change from `default` to `text`. + */ + +input[type="number"]::-webkit-inner-spin-button, +input[type="number"]::-webkit-outer-spin-button { + height: auto; +} + +/** + * 1. Address `appearance` set to `searchfield` in Safari and Chrome. + * 2. Address `box-sizing` set to `border-box` in Safari and Chrome + * (include `-moz` to future-proof). + */ + +input[type="search"] { + -webkit-appearance: textfield; /* 1 */ + -moz-box-sizing: content-box; + -webkit-box-sizing: content-box; /* 2 */ + box-sizing: content-box; +} + +/** + * Remove inner padding and search cancel button in Safari and Chrome on OS X. + * Safari (but not Chrome) clips the cancel button when the search input has + * padding (and `textfield` appearance). + */ + +input[type="search"]::-webkit-search-cancel-button, +input[type="search"]::-webkit-search-decoration { + -webkit-appearance: none; +} + +/** + * Define consistent border, margin, and padding. + */ + +fieldset { + border: 1px solid #c0c0c0; + margin: 0 2px; + padding: 0.35em 0.625em 0.75em; +} + +/** + * 1. Correct `color` not being inherited in IE 8/9/10/11. + * 2. Remove padding so people aren't caught out if they zero out fieldsets. + */ + +legend { + border: 0; /* 1 */ + padding: 0; /* 2 */ +} + +/** + * Remove default vertical scrollbar in IE 8/9/10/11. + */ + +textarea { + overflow: auto; +} + +/** + * Don't inherit the `font-weight` (applied by a rule above). + * NOTE: the default cannot safely be changed in Chrome and Safari on OS X. + */ + +optgroup { + font-weight: bold; +} + +/* Tables + ========================================================================== */ + +/** + * Remove most spacing between table cells. + */ + +table { + border-collapse: collapse; + border-spacing: 0; +} + +td, +th { + padding: 0; +} diff --git a/css/template.css b/css/template.css new file mode 100644 index 00000000..cafd680d --- /dev/null +++ b/css/template.css @@ -0,0 +1,271 @@ + +.phpdocumentor-content { + position: relative; + display: flex; + gap: var(--spacing-md); +} + +.phpdocumentor-content > section:first-of-type { + width: 75%; + flex: 1 1 auto; +} + +@media (min-width: 1900px) { + .phpdocumentor-content > section:first-of-type { + width: 100%; + flex: 1 1 auto; + } +} + +.phpdocumentor .phpdocumentor-content__title { + margin-top: 0; +} +.phpdocumentor-summary { + font-style: italic; +} +.phpdocumentor-description { + margin-bottom: var(--spacing-md); +} +.phpdocumentor-element { + position: relative; +} + +.phpdocumentor-element .phpdocumentor-element { + border: 1px solid var(--primary-color-lighten); + margin-bottom: var(--spacing-md); + padding: var(--spacing-xs); + border-radius: 5px; +} + +.phpdocumentor-element.-deprecated .phpdocumentor-element__name { + text-decoration: line-through; +} + +@media (min-width: 550px) { + .phpdocumentor-element .phpdocumentor-element { + margin-bottom: var(--spacing-lg); + padding: var(--spacing-md); + } +} + +.phpdocumentor-element__modifier { + font-size: var(--text-xxs); + padding: calc(var(--spacing-base-size) / 4) calc(var(--spacing-base-size) / 2); + color: var(--text-color); + background-color: var(--light-gray); + border-radius: 3px; + text-transform: uppercase; +} + +.phpdocumentor .phpdocumentor-elements__header { + margin-top: var(--spacing-xxl); + margin-bottom: var(--spacing-lg); +} + +.phpdocumentor .phpdocumentor-element__name { + line-height: 1; + margin-top: 0; + font-weight: 300; + font-size: var(--text-lg); + word-break: break-all; + margin-bottom: var(--spacing-sm); +} + +@media (min-width: 550px) { + .phpdocumentor .phpdocumentor-element__name { + font-size: var(--text-xl); + margin-bottom: var(--spacing-xs); + } +} + +@media (min-width: 1200px) { + .phpdocumentor .phpdocumentor-element__name { + margin-bottom: var(--spacing-md); + } +} + +.phpdocumentor-element__package, +.phpdocumentor-element__extends, +.phpdocumentor-element__implements { + display: block; + font-size: var(--text-xxs); + font-weight: normal; + opacity: .7; +} + +.phpdocumentor-element__package .phpdocumentor-breadcrumbs { + display: inline; +} +.phpdocumentor .phpdocumentor-signature { + display: block; + font-size: var(--text-sm); + border: 1px solid #f0f0f0; +} + +.phpdocumentor .phpdocumentor-signature.-deprecated .phpdocumentor-signature__name { + text-decoration: line-through; +} + +@media (min-width: 550px) { + .phpdocumentor .phpdocumentor-signature { + margin-left: calc(var(--spacing-xl) * -1); + width: calc(100% + var(--spacing-xl)); + } +} + +.phpdocumentor-table-of-contents { +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry { + margin-bottom: var(--spacing-xxs); + margin-left: 2rem; + display: flex; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry > a { + flex: 0 1 auto; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry > span { + flex: 1; + white-space: nowrap; + text-overflow: ellipsis; + overflow: hidden; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry:after { + content: ''; + height: 12px; + width: 12px; + left: 16px; + position: absolute; +} +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-private:after { + background: url('data:image/svg+xml;utf8,') no-repeat; +} +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-protected:after { + left: 13px; + background: url('data:image/svg+xml;utf8,') no-repeat; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry:before { + width: 1.25rem; + height: 1.25rem; + line-height: 1.25rem; + background: transparent url('data:image/svg+xml;utf8,') no-repeat center center; + content: ''; + position: absolute; + left: 0; + border-radius: 50%; + font-weight: 600; + color: white; + text-align: center; + font-size: .75rem; + margin-top: .2rem; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-method:before { + content: 'M'; + color: ''; + background-image: url('data:image/svg+xml;utf8,'); +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-function:before { + content: 'M'; + color: ' 262'; + background-image: url('data:image/svg+xml;utf8,'); +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-property:before { + content: 'P' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-constant:before { + content: 'C'; + background-color: transparent; + background-image: url('data:image/svg+xml;utf8,'); +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-class:before { + content: 'C' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-interface:before { + content: 'I' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-trait:before { + content: 'T' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-namespace:before { + content: 'N' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-package:before { + content: 'P' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-enum:before { + content: 'E' +} + +.phpdocumentor-table-of-contents dd { + font-style: italic; + margin-left: 2rem; +} +.phpdocumentor-element-found-in { + display: none; +} + +@media (min-width: 550px) { + .phpdocumentor-element-found-in { + display: block; + font-size: var(--text-sm); + color: gray; + margin-bottom: 1rem; + } +} + +@media (min-width: 1200px) { + .phpdocumentor-element-found-in { + position: absolute; + top: var(--spacing-sm); + right: var(--spacing-sm); + font-size: var(--text-sm); + margin-bottom: 0; + } +} + +.phpdocumentor-element-found-in .phpdocumentor-element-found-in__source { + flex: 0 1 auto; + display: inline-flex; +} + +.phpdocumentor-element-found-in .phpdocumentor-element-found-in__source:after { + width: 1.25rem; + height: 1.25rem; + line-height: 1.25rem; + background: transparent url('data:image/svg+xml;utf8,') no-repeat center center; + content: ''; + left: 0; + border-radius: 50%; + font-weight: 600; + text-align: center; + font-size: .75rem; + margin-top: .2rem; +} +.phpdocumentor-class-graph { + width: 100%; height: 600px; border:1px solid black; overflow: hidden +} + +.phpdocumentor-class-graph__graph { + width: 100%; +} +.phpdocumentor-tag-list__definition { + display: flex; +} + +.phpdocumentor-tag-link { + margin-right: var(--spacing-sm); +} diff --git a/examples/curl_multi.php b/examples/curl_multi.php deleted file mode 100644 index 163d6940..00000000 --- a/examples/curl_multi.php +++ /dev/null @@ -1,106 +0,0 @@ - - * @copyright 2019 smiley - * @license MIT - */ - -use chillerlan\HTTP\{CurlClient , CurlMultiClient, HTTPOptions, MultiResponseHandlerInterface}; -use chillerlan\HTTP\Psr7\HTTPFactory; -use chillerlan\HTTP\Utils\{MessageUtil, QueryUtil}; -use Psr\Http\Message\{RequestInterface, ResponseInterface}; - -require_once __DIR__.'/../vendor/autoload.php'; - -// options for both clients -$options = new HTTPOptions; -$options->ca_info = __DIR__.'/cacert.pem'; -$options->sleep = 750000; // GW2 API limit: 300 requests/minute -$options->window_size = 5; -$options->retries = 1; -#$options->user_agent = 'my fancy http client'; - -$factory = new HTTPFactory; -$client = new CurlClient($factory, $options); - -$endpoint = 'https://api.guildwars2.com/v2/items'; -$languages = ['de', 'en', 'es'];//, 'fr', 'zh' -// request the list of item ids -$itemResponse = $client->sendRequest($factory->createRequest('GET', $endpoint)); - -if($itemResponse->getStatusCode() !== 200){ - exit('/v2/items fetch error'); -} - -// create directories for each language to dump the item responses into -foreach($languages as $lang){ - $dir = __DIR__.'/'.$lang; - - if(!file_exists($dir)){ - mkdir($dir); - } -} - -// the multi request handler -$handler = new class () implements MultiResponseHandlerInterface{ - - public function handleResponse( - ResponseInterface $response, - RequestInterface $request, - int $id, - array|null $curl_info, - ):RequestInterface|null{ - - // the API returns either 200 or 206 on OK responses - // https://gitter.im/arenanet/api-cdi?at=5738e2c0ae26c1967f9eb4a0 - if(!in_array($response->getStatusCode(), [200, 206], true)){ - // return the failed request back to the stack - return $request; - } - - // the response body is empty for some reason, we pretend that's fine and exit - if($response->getBody()->getSize() === 0){ - return null; - } - - try{ - $json = MessageUtil::decodeJSON($response); - } - catch(Throwable){ - // maybe we didn't properly receive the data? let's try again - return $request; - } - - $lang = $response->getHeaderLine('content-language'); - - // create a file for each item in the response (ofc you'd rather put this in a DB) - foreach($json as $item){ - $file = sprintf('%s/%s/%s.json', __DIR__, $lang, $item->id); - - file_put_contents($file, json_encode($item, (JSON_PRETTY_PRINT|JSON_UNESCAPED_SLASHES))); - - echo $file.PHP_EOL; - } - - // response ok, nothing to return - return null; - } - -}; - -$multiClient = new CurlMultiClient($handler, $factory, $options); - -// chunk the item response into arrays of 200 ids each (API limit) and create Request objects for each desired language -foreach(array_chunk(MessageUtil::decodeJSON($itemResponse), 200) as $chunk){ - foreach($languages as $lang){ - $multiClient->addRequest($factory->createRequest('GET', $endpoint.'?'.QueryUtil::build(['lang' => $lang, 'ids' => implode(',', $chunk)]))); - } -} - -// run the whole thing -$multiClient->process(); diff --git a/examples/spotify.php b/examples/spotify.php deleted file mode 100644 index 9dc33925..00000000 --- a/examples/spotify.php +++ /dev/null @@ -1,58 +0,0 @@ - - * @copyright 2021 smiley - * @license MIT - */ - -use chillerlan\HTTP\{CurlClient, HTTPOptions}; -use chillerlan\HTTP\Psr7\HTTPFactory; -use chillerlan\HTTP\Utils\MessageUtil; - -require_once __DIR__.'/../vendor/autoload.php'; - -$artists = ['4wLIbcoqmqI4WZHDiBxeCB', '7mefbdlQXxJVKgEbfAeKjL', '4G3PykZuN4ts87LgYKI9Zu']; - -// https://github.com/ThirumalaiK/youtube-dl/commit/120339ec1413bca0a398cdcb7b4d12c5897ce7b7 -$sha256Hash = 'd66221ea13998b2f81883c5187d174c8646e4041d67f5b1e103bc262d447e3a0'; // Apollo/GraphQL thing?? may change - -$options = new HTTPOptions; -$options->ca_info = __DIR__.'/cacert.pem'; -$options->user_agent = 'Mozilla/5.0 (Windows NT 6.6.6; Win64; x64; rv:91.0) Gecko/20100101 Firefox/91.0'; - -$factory = new HTTPFactory; -$http = new CurlClient($factory, $options); - -$tokenRequest = $factory->createRequest('GET', $factory->createUri('https://open.spotify.com/get_access_token')); -$tokenResponse = $http->sendRequest($tokenRequest); - -if($tokenResponse->getStatusCode() !== 200){ - throw new RuntimeException('could not obtain token'); -} - -$token = MessageUtil::decodeJSON($tokenResponse); -$queryUri = $factory->createUri('https://api-partner.spotify.com/pathfinder/v1/query'); -$params = [ - 'operationName' => 'queryArtistOverview', - 'extensions' => json_encode(['persistedQuery' => ['version' => 1, 'sha256Hash' => $sha256Hash]]), -]; - -foreach($artists as $artistID){ - $params['variables'] = json_encode(['uri' => sprintf('spotify:artist:%s', $artistID)]); - - $request = $factory->createRequest('GET', $queryUri->withQuery(http_build_query($params))); - $request = $request->withHeader('Authorization', sprintf('Bearer %s', $token->accessToken)); - /** @phan-suppress-next-line PhanTypeMismatchArgumentSuperType */ - $response = $http->sendRequest($request); - - if($response->getStatusCode() === 200){ - $body = $response->getBody(); - - var_dump($artistID, $body->getSize()); - file_put_contents(sprintf('%s/json/%s.json', __DIR__, $artistID), $body->getContents()); - } - -} diff --git a/files/src-clientexception.html b/files/src-clientexception.html new file mode 100644 index 00000000..1e8dd9c2 --- /dev/null +++ b/files/src-clientexception.html @@ -0,0 +1,319 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                  +

                                                  Documentation

                                                  + + + + + +
                                                  + +
                                                  +
                                                  + + + + +
                                                  +
                                                  +
                                                    +
                                                  + +
                                                  +

                                                  ClientException.php

                                                  + +

                                                  Class ClientException

                                                  + + + +
                                                  + Tags + + +
                                                  +
                                                  +
                                                  + created +
                                                  +
                                                  + +

                                                  10.09.2018

                                                  +
                                                  + +
                                                  +
                                                  + author +
                                                  +
                                                  + +

                                                  smiley smiley@chillerlan.net

                                                  +
                                                  + +
                                                  +
                                                  + copyright +
                                                  +
                                                  + +

                                                  2018 smiley

                                                  +
                                                  + +
                                                  +
                                                  + license +
                                                  +
                                                  + +

                                                  MIT

                                                  +
                                                  + +
                                                  +
                                                  + + + +

                                                  + Table of Contents + + +

                                                  + + + + +

                                                  + Classes + + +

                                                  +
                                                  +
                                                  ClientException
                                                  + + + + + + + + + + + + + +
                                                  +
                                                  +
                                                  +
                                                  +
                                                  
                                                  +        
                                                  + +
                                                  +
                                                  + + + +
                                                  +
                                                  +
                                                  + +
                                                  + On this page + +
                                                    +
                                                  • Table Of Contents
                                                  • +
                                                  • + +
                                                  • + + +
                                                  +
                                                  + +
                                                  +
                                                  +
                                                  +
                                                  +
                                                  +

                                                  Search results

                                                  + +
                                                  +
                                                  +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    + + +
                                                    + + + + + + + + diff --git a/files/src-curlclient.html b/files/src-curlclient.html new file mode 100644 index 00000000..daedf882 --- /dev/null +++ b/files/src-curlclient.html @@ -0,0 +1,319 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                    +

                                                    Documentation

                                                    + + + + + +
                                                    + +
                                                    +
                                                    + + + + +
                                                    +
                                                    +
                                                      +
                                                    + +
                                                    +

                                                    CurlClient.php

                                                    + +

                                                    Class HTTPClient

                                                    + + + +
                                                    + Tags + + +
                                                    +
                                                    +
                                                    + created +
                                                    +
                                                    + +

                                                    27.08.2018

                                                    +
                                                    + +
                                                    +
                                                    + author +
                                                    +
                                                    + +

                                                    smiley smiley@chillerlan.net

                                                    +
                                                    + +
                                                    +
                                                    + copyright +
                                                    +
                                                    + +

                                                    2018 smiley

                                                    +
                                                    + +
                                                    +
                                                    + license +
                                                    +
                                                    + +

                                                    MIT

                                                    +
                                                    + +
                                                    +
                                                    + + + +

                                                    + Table of Contents + + +

                                                    + + + + +

                                                    + Classes + + +

                                                    +
                                                    +
                                                    CurlClient
                                                    A "simple" cURL http client
                                                    + + + + + + + + + + + + + +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    
                                                    +        
                                                    + +
                                                    +
                                                    + + + +
                                                    +
                                                    +
                                                    + +
                                                    + On this page + +
                                                      +
                                                    • Table Of Contents
                                                    • +
                                                    • + +
                                                    • + + +
                                                    +
                                                    + +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    +

                                                    Search results

                                                    + +
                                                    +
                                                    +
                                                      +
                                                      +
                                                      +
                                                      +
                                                      + + +
                                                      + + + + + + + + diff --git a/files/src-curlhandle.html b/files/src-curlhandle.html new file mode 100644 index 00000000..12178c2c --- /dev/null +++ b/files/src-curlhandle.html @@ -0,0 +1,319 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                      +

                                                      Documentation

                                                      + + + + + +
                                                      + +
                                                      +
                                                      + + + + +
                                                      +
                                                      +
                                                        +
                                                      + +
                                                      +

                                                      CurlHandle.php

                                                      + +

                                                      Class CurlHandle

                                                      + + + +
                                                      + Tags + + +
                                                      +
                                                      +
                                                      + created +
                                                      +
                                                      + +

                                                      30.08.2018

                                                      +
                                                      + +
                                                      +
                                                      + author +
                                                      +
                                                      + +

                                                      smiley smiley@chillerlan.net

                                                      +
                                                      + +
                                                      +
                                                      + copyright +
                                                      +
                                                      + +

                                                      2018 smiley

                                                      +
                                                      + +
                                                      +
                                                      + license +
                                                      +
                                                      + +

                                                      MIT

                                                      +
                                                      + +
                                                      +
                                                      + + + +

                                                      + Table of Contents + + +

                                                      + + + + +

                                                      + Classes + + +

                                                      +
                                                      +
                                                      CurlHandle
                                                      Implements a cURL connection object
                                                      + + + + + + + + + + + + + +
                                                      +
                                                      +
                                                      +
                                                      +
                                                      
                                                      +        
                                                      + +
                                                      +
                                                      + + + +
                                                      +
                                                      +
                                                      + +
                                                      + On this page + +
                                                        +
                                                      • Table Of Contents
                                                      • +
                                                      • + +
                                                      • + + +
                                                      +
                                                      + +
                                                      +
                                                      +
                                                      +
                                                      +
                                                      +

                                                      Search results

                                                      + +
                                                      +
                                                      +
                                                        +
                                                        +
                                                        +
                                                        +
                                                        + + +
                                                        + + + + + + + + diff --git a/files/src-curlmulticlient.html b/files/src-curlmulticlient.html new file mode 100644 index 00000000..f42fb386 --- /dev/null +++ b/files/src-curlmulticlient.html @@ -0,0 +1,319 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                        +

                                                        Documentation

                                                        + + + + + +
                                                        + +
                                                        +
                                                        + + + + +
                                                        +
                                                        +
                                                          +
                                                        + +
                                                        +

                                                        CurlMultiClient.php

                                                        + +

                                                        Class CurlMultiClient

                                                        + + + +
                                                        + Tags + + +
                                                        +
                                                        +
                                                        + created +
                                                        +
                                                        + +

                                                        30.08.2018

                                                        +
                                                        + +
                                                        +
                                                        + author +
                                                        +
                                                        + +

                                                        smiley smiley@chillerlan.net

                                                        +
                                                        + +
                                                        +
                                                        + copyright +
                                                        +
                                                        + +

                                                        2018 smiley

                                                        +
                                                        + +
                                                        +
                                                        + license +
                                                        +
                                                        + +

                                                        MIT

                                                        +
                                                        + +
                                                        +
                                                        + + + +

                                                        + Table of Contents + + +

                                                        + + + + +

                                                        + Classes + + +

                                                        +
                                                        +
                                                        CurlMultiClient
                                                        Curl multi http client
                                                        + + + + + + + + + + + + + +
                                                        +
                                                        +
                                                        +
                                                        +
                                                        
                                                        +        
                                                        + +
                                                        +
                                                        + + + +
                                                        +
                                                        +
                                                        + +
                                                        + On this page + +
                                                          +
                                                        • Table Of Contents
                                                        • +
                                                        • + +
                                                        • + + +
                                                        +
                                                        + +
                                                        +
                                                        +
                                                        +
                                                        +
                                                        +

                                                        Search results

                                                        + +
                                                        +
                                                        +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          + + +
                                                          + + + + + + + + diff --git a/files/src-httpclientabstract.html b/files/src-httpclientabstract.html new file mode 100644 index 00000000..fa1d2c47 --- /dev/null +++ b/files/src-httpclientabstract.html @@ -0,0 +1,319 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                          +

                                                          Documentation

                                                          + + + + + +
                                                          + +
                                                          +
                                                          + + + + +
                                                          +
                                                          +
                                                            +
                                                          + +
                                                          +

                                                          HTTPClientAbstract.php

                                                          + +

                                                          Class HTTPClientAbstract

                                                          + + + +
                                                          + Tags + + +
                                                          +
                                                          +
                                                          + created +
                                                          +
                                                          + +

                                                          22.02.2019

                                                          +
                                                          + +
                                                          +
                                                          + author +
                                                          +
                                                          + +

                                                          smiley smiley@chillerlan.net

                                                          +
                                                          + +
                                                          +
                                                          + copyright +
                                                          +
                                                          + +

                                                          2019 smiley

                                                          +
                                                          + +
                                                          +
                                                          + license +
                                                          +
                                                          + +

                                                          MIT

                                                          +
                                                          + +
                                                          +
                                                          + + + +

                                                          + Table of Contents + + +

                                                          + + + + +

                                                          + Classes + + +

                                                          +
                                                          +
                                                          HTTPClientAbstract
                                                          + + + + + + + + + + + + + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          
                                                          +        
                                                          + +
                                                          +
                                                          + + + +
                                                          +
                                                          +
                                                          + +
                                                          + On this page + +
                                                            +
                                                          • Table Of Contents
                                                          • +
                                                          • + +
                                                          • + + +
                                                          +
                                                          + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +

                                                          Search results

                                                          + +
                                                          +
                                                          +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            + + +
                                                            + + + + + + + + diff --git a/files/src-httpclientinterface.html b/files/src-httpclientinterface.html new file mode 100644 index 00000000..dede450c --- /dev/null +++ b/files/src-httpclientinterface.html @@ -0,0 +1,319 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                            +

                                                            Documentation

                                                            + + + + + +
                                                            + +
                                                            +
                                                            + + + + +
                                                            +
                                                            +
                                                              +
                                                            + +
                                                            +

                                                            HTTPClientInterface.php

                                                            + +

                                                            Interface HTTPClientInterface

                                                            + + + +
                                                            + Tags + + +
                                                            +
                                                            +
                                                            + created +
                                                            +
                                                            + +

                                                            14.02.2023

                                                            +
                                                            + +
                                                            +
                                                            + author +
                                                            +
                                                            + +

                                                            smiley smiley@chillerlan.net

                                                            +
                                                            + +
                                                            +
                                                            + copyright +
                                                            +
                                                            + +

                                                            2023 smiley

                                                            +
                                                            + +
                                                            +
                                                            + license +
                                                            +
                                                            + +

                                                            MIT

                                                            +
                                                            + +
                                                            +
                                                            + + + +

                                                            + Table of Contents + + +

                                                            + + + +

                                                            + Interfaces + + +

                                                            +
                                                            +
                                                            HTTPClientInterface
                                                            + + + + + + + + + + + + + + +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            
                                                            +        
                                                            + +
                                                            +
                                                            + + + +
                                                            +
                                                            +
                                                            + +
                                                            + On this page + + +
                                                            + +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            +

                                                            Search results

                                                            + +
                                                            +
                                                            +
                                                              +
                                                              +
                                                              +
                                                              +
                                                              + + +
                                                              + + + + + + + + diff --git a/files/src-httpoptions.html b/files/src-httpoptions.html new file mode 100644 index 00000000..98f7ce7d --- /dev/null +++ b/files/src-httpoptions.html @@ -0,0 +1,319 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                              +

                                                              Documentation

                                                              + + + + + +
                                                              + +
                                                              +
                                                              + + + + +
                                                              +
                                                              +
                                                                +
                                                              + +
                                                              +

                                                              HTTPOptions.php

                                                              + +

                                                              Class HTTPOptions

                                                              + + + +
                                                              + Tags + + +
                                                              +
                                                              +
                                                              + created +
                                                              +
                                                              + +

                                                              28.08.2018

                                                              +
                                                              + +
                                                              +
                                                              + author +
                                                              +
                                                              + +

                                                              smiley smiley@chillerlan.net

                                                              +
                                                              + +
                                                              +
                                                              + copyright +
                                                              +
                                                              + +

                                                              2018 smiley

                                                              +
                                                              + +
                                                              +
                                                              + license +
                                                              +
                                                              + +

                                                              MIT

                                                              +
                                                              + +
                                                              +
                                                              + + + +

                                                              + Table of Contents + + +

                                                              + + + + +

                                                              + Classes + + +

                                                              +
                                                              +
                                                              HTTPOptions
                                                              + + + + + + + + + + + + + +
                                                              +
                                                              +
                                                              +
                                                              +
                                                              
                                                              +        
                                                              + +
                                                              +
                                                              + + + +
                                                              +
                                                              +
                                                              + +
                                                              + On this page + +
                                                                +
                                                              • Table Of Contents
                                                              • +
                                                              • + +
                                                              • + + +
                                                              +
                                                              + +
                                                              +
                                                              +
                                                              +
                                                              +
                                                              +

                                                              Search results

                                                              + +
                                                              +
                                                              +
                                                                +
                                                                +
                                                                +
                                                                +
                                                                + + +
                                                                + + + + + + + + diff --git a/files/src-httpoptionstrait.html b/files/src-httpoptionstrait.html new file mode 100644 index 00000000..20e54262 --- /dev/null +++ b/files/src-httpoptionstrait.html @@ -0,0 +1,328 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                                +

                                                                Documentation

                                                                + + + + + +
                                                                + +
                                                                +
                                                                + + + + +
                                                                +
                                                                +
                                                                  +
                                                                + +
                                                                +

                                                                HTTPOptionsTrait.php

                                                                + +

                                                                Trait HTTPOptionsTrait

                                                                + + + +
                                                                + Tags + + +
                                                                +
                                                                +
                                                                + created +
                                                                +
                                                                + +

                                                                28.08.2018

                                                                +
                                                                + +
                                                                +
                                                                + author +
                                                                +
                                                                + +

                                                                Smiley smiley@chillerlan.net

                                                                +
                                                                + +
                                                                +
                                                                + copyright +
                                                                +
                                                                + +

                                                                2018 Smiley

                                                                +
                                                                + +
                                                                +
                                                                + license +
                                                                +
                                                                + +

                                                                MIT

                                                                +
                                                                + +
                                                                +
                                                                + phan-file-suppress +
                                                                +
                                                                + +

                                                                PhanTypeInvalidThrowsIsInterface

                                                                +
                                                                + +
                                                                +
                                                                + + + +

                                                                + Table of Contents + + +

                                                                + + + + + +

                                                                + Traits + + +

                                                                +
                                                                +
                                                                HTTPOptionsTrait
                                                                + + + + + + + + + + + + +
                                                                +
                                                                +
                                                                +
                                                                +
                                                                
                                                                +        
                                                                + +
                                                                +
                                                                + + + +
                                                                +
                                                                +
                                                                + +
                                                                + On this page + +
                                                                  +
                                                                • Table Of Contents
                                                                • +
                                                                • + +
                                                                • + + +
                                                                +
                                                                + +
                                                                +
                                                                +
                                                                +
                                                                +
                                                                +

                                                                Search results

                                                                + +
                                                                +
                                                                +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  + + +
                                                                  + + + + + + + + diff --git a/files/src-multiresponsehandlerinterface.html b/files/src-multiresponsehandlerinterface.html new file mode 100644 index 00000000..35b9ad3b --- /dev/null +++ b/files/src-multiresponsehandlerinterface.html @@ -0,0 +1,319 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                                  +

                                                                  Documentation

                                                                  + + + + + +
                                                                  + +
                                                                  +
                                                                  + + + + +
                                                                  +
                                                                  +
                                                                    +
                                                                  + +
                                                                  +

                                                                  MultiResponseHandlerInterface.php

                                                                  + +

                                                                  Interface MultiResponseHandlerInterface

                                                                  + + + +
                                                                  + Tags + + +
                                                                  +
                                                                  +
                                                                  + created +
                                                                  +
                                                                  + +

                                                                  30.08.2018

                                                                  +
                                                                  + +
                                                                  +
                                                                  + author +
                                                                  +
                                                                  + +

                                                                  smiley smiley@chillerlan.net

                                                                  +
                                                                  + +
                                                                  +
                                                                  + copyright +
                                                                  +
                                                                  + +

                                                                  2018 Smiley

                                                                  +
                                                                  + +
                                                                  +
                                                                  + license +
                                                                  +
                                                                  + +

                                                                  MIT

                                                                  +
                                                                  + +
                                                                  +
                                                                  + + + +

                                                                  + Table of Contents + + +

                                                                  + + + +

                                                                  + Interfaces + + +

                                                                  +
                                                                  +
                                                                  MultiResponseHandlerInterface
                                                                  The multi response handler. (Schrödinger's cat state handler)
                                                                  + + + + + + + + + + + + + + +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  
                                                                  +        
                                                                  + +
                                                                  +
                                                                  + + + +
                                                                  +
                                                                  +
                                                                  + +
                                                                  + On this page + + +
                                                                  + +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Search results

                                                                  + +
                                                                  +
                                                                  +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    + + +
                                                                    + + + + + + + + diff --git a/files/src-networkexception.html b/files/src-networkexception.html new file mode 100644 index 00000000..c75d7a24 --- /dev/null +++ b/files/src-networkexception.html @@ -0,0 +1,319 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                                    +

                                                                    Documentation

                                                                    + + + + + +
                                                                    + +
                                                                    +
                                                                    + + + + +
                                                                    +
                                                                    +
                                                                      +
                                                                    + +
                                                                    +

                                                                    NetworkException.php

                                                                    + +

                                                                    Class NetworkException

                                                                    + + + +
                                                                    + Tags + + +
                                                                    +
                                                                    +
                                                                    + created +
                                                                    +
                                                                    + +

                                                                    10.09.2018

                                                                    +
                                                                    + +
                                                                    +
                                                                    + author +
                                                                    +
                                                                    + +

                                                                    smiley smiley@chillerlan.net

                                                                    +
                                                                    + +
                                                                    +
                                                                    + copyright +
                                                                    +
                                                                    + +

                                                                    2018 smiley

                                                                    +
                                                                    + +
                                                                    +
                                                                    + license +
                                                                    +
                                                                    + +

                                                                    MIT

                                                                    +
                                                                    + +
                                                                    +
                                                                    + + + +

                                                                    + Table of Contents + + +

                                                                    + + + + +

                                                                    + Classes + + +

                                                                    +
                                                                    +
                                                                    NetworkException
                                                                    + + + + + + + + + + + + + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    
                                                                    +        
                                                                    + +
                                                                    +
                                                                    + + + +
                                                                    +
                                                                    +
                                                                    + +
                                                                    + On this page + +
                                                                      +
                                                                    • Table Of Contents
                                                                    • +
                                                                    • + +
                                                                    • + + +
                                                                    +
                                                                    + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Search results

                                                                    + +
                                                                    +
                                                                    +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      + + +
                                                                      + + + + + + + + diff --git a/files/src-requestexception.html b/files/src-requestexception.html new file mode 100644 index 00000000..82be4efa --- /dev/null +++ b/files/src-requestexception.html @@ -0,0 +1,319 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                                      +

                                                                      Documentation

                                                                      + + + + + +
                                                                      + +
                                                                      +
                                                                      + + + + +
                                                                      +
                                                                      +
                                                                        +
                                                                      + +
                                                                      +

                                                                      RequestException.php

                                                                      + +

                                                                      Class RequestException

                                                                      + + + +
                                                                      + Tags + + +
                                                                      +
                                                                      +
                                                                      + created +
                                                                      +
                                                                      + +

                                                                      10.09.2018

                                                                      +
                                                                      + +
                                                                      +
                                                                      + author +
                                                                      +
                                                                      + +

                                                                      smiley smiley@chillerlan.net

                                                                      +
                                                                      + +
                                                                      +
                                                                      + copyright +
                                                                      +
                                                                      + +

                                                                      2018 smiley

                                                                      +
                                                                      + +
                                                                      +
                                                                      + license +
                                                                      +
                                                                      + +

                                                                      MIT

                                                                      +
                                                                      + +
                                                                      +
                                                                      + + + +

                                                                      + Table of Contents + + +

                                                                      + + + + +

                                                                      + Classes + + +

                                                                      +
                                                                      +
                                                                      RequestException
                                                                      + + + + + + + + + + + + + +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      
                                                                      +        
                                                                      + +
                                                                      +
                                                                      + + + +
                                                                      +
                                                                      +
                                                                      + +
                                                                      + On this page + +
                                                                        +
                                                                      • Table Of Contents
                                                                      • +
                                                                      • + +
                                                                      • + + +
                                                                      +
                                                                      + +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      +

                                                                      Search results

                                                                      + +
                                                                      +
                                                                      +
                                                                        +
                                                                        +
                                                                        +
                                                                        +
                                                                        + + +
                                                                        + + + + + + + + diff --git a/files/src-streamclient.html b/files/src-streamclient.html new file mode 100644 index 00000000..7a0b6603 --- /dev/null +++ b/files/src-streamclient.html @@ -0,0 +1,319 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                                        +

                                                                        Documentation

                                                                        + + + + + +
                                                                        + +
                                                                        +
                                                                        + + + + +
                                                                        +
                                                                        +
                                                                          +
                                                                        + +
                                                                        +

                                                                        StreamClient.php

                                                                        + +

                                                                        Class StreamClient

                                                                        + + + +
                                                                        + Tags + + +
                                                                        +
                                                                        +
                                                                        + created +
                                                                        +
                                                                        + +

                                                                        23.02.2019

                                                                        +
                                                                        + +
                                                                        +
                                                                        + author +
                                                                        +
                                                                        + +

                                                                        smiley smiley@chillerlan.net

                                                                        +
                                                                        + +
                                                                        +
                                                                        + copyright +
                                                                        +
                                                                        + +

                                                                        2019 smiley

                                                                        +
                                                                        + +
                                                                        +
                                                                        + license +
                                                                        +
                                                                        + +

                                                                        MIT

                                                                        +
                                                                        + +
                                                                        +
                                                                        + + + +

                                                                        + Table of Contents + + +

                                                                        + + + + +

                                                                        + Classes + + +

                                                                        +
                                                                        +
                                                                        StreamClient
                                                                        A http client via PHP streams
                                                                        + + + + + + + + + + + + + +
                                                                        +
                                                                        +
                                                                        +
                                                                        +
                                                                        
                                                                        +        
                                                                        + +
                                                                        +
                                                                        + + + +
                                                                        +
                                                                        +
                                                                        + +
                                                                        + On this page + +
                                                                          +
                                                                        • Table Of Contents
                                                                        • +
                                                                        • + +
                                                                        • + + +
                                                                        +
                                                                        + +
                                                                        +
                                                                        +
                                                                        +
                                                                        +
                                                                        +

                                                                        Search results

                                                                        + +
                                                                        +
                                                                        +
                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          + + +
                                                                          + + + + + + + + diff --git a/files/tests-clientfactories-curlclientfactory.html b/files/tests-clientfactories-curlclientfactory.html new file mode 100644 index 00000000..59551da8 --- /dev/null +++ b/files/tests-clientfactories-curlclientfactory.html @@ -0,0 +1,319 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                                          +

                                                                          Documentation

                                                                          + + + + + +
                                                                          + +
                                                                          +
                                                                          + + + + +
                                                                          +
                                                                          +
                                                                            +
                                                                          + +
                                                                          +

                                                                          CurlClientFactory.php

                                                                          + +

                                                                          Class CurlClientFactory

                                                                          + + + +
                                                                          + Tags + + +
                                                                          +
                                                                          +
                                                                          + created +
                                                                          +
                                                                          + +

                                                                          14.03.2024

                                                                          +
                                                                          + +
                                                                          +
                                                                          + author +
                                                                          +
                                                                          + +

                                                                          smiley smiley@chillerlan.net

                                                                          +
                                                                          + +
                                                                          +
                                                                          + copyright +
                                                                          +
                                                                          + +

                                                                          2024 smiley

                                                                          +
                                                                          + +
                                                                          +
                                                                          + license +
                                                                          +
                                                                          + +

                                                                          MIT

                                                                          +
                                                                          + +
                                                                          +
                                                                          + + + +

                                                                          + Table of Contents + + +

                                                                          + + + + +

                                                                          + Classes + + +

                                                                          +
                                                                          +
                                                                          CurlClientFactory
                                                                          + + + + + + + + + + + + + +
                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          
                                                                          +        
                                                                          + +
                                                                          +
                                                                          + + + +
                                                                          +
                                                                          +
                                                                          + +
                                                                          + On this page + +
                                                                            +
                                                                          • Table Of Contents
                                                                          • +
                                                                          • + +
                                                                          • + + +
                                                                          +
                                                                          + +
                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          +

                                                                          Search results

                                                                          + +
                                                                          +
                                                                          +
                                                                            +
                                                                            +
                                                                            +
                                                                            +
                                                                            + + +
                                                                            + + + + + + + + diff --git a/files/tests-clientfactories-curlclientnocafactory.html b/files/tests-clientfactories-curlclientnocafactory.html new file mode 100644 index 00000000..5baa2cc8 --- /dev/null +++ b/files/tests-clientfactories-curlclientnocafactory.html @@ -0,0 +1,319 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                                            +

                                                                            Documentation

                                                                            + + + + + +
                                                                            + +
                                                                            +
                                                                            + + + + +
                                                                            +
                                                                            +
                                                                              +
                                                                            + +
                                                                            +

                                                                            CurlClientNoCAFactory.php

                                                                            + +

                                                                            Class CurlClientNoCAFactory

                                                                            + + + +
                                                                            + Tags + + +
                                                                            +
                                                                            +
                                                                            + created +
                                                                            +
                                                                            + +

                                                                            14.03.2024

                                                                            +
                                                                            + +
                                                                            +
                                                                            + author +
                                                                            +
                                                                            + +

                                                                            smiley smiley@chillerlan.net

                                                                            +
                                                                            + +
                                                                            +
                                                                            + copyright +
                                                                            +
                                                                            + +

                                                                            2024 smiley

                                                                            +
                                                                            + +
                                                                            +
                                                                            + license +
                                                                            +
                                                                            + +

                                                                            MIT

                                                                            +
                                                                            + +
                                                                            +
                                                                            + + + +

                                                                            + Table of Contents + + +

                                                                            + + + + +

                                                                            + Classes + + +

                                                                            +
                                                                            +
                                                                            CurlClientNoCAFactory
                                                                            + + + + + + + + + + + + + +
                                                                            +
                                                                            +
                                                                            +
                                                                            +
                                                                            
                                                                            +        
                                                                            + +
                                                                            +
                                                                            + + + +
                                                                            +
                                                                            +
                                                                            + +
                                                                            + On this page + +
                                                                              +
                                                                            • Table Of Contents
                                                                            • +
                                                                            • + +
                                                                            • + + +
                                                                            +
                                                                            + +
                                                                            +
                                                                            +
                                                                            +
                                                                            +
                                                                            +

                                                                            Search results

                                                                            + +
                                                                            +
                                                                            +
                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              + + +
                                                                              + + + + + + + + diff --git a/files/tests-clientfactories-streamclientfactory.html b/files/tests-clientfactories-streamclientfactory.html new file mode 100644 index 00000000..fa46d661 --- /dev/null +++ b/files/tests-clientfactories-streamclientfactory.html @@ -0,0 +1,319 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                                              +

                                                                              Documentation

                                                                              + + + + + +
                                                                              + +
                                                                              +
                                                                              + + + + +
                                                                              +
                                                                              +
                                                                                +
                                                                              + +
                                                                              +

                                                                              StreamClientFactory.php

                                                                              + +

                                                                              Class StreamClientFactory

                                                                              + + + +
                                                                              + Tags + + +
                                                                              +
                                                                              +
                                                                              + created +
                                                                              +
                                                                              + +

                                                                              14.03.2024

                                                                              +
                                                                              + +
                                                                              +
                                                                              + author +
                                                                              +
                                                                              + +

                                                                              smiley smiley@chillerlan.net

                                                                              +
                                                                              + +
                                                                              +
                                                                              + copyright +
                                                                              +
                                                                              + +

                                                                              2024 smiley

                                                                              +
                                                                              + +
                                                                              +
                                                                              + license +
                                                                              +
                                                                              + +

                                                                              MIT

                                                                              +
                                                                              + +
                                                                              +
                                                                              + + + +

                                                                              + Table of Contents + + +

                                                                              + + + + +

                                                                              + Classes + + +

                                                                              +
                                                                              +
                                                                              StreamClientFactory
                                                                              + + + + + + + + + + + + + +
                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              
                                                                              +        
                                                                              + +
                                                                              +
                                                                              + + + +
                                                                              +
                                                                              +
                                                                              + +
                                                                              + On this page + +
                                                                                +
                                                                              • Table Of Contents
                                                                              • +
                                                                              • + +
                                                                              • + + +
                                                                              +
                                                                              + +
                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              +

                                                                              Search results

                                                                              + +
                                                                              +
                                                                              +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                + + +
                                                                                + + + + + + + + diff --git a/files/tests-clientfactories-streamclientnocafactory.html b/files/tests-clientfactories-streamclientnocafactory.html new file mode 100644 index 00000000..eb06b4fc --- /dev/null +++ b/files/tests-clientfactories-streamclientnocafactory.html @@ -0,0 +1,319 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                                                +

                                                                                Documentation

                                                                                + + + + + +
                                                                                + +
                                                                                +
                                                                                + + + + +
                                                                                +
                                                                                +
                                                                                  +
                                                                                + +
                                                                                +

                                                                                StreamClientNoCAFactory.php

                                                                                + +

                                                                                Class StreamClientNoCAFactory

                                                                                + + + +
                                                                                + Tags + + +
                                                                                +
                                                                                +
                                                                                + created +
                                                                                +
                                                                                + +

                                                                                14.03.2024

                                                                                +
                                                                                + +
                                                                                +
                                                                                + author +
                                                                                +
                                                                                + +

                                                                                smiley smiley@chillerlan.net

                                                                                +
                                                                                + +
                                                                                +
                                                                                + copyright +
                                                                                +
                                                                                + +

                                                                                2024 smiley

                                                                                +
                                                                                + +
                                                                                +
                                                                                + license +
                                                                                +
                                                                                + +

                                                                                MIT

                                                                                +
                                                                                + +
                                                                                +
                                                                                + + + +

                                                                                + Table of Contents + + +

                                                                                + + + + +

                                                                                + Classes + + +

                                                                                +
                                                                                +
                                                                                StreamClientNoCAFactory
                                                                                + + + + + + + + + + + + + +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                
                                                                                +        
                                                                                + +
                                                                                +
                                                                                + + + +
                                                                                +
                                                                                +
                                                                                + +
                                                                                + On this page + +
                                                                                  +
                                                                                • Table Of Contents
                                                                                • +
                                                                                • + +
                                                                                • + + +
                                                                                +
                                                                                + +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                +

                                                                                Search results

                                                                                + +
                                                                                +
                                                                                +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  + + +
                                                                                  + + + + + + + + diff --git a/files/tests-curlclientnocatest.html b/files/tests-curlclientnocatest.html new file mode 100644 index 00000000..ced69d26 --- /dev/null +++ b/files/tests-curlclientnocatest.html @@ -0,0 +1,319 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                                                  +

                                                                                  Documentation

                                                                                  + + + + + +
                                                                                  + +
                                                                                  +
                                                                                  + + + + +
                                                                                  +
                                                                                  +
                                                                                    +
                                                                                  + +
                                                                                  +

                                                                                  CurlClientNoCATest.php

                                                                                  + +

                                                                                  Class CurlClientNoCATest

                                                                                  + + + +
                                                                                  + Tags + + +
                                                                                  +
                                                                                  +
                                                                                  + created +
                                                                                  +
                                                                                  + +

                                                                                  28.08.2018

                                                                                  +
                                                                                  + +
                                                                                  +
                                                                                  + author +
                                                                                  +
                                                                                  + +

                                                                                  smiley smiley@chillerlan.net

                                                                                  +
                                                                                  + +
                                                                                  +
                                                                                  + copyright +
                                                                                  +
                                                                                  + +

                                                                                  2018 smiley

                                                                                  +
                                                                                  + +
                                                                                  +
                                                                                  + license +
                                                                                  +
                                                                                  + +

                                                                                  MIT

                                                                                  +
                                                                                  + +
                                                                                  +
                                                                                  + + + +

                                                                                  + Table of Contents + + +

                                                                                  + + + + +

                                                                                  + Classes + + +

                                                                                  +
                                                                                  +
                                                                                  CurlClientNoCATest
                                                                                  + + + + + + + + + + + + + +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  
                                                                                  +        
                                                                                  + +
                                                                                  +
                                                                                  + + + +
                                                                                  +
                                                                                  +
                                                                                  + +
                                                                                  + On this page + +
                                                                                    +
                                                                                  • Table Of Contents
                                                                                  • +
                                                                                  • + +
                                                                                  • + + +
                                                                                  +
                                                                                  + +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +

                                                                                  Search results

                                                                                  + +
                                                                                  +
                                                                                  +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    + + +
                                                                                    + + + + + + + + diff --git a/files/tests-curlclienttest.html b/files/tests-curlclienttest.html new file mode 100644 index 00000000..6012964a --- /dev/null +++ b/files/tests-curlclienttest.html @@ -0,0 +1,319 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                                                    +

                                                                                    Documentation

                                                                                    + + + + + +
                                                                                    + +
                                                                                    +
                                                                                    + + + + +
                                                                                    +
                                                                                    +
                                                                                      +
                                                                                    + +
                                                                                    +

                                                                                    CurlClientTest.php

                                                                                    + +

                                                                                    Class HTTPClientTest

                                                                                    + + + +
                                                                                    + Tags + + +
                                                                                    +
                                                                                    +
                                                                                    + created +
                                                                                    +
                                                                                    + +

                                                                                    28.08.2018

                                                                                    +
                                                                                    + +
                                                                                    +
                                                                                    + author +
                                                                                    +
                                                                                    + +

                                                                                    smiley smiley@chillerlan.net

                                                                                    +
                                                                                    + +
                                                                                    +
                                                                                    + copyright +
                                                                                    +
                                                                                    + +

                                                                                    2018 smiley

                                                                                    +
                                                                                    + +
                                                                                    +
                                                                                    + license +
                                                                                    +
                                                                                    + +

                                                                                    MIT

                                                                                    +
                                                                                    + +
                                                                                    +
                                                                                    + + + +

                                                                                    + Table of Contents + + +

                                                                                    + + + + +

                                                                                    + Classes + + +

                                                                                    +
                                                                                    +
                                                                                    CurlClientTest
                                                                                    + + + + + + + + + + + + + +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    
                                                                                    +        
                                                                                    + +
                                                                                    +
                                                                                    + + + +
                                                                                    +
                                                                                    +
                                                                                    + +
                                                                                    + On this page + +
                                                                                      +
                                                                                    • Table Of Contents
                                                                                    • +
                                                                                    • + +
                                                                                    • + + +
                                                                                    +
                                                                                    + +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    +

                                                                                    Search results

                                                                                    + +
                                                                                    +
                                                                                    +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      + + +
                                                                                      + + + + + + + + diff --git a/files/tests-curlhandletest.html b/files/tests-curlhandletest.html new file mode 100644 index 00000000..cd68db40 --- /dev/null +++ b/files/tests-curlhandletest.html @@ -0,0 +1,319 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                                                      +

                                                                                      Documentation

                                                                                      + + + + + +
                                                                                      + +
                                                                                      +
                                                                                      + + + + +
                                                                                      +
                                                                                      +
                                                                                        +
                                                                                      + +
                                                                                      +

                                                                                      CurlHandleTest.php

                                                                                      + +

                                                                                      Class CurlHandleTest

                                                                                      + + + +
                                                                                      + Tags + + +
                                                                                      +
                                                                                      +
                                                                                      + created +
                                                                                      +
                                                                                      + +

                                                                                      09.11.2019

                                                                                      +
                                                                                      + +
                                                                                      +
                                                                                      + author +
                                                                                      +
                                                                                      + +

                                                                                      smiley smiley@chillerlan.net

                                                                                      +
                                                                                      + +
                                                                                      +
                                                                                      + copyright +
                                                                                      +
                                                                                      + +

                                                                                      2019 smiley

                                                                                      +
                                                                                      + +
                                                                                      +
                                                                                      + license +
                                                                                      +
                                                                                      + +

                                                                                      MIT

                                                                                      +
                                                                                      + +
                                                                                      +
                                                                                      + + + +

                                                                                      + Table of Contents + + +

                                                                                      + + + + +

                                                                                      + Classes + + +

                                                                                      +
                                                                                      +
                                                                                      CurlHandleTest
                                                                                      + + + + + + + + + + + + + +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      
                                                                                      +        
                                                                                      + +
                                                                                      +
                                                                                      + + + +
                                                                                      +
                                                                                      +
                                                                                      + +
                                                                                      + On this page + +
                                                                                        +
                                                                                      • Table Of Contents
                                                                                      • +
                                                                                      • + +
                                                                                      • + + +
                                                                                      +
                                                                                      + +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +

                                                                                      Search results

                                                                                      + +
                                                                                      +
                                                                                      +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        + + +
                                                                                        + + + + + + + + diff --git a/files/tests-curlmulticlienttest.html b/files/tests-curlmulticlienttest.html new file mode 100644 index 00000000..efe609f0 --- /dev/null +++ b/files/tests-curlmulticlienttest.html @@ -0,0 +1,319 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                                                        +

                                                                                        Documentation

                                                                                        + + + + + +
                                                                                        + +
                                                                                        +
                                                                                        + + + + +
                                                                                        +
                                                                                        +
                                                                                          +
                                                                                        + +
                                                                                        +

                                                                                        CurlMultiClientTest.php

                                                                                        + +

                                                                                        Class CurlMultiClientTest

                                                                                        + + + +
                                                                                        + Tags + + +
                                                                                        +
                                                                                        +
                                                                                        + created +
                                                                                        +
                                                                                        + +

                                                                                        11.08.2019

                                                                                        +
                                                                                        + +
                                                                                        +
                                                                                        + author +
                                                                                        +
                                                                                        + +

                                                                                        smiley smiley@chillerlan.net

                                                                                        +
                                                                                        + +
                                                                                        +
                                                                                        + copyright +
                                                                                        +
                                                                                        + +

                                                                                        2019 smiley

                                                                                        +
                                                                                        + +
                                                                                        +
                                                                                        + license +
                                                                                        +
                                                                                        + +

                                                                                        MIT

                                                                                        +
                                                                                        + +
                                                                                        +
                                                                                        + + + +

                                                                                        + Table of Contents + + +

                                                                                        + + + + +

                                                                                        + Classes + + +

                                                                                        +
                                                                                        +
                                                                                        CurlMultiClientTest
                                                                                        + + + + + + + + + + + + + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        
                                                                                        +        
                                                                                        + +
                                                                                        +
                                                                                        + + + +
                                                                                        +
                                                                                        +
                                                                                        + +
                                                                                        + On this page + +
                                                                                          +
                                                                                        • Table Of Contents
                                                                                        • +
                                                                                        • + +
                                                                                        • + + +
                                                                                        +
                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Search results

                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          + + +
                                                                                          + + + + + + + + diff --git a/files/tests-httpclienttestabstract.html b/files/tests-httpclienttestabstract.html new file mode 100644 index 00000000..4e9bfad5 --- /dev/null +++ b/files/tests-httpclienttestabstract.html @@ -0,0 +1,319 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                                                          +

                                                                                          Documentation

                                                                                          + + + + + +
                                                                                          + +
                                                                                          +
                                                                                          + + + + +
                                                                                          +
                                                                                          +
                                                                                            +
                                                                                          + +
                                                                                          +

                                                                                          HTTPClientTestAbstract.php

                                                                                          + +

                                                                                          Class HTTPClientTestAbstract

                                                                                          + + + +
                                                                                          + Tags + + +
                                                                                          +
                                                                                          +
                                                                                          + created +
                                                                                          +
                                                                                          + +

                                                                                          10.11.2018

                                                                                          +
                                                                                          + +
                                                                                          +
                                                                                          + author +
                                                                                          +
                                                                                          + +

                                                                                          smiley smiley@chillerlan.net

                                                                                          +
                                                                                          + +
                                                                                          +
                                                                                          + copyright +
                                                                                          +
                                                                                          + +

                                                                                          2018 smiley

                                                                                          +
                                                                                          + +
                                                                                          +
                                                                                          + license +
                                                                                          +
                                                                                          + +

                                                                                          MIT

                                                                                          +
                                                                                          + +
                                                                                          +
                                                                                          + + + +

                                                                                          + Table of Contents + + +

                                                                                          + + + + +

                                                                                          + Classes + + +

                                                                                          +
                                                                                          +
                                                                                          HTTPClientTestAbstract
                                                                                          + + + + + + + + + + + + + +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          
                                                                                          +        
                                                                                          + +
                                                                                          +
                                                                                          + + + +
                                                                                          +
                                                                                          +
                                                                                          + +
                                                                                          + On this page + +
                                                                                            +
                                                                                          • Table Of Contents
                                                                                          • +
                                                                                          • + +
                                                                                          • + + +
                                                                                          +
                                                                                          + +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +

                                                                                          Search results

                                                                                          + +
                                                                                          +
                                                                                          +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            + + +
                                                                                            + + + + + + + + diff --git a/files/tests-httpoptionstest.html b/files/tests-httpoptionstest.html new file mode 100644 index 00000000..0fb53ccb --- /dev/null +++ b/files/tests-httpoptionstest.html @@ -0,0 +1,319 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                                                            +

                                                                                            Documentation

                                                                                            + + + + + +
                                                                                            + +
                                                                                            +
                                                                                            + + + + +
                                                                                            +
                                                                                            +
                                                                                              +
                                                                                            + +
                                                                                            +

                                                                                            HTTPOptionsTest.php

                                                                                            + +

                                                                                            Class HTTPOptionsTest

                                                                                            + + + +
                                                                                            + Tags + + +
                                                                                            +
                                                                                            +
                                                                                            + created +
                                                                                            +
                                                                                            + +

                                                                                            14.11.2018

                                                                                            +
                                                                                            + +
                                                                                            +
                                                                                            + author +
                                                                                            +
                                                                                            + +

                                                                                            smiley smiley@chillerlan.net

                                                                                            +
                                                                                            + +
                                                                                            +
                                                                                            + copyright +
                                                                                            +
                                                                                            + +

                                                                                            2018 smiley

                                                                                            +
                                                                                            + +
                                                                                            +
                                                                                            + license +
                                                                                            +
                                                                                            + +

                                                                                            MIT

                                                                                            +
                                                                                            + +
                                                                                            +
                                                                                            + + + +

                                                                                            + Table of Contents + + +

                                                                                            + + + + +

                                                                                            + Classes + + +

                                                                                            +
                                                                                            +
                                                                                            HTTPOptionsTest
                                                                                            + + + + + + + + + + + + + +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            
                                                                                            +        
                                                                                            + +
                                                                                            +
                                                                                            + + + +
                                                                                            +
                                                                                            +
                                                                                            + +
                                                                                            + On this page + +
                                                                                              +
                                                                                            • Table Of Contents
                                                                                            • +
                                                                                            • + +
                                                                                            • + + +
                                                                                            +
                                                                                            + +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            +

                                                                                            Search results

                                                                                            + +
                                                                                            +
                                                                                            +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              + + +
                                                                                              + + + + + + + + diff --git a/files/tests-streamclientnocatest.html b/files/tests-streamclientnocatest.html new file mode 100644 index 00000000..8b4d0afd --- /dev/null +++ b/files/tests-streamclientnocatest.html @@ -0,0 +1,319 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                                                              +

                                                                                              Documentation

                                                                                              + + + + + +
                                                                                              + +
                                                                                              +
                                                                                              + + + + +
                                                                                              +
                                                                                              +
                                                                                                +
                                                                                              + +
                                                                                              +

                                                                                              StreamClientNoCATest.php

                                                                                              + +

                                                                                              Class StreamClientNoCATest

                                                                                              + + + +
                                                                                              + Tags + + +
                                                                                              +
                                                                                              +
                                                                                              + created +
                                                                                              +
                                                                                              + +

                                                                                              23.02.2019

                                                                                              +
                                                                                              + +
                                                                                              +
                                                                                              + author +
                                                                                              +
                                                                                              + +

                                                                                              smiley smiley@chillerlan.net

                                                                                              +
                                                                                              + +
                                                                                              +
                                                                                              + copyright +
                                                                                              +
                                                                                              + +

                                                                                              2019 smiley

                                                                                              +
                                                                                              + +
                                                                                              +
                                                                                              + license +
                                                                                              +
                                                                                              + +

                                                                                              MIT

                                                                                              +
                                                                                              + +
                                                                                              +
                                                                                              + + + +

                                                                                              + Table of Contents + + +

                                                                                              + + + + +

                                                                                              + Classes + + +

                                                                                              +
                                                                                              +
                                                                                              StreamClientNoCATest
                                                                                              + + + + + + + + + + + + + +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              
                                                                                              +        
                                                                                              + +
                                                                                              +
                                                                                              + + + +
                                                                                              +
                                                                                              +
                                                                                              + +
                                                                                              + On this page + +
                                                                                                +
                                                                                              • Table Of Contents
                                                                                              • +
                                                                                              • + +
                                                                                              • + + +
                                                                                              +
                                                                                              + +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +

                                                                                              Search results

                                                                                              + +
                                                                                              +
                                                                                              +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                + + +
                                                                                                + + + + + + + + diff --git a/files/tests-streamclienttest.html b/files/tests-streamclienttest.html new file mode 100644 index 00000000..d139d1e1 --- /dev/null +++ b/files/tests-streamclienttest.html @@ -0,0 +1,319 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                                                                +

                                                                                                Documentation

                                                                                                + + + + + +
                                                                                                + +
                                                                                                +
                                                                                                + + + + +
                                                                                                +
                                                                                                +
                                                                                                  +
                                                                                                + +
                                                                                                +

                                                                                                StreamClientTest.php

                                                                                                + +

                                                                                                Class StreamClientTest

                                                                                                + + + +
                                                                                                + Tags + + +
                                                                                                +
                                                                                                +
                                                                                                + created +
                                                                                                +
                                                                                                + +

                                                                                                23.02.2019

                                                                                                +
                                                                                                + +
                                                                                                +
                                                                                                + author +
                                                                                                +
                                                                                                + +

                                                                                                smiley smiley@chillerlan.net

                                                                                                +
                                                                                                + +
                                                                                                +
                                                                                                + copyright +
                                                                                                +
                                                                                                + +

                                                                                                2019 smiley

                                                                                                +
                                                                                                + +
                                                                                                +
                                                                                                + license +
                                                                                                +
                                                                                                + +

                                                                                                MIT

                                                                                                +
                                                                                                + +
                                                                                                +
                                                                                                + + + +

                                                                                                + Table of Contents + + +

                                                                                                + + + + +

                                                                                                + Classes + + +

                                                                                                +
                                                                                                +
                                                                                                StreamClientTest
                                                                                                + + + + + + + + + + + + + +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                
                                                                                                +        
                                                                                                + +
                                                                                                +
                                                                                                + + + +
                                                                                                +
                                                                                                +
                                                                                                + +
                                                                                                + On this page + +
                                                                                                  +
                                                                                                • Table Of Contents
                                                                                                • +
                                                                                                • + +
                                                                                                • + + +
                                                                                                +
                                                                                                + +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +

                                                                                                Search results

                                                                                                + +
                                                                                                +
                                                                                                +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  + + +
                                                                                                  + + + + + + + + diff --git a/graphs/classes.html b/graphs/classes.html new file mode 100644 index 00000000..7f300b5e --- /dev/null +++ b/graphs/classes.html @@ -0,0 +1,120 @@ + + + + + Documentation + + + + + + + + + +
                                                                                                  +

                                                                                                  Documentation

                                                                                                  + + + + + +
                                                                                                  + +
                                                                                                  +
                                                                                                  + + + + +
                                                                                                  +
                                                                                                  + +
                                                                                                  + +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  +

                                                                                                  Search results

                                                                                                  + +
                                                                                                  +
                                                                                                  +
                                                                                                    +
                                                                                                    +
                                                                                                    +
                                                                                                    +
                                                                                                    + + +
                                                                                                    + + + + + + + + diff --git a/index.html b/index.html new file mode 100644 index 00000000..2b0489ff --- /dev/null +++ b/index.html @@ -0,0 +1,163 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                                                                    +

                                                                                                    Documentation

                                                                                                    + + + + + +
                                                                                                    + +
                                                                                                    +
                                                                                                    + + + + +
                                                                                                    +
                                                                                                    +

                                                                                                    Documentation

                                                                                                    + + + +

                                                                                                    + Table of Contents + + +

                                                                                                    + +

                                                                                                    + Packages + + +

                                                                                                    +
                                                                                                    +
                                                                                                    Application
                                                                                                    +
                                                                                                    + +

                                                                                                    + Namespaces + + +

                                                                                                    +
                                                                                                    +
                                                                                                    chillerlan
                                                                                                    +
                                                                                                    + + + + + + + + + + + + + +
                                                                                                    +
                                                                                                    +
                                                                                                    +
                                                                                                    +
                                                                                                    +

                                                                                                    Search results

                                                                                                    + +
                                                                                                    +
                                                                                                    +
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      + + +
                                                                                                      + + + + + + + + diff --git a/indices/files.html b/indices/files.html new file mode 100644 index 00000000..b17eea05 --- /dev/null +++ b/indices/files.html @@ -0,0 +1,167 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                                                                      +

                                                                                                      Documentation

                                                                                                      + + + + + +
                                                                                                      + +
                                                                                                      + + + +
                                                                                                      + + + + + + + + diff --git a/js/search.js b/js/search.js new file mode 100644 index 00000000..093d6d03 --- /dev/null +++ b/js/search.js @@ -0,0 +1,173 @@ +// Search module for phpDocumentor +// +// This module is a wrapper around fuse.js that will use a given index and attach itself to a +// search form and to a search results pane identified by the following data attributes: +// +// 1. data-search-form +// 2. data-search-results +// +// The data-search-form is expected to have a single input element of type 'search' that will trigger searching for +// a series of results, were the data-search-results pane is expected to have a direct UL child that will be populated +// with rendered results. +// +// The search has various stages, upon loading this stage the data-search-form receives the CSS class +// 'phpdocumentor-search--enabled'; this indicates that JS is allowed and indices are being loaded. It is recommended +// to hide the form by default and show it when it receives this class to achieve progressive enhancement for this +// feature. +// +// After loading this module, it is expected to load a search index asynchronously, for example: +// +// +// +// In this script the generated index should attach itself to the search module using the `appendIndex` function. By +// doing it like this the page will continue loading, unhindered by the loading of the search. +// +// After the page has fully loaded, and all these deferred indexes loaded, the initialization of the search module will +// be called and the form will receive the class 'phpdocumentor-search--active', indicating search is ready. At this +// point, the input field will also have it's 'disabled' attribute removed. +var Search = (function () { + var fuse; + var index = []; + var options = { + shouldSort: true, + threshold: 0.6, + location: 0, + distance: 100, + maxPatternLength: 32, + minMatchCharLength: 1, + keys: [ + "fqsen", + "name", + "summary", + "url" + ] + }; + + // Credit David Walsh (https://davidwalsh.name/javascript-debounce-function) + // Returns a function, that, as long as it continues to be invoked, will not + // be triggered. The function will be called after it stops being called for + // N milliseconds. If `immediate` is passed, trigger the function on the + // leading edge, instead of the trailing. + function debounce(func, wait, immediate) { + var timeout; + + return function executedFunction() { + var context = this; + var args = arguments; + + var later = function () { + timeout = null; + if (!immediate) func.apply(context, args); + }; + + var callNow = immediate && !timeout; + clearTimeout(timeout); + timeout = setTimeout(later, wait); + if (callNow) func.apply(context, args); + }; + } + + function close() { + // Start scroll prevention: https://css-tricks.com/prevent-page-scrolling-when-a-modal-is-open/ + const scrollY = document.body.style.top; + document.body.style.position = ''; + document.body.style.top = ''; + window.scrollTo(0, parseInt(scrollY || '0') * -1); + // End scroll prevention + + var form = document.querySelector('[data-search-form]'); + var searchResults = document.querySelector('[data-search-results]'); + + form.classList.toggle('phpdocumentor-search--has-results', false); + searchResults.classList.add('phpdocumentor-search-results--hidden'); + var searchField = document.querySelector('[data-search-form] input[type="search"]'); + searchField.blur(); + } + + function search(event) { + // Start scroll prevention: https://css-tricks.com/prevent-page-scrolling-when-a-modal-is-open/ + document.body.style.position = 'fixed'; + document.body.style.top = `-${window.scrollY}px`; + // End scroll prevention + + // prevent enter's from autosubmitting + event.stopPropagation(); + + var form = document.querySelector('[data-search-form]'); + var searchResults = document.querySelector('[data-search-results]'); + var searchResultEntries = document.querySelector('[data-search-results] .phpdocumentor-search-results__entries'); + + searchResultEntries.innerHTML = ''; + + if (!event.target.value) { + close(); + return; + } + + form.classList.toggle('phpdocumentor-search--has-results', true); + searchResults.classList.remove('phpdocumentor-search-results--hidden'); + var results = fuse.search(event.target.value, {limit: 25}); + + results.forEach(function (result) { + var entry = document.createElement("li"); + entry.classList.add("phpdocumentor-search-results__entry"); + entry.innerHTML += '

                                                                                                      ' + result.name + "

                                                                                                      \n"; + entry.innerHTML += '' + result.fqsen + "\n"; + entry.innerHTML += '
                                                                                                      ' + result.summary + '
                                                                                                      '; + searchResultEntries.appendChild(entry) + }); + } + + function appendIndex(added) { + index = index.concat(added); + + // re-initialize search engine when appending an index after initialisation + if (typeof fuse !== 'undefined') { + fuse = new Fuse(index, options); + } + } + + function init() { + fuse = new Fuse(index, options); + + var form = document.querySelector('[data-search-form]'); + var searchField = document.querySelector('[data-search-form] input[type="search"]'); + + var closeButton = document.querySelector('.phpdocumentor-search-results__close'); + closeButton.addEventListener('click', function() { close() }.bind(this)); + + var searchResults = document.querySelector('[data-search-results]'); + searchResults.addEventListener('click', function() { close() }.bind(this)); + + form.classList.add('phpdocumentor-search--active'); + + searchField.setAttribute('placeholder', 'Search (Press "/" to focus)'); + searchField.removeAttribute('disabled'); + searchField.addEventListener('keyup', debounce(search, 300)); + + window.addEventListener('keyup', function (event) { + if (event.key === '/') { + searchField.focus(); + } + if (event.code === 'Escape') { + close(); + } + }.bind(this)); + } + + return { + appendIndex, + init + } +})(); + +window.addEventListener('DOMContentLoaded', function () { + var form = document.querySelector('[data-search-form]'); + + // When JS is supported; show search box. Must be before including the search for it to take effect immediately + form.classList.add('phpdocumentor-search--enabled'); +}); + +window.addEventListener('load', function () { + Search.init(); +}); diff --git a/js/searchIndex.js b/js/searchIndex.js new file mode 100644 index 00000000..9993c491 --- /dev/null +++ b/js/searchIndex.js @@ -0,0 +1,734 @@ +Search.appendIndex( + [ + { + "fqsen": "\\chillerlan\\HTTP\\ClientException", + "name": "ClientException", + "summary": "", + "url": "classes/chillerlan-HTTP-ClientException.html" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlClient", + "name": "CurlClient", + "summary": "A\u0020\u0022simple\u0022\u0020cURL\u0020http\u0020client", + "url": "classes/chillerlan-HTTP-CurlClient.html" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlClient\u003A\u003AsendRequest\u0028\u0029", + "name": "sendRequest", + "summary": "", + "url": "classes/chillerlan-HTTP-CurlClient.html#method_sendRequest" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlHandle", + "name": "CurlHandle", + "summary": "Implements\u0020a\u0020cURL\u0020connection\u0020object", + "url": "classes/chillerlan-HTTP-CurlHandle.html" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "CurlHandle\u0020constructor.", + "url": "classes/chillerlan-HTTP-CurlHandle.html#method___construct" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003A__destruct\u0028\u0029", + "name": "__destruct", + "summary": "close\u0020an\u0020existing\u0020cURL\u0020handle\u0020on\u0020exit", + "url": "classes/chillerlan-HTTP-CurlHandle.html#method___destruct" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003Aclose\u0028\u0029", + "name": "close", + "summary": "closes\u0020the\u0020handle", + "url": "classes/chillerlan-HTTP-CurlHandle.html#method_close" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003AgetCurlResource\u0028\u0029", + "name": "getCurlResource", + "summary": "returns\u0020the\u0020internal\u0020cURL\u0020resource\u0020in\u0020its\u0020current\u0020state", + "url": "classes/chillerlan-HTTP-CurlHandle.html#method_getCurlResource" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003AgetHandleID\u0028\u0029", + "name": "getHandleID", + "summary": "returns\u0020the\u0020handle\u0020ID\u0020\u0028cURL\u0020resource\u0020id\u0029", + "url": "classes/chillerlan-HTTP-CurlHandle.html#method_getHandleID" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003AgetInfo\u0028\u0029", + "name": "getInfo", + "summary": "returns\u0020the\u0020result\u0020from\u0020\u0060curl_getinfo\u0028\u0029\u0060\u0020or\u0020\u0060null\u0060\u0020in\u0020case\u0020of\u0020an\u0020error", + "url": "classes/chillerlan-HTTP-CurlHandle.html#method_getInfo" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003AgetRequest\u0028\u0029", + "name": "getRequest", + "summary": "", + "url": "classes/chillerlan-HTTP-CurlHandle.html#method_getRequest" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003AgetResponse\u0028\u0029", + "name": "getResponse", + "summary": "", + "url": "classes/chillerlan-HTTP-CurlHandle.html#method_getResponse" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003AgetCurlOptions\u0028\u0029", + "name": "getCurlOptions", + "summary": "", + "url": "classes/chillerlan-HTTP-CurlHandle.html#method_getCurlOptions" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003AguessCA\u0028\u0029", + "name": "guessCA", + "summary": "Check\u0020default\u0020locations\u0020for\u0020the\u0020CA\u0020bundle", + "url": "classes/chillerlan-HTTP-CurlHandle.html#method_guessCA" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003AsetCA\u0028\u0029", + "name": "setCA", + "summary": "", + "url": "classes/chillerlan-HTTP-CurlHandle.html#method_setCA" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003AsetRequestOptions\u0028\u0029", + "name": "setRequestOptions", + "summary": "", + "url": "classes/chillerlan-HTTP-CurlHandle.html#method_setRequestOptions" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003Ainit\u0028\u0029", + "name": "init", + "summary": "", + "url": "classes/chillerlan-HTTP-CurlHandle.html#method_init" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003Aexec\u0028\u0029", + "name": "exec", + "summary": "executes\u0020the\u0020current\u0020cURL\u0020instance\u0020and\u0020returns\u0020the\u0020error\u0020number", + "url": "classes/chillerlan-HTTP-CurlHandle.html#method_exec" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003AgetError\u0028\u0029", + "name": "getError", + "summary": "returns\u0020a\u0020string\u0020containing\u0020the\u0020last\u0020error", + "url": "classes/chillerlan-HTTP-CurlHandle.html#method_getError" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003ACURL_NETWORK_ERRORS", + "name": "CURL_NETWORK_ERRORS", + "summary": "", + "url": "classes/chillerlan-HTTP-CurlHandle.html#constant_CURL_NETWORK_ERRORS" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003ANEVER_OVERWRITE", + "name": "NEVER_OVERWRITE", + "summary": "", + "url": "classes/chillerlan-HTTP-CurlHandle.html#constant_NEVER_OVERWRITE" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003A\u0024curl", + "name": "curl", + "summary": "", + "url": "classes/chillerlan-HTTP-CurlHandle.html#property_curl" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003A\u0024handleID", + "name": "handleID", + "summary": "", + "url": "classes/chillerlan-HTTP-CurlHandle.html#property_handleID" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003A\u0024curlOptions", + "name": "curlOptions", + "summary": "", + "url": "classes/chillerlan-HTTP-CurlHandle.html#property_curlOptions" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003A\u0024initialized", + "name": "initialized", + "summary": "", + "url": "classes/chillerlan-HTTP-CurlHandle.html#property_initialized" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003A\u0024requestBody", + "name": "requestBody", + "summary": "", + "url": "classes/chillerlan-HTTP-CurlHandle.html#property_requestBody" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003A\u0024responseBody", + "name": "responseBody", + "summary": "", + "url": "classes/chillerlan-HTTP-CurlHandle.html#property_responseBody" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003A\u0024request", + "name": "request", + "summary": "", + "url": "classes/chillerlan-HTTP-CurlHandle.html#property_request" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003A\u0024response", + "name": "response", + "summary": "", + "url": "classes/chillerlan-HTTP-CurlHandle.html#property_response" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlHandle\u003A\u003A\u0024options", + "name": "options", + "summary": "", + "url": "classes/chillerlan-HTTP-CurlHandle.html#property_options" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient", + "name": "CurlMultiClient", + "summary": "Curl\u0020multi\u0020http\u0020client", + "url": "classes/chillerlan-HTTP-CurlMultiClient.html" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "CurlMultiClient\u0020constructor.", + "url": "classes/chillerlan-HTTP-CurlMultiClient.html#method___construct" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003AinitCurlMultiOptions\u0028\u0029", + "name": "initCurlMultiOptions", + "summary": "", + "url": "classes/chillerlan-HTTP-CurlMultiClient.html#method_initCurlMultiOptions" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003A__destruct\u0028\u0029", + "name": "__destruct", + "summary": "close\u0020an\u0020existing\u0020cURL\u0020multi\u0020handle\u0020on\u0020exit", + "url": "classes/chillerlan-HTTP-CurlMultiClient.html#method___destruct" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003AsetLogger\u0028\u0029", + "name": "setLogger", + "summary": "", + "url": "classes/chillerlan-HTTP-CurlMultiClient.html#method_setLogger" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003Aclose\u0028\u0029", + "name": "close", + "summary": "closes\u0020the\u0020handle", + "url": "classes/chillerlan-HTTP-CurlMultiClient.html#method_close" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003AaddRequest\u0028\u0029", + "name": "addRequest", + "summary": "adds\u0020a\u0020request\u0020to\u0020the\u0020stack", + "url": "classes/chillerlan-HTTP-CurlMultiClient.html#method_addRequest" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003AaddRequests\u0028\u0029", + "name": "addRequests", + "summary": "adds\u0020multiple\u0020requests\u0020to\u0020the\u0020stack", + "url": "classes/chillerlan-HTTP-CurlMultiClient.html#method_addRequests" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003Aprocess\u0028\u0029", + "name": "process", + "summary": "processes\u0020the\u0020stack", + "url": "classes/chillerlan-HTTP-CurlMultiClient.html#method_process" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003Aresolve\u0028\u0029", + "name": "resolve", + "summary": "resolves\u0020the\u0020handle,\u0020calls\u0020the\u0020response\u0020handler\u0020callback\u0020and\u0020creates\u0020the\u0020next\u0020handle", + "url": "classes/chillerlan-HTTP-CurlMultiClient.html#method_resolve" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003AcreateHandle\u0028\u0029", + "name": "createHandle", + "summary": "creates\u0020a\u0020new\u0020request\u0020handle", + "url": "classes/chillerlan-HTTP-CurlMultiClient.html#method_createHandle" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003A\u0024curl_multi", + "name": "curl_multi", + "summary": "the\u0020cURL\u0020multi\u0020handle\u0020instance", + "url": "classes/chillerlan-HTTP-CurlMultiClient.html#property_curl_multi" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003A\u0024requests", + "name": "requests", + "summary": "An\u0020array\u0020of\u0020RequestInterface\u0020to\u0020run", + "url": "classes/chillerlan-HTTP-CurlMultiClient.html#property_requests" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003A\u0024handles", + "name": "handles", + "summary": "the\u0020stack\u0020of\u0020running\u0020handles", + "url": "classes/chillerlan-HTTP-CurlMultiClient.html#property_handles" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003A\u0024counter", + "name": "counter", + "summary": "the\u0020request\u0020counter\u0020\u0028request\u0020ID\/order\u0020in\u0020multi\u0020response\u0020handler\u0029", + "url": "classes/chillerlan-HTTP-CurlMultiClient.html#property_counter" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003A\u0024multiResponseHandler", + "name": "multiResponseHandler", + "summary": "", + "url": "classes/chillerlan-HTTP-CurlMultiClient.html#property_multiResponseHandler" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003A\u0024responseFactory", + "name": "responseFactory", + "summary": "", + "url": "classes/chillerlan-HTTP-CurlMultiClient.html#property_responseFactory" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003A\u0024options", + "name": "options", + "summary": "", + "url": "classes/chillerlan-HTTP-CurlMultiClient.html#property_options" + }, { + "fqsen": "\\chillerlan\\HTTP\\CurlMultiClient\u003A\u003A\u0024logger", + "name": "logger", + "summary": "", + "url": "classes/chillerlan-HTTP-CurlMultiClient.html#property_logger" + }, { + "fqsen": "\\chillerlan\\HTTP\\HTTPClientAbstract", + "name": "HTTPClientAbstract", + "summary": "", + "url": "classes/chillerlan-HTTP-HTTPClientAbstract.html" + }, { + "fqsen": "\\chillerlan\\HTTP\\HTTPClientAbstract\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "HTTPClientAbstract\u0020constructor.", + "url": "classes/chillerlan-HTTP-HTTPClientAbstract.html#method___construct" + }, { + "fqsen": "\\chillerlan\\HTTP\\HTTPClientAbstract\u003A\u003AsetLogger\u0028\u0029", + "name": "setLogger", + "summary": "Sets\u0020a\u0020PSR\u002D3\u0020Logger", + "url": "classes/chillerlan-HTTP-HTTPClientAbstract.html#method_setLogger" + }, { + "fqsen": "\\chillerlan\\HTTP\\HTTPClientAbstract\u003A\u003AsetResponseFactory\u0028\u0029", + "name": "setResponseFactory", + "summary": "Sets\u0020a\u0020PSR\u002D17\u0020response\u0020factory", + "url": "classes/chillerlan-HTTP-HTTPClientAbstract.html#method_setResponseFactory" + }, { + "fqsen": "\\chillerlan\\HTTP\\HTTPClientAbstract\u003A\u003AsetStreamFactory\u0028\u0029", + "name": "setStreamFactory", + "summary": "Sets\u0020a\u0020PSR\u002D17\u0020stream\u0020factory", + "url": "classes/chillerlan-HTTP-HTTPClientAbstract.html#method_setStreamFactory" + }, { + "fqsen": "\\chillerlan\\HTTP\\HTTPClientAbstract\u003A\u003A\u0024streamFactory", + "name": "streamFactory", + "summary": "", + "url": "classes/chillerlan-HTTP-HTTPClientAbstract.html#property_streamFactory" + }, { + "fqsen": "\\chillerlan\\HTTP\\HTTPClientAbstract\u003A\u003A\u0024responseFactory", + "name": "responseFactory", + "summary": "", + "url": "classes/chillerlan-HTTP-HTTPClientAbstract.html#property_responseFactory" + }, { + "fqsen": "\\chillerlan\\HTTP\\HTTPClientAbstract\u003A\u003A\u0024options", + "name": "options", + "summary": "", + "url": "classes/chillerlan-HTTP-HTTPClientAbstract.html#property_options" + }, { + "fqsen": "\\chillerlan\\HTTP\\HTTPClientAbstract\u003A\u003A\u0024logger", + "name": "logger", + "summary": "", + "url": "classes/chillerlan-HTTP-HTTPClientAbstract.html#property_logger" + }, { + "fqsen": "\\chillerlan\\HTTP\\HTTPClientInterface", + "name": "HTTPClientInterface", + "summary": "", + "url": "classes/chillerlan-HTTP-HTTPClientInterface.html" + }, { + "fqsen": "\\chillerlan\\HTTP\\HTTPClientInterface\u003A\u003AsetLogger\u0028\u0029", + "name": "setLogger", + "summary": "Sets\u0020a\u0020PSR\u002D3\u0020Logger", + "url": "classes/chillerlan-HTTP-HTTPClientInterface.html#method_setLogger" + }, { + "fqsen": "\\chillerlan\\HTTP\\HTTPClientInterface\u003A\u003AsetResponseFactory\u0028\u0029", + "name": "setResponseFactory", + "summary": "Sets\u0020a\u0020PSR\u002D17\u0020response\u0020factory", + "url": "classes/chillerlan-HTTP-HTTPClientInterface.html#method_setResponseFactory" + }, { + "fqsen": "\\chillerlan\\HTTP\\HTTPClientInterface\u003A\u003AsetStreamFactory\u0028\u0029", + "name": "setStreamFactory", + "summary": "Sets\u0020a\u0020PSR\u002D17\u0020stream\u0020factory", + "url": "classes/chillerlan-HTTP-HTTPClientInterface.html#method_setStreamFactory" + }, { + "fqsen": "\\chillerlan\\HTTP\\HTTPOptions", + "name": "HTTPOptions", + "summary": "", + "url": "classes/chillerlan-HTTP-HTTPOptions.html" + }, { + "fqsen": "\\chillerlan\\HTTP\\HTTPOptionsTrait", + "name": "HTTPOptionsTrait", + "summary": "", + "url": "classes/chillerlan-HTTP-HTTPOptionsTrait.html" + }, { + "fqsen": "\\chillerlan\\HTTP\\HTTPOptionsTrait\u003A\u003Aset_user_agent\u0028\u0029", + "name": "set_user_agent", + "summary": "", + "url": "classes/chillerlan-HTTP-HTTPOptionsTrait.html#method_set_user_agent" + }, { + "fqsen": "\\chillerlan\\HTTP\\HTTPOptionsTrait\u003A\u003Aset_curl_options\u0028\u0029", + "name": "set_curl_options", + "summary": "", + "url": "classes/chillerlan-HTTP-HTTPOptionsTrait.html#method_set_curl_options" + }, { + "fqsen": "\\chillerlan\\HTTP\\HTTPOptionsTrait\u003A\u003Aset_dns_over_https\u0028\u0029", + "name": "set_dns_over_https", + "summary": "", + "url": "classes/chillerlan-HTTP-HTTPOptionsTrait.html#method_set_dns_over_https" + }, { + "fqsen": "\\chillerlan\\HTTP\\HTTPOptionsTrait\u003A\u003A\u0024user_agent", + "name": "user_agent", + "summary": "A\u0020custom\u0020user\u0020agent\u0020string", + "url": "classes/chillerlan-HTTP-HTTPOptionsTrait.html#property_user_agent" + }, { + "fqsen": "\\chillerlan\\HTTP\\HTTPOptionsTrait\u003A\u003A\u0024curl_options", + "name": "curl_options", + "summary": "options\u0020for\u0020each\u0020curl\u0020instance", + "url": "classes/chillerlan-HTTP-HTTPOptionsTrait.html#property_curl_options" + }, { + "fqsen": "\\chillerlan\\HTTP\\HTTPOptionsTrait\u003A\u003A\u0024ca_info", + "name": "ca_info", + "summary": "CA\u0020Root\u0020Certificates\u0020for\u0020use\u0020with\u0020CURL\/SSL", + "url": "classes/chillerlan-HTTP-HTTPOptionsTrait.html#property_ca_info" + }, { + "fqsen": "\\chillerlan\\HTTP\\HTTPOptionsTrait\u003A\u003A\u0024ssl_verifypeer", + "name": "ssl_verifypeer", + "summary": "see\u0020CURLOPT_SSL_VERIFYPEER\nrequires\u0020either\u0020HTTPOptions\u003A\u003A\u0024ca_info\u0020or\u0020a\u0020properly\u0020working\u0020system\u0020CA\u0020file", + "url": "classes/chillerlan-HTTP-HTTPOptionsTrait.html#property_ssl_verifypeer" + }, { + "fqsen": "\\chillerlan\\HTTP\\HTTPOptionsTrait\u003A\u003A\u0024curl_multi_options", + "name": "curl_multi_options", + "summary": "options\u0020for\u0020the\u0020curl\u0020multi\u0020instance", + "url": "classes/chillerlan-HTTP-HTTPOptionsTrait.html#property_curl_multi_options" + }, { + "fqsen": "\\chillerlan\\HTTP\\HTTPOptionsTrait\u003A\u003A\u0024curl_check_OCSP", + "name": "curl_check_OCSP", + "summary": "cURL\u0020extra\u0020hardening", + "url": "classes/chillerlan-HTTP-HTTPOptionsTrait.html#property_curl_check_OCSP" + }, { + "fqsen": "\\chillerlan\\HTTP\\HTTPOptionsTrait\u003A\u003A\u0024window_size", + "name": "window_size", + "summary": "maximum\u0020of\u0020concurrent\u0020requests\u0020for\u0020curl_multi", + "url": "classes/chillerlan-HTTP-HTTPOptionsTrait.html#property_window_size" + }, { + "fqsen": "\\chillerlan\\HTTP\\HTTPOptionsTrait\u003A\u003A\u0024sleep", + "name": "sleep", + "summary": "sleep\u0020timer\u0020\u0028microseconds\u0029\u0020between\u0020each\u0020fired\u0020multi\u0020request\u0020on\u0020startup", + "url": "classes/chillerlan-HTTP-HTTPOptionsTrait.html#property_sleep" + }, { + "fqsen": "\\chillerlan\\HTTP\\HTTPOptionsTrait\u003A\u003A\u0024timeout", + "name": "timeout", + "summary": "Timeout\u0020value", + "url": "classes/chillerlan-HTTP-HTTPOptionsTrait.html#property_timeout" + }, { + "fqsen": "\\chillerlan\\HTTP\\HTTPOptionsTrait\u003A\u003A\u0024retries", + "name": "retries", + "summary": "Number\u0020of\u0020retries\u0020\u0028multi\u0020fetch\u0029", + "url": "classes/chillerlan-HTTP-HTTPOptionsTrait.html#property_retries" + }, { + "fqsen": "\\chillerlan\\HTTP\\HTTPOptionsTrait\u003A\u003A\u0024dns_over_https", + "name": "dns_over_https", + "summary": "Sets\u0020a\u0020DNS\u002Dover\u002DHTTPS\u0020provider\u0020URL", + "url": "classes/chillerlan-HTTP-HTTPOptionsTrait.html#property_dns_over_https" + }, { + "fqsen": "\\chillerlan\\HTTP\\MultiResponseHandlerInterface", + "name": "MultiResponseHandlerInterface", + "summary": "The\u0020multi\u0020response\u0020handler.\u0020\u0028Schr\u00F6dinger\u0027s\u0020cat\u0020state\u0020handler\u0029", + "url": "classes/chillerlan-HTTP-MultiResponseHandlerInterface.html" + }, { + "fqsen": "\\chillerlan\\HTTP\\MultiResponseHandlerInterface\u003A\u003AhandleResponse\u0028\u0029", + "name": "handleResponse", + "summary": "This\u0020method\u0020will\u0020be\u0020called\u0020within\u0020a\u0020loop\u0020in\u0020MultiRequest\u003A\u003AprocessStack\u0028\u0029.", + "url": "classes/chillerlan-HTTP-MultiResponseHandlerInterface.html#method_handleResponse" + }, { + "fqsen": "\\chillerlan\\HTTP\\NetworkException", + "name": "NetworkException", + "summary": "", + "url": "classes/chillerlan-HTTP-NetworkException.html" + }, { + "fqsen": "\\chillerlan\\HTTP\\NetworkException\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "", + "url": "classes/chillerlan-HTTP-NetworkException.html#method___construct" + }, { + "fqsen": "\\chillerlan\\HTTP\\NetworkException\u003A\u003AgetRequest\u0028\u0029", + "name": "getRequest", + "summary": "", + "url": "classes/chillerlan-HTTP-NetworkException.html#method_getRequest" + }, { + "fqsen": "\\chillerlan\\HTTP\\NetworkException\u003A\u003A\u0024request", + "name": "request", + "summary": "", + "url": "classes/chillerlan-HTTP-NetworkException.html#property_request" + }, { + "fqsen": "\\chillerlan\\HTTP\\RequestException", + "name": "RequestException", + "summary": "", + "url": "classes/chillerlan-HTTP-RequestException.html" + }, { + "fqsen": "\\chillerlan\\HTTP\\RequestException\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "", + "url": "classes/chillerlan-HTTP-RequestException.html#method___construct" + }, { + "fqsen": "\\chillerlan\\HTTP\\RequestException\u003A\u003AgetRequest\u0028\u0029", + "name": "getRequest", + "summary": "", + "url": "classes/chillerlan-HTTP-RequestException.html#method_getRequest" + }, { + "fqsen": "\\chillerlan\\HTTP\\RequestException\u003A\u003A\u0024request", + "name": "request", + "summary": "", + "url": "classes/chillerlan-HTTP-RequestException.html#property_request" + }, { + "fqsen": "\\chillerlan\\HTTP\\StreamClient", + "name": "StreamClient", + "summary": "A\u0020http\u0020client\u0020via\u0020PHP\u0020streams", + "url": "classes/chillerlan-HTTP-StreamClient.html" + }, { + "fqsen": "\\chillerlan\\HTTP\\StreamClient\u003A\u003AsendRequest\u0028\u0029", + "name": "sendRequest", + "summary": "", + "url": "classes/chillerlan-HTTP-StreamClient.html#method_sendRequest" + }, { + "fqsen": "\\chillerlan\\HTTP\\StreamClient\u003A\u003AgetContextOptions\u0028\u0029", + "name": "getContextOptions", + "summary": "", + "url": "classes/chillerlan-HTTP-StreamClient.html#method_getContextOptions" + }, { + "fqsen": "\\chillerlan\\HTTP\\StreamClient\u003A\u003AgetRequestHeaders\u0028\u0029", + "name": "getRequestHeaders", + "summary": "", + "url": "classes/chillerlan-HTTP-StreamClient.html#method_getRequestHeaders" + }, { + "fqsen": "\\chillerlan\\HTTP\\StreamClient\u003A\u003AcreateResponse\u0028\u0029", + "name": "createResponse", + "summary": "", + "url": "classes/chillerlan-HTTP-StreamClient.html#method_createResponse" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\ClientFactories\\CurlClientFactory", + "name": "CurlClientFactory", + "summary": "", + "url": "classes/chillerlan-HTTPTest-ClientFactories-CurlClientFactory.html" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\ClientFactories\\CurlClientFactory\u003A\u003AgetClient\u0028\u0029", + "name": "getClient", + "summary": "", + "url": "classes/chillerlan-HTTPTest-ClientFactories-CurlClientFactory.html#method_getClient" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\ClientFactories\\CurlClientNoCAFactory", + "name": "CurlClientNoCAFactory", + "summary": "", + "url": "classes/chillerlan-HTTPTest-ClientFactories-CurlClientNoCAFactory.html" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\ClientFactories\\CurlClientNoCAFactory\u003A\u003AgetClient\u0028\u0029", + "name": "getClient", + "summary": "", + "url": "classes/chillerlan-HTTPTest-ClientFactories-CurlClientNoCAFactory.html#method_getClient" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\ClientFactories\\StreamClientFactory", + "name": "StreamClientFactory", + "summary": "", + "url": "classes/chillerlan-HTTPTest-ClientFactories-StreamClientFactory.html" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\ClientFactories\\StreamClientFactory\u003A\u003AgetClient\u0028\u0029", + "name": "getClient", + "summary": "", + "url": "classes/chillerlan-HTTPTest-ClientFactories-StreamClientFactory.html#method_getClient" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\ClientFactories\\StreamClientNoCAFactory", + "name": "StreamClientNoCAFactory", + "summary": "", + "url": "classes/chillerlan-HTTPTest-ClientFactories-StreamClientNoCAFactory.html" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\ClientFactories\\StreamClientNoCAFactory\u003A\u003AgetClient\u0028\u0029", + "name": "getClient", + "summary": "", + "url": "classes/chillerlan-HTTPTest-ClientFactories-StreamClientNoCAFactory.html#method_getClient" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlClientNoCATest", + "name": "CurlClientNoCATest", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlClientNoCATest.html" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlClientNoCATest\u003A\u003A\u0024HTTP_CLIENT_FACTORY", + "name": "HTTP_CLIENT_FACTORY", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlClientNoCATest.html#property_HTTP_CLIENT_FACTORY" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlClientTest", + "name": "CurlClientTest", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlClientTest.html" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlClientTest\u003A\u003AtestRequestError\u0028\u0029", + "name": "testRequestError", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlClientTest.html#method_testRequestError" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlClientTest\u003A\u003A\u0024HTTP_CLIENT_FACTORY", + "name": "HTTP_CLIENT_FACTORY", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlClientTest.html#property_HTTP_CLIENT_FACTORY" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlHandleTest", + "name": "CurlHandleTest", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlHandleTest.html" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlHandleTest\u003A\u003AsetUp\u0028\u0029", + "name": "setUp", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlHandleTest.html#method_setUp" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlHandleTest\u003A\u003AcreateHandle\u0028\u0029", + "name": "createHandle", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlHandleTest.html#method_createHandle" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlHandleTest\u003A\u003AinvalidCaOptionProvider\u0028\u0029", + "name": "invalidCaOptionProvider", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlHandleTest.html#method_invalidCaOptionProvider" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlHandleTest\u003A\u003AtestInvalidCAException\u0028\u0029", + "name": "testInvalidCAException", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlHandleTest.html#method_testInvalidCAException" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlHandleTest\u003A\u003AcaOptionProvider\u0028\u0029", + "name": "caOptionProvider", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlHandleTest.html#method_caOptionProvider" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlHandleTest\u003A\u003AtestCaInfoFile\u0028\u0029", + "name": "testCaInfoFile", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlHandleTest.html#method_testCaInfoFile" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlHandleTest\u003A\u003ArequestMethodProvider\u0028\u0029", + "name": "requestMethodProvider", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlHandleTest.html#method_requestMethodProvider" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlHandleTest\u003A\u003AtestRequestMethods\u0028\u0029", + "name": "testRequestMethods", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlHandleTest.html#method_testRequestMethods" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlHandleTest\u003A\u003ArequestMethodWithBodyProvider\u0028\u0029", + "name": "requestMethodWithBodyProvider", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlHandleTest.html#method_requestMethodWithBodyProvider" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlHandleTest\u003A\u003AtestRequestMethodsWithFormBody\u0028\u0029", + "name": "testRequestMethodsWithFormBody", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlHandleTest.html#method_testRequestMethodsWithFormBody" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlHandleTest\u003A\u003AtestRequestMethodsWithJsonBody\u0028\u0029", + "name": "testRequestMethodsWithJsonBody", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlHandleTest.html#method_testRequestMethodsWithJsonBody" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlHandleTest\u003A\u003AtestLargeBody\u0028\u0029", + "name": "testLargeBody", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlHandleTest.html#method_testLargeBody" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlHandleTest\u003A\u003A\u0024HTTP_CLIENT_FACTORY", + "name": "HTTP_CLIENT_FACTORY", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlHandleTest.html#property_HTTP_CLIENT_FACTORY" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlMultiClientTest", + "name": "CurlMultiClientTest", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlMultiClientTest.html" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlMultiClientTest\u003A\u003AsetUp\u0028\u0029", + "name": "setUp", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlMultiClientTest.html#method_setUp" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlMultiClientTest\u003A\u003AgetTestResponseHandler\u0028\u0029", + "name": "getTestResponseHandler", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlMultiClientTest.html#method_getTestResponseHandler" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlMultiClientTest\u003A\u003AgetRequests\u0028\u0029", + "name": "getRequests", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlMultiClientTest.html#method_getRequests" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlMultiClientTest\u003A\u003AtestMultiRequest\u0028\u0029", + "name": "testMultiRequest", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlMultiClientTest.html#method_testMultiRequest" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlMultiClientTest\u003A\u003AtestEmptyStackException\u0028\u0029", + "name": "testEmptyStackException", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlMultiClientTest.html#method_testEmptyStackException" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlMultiClientTest\u003A\u003A\u0024http", + "name": "http", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlMultiClientTest.html#property_http" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\CurlMultiClientTest\u003A\u003A\u0024multiResponseHandler", + "name": "multiResponseHandler", + "summary": "", + "url": "classes/chillerlan-HTTPTest-CurlMultiClientTest.html#property_multiResponseHandler" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\HTTPClientTestAbstract", + "name": "HTTPClientTestAbstract", + "summary": "", + "url": "classes/chillerlan-HTTPTest-HTTPClientTestAbstract.html" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\HTTPClientTestAbstract\u003A\u003AsetUp\u0028\u0029", + "name": "setUp", + "summary": "", + "url": "classes/chillerlan-HTTPTest-HTTPClientTestAbstract.html#method_setUp" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\HTTPClientTestAbstract\u003A\u003AtestSendRequest\u0028\u0029", + "name": "testSendRequest", + "summary": "", + "url": "classes/chillerlan-HTTPTest-HTTPClientTestAbstract.html#method_testSendRequest" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\HTTPClientTestAbstract\u003A\u003AtestNetworkError\u0028\u0029", + "name": "testNetworkError", + "summary": "", + "url": "classes/chillerlan-HTTPTest-HTTPClientTestAbstract.html#method_testNetworkError" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\HTTPClientTestAbstract\u003A\u003AUSER_AGENT", + "name": "USER_AGENT", + "summary": "", + "url": "classes/chillerlan-HTTPTest-HTTPClientTestAbstract.html#constant_USER_AGENT" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\HTTPOptionsTest", + "name": "HTTPOptionsTest", + "summary": "", + "url": "classes/chillerlan-HTTPTest-HTTPOptionsTest.html" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\HTTPOptionsTest\u003A\u003AtestInvalidUserAgentException\u0028\u0029", + "name": "testInvalidUserAgentException", + "summary": "", + "url": "classes/chillerlan-HTTPTest-HTTPOptionsTest.html#method_testInvalidUserAgentException" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\HTTPOptionsTest\u003A\u003AtestSetDnsOverHttpsURL\u0028\u0029", + "name": "testSetDnsOverHttpsURL", + "summary": "", + "url": "classes/chillerlan-HTTPTest-HTTPOptionsTest.html#method_testSetDnsOverHttpsURL" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\HTTPOptionsTest\u003A\u003AtestSetDnsOverHttpsURLException\u0028\u0029", + "name": "testSetDnsOverHttpsURLException", + "summary": "", + "url": "classes/chillerlan-HTTPTest-HTTPOptionsTest.html#method_testSetDnsOverHttpsURLException" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\StreamClientNoCATest", + "name": "StreamClientNoCATest", + "summary": "", + "url": "classes/chillerlan-HTTPTest-StreamClientNoCATest.html" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\StreamClientNoCATest\u003A\u003A\u0024HTTP_CLIENT_FACTORY", + "name": "HTTP_CLIENT_FACTORY", + "summary": "", + "url": "classes/chillerlan-HTTPTest-StreamClientNoCATest.html#property_HTTP_CLIENT_FACTORY" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\StreamClientTest", + "name": "StreamClientTest", + "summary": "", + "url": "classes/chillerlan-HTTPTest-StreamClientTest.html" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\StreamClientTest\u003A\u003A\u0024HTTP_CLIENT_FACTORY", + "name": "HTTP_CLIENT_FACTORY", + "summary": "", + "url": "classes/chillerlan-HTTPTest-StreamClientTest.html#property_HTTP_CLIENT_FACTORY" + }, { + "fqsen": "\\", + "name": "\\", + "summary": "", + "url": "namespaces/default.html" + }, { + "fqsen": "\\chillerlan\\HTTP", + "name": "HTTP", + "summary": "", + "url": "namespaces/chillerlan-http.html" + }, { + "fqsen": "\\chillerlan", + "name": "chillerlan", + "summary": "", + "url": "namespaces/chillerlan.html" + }, { + "fqsen": "\\chillerlan\\HTTPTest\\ClientFactories", + "name": "ClientFactories", + "summary": "", + "url": "namespaces/chillerlan-httptest-clientfactories.html" + }, { + "fqsen": "\\chillerlan\\HTTPTest", + "name": "HTTPTest", + "summary": "", + "url": "namespaces/chillerlan-httptest.html" + } ] +); diff --git a/js/template.js b/js/template.js new file mode 100644 index 00000000..49383291 --- /dev/null +++ b/js/template.js @@ -0,0 +1,17 @@ +(function(){ + window.addEventListener('load', () => { + const el = document.querySelector('.phpdocumentor-on-this-page__content') + if (!el) { + return; + } + + const observer = new IntersectionObserver( + ([e]) => { + e.target.classList.toggle("-stuck", e.intersectionRatio < 1); + }, + {threshold: [1]} + ); + + observer.observe(el); + }) +})(); diff --git a/namespaces/chillerlan-http.html b/namespaces/chillerlan-http.html new file mode 100644 index 00000000..e29588aa --- /dev/null +++ b/namespaces/chillerlan-http.html @@ -0,0 +1,285 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                                                                      +

                                                                                                      Documentation

                                                                                                      + + + + + +
                                                                                                      + +
                                                                                                      +
                                                                                                      + + + + +
                                                                                                      +
                                                                                                      + + +
                                                                                                      +

                                                                                                      HTTP

                                                                                                      + + +

                                                                                                      + Table of Contents + + +

                                                                                                      + + + +

                                                                                                      + Interfaces + + +

                                                                                                      +
                                                                                                      +
                                                                                                      HTTPClientInterface
                                                                                                      MultiResponseHandlerInterface
                                                                                                      The multi response handler. (Schrödinger's cat state handler)
                                                                                                      + +

                                                                                                      + Classes + + +

                                                                                                      +
                                                                                                      +
                                                                                                      ClientException
                                                                                                      CurlClient
                                                                                                      A "simple" cURL http client
                                                                                                      CurlHandle
                                                                                                      Implements a cURL connection object
                                                                                                      CurlMultiClient
                                                                                                      Curl multi http client
                                                                                                      HTTPClientAbstract
                                                                                                      HTTPOptions
                                                                                                      NetworkException
                                                                                                      RequestException
                                                                                                      StreamClient
                                                                                                      A http client via PHP streams
                                                                                                      + +

                                                                                                      + Traits + + +

                                                                                                      +
                                                                                                      +
                                                                                                      HTTPOptionsTrait
                                                                                                      + + + + + + + + + + +
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      
                                                                                                      +        
                                                                                                      + +
                                                                                                      +
                                                                                                      + + + +
                                                                                                      +
                                                                                                      +
                                                                                                      + +
                                                                                                      + On this page + + +
                                                                                                      + +
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      +

                                                                                                      Search results

                                                                                                      + +
                                                                                                      +
                                                                                                      +
                                                                                                        +
                                                                                                        +
                                                                                                        +
                                                                                                        +
                                                                                                        + + +
                                                                                                        + + + + + + + + diff --git a/namespaces/chillerlan-httptest-clientfactories.html b/namespaces/chillerlan-httptest-clientfactories.html new file mode 100644 index 00000000..1dd3ccb1 --- /dev/null +++ b/namespaces/chillerlan-httptest-clientfactories.html @@ -0,0 +1,270 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                                                                        +

                                                                                                        Documentation

                                                                                                        + + + + + +
                                                                                                        + +
                                                                                                        +
                                                                                                        + + + + +
                                                                                                        +
                                                                                                        + + +
                                                                                                        +

                                                                                                        ClientFactories

                                                                                                        + + +

                                                                                                        + Table of Contents + + +

                                                                                                        + + + + +

                                                                                                        + Classes + + +

                                                                                                        +
                                                                                                        +
                                                                                                        CurlClientFactory
                                                                                                        CurlClientNoCAFactory
                                                                                                        StreamClientFactory
                                                                                                        StreamClientNoCAFactory
                                                                                                        + + + + + + + + + + + +
                                                                                                        +
                                                                                                        +
                                                                                                        +
                                                                                                        +
                                                                                                        
                                                                                                        +        
                                                                                                        + +
                                                                                                        +
                                                                                                        + + + +
                                                                                                        +
                                                                                                        +
                                                                                                        + +
                                                                                                        + On this page + +
                                                                                                          +
                                                                                                        • Table Of Contents
                                                                                                        • +
                                                                                                        • + +
                                                                                                        • + + +
                                                                                                        +
                                                                                                        + +
                                                                                                        +
                                                                                                        +
                                                                                                        +
                                                                                                        +
                                                                                                        +

                                                                                                        Search results

                                                                                                        + +
                                                                                                        +
                                                                                                        +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          + + +
                                                                                                          + + + + + + + + diff --git a/namespaces/chillerlan-httptest.html b/namespaces/chillerlan-httptest.html new file mode 100644 index 00000000..57382965 --- /dev/null +++ b/namespaces/chillerlan-httptest.html @@ -0,0 +1,277 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                                                                          +

                                                                                                          Documentation

                                                                                                          + + + + + +
                                                                                                          + +
                                                                                                          +
                                                                                                          + + + + +
                                                                                                          +
                                                                                                          + + +
                                                                                                          +

                                                                                                          HTTPTest

                                                                                                          + + +

                                                                                                          + Table of Contents + + +

                                                                                                          + + +

                                                                                                          + Namespaces + + +

                                                                                                          +
                                                                                                          +
                                                                                                          ClientFactories
                                                                                                          +
                                                                                                          + + +

                                                                                                          + Classes + + +

                                                                                                          +
                                                                                                          +
                                                                                                          CurlClientNoCATest
                                                                                                          CurlClientTest
                                                                                                          CurlHandleTest
                                                                                                          CurlMultiClientTest
                                                                                                          HTTPClientTestAbstract
                                                                                                          HTTPOptionsTest
                                                                                                          StreamClientNoCATest
                                                                                                          StreamClientTest
                                                                                                          + + + + + + + + + + + +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          
                                                                                                          +        
                                                                                                          + +
                                                                                                          +
                                                                                                          + + + +
                                                                                                          +
                                                                                                          +
                                                                                                          + +
                                                                                                          + On this page + +
                                                                                                            +
                                                                                                          • Table Of Contents
                                                                                                          • +
                                                                                                          • + +
                                                                                                          • + + +
                                                                                                          +
                                                                                                          + +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          +

                                                                                                          Search results

                                                                                                          + +
                                                                                                          +
                                                                                                          +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            + + +
                                                                                                            + + + + + + + + diff --git a/namespaces/chillerlan.html b/namespaces/chillerlan.html new file mode 100644 index 00000000..c6173661 --- /dev/null +++ b/namespaces/chillerlan.html @@ -0,0 +1,269 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                                                                            +

                                                                                                            Documentation

                                                                                                            + + + + + +
                                                                                                            + +
                                                                                                            +
                                                                                                            + + + + +
                                                                                                            +
                                                                                                            +
                                                                                                              +
                                                                                                            + +
                                                                                                            +

                                                                                                            chillerlan

                                                                                                            + + +

                                                                                                            + Table of Contents + + +

                                                                                                            + + +

                                                                                                            + Namespaces + + +

                                                                                                            +
                                                                                                            +
                                                                                                            HTTP
                                                                                                            +
                                                                                                            HTTPTest
                                                                                                            +
                                                                                                            + + + + + + + + + + + + + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            
                                                                                                            +        
                                                                                                            + +
                                                                                                            +
                                                                                                            + + + +
                                                                                                            +
                                                                                                            +
                                                                                                            + +
                                                                                                            + On this page + +
                                                                                                              +
                                                                                                            • Table Of Contents
                                                                                                            • +
                                                                                                            • +
                                                                                                                +
                                                                                                              +
                                                                                                            • + + +
                                                                                                            +
                                                                                                            + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +

                                                                                                            Search results

                                                                                                            + +
                                                                                                            +
                                                                                                            +
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              + + +
                                                                                                              + + + + + + + + diff --git a/namespaces/default.html b/namespaces/default.html new file mode 100644 index 00000000..67ca2234 --- /dev/null +++ b/namespaces/default.html @@ -0,0 +1,268 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                                                                              +

                                                                                                              Documentation

                                                                                                              + + + + + +
                                                                                                              + +
                                                                                                              +
                                                                                                              + + + + +
                                                                                                              +
                                                                                                              +
                                                                                                                +
                                                                                                              + +
                                                                                                              +

                                                                                                              API Documentation

                                                                                                              + + +

                                                                                                              + Table of Contents + + +

                                                                                                              + + +

                                                                                                              + Namespaces + + +

                                                                                                              +
                                                                                                              +
                                                                                                              chillerlan
                                                                                                              +
                                                                                                              + + + + + + + + + + + + + +
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              
                                                                                                              +        
                                                                                                              + +
                                                                                                              +
                                                                                                              + + + +
                                                                                                              +
                                                                                                              +
                                                                                                              + +
                                                                                                              + On this page + +
                                                                                                                +
                                                                                                              • Table Of Contents
                                                                                                              • +
                                                                                                              • +
                                                                                                                  +
                                                                                                                +
                                                                                                              • + + +
                                                                                                              +
                                                                                                              + +
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              +

                                                                                                              Search results

                                                                                                              + +
                                                                                                              +
                                                                                                              +
                                                                                                                +
                                                                                                                +
                                                                                                                +
                                                                                                                +
                                                                                                                + + +
                                                                                                                + + + + + + + + diff --git a/packages/Application.html b/packages/Application.html new file mode 100644 index 00000000..3028aa4e --- /dev/null +++ b/packages/Application.html @@ -0,0 +1,284 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                +

                                                                                                                Documentation

                                                                                                                + + + + + +
                                                                                                                + +
                                                                                                                +
                                                                                                                + + + + +
                                                                                                                +
                                                                                                                +
                                                                                                                  +
                                                                                                                + +
                                                                                                                +

                                                                                                                Application

                                                                                                                + + +

                                                                                                                + Table of Contents + + +

                                                                                                                + + + +

                                                                                                                + Interfaces + + +

                                                                                                                +
                                                                                                                +
                                                                                                                HTTPClientInterface
                                                                                                                MultiResponseHandlerInterface
                                                                                                                The multi response handler. (Schrödinger's cat state handler)
                                                                                                                + +

                                                                                                                + Classes + + +

                                                                                                                +
                                                                                                                +
                                                                                                                ClientException
                                                                                                                CurlClient
                                                                                                                A "simple" cURL http client
                                                                                                                CurlHandle
                                                                                                                Implements a cURL connection object
                                                                                                                CurlMultiClient
                                                                                                                Curl multi http client
                                                                                                                HTTPClientAbstract
                                                                                                                HTTPOptions
                                                                                                                NetworkException
                                                                                                                RequestException
                                                                                                                StreamClient
                                                                                                                A http client via PHP streams
                                                                                                                CurlClientFactory
                                                                                                                CurlClientNoCAFactory
                                                                                                                StreamClientFactory
                                                                                                                StreamClientNoCAFactory
                                                                                                                CurlClientNoCATest
                                                                                                                CurlClientTest
                                                                                                                CurlHandleTest
                                                                                                                CurlMultiClientTest
                                                                                                                HTTPClientTestAbstract
                                                                                                                HTTPOptionsTest
                                                                                                                StreamClientNoCATest
                                                                                                                StreamClientTest
                                                                                                                + +

                                                                                                                + Traits + + +

                                                                                                                +
                                                                                                                +
                                                                                                                HTTPOptionsTrait
                                                                                                                + + + + + + + + + + +
                                                                                                                +
                                                                                                                +
                                                                                                                +
                                                                                                                +
                                                                                                                
                                                                                                                +        
                                                                                                                + +
                                                                                                                +
                                                                                                                + + + +
                                                                                                                +
                                                                                                                +
                                                                                                                + +
                                                                                                                + On this page + + +
                                                                                                                + +
                                                                                                                +
                                                                                                                +
                                                                                                                +
                                                                                                                +
                                                                                                                +

                                                                                                                Search results

                                                                                                                + +
                                                                                                                +
                                                                                                                +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  + + +
                                                                                                                  + + + + + + + + diff --git a/packages/default.html b/packages/default.html new file mode 100644 index 00000000..a9b99dec --- /dev/null +++ b/packages/default.html @@ -0,0 +1,268 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                  +

                                                                                                                  Documentation

                                                                                                                  + + + + + +
                                                                                                                  + +
                                                                                                                  +
                                                                                                                  + + + + +
                                                                                                                  +
                                                                                                                  +
                                                                                                                    +
                                                                                                                  + +
                                                                                                                  +

                                                                                                                  API Documentation

                                                                                                                  + + +

                                                                                                                  + Table of Contents + + +

                                                                                                                  + +

                                                                                                                  + Packages + + +

                                                                                                                  +
                                                                                                                  +
                                                                                                                  Application
                                                                                                                  +
                                                                                                                  + + + + + + + + + + + + + + +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  
                                                                                                                  +        
                                                                                                                  + +
                                                                                                                  +
                                                                                                                  + + + +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  + +
                                                                                                                  + On this page + +
                                                                                                                    +
                                                                                                                  • Table Of Contents
                                                                                                                  • +
                                                                                                                  • +
                                                                                                                      +
                                                                                                                    +
                                                                                                                  • + + +
                                                                                                                  +
                                                                                                                  + +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +

                                                                                                                  Search results

                                                                                                                  + +
                                                                                                                  +
                                                                                                                  +
                                                                                                                    +
                                                                                                                    +
                                                                                                                    +
                                                                                                                    +
                                                                                                                    + + +
                                                                                                                    + + + + + + + + diff --git a/phpcs.xml.dist b/phpcs.xml.dist deleted file mode 100644 index 5a5266fa..00000000 --- a/phpcs.xml.dist +++ /dev/null @@ -1,190 +0,0 @@ - - - php-httpinterface rules for phpcs - - examples - src - tests - - - - - - error - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - error - - - - error - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - examples - - - - examples - - - - examples - - - - examples - - - - examples - - - diff --git a/phpdoc.xml.dist b/phpdoc.xml.dist deleted file mode 100644 index 8910b1ef..00000000 --- a/phpdoc.xml.dist +++ /dev/null @@ -1,25 +0,0 @@ - - - - - docs - .build/phpdocs-cache - - - - - src - tests - - - php - - - - -