diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 8662ceb..98255af 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -8,7 +8,7 @@ jobs: strategy: matrix: operating-system: [ ubuntu-latest ] - php: [ '5.6', '7.0', '7.1', '7.2', '7.3', '7.4', '8.3' ] + php: [ '7.1', '7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3' ] steps: - uses: actions/checkout@v4 @@ -45,7 +45,7 @@ jobs: strategy: matrix: operating-system: [ ubuntu-latest ] - php: [ '5.6', '7.0', '7.1', '7.2', '7.3', '7.4' ] + php: [ '7.1', '7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3' ] steps: - name: Checkout diff --git a/.gitignore b/.gitignore index ea70af0..3ad818f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ .idea vendor/* .phpdoc +doc/ diff --git a/CHANGELOG.md b/CHANGELOG.md index 67c2a2a..a7aa8c0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). +## [Unreleased] +### Changed +- Removed all Cart v1 code and references (obsolete/legacy functionality removed). +- Made test tooling and CI compatible with PHP 7.1 through 8.3: + - Relaxed `phpunit/phpunit`, `phpunit/php-timer` and `php-mock/php-mock-phpunit` version constraints to allow Composer to resolve compatible test libraries per PHP runtime. + - Updated GitHub Actions matrix to run tests on PHP 7.1–8.3 and removed Docker-based CI job. + + ## [7.0.7] - 2025-01-21 ### Fixed - Fixed RequestException constructor to properly handle integer error codes diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..76fc41e --- /dev/null +++ b/Dockerfile @@ -0,0 +1,24 @@ +# Dockerfile for php-doofinder tests +ARG PHP_VERSION=7.4 +FROM php:${PHP_VERSION}-cli + +# Install system deps (Composer, extensions) +RUN apt-get update && apt-get install -y \ + git unzip libcurl4-openssl-dev pkg-config libxml2-dev \ + && docker-php-ext-install curl dom \ + && curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer \ + && apt-get clean && rm -rf /var/lib/apt/lists/* + +WORKDIR /app + +# Copy composer files first for better caching +COPY composer.json composer.lock ./ + +# Install dependencies +RUN composer install --no-scripts --dev --optimize-autoloader + +# Copy source code +COPY . . + +# Default command: run tests +CMD ["composer", "tests"] diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..9a3eb0a --- /dev/null +++ b/Makefile @@ -0,0 +1,60 @@ +# Makefile for php-doofinder testing with Docker +# Usage: make (e.g., make install, make test) + +# Variables +PHP_VERSION ?= 8.3 +IMAGE_BASE ?= php-doofinder +COMPOSER_IMAGE ?= composer:latest + +# Install Composer dependencies (dev mode) +install: + docker run --rm -v $(PWD):/app -w /app $(COMPOSER_IMAGE) install --no-scripts --dev + +# Update composer.lock using Composer update (defaults to PHP 8.3) +update-lock: + docker run --rm -v $(PWD):/app -w /app $(COMPOSER_IMAGE) update --prefer-dist --no-interaction --no-progress + +# Build custom Docker image (if using Dockerfile) +# Tags images as: php-doofinder- +build: + docker build --build-arg PHP_VERSION=$(PHP_VERSION) -t $(IMAGE_BASE)-$(PHP_VERSION) . + +# Run tests (builds image with dependencies) +test: build + docker run --rm $(IMAGE_BASE)-$(PHP_VERSION) + +# Run tests via Composer script +test-composer: + docker run --rm -v $(PWD):/app -w /app $(IMAGE_BASE)-$(PHP_VERSION) composer tests + +# Clean vendor/ (for branch switches) +clean: + rm -rf vendor/ + +# Full cycle: clean, install, test +ci: clean install test + +# Test all supported PHP versions (7.1, 7.4 and 8.3) +test-all: + @for version in 7.1 7.4 8.3; do \ + echo "Testing PHP $$version..."; \ + make test PHP_VERSION=$$version; \ + done + +# Specific convenience targets to run tests for 7.4 and 8.3 +# They build and run a local image named `php-doofinder-` +test-7.4: + @$(MAKE) test PHP_VERSION=7.4 + +test-8.3: + @$(MAKE) test PHP_VERSION=8.3 + +# Lint/check (if you add later; placeholder) +lint: + @echo "No linter defined; add php-cs-fixer or similar if needed" + +# Generate documentation +docs: + docker run --rm -v $(PWD):/app -w /app $(IMAGE_BASE)-$(PHP_VERSION) php phpDocumentor.phar -d src/ -t doc/ + +.PHONY: install build test test-composer clean ci lint docs test-7.4 test-8.3 test-5.6 test-all diff --git a/composer.json b/composer.json index 643d6ac..6e14cad 100644 --- a/composer.json +++ b/composer.json @@ -52,8 +52,9 @@ } }, "require-dev": { - "phpunit/phpunit": "5.*", - "php-mock/php-mock-phpunit": "1.1.*" + "phpunit/phpunit": ">=4.8 <11.0", + "phpunit/php-timer": ">=1.0 <3.0", + "php-mock/php-mock-phpunit": ">=1.0 <4.0" }, "scripts": { "remove-documentation": "rm -rf doc/*", diff --git a/composer.lock b/composer.lock index bc99ae1..b16d61e 100644 --- a/composer.lock +++ b/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "450fcd118d46cc8abd81f1de60aaaa70", + "content-hash": "c186a28006ae50b9836c96ef0d819039", "packages": [], "packages-dev": [ { @@ -137,40 +137,161 @@ ], "time": "2025-08-01T08:46:24+00:00" }, + { + "name": "phar-io/manifest", + "version": "2.0.4", + "source": { + "type": "git", + "url": "https://github.com/phar-io/manifest.git", + "reference": "54750ef60c58e43759730615a392c31c80e23176" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/phar-io/manifest/zipball/54750ef60c58e43759730615a392c31c80e23176", + "reference": "54750ef60c58e43759730615a392c31c80e23176", + "shasum": "" + }, + "require": { + "ext-dom": "*", + "ext-libxml": "*", + "ext-phar": "*", + "ext-xmlwriter": "*", + "phar-io/version": "^3.0.1", + "php": "^7.2 || ^8.0" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "2.0.x-dev" + } + }, + "autoload": { + "classmap": [ + "src/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Arne Blankerts", + "email": "arne@blankerts.de", + "role": "Developer" + }, + { + "name": "Sebastian Heuer", + "email": "sebastian@phpeople.de", + "role": "Developer" + }, + { + "name": "Sebastian Bergmann", + "email": "sebastian@phpunit.de", + "role": "Developer" + } + ], + "description": "Component for reading phar.io manifest information from a PHP Archive (PHAR)", + "support": { + "issues": "https://github.com/phar-io/manifest/issues", + "source": "https://github.com/phar-io/manifest/tree/2.0.4" + }, + "funding": [ + { + "url": "https://github.com/theseer", + "type": "github" + } + ], + "time": "2024-03-03T12:33:53+00:00" + }, + { + "name": "phar-io/version", + "version": "3.2.1", + "source": { + "type": "git", + "url": "https://github.com/phar-io/version.git", + "reference": "4f7fd7836c6f332bb2933569e566a0d6c4cbed74" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/phar-io/version/zipball/4f7fd7836c6f332bb2933569e566a0d6c4cbed74", + "reference": "4f7fd7836c6f332bb2933569e566a0d6c4cbed74", + "shasum": "" + }, + "require": { + "php": "^7.2 || ^8.0" + }, + "type": "library", + "autoload": { + "classmap": [ + "src/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Arne Blankerts", + "email": "arne@blankerts.de", + "role": "Developer" + }, + { + "name": "Sebastian Heuer", + "email": "sebastian@phpeople.de", + "role": "Developer" + }, + { + "name": "Sebastian Bergmann", + "email": "sebastian@phpunit.de", + "role": "Developer" + } + ], + "description": "Library for handling version information and constraints", + "support": { + "issues": "https://github.com/phar-io/version/issues", + "source": "https://github.com/phar-io/version/tree/3.2.1" + }, + "time": "2022-02-21T01:04:05+00:00" + }, { "name": "php-mock/php-mock", - "version": "1.0.1", + "version": "2.6.2", "source": { "type": "git", "url": "https://github.com/php-mock/php-mock.git", - "reference": "bfa2d17d64dbf129073a7ba2051a96ce52749570" + "reference": "e134d210e4707c29724ebc7fe50d220123f0fdd9" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/php-mock/php-mock/zipball/bfa2d17d64dbf129073a7ba2051a96ce52749570", - "reference": "bfa2d17d64dbf129073a7ba2051a96ce52749570", + "url": "https://api.github.com/repos/php-mock/php-mock/zipball/e134d210e4707c29724ebc7fe50d220123f0fdd9", + "reference": "e134d210e4707c29724ebc7fe50d220123f0fdd9", "shasum": "" }, "require": { - "php": ">=5.5", - "phpunit/php-text-template": "^1" + "php": "^5.6 || ^7.0 || ^8.0", + "phpunit/php-text-template": "^1 || ^2 || ^3 || ^4 || ^5" }, "replace": { "malkusch/php-mock": "*" }, "require-dev": { - "phpunit/phpunit": "^4|^5" + "phpunit/phpunit": "^5.7 || ^6.5 || ^7.5 || ^8.0 || ^9.0 || ^10.0 || ^11.0 || ^12.0", + "squizlabs/php_codesniffer": "^3.8" }, "suggest": { - "php-mock/php-mock-mockery": "Allows using PHPMockery for Mockery integration", "php-mock/php-mock-phpunit": "Allows integration into PHPUnit testcase with the trait PHPMock." }, "type": "library", "autoload": { + "files": [ + "autoload.php" + ], "psr-4": { "phpmock\\": [ "classes/", - "tests/unit/" + "tests/" ] } }, @@ -195,35 +316,42 @@ "mock", "stub", "test", - "test double" + "test double", + "testing" ], "support": { "issues": "https://github.com/php-mock/php-mock/issues", - "source": "https://github.com/php-mock/php-mock/tree/master" + "source": "https://github.com/php-mock/php-mock/tree/2.6.2" }, - "time": "2015-11-11T22:37:09+00:00" + "funding": [ + { + "url": "https://github.com/michalbundyra", + "type": "github" + } + ], + "time": "2025-08-18T19:59:14+00:00" }, { "name": "php-mock/php-mock-integration", - "version": "1.0.0", + "version": "3.0.0", "source": { "type": "git", "url": "https://github.com/php-mock/php-mock-integration.git", - "reference": "e83fb65dd20cd3cf250d554cbd4682b96b684f4b" + "reference": "8ceb860f343a143af604efeb66a7a124381cc52e" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/php-mock/php-mock-integration/zipball/e83fb65dd20cd3cf250d554cbd4682b96b684f4b", - "reference": "e83fb65dd20cd3cf250d554cbd4682b96b684f4b", + "url": "https://api.github.com/repos/php-mock/php-mock-integration/zipball/8ceb860f343a143af604efeb66a7a124381cc52e", + "reference": "8ceb860f343a143af604efeb66a7a124381cc52e", "shasum": "" }, "require": { - "php": ">=5.5", - "php-mock/php-mock": "^1", - "phpunit/php-text-template": "^1" + "php": ">=5.6", + "php-mock/php-mock": "^2.5", + "phpunit/php-text-template": "^1 || ^2 || ^3 || ^4 || ^5" }, "require-dev": { - "phpunit/phpunit": "^4|^5" + "phpunit/phpunit": "^5.7.27 || ^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12" }, "type": "library", "autoload": { @@ -256,34 +384,43 @@ ], "support": { "issues": "https://github.com/php-mock/php-mock-integration/issues", - "source": "https://github.com/php-mock/php-mock-integration/tree/master" + "source": "https://github.com/php-mock/php-mock-integration/tree/3.0.0" }, - "time": "2015-10-26T21:21:42+00:00" + "funding": [ + { + "url": "https://github.com/michalbundyra", + "type": "github" + } + ], + "time": "2025-03-08T19:22:38+00:00" }, { "name": "php-mock/php-mock-phpunit", - "version": "1.1.2", + "version": "2.13.1", "source": { "type": "git", "url": "https://github.com/php-mock/php-mock-phpunit.git", - "reference": "359e3038c016cee4c8f8db6387bcab3fcdebada0" + "reference": "29f90fe44a04105959d6ae835b10c9e0da2fcaa7" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/php-mock/php-mock-phpunit/zipball/359e3038c016cee4c8f8db6387bcab3fcdebada0", - "reference": "359e3038c016cee4c8f8db6387bcab3fcdebada0", + "url": "https://api.github.com/repos/php-mock/php-mock-phpunit/zipball/29f90fe44a04105959d6ae835b10c9e0da2fcaa7", + "reference": "29f90fe44a04105959d6ae835b10c9e0da2fcaa7", "shasum": "" }, "require": { - "php": ">=5.5", - "php-mock/php-mock-integration": "^1", - "phpunit/phpunit": "^4.0.0 || ^5.0.0" + "php": ">=7", + "php-mock/php-mock-integration": "^3.0", + "phpunit/phpunit": "^6 || ^7 || ^8 || ^9 || ^10.0.17 || ^11 || ^12.0.9" }, - "conflict": { - "phpunit/phpunit-mock-objects": "3.2.0" + "require-dev": { + "mockery/mockery": "^1.3.6" }, "type": "library", "autoload": { + "files": [ + "autoload.php" + ], "psr-4": { "phpmock\\phpunit\\": "classes/" } @@ -310,167 +447,57 @@ "phpunit", "stub", "test", - "test double" + "test double", + "testing" ], "support": { "issues": "https://github.com/php-mock/php-mock-phpunit/issues", - "source": "https://github.com/php-mock/php-mock-phpunit/tree/fix-phpunit-fuckup" - }, - "time": "2016-06-15T23:36:13+00:00" - }, - { - "name": "phpdocumentor/reflection-docblock", - "version": "2.0.5", - "source": { - "type": "git", - "url": "https://github.com/phpDocumentor/ReflectionDocBlock.git", - "reference": "e6a969a640b00d8daa3c66518b0405fb41ae0c4b" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/phpDocumentor/ReflectionDocBlock/zipball/e6a969a640b00d8daa3c66518b0405fb41ae0c4b", - "reference": "e6a969a640b00d8daa3c66518b0405fb41ae0c4b", - "shasum": "" - }, - "require": { - "php": ">=5.3.3" - }, - "require-dev": { - "phpunit/phpunit": "~4.0" - }, - "suggest": { - "dflydev/markdown": "~1.0", - "erusev/parsedown": "~1.0" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "2.0.x-dev" - } - }, - "autoload": { - "psr-0": { - "phpDocumentor": [ - "src/" - ] - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Mike van Riel", - "email": "mike.vanriel@naenius.com" - } - ], - "support": { - "issues": "https://github.com/phpDocumentor/ReflectionDocBlock/issues", - "source": "https://github.com/phpDocumentor/ReflectionDocBlock/tree/release/2.x" - }, - "time": "2016-01-25T08:17:30+00:00" - }, - { - "name": "phpspec/prophecy", - "version": "v1.5.0", - "source": { - "type": "git", - "url": "https://github.com/phpspec/prophecy.git", - "reference": "4745ded9307786b730d7a60df5cb5a6c43cf95f7" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/phpspec/prophecy/zipball/4745ded9307786b730d7a60df5cb5a6c43cf95f7", - "reference": "4745ded9307786b730d7a60df5cb5a6c43cf95f7", - "shasum": "" - }, - "require": { - "doctrine/instantiator": "^1.0.2", - "phpdocumentor/reflection-docblock": "~2.0", - "sebastian/comparator": "~1.1" - }, - "require-dev": { - "phpspec/phpspec": "~2.0" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "1.4.x-dev" - } - }, - "autoload": { - "psr-0": { - "Prophecy\\": "src/" - } + "source": "https://github.com/php-mock/php-mock-phpunit/tree/2.13.1" }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Konstantin Kudryashov", - "email": "ever.zet@gmail.com", - "homepage": "http://everzet.com" - }, + "funding": [ { - "name": "Marcello Duarte", - "email": "marcello.duarte@gmail.com" + "url": "https://github.com/michalbundyra", + "type": "github" } ], - "description": "Highly opinionated mocking framework for PHP 5.3+", - "homepage": "https://github.com/phpspec/prophecy", - "keywords": [ - "Double", - "Dummy", - "fake", - "mock", - "spy", - "stub" - ], - "support": { - "issues": "https://github.com/phpspec/prophecy/issues", - "source": "https://github.com/phpspec/prophecy/tree/master" - }, - "time": "2015-08-13T10:07:40+00:00" + "time": "2025-09-23T06:00:08+00:00" }, { "name": "phpunit/php-code-coverage", - "version": "3.2.0", + "version": "7.0.17", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-code-coverage.git", - "reference": "85f5db2d0a0da79ad6a256eb54148ba383059ad9" + "reference": "40a4ed114a4aea5afd6df8d0f0c9cd3033097f66" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/85f5db2d0a0da79ad6a256eb54148ba383059ad9", - "reference": "85f5db2d0a0da79ad6a256eb54148ba383059ad9", + "url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/40a4ed114a4aea5afd6df8d0f0c9cd3033097f66", + "reference": "40a4ed114a4aea5afd6df8d0f0c9cd3033097f66", "shasum": "" }, "require": { - "php": ">=5.6", - "phpunit/php-file-iterator": "~1.3", - "phpunit/php-text-template": "~1.2", - "phpunit/php-token-stream": "~1.3", - "sebastian/code-unit-reverse-lookup": "~1.0", - "sebastian/environment": "^1.3.2", - "sebastian/version": "~1.0|~2.0" + "ext-dom": "*", + "ext-xmlwriter": "*", + "php": ">=7.2", + "phpunit/php-file-iterator": "^2.0.2", + "phpunit/php-text-template": "^1.2.1", + "phpunit/php-token-stream": "^3.1.3 || ^4.0", + "sebastian/code-unit-reverse-lookup": "^1.0.1", + "sebastian/environment": "^4.2.2", + "sebastian/version": "^2.0.1", + "theseer/tokenizer": "^1.1.3" }, "require-dev": { - "ext-xdebug": ">=2.1.4", - "phpunit/phpunit": "~5" + "phpunit/phpunit": "^8.2.2" }, "suggest": { - "ext-dom": "*", - "ext-xdebug": ">=2.2.1", - "ext-xmlwriter": "*" + "ext-xdebug": "^2.7.2" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "3.2.x-dev" + "dev-master": "7.0-dev" } }, "autoload": { @@ -485,7 +512,7 @@ "authors": [ { "name": "Sebastian Bergmann", - "email": "sb@sebastian-bergmann.de", + "email": "sebastian@phpunit.de", "role": "lead" } ], @@ -497,33 +524,41 @@ "xunit" ], "support": { - "irc": "irc://irc.freenode.net/phpunit", "issues": "https://github.com/sebastianbergmann/php-code-coverage/issues", - "source": "https://github.com/sebastianbergmann/php-code-coverage/tree/3.2.0" + "source": "https://github.com/sebastianbergmann/php-code-coverage/tree/7.0.17" }, - "time": "2016-02-13T06:47:56+00:00" + "funding": [ + { + "url": "https://github.com/sebastianbergmann", + "type": "github" + } + ], + "time": "2024-03-02T06:09:37+00:00" }, { "name": "phpunit/php-file-iterator", - "version": "1.4.5", + "version": "2.0.6", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-file-iterator.git", - "reference": "730b01bc3e867237eaac355e06a36b85dd93a8b4" + "reference": "69deeb8664f611f156a924154985fbd4911eb36b" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-file-iterator/zipball/730b01bc3e867237eaac355e06a36b85dd93a8b4", - "reference": "730b01bc3e867237eaac355e06a36b85dd93a8b4", + "url": "https://api.github.com/repos/sebastianbergmann/php-file-iterator/zipball/69deeb8664f611f156a924154985fbd4911eb36b", + "reference": "69deeb8664f611f156a924154985fbd4911eb36b", "shasum": "" }, "require": { - "php": ">=5.3.3" + "php": ">=7.1" + }, + "require-dev": { + "phpunit/phpunit": "^8.5" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "1.4.x-dev" + "dev-master": "2.0.x-dev" } }, "autoload": { @@ -538,7 +573,7 @@ "authors": [ { "name": "Sebastian Bergmann", - "email": "sb@sebastian-bergmann.de", + "email": "sebastian@phpunit.de", "role": "lead" } ], @@ -549,11 +584,16 @@ "iterator" ], "support": { - "irc": "irc://irc.freenode.net/phpunit", "issues": "https://github.com/sebastianbergmann/php-file-iterator/issues", - "source": "https://github.com/sebastianbergmann/php-file-iterator/tree/1.4.5" + "source": "https://github.com/sebastianbergmann/php-file-iterator/tree/2.0.6" }, - "time": "2017-11-27T13:52:08+00:00" + "funding": [ + { + "url": "https://github.com/sebastianbergmann", + "type": "github" + } + ], + "time": "2024-03-01T13:39:50+00:00" }, { "name": "phpunit/php-text-template", @@ -602,28 +642,28 @@ }, { "name": "phpunit/php-timer", - "version": "8.0.0", + "version": "2.1.4", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-timer.git", - "reference": "f258ce36aa457f3aa3339f9ed4c81fc66dc8c2cc" + "reference": "a691211e94ff39a34811abd521c31bd5b305b0bb" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-timer/zipball/f258ce36aa457f3aa3339f9ed4c81fc66dc8c2cc", - "reference": "f258ce36aa457f3aa3339f9ed4c81fc66dc8c2cc", + "url": "https://api.github.com/repos/sebastianbergmann/php-timer/zipball/a691211e94ff39a34811abd521c31bd5b305b0bb", + "reference": "a691211e94ff39a34811abd521c31bd5b305b0bb", "shasum": "" }, "require": { - "php": ">=8.3" + "php": ">=7.1" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^8.5" }, "type": "library", "extra": { "branch-alias": { - "dev-main": "8.0-dev" + "dev-master": "2.1-dev" } }, "autoload": { @@ -649,8 +689,7 @@ ], "support": { "issues": "https://github.com/sebastianbergmann/php-timer/issues", - "security": "https://github.com/sebastianbergmann/php-timer/security/policy", - "source": "https://github.com/sebastianbergmann/php-timer/tree/8.0.0" + "source": "https://github.com/sebastianbergmann/php-timer/tree/2.1.4" }, "funding": [ { @@ -658,33 +697,33 @@ "type": "github" } ], - "time": "2025-02-07T04:59:38+00:00" + "time": "2024-03-01T13:42:41+00:00" }, { "name": "phpunit/php-token-stream", - "version": "1.4.12", + "version": "4.0.4", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-token-stream.git", - "reference": "1ce90ba27c42e4e44e6d8458241466380b51fa16" + "reference": "a853a0e183b9db7eed023d7933a858fa1c8d25a3" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-token-stream/zipball/1ce90ba27c42e4e44e6d8458241466380b51fa16", - "reference": "1ce90ba27c42e4e44e6d8458241466380b51fa16", + "url": "https://api.github.com/repos/sebastianbergmann/php-token-stream/zipball/a853a0e183b9db7eed023d7933a858fa1c8d25a3", + "reference": "a853a0e183b9db7eed023d7933a858fa1c8d25a3", "shasum": "" }, "require": { "ext-tokenizer": "*", - "php": ">=5.3.3" + "php": "^7.3 || ^8.0" }, "require-dev": { - "phpunit/phpunit": "~4.2" + "phpunit/phpunit": "^9.0" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "1.4-dev" + "dev-master": "4.0-dev" } }, "autoload": { @@ -709,50 +748,61 @@ ], "support": { "issues": "https://github.com/sebastianbergmann/php-token-stream/issues", - "source": "https://github.com/sebastianbergmann/php-token-stream/tree/1.4" + "source": "https://github.com/sebastianbergmann/php-token-stream/tree/master" }, + "funding": [ + { + "url": "https://github.com/sebastianbergmann", + "type": "github" + } + ], "abandoned": true, - "time": "2017-12-04T08:55:13+00:00" + "time": "2020-08-04T08:28:15+00:00" }, { "name": "phpunit/phpunit", - "version": "5.2.7", + "version": "8.5.48", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/phpunit.git", - "reference": "073701643835376cb2f15dc005ea8933f8d4edbd" + "reference": "75f469c1948b91aa566206f88412c88f08090b32" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/073701643835376cb2f15dc005ea8933f8d4edbd", - "reference": "073701643835376cb2f15dc005ea8933f8d4edbd", + "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/75f469c1948b91aa566206f88412c88f08090b32", + "reference": "75f469c1948b91aa566206f88412c88f08090b32", "shasum": "" }, "require": { + "doctrine/instantiator": "^1.5.0", "ext-dom": "*", "ext-json": "*", - "ext-pcre": "*", - "ext-reflection": "*", - "ext-spl": "*", - "myclabs/deep-copy": "~1.3", - "php": ">=5.6", - "phpspec/prophecy": "^1.3.1", - "phpunit/php-code-coverage": "~3.2", - "phpunit/php-file-iterator": "~1.4", - "phpunit/php-text-template": "~1.2", - "phpunit/php-timer": ">=1.0.6", - "phpunit/phpunit-mock-objects": ">=3.0.5", - "sebastian/comparator": "~1.1", - "sebastian/diff": "~1.2", - "sebastian/environment": "~1.3", - "sebastian/exporter": "~1.2", - "sebastian/global-state": "~1.0", - "sebastian/resource-operations": "~1.0", - "sebastian/version": "~1.0|~2.0", - "symfony/yaml": "~2.1|~3.0" + "ext-libxml": "*", + "ext-mbstring": "*", + "ext-xml": "*", + "ext-xmlwriter": "*", + "myclabs/deep-copy": "^1.13.4", + "phar-io/manifest": "^2.0.4", + "phar-io/version": "^3.2.1", + "php": ">=7.2", + "phpunit/php-code-coverage": "^7.0.17", + "phpunit/php-file-iterator": "^2.0.6", + "phpunit/php-text-template": "^1.2.1", + "phpunit/php-timer": "^2.1.4", + "sebastian/comparator": "^3.0.6", + "sebastian/diff": "^3.0.6", + "sebastian/environment": "^4.2.5", + "sebastian/exporter": "^3.1.8", + "sebastian/global-state": "^3.0.6", + "sebastian/object-enumerator": "^3.0.5", + "sebastian/resource-operations": "^2.0.3", + "sebastian/type": "^1.1.5", + "sebastian/version": "^2.0.1" }, "suggest": { - "phpunit/php-invoker": "~1.1" + "ext-soap": "To be able to generate mocks based on WSDL files", + "ext-xdebug": "PHP extension that provides line coverage as well as branch and path coverage", + "phpunit/php-invoker": "To allow enforcing time limits" }, "bin": [ "phpunit" @@ -760,7 +810,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-master": "5.2.x-dev" + "dev-master": "8.5-dev" } }, "autoload": { @@ -787,42 +837,58 @@ "xunit" ], "support": { - "irc": "irc://irc.freenode.net/phpunit", "issues": "https://github.com/sebastianbergmann/phpunit/issues", - "source": "https://github.com/sebastianbergmann/phpunit/tree/5.2.7" + "security": "https://github.com/sebastianbergmann/phpunit/security/policy", + "source": "https://github.com/sebastianbergmann/phpunit/tree/8.5.48" }, - "time": "2016-02-18T06:39:51+00:00" + "funding": [ + { + "url": "https://phpunit.de/sponsors.html", + "type": "custom" + }, + { + "url": "https://github.com/sebastianbergmann", + "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/phpunit/phpunit", + "type": "tidelift" + } + ], + "time": "2025-09-24T06:27:39+00:00" }, { - "name": "phpunit/phpunit-mock-objects", - "version": "3.1.3", + "name": "sebastian/code-unit-reverse-lookup", + "version": "1.0.3", "source": { "type": "git", - "url": "https://github.com/sebastianbergmann/phpunit-mock-objects.git", - "reference": "151c96874bff6fe61a25039df60e776613a61489" + "url": "https://github.com/sebastianbergmann/code-unit-reverse-lookup.git", + "reference": "92a1a52e86d34cde6caa54f1b5ffa9fda18e5d54" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/phpunit-mock-objects/zipball/151c96874bff6fe61a25039df60e776613a61489", - "reference": "151c96874bff6fe61a25039df60e776613a61489", + "url": "https://api.github.com/repos/sebastianbergmann/code-unit-reverse-lookup/zipball/92a1a52e86d34cde6caa54f1b5ffa9fda18e5d54", + "reference": "92a1a52e86d34cde6caa54f1b5ffa9fda18e5d54", "shasum": "" }, "require": { - "doctrine/instantiator": "^1.0.2", - "php": ">=5.6", - "phpunit/php-text-template": "~1.2", - "sebastian/exporter": "~1.2" + "php": ">=5.6" }, "require-dev": { - "phpunit/phpunit": "~5" - }, - "suggest": { - "ext-soap": "*" + "phpunit/phpunit": "^8.5" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "3.1.x-dev" + "dev-master": "1.0.x-dev" } }, "autoload": { @@ -837,40 +903,41 @@ "authors": [ { "name": "Sebastian Bergmann", - "email": "sb@sebastian-bergmann.de", - "role": "lead" + "email": "sebastian@phpunit.de" } ], - "description": "Mock Object library for PHPUnit", - "homepage": "https://github.com/sebastianbergmann/phpunit-mock-objects/", - "keywords": [ - "mock", - "xunit" - ], + "description": "Looks up which function or method a line of code belongs to", + "homepage": "https://github.com/sebastianbergmann/code-unit-reverse-lookup/", "support": { - "irc": "irc://irc.freenode.net/phpunit", - "issues": "https://github.com/sebastianbergmann/phpunit-mock-objects/issues", - "source": "https://github.com/sebastianbergmann/phpunit-mock-objects/tree/3.1" + "issues": "https://github.com/sebastianbergmann/code-unit-reverse-lookup/issues", + "source": "https://github.com/sebastianbergmann/code-unit-reverse-lookup/tree/1.0.3" }, - "abandoned": true, - "time": "2016-04-20T14:39:26+00:00" + "funding": [ + { + "url": "https://github.com/sebastianbergmann", + "type": "github" + } + ], + "time": "2024-03-01T13:45:45+00:00" }, { - "name": "sebastian/code-unit-reverse-lookup", - "version": "1.0.3", + "name": "sebastian/comparator", + "version": "3.0.6", "source": { "type": "git", - "url": "https://github.com/sebastianbergmann/code-unit-reverse-lookup.git", - "reference": "92a1a52e86d34cde6caa54f1b5ffa9fda18e5d54" + "url": "https://github.com/sebastianbergmann/comparator.git", + "reference": "4b3c947888c81708b20fb081bb653a2ba68f989a" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/code-unit-reverse-lookup/zipball/92a1a52e86d34cde6caa54f1b5ffa9fda18e5d54", - "reference": "92a1a52e86d34cde6caa54f1b5ffa9fda18e5d54", + "url": "https://api.github.com/repos/sebastianbergmann/comparator/zipball/4b3c947888c81708b20fb081bb653a2ba68f989a", + "reference": "4b3c947888c81708b20fb081bb653a2ba68f989a", "shasum": "" }, "require": { - "php": ">=5.6" + "php": ">=7.1", + "sebastian/diff": "^3.0", + "sebastian/exporter": "^3.1" }, "require-dev": { "phpunit/phpunit": "^8.5" @@ -878,7 +945,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-master": "1.0.x-dev" + "dev-master": "3.0-dev" } }, "autoload": { @@ -894,60 +961,7 @@ { "name": "Sebastian Bergmann", "email": "sebastian@phpunit.de" - } - ], - "description": "Looks up which function or method a line of code belongs to", - "homepage": "https://github.com/sebastianbergmann/code-unit-reverse-lookup/", - "support": { - "issues": "https://github.com/sebastianbergmann/code-unit-reverse-lookup/issues", - "source": "https://github.com/sebastianbergmann/code-unit-reverse-lookup/tree/1.0.3" - }, - "funding": [ - { - "url": "https://github.com/sebastianbergmann", - "type": "github" - } - ], - "time": "2024-03-01T13:45:45+00:00" - }, - { - "name": "sebastian/comparator", - "version": "1.2.4", - "source": { - "type": "git", - "url": "https://github.com/sebastianbergmann/comparator.git", - "reference": "2b7424b55f5047b47ac6e5ccb20b2aea4011d9be" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/comparator/zipball/2b7424b55f5047b47ac6e5ccb20b2aea4011d9be", - "reference": "2b7424b55f5047b47ac6e5ccb20b2aea4011d9be", - "shasum": "" - }, - "require": { - "php": ">=5.3.3", - "sebastian/diff": "~1.2", - "sebastian/exporter": "~1.2 || ~2.0" - }, - "require-dev": { - "phpunit/phpunit": "~4.4" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "1.2.x-dev" - } - }, - "autoload": { - "classmap": [ - "src/" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "BSD-3-Clause" - ], - "authors": [ + }, { "name": "Jeff Welch", "email": "whatthejeff@gmail.com" @@ -959,14 +973,10 @@ { "name": "Bernhard Schussek", "email": "bschussek@2bepublished.at" - }, - { - "name": "Sebastian Bergmann", - "email": "sebastian@phpunit.de" } ], "description": "Provides the functionality to compare PHP values for equality", - "homepage": "http://www.github.com/sebastianbergmann/comparator", + "homepage": "https://github.com/sebastianbergmann/comparator", "keywords": [ "comparator", "compare", @@ -974,34 +984,53 @@ ], "support": { "issues": "https://github.com/sebastianbergmann/comparator/issues", - "source": "https://github.com/sebastianbergmann/comparator/tree/1.2" + "source": "https://github.com/sebastianbergmann/comparator/tree/3.0.6" }, - "time": "2017-01-29T09:50:25+00:00" + "funding": [ + { + "url": "https://github.com/sebastianbergmann", + "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/sebastian/comparator", + "type": "tidelift" + } + ], + "time": "2025-08-10T05:29:24+00:00" }, { "name": "sebastian/diff", - "version": "1.4.1", + "version": "3.0.6", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/diff.git", - "reference": "13edfd8706462032c2f52b4b862974dd46b71c9e" + "reference": "98ff311ca519c3aa73ccd3de053bdb377171d7b6" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/diff/zipball/13edfd8706462032c2f52b4b862974dd46b71c9e", - "reference": "13edfd8706462032c2f52b4b862974dd46b71c9e", + "url": "https://api.github.com/repos/sebastianbergmann/diff/zipball/98ff311ca519c3aa73ccd3de053bdb377171d7b6", + "reference": "98ff311ca519c3aa73ccd3de053bdb377171d7b6", "shasum": "" }, "require": { - "php": ">=5.3.3" + "php": ">=7.1" }, "require-dev": { - "phpunit/phpunit": "~4.8" + "phpunit/phpunit": "^7.5 || ^8.0", + "symfony/process": "^2 || ^3.3 || ^4" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "1.4-dev" + "dev-master": "3.0-dev" } }, "autoload": { @@ -1014,50 +1043,62 @@ "BSD-3-Clause" ], "authors": [ - { - "name": "Kore Nordmann", - "email": "mail@kore-nordmann.de" - }, { "name": "Sebastian Bergmann", "email": "sebastian@phpunit.de" + }, + { + "name": "Kore Nordmann", + "email": "mail@kore-nordmann.de" } ], "description": "Diff implementation", "homepage": "https://github.com/sebastianbergmann/diff", "keywords": [ - "diff" + "diff", + "udiff", + "unidiff", + "unified diff" ], "support": { "issues": "https://github.com/sebastianbergmann/diff/issues", - "source": "https://github.com/sebastianbergmann/diff/tree/master" + "source": "https://github.com/sebastianbergmann/diff/tree/3.0.6" }, - "time": "2015-12-08T07:14:41+00:00" + "funding": [ + { + "url": "https://github.com/sebastianbergmann", + "type": "github" + } + ], + "time": "2024-03-02T06:16:36+00:00" }, { "name": "sebastian/environment", - "version": "1.3.7", + "version": "4.2.5", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/environment.git", - "reference": "4e8f0da10ac5802913afc151413bc8c53b6c2716" + "reference": "56932f6049a0482853056ffd617c91ffcc754205" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/environment/zipball/4e8f0da10ac5802913afc151413bc8c53b6c2716", - "reference": "4e8f0da10ac5802913afc151413bc8c53b6c2716", + "url": "https://api.github.com/repos/sebastianbergmann/environment/zipball/56932f6049a0482853056ffd617c91ffcc754205", + "reference": "56932f6049a0482853056ffd617c91ffcc754205", "shasum": "" }, "require": { - "php": ">=5.3.3" + "php": ">=7.1" }, "require-dev": { - "phpunit/phpunit": "~4.4" + "phpunit/phpunit": "^7.5" + }, + "suggest": { + "ext-posix": "*" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "1.3.x-dev" + "dev-master": "4.2-dev" } }, "autoload": { @@ -1084,36 +1125,42 @@ ], "support": { "issues": "https://github.com/sebastianbergmann/environment/issues", - "source": "https://github.com/sebastianbergmann/environment/tree/1.3.7" + "source": "https://github.com/sebastianbergmann/environment/tree/4.2.5" }, - "time": "2016-05-17T03:18:57+00:00" + "funding": [ + { + "url": "https://github.com/sebastianbergmann", + "type": "github" + } + ], + "time": "2024-03-01T13:49:59+00:00" }, { "name": "sebastian/exporter", - "version": "1.2.2", + "version": "3.1.8", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/exporter.git", - "reference": "42c4c2eec485ee3e159ec9884f95b431287edde4" + "reference": "64cfeaa341951ceb2019d7b98232399d57bb2296" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/exporter/zipball/42c4c2eec485ee3e159ec9884f95b431287edde4", - "reference": "42c4c2eec485ee3e159ec9884f95b431287edde4", + "url": "https://api.github.com/repos/sebastianbergmann/exporter/zipball/64cfeaa341951ceb2019d7b98232399d57bb2296", + "reference": "64cfeaa341951ceb2019d7b98232399d57bb2296", "shasum": "" }, "require": { - "php": ">=5.3.3", - "sebastian/recursion-context": "~1.0" + "php": ">=7.2", + "sebastian/recursion-context": "^3.0" }, "require-dev": { "ext-mbstring": "*", - "phpunit/phpunit": "~4.4" + "phpunit/phpunit": "^8.5" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "1.3.x-dev" + "dev-master": "3.1.x-dev" } }, "autoload": { @@ -1126,6 +1173,10 @@ "BSD-3-Clause" ], "authors": [ + { + "name": "Sebastian Bergmann", + "email": "sebastian@phpunit.de" + }, { "name": "Jeff Welch", "email": "whatthejeff@gmail.com" @@ -1134,17 +1185,13 @@ "name": "Volker Dusch", "email": "github@wallbash.com" }, - { - "name": "Bernhard Schussek", - "email": "bschussek@2bepublished.at" - }, - { - "name": "Sebastian Bergmann", - "email": "sebastian@phpunit.de" - }, { "name": "Adam Harvey", "email": "aharvey@php.net" + }, + { + "name": "Bernhard Schussek", + "email": "bschussek@gmail.com" } ], "description": "Provides the functionality to export PHP variables for visualization", @@ -1155,29 +1202,50 @@ ], "support": { "issues": "https://github.com/sebastianbergmann/exporter/issues", - "source": "https://github.com/sebastianbergmann/exporter/tree/master" + "source": "https://github.com/sebastianbergmann/exporter/tree/3.1.8" }, - "time": "2016-06-17T09:04:28+00:00" + "funding": [ + { + "url": "https://github.com/sebastianbergmann", + "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/sebastian/exporter", + "type": "tidelift" + } + ], + "time": "2025-09-24T05:55:14+00:00" }, { "name": "sebastian/global-state", - "version": "1.1.1", + "version": "3.0.6", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/global-state.git", - "reference": "bc37d50fea7d017d3d340f230811c9f1d7280af4" + "reference": "800689427e3e8cf57a8fe38fcd1d4344c9b2f046" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/global-state/zipball/bc37d50fea7d017d3d340f230811c9f1d7280af4", - "reference": "bc37d50fea7d017d3d340f230811c9f1d7280af4", + "url": "https://api.github.com/repos/sebastianbergmann/global-state/zipball/800689427e3e8cf57a8fe38fcd1d4344c9b2f046", + "reference": "800689427e3e8cf57a8fe38fcd1d4344c9b2f046", "shasum": "" }, "require": { - "php": ">=5.3.3" + "php": ">=7.2", + "sebastian/object-reflector": "^1.1.1", + "sebastian/recursion-context": "^3.0" }, "require-dev": { - "phpunit/phpunit": "~4.2" + "ext-dom": "*", + "phpunit/phpunit": "^8.0" }, "suggest": { "ext-uopz": "*" @@ -1185,7 +1253,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-master": "1.0-dev" + "dev-master": "3.0-dev" } }, "autoload": { @@ -1210,34 +1278,164 @@ ], "support": { "issues": "https://github.com/sebastianbergmann/global-state/issues", - "source": "https://github.com/sebastianbergmann/global-state/tree/1.1.1" + "source": "https://github.com/sebastianbergmann/global-state/tree/3.0.6" }, - "time": "2015-10-12T03:26:01+00:00" + "funding": [ + { + "url": "https://github.com/sebastianbergmann", + "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/sebastian/global-state", + "type": "tidelift" + } + ], + "time": "2025-08-10T05:40:12+00:00" + }, + { + "name": "sebastian/object-enumerator", + "version": "3.0.5", + "source": { + "type": "git", + "url": "https://github.com/sebastianbergmann/object-enumerator.git", + "reference": "ac5b293dba925751b808e02923399fb44ff0d541" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/sebastianbergmann/object-enumerator/zipball/ac5b293dba925751b808e02923399fb44ff0d541", + "reference": "ac5b293dba925751b808e02923399fb44ff0d541", + "shasum": "" + }, + "require": { + "php": ">=7.0", + "sebastian/object-reflector": "^1.1.1", + "sebastian/recursion-context": "^3.0" + }, + "require-dev": { + "phpunit/phpunit": "^6.0" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "3.0.x-dev" + } + }, + "autoload": { + "classmap": [ + "src/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Sebastian Bergmann", + "email": "sebastian@phpunit.de" + } + ], + "description": "Traverses array structures and object graphs to enumerate all referenced objects", + "homepage": "https://github.com/sebastianbergmann/object-enumerator/", + "support": { + "issues": "https://github.com/sebastianbergmann/object-enumerator/issues", + "source": "https://github.com/sebastianbergmann/object-enumerator/tree/3.0.5" + }, + "funding": [ + { + "url": "https://github.com/sebastianbergmann", + "type": "github" + } + ], + "time": "2024-03-01T13:54:02+00:00" + }, + { + "name": "sebastian/object-reflector", + "version": "1.1.3", + "source": { + "type": "git", + "url": "https://github.com/sebastianbergmann/object-reflector.git", + "reference": "1d439c229e61f244ff1f211e5c99737f90c67def" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/sebastianbergmann/object-reflector/zipball/1d439c229e61f244ff1f211e5c99737f90c67def", + "reference": "1d439c229e61f244ff1f211e5c99737f90c67def", + "shasum": "" + }, + "require": { + "php": ">=7.0" + }, + "require-dev": { + "phpunit/phpunit": "^6.0" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "1.1-dev" + } + }, + "autoload": { + "classmap": [ + "src/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Sebastian Bergmann", + "email": "sebastian@phpunit.de" + } + ], + "description": "Allows reflection of object attributes, including inherited and non-public ones", + "homepage": "https://github.com/sebastianbergmann/object-reflector/", + "support": { + "issues": "https://github.com/sebastianbergmann/object-reflector/issues", + "source": "https://github.com/sebastianbergmann/object-reflector/tree/1.1.3" + }, + "funding": [ + { + "url": "https://github.com/sebastianbergmann", + "type": "github" + } + ], + "time": "2024-03-01T13:56:04+00:00" }, { "name": "sebastian/recursion-context", - "version": "1.0.5", + "version": "3.0.3", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/recursion-context.git", - "reference": "b19cc3298482a335a95f3016d2f8a6950f0fbcd7" + "reference": "8fe7e75986a9d24b4cceae847314035df7703a5a" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/recursion-context/zipball/b19cc3298482a335a95f3016d2f8a6950f0fbcd7", - "reference": "b19cc3298482a335a95f3016d2f8a6950f0fbcd7", + "url": "https://api.github.com/repos/sebastianbergmann/recursion-context/zipball/8fe7e75986a9d24b4cceae847314035df7703a5a", + "reference": "8fe7e75986a9d24b4cceae847314035df7703a5a", "shasum": "" }, "require": { - "php": ">=5.3.3" + "php": ">=7.0" }, "require-dev": { - "phpunit/phpunit": "~4.4" + "phpunit/phpunit": "^6.0" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "1.0.x-dev" + "dev-master": "3.0.x-dev" } }, "autoload": { @@ -1250,14 +1448,14 @@ "BSD-3-Clause" ], "authors": [ - { - "name": "Jeff Welch", - "email": "whatthejeff@gmail.com" - }, { "name": "Sebastian Bergmann", "email": "sebastian@phpunit.de" }, + { + "name": "Jeff Welch", + "email": "whatthejeff@gmail.com" + }, { "name": "Adam Harvey", "email": "aharvey@php.net" @@ -1267,31 +1465,49 @@ "homepage": "http://www.github.com/sebastianbergmann/recursion-context", "support": { "issues": "https://github.com/sebastianbergmann/recursion-context/issues", - "source": "https://github.com/sebastianbergmann/recursion-context/tree/master" + "source": "https://github.com/sebastianbergmann/recursion-context/tree/3.0.3" }, - "time": "2016-10-03T07:41:43+00:00" + "funding": [ + { + "url": "https://github.com/sebastianbergmann", + "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/sebastian/recursion-context", + "type": "tidelift" + } + ], + "time": "2025-08-10T05:25:53+00:00" }, { "name": "sebastian/resource-operations", - "version": "1.0.0", + "version": "2.0.3", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/resource-operations.git", - "reference": "ce990bb21759f94aeafd30209e8cfcdfa8bc3f52" + "reference": "72a7f7674d053d548003b16ff5a106e7e0e06eee" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/resource-operations/zipball/ce990bb21759f94aeafd30209e8cfcdfa8bc3f52", - "reference": "ce990bb21759f94aeafd30209e8cfcdfa8bc3f52", + "url": "https://api.github.com/repos/sebastianbergmann/resource-operations/zipball/72a7f7674d053d548003b16ff5a106e7e0e06eee", + "reference": "72a7f7674d053d548003b16ff5a106e7e0e06eee", "shasum": "" }, "require": { - "php": ">=5.6.0" + "php": ">=7.1" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "1.0.x-dev" + "dev-master": "2.0-dev" } }, "autoload": { @@ -1312,32 +1528,40 @@ "description": "Provides a list of PHP built-in functions that operate on resources", "homepage": "https://www.github.com/sebastianbergmann/resource-operations", "support": { - "issues": "https://github.com/sebastianbergmann/resource-operations/issues", - "source": "https://github.com/sebastianbergmann/resource-operations/tree/master" + "source": "https://github.com/sebastianbergmann/resource-operations/tree/2.0.3" }, - "time": "2015-07-28T20:34:47+00:00" + "funding": [ + { + "url": "https://github.com/sebastianbergmann", + "type": "github" + } + ], + "time": "2024-03-01T13:59:09+00:00" }, { - "name": "sebastian/version", - "version": "2.0.1", + "name": "sebastian/type", + "version": "1.1.5", "source": { "type": "git", - "url": "https://github.com/sebastianbergmann/version.git", - "reference": "99732be0ddb3361e16ad77b68ba41efc8e979019" + "url": "https://github.com/sebastianbergmann/type.git", + "reference": "18f071c3a29892b037d35e6b20ddf3ea39b42874" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/version/zipball/99732be0ddb3361e16ad77b68ba41efc8e979019", - "reference": "99732be0ddb3361e16ad77b68ba41efc8e979019", + "url": "https://api.github.com/repos/sebastianbergmann/type/zipball/18f071c3a29892b037d35e6b20ddf3ea39b42874", + "reference": "18f071c3a29892b037d35e6b20ddf3ea39b42874", "shasum": "" }, "require": { - "php": ">=5.6" + "php": ">=7.2" + }, + "require-dev": { + "phpunit/phpunit": "^8.2" }, "type": "library", "extra": { "branch-alias": { - "dev-master": "2.0.x-dev" + "dev-master": "1.1-dev" } }, "autoload": { @@ -1356,168 +1580,121 @@ "role": "lead" } ], - "description": "Library that helps with managing the version number of Git-hosted PHP projects", - "homepage": "https://github.com/sebastianbergmann/version", + "description": "Collection of value objects that represent the types of the PHP type system", + "homepage": "https://github.com/sebastianbergmann/type", "support": { - "issues": "https://github.com/sebastianbergmann/version/issues", - "source": "https://github.com/sebastianbergmann/version/tree/master" + "issues": "https://github.com/sebastianbergmann/type/issues", + "source": "https://github.com/sebastianbergmann/type/tree/1.1.5" }, - "time": "2016-10-03T07:35:21+00:00" + "funding": [ + { + "url": "https://github.com/sebastianbergmann", + "type": "github" + } + ], + "time": "2024-03-01T14:04:07+00:00" }, { - "name": "symfony/polyfill-ctype", - "version": "v1.32.0", + "name": "sebastian/version", + "version": "2.0.1", "source": { "type": "git", - "url": "https://github.com/symfony/polyfill-ctype.git", - "reference": "a3cc8b044a6ea513310cbd48ef7333b384945638" + "url": "https://github.com/sebastianbergmann/version.git", + "reference": "99732be0ddb3361e16ad77b68ba41efc8e979019" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-ctype/zipball/a3cc8b044a6ea513310cbd48ef7333b384945638", - "reference": "a3cc8b044a6ea513310cbd48ef7333b384945638", + "url": "https://api.github.com/repos/sebastianbergmann/version/zipball/99732be0ddb3361e16ad77b68ba41efc8e979019", + "reference": "99732be0ddb3361e16ad77b68ba41efc8e979019", "shasum": "" }, "require": { - "php": ">=7.2" - }, - "provide": { - "ext-ctype": "*" - }, - "suggest": { - "ext-ctype": "For best performance" + "php": ">=5.6" }, "type": "library", "extra": { - "thanks": { - "url": "https://github.com/symfony/polyfill", - "name": "symfony/polyfill" + "branch-alias": { + "dev-master": "2.0.x-dev" } }, "autoload": { - "files": [ - "bootstrap.php" - ], - "psr-4": { - "Symfony\\Polyfill\\Ctype\\": "" - } + "classmap": [ + "src/" + ] }, "notification-url": "https://packagist.org/downloads/", "license": [ - "MIT" + "BSD-3-Clause" ], "authors": [ { - "name": "Gert de Pagter", - "email": "BackEndTea@gmail.com" - }, - { - "name": "Symfony Community", - "homepage": "https://symfony.com/contributors" + "name": "Sebastian Bergmann", + "email": "sebastian@phpunit.de", + "role": "lead" } ], - "description": "Symfony polyfill for ctype functions", - "homepage": "https://symfony.com", - "keywords": [ - "compatibility", - "ctype", - "polyfill", - "portable" - ], + "description": "Library that helps with managing the version number of Git-hosted PHP projects", + "homepage": "https://github.com/sebastianbergmann/version", "support": { - "source": "https://github.com/symfony/polyfill-ctype/tree/v1.32.0" + "issues": "https://github.com/sebastianbergmann/version/issues", + "source": "https://github.com/sebastianbergmann/version/tree/master" }, - "funding": [ - { - "url": "https://symfony.com/sponsor", - "type": "custom" - }, - { - "url": "https://github.com/fabpot", - "type": "github" - }, - { - "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", - "type": "tidelift" - } - ], - "time": "2024-09-09T11:45:10+00:00" + "time": "2016-10-03T07:35:21+00:00" }, { - "name": "symfony/yaml", - "version": "v3.4.47", + "name": "theseer/tokenizer", + "version": "1.2.3", "source": { "type": "git", - "url": "https://github.com/symfony/yaml.git", - "reference": "88289caa3c166321883f67fe5130188ebbb47094" + "url": "https://github.com/theseer/tokenizer.git", + "reference": "737eda637ed5e28c3413cb1ebe8bb52cbf1ca7a2" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/yaml/zipball/88289caa3c166321883f67fe5130188ebbb47094", - "reference": "88289caa3c166321883f67fe5130188ebbb47094", + "url": "https://api.github.com/repos/theseer/tokenizer/zipball/737eda637ed5e28c3413cb1ebe8bb52cbf1ca7a2", + "reference": "737eda637ed5e28c3413cb1ebe8bb52cbf1ca7a2", "shasum": "" }, "require": { - "php": "^5.5.9|>=7.0.8", - "symfony/polyfill-ctype": "~1.8" - }, - "conflict": { - "symfony/console": "<3.4" - }, - "require-dev": { - "symfony/console": "~3.4|~4.0" - }, - "suggest": { - "symfony/console": "For validating YAML files using the lint command" + "ext-dom": "*", + "ext-tokenizer": "*", + "ext-xmlwriter": "*", + "php": "^7.2 || ^8.0" }, "type": "library", "autoload": { - "psr-4": { - "Symfony\\Component\\Yaml\\": "" - }, - "exclude-from-classmap": [ - "/Tests/" + "classmap": [ + "src/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ - "MIT" + "BSD-3-Clause" ], "authors": [ { - "name": "Fabien Potencier", - "email": "fabien@symfony.com" - }, - { - "name": "Symfony Community", - "homepage": "https://symfony.com/contributors" + "name": "Arne Blankerts", + "email": "arne@blankerts.de", + "role": "Developer" } ], - "description": "Symfony Yaml Component", - "homepage": "https://symfony.com", + "description": "A small library for converting tokenized PHP source code into XML and potentially other formats", "support": { - "source": "https://github.com/symfony/yaml/tree/v3.4.47" + "issues": "https://github.com/theseer/tokenizer/issues", + "source": "https://github.com/theseer/tokenizer/tree/1.2.3" }, "funding": [ { - "url": "https://symfony.com/sponsor", - "type": "custom" - }, - { - "url": "https://github.com/fabpot", + "url": "https://github.com/theseer", "type": "github" - }, - { - "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", - "type": "tidelift" } ], - "time": "2020-10-24T10:57:07+00:00" + "time": "2024-03-03T12:36:25+00:00" } ], "aliases": [], "minimum-stability": "stable", - "stability-flags": [], + "stability-flags": {}, "prefer-stable": false, "prefer-lowest": false, "platform": { @@ -1526,6 +1703,6 @@ "ext-json": "*", "ext-dom": "*" }, - "platform-dev": [], + "platform-dev": {}, "plugin-api-version": "2.6.0" } diff --git a/doc/classes/Doofinder-Configuration.html b/doc/classes/Doofinder-Configuration.html deleted file mode 100644 index 8e60eae..0000000 --- a/doc/classes/Doofinder-Configuration.html +++ /dev/null @@ -1,605 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
-

Documentation

- - - - - -
- -
-
- - - - -
- - -
-

- Configuration - - -
- in package - -
- - -

- - - -

Class with API configuration

- - - - - - - - - -

- Table of Contents - -

- -
-
- $host - -  : string -
-
- -
- $token - -  : string -
-
- -
- $userId - -  : string -
-
- -
- create() - -  : Configuration -
-
- -
- getBaseUrl() - -  : string -
-
- -
- getToken() - -  : string -
-
- -
- getUserId() - -  : string|null -
-
- -
- __construct() - -  : mixed -
-
- -
- - - - - - -
-

- Properties - -

-
-

- $host - - - -

- - - - - private - string - $host - - - - - - -
-
-

- $token - - - -

- - - - - private - string - $token - - - - - - -
-
-

- $userId - - - -

- - - - - private - string - $userId - - - - - - -
-
- -
-

- Methods - -

-
-

- create() - -

- - - - - public - static create(string $host, string $token[, string|null $userId = null ]) : Configuration - - -
Parameters
-
-
- $host - : string -
-
- -
-
- $token - : string -
-
- -
-
- $userId - : string|null - = null
-
- -
-
- - - -
Return values
- Configuration - — - - -
-
-

- getBaseUrl() - -

- - - - - public - getBaseUrl() : string - - - - - -
Return values
- string - — - - -
-
-

- getToken() - -

- - - - - public - getToken() : string - - - - - -
Return values
- string - — - - -
-
-

- getUserId() - -

- - - - - public - getUserId() : string|null - - - - - -
Return values
- string|null - — - - -
-
-

- __construct() - -

- - - - - private - __construct(string $host, string $token, string $userId) : mixed - - -
Parameters
-
-
- $host - : string -
-
- -
-
- $token - : string -
-
- -
-
- $userId - : string -
-
- -
-
- - - -
Return values
- mixed - — - - -
-
- - - - -
-
-
-
-

Search results

- -
-
-
    -
    -
    -
    -
    -
    - - -
    - - - - - - - - diff --git a/doc/classes/Doofinder-Management-ManagementClient.html b/doc/classes/Doofinder-Management-ManagementClient.html deleted file mode 100644 index 8b75dfb..0000000 --- a/doc/classes/Doofinder-Management-ManagementClient.html +++ /dev/null @@ -1,3097 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
    -

    Documentation

    - - - - - -
    - -
    -
    - - - - -
    - - -
    -

    - ManagementClient - - -
    - in package - -
    - - -

    - - - -

    This class is used to do management actions against search engines, index and items through calling an API.

    - - - - - - - - - -

    - Table of Contents - -

    - -
    -
    - $indexResource - -  : Index -
    -
    - -
    - $itemsResource - -  : Item -
    -
    - -
    - $searchEnginesResource - -  : SearchEngine -
    -
    - -
    - __construct() - -  : mixed -
    -
    - -
    - countItems() - -  : HttpResponseInterface -
    -
    Given a hashId and indexName, returns the total number of items in the index.
    - -
    - create() - -  : ManagementClient -
    -
    - -
    - createIndex() - -  : HttpResponseInterface -
    -
    Given a hashId and index data, creates a new index
    - -
    - createItem() - -  : HttpResponseInterface -
    -
    Given a hashId, index id and item data, creates a new item
    - -
    - createItemInTemporalIndex() - -  : HttpResponseInterface -
    -
    Given a hashId, index id and item data, creates a new item in temporal index
    - -
    - createItemsInBulk() - -  : HttpResponseInterface -
    -
    Given a hashId, index id and items data, creates new items
    - -
    - createItemsInBulkInTemporalIndex() - -  : HttpResponseInterface -
    -
    Given a hashId, index id and items data, creates new items in temporal index
    - -
    - createSearchEngine() - -  : HttpResponseInterface -
    -
    Creates a new search engine with the provided data. It is not possible to run searches against the new search -engine as it does not have any index yet. You must create an index belonging to the new search engine to be able -to make searches.
    - -
    - createTemporaryIndex() - -  : HttpResponseInterface -
    -
    Given a hashId and index name, creates a new temporary index
    - -
    - deleteIndex() - -  : HttpResponseInterface -
    -
    Given a hashId and indexName, removes an index
    - -
    - deleteItem() - -  : HttpResponseInterface -
    -
    Given a hashId, indexName and item id, removes an item
    - -
    - deleteItemFromTemporalIndex() - -  : HttpResponseInterface -
    -
    Given a hashId, indexName and item id, removes an item from temporal index
    - -
    - deleteItemsInBulk() - -  : HttpResponseInterface -
    -
    Given a hashId, index id and items id, deletes items
    - -
    - deleteItemsInBulkInTemporalIndex() - -  : HttpResponseInterface -
    -
    Given a hashId, index id and items id, deletes items in temporal index
    - -
    - deleteSearchEngine() - -  : HttpResponseInterface -
    -
    Given a hashId deletes a search engine.
    - -
    - deleteTemporaryIndex() - -  : HttpResponseInterface -
    -
    Given a hashId and index name, deletes a temporary index
    - -
    - findItems() - -  : HttpResponseInterface -
    -
    Given a hashId, indexName and params, it gets an item list.
    - -
    - findItemsFromTemporalIndex() - -  : HttpResponseInterface -
    -
    Given a hashId, indexName and params, it gets an item list from temporal index.
    - -
    - getIndex() - -  : HttpResponseInterface -
    -
    Given a hashId and indexName, it gets an index.
    - -
    - getItem() - -  : HttpResponseInterface -
    -
    Given a hashId, indexName and item id, it gets an item.
    - -
    - getItemFromTemporalIndex() - -  : HttpResponseInterface -
    -
    Given a hashId, indexName and item id, it gets an item from temporal index.
    - -
    - getSearchEngine() - -  : HttpResponseInterface -
    -
    Given a hashId gets a search engine details.
    - -
    - getSearchEngineProcessStatus() - -  : HttpResponseInterface -
    -
    Given a hashId gets the status of the last process task.
    - -
    - listIndexes() - -  : HttpResponseInterface -
    -
    Given a hashId, list index's search engine.
    - -
    - listSearchEngines() - -  : HttpResponseInterface -
    -
    Lists all user's search engines.
    - -
    - processSearchEngine() - -  : HttpResponseInterface -
    -
    Given a hashId schedules a task for processing all search engine's data sources.
    - -
    - reindexIntoTemporary() - -  : HttpResponseInterface -
    -
    Given a hashId and index name, reindex all items from real and index them onto the temporary.
    - -
    - reindexTaskStatus() - -  : HttpResponseInterface -
    -
    Given a hashId and index name, returns the status of the last scheduled reindexing tasks.
    - -
    - replaceIndex() - -  : HttpResponseInterface -
    -
    Given a hashId and index name, replaces the content of the current "production" index with the content of the temporary one
    - -
    - scrollIndex() - -  : HttpResponseInterface -
    -
    Given a hashId and index name, scrolls index
    - -
    - updateIndex() - -  : HttpResponseInterface -
    -
    Given a hashId, indexName and data updates an index.
    - -
    - updateItem() - -  : HttpResponseInterface -
    -
    Given a hashId, indexName, item id and data updates an item.
    - -
    - updateItemInTemporalIndex() - -  : HttpResponseInterface -
    -
    Given a hashId, indexName, item id and data updates an item on temporal index.
    - -
    - updateItemsInBulk() - -  : HttpResponseInterface -
    -
    Given a hashId, index id and items data, updates items
    - -
    - updateItemsInBulkInTemporalIndex() - -  : HttpResponseInterface -
    -
    Given a hashId, index id and items data, updates items in temporal index
    - -
    - updateSearchEngine() - -  : HttpResponseInterface -
    -
    Given a hashId and data updates a search engine.
    - -
    - - - - - - -
    -

    - Properties - -

    - - - -
    - -
    -

    - Methods - -

    -
    -

    - __construct() - -

    - - - - - public - __construct(SearchEngine $searchEnginesResource, Item $itemsResource, Index $indexesResource) : mixed - -
    - -
    Parameters
    -
    -
    - $searchEnginesResource - : SearchEngine -
    -
    -
    - -
    -
    - $itemsResource - : Item -
    -
    -
    - -
    -
    - $indexesResource - : Index -
    -
    -
    - -
    -
    - - - -
    Return values
    - mixed - — - - -
    -
    -

    - countItems() - -

    - - -

    Given a hashId and indexName, returns the total number of items in the index.

    - - - public - countItems(string $hashId, string $indexName) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $hashId - : string -
    -
    - -
    -
    - $indexName - : string -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    -
    -

    - create() - -

    - - - - - public - static create(string $host, string $token, string $userId) : ManagementClient - - -
    Parameters
    -
    -
    - $host - : string -
    -
    - -
    -
    - $token - : string -
    -
    - -
    -
    - $userId - : string -
    -
    - -
    -
    - - - -
    Return values
    - ManagementClient - — - - -
    -
    -

    - createIndex() - -

    - - -

    Given a hashId and index data, creates a new index

    - - - public - createIndex(string $hashId, array<string|int, mixed> $params) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $hashId - : string -
    -
    - -
    -
    - $params - : array<string|int, mixed> -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    -
    -

    - createItem() - -

    - - -

    Given a hashId, index id and item data, creates a new item

    - - - public - createItem(string $hashId, string $itemId, array<string|int, mixed> $params) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $hashId - : string -
    -
    - -
    -
    - $itemId - : string -
    -
    - -
    -
    - $params - : array<string|int, mixed> -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    -
    -

    - createItemInTemporalIndex() - -

    - - -

    Given a hashId, index id and item data, creates a new item in temporal index

    - - - public - createItemInTemporalIndex(string $hashId, string $indexName, array<string|int, mixed> $params) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $hashId - : string -
    -
    - -
    -
    - $indexName - : string -
    -
    - -
    -
    - $params - : array<string|int, mixed> -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    -
    -

    - createItemsInBulk() - -

    - - -

    Given a hashId, index id and items data, creates new items

    - - - public - createItemsInBulk(string $hashId, string $indexName, array<string|int, mixed> $params) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $hashId - : string -
    -
    - -
    -
    - $indexName - : string -
    -
    - -
    -
    - $params - : array<string|int, mixed> -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    -
    -

    - createItemsInBulkInTemporalIndex() - -

    - - -

    Given a hashId, index id and items data, creates new items in temporal index

    - - - public - createItemsInBulkInTemporalIndex(string $hashId, string $indexName, array<string|int, mixed> $params) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $hashId - : string -
    -
    - -
    -
    - $indexName - : string -
    -
    - -
    -
    - $params - : array<string|int, mixed> -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    -
    -

    - createSearchEngine() - -

    - - -

    Creates a new search engine with the provided data. It is not possible to run searches against the new search -engine as it does not have any index yet. You must create an index belonging to the new search engine to be able -to make searches.

    - - - public - createSearchEngine(array<string, mixed> $params) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $params - : array<string, mixed> -
    -
    -

    = [ -'currency' => string, // Default: "EUR" ("AED", "ARS", "AUD", "BAM", "BDT", "BGN", "BOB", "BRL", "BYN", "CAD", "CHF", "CLP", "CNY", "COP", "CZK", "DKK", "DOP", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "IRR", "ISK", "JPY", "KRW", "KWD", "MXN", "MYR", "NOK", "NZD", "PEN", "PLN", "RON", "RSD", "RUB", "SAR", "SEK", "TRY", "TWD", "UAH", "USD", "VEF", "VND", "XPF", "ZAR") -'language' => string, // ("ar", "hy", "eu", "pt-br", "bg", "ca", "cs", "da", "nl", "en", "fi", "fr", "de", "el", "hi", "hu", "id", "it", "no", "pt", "ro", "ru", "es", "sv", "tr"), -'name' => string, -'site_url' => string|null, // Deprecated -'stopwords' => boolean Default: false, -'platform' => string, // Default: ("api", "api", "shopify", "woocommerce", "bigcommerce", "crawler", "ecommerce", "ekm", "file", "magento", "magento2", "opencart", "oscommerce", "prestashop", "shopify"), -'has_grouping' => boolean, // Default: false -]

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - example -
    -
    - -

    $params = [ -'currency' => string, -'language' => string, -'name' => string, -'site_url' => string|null, // Deprecated -'stopwords' => boolean Default: false, -'platform' => string, -'has_grouping' => boolean, -]

    -
    - -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    -
    -

    - createTemporaryIndex() - -

    - - -

    Given a hashId and index name, creates a new temporary index

    - - - public - createTemporaryIndex(string $hashId, string $indexName) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $hashId - : string -
    -
    - -
    -
    - $indexName - : string -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    -
    -

    - deleteIndex() - -

    - - -

    Given a hashId and indexName, removes an index

    - - - public - deleteIndex(string $hashId, string $indexName) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $hashId - : string -
    -
    - -
    -
    - $indexName - : string -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    -
    -

    - deleteItem() - -

    - - -

    Given a hashId, indexName and item id, removes an item

    - - - public - deleteItem(string $hashId, string $indexName, string $itemId) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $hashId - : string -
    -
    - -
    -
    - $indexName - : string -
    -
    - -
    -
    - $itemId - : string -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    -
    -

    - deleteItemFromTemporalIndex() - -

    - - -

    Given a hashId, indexName and item id, removes an item from temporal index

    - - - public - deleteItemFromTemporalIndex(string $hashId, string $indexName, string $itemId) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $hashId - : string -
    -
    - -
    -
    - $indexName - : string -
    -
    - -
    -
    - $itemId - : string -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    -
    -

    - deleteItemsInBulk() - -

    - - -

    Given a hashId, index id and items id, deletes items

    - - - public - deleteItemsInBulk(string $hashId, string $indexName, array<string|int, mixed> $params) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $hashId - : string -
    -
    - -
    -
    - $indexName - : string -
    -
    - -
    -
    - $params - : array<string|int, mixed> -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    -
    -

    - deleteItemsInBulkInTemporalIndex() - -

    - - -

    Given a hashId, index id and items id, deletes items in temporal index

    - - - public - deleteItemsInBulkInTemporalIndex(string $hashId, string $indexName, array<string|int, mixed> $params) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $hashId - : string -
    -
    - -
    -
    - $indexName - : string -
    -
    - -
    -
    - $params - : array<string|int, mixed> -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    - -
    -

    - deleteTemporaryIndex() - -

    - - -

    Given a hashId and index name, deletes a temporary index

    - - - public - deleteTemporaryIndex(string $hashId, string $indexName) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $hashId - : string -
    -
    - -
    -
    - $indexName - : string -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    -
    -

    - findItems() - -

    - - -

    Given a hashId, indexName and params, it gets an item list.

    - - - public - findItems(string $hashId, string $indexName, array<string|int, mixed> $params) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $hashId - : string -
    -
    - -
    -
    - $indexName - : string -
    -
    - -
    -
    - $params - : array<string|int, mixed> -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    -
    -

    - findItemsFromTemporalIndex() - -

    - - -

    Given a hashId, indexName and params, it gets an item list from temporal index.

    - - - public - findItemsFromTemporalIndex(string $hashId, string $indexName, array<string|int, mixed> $params) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $hashId - : string -
    -
    - -
    -
    - $indexName - : string -
    -
    - -
    -
    - $params - : array<string|int, mixed> -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    -
    -

    - getIndex() - -

    - - -

    Given a hashId and indexName, it gets an index.

    - - - public - getIndex(string $hashId, string $indexName) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $hashId - : string -
    -
    - -
    -
    - $indexName - : string -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    -
    -

    - getItem() - -

    - - -

    Given a hashId, indexName and item id, it gets an item.

    - - - public - getItem(string $hashId, string $indexName, string $itemId) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $hashId - : string -
    -
    - -
    -
    - $indexName - : string -
    -
    - -
    -
    - $itemId - : string -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    -
    -

    - getItemFromTemporalIndex() - -

    - - -

    Given a hashId, indexName and item id, it gets an item from temporal index.

    - - - public - getItemFromTemporalIndex(string $hashId, string $indexName, string $itemId) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $hashId - : string -
    -
    - -
    -
    - $indexName - : string -
    -
    - -
    -
    - $itemId - : string -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    - -
    -

    - getSearchEngineProcessStatus() - -

    - - -

    Given a hashId gets the status of the last process task.

    - - - public - getSearchEngineProcessStatus(string $hashId) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $hashId - : string -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    - - -
    -

    - processSearchEngine() - -

    - - -

    Given a hashId schedules a task for processing all search engine's data sources.

    - - - public - processSearchEngine(string $hashId[, array<string|int, mixed> $params = [] ]) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $hashId - : string -
    -
    - -
    -
    - $params - : array<string|int, mixed> - = []
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    -
    -

    - reindexIntoTemporary() - -

    - - -

    Given a hashId and index name, reindex all items from real and index them onto the temporary.

    - - - public - reindexIntoTemporary(string $hashId, string $indexName) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $hashId - : string -
    -
    - -
    -
    - $indexName - : string -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    -
    -

    - reindexTaskStatus() - -

    - - -

    Given a hashId and index name, returns the status of the last scheduled reindexing tasks.

    - - - public - reindexTaskStatus(string $hashId, string $indexName) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $hashId - : string -
    -
    - -
    -
    - $indexName - : string -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    -
    -

    - replaceIndex() - -

    - - -

    Given a hashId and index name, replaces the content of the current "production" index with the content of the temporary one

    - - - public - replaceIndex(string $hashId, string $indexName) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $hashId - : string -
    -
    - -
    -
    - $indexName - : string -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    -
    -

    - scrollIndex() - -

    - - -

    Given a hashId and index name, scrolls index

    - - - public - scrollIndex(string $hashId, string $indexName[, array<string|int, mixed> $params = [] ]) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $hashId - : string -
    -
    - -
    -
    - $indexName - : string -
    -
    - -
    -
    - $params - : array<string|int, mixed> - = []
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    -
    -

    - updateIndex() - -

    - - -

    Given a hashId, indexName and data updates an index.

    - - - public - updateIndex(string $hashId, string $indexName, array<string|int, mixed> $params) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $hashId - : string -
    -
    - -
    -
    - $indexName - : string -
    -
    - -
    -
    - $params - : array<string|int, mixed> -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    -
    -

    - updateItem() - -

    - - -

    Given a hashId, indexName, item id and data updates an item.

    - - - public - updateItem(string $hashId, string $indexName, string $itemId, array<string|int, mixed> $params) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $hashId - : string -
    -
    - -
    -
    - $indexName - : string -
    -
    - -
    -
    - $itemId - : string -
    -
    - -
    -
    - $params - : array<string|int, mixed> -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    -
    -

    - updateItemInTemporalIndex() - -

    - - -

    Given a hashId, indexName, item id and data updates an item on temporal index.

    - - - public - updateItemInTemporalIndex(string $hashId, string $indexName, string $itemId, array<string|int, mixed> $params) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $hashId - : string -
    -
    - -
    -
    - $indexName - : string -
    -
    - -
    -
    - $itemId - : string -
    -
    - -
    -
    - $params - : array<string|int, mixed> -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    -
    -

    - updateItemsInBulk() - -

    - - -

    Given a hashId, index id and items data, updates items

    - - - public - updateItemsInBulk(string $hashId, string $indexName, array<string|int, mixed> $params) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $hashId - : string -
    -
    - -
    -
    - $indexName - : string -
    -
    - -
    -
    - $params - : array<string|int, mixed> -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    -
    -

    - updateItemsInBulkInTemporalIndex() - -

    - - -

    Given a hashId, index id and items data, updates items in temporal index

    - - - public - updateItemsInBulkInTemporalIndex(string $hashId, string $indexName, array<string|int, mixed> $params) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $hashId - : string -
    -
    - -
    -
    - $indexName - : string -
    -
    - -
    -
    - $params - : array<string|int, mixed> -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    -
    -

    - updateSearchEngine() - -

    - - -

    Given a hashId and data updates a search engine.

    - - - public - updateSearchEngine(string $hashId, array<string|int, mixed> $params) : HttpResponseInterface - - -
    Parameters
    -
    -
    - $hashId - : string -
    -
    - -
    -
    - $params - : array<string|int, mixed> -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - throws -
    -
    - ApiException - - -
    -
    - -
    Return values
    - HttpResponseInterface - — - - -
    -
    - - - - -
    -
    -
    -
    -

    Search results

    - -
    -
    -
      -
      -
      -
      -
      -
      - - -
      - - - - - - - - diff --git a/doc/classes/Doofinder-Management-Model-DataSource.html b/doc/classes/Doofinder-Management-Model-DataSource.html deleted file mode 100644 index 8b90b15..0000000 --- a/doc/classes/Doofinder-Management-Model-DataSource.html +++ /dev/null @@ -1,523 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
      -

      Documentation

      - - - - - -
      - -
      -
      - - - - -
      - - -
      -

      - DataSource - - -
      - in package - -
      - - - implements - ModelInterface - -

      - - - -

      Model with data of a given data source

      - - - - - - - -

      - Interfaces, Classes and Traits - -

      - -
      -
      ModelInterface
      -
      Model's interface
      - - -
      - - -

      - Table of Contents - -

      - -
      -
      - FQCN_OPTIONS - -  = ['file' => DoofinderManagementModelDataSourceOptionFile::class, 'shopify' => DoofinderManagementModelDataSourceOptionShopify::class, 'bigcommerce' => DoofinderManagementModelDataSourceOptionBigCommerce::class, 'ekm' => DoofinderManagementModelDataSourceOptionEkm::class, 'magento2' => DoofinderManagementModelDataSourceOptionMagento::class] -
      -
      - -
      - $options - -  : DataSourceOption -
      -
      - -
      - $type - -  : string -
      -
      - -
      - createFromArray() - -  : DataSource -
      -
      - -
      - jsonSerialize() - -  : array<string|int, mixed> -
      -
      - -
      - __construct() - -  : mixed -
      -
      - -
      - - - - -
      -

      - Constants - -

      -
      -

      - FQCN_OPTIONS - -

      - - - - - - public - array<string|int, DataSourceOption> - FQCN_OPTIONS - = ['file' => DoofinderManagementModelDataSourceOptionFile::class, 'shopify' => DoofinderManagementModelDataSourceOptionShopify::class, 'bigcommerce' => DoofinderManagementModelDataSourceOptionBigCommerce::class, 'ekm' => DoofinderManagementModelDataSourceOptionEkm::class, 'magento2' => DoofinderManagementModelDataSourceOptionMagento::class] - - - - - - - -
      -
      - - -
      -

      - Properties - -

      - -
      -

      - $type - - - -

      - - - - - private - string - $type - - - - - - -
      -
      - -
      -

      - Methods - -

      -
      -

      - createFromArray() - -

      - - - - - public - static createFromArray(array<string|int, mixed> $data) : DataSource - - -
      Parameters
      -
      -
      - $data - : array<string|int, mixed> -
      -
      - -
      -
      - - - -
      Return values
      - DataSource - — - - -
      -
      -

      - jsonSerialize() - -

      - - - - - public - jsonSerialize() : array<string|int, mixed> - - - - - -
      Return values
      - array<string|int, mixed> - — - - -
      -
      -

      - __construct() - -

      - - - - - private - __construct(DataSourceOption $options, string $type) : mixed - - -
      Parameters
      -
      -
      - $options - : DataSourceOption -
      -
      - -
      -
      - $type - : string -
      -
      - -
      -
      - - - -
      Return values
      - mixed - — - - -
      -
      - - - - -
      -
      -
      -
      -

      Search results

      - -
      -
      -
        -
        -
        -
        -
        -
        - - -
        - - - - - - - - diff --git a/doc/classes/Doofinder-Management-Model-DataSourceOption.html b/doc/classes/Doofinder-Management-Model-DataSourceOption.html deleted file mode 100644 index 6f338e3..0000000 --- a/doc/classes/Doofinder-Management-Model-DataSourceOption.html +++ /dev/null @@ -1,388 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
        -

        Documentation

        - - - - - -
        - -
        -
        - - - - -
        - - -
        -

        - DataSourceOption - - -
        - in package - -
        - - - implements - ModelInterface - -

        - - - -

        Model with data of a given data source option

        - - - - - - - -

        - Interfaces, Classes and Traits - -

        - -
        -
        ModelInterface
        -
        Model's interface
        - - -
        - - -

        - Table of Contents - -

        - -
        -
        - $url - -  : string|null -
        -
        - -
        - getUrl() - -  : string|null -
        -
        - -
        - __construct() - -  : mixed -
        -
        - -
        - - - - - - -
        -

        - Properties - -

        -
        -

        - $url - - - -

        - - - - - protected - string|null - $url - - - - - - -
        -
        - -
        -

        - Methods - -

        -
        -

        - getUrl() - -

        - - - - - public - getUrl() : string|null - - - - - -
        Return values
        - string|null - — - - -
        -
        -

        - __construct() - -

        - - - - - protected - __construct(string|null $url) : mixed - - -
        Parameters
        -
        -
        - $url - : string|null -
        -
        - -
        -
        - - - -
        Return values
        - mixed - — - - -
        -
        - - - - -
        -
        -
        -
        -

        Search results

        - -
        -
        -
          -
          -
          -
          -
          -
          - - -
          - - - - - - - - diff --git a/doc/classes/Doofinder-Management-Model-DataSourceOptionBigCommerce.html b/doc/classes/Doofinder-Management-Model-DataSourceOptionBigCommerce.html deleted file mode 100644 index b8f3e33..0000000 --- a/doc/classes/Doofinder-Management-Model-DataSourceOptionBigCommerce.html +++ /dev/null @@ -1,621 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
          -

          Documentation

          - - - - - -
          - -
          -
          - - - - -
          - - -
          -

          - DataSourceOptionBigCommerce - - - extends DataSourceOption - - -
          - in package - -
          - - -

          - - - -

          Model with data of a given "big commerce" data source option

          - - - - - - - - - -

          - Table of Contents - -

          - -
          -
          - $url - -  : string|null -
          -
          - -
          - $accessToken - -  : string -
          -
          - -
          - $storeHash - -  : string -
          -
          - -
          - createFromArray() - -  : DataSourceOptionBigCommerce -
          -
          - -
          - getAccessToken() - -  : string -
          -
          - -
          - getStoreHash() - -  : string -
          -
          - -
          - getUrl() - -  : string|null -
          -
          - -
          - jsonSerialize() - -  : array<string|int, string> -
          -
          - -
          - __construct() - -  : mixed -
          -
          - -
          - - - - - - -
          -

          - Properties - -

          -
          -

          - $url - - - -

          - - - - - protected - string|null - $url - - - - - - -
          - - -
          - -
          -

          - Methods - -

          - -
          -

          - getAccessToken() - -

          - - - - - public - getAccessToken() : string - - - - - -
          Return values
          - string - — - - -
          -
          -

          - getStoreHash() - -

          - - - - - public - getStoreHash() : string - - - - - -
          Return values
          - string - — - - -
          -
          -

          - getUrl() - -

          - - - - - public - getUrl() : string|null - - - - - -
          Return values
          - string|null - — - - -
          -
          -

          - jsonSerialize() - -

          - - - - - public - jsonSerialize() : array<string|int, string> - - - - - -
          Return values
          - array<string|int, string> - — - - -
          -
          -

          - __construct() - -

          - - - - - protected - __construct(string|null $url) : mixed - - -
          Parameters
          -
          -
          - $url - : string|null -
          -
          - -
          -
          - - - -
          Return values
          - mixed - — - - -
          -
          - - - - -
          -
          -
          -
          -

          Search results

          - -
          -
          -
            -
            -
            -
            -
            -
            - - -
            - - - - - - - - diff --git a/doc/classes/Doofinder-Management-Model-DataSourceOptionEkm.html b/doc/classes/Doofinder-Management-Model-DataSourceOptionEkm.html deleted file mode 100644 index 5964554..0000000 --- a/doc/classes/Doofinder-Management-Model-DataSourceOptionEkm.html +++ /dev/null @@ -1,543 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
            -

            Documentation

            - - - - - -
            - -
            -
            - - - - -
            - - -
            -

            - DataSourceOptionEkm - - - extends DataSourceOption - - -
            - in package - -
            - - -

            - - - -

            Model with data of a given "ekm" data source option

            - - - - - - - - - -

            - Table of Contents - -

            - -
            -
            - $url - -  : string|null -
            -
            - -
            - $refreshToken - -  : string -
            -
            - -
            - createFromArray() - -  : DataSourceOptionEkm -
            -
            - -
            - getRefreshToken() - -  : string -
            -
            - -
            - getUrl() - -  : string|null -
            -
            - -
            - jsonSerialize() - -  : array<string|int, string> -
            -
            - -
            - __construct() - -  : mixed -
            -
            - -
            - - - - - - -
            -

            - Properties - -

            -
            -

            - $url - - - -

            - - - - - protected - string|null - $url - - - - - - -
            -
            -

            - $refreshToken - - - -

            - - - - - private - string - $refreshToken - - - - - - -
            -
            - -
            -

            - Methods - -

            - -
            -

            - getRefreshToken() - -

            - - - - - public - getRefreshToken() : string - - - - - -
            Return values
            - string - — - - -
            -
            -

            - getUrl() - -

            - - - - - public - getUrl() : string|null - - - - - -
            Return values
            - string|null - — - - -
            -
            -

            - jsonSerialize() - -

            - - - - - public - jsonSerialize() : array<string|int, string> - - - - - -
            Return values
            - array<string|int, string> - — - - -
            -
            -

            - __construct() - -

            - - - - - protected - __construct(string|null $url) : mixed - - -
            Parameters
            -
            -
            - $url - : string|null -
            -
            - -
            -
            - - - -
            Return values
            - mixed - — - - -
            -
            - - - - -
            -
            -
            -
            -

            Search results

            - -
            -
            -
              -
              -
              -
              -
              -
              - - -
              - - - - - - - - diff --git a/doc/classes/Doofinder-Management-Model-DataSourceOptionFile.html b/doc/classes/Doofinder-Management-Model-DataSourceOptionFile.html deleted file mode 100644 index bf44a23..0000000 --- a/doc/classes/Doofinder-Management-Model-DataSourceOptionFile.html +++ /dev/null @@ -1,543 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
              -

              Documentation

              - - - - - -
              - -
              -
              - - - - -
              - - -
              -

              - DataSourceOptionFile - - - extends DataSourceOption - - -
              - in package - -
              - - -

              - - - -

              Model with data of a given "file" data source option

              - - - - - - - - - -

              - Table of Contents - -

              - -
              -
              - $url - -  : string|null -
              -
              - -
              - $pageSize - -  : int|null -
              -
              - -
              - createFromArray() - -  : DataSourceOptionFile -
              -
              - -
              - getPageSize() - -  : int|null -
              -
              - -
              - getUrl() - -  : string|null -
              -
              - -
              - jsonSerialize() - -  : array<string|int, string> -
              -
              - -
              - __construct() - -  : mixed -
              -
              - -
              - - - - - - -
              -

              - Properties - -

              -
              -

              - $url - - - -

              - - - - - protected - string|null - $url - - - - - - -
              -
              -

              - $pageSize - - - -

              - - - - - private - int|null - $pageSize - = null - - - - - -
              -
              - -
              -

              - Methods - -

              - -
              -

              - getPageSize() - -

              - - - - - public - getPageSize() : int|null - - - - - -
              Return values
              - int|null - — - - -
              -
              -

              - getUrl() - -

              - - - - - public - getUrl() : string|null - - - - - -
              Return values
              - string|null - — - - -
              -
              -

              - jsonSerialize() - -

              - - - - - public - jsonSerialize() : array<string|int, string> - - - - - -
              Return values
              - array<string|int, string> - — - - -
              -
              -

              - __construct() - -

              - - - - - protected - __construct(string|null $url) : mixed - - -
              Parameters
              -
              -
              - $url - : string|null -
              -
              - -
              -
              - - - -
              Return values
              - mixed - — - - -
              -
              - - - - -
              -
              -
              -
              -

              Search results

              - -
              -
              -
                -
                -
                -
                -
                -
                - - -
                - - - - - - - - diff --git a/doc/classes/Doofinder-Management-Model-DataSourceOptionMagento.html b/doc/classes/Doofinder-Management-Model-DataSourceOptionMagento.html deleted file mode 100644 index 04607c6..0000000 --- a/doc/classes/Doofinder-Management-Model-DataSourceOptionMagento.html +++ /dev/null @@ -1,465 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                -

                Documentation

                - - - - - -
                - -
                -
                - - - - -
                - - -
                -

                - DataSourceOptionMagento - - - extends DataSourceOption - - -
                - in package - -
                - - -

                - - - -

                Model with data of a given "magento" data source option

                - - - - - - - - - -

                - Table of Contents - -

                - -
                -
                - $url - -  : string|null -
                -
                - -
                - createFromArray() - -  : DataSourceOptionMagento -
                -
                - -
                - getUrl() - -  : string|null -
                -
                - -
                - jsonSerialize() - -  : array<string|int, string> -
                -
                - -
                - __construct() - -  : mixed -
                -
                - -
                - - - - - - -
                -

                - Properties - -

                -
                -

                - $url - - - -

                - - - - - protected - string|null - $url - - - - - - -
                -
                - -
                -

                - Methods - -

                - -
                -

                - getUrl() - -

                - - - - - public - getUrl() : string|null - - - - - -
                Return values
                - string|null - — - - -
                -
                -

                - jsonSerialize() - -

                - - - - - public - jsonSerialize() : array<string|int, string> - - - - - -
                Return values
                - array<string|int, string> - — - - -
                -
                -

                - __construct() - -

                - - - - - protected - __construct(string|null $url) : mixed - - -
                Parameters
                -
                -
                - $url - : string|null -
                -
                - -
                -
                - - - -
                Return values
                - mixed - — - - -
                -
                - - - - -
                -
                -
                -
                -

                Search results

                - -
                -
                -
                  -
                  -
                  -
                  -
                  -
                  - - -
                  - - - - - - - - diff --git a/doc/classes/Doofinder-Management-Model-DataSourceOptionShopify.html b/doc/classes/Doofinder-Management-Model-DataSourceOptionShopify.html deleted file mode 100644 index 8147e0c..0000000 --- a/doc/classes/Doofinder-Management-Model-DataSourceOptionShopify.html +++ /dev/null @@ -1,543 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                  -

                  Documentation

                  - - - - - -
                  - -
                  -
                  - - - - -
                  - - -
                  -

                  - DataSourceOptionShopify - - - extends DataSourceOption - - -
                  - in package - -
                  - - -

                  - - - -

                  Model with data of a given "shopify" data source option

                  - - - - - - - - - -

                  - Table of Contents - -

                  - -
                  -
                  - $url - -  : string|null -
                  -
                  - -
                  - $token - -  : string -
                  -
                  - -
                  - createFromArray() - -  : DataSourceOptionShopify -
                  -
                  - -
                  - getToken() - -  : string -
                  -
                  - -
                  - getUrl() - -  : string|null -
                  -
                  - -
                  - jsonSerialize() - -  : array<string|int, string> -
                  -
                  - -
                  - __construct() - -  : mixed -
                  -
                  - -
                  - - - - - - -
                  -

                  - Properties - -

                  -
                  -

                  - $url - - - -

                  - - - - - protected - string|null - $url - - - - - - -
                  - -
                  - -
                  -

                  - Methods - -

                  - -
                  -

                  - getToken() - -

                  - - - - - public - getToken() : string - - - - - -
                  Return values
                  - string - — - - -
                  -
                  -

                  - getUrl() - -

                  - - - - - public - getUrl() : string|null - - - - - -
                  Return values
                  - string|null - — - - -
                  -
                  -

                  - jsonSerialize() - -

                  - - - - - public - jsonSerialize() : array<string|int, string> - - - - - -
                  Return values
                  - array<string|int, string> - — - - -
                  -
                  -

                  - __construct() - -

                  - - - - - protected - __construct(string|null $url) : mixed - - -
                  Parameters
                  -
                  -
                  - $url - : string|null -
                  -
                  - -
                  -
                  - - - -
                  Return values
                  - mixed - — - - -
                  -
                  - - - - -
                  -
                  -
                  -
                  -

                  Search results

                  - -
                  -
                  -
                    -
                    -
                    -
                    -
                    -
                    - - -
                    - - - - - - - - diff --git a/doc/classes/Doofinder-Management-Model-Index.html b/doc/classes/Doofinder-Management-Model-Index.html deleted file mode 100644 index e9e9770..0000000 --- a/doc/classes/Doofinder-Management-Model-Index.html +++ /dev/null @@ -1,731 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                    -

                    Documentation

                    - - - - - -
                    - -
                    -
                    - - - - -
                    - - -
                    -

                    - Index - - -
                    - in package - -
                    - - - implements - ModelInterface - -

                    - - - -

                    Model with data of a given index

                    - - - - - - - -

                    - Interfaces, Classes and Traits - -

                    - -
                    -
                    ModelInterface
                    -
                    Model's interface
                    - - -
                    - - -

                    - Table of Contents - -

                    - -
                    -
                    - $dataSources - -  : array<string|int, DataSource> -
                    -
                    - -
                    - $name - -  : string -
                    -
                    - -
                    - $options - -  : array<string|int, mixed> -
                    -
                    - -
                    - $preset - -  : string -
                    -
                    - -
                    - createFromArray() - -  : Index -
                    -
                    - -
                    - getDataSources() - -  : array<string|int, DataSource> -
                    -
                    - -
                    - getName() - -  : string -
                    -
                    - -
                    - getOptions() - -  : array<string|int, mixed> -
                    -
                    - -
                    - getPreset() - -  : string -
                    -
                    - -
                    - jsonSerialize() - -  : array<string|int, mixed> -
                    -
                    - -
                    - __construct() - -  : mixed -
                    -
                    - -
                    - - - - - - -
                    -

                    - Properties - -

                    -
                    -

                    - $dataSources - - - -

                    - - - - - private - array<string|int, DataSource> - $dataSources - - - - - - -
                    -
                    -

                    - $name - - - -

                    - - - - - private - string - $name - - - - - - -
                    -
                    -

                    - $options - - - -

                    - - - - - private - array<string|int, mixed> - $options - - - - - - -
                    -
                    -

                    - $preset - - - -

                    - - - - - private - string - $preset - - - - - - -
                    -
                    - -
                    -

                    - Methods - -

                    -
                    -

                    - createFromArray() - -

                    - - - - - public - static createFromArray(array<string|int, mixed> $data) : Index - - -
                    Parameters
                    -
                    -
                    - $data - : array<string|int, mixed> -
                    -
                    - -
                    -
                    - - - -
                    Return values
                    - Index - — - - -
                    -
                    -

                    - getDataSources() - -

                    - - - - - public - getDataSources() : array<string|int, DataSource> - - - - - -
                    Return values
                    - array<string|int, DataSource> - — - - -
                    -
                    -

                    - getName() - -

                    - - - - - public - getName() : string - - - - - -
                    Return values
                    - string - — - - -
                    -
                    -

                    - getOptions() - -

                    - - - - - public - getOptions() : array<string|int, mixed> - - - - - -
                    Return values
                    - array<string|int, mixed> - — - - -
                    -
                    -

                    - getPreset() - -

                    - - - - - public - getPreset() : string - - - - - -
                    Return values
                    - string - — - - -
                    -
                    -

                    - jsonSerialize() - -

                    - - - - - public - jsonSerialize() : array<string|int, mixed> - - - - - -
                    Return values
                    - array<string|int, mixed> - — - - -
                    -
                    -

                    - __construct() - -

                    - - - - - private - __construct(string $name, string $preset, string $options, array<string|int, DataSource$dataSources) : mixed - - -
                    Parameters
                    -
                    -
                    - $name - : string -
                    -
                    - -
                    -
                    - $preset - : string -
                    -
                    - -
                    -
                    - $options - : string -
                    -
                    - -
                    -
                    - $dataSources - : array<string|int, DataSource> -
                    -
                    - -
                    -
                    - - - -
                    Return values
                    - mixed - — - - -
                    -
                    - - - - -
                    -
                    -
                    -
                    -

                    Search results

                    - -
                    -
                    -
                      -
                      -
                      -
                      -
                      -
                      - - -
                      - - - - - - - - diff --git a/doc/classes/Doofinder-Management-Model-Item.html b/doc/classes/Doofinder-Management-Model-Item.html deleted file mode 100644 index 8774aac..0000000 --- a/doc/classes/Doofinder-Management-Model-Item.html +++ /dev/null @@ -1,1028 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                      -

                      Documentation

                      - - - - - -
                      - -
                      -
                      - - - - -
                      - - -
                      -

                      - Item - - -
                      - in package - -
                      - - - implements - ModelInterface - -

                      - - - -

                      Model with data of a given item

                      - - - - - - - -

                      - Interfaces, Classes and Traits - -

                      - -
                      -
                      ModelInterface
                      -
                      Model's interface
                      - - -
                      - - -

                      - Table of Contents - -

                      - -
                      -
                      - SETTED_FIELDS - -  = ['title', 'description', 'link', 'image_link', 'availability', 'price', 'sale_price', 'brand', 'gtin', 'mpn'] -
                      -
                      - -
                      - $additionalFields - -  : array<string|int, mixed> -
                      -
                      - -
                      - $bestPrice - -  : float|null -
                      -
                      - -
                      - $categories - -  : array<string|int, string>|string -
                      -
                      - -
                      - $dfGroupingId - -  : string|null -
                      -
                      - -
                      - $dfGroupLeader - -  : bool|null -
                      -
                      - -
                      - $dfManualBoost - -  : float|null -
                      -
                      - -
                      - $id - -  : string -
                      -
                      - -
                      - createFromArray() - -  : Item -
                      -
                      - -
                      - getAdditionalFields() - -  : array<string|int, mixed> -
                      -
                      - -
                      - getBestPrice() - -  : float|null -
                      -
                      - -
                      - getCategories() - -  : array<string|int, string>|string|null -
                      -
                      - -
                      - getDfGroupingId() - -  : string|null -
                      -
                      - -
                      - getDfGroupLeader() - -  : bool|null -
                      -
                      - -
                      - getDfManualBoost() - -  : float|null -
                      -
                      - -
                      - getId() - -  : string -
                      -
                      - -
                      - jsonSerialize() - -  : array<string|int, mixed> -
                      -
                      - -
                      - __construct() - -  : mixed -
                      -
                      - -
                      - - - - -
                      -

                      - Constants - -

                      -
                      -

                      - SETTED_FIELDS - -

                      - - - - - - public - mixed - SETTED_FIELDS - = ['title', 'description', 'link', 'image_link', 'availability', 'price', 'sale_price', 'brand', 'gtin', 'mpn'] - - - -
                      - -
                      - - - -
                      -
                      - - -
                      -

                      - Properties - -

                      -
                      -

                      - $additionalFields - - - -

                      - - - - - private - array<string|int, mixed> - $additionalFields - = [] - - - - - -
                      -
                      -

                      - $bestPrice - - - -

                      - - - - - private - float|null - $bestPrice - - - - - - -
                      -
                      -

                      - $categories - - - -

                      - - - - - private - array<string|int, string>|string - $categories - - - - - - -
                      -
                      -

                      - $dfGroupingId - - - -

                      - - - - - private - string|null - $dfGroupingId - - - - - - -
                      -
                      -

                      - $dfGroupLeader - - - -

                      - - - - - private - bool|null - $dfGroupLeader - - - - - - -
                      -
                      -

                      - $dfManualBoost - - - -

                      - - - - - private - float|null - $dfManualBoost - - - - - - -
                      -
                      -

                      - $id - - - -

                      - - - - - private - string - $id - - - - - - -
                      -
                      - -
                      -

                      - Methods - -

                      -
                      -

                      - createFromArray() - -

                      - - - - - public - static createFromArray(array<string|int, mixed> $data) : Item - - -
                      Parameters
                      -
                      -
                      - $data - : array<string|int, mixed> -
                      -
                      - -
                      -
                      - - - -
                      Return values
                      - Item - — - - -
                      -
                      -

                      - getAdditionalFields() - -

                      - - - - - public - getAdditionalFields() : array<string|int, mixed> - - - - - -
                      Return values
                      - array<string|int, mixed> - — - - -
                      -
                      -

                      - getBestPrice() - -

                      - - - - - public - getBestPrice() : float|null - - - - - -
                      Return values
                      - float|null - — - - -
                      -
                      -

                      - getCategories() - -

                      - - - - - public - getCategories() : array<string|int, string>|string|null - - - - - -
                      Return values
                      - array<string|int, string>|string|null - — - - -
                      -
                      -

                      - getDfGroupingId() - -

                      - - - - - public - getDfGroupingId() : string|null - - - - - -
                      Return values
                      - string|null - — - - -
                      -
                      -

                      - getDfGroupLeader() - -

                      - - - - - public - getDfGroupLeader() : bool|null - - - - - -
                      Return values
                      - bool|null - — - - -
                      -
                      -

                      - getDfManualBoost() - -

                      - - - - - public - getDfManualBoost() : float|null - - - - - -
                      Return values
                      - float|null - — - - -
                      -
                      -

                      - getId() - -

                      - - - - - public - getId() : string - - - - - -
                      Return values
                      - string - — - - -
                      -
                      -

                      - jsonSerialize() - -

                      - - - - - public - jsonSerialize() : array<string|int, mixed> - - - - - -
                      Return values
                      - array<string|int, mixed> - — - - -
                      -
                      -

                      - __construct() - -

                      - - - - - private - __construct(string|null $id, string|null $dfGroupingId, string|null $dfGroupLeader, float|null $dfManualBoost, array<string|int, string>|string|null $categories, float|null $bestPrice, string|null $additionalFields) : mixed - - -
                      Parameters
                      -
                      -
                      - $id - : string|null -
                      -
                      - -
                      -
                      - $dfGroupingId - : string|null -
                      -
                      - -
                      -
                      - $dfGroupLeader - : string|null -
                      -
                      - -
                      -
                      - $dfManualBoost - : float|null -
                      -
                      - -
                      -
                      - $categories - : array<string|int, string>|string|null -
                      -
                      - -
                      -
                      - $bestPrice - : float|null -
                      -
                      - -
                      -
                      - $additionalFields - : string|null -
                      -
                      - -
                      -
                      - - - -
                      Return values
                      - mixed - — - - -
                      -
                      - - - - -
                      -
                      -
                      -
                      -

                      Search results

                      - -
                      -
                      -
                        -
                        -
                        -
                        -
                        -
                        - - -
                        - - - - - - - - diff --git a/doc/classes/Doofinder-Management-Model-SearchEngine.html b/doc/classes/Doofinder-Management-Model-SearchEngine.html deleted file mode 100644 index be7b698..0000000 --- a/doc/classes/Doofinder-Management-Model-SearchEngine.html +++ /dev/null @@ -1,1366 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                        -

                        Documentation

                        - - - - - -
                        - -
                        -
                        - - - - -
                        - - -
                        -

                        - SearchEngine - - -
                        - in package - -
                        - - - implements - ModelInterface - -

                        - - - -

                        Model with data of a given search engine

                        - - - - - - - -

                        - Interfaces, Classes and Traits - -

                        - -
                        -
                        ModelInterface
                        -
                        Model's interface
                        - - -
                        - - -

                        - Table of Contents - -

                        - -
                        -
                        - $currency - -  : string -
                        -
                        - -
                        - $hasGrouping - -  : bool -
                        -
                        - -
                        - $hashid - -  : string -
                        -
                        - -
                        - $inactive - -  : bool -
                        -
                        - -
                        - $indices - -  : array<string|int, mixed> -
                        -
                        - -
                        - $language - -  : string -
                        -
                        - -
                        - $name - -  : string -
                        -
                        - -
                        - $platform - -  : string -
                        -
                        - -
                        - $searchUrl - -  : string -
                        -
                        - -
                        - $siteUrl - -  : string|null -
                        -
                        - -
                        - $stopwords - -  : bool -
                        -
                        - -
                        - createFromArray() - -  : SearchEngine -
                        -
                        - -
                        - getCurrency() - -  : string -
                        -
                        - -
                        - getHashid() - -  : string -
                        -
                        - -
                        - getIndices() - -  : array<string|int, mixed> -
                        -
                        - -
                        - getLanguage() - -  : string -
                        -
                        - -
                        - getName() - -  : string -
                        -
                        - -
                        - getPlatform() - -  : string -
                        -
                        - -
                        - getSearchUrl() - -  : string -
                        -
                        - -
                        - getSiteUrl() - -  : string|null -
                        -
                        - -
                        - isHasGrouping() - -  : bool -
                        -
                        - -
                        - isInactive() - -  : bool -
                        -
                        - -
                        - isStopwords() - -  : bool -
                        -
                        - -
                        - jsonSerialize() - -  : array<string|int, mixed> -
                        -
                        - -
                        - __construct() - -  : mixed -
                        -
                        - -
                        - - - - - - -
                        -

                        - Properties - -

                        -
                        -

                        - $currency - - - -

                        - - - - - private - string - $currency - - - - - - -
                        -
                        -

                        - $hasGrouping - - - -

                        - - - - - private - bool - $hasGrouping - - - - - - -
                        -
                        -

                        - $hashid - - - -

                        - - - - - private - string - $hashid - - - - - - -
                        -
                        -

                        - $inactive - - - -

                        - - - - - private - bool - $inactive - - - - - - -
                        -
                        -

                        - $indices - - - -

                        - - - - - private - array<string|int, mixed> - $indices - - - - - - -
                        -
                        -

                        - $language - - - -

                        - - - - - private - string - $language - - - - - - -
                        -
                        -

                        - $name - - - -

                        - - - - - private - string - $name - - - - - - -
                        -
                        -

                        - $platform - - - -

                        - - - - - private - string - $platform - - - - - - -
                        -
                        -

                        - $searchUrl - - - -

                        - - - - - private - string - $searchUrl - - - - - - -
                        -
                        -

                        - $siteUrl - - - -

                        - - - - - private - string|null - $siteUrl - - - - - -
                        - Tags - -
                        -
                        -
                        - deprecated -
                        -
                        - 7.0.4 - - -
                        -
                        - -
                        -
                        -

                        - $stopwords - - - -

                        - - - - - private - bool - $stopwords - - - - - - -
                        -
                        - -
                        -

                        - Methods - -

                        -
                        -

                        - createFromArray() - -

                        - - - - - public - static createFromArray(array<string|int, mixed> $data) : SearchEngine - - -
                        Parameters
                        -
                        -
                        - $data - : array<string|int, mixed> -
                        -
                        - -
                        -
                        - - - -
                        Return values
                        - SearchEngine - — - - -
                        -
                        -

                        - getCurrency() - -

                        - - - - - public - getCurrency() : string - - - - - -
                        Return values
                        - string - — - - -
                        -
                        -

                        - getHashid() - -

                        - - - - - public - getHashid() : string - - - - - -
                        Return values
                        - string - — - - -
                        -
                        -

                        - getIndices() - -

                        - - - - - public - getIndices() : array<string|int, mixed> - - - - - -
                        Return values
                        - array<string|int, mixed> - — - - -
                        -
                        -

                        - getLanguage() - -

                        - - - - - public - getLanguage() : string - - - - - -
                        Return values
                        - string - — - - -
                        -
                        -

                        - getName() - -

                        - - - - - public - getName() : string - - - - - -
                        Return values
                        - string - — - - -
                        -
                        -

                        - getPlatform() - -

                        - - - - - public - getPlatform() : string - - - - - -
                        Return values
                        - string - — - - -
                        -
                        -

                        - getSearchUrl() - -

                        - - - - - public - getSearchUrl() : string - - - - - -
                        Return values
                        - string - — - - -
                        -
                        -

                        - getSiteUrl() - -

                        - - - - - public - getSiteUrl() : string|null - - - - -
                        - Tags - -
                        -
                        -
                        - deprecated -
                        -
                        - 7.0.4 - - -
                        -
                        - -
                        Return values
                        - string|null - — - - -
                        -
                        -

                        - isHasGrouping() - -

                        - - - - - public - isHasGrouping() : bool - - - - - -
                        Return values
                        - bool - — - - -
                        -
                        -

                        - isInactive() - -

                        - - - - - public - isInactive() : bool - - - - - -
                        Return values
                        - bool - — - - -
                        -
                        -

                        - isStopwords() - -

                        - - - - - public - isStopwords() : bool - - - - - -
                        Return values
                        - bool - — - - -
                        -
                        -

                        - jsonSerialize() - -

                        - - - - - public - jsonSerialize() : array<string|int, mixed> - - - - - -
                        Return values
                        - array<string|int, mixed> - — - - -
                        -
                        -

                        - __construct() - -

                        - - - - - private - __construct(mixed $language, mixed $name, mixed $currency, mixed $hashid, mixed $indices, mixed $inactive, mixed $searchUrl, mixed $siteUrl, mixed $stopwords, mixed $platform, mixed $hasGrouping) : mixed - -
                        - -
                        Parameters
                        -
                        -
                        - $language - : mixed -
                        -
                        -
                        - -
                        -
                        - $name - : mixed -
                        -
                        -
                        - -
                        -
                        - $currency - : mixed -
                        -
                        -
                        - -
                        -
                        - $hashid - : mixed -
                        -
                        -
                        - -
                        -
                        - $indices - : mixed -
                        -
                        -
                        - -
                        -
                        - $inactive - : mixed -
                        -
                        -
                        - -
                        -
                        - $searchUrl - : mixed -
                        -
                        -
                        - -
                        -
                        - $siteUrl - : mixed -
                        -
                        -
                        - -
                        -
                        - $stopwords - : mixed -
                        -
                        -
                        - -
                        -
                        - $platform - : mixed -
                        -
                        -
                        - -
                        -
                        - $hasGrouping - : mixed -
                        -
                        -
                        - -
                        -
                        - - - -
                        Return values
                        - mixed - — - - -
                        -
                        - - - - -
                        -
                        -
                        -
                        -

                        Search results

                        - -
                        -
                        -
                          -
                          -
                          -
                          -
                          -
                          - - -
                          - - - - - - - - diff --git a/doc/classes/Doofinder-Management-Resources-Index.html b/doc/classes/Doofinder-Management-Resources-Index.html deleted file mode 100644 index 9b32a70..0000000 --- a/doc/classes/Doofinder-Management-Resources-Index.html +++ /dev/null @@ -1,1560 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                          -

                          Documentation

                          - - - - - -
                          - -
                          -
                          - - - - -
                          - - -
                          -

                          - Index - - - extends ManagementResource - - -
                          - in package - -
                          - - -

                          - - - -

                          Index class is responsible for making the requests to the index's endpoints and return a response

                          - - - - - - - - - -

                          - Table of Contents - -

                          - -
                          -
                          - $baseUrl - -  : string -
                          -
                          - -
                          - $config - -  : Configuration -
                          -
                          - -
                          - $httpClient - -  : HttpClientInterface -
                          -
                          - -
                          - create() - -  : Index -
                          -
                          - -
                          - createIndex() - -  : HttpResponseInterface -
                          -
                          Given a hashId and index data, creates a new index
                          - -
                          - createTemporaryIndex() - -  : HttpResponseInterface -
                          -
                          Given a hashId and index name, creates a new temporary index
                          - -
                          - deleteIndex() - -  : HttpResponseInterface -
                          -
                          Given a hashId and indexName, deletes an index
                          - -
                          - deleteTemporaryIndex() - -  : HttpResponseInterface -
                          -
                          Given a hashId and index name, deletes a temporary index
                          - -
                          - getIndex() - -  : HttpResponseInterface -
                          -
                          Given a hashId, indexName and data, it gets an index
                          - -
                          - getUrl() - -  : string -
                          -
                          - -
                          - listIndexes() - -  : HttpResponseInterface -
                          -
                          Given a hashId, lists index's search engine
                          - -
                          - reindexIntoTemporary() - -  : HttpResponseInterface -
                          -
                          Given a hashId and index name, reindex all items from real and index them onto the temporary.
                          - -
                          - reindexTaskStatus() - -  : HttpResponseInterface -
                          -
                          Given a hashId and index name, returns the status of the last scheduled reindexing tasks.
                          - -
                          - replaceIndex() - -  : HttpResponseInterface -
                          -
                          Given a hashId and index name, replaces the content of the current "production" index with the content of the temporary one
                          - -
                          - updateIndex() - -  : HttpResponseInterface -
                          -
                          Given a hashId, indexName and data updates an index
                          - -
                          - __construct() - -  : mixed -
                          -
                          - -
                          - requestWithJwt() - -  : HttpResponseInterface -
                          -
                          It does a http request with Jwt authentication. If there is an error throws an ApiException
                          - -
                          - requestWithToken() - -  : HttpResponseInterface -
                          -
                          It does a http request with Token authentication. If there is an error throws an ApiException
                          - -
                          - getBaseUrl() - -  : string -
                          -
                          - -
                          - request() - -  : HttpResponseInterface -
                          -
                          It does a http request. If there is an error throws an ApiException
                          - -
                          - - - - - - -
                          -

                          - Properties - -

                          -
                          -

                          - $baseUrl - - - -

                          - - - - - protected - string - $baseUrl - - - - - - -
                          - - -
                          - -
                          -

                          - Methods - -

                          - -
                          -

                          - createIndex() - -

                          - - -

                          Given a hashId and index data, creates a new index

                          - - - public - createIndex(string $hashId, array<string|int, mixed> $params) : HttpResponseInterface - - -
                          Parameters
                          -
                          -
                          - $hashId - : string -
                          -
                          - -
                          -
                          - $params - : array<string|int, mixed> -
                          -
                          - -
                          -
                          - - -
                          - Tags - -
                          -
                          -
                          - throws -
                          -
                          - ApiException - - -
                          -
                          - -
                          Return values
                          - HttpResponseInterface - — - - -
                          -
                          -

                          - createTemporaryIndex() - -

                          - - -

                          Given a hashId and index name, creates a new temporary index

                          - - - public - createTemporaryIndex(string $hashId, string $indexName) : HttpResponseInterface - - -
                          Parameters
                          -
                          -
                          - $hashId - : string -
                          -
                          - -
                          -
                          - $indexName - : string -
                          -
                          - -
                          -
                          - - -
                          - Tags - -
                          -
                          -
                          - throws -
                          -
                          - ApiException - - -
                          -
                          - -
                          Return values
                          - HttpResponseInterface - — - - -
                          -
                          -

                          - deleteIndex() - -

                          - - -

                          Given a hashId and indexName, deletes an index

                          - - - public - deleteIndex(string $hashId, string $indexName) : HttpResponseInterface - - -
                          Parameters
                          -
                          -
                          - $hashId - : string -
                          -
                          - -
                          -
                          - $indexName - : string -
                          -
                          - -
                          -
                          - - -
                          - Tags - -
                          -
                          -
                          - throws -
                          -
                          - ApiException - - -
                          -
                          - -
                          Return values
                          - HttpResponseInterface - — - - -
                          -
                          -

                          - deleteTemporaryIndex() - -

                          - - -

                          Given a hashId and index name, deletes a temporary index

                          - - - public - deleteTemporaryIndex(string $hashId, string $indexName) : HttpResponseInterface - - -
                          Parameters
                          -
                          -
                          - $hashId - : string -
                          -
                          - -
                          -
                          - $indexName - : string -
                          -
                          - -
                          -
                          - - -
                          - Tags - -
                          -
                          -
                          - throws -
                          -
                          - ApiException - - -
                          -
                          - -
                          Return values
                          - HttpResponseInterface - — - - -
                          -
                          -

                          - getIndex() - -

                          - - -

                          Given a hashId, indexName and data, it gets an index

                          - - - public - getIndex(string $hashId, string $indexName) : HttpResponseInterface - - -
                          Parameters
                          -
                          -
                          - $hashId - : string -
                          -
                          - -
                          -
                          - $indexName - : string -
                          -
                          - -
                          -
                          - - -
                          - Tags - -
                          -
                          -
                          - throws -
                          -
                          - ApiException - - -
                          -
                          - -
                          Return values
                          - HttpResponseInterface - — - - -
                          -
                          -

                          - getUrl() - -

                          - - - - - public - abstract getUrl() : string - - - - - -
                          Return values
                          - string - — - - -
                          -
                          -

                          - listIndexes() - -

                          - - -

                          Given a hashId, lists index's search engine

                          - - - public - listIndexes(string $hashId) : HttpResponseInterface - - -
                          Parameters
                          -
                          -
                          - $hashId - : string -
                          -
                          - -
                          -
                          - - -
                          - Tags - -
                          -
                          -
                          - throws -
                          -
                          - ApiException - - -
                          -
                          - -
                          Return values
                          - HttpResponseInterface - — - - -
                          -
                          -

                          - reindexIntoTemporary() - -

                          - - -

                          Given a hashId and index name, reindex all items from real and index them onto the temporary.

                          - - - public - reindexIntoTemporary(string $hashId, string $indexName) : HttpResponseInterface - - -
                          Parameters
                          -
                          -
                          - $hashId - : string -
                          -
                          - -
                          -
                          - $indexName - : string -
                          -
                          - -
                          -
                          - - -
                          - Tags - -
                          -
                          -
                          - throws -
                          -
                          - ApiException - - -
                          -
                          - -
                          Return values
                          - HttpResponseInterface - — - - -
                          -
                          -

                          - reindexTaskStatus() - -

                          - - -

                          Given a hashId and index name, returns the status of the last scheduled reindexing tasks.

                          - - - public - reindexTaskStatus(string $hashId, string $indexName) : HttpResponseInterface - - -
                          Parameters
                          -
                          -
                          - $hashId - : string -
                          -
                          - -
                          -
                          - $indexName - : string -
                          -
                          - -
                          -
                          - - -
                          - Tags - -
                          -
                          -
                          - throws -
                          -
                          - ApiException - - -
                          -
                          - -
                          Return values
                          - HttpResponseInterface - — - - -
                          -
                          -

                          - replaceIndex() - -

                          - - -

                          Given a hashId and index name, replaces the content of the current "production" index with the content of the temporary one

                          - - - public - replaceIndex(string $hashId, string $indexName) : HttpResponseInterface - - -
                          Parameters
                          -
                          -
                          - $hashId - : string -
                          -
                          - -
                          -
                          - $indexName - : string -
                          -
                          - -
                          -
                          - - -
                          - Tags - -
                          -
                          -
                          - throws -
                          -
                          - ApiException - - -
                          -
                          - -
                          Return values
                          - HttpResponseInterface - — - - -
                          -
                          -

                          - updateIndex() - -

                          - - -

                          Given a hashId, indexName and data updates an index

                          - - - public - updateIndex(string $hashId, string $indexName, array<string|int, mixed> $params) : HttpResponseInterface - - -
                          Parameters
                          -
                          -
                          - $hashId - : string -
                          -
                          - -
                          -
                          - $indexName - : string -
                          -
                          - -
                          -
                          - $params - : array<string|int, mixed> -
                          -
                          - -
                          -
                          - - -
                          - Tags - -
                          -
                          -
                          - throws -
                          -
                          - ApiException - - -
                          -
                          - -
                          Return values
                          - HttpResponseInterface - — - - -
                          - -
                          -

                          - requestWithJwt() - -

                          - - -

                          It does a http request with Jwt authentication. If there is an error throws an ApiException

                          - - - protected - requestWithJwt(string $url, string $method[, class-string<\Doofinder\Shared\Interfaces\ModelInterface> $model = null ][, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $headers = [] ]) : HttpResponseInterface - - -
                          Parameters
                          -
                          -
                          - $url - : string -
                          -
                          - -
                          -
                          - $method - : string -
                          -
                          - -
                          -
                          - $model - : class-string<\Doofinder\Shared\Interfaces\ModelInterface> - = null
                          -
                          - -
                          -
                          - $params - : array<string|int, mixed> - = []
                          -
                          - -
                          -
                          - $headers - : array<string|int, mixed> - = []
                          -
                          - -
                          -
                          - - -
                          - Tags - -
                          -
                          -
                          - throws -
                          -
                          - ApiException - - -
                          -
                          - -
                          Return values
                          - HttpResponseInterface - — - - -
                          -
                          -

                          - requestWithToken() - -

                          - - -

                          It does a http request with Token authentication. If there is an error throws an ApiException

                          - - - protected - requestWithToken(string $url, string $method[, class-string<\Doofinder\Shared\Interfaces\ModelInterface> $model = null ][, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $headers = [] ]) : HttpResponseInterface - - -
                          Parameters
                          -
                          -
                          - $url - : string -
                          -
                          - -
                          -
                          - $method - : string -
                          -
                          - -
                          -
                          - $model - : class-string<\Doofinder\Shared\Interfaces\ModelInterface> - = null
                          -
                          - -
                          -
                          - $params - : array<string|int, mixed> - = []
                          -
                          - -
                          -
                          - $headers - : array<string|int, mixed> - = []
                          -
                          - -
                          -
                          - - -
                          - Tags - -
                          -
                          -
                          - throws -
                          -
                          - ApiException - - -
                          -
                          - -
                          Return values
                          - HttpResponseInterface - — - - -
                          -
                          -

                          - getBaseUrl() - -

                          - - - - - private - getBaseUrl(string $hashId[, string|null $indexName = null ]) : string - - -
                          Parameters
                          -
                          -
                          - $hashId - : string -
                          -
                          - -
                          -
                          - $indexName - : string|null - = null
                          -
                          - -
                          -
                          - - - -
                          Return values
                          - string - — - - -
                          -
                          -

                          - request() - -

                          - - -

                          It does a http request. If there is an error throws an ApiException

                          - - - private - request(string $url, string $method[, class-string<\Doofinder\Shared\Interfaces\ModelInterface> $model = null ][, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $headers = [] ]) : HttpResponseInterface - - -
                          Parameters
                          -
                          -
                          - $url - : string -
                          -
                          - -
                          -
                          - $method - : string -
                          -
                          - -
                          -
                          - $model - : class-string<\Doofinder\Shared\Interfaces\ModelInterface> - = null
                          -
                          - -
                          -
                          - $params - : array<string|int, mixed> - = []
                          -
                          - -
                          -
                          - $headers - : array<string|int, mixed> - = []
                          -
                          - -
                          -
                          - - -
                          - Tags - -
                          -
                          -
                          - throws -
                          -
                          - ApiException - - -
                          -
                          - -
                          Return values
                          - HttpResponseInterface - — - - -
                          -
                          - - - - -
                          -
                          -
                          -
                          -

                          Search results

                          - -
                          -
                          -
                            -
                            -
                            -
                            -
                            -
                            - - -
                            - - - - - - - - diff --git a/doc/classes/Doofinder-Management-Resources-Item.html b/doc/classes/Doofinder-Management-Resources-Item.html deleted file mode 100644 index bf16b53..0000000 --- a/doc/classes/Doofinder-Management-Resources-Item.html +++ /dev/null @@ -1,2276 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                            -

                            Documentation

                            - - - - - -
                            - -
                            -
                            - - - - -
                            - - -
                            -

                            - Item - - - extends ManagementResource - - -
                            - in package - -
                            - - -

                            - - - -

                            Item class is responsible for making the requests to the item's endpoints and return a response

                            - - - - - - - - - -

                            - Table of Contents - -

                            - -
                            -
                            - $baseUrl - -  : string -
                            -
                            - -
                            - $config - -  : Configuration -
                            -
                            - -
                            - $httpClient - -  : HttpClientInterface -
                            -
                            - -
                            - countItems() - -  : HttpResponseInterface -
                            -
                            Given a hashId and indexName, returns the total number of items in the index.
                            - -
                            - create() - -  : Item -
                            -
                            - -
                            - createItem() - -  : HttpResponseInterface -
                            -
                            Given a hashId, index name and item data, creates a new item
                            - -
                            - createItemInTemporalIndex() - -  : HttpResponseInterface -
                            -
                            Given a hashId, index name and item data, creates a new item in temporal index
                            - -
                            - createItemsInBulk() - -  : HttpResponseInterface -
                            -
                            Given a hashId, index name and items data, creates new items in index
                            - -
                            - createItemsInBulkInTemporalIndex() - -  : HttpResponseInterface -
                            -
                            Given a hashId, index name and items data, creates new items in temporal index
                            - -
                            - deleteItem() - -  : HttpResponseInterface -
                            -
                            Given a hashId, indexName and item id, deletes an item
                            - -
                            - deleteItemFromTemporalIndex() - -  : HttpResponseInterface -
                            -
                            Given a hashId, indexName and item id, deletes an item from temporal index
                            - -
                            - deleteItemsInBulk() - -  : HttpResponseInterface -
                            -
                            Given a hashId, index name and items id, deletes items in index
                            - -
                            - deleteItemsInBulkInTemporalIndex() - -  : HttpResponseInterface -
                            -
                            Given a hashId, index name and items id, deletes items in temporal index
                            - -
                            - findItems() - -  : HttpResponseInterface -
                            -
                            Given a hashId, indexName and params, it gets an item list
                            - -
                            - findItemsFromTemporalIndex() - -  : HttpResponseInterface -
                            -
                            Given a hashId, indexName and params, it gets an item list from temporal index
                            - -
                            - getItem() - -  : HttpResponseInterface -
                            -
                            Given a hashId, indexName and item id, it gets an item
                            - -
                            - getItemFromTemporalIndex() - -  : HttpResponseInterface -
                            -
                            Given a hashId, indexName and item id, it gets an item from temporal index
                            - -
                            - getUrl() - -  : string -
                            -
                            - -
                            - scrollIndex() - -  : HttpResponseInterface -
                            -
                            Given a hashId and index name, scrolls index
                            - -
                            - updateItem() - -  : HttpResponseInterface -
                            -
                            Given a hashId, indexName, item id and data, updates an item
                            - -
                            - updateItemInTemporalIndex() - -  : HttpResponseInterface -
                            -
                            Given a hashId, indexName, item id and data, updates an item in temporal index
                            - -
                            - updateItemsInBulk() - -  : HttpResponseInterface -
                            -
                            Given a hashId, index name and items data, updates items in index
                            - -
                            - updateItemsInBulkInTemporalIndex() - -  : HttpResponseInterface -
                            -
                            Given a hashId, index name and items data, updates items in temporal index
                            - -
                            - __construct() - -  : mixed -
                            -
                            - -
                            - requestWithJwt() - -  : HttpResponseInterface -
                            -
                            It does a http request with Jwt authentication. If there is an error throws an ApiException
                            - -
                            - requestWithToken() - -  : HttpResponseInterface -
                            -
                            It does a http request with Token authentication. If there is an error throws an ApiException
                            - -
                            - getBaseUrl() - -  : string -
                            -
                            - -
                            - request() - -  : HttpResponseInterface -
                            -
                            It does a http request. If there is an error throws an ApiException
                            - -
                            - - - - - - -
                            -

                            - Properties - -

                            -
                            -

                            - $baseUrl - - - -

                            - - - - - protected - string - $baseUrl - - - - - - -
                            - - -
                            - -
                            -

                            - Methods - -

                            -
                            -

                            - countItems() - -

                            - - -

                            Given a hashId and indexName, returns the total number of items in the index.

                            - - - public - countItems(string $hashId, string $indexName) : HttpResponseInterface - - -
                            Parameters
                            -
                            -
                            - $hashId - : string -
                            -
                            - -
                            -
                            - $indexName - : string -
                            -
                            - -
                            -
                            - - -
                            - Tags - -
                            -
                            -
                            - throws -
                            -
                            - ApiException - - -
                            -
                            - -
                            Return values
                            - HttpResponseInterface - — - - -
                            - -
                            -

                            - createItem() - -

                            - - -

                            Given a hashId, index name and item data, creates a new item

                            - - - public - createItem(string $hashId, string $indexName, array<string|int, mixed> $params) : HttpResponseInterface - - -
                            Parameters
                            -
                            -
                            - $hashId - : string -
                            -
                            - -
                            -
                            - $indexName - : string -
                            -
                            - -
                            -
                            - $params - : array<string|int, mixed> -
                            -
                            - -
                            -
                            - - -
                            - Tags - -
                            -
                            -
                            - throws -
                            -
                            - ApiException - - -
                            -
                            - -
                            Return values
                            - HttpResponseInterface - — - - -
                            -
                            -

                            - createItemInTemporalIndex() - -

                            - - -

                            Given a hashId, index name and item data, creates a new item in temporal index

                            - - - public - createItemInTemporalIndex(string $hashId, string $indexName, array<string|int, mixed> $params) : HttpResponseInterface - - -
                            Parameters
                            -
                            -
                            - $hashId - : string -
                            -
                            - -
                            -
                            - $indexName - : string -
                            -
                            - -
                            -
                            - $params - : array<string|int, mixed> -
                            -
                            - -
                            -
                            - - -
                            - Tags - -
                            -
                            -
                            - throws -
                            -
                            - ApiException - - -
                            -
                            - -
                            Return values
                            - HttpResponseInterface - — - - -
                            -
                            -

                            - createItemsInBulk() - -

                            - - -

                            Given a hashId, index name and items data, creates new items in index

                            - - - public - createItemsInBulk(string $hashId, string $indexName, array<string|int, mixed> $params) : HttpResponseInterface - - -
                            Parameters
                            -
                            -
                            - $hashId - : string -
                            -
                            - -
                            -
                            - $indexName - : string -
                            -
                            - -
                            -
                            - $params - : array<string|int, mixed> -
                            -
                            - -
                            -
                            - - -
                            - Tags - -
                            -
                            -
                            - throws -
                            -
                            - ApiException - - -
                            -
                            - -
                            Return values
                            - HttpResponseInterface - — - - -
                            -
                            -

                            - createItemsInBulkInTemporalIndex() - -

                            - - -

                            Given a hashId, index name and items data, creates new items in temporal index

                            - - - public - createItemsInBulkInTemporalIndex(string $hashId, string $indexName, array<string|int, mixed> $params) : HttpResponseInterface - - -
                            Parameters
                            -
                            -
                            - $hashId - : string -
                            -
                            - -
                            -
                            - $indexName - : string -
                            -
                            - -
                            -
                            - $params - : array<string|int, mixed> -
                            -
                            - -
                            -
                            - - -
                            - Tags - -
                            -
                            -
                            - throws -
                            -
                            - ApiException - - -
                            -
                            - -
                            Return values
                            - HttpResponseInterface - — - - -
                            -
                            -

                            - deleteItem() - -

                            - - -

                            Given a hashId, indexName and item id, deletes an item

                            - - - public - deleteItem(string $hashId, string $indexName, string $itemId) : HttpResponseInterface - - -
                            Parameters
                            -
                            -
                            - $hashId - : string -
                            -
                            - -
                            -
                            - $indexName - : string -
                            -
                            - -
                            -
                            - $itemId - : string -
                            -
                            - -
                            -
                            - - -
                            - Tags - -
                            -
                            -
                            - throws -
                            -
                            - ApiException - - -
                            -
                            - -
                            Return values
                            - HttpResponseInterface - — - - -
                            -
                            -

                            - deleteItemFromTemporalIndex() - -

                            - - -

                            Given a hashId, indexName and item id, deletes an item from temporal index

                            - - - public - deleteItemFromTemporalIndex(string $hashId, string $indexName, string $itemId) : HttpResponseInterface - - -
                            Parameters
                            -
                            -
                            - $hashId - : string -
                            -
                            - -
                            -
                            - $indexName - : string -
                            -
                            - -
                            -
                            - $itemId - : string -
                            -
                            - -
                            -
                            - - -
                            - Tags - -
                            -
                            -
                            - throws -
                            -
                            - ApiException - - -
                            -
                            - -
                            Return values
                            - HttpResponseInterface - — - - -
                            -
                            -

                            - deleteItemsInBulk() - -

                            - - -

                            Given a hashId, index name and items id, deletes items in index

                            - - - public - deleteItemsInBulk(string $hashId, string $indexName, array<string|int, mixed> $params) : HttpResponseInterface - - -
                            Parameters
                            -
                            -
                            - $hashId - : string -
                            -
                            - -
                            -
                            - $indexName - : string -
                            -
                            - -
                            -
                            - $params - : array<string|int, mixed> -
                            -
                            - -
                            -
                            - - -
                            - Tags - -
                            -
                            -
                            - throws -
                            -
                            - ApiException - - -
                            -
                            - -
                            Return values
                            - HttpResponseInterface - — - - -
                            -
                            -

                            - deleteItemsInBulkInTemporalIndex() - -

                            - - -

                            Given a hashId, index name and items id, deletes items in temporal index

                            - - - public - deleteItemsInBulkInTemporalIndex(string $hashId, string $indexName, array<string|int, mixed> $params) : HttpResponseInterface - - -
                            Parameters
                            -
                            -
                            - $hashId - : string -
                            -
                            - -
                            -
                            - $indexName - : string -
                            -
                            - -
                            -
                            - $params - : array<string|int, mixed> -
                            -
                            - -
                            -
                            - - -
                            - Tags - -
                            -
                            -
                            - throws -
                            -
                            - ApiException - - -
                            -
                            - -
                            Return values
                            - HttpResponseInterface - — - - -
                            -
                            -

                            - findItems() - -

                            - - -

                            Given a hashId, indexName and params, it gets an item list

                            - - - public - findItems(string $hashId, string $indexName, array<string|int, mixed> $params) : HttpResponseInterface - - -
                            Parameters
                            -
                            -
                            - $hashId - : string -
                            -
                            - -
                            -
                            - $indexName - : string -
                            -
                            - -
                            -
                            - $params - : array<string|int, mixed> -
                            -
                            - -
                            -
                            - - -
                            - Tags - -
                            -
                            -
                            - throws -
                            -
                            - ApiException - - -
                            -
                            - -
                            Return values
                            - HttpResponseInterface - — - - -
                            -
                            -

                            - findItemsFromTemporalIndex() - -

                            - - -

                            Given a hashId, indexName and params, it gets an item list from temporal index

                            - - - public - findItemsFromTemporalIndex(string $hashId, string $indexName, array<string|int, mixed> $params) : HttpResponseInterface - - -
                            Parameters
                            -
                            -
                            - $hashId - : string -
                            -
                            - -
                            -
                            - $indexName - : string -
                            -
                            - -
                            -
                            - $params - : array<string|int, mixed> -
                            -
                            - -
                            -
                            - - -
                            - Tags - -
                            -
                            -
                            - throws -
                            -
                            - ApiException - - -
                            -
                            - -
                            Return values
                            - HttpResponseInterface - — - - -
                            -
                            -

                            - getItem() - -

                            - - -

                            Given a hashId, indexName and item id, it gets an item

                            - - - public - getItem(string $hashId, string $indexName, string $itemId) : HttpResponseInterface - - -
                            Parameters
                            -
                            -
                            - $hashId - : string -
                            -
                            - -
                            -
                            - $indexName - : string -
                            -
                            - -
                            -
                            - $itemId - : string -
                            -
                            - -
                            -
                            - - -
                            - Tags - -
                            -
                            -
                            - throws -
                            -
                            - ApiException - - -
                            -
                            - -
                            Return values
                            - HttpResponseInterface - — - - -
                            -
                            -

                            - getItemFromTemporalIndex() - -

                            - - -

                            Given a hashId, indexName and item id, it gets an item from temporal index

                            - - - public - getItemFromTemporalIndex(string $hashId, string $indexName, string $itemId) : HttpResponseInterface - - -
                            Parameters
                            -
                            -
                            - $hashId - : string -
                            -
                            - -
                            -
                            - $indexName - : string -
                            -
                            - -
                            -
                            - $itemId - : string -
                            -
                            - -
                            -
                            - - -
                            - Tags - -
                            -
                            -
                            - throws -
                            -
                            - ApiException - - -
                            -
                            - -
                            Return values
                            - HttpResponseInterface - — - - -
                            -
                            -

                            - getUrl() - -

                            - - - - - public - abstract getUrl() : string - - - - - -
                            Return values
                            - string - — - - -
                            -
                            -

                            - scrollIndex() - -

                            - - -

                            Given a hashId and index name, scrolls index

                            - - - public - scrollIndex(string $hashId, string $indexName, mixed $params) : HttpResponseInterface - - -
                            Parameters
                            -
                            -
                            - $hashId - : string -
                            -
                            - -
                            -
                            - $indexName - : string -
                            -
                            - -
                            -
                            - $params - : mixed -
                            -
                            -
                            - -
                            -
                            - - -
                            - Tags - -
                            -
                            -
                            - throws -
                            -
                            - ApiException - - -
                            -
                            - -
                            Return values
                            - HttpResponseInterface - — - - -
                            -
                            -

                            - updateItem() - -

                            - - -

                            Given a hashId, indexName, item id and data, updates an item

                            - - - public - updateItem(string $hashId, string $indexName, string $itemId, array<string|int, mixed> $params) : HttpResponseInterface - - -
                            Parameters
                            -
                            -
                            - $hashId - : string -
                            -
                            - -
                            -
                            - $indexName - : string -
                            -
                            - -
                            -
                            - $itemId - : string -
                            -
                            - -
                            -
                            - $params - : array<string|int, mixed> -
                            -
                            - -
                            -
                            - - -
                            - Tags - -
                            -
                            -
                            - throws -
                            -
                            - ApiException - - -
                            -
                            - -
                            Return values
                            - HttpResponseInterface - — - - -
                            -
                            -

                            - updateItemInTemporalIndex() - -

                            - - -

                            Given a hashId, indexName, item id and data, updates an item in temporal index

                            - - - public - updateItemInTemporalIndex(string $hashId, string $indexName, string $itemId, array<string|int, mixed> $params) : HttpResponseInterface - - -
                            Parameters
                            -
                            -
                            - $hashId - : string -
                            -
                            - -
                            -
                            - $indexName - : string -
                            -
                            - -
                            -
                            - $itemId - : string -
                            -
                            - -
                            -
                            - $params - : array<string|int, mixed> -
                            -
                            - -
                            -
                            - - -
                            - Tags - -
                            -
                            -
                            - throws -
                            -
                            - ApiException - - -
                            -
                            - -
                            Return values
                            - HttpResponseInterface - — - - -
                            -
                            -

                            - updateItemsInBulk() - -

                            - - -

                            Given a hashId, index name and items data, updates items in index

                            - - - public - updateItemsInBulk(string $hashId, string $indexName, array<string|int, mixed> $params) : HttpResponseInterface - - -
                            Parameters
                            -
                            -
                            - $hashId - : string -
                            -
                            - -
                            -
                            - $indexName - : string -
                            -
                            - -
                            -
                            - $params - : array<string|int, mixed> -
                            -
                            - -
                            -
                            - - -
                            - Tags - -
                            -
                            -
                            - throws -
                            -
                            - ApiException - - -
                            -
                            - -
                            Return values
                            - HttpResponseInterface - — - - -
                            -
                            -

                            - updateItemsInBulkInTemporalIndex() - -

                            - - -

                            Given a hashId, index name and items data, updates items in temporal index

                            - - - public - updateItemsInBulkInTemporalIndex(string $hashId, string $indexName, array<string|int, mixed> $params) : HttpResponseInterface - - -
                            Parameters
                            -
                            -
                            - $hashId - : string -
                            -
                            - -
                            -
                            - $indexName - : string -
                            -
                            - -
                            -
                            - $params - : array<string|int, mixed> -
                            -
                            - -
                            -
                            - - -
                            - Tags - -
                            -
                            -
                            - throws -
                            -
                            - ApiException - - -
                            -
                            - -
                            Return values
                            - HttpResponseInterface - — - - -
                            - -
                            -

                            - requestWithJwt() - -

                            - - -

                            It does a http request with Jwt authentication. If there is an error throws an ApiException

                            - - - protected - requestWithJwt(string $url, string $method[, class-string<\Doofinder\Shared\Interfaces\ModelInterface> $model = null ][, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $headers = [] ]) : HttpResponseInterface - - -
                            Parameters
                            -
                            -
                            - $url - : string -
                            -
                            - -
                            -
                            - $method - : string -
                            -
                            - -
                            -
                            - $model - : class-string<\Doofinder\Shared\Interfaces\ModelInterface> - = null
                            -
                            - -
                            -
                            - $params - : array<string|int, mixed> - = []
                            -
                            - -
                            -
                            - $headers - : array<string|int, mixed> - = []
                            -
                            - -
                            -
                            - - -
                            - Tags - -
                            -
                            -
                            - throws -
                            -
                            - ApiException - - -
                            -
                            - -
                            Return values
                            - HttpResponseInterface - — - - -
                            -
                            -

                            - requestWithToken() - -

                            - - -

                            It does a http request with Token authentication. If there is an error throws an ApiException

                            - - - protected - requestWithToken(string $url, string $method[, class-string<\Doofinder\Shared\Interfaces\ModelInterface> $model = null ][, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $headers = [] ]) : HttpResponseInterface - - -
                            Parameters
                            -
                            -
                            - $url - : string -
                            -
                            - -
                            -
                            - $method - : string -
                            -
                            - -
                            -
                            - $model - : class-string<\Doofinder\Shared\Interfaces\ModelInterface> - = null
                            -
                            - -
                            -
                            - $params - : array<string|int, mixed> - = []
                            -
                            - -
                            -
                            - $headers - : array<string|int, mixed> - = []
                            -
                            - -
                            -
                            - - -
                            - Tags - -
                            -
                            -
                            - throws -
                            -
                            - ApiException - - -
                            -
                            - -
                            Return values
                            - HttpResponseInterface - — - - -
                            -
                            -

                            - getBaseUrl() - -

                            - - - - - private - getBaseUrl(string $hashId, string $indexName[, string|null $itemId = null ][, bool $isTemporalIndex = false ]) : string - - -
                            Parameters
                            -
                            -
                            - $hashId - : string -
                            -
                            - -
                            -
                            - $indexName - : string -
                            -
                            - -
                            -
                            - $itemId - : string|null - = null
                            -
                            - -
                            -
                            - $isTemporalIndex - : bool - = false
                            -
                            - -
                            -
                            - - - -
                            Return values
                            - string - — - - -
                            -
                            -

                            - request() - -

                            - - -

                            It does a http request. If there is an error throws an ApiException

                            - - - private - request(string $url, string $method[, class-string<\Doofinder\Shared\Interfaces\ModelInterface> $model = null ][, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $headers = [] ]) : HttpResponseInterface - - -
                            Parameters
                            -
                            -
                            - $url - : string -
                            -
                            - -
                            -
                            - $method - : string -
                            -
                            - -
                            -
                            - $model - : class-string<\Doofinder\Shared\Interfaces\ModelInterface> - = null
                            -
                            - -
                            -
                            - $params - : array<string|int, mixed> - = []
                            -
                            - -
                            -
                            - $headers - : array<string|int, mixed> - = []
                            -
                            - -
                            -
                            - - -
                            - Tags - -
                            -
                            -
                            - throws -
                            -
                            - ApiException - - -
                            -
                            - -
                            Return values
                            - HttpResponseInterface - — - - -
                            -
                            - - - - -
                            -
                            -
                            -
                            -

                            Search results

                            - -
                            -
                            -
                              -
                              -
                              -
                              -
                              -
                              - - -
                              - - - - - - - - diff --git a/doc/classes/Doofinder-Management-Resources-ManagementResource.html b/doc/classes/Doofinder-Management-Resources-ManagementResource.html deleted file mode 100644 index daed4fb..0000000 --- a/doc/classes/Doofinder-Management-Resources-ManagementResource.html +++ /dev/null @@ -1,739 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                              -

                              Documentation

                              - - - - - -
                              - -
                              -
                              - - - - -
                              - - -
                              -

                              - ManagementResource - - - extends Resource - - -
                              - in package - -
                              - - -

                              - - - -

                              A resource class is in charge to communicate with the API and return a formatted response

                              - - - - - - - - - -

                              - Table of Contents - -

                              - -
                              -
                              - $baseUrl - -  : string -
                              -
                              - -
                              - $config - -  : Configuration -
                              -
                              - -
                              - $httpClient - -  : HttpClientInterface -
                              -
                              - -
                              - getUrl() - -  : string -
                              -
                              Returns versioned url
                              - -
                              - __construct() - -  : mixed -
                              -
                              - -
                              - requestWithJwt() - -  : HttpResponseInterface -
                              -
                              It does a http request with Jwt authentication. If there is an error throws an ApiException
                              - -
                              - requestWithToken() - -  : HttpResponseInterface -
                              -
                              It does a http request with Token authentication. If there is an error throws an ApiException
                              - -
                              - request() - -  : HttpResponseInterface -
                              -
                              It does a http request. If there is an error throws an ApiException
                              - -
                              - - - - - - -
                              -

                              - Properties - -

                              -
                              -

                              - $baseUrl - - - -

                              - - - - - protected - string - $baseUrl - - - - - - -
                              - - -
                              - -
                              -

                              - Methods - -

                              -
                              -

                              - getUrl() - -

                              - - -

                              Returns versioned url

                              - - - public - getUrl() : string - - - - - -
                              Return values
                              - string - — - - -
                              - -
                              -

                              - requestWithJwt() - -

                              - - -

                              It does a http request with Jwt authentication. If there is an error throws an ApiException

                              - - - protected - requestWithJwt(string $url, string $method[, class-string<\Doofinder\Shared\Interfaces\ModelInterface> $model = null ][, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $headers = [] ]) : HttpResponseInterface - - -
                              Parameters
                              -
                              -
                              - $url - : string -
                              -
                              - -
                              -
                              - $method - : string -
                              -
                              - -
                              -
                              - $model - : class-string<\Doofinder\Shared\Interfaces\ModelInterface> - = null
                              -
                              - -
                              -
                              - $params - : array<string|int, mixed> - = []
                              -
                              - -
                              -
                              - $headers - : array<string|int, mixed> - = []
                              -
                              - -
                              -
                              - - -
                              - Tags - -
                              -
                              -
                              - throws -
                              -
                              - ApiException - - -
                              -
                              - -
                              Return values
                              - HttpResponseInterface - — - - -
                              -
                              -

                              - requestWithToken() - -

                              - - -

                              It does a http request with Token authentication. If there is an error throws an ApiException

                              - - - protected - requestWithToken(string $url, string $method[, class-string<\Doofinder\Shared\Interfaces\ModelInterface> $model = null ][, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $headers = [] ]) : HttpResponseInterface - - -
                              Parameters
                              -
                              -
                              - $url - : string -
                              -
                              - -
                              -
                              - $method - : string -
                              -
                              - -
                              -
                              - $model - : class-string<\Doofinder\Shared\Interfaces\ModelInterface> - = null
                              -
                              - -
                              -
                              - $params - : array<string|int, mixed> - = []
                              -
                              - -
                              -
                              - $headers - : array<string|int, mixed> - = []
                              -
                              - -
                              -
                              - - -
                              - Tags - -
                              -
                              -
                              - throws -
                              -
                              - ApiException - - -
                              -
                              - -
                              Return values
                              - HttpResponseInterface - — - - -
                              -
                              -

                              - request() - -

                              - - -

                              It does a http request. If there is an error throws an ApiException

                              - - - private - request(string $url, string $method[, class-string<\Doofinder\Shared\Interfaces\ModelInterface> $model = null ][, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $headers = [] ]) : HttpResponseInterface - - -
                              Parameters
                              -
                              -
                              - $url - : string -
                              -
                              - -
                              -
                              - $method - : string -
                              -
                              - -
                              -
                              - $model - : class-string<\Doofinder\Shared\Interfaces\ModelInterface> - = null
                              -
                              - -
                              -
                              - $params - : array<string|int, mixed> - = []
                              -
                              - -
                              -
                              - $headers - : array<string|int, mixed> - = []
                              -
                              - -
                              -
                              - - -
                              - Tags - -
                              -
                              -
                              - throws -
                              -
                              - ApiException - - -
                              -
                              - -
                              Return values
                              - HttpResponseInterface - — - - -
                              -
                              - - - - -
                              -
                              -
                              -
                              -

                              Search results

                              - -
                              -
                              -
                                -
                                -
                                -
                                -
                                -
                                - - -
                                - - - - - - - - diff --git a/doc/classes/Doofinder-Management-Resources-SearchEngine.html b/doc/classes/Doofinder-Management-Resources-SearchEngine.html deleted file mode 100644 index 9800691..0000000 --- a/doc/classes/Doofinder-Management-Resources-SearchEngine.html +++ /dev/null @@ -1,1295 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                -

                                Documentation

                                - - - - - -
                                - -
                                -
                                - - - - -
                                - - -
                                -

                                - SearchEngine - - - extends ManagementResource - - -
                                - in package - -
                                - - -

                                - - - -

                                SearchEngines class is responsible for making the requests to the search_engine's endpoints and return a response

                                - - - - - - - - - -

                                - Table of Contents - -

                                - -
                                -
                                - $baseUrl - -  : string -
                                -
                                - -
                                - $config - -  : Configuration -
                                -
                                - -
                                - $httpClient - -  : HttpClientInterface -
                                -
                                - -
                                - create() - -  : SearchEngine -
                                -
                                - -
                                - createSearchEngine() - -  : HttpResponseInterface -
                                -
                                Creates a new search engine
                                - -
                                - deleteSearchEngine() - -  : HttpResponseInterface -
                                -
                                Given a hashId deletes a search engine
                                - -
                                - getSearchEngine() - -  : HttpResponseInterface -
                                -
                                Given a hashId gets a search engine
                                - -
                                - getSearchEngineProcessStatus() - -  : HttpResponseInterface -
                                -
                                Given a hashId gets the status of the last process task.
                                - -
                                - getUrl() - -  : string -
                                -
                                - -
                                - listSearchEngines() - -  : HttpResponseInterface -
                                -
                                List a user's search engines
                                - -
                                - processSearchEngine() - -  : HttpResponseInterface -
                                -
                                Given a hashId schedules a task for processing all search engine's data sources.
                                - -
                                - updateSearchEngine() - -  : HttpResponseInterface -
                                -
                                Given a hashId and data updates a search engine
                                - -
                                - __construct() - -  : mixed -
                                -
                                - -
                                - requestWithJwt() - -  : HttpResponseInterface -
                                -
                                It does a http request with Jwt authentication. If there is an error throws an ApiException
                                - -
                                - requestWithToken() - -  : HttpResponseInterface -
                                -
                                It does a http request with Token authentication. If there is an error throws an ApiException
                                - -
                                - getBaseUrl() - -  : string -
                                -
                                - -
                                - request() - -  : HttpResponseInterface -
                                -
                                It does a http request. If there is an error throws an ApiException
                                - -
                                - - - - - - -
                                -

                                - Properties - -

                                -
                                -

                                - $baseUrl - - - -

                                - - - - - protected - string - $baseUrl - - - - - - -
                                - - -
                                - -
                                -

                                - Methods - -

                                - -
                                -

                                - createSearchEngine() - -

                                - - -

                                Creates a new search engine

                                - - - public - createSearchEngine(array<string|int, mixed> $params) : HttpResponseInterface - - -
                                Parameters
                                -
                                -
                                - $params - : array<string|int, mixed> -
                                -
                                - -
                                -
                                - - -
                                - Tags - -
                                -
                                -
                                - throws -
                                -
                                - ApiException - - -
                                -
                                - -
                                Return values
                                - HttpResponseInterface - — - - -
                                - - -
                                -

                                - getSearchEngineProcessStatus() - -

                                - - -

                                Given a hashId gets the status of the last process task.

                                - - - public - getSearchEngineProcessStatus(string $hashId) : HttpResponseInterface - - -
                                Parameters
                                -
                                -
                                - $hashId - : string -
                                -
                                - -
                                -
                                - - -
                                - Tags - -
                                -
                                -
                                - throws -
                                -
                                - ApiException - - -
                                -
                                - -
                                Return values
                                - HttpResponseInterface - — - - -
                                -
                                -

                                - getUrl() - -

                                - - - - - public - abstract getUrl() : string - - - - - -
                                Return values
                                - string - — - - -
                                - -
                                -

                                - processSearchEngine() - -

                                - - -

                                Given a hashId schedules a task for processing all search engine's data sources.

                                - - - public - processSearchEngine(string $hashId, array<string|int, mixed> $params) : HttpResponseInterface - - -
                                Parameters
                                -
                                -
                                - $hashId - : string -
                                -
                                - -
                                -
                                - $params - : array<string|int, mixed> -
                                -
                                - -
                                -
                                - - -
                                - Tags - -
                                -
                                -
                                - throws -
                                -
                                - ApiException - - -
                                -
                                - -
                                Return values
                                - HttpResponseInterface - — - - -
                                -
                                -

                                - updateSearchEngine() - -

                                - - -

                                Given a hashId and data updates a search engine

                                - - - public - updateSearchEngine(string $hashId, array<string|int, mixed> $params) : HttpResponseInterface - - -
                                Parameters
                                -
                                -
                                - $hashId - : string -
                                -
                                - -
                                -
                                - $params - : array<string|int, mixed> -
                                -
                                - -
                                -
                                - - -
                                - Tags - -
                                -
                                -
                                - throws -
                                -
                                - ApiException - - -
                                -
                                - -
                                Return values
                                - HttpResponseInterface - — - - -
                                - -
                                -

                                - requestWithJwt() - -

                                - - -

                                It does a http request with Jwt authentication. If there is an error throws an ApiException

                                - - - protected - requestWithJwt(string $url, string $method[, class-string<\Doofinder\Shared\Interfaces\ModelInterface> $model = null ][, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $headers = [] ]) : HttpResponseInterface - - -
                                Parameters
                                -
                                -
                                - $url - : string -
                                -
                                - -
                                -
                                - $method - : string -
                                -
                                - -
                                -
                                - $model - : class-string<\Doofinder\Shared\Interfaces\ModelInterface> - = null
                                -
                                - -
                                -
                                - $params - : array<string|int, mixed> - = []
                                -
                                - -
                                -
                                - $headers - : array<string|int, mixed> - = []
                                -
                                - -
                                -
                                - - -
                                - Tags - -
                                -
                                -
                                - throws -
                                -
                                - ApiException - - -
                                -
                                - -
                                Return values
                                - HttpResponseInterface - — - - -
                                -
                                -

                                - requestWithToken() - -

                                - - -

                                It does a http request with Token authentication. If there is an error throws an ApiException

                                - - - protected - requestWithToken(string $url, string $method[, class-string<\Doofinder\Shared\Interfaces\ModelInterface> $model = null ][, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $headers = [] ]) : HttpResponseInterface - - -
                                Parameters
                                -
                                -
                                - $url - : string -
                                -
                                - -
                                -
                                - $method - : string -
                                -
                                - -
                                -
                                - $model - : class-string<\Doofinder\Shared\Interfaces\ModelInterface> - = null
                                -
                                - -
                                -
                                - $params - : array<string|int, mixed> - = []
                                -
                                - -
                                -
                                - $headers - : array<string|int, mixed> - = []
                                -
                                - -
                                -
                                - - -
                                - Tags - -
                                -
                                -
                                - throws -
                                -
                                - ApiException - - -
                                -
                                - -
                                Return values
                                - HttpResponseInterface - — - - -
                                -
                                -

                                - getBaseUrl() - -

                                - - - - - private - getBaseUrl([string|null $hashId = null ]) : string - - -
                                Parameters
                                -
                                -
                                - $hashId - : string|null - = null
                                -
                                - -
                                -
                                - - - -
                                Return values
                                - string - — - - -
                                -
                                -

                                - request() - -

                                - - -

                                It does a http request. If there is an error throws an ApiException

                                - - - private - request(string $url, string $method[, class-string<\Doofinder\Shared\Interfaces\ModelInterface> $model = null ][, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $headers = [] ]) : HttpResponseInterface - - -
                                Parameters
                                -
                                -
                                - $url - : string -
                                -
                                - -
                                -
                                - $method - : string -
                                -
                                - -
                                -
                                - $model - : class-string<\Doofinder\Shared\Interfaces\ModelInterface> - = null
                                -
                                - -
                                -
                                - $params - : array<string|int, mixed> - = []
                                -
                                - -
                                -
                                - $headers - : array<string|int, mixed> - = []
                                -
                                - -
                                -
                                - - -
                                - Tags - -
                                -
                                -
                                - throws -
                                -
                                - ApiException - - -
                                -
                                - -
                                Return values
                                - HttpResponseInterface - — - - -
                                -
                                - - - - -
                                -
                                -
                                -
                                -

                                Search results

                                - -
                                -
                                -
                                  -
                                  -
                                  -
                                  -
                                  -
                                  - - -
                                  - - - - - - - - diff --git a/doc/classes/Doofinder-Search-Resources-Search.html b/doc/classes/Doofinder-Search-Resources-Search.html deleted file mode 100644 index 243e1e3..0000000 --- a/doc/classes/Doofinder-Search-Resources-Search.html +++ /dev/null @@ -1,985 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                  -

                                  Documentation

                                  - - - - - -
                                  - -
                                  -
                                  - - - - -
                                  - - -
                                  -

                                  - Search - - - extends SearchResource - - -
                                  - in package - -
                                  - - -

                                  - - - -

                                  Search class is responsible for making the requests to the search's endpoint and return a response

                                  - - - - - - - - - -

                                  - Table of Contents - -

                                  - -
                                  -
                                  - $baseUrl - -  : string -
                                  -
                                  - -
                                  - $config - -  : Configuration -
                                  -
                                  - -
                                  - $httpClient - -  : HttpClientInterface -
                                  -
                                  - -
                                  - create() - -  : Search -
                                  -
                                  - -
                                  - getUrl() - -  : string -
                                  -
                                  - -
                                  - search() - -  : HttpResponseInterface -
                                  -
                                  Given a hashId and search params, makes a search
                                  - -
                                  - suggest() - -  : HttpResponseInterface -
                                  -
                                  Given a hashId and suggest params, it returns a suggest list
                                  - -
                                  - __construct() - -  : mixed -
                                  -
                                  - -
                                  - requestWithJwt() - -  : HttpResponseInterface -
                                  -
                                  It does a http request with Jwt authentication. If there is an error throws an ApiException
                                  - -
                                  - requestWithToken() - -  : HttpResponseInterface -
                                  -
                                  It does a http request with Token authentication. If there is an error throws an ApiException
                                  - -
                                  - getBaseUrl() - -  : string -
                                  -
                                  - -
                                  - request() - -  : HttpResponseInterface -
                                  -
                                  It does a http request. If there is an error throws an ApiException
                                  - -
                                  - - - - - - -
                                  -

                                  - Properties - -

                                  -
                                  -

                                  - $baseUrl - - - -

                                  - - - - - protected - string - $baseUrl - - - - - - -
                                  - - -
                                  - -
                                  -

                                  - Methods - -

                                  - -
                                  -

                                  - getUrl() - -

                                  - - - - - public - abstract getUrl() : string - - - - - -
                                  Return values
                                  - string - — - - -
                                  -
                                  - - - -

                                  Given a hashId and search params, makes a search

                                  - - - public - search(string $hashId, array<string|int, mixed> $params) : HttpResponseInterface - - -
                                  Parameters
                                  -
                                  -
                                  - $hashId - : string -
                                  -
                                  - -
                                  -
                                  - $params - : array<string|int, mixed> -
                                  -
                                  - -
                                  -
                                  - - -
                                  - Tags - -
                                  -
                                  -
                                  - throws -
                                  -
                                  - ApiException - - -
                                  -
                                  - -
                                  Return values
                                  - HttpResponseInterface - — - - -
                                  -
                                  -

                                  - suggest() - -

                                  - - -

                                  Given a hashId and suggest params, it returns a suggest list

                                  - - - public - suggest(string $hashId, array<string|int, mixed> $params) : HttpResponseInterface - - -
                                  Parameters
                                  -
                                  -
                                  - $hashId - : string -
                                  -
                                  - -
                                  -
                                  - $params - : array<string|int, mixed> -
                                  -
                                  - -
                                  -
                                  - - -
                                  - Tags - -
                                  -
                                  -
                                  - throws -
                                  -
                                  - ApiException - - -
                                  -
                                  - -
                                  Return values
                                  - HttpResponseInterface - — - - -
                                  - -
                                  -

                                  - requestWithJwt() - -

                                  - - -

                                  It does a http request with Jwt authentication. If there is an error throws an ApiException

                                  - - - protected - requestWithJwt(string $url, string $method[, class-string<\Doofinder\Shared\Interfaces\ModelInterface> $model = null ][, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $headers = [] ]) : HttpResponseInterface - - -
                                  Parameters
                                  -
                                  -
                                  - $url - : string -
                                  -
                                  - -
                                  -
                                  - $method - : string -
                                  -
                                  - -
                                  -
                                  - $model - : class-string<\Doofinder\Shared\Interfaces\ModelInterface> - = null
                                  -
                                  - -
                                  -
                                  - $params - : array<string|int, mixed> - = []
                                  -
                                  - -
                                  -
                                  - $headers - : array<string|int, mixed> - = []
                                  -
                                  - -
                                  -
                                  - - -
                                  - Tags - -
                                  -
                                  -
                                  - throws -
                                  -
                                  - ApiException - - -
                                  -
                                  - -
                                  Return values
                                  - HttpResponseInterface - — - - -
                                  -
                                  -

                                  - requestWithToken() - -

                                  - - -

                                  It does a http request with Token authentication. If there is an error throws an ApiException

                                  - - - protected - requestWithToken(string $url, string $method[, class-string<\Doofinder\Shared\Interfaces\ModelInterface> $model = null ][, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $headers = [] ]) : HttpResponseInterface - - -
                                  Parameters
                                  -
                                  -
                                  - $url - : string -
                                  -
                                  - -
                                  -
                                  - $method - : string -
                                  -
                                  - -
                                  -
                                  - $model - : class-string<\Doofinder\Shared\Interfaces\ModelInterface> - = null
                                  -
                                  - -
                                  -
                                  - $params - : array<string|int, mixed> - = []
                                  -
                                  - -
                                  -
                                  - $headers - : array<string|int, mixed> - = []
                                  -
                                  - -
                                  -
                                  - - -
                                  - Tags - -
                                  -
                                  -
                                  - throws -
                                  -
                                  - ApiException - - -
                                  -
                                  - -
                                  Return values
                                  - HttpResponseInterface - — - - -
                                  -
                                  -

                                  - getBaseUrl() - -

                                  - - - - - private - getBaseUrl(string $hashId) : string - - -
                                  Parameters
                                  -
                                  -
                                  - $hashId - : string -
                                  -
                                  - -
                                  -
                                  - - - -
                                  Return values
                                  - string - — - - -
                                  -
                                  -

                                  - request() - -

                                  - - -

                                  It does a http request. If there is an error throws an ApiException

                                  - - - private - request(string $url, string $method[, class-string<\Doofinder\Shared\Interfaces\ModelInterface> $model = null ][, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $headers = [] ]) : HttpResponseInterface - - -
                                  Parameters
                                  -
                                  -
                                  - $url - : string -
                                  -
                                  - -
                                  -
                                  - $method - : string -
                                  -
                                  - -
                                  -
                                  - $model - : class-string<\Doofinder\Shared\Interfaces\ModelInterface> - = null
                                  -
                                  - -
                                  -
                                  - $params - : array<string|int, mixed> - = []
                                  -
                                  - -
                                  -
                                  - $headers - : array<string|int, mixed> - = []
                                  -
                                  - -
                                  -
                                  - - -
                                  - Tags - -
                                  -
                                  -
                                  - throws -
                                  -
                                  - ApiException - - -
                                  -
                                  - -
                                  Return values
                                  - HttpResponseInterface - — - - -
                                  -
                                  - - - - -
                                  -
                                  -
                                  -
                                  -

                                  Search results

                                  - -
                                  -
                                  -
                                    -
                                    -
                                    -
                                    -
                                    -
                                    - - -
                                    - - - - - - - - diff --git a/doc/classes/Doofinder-Search-Resources-SearchResource.html b/doc/classes/Doofinder-Search-Resources-SearchResource.html deleted file mode 100644 index afe0783..0000000 --- a/doc/classes/Doofinder-Search-Resources-SearchResource.html +++ /dev/null @@ -1,739 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                    -

                                    Documentation

                                    - - - - - -
                                    - -
                                    -
                                    - - - - -
                                    - - -
                                    -

                                    - SearchResource - - - extends Resource - - -
                                    - in package - -
                                    - - -

                                    - - - -

                                    A resource class is in charge to communicate with the API and return a formatted response

                                    - - - - - - - - - -

                                    - Table of Contents - -

                                    - -
                                    -
                                    - $baseUrl - -  : string -
                                    -
                                    - -
                                    - $config - -  : Configuration -
                                    -
                                    - -
                                    - $httpClient - -  : HttpClientInterface -
                                    -
                                    - -
                                    - getUrl() - -  : string -
                                    -
                                    Returns versioned url
                                    - -
                                    - __construct() - -  : mixed -
                                    -
                                    - -
                                    - requestWithJwt() - -  : HttpResponseInterface -
                                    -
                                    It does a http request with Jwt authentication. If there is an error throws an ApiException
                                    - -
                                    - requestWithToken() - -  : HttpResponseInterface -
                                    -
                                    It does a http request with Token authentication. If there is an error throws an ApiException
                                    - -
                                    - request() - -  : HttpResponseInterface -
                                    -
                                    It does a http request. If there is an error throws an ApiException
                                    - -
                                    - - - - - - -
                                    -

                                    - Properties - -

                                    -
                                    -

                                    - $baseUrl - - - -

                                    - - - - - protected - string - $baseUrl - - - - - - -
                                    - - -
                                    - -
                                    -

                                    - Methods - -

                                    -
                                    -

                                    - getUrl() - -

                                    - - -

                                    Returns versioned url

                                    - - - public - getUrl() : string - - - - - -
                                    Return values
                                    - string - — - - -
                                    - -
                                    -

                                    - requestWithJwt() - -

                                    - - -

                                    It does a http request with Jwt authentication. If there is an error throws an ApiException

                                    - - - protected - requestWithJwt(string $url, string $method[, class-string<\Doofinder\Shared\Interfaces\ModelInterface> $model = null ][, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $headers = [] ]) : HttpResponseInterface - - -
                                    Parameters
                                    -
                                    -
                                    - $url - : string -
                                    -
                                    - -
                                    -
                                    - $method - : string -
                                    -
                                    - -
                                    -
                                    - $model - : class-string<\Doofinder\Shared\Interfaces\ModelInterface> - = null
                                    -
                                    - -
                                    -
                                    - $params - : array<string|int, mixed> - = []
                                    -
                                    - -
                                    -
                                    - $headers - : array<string|int, mixed> - = []
                                    -
                                    - -
                                    -
                                    - - -
                                    - Tags - -
                                    -
                                    -
                                    - throws -
                                    -
                                    - ApiException - - -
                                    -
                                    - -
                                    Return values
                                    - HttpResponseInterface - — - - -
                                    -
                                    -

                                    - requestWithToken() - -

                                    - - -

                                    It does a http request with Token authentication. If there is an error throws an ApiException

                                    - - - protected - requestWithToken(string $url, string $method[, class-string<\Doofinder\Shared\Interfaces\ModelInterface> $model = null ][, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $headers = [] ]) : HttpResponseInterface - - -
                                    Parameters
                                    -
                                    -
                                    - $url - : string -
                                    -
                                    - -
                                    -
                                    - $method - : string -
                                    -
                                    - -
                                    -
                                    - $model - : class-string<\Doofinder\Shared\Interfaces\ModelInterface> - = null
                                    -
                                    - -
                                    -
                                    - $params - : array<string|int, mixed> - = []
                                    -
                                    - -
                                    -
                                    - $headers - : array<string|int, mixed> - = []
                                    -
                                    - -
                                    -
                                    - - -
                                    - Tags - -
                                    -
                                    -
                                    - throws -
                                    -
                                    - ApiException - - -
                                    -
                                    - -
                                    Return values
                                    - HttpResponseInterface - — - - -
                                    -
                                    -

                                    - request() - -

                                    - - -

                                    It does a http request. If there is an error throws an ApiException

                                    - - - private - request(string $url, string $method[, class-string<\Doofinder\Shared\Interfaces\ModelInterface> $model = null ][, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $headers = [] ]) : HttpResponseInterface - - -
                                    Parameters
                                    -
                                    -
                                    - $url - : string -
                                    -
                                    - -
                                    -
                                    - $method - : string -
                                    -
                                    - -
                                    -
                                    - $model - : class-string<\Doofinder\Shared\Interfaces\ModelInterface> - = null
                                    -
                                    - -
                                    -
                                    - $params - : array<string|int, mixed> - = []
                                    -
                                    - -
                                    -
                                    - $headers - : array<string|int, mixed> - = []
                                    -
                                    - -
                                    -
                                    - - -
                                    - Tags - -
                                    -
                                    -
                                    - throws -
                                    -
                                    - ApiException - - -
                                    -
                                    - -
                                    Return values
                                    - HttpResponseInterface - — - - -
                                    -
                                    - - - - -
                                    -
                                    -
                                    -
                                    -

                                    Search results

                                    - -
                                    -
                                    -
                                      -
                                      -
                                      -
                                      -
                                      -
                                      - - -
                                      - - - - - - - - diff --git a/doc/classes/Doofinder-Search-Resources-Stats.html b/doc/classes/Doofinder-Search-Resources-Stats.html deleted file mode 100644 index dd3dfdb..0000000 --- a/doc/classes/Doofinder-Search-Resources-Stats.html +++ /dev/null @@ -1,1509 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                      -

                                      Documentation

                                      - - - - - -
                                      - -
                                      -
                                      - - - - -
                                      - - -
                                      -

                                      - Stats - - - extends SearchResource - - -
                                      - in package - -
                                      - - -

                                      - - - -

                                      Stats class is responsible for making the requests to the Stats's endpoint and return a response

                                      - - - - - - - - - -

                                      - Table of Contents - -

                                      - -
                                      -
                                      - $baseUrl - -  : string -
                                      -
                                      - -
                                      - $config - -  : Configuration -
                                      -
                                      - -
                                      - $httpClient - -  : HttpClientInterface -
                                      -
                                      - -
                                      - clearCart() - -  : HttpResponseInterface -
                                      -
                                      Erase completely a cart
                                      - -
                                      - create() - -  : Stats -
                                      -
                                      - -
                                      - getUrl() - -  : string -
                                      -
                                      - -
                                      - initSession() - -  : HttpResponseInterface -
                                      -
                                      Given a hashId and search params, starts a session
                                      - -
                                      - logAddToCart() - -  : HttpResponseInterface -
                                      -
                                      Log an "Add to cart" event
                                      - -
                                      - logBanner() - -  : HttpResponseInterface -
                                      -
                                      Given a hashId and banner params, log a banner click
                                      - -
                                      - logCheckout() - -  : HttpResponseInterface -
                                      -
                                      Given a hashId and sessionId, logs a checkout
                                      - -
                                      - logClick() - -  : HttpResponseInterface -
                                      -
                                      Given a hashId, session id, item id and click params, log a click
                                      - -
                                      - logRedirection() - -  : HttpResponseInterface -
                                      -
                                      Given a hashId and redirection params, log a redirection
                                      - -
                                      - logRemoveFromCart() - -  : HttpResponseInterface -
                                      -
                                      Log "Remove from cart" event
                                      - -
                                      - __construct() - -  : mixed -
                                      -
                                      - -
                                      - requestWithJwt() - -  : HttpResponseInterface -
                                      -
                                      It does a http request with Jwt authentication. If there is an error throws an ApiException
                                      - -
                                      - requestWithToken() - -  : HttpResponseInterface -
                                      -
                                      It does a http request with Token authentication. If there is an error throws an ApiException
                                      - -
                                      - getBaseUrl() - -  : string -
                                      -
                                      - -
                                      - request() - -  : HttpResponseInterface -
                                      -
                                      It does a http request. If there is an error throws an ApiException
                                      - -
                                      - - - - - - -
                                      -

                                      - Properties - -

                                      -
                                      -

                                      - $baseUrl - - - -

                                      - - - - - protected - string - $baseUrl - - - - - - -
                                      - - -
                                      - -
                                      -

                                      - Methods - -

                                      -
                                      -

                                      - clearCart() - -

                                      - - -

                                      Erase completely a cart

                                      - - - public - clearCart(string $hashId, string $sessionId) : HttpResponseInterface - - -
                                      Parameters
                                      -
                                      -
                                      - $hashId - : string -
                                      -
                                      - -
                                      -
                                      - $sessionId - : string -
                                      -
                                      - -
                                      -
                                      - - -
                                      - Tags - -
                                      -
                                      -
                                      - throws -
                                      -
                                      - ApiException - - -
                                      -
                                      - -
                                      Return values
                                      - HttpResponseInterface - — - - -
                                      - -
                                      -

                                      - getUrl() - -

                                      - - - - - public - abstract getUrl() : string - - - - - -
                                      Return values
                                      - string - — - - -
                                      -
                                      -

                                      - initSession() - -

                                      - - -

                                      Given a hashId and search params, starts a session

                                      - - - public - initSession(string $hashId, string $sessionId) : HttpResponseInterface - - -
                                      Parameters
                                      -
                                      -
                                      - $hashId - : string -
                                      -
                                      - -
                                      -
                                      - $sessionId - : string -
                                      -
                                      - -
                                      -
                                      - - -
                                      - Tags - -
                                      -
                                      -
                                      - throws -
                                      -
                                      - ApiException - - -
                                      -
                                      - -
                                      Return values
                                      - HttpResponseInterface - — - - -
                                      -
                                      -

                                      - logAddToCart() - -

                                      - - -

                                      Log an "Add to cart" event

                                      - - - public - logAddToCart(string $hashId, string $sessionId, int $amount, string $itemId, string $indexId, float $price, string $title) : HttpResponseInterface - - -
                                      Parameters
                                      -
                                      -
                                      - $hashId - : string -
                                      -
                                      - -
                                      -
                                      - $sessionId - : string -
                                      -
                                      - -
                                      -
                                      - $amount - : int -
                                      -
                                      - -
                                      -
                                      - $itemId - : string -
                                      -
                                      - -
                                      -
                                      - $indexId - : string -
                                      -
                                      - -
                                      -
                                      - $price - : float -
                                      -
                                      - -
                                      -
                                      - $title - : string -
                                      -
                                      - -
                                      -
                                      - - -
                                      - Tags - -
                                      -
                                      -
                                      - throws -
                                      -
                                      - ApiException - - -
                                      -
                                      - -
                                      Return values
                                      - HttpResponseInterface - — - - -
                                      -
                                      -

                                      - logBanner() - -

                                      - - -

                                      Given a hashId and banner params, log a banner click

                                      - - - public - logBanner(string $hashId, string $sessionId, string $id, string|null $query) : HttpResponseInterface - - -
                                      Parameters
                                      -
                                      -
                                      - $hashId - : string -
                                      -
                                      - -
                                      -
                                      - $sessionId - : string -
                                      -
                                      - -
                                      -
                                      - $id - : string -
                                      -
                                      - -
                                      -
                                      - $query - : string|null -
                                      -
                                      - -
                                      -
                                      - - -
                                      - Tags - -
                                      -
                                      -
                                      - throws -
                                      -
                                      - ApiException - - -
                                      -
                                      - -
                                      Return values
                                      - HttpResponseInterface - — - - -
                                      -
                                      -

                                      - logCheckout() - -

                                      - - -

                                      Given a hashId and sessionId, logs a checkout

                                      - - - public - logCheckout(string $hashId, string $sessionId) : HttpResponseInterface - - -
                                      Parameters
                                      -
                                      -
                                      - $hashId - : string -
                                      -
                                      - -
                                      -
                                      - $sessionId - : string -
                                      -
                                      - -
                                      -
                                      - - -
                                      - Tags - -
                                      -
                                      -
                                      - throws -
                                      -
                                      - ApiException - - -
                                      -
                                      - -
                                      Return values
                                      - HttpResponseInterface - — - - -
                                      -
                                      -

                                      - logClick() - -

                                      - - -

                                      Given a hashId, session id, item id and click params, log a click

                                      - - - public - logClick(string $hashId, string $sessionId, string $itemId, string|null $query) : HttpResponseInterface - - -
                                      Parameters
                                      -
                                      -
                                      - $hashId - : string -
                                      -
                                      - -
                                      -
                                      - $sessionId - : string -
                                      -
                                      - -
                                      -
                                      - $itemId - : string -
                                      -
                                      - -
                                      -
                                      - $query - : string|null -
                                      -
                                      - -
                                      -
                                      - - -
                                      - Tags - -
                                      -
                                      -
                                      - throws -
                                      -
                                      - ApiException - - -
                                      -
                                      - -
                                      Return values
                                      - HttpResponseInterface - — - - -
                                      -
                                      -

                                      - logRedirection() - -

                                      - - -

                                      Given a hashId and redirection params, log a redirection

                                      - - - public - logRedirection(string $hashId, string $sessionId, string $id, string|null $query) : HttpResponseInterface - - -
                                      Parameters
                                      -
                                      -
                                      - $hashId - : string -
                                      -
                                      - -
                                      -
                                      - $sessionId - : string -
                                      -
                                      - -
                                      -
                                      - $id - : string -
                                      -
                                      - -
                                      -
                                      - $query - : string|null -
                                      -
                                      - -
                                      -
                                      - - -
                                      - Tags - -
                                      -
                                      -
                                      - throws -
                                      -
                                      - ApiException - - -
                                      -
                                      - -
                                      Return values
                                      - HttpResponseInterface - — - - -
                                      -
                                      -

                                      - logRemoveFromCart() - -

                                      - - -

                                      Log "Remove from cart" event

                                      - - - public - logRemoveFromCart(string $hashId, string $sessionId, int $amount, string $itemId, string $indexId) : HttpResponseInterface - - -
                                      Parameters
                                      -
                                      -
                                      - $hashId - : string -
                                      -
                                      - -
                                      -
                                      - $sessionId - : string -
                                      -
                                      - -
                                      -
                                      - $amount - : int -
                                      -
                                      - -
                                      -
                                      - $itemId - : string -
                                      -
                                      - -
                                      -
                                      - $indexId - : string -
                                      -
                                      - -
                                      -
                                      - - -
                                      - Tags - -
                                      -
                                      -
                                      - throws -
                                      -
                                      - ApiException - - -
                                      -
                                      - -
                                      Return values
                                      - HttpResponseInterface - — - - -
                                      - -
                                      -

                                      - requestWithJwt() - -

                                      - - -

                                      It does a http request with Jwt authentication. If there is an error throws an ApiException

                                      - - - protected - requestWithJwt(string $url, string $method[, class-string<\Doofinder\Shared\Interfaces\ModelInterface> $model = null ][, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $headers = [] ]) : HttpResponseInterface - - -
                                      Parameters
                                      -
                                      -
                                      - $url - : string -
                                      -
                                      - -
                                      -
                                      - $method - : string -
                                      -
                                      - -
                                      -
                                      - $model - : class-string<\Doofinder\Shared\Interfaces\ModelInterface> - = null
                                      -
                                      - -
                                      -
                                      - $params - : array<string|int, mixed> - = []
                                      -
                                      - -
                                      -
                                      - $headers - : array<string|int, mixed> - = []
                                      -
                                      - -
                                      -
                                      - - -
                                      - Tags - -
                                      -
                                      -
                                      - throws -
                                      -
                                      - ApiException - - -
                                      -
                                      - -
                                      Return values
                                      - HttpResponseInterface - — - - -
                                      -
                                      -

                                      - requestWithToken() - -

                                      - - -

                                      It does a http request with Token authentication. If there is an error throws an ApiException

                                      - - - protected - requestWithToken(string $url, string $method[, class-string<\Doofinder\Shared\Interfaces\ModelInterface> $model = null ][, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $headers = [] ]) : HttpResponseInterface - - -
                                      Parameters
                                      -
                                      -
                                      - $url - : string -
                                      -
                                      - -
                                      -
                                      - $method - : string -
                                      -
                                      - -
                                      -
                                      - $model - : class-string<\Doofinder\Shared\Interfaces\ModelInterface> - = null
                                      -
                                      - -
                                      -
                                      - $params - : array<string|int, mixed> - = []
                                      -
                                      - -
                                      -
                                      - $headers - : array<string|int, mixed> - = []
                                      -
                                      - -
                                      -
                                      - - -
                                      - Tags - -
                                      -
                                      -
                                      - throws -
                                      -
                                      - ApiException - - -
                                      -
                                      - -
                                      Return values
                                      - HttpResponseInterface - — - - -
                                      -
                                      -

                                      - getBaseUrl() - -

                                      - - - - - private - getBaseUrl(string $hashId) : string - - -
                                      Parameters
                                      -
                                      -
                                      - $hashId - : string -
                                      -
                                      - -
                                      -
                                      - - - -
                                      Return values
                                      - string - — - - -
                                      -
                                      -

                                      - request() - -

                                      - - -

                                      It does a http request. If there is an error throws an ApiException

                                      - - - private - request(string $url, string $method[, class-string<\Doofinder\Shared\Interfaces\ModelInterface> $model = null ][, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $headers = [] ]) : HttpResponseInterface - - -
                                      Parameters
                                      -
                                      -
                                      - $url - : string -
                                      -
                                      - -
                                      -
                                      - $method - : string -
                                      -
                                      - -
                                      -
                                      - $model - : class-string<\Doofinder\Shared\Interfaces\ModelInterface> - = null
                                      -
                                      - -
                                      -
                                      - $params - : array<string|int, mixed> - = []
                                      -
                                      - -
                                      -
                                      - $headers - : array<string|int, mixed> - = []
                                      -
                                      - -
                                      -
                                      - - -
                                      - Tags - -
                                      -
                                      -
                                      - throws -
                                      -
                                      - ApiException - - -
                                      -
                                      - -
                                      Return values
                                      - HttpResponseInterface - — - - -
                                      -
                                      - - - - -
                                      -
                                      -
                                      -
                                      -

                                      Search results

                                      - -
                                      -
                                      -
                                        -
                                        -
                                        -
                                        -
                                        -
                                        - - -
                                        - - - - - - - - diff --git a/doc/classes/Doofinder-Search-SearchClient.html b/doc/classes/Doofinder-Search-SearchClient.html deleted file mode 100644 index abdbb57..0000000 --- a/doc/classes/Doofinder-Search-SearchClient.html +++ /dev/null @@ -1,1249 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                        -

                                        Documentation

                                        - - - - - -
                                        - -
                                        -
                                        - - - - -
                                        - - -
                                        -

                                        - SearchClient - - -
                                        - in package - -
                                        - - -

                                        - - - -

                                        This class is used to do searches through calling an API.

                                        - - - - - - - - - -

                                        - Table of Contents - -

                                        - -
                                        -
                                        - $searchResource - -  : Search -
                                        -
                                        - -
                                        - $statsResource - -  : Stats -
                                        -
                                        - -
                                        - __construct() - -  : mixed -
                                        -
                                        - -
                                        - clearCart() - -  : HttpResponseInterface -
                                        -
                                        This call will erase completely a cart identified by the pair of hashid and session ID, if it does exist
                                        - -
                                        - create() - -  : SearchClient -
                                        -
                                        - -
                                        - initSession() - -  : HttpResponseInterface -
                                        -
                                        Starts a session identified by a session_id. The session is used to "group" events.
                                        - -
                                        - logAddToCart() - -  : HttpResponseInterface -
                                        -
                                        Adds an item to the cart, or creates a new cart for the given session if it does not exists
                                        - -
                                        - logBanner() - -  : HttpResponseInterface -
                                        -
                                        Logs a "click on banner image" event in stats logs.
                                        - -
                                        - logCheckout() - -  : HttpResponseInterface -
                                        -
                                        Logs a checkout event in stats logs.
                                        - -
                                        - logClick() - -  : HttpResponseInterface -
                                        -
                                        Save click event on doofinder statistics
                                        - -
                                        - logRedirection() - -  : HttpResponseInterface -
                                        -
                                        Logs a "redirection triggered" event in stats logs.
                                        - -
                                        - logRemoveFromCart() - -  : HttpResponseInterface -
                                        -
                                        Removes an amount from the given item in the cart, removing it completely if the amount present in the cart minus -the amount specified in this call is zero or negative, else, it will be updated with the new calculated amount.
                                        - -
                                        - search() - -  : HttpResponseInterface -
                                        -
                                        Search through indexed items of a search engine.
                                        - -
                                        - suggest() - -  : HttpResponseInterface -
                                        -
                                        Search through indexed suggestions of a search engine.
                                        - -
                                        - - - - - - -
                                        -

                                        - Properties - -

                                        -
                                        -

                                        - $searchResource - - - -

                                        - - - - - private - Search - $searchResource - - - - - - -
                                        -
                                        -

                                        - $statsResource - - - -

                                        - - - - - private - Stats - $statsResource - - - - - - -
                                        -
                                        - -
                                        -

                                        - Methods - -

                                        -
                                        -

                                        - __construct() - -

                                        - - - - - public - __construct(Search $searchResource, Stats $statsResource) : mixed - -
                                        - -
                                        Parameters
                                        -
                                        -
                                        - $searchResource - : Search -
                                        -
                                        -
                                        - -
                                        -
                                        - $statsResource - : Stats -
                                        -
                                        -
                                        - -
                                        -
                                        - - - -
                                        Return values
                                        - mixed - — - - -
                                        -
                                        -

                                        - clearCart() - -

                                        - - -

                                        This call will erase completely a cart identified by the pair of hashid and session ID, if it does exist

                                        - - - public - clearCart(string $hashId, string $sessionId) : HttpResponseInterface - - -
                                        Parameters
                                        -
                                        -
                                        - $hashId - : string -
                                        -
                                        - -
                                        -
                                        - $sessionId - : string -
                                        -
                                        - -
                                        -
                                        - - -
                                        - Tags - -
                                        -
                                        -
                                        - throws -
                                        -
                                        - ApiException - - -
                                        -
                                        - -
                                        Return values
                                        - HttpResponseInterface - — - - -
                                        -
                                        -

                                        - create() - -

                                        - - - - - public - static create(string $host, string $token) : SearchClient - - -
                                        Parameters
                                        -
                                        -
                                        - $host - : string -
                                        -
                                        - -
                                        -
                                        - $token - : string -
                                        -
                                        - -
                                        -
                                        - - - -
                                        Return values
                                        - SearchClient - — - - -
                                        -
                                        -

                                        - initSession() - -

                                        - - -

                                        Starts a session identified by a session_id. The session is used to "group" events.

                                        - - - public - initSession(string $hashId, string $sessionId) : HttpResponseInterface - - -
                                        Parameters
                                        -
                                        -
                                        - $hashId - : string -
                                        -
                                        - -
                                        -
                                        - $sessionId - : string -
                                        -
                                        - -
                                        -
                                        - - -
                                        - Tags - -
                                        -
                                        -
                                        - throws -
                                        -
                                        - ApiException - - -
                                        -
                                        - -
                                        Return values
                                        - HttpResponseInterface - — - - -
                                        -
                                        -

                                        - logAddToCart() - -

                                        - - -

                                        Adds an item to the cart, or creates a new cart for the given session if it does not exists

                                        - - - public - logAddToCart(string $hashId, string $sessionId, int $amount, string $itemId, string $indexId, float $price, string $title) : HttpResponseInterface - - -
                                        Parameters
                                        -
                                        -
                                        - $hashId - : string -
                                        -
                                        - -
                                        -
                                        - $sessionId - : string -
                                        -
                                        - -
                                        -
                                        - $amount - : int -
                                        -
                                        - -
                                        -
                                        - $itemId - : string -
                                        -
                                        - -
                                        -
                                        - $indexId - : string -
                                        -
                                        - -
                                        -
                                        - $price - : float -
                                        -
                                        - -
                                        -
                                        - $title - : string -
                                        -
                                        - -
                                        -
                                        - - -
                                        - Tags - -
                                        -
                                        -
                                        - throws -
                                        -
                                        - ApiException - - -
                                        -
                                        - -
                                        Return values
                                        - HttpResponseInterface - — - - -
                                        -
                                        -

                                        - logBanner() - -

                                        - - -

                                        Logs a "click on banner image" event in stats logs.

                                        - - - public - logBanner(string $hashId, string $sessionId, string $id[, string|null $query = null ]) : HttpResponseInterface - - -
                                        Parameters
                                        -
                                        -
                                        - $hashId - : string -
                                        -
                                        - -
                                        -
                                        - $sessionId - : string -
                                        -
                                        - -
                                        -
                                        - $id - : string -
                                        -
                                        - -
                                        -
                                        - $query - : string|null - = null
                                        -
                                        - -
                                        -
                                        - - -
                                        - Tags - -
                                        -
                                        -
                                        - throws -
                                        -
                                        - ApiException - - -
                                        -
                                        - -
                                        Return values
                                        - HttpResponseInterface - — - - -
                                        -
                                        -

                                        - logCheckout() - -

                                        - - -

                                        Logs a checkout event in stats logs.

                                        - - - public - logCheckout(string $hashId, string $sessionId) : HttpResponseInterface - - -
                                        Parameters
                                        -
                                        -
                                        - $hashId - : string -
                                        -
                                        - -
                                        -
                                        - $sessionId - : string -
                                        -
                                        - -
                                        -
                                        - - -
                                        - Tags - -
                                        -
                                        -
                                        - throws -
                                        -
                                        - ApiException - - -
                                        -
                                        - -
                                        Return values
                                        - HttpResponseInterface - — - - -
                                        -
                                        -

                                        - logClick() - -

                                        - - -

                                        Save click event on doofinder statistics

                                        - - - public - logClick(string $hashId, string $sessionId, string $itemId[, string|null $query = null ]) : HttpResponseInterface - - -
                                        Parameters
                                        -
                                        -
                                        - $hashId - : string -
                                        -
                                        - -
                                        -
                                        - $sessionId - : string -
                                        -
                                        - -
                                        -
                                        - $itemId - : string -
                                        -
                                        - -
                                        -
                                        - $query - : string|null - = null
                                        -
                                        - -
                                        -
                                        - - -
                                        - Tags - -
                                        -
                                        -
                                        - throws -
                                        -
                                        - ApiException - - -
                                        -
                                        - -
                                        Return values
                                        - HttpResponseInterface - — - - -
                                        -
                                        -

                                        - logRedirection() - -

                                        - - -

                                        Logs a "redirection triggered" event in stats logs.

                                        - - - public - logRedirection(string $hashId, string $sessionId, string $id[, string|null $query = null ]) : HttpResponseInterface - - -
                                        Parameters
                                        -
                                        -
                                        - $hashId - : string -
                                        -
                                        - -
                                        -
                                        - $sessionId - : string -
                                        -
                                        - -
                                        -
                                        - $id - : string -
                                        -
                                        - -
                                        -
                                        - $query - : string|null - = null
                                        -
                                        - -
                                        -
                                        - - -
                                        - Tags - -
                                        -
                                        -
                                        - throws -
                                        -
                                        - ApiException - - -
                                        -
                                        - -
                                        Return values
                                        - HttpResponseInterface - — - - -
                                        -
                                        -

                                        - logRemoveFromCart() - -

                                        - - -

                                        Removes an amount from the given item in the cart, removing it completely if the amount present in the cart minus -the amount specified in this call is zero or negative, else, it will be updated with the new calculated amount.

                                        - - - public - logRemoveFromCart(string $hashId, string $sessionId, int $amount, string $itemId, string $indexId) : HttpResponseInterface - - -
                                        Parameters
                                        -
                                        -
                                        - $hashId - : string -
                                        -
                                        - -
                                        -
                                        - $sessionId - : string -
                                        -
                                        - -
                                        -
                                        - $amount - : int -
                                        -
                                        - -
                                        -
                                        - $itemId - : string -
                                        -
                                        - -
                                        -
                                        - $indexId - : string -
                                        -
                                        - -
                                        -
                                        - - -
                                        - Tags - -
                                        -
                                        -
                                        - throws -
                                        -
                                        - ApiException - - -
                                        -
                                        - -
                                        Return values
                                        - HttpResponseInterface - — - - -
                                        -
                                        - - - -

                                        Search through indexed items of a search engine.

                                        - - - public - search(string $hashId, array<string|int, mixed> $params) : HttpResponseInterface - - -
                                        Parameters
                                        -
                                        -
                                        - $hashId - : string -
                                        -
                                        - -
                                        -
                                        - $params - : array<string|int, mixed> -
                                        -
                                        - -
                                        -
                                        - - -
                                        - Tags - -
                                        -
                                        -
                                        - throws -
                                        -
                                        - ApiException - - -
                                        -
                                        - -
                                        Return values
                                        - HttpResponseInterface - — - - -
                                        -
                                        -

                                        - suggest() - -

                                        - - -

                                        Search through indexed suggestions of a search engine.

                                        - - - public - suggest(string $hashId, array<string|int, mixed> $params) : HttpResponseInterface - - -
                                        Parameters
                                        -
                                        -
                                        - $hashId - : string -
                                        -
                                        - -
                                        -
                                        - $params - : array<string|int, mixed> -
                                        -
                                        - -
                                        -
                                        - - -
                                        - Tags - -
                                        -
                                        -
                                        - throws -
                                        -
                                        - ApiException - - -
                                        -
                                        - -
                                        Return values
                                        - HttpResponseInterface - — - - -
                                        -
                                        - - - - -
                                        -
                                        -
                                        -
                                        -

                                        Search results

                                        - -
                                        -
                                        -
                                          -
                                          -
                                          -
                                          -
                                          -
                                          - - -
                                          - - - - - - - - diff --git a/doc/classes/Doofinder-Shared-Exceptions-ApiException.html b/doc/classes/Doofinder-Shared-Exceptions-ApiException.html deleted file mode 100644 index 300c093..0000000 --- a/doc/classes/Doofinder-Shared-Exceptions-ApiException.html +++ /dev/null @@ -1,398 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                          -

                                          Documentation

                                          - - - - - -
                                          - -
                                          -
                                          - - - - -
                                          - - -
                                          -

                                          - ApiException - - - extends Exception - - -
                                          - in package - -
                                          - - -

                                          - - - -

                                          Exception used when API request returns a not OK response

                                          - - - - - - - - - -

                                          - Table of Contents - -

                                          - -
                                          -
                                          - $body - -  : mixed|null -
                                          -
                                          - -
                                          - __construct() - -  : mixed -
                                          -
                                          - -
                                          - getBody() - -  : mixed|null -
                                          -
                                          - -
                                          - - - - - - -
                                          -

                                          - Properties - -

                                          -
                                          -

                                          - $body - - - -

                                          - - - - - private - mixed|null - $body - - - - - - -
                                          -
                                          - -
                                          -

                                          - Methods - -

                                          -
                                          -

                                          - __construct() - -

                                          - - - - - public - __construct([string $message = "" ], int $code[, Throwable $exception = null ][, mixed|null $responseBody = null ]) : mixed - - -
                                          Parameters
                                          -
                                          -
                                          - $message - : string - = ""
                                          -
                                          - -
                                          -
                                          - $code - : int -
                                          -
                                          - -
                                          -
                                          - $exception - : Throwable - = null
                                          -
                                          - -
                                          -
                                          - $responseBody - : mixed|null - = null
                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - mixed - — - - -
                                          -
                                          -

                                          - getBody() - -

                                          - - - - - public - getBody() : mixed|null - - - - - -
                                          Return values
                                          - mixed|null - — - - -
                                          -
                                          - - - - -
                                          -
                                          -
                                          -
                                          -

                                          Search results

                                          - -
                                          -
                                          -
                                            -
                                            -
                                            -
                                            -
                                            -
                                            - - -
                                            - - - - - - - - diff --git a/doc/classes/Doofinder-Shared-Exceptions-RequestException.html b/doc/classes/Doofinder-Shared-Exceptions-RequestException.html deleted file mode 100644 index 582d1f4..0000000 --- a/doc/classes/Doofinder-Shared-Exceptions-RequestException.html +++ /dev/null @@ -1,231 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                            -

                                            Documentation

                                            - - - - - -
                                            - -
                                            -
                                            - - - - -
                                            - - -
                                            -

                                            - RequestException - - - extends Exception - - -
                                            - in package - -
                                            - - -

                                            - - - -

                                            Exception used when there is an error in the http request

                                            - - - - - - - - - - - - - - - - - - - - -
                                            -
                                            -
                                            -
                                            -

                                            Search results

                                            - -
                                            -
                                            -
                                              -
                                              -
                                              -
                                              -
                                              -
                                              - - -
                                              - - - - - - - - diff --git a/doc/classes/Doofinder-Shared-HttpClient.html b/doc/classes/Doofinder-Shared-HttpClient.html deleted file mode 100644 index de9596f..0000000 --- a/doc/classes/Doofinder-Shared-HttpClient.html +++ /dev/null @@ -1,388 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                              -

                                              Documentation

                                              - - - - - -
                                              - -
                                              -
                                              - - - - -
                                              - - -
                                              -

                                              - HttpClient - - -
                                              - in package - -
                                              - - - implements - HttpClientInterface - -

                                              - - - -

                                              Class to do requests though curl utility

                                              - - - - - - - -

                                              - Interfaces, Classes and Traits - -

                                              - -
                                              -
                                              HttpClientInterface
                                              -
                                              Http client's interface
                                              - - -
                                              - - -

                                              - Table of Contents - -

                                              - -
                                              -
                                              - request() - -  : HttpResponseInterface -
                                              -
                                              - -
                                              - getHeader() - -  : array<string|int, string> -
                                              -
                                              It generates the http header
                                              - -
                                              - - - - - - - -
                                              -

                                              - Methods - -

                                              -
                                              -

                                              - request() - -

                                              - - - - - public - request(string $url, string $method, array<string|int, mixed> $params, array<string|int, mixed> $headers) : HttpResponseInterface - - -
                                              Parameters
                                              -
                                              -
                                              - $url - : string -
                                              -
                                              - -
                                              -
                                              - $method - : string -
                                              -
                                              - -
                                              -
                                              - $params - : array<string|int, mixed> -
                                              -
                                              - -
                                              -
                                              - $headers - : array<string|int, mixed> -
                                              -
                                              - -
                                              -
                                              - - -
                                              - Tags - -
                                              -
                                              -
                                              - throws -
                                              -
                                              - RequestException - - -
                                              -
                                              - -
                                              Return values
                                              - HttpResponseInterface - — - - -
                                              -
                                              -

                                              - getHeader() - -

                                              - - -

                                              It generates the http header

                                              - - - private - getHeader(array<string|int, mixed> $headers) : array<string|int, string> - - -
                                              Parameters
                                              -
                                              -
                                              - $headers - : array<string|int, mixed> -
                                              -
                                              - -
                                              -
                                              - - - -
                                              Return values
                                              - array<string|int, string> - — - - -
                                              -
                                              - - - - -
                                              -
                                              -
                                              -
                                              -

                                              Search results

                                              - -
                                              -
                                              -
                                                -
                                                -
                                                -
                                                -
                                                -
                                                - - -
                                                - - - - - - - - diff --git a/doc/classes/Doofinder-Shared-HttpResponse.html b/doc/classes/Doofinder-Shared-HttpResponse.html deleted file mode 100644 index b9cbd49..0000000 --- a/doc/classes/Doofinder-Shared-HttpResponse.html +++ /dev/null @@ -1,577 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                -

                                                Documentation

                                                - - - - - -
                                                - -
                                                -
                                                - - - - -
                                                - - -
                                                -

                                                - HttpResponse - - -
                                                - in package - -
                                                - - - implements - HttpResponseInterface - -

                                                - - - -

                                                Class to return a formatted info comming from API

                                                - - - - - - - -

                                                - Interfaces, Classes and Traits - -

                                                - -
                                                -
                                                HttpResponseInterface
                                                -
                                                Http response's interface
                                                - - -
                                                - - -

                                                - Table of Contents - -

                                                - -
                                                -
                                                - $body - -  : mixed -
                                                -
                                                - -
                                                - $statusCode - -  : int -
                                                -
                                                - -
                                                - create() - -  : HttpResponse -
                                                -
                                                - -
                                                - getBody() - -  : mixed -
                                                -
                                                - -
                                                - getStatusCode() - -  : int -
                                                -
                                                - -
                                                - setBody() - -  : mixed -
                                                -
                                                - -
                                                - __construct() - -  : mixed -
                                                -
                                                - -
                                                - - - - - - -
                                                -

                                                - Properties - -

                                                -
                                                -

                                                - $body - - - -

                                                - - - - - private - mixed - $body - - - - - - -
                                                -
                                                -

                                                - $statusCode - - - -

                                                - - - - - private - int - $statusCode - - - - - - -
                                                -
                                                - -
                                                -

                                                - Methods - -

                                                -
                                                -

                                                - create() - -

                                                - - - - - public - static create(int $statusCode[, mixed $body = null ]) : HttpResponse - - -
                                                Parameters
                                                -
                                                -
                                                - $statusCode - : int -
                                                -
                                                - -
                                                -
                                                - $body - : mixed - = null
                                                -
                                                - -
                                                -
                                                - - - -
                                                Return values
                                                - HttpResponse - — - - -
                                                -
                                                -

                                                - getBody() - -

                                                - - - - - public - getBody() : mixed - - - - - -
                                                Return values
                                                - mixed - — - - -
                                                -
                                                -

                                                - getStatusCode() - -

                                                - - - - - public - getStatusCode() : int - - - - - -
                                                Return values
                                                - int - — - - -
                                                -
                                                -

                                                - setBody() - -

                                                - - - - - public - setBody(mixed $body) : mixed - - -
                                                Parameters
                                                -
                                                -
                                                - $body - : mixed -
                                                -
                                                - -
                                                -
                                                - - - -
                                                Return values
                                                - mixed - — - - -
                                                -
                                                -

                                                - __construct() - -

                                                - - - - - private - __construct( $statusCode,  $body) : mixed - - -
                                                Parameters
                                                -
                                                -
                                                - $statusCode - : -
                                                -
                                                - -
                                                -
                                                - $body - : -
                                                -
                                                - -
                                                -
                                                - - - -
                                                Return values
                                                - mixed - — - - -
                                                -
                                                - - - - -
                                                -
                                                -
                                                -
                                                -

                                                Search results

                                                - -
                                                -
                                                -
                                                  -
                                                  -
                                                  -
                                                  -
                                                  -
                                                  - - -
                                                  - - - - - - - - diff --git a/doc/classes/Doofinder-Shared-HttpStatusCode.html b/doc/classes/Doofinder-Shared-HttpStatusCode.html deleted file mode 100644 index 8722bf6..0000000 --- a/doc/classes/Doofinder-Shared-HttpStatusCode.html +++ /dev/null @@ -1,708 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                  -

                                                  Documentation

                                                  - - - - - -
                                                  - -
                                                  -
                                                  - - - - -
                                                  - - -
                                                  -

                                                  - HttpStatusCode - - -
                                                  - in package - -
                                                  - - -

                                                  - - - -

                                                  Class to store all http status code used in the API

                                                  - - - - - - - - - -

                                                  - Table of Contents - -

                                                  - -
                                                  -
                                                  - BAD_GATEWAY - -  = 502 -
                                                  -
                                                  - -
                                                  - BAD_REQUEST - -  = 400 -
                                                  -
                                                  - -
                                                  - CONFLICT - -  = 409 -
                                                  -
                                                  - -
                                                  - CREATED - -  = 201 -
                                                  -
                                                  - -
                                                  - FORBIDDEN - -  = 403 -
                                                  -
                                                  - -
                                                  - INTERNAL_SERVER_ERROR - -  = 500 -
                                                  -
                                                  - -
                                                  - NO_CONTENT - -  = 204 -
                                                  -
                                                  - -
                                                  - NOT_FOUND - -  = 404 -
                                                  -
                                                  - -
                                                  - OK - -  = 200 -
                                                  -
                                                  - -
                                                  - REQUEST_ENTITY_TOO_LARGE - -  = 413 -
                                                  -
                                                  - -
                                                  - REQUEST_TIMEOUT - -  = 408 -
                                                  -
                                                  - -
                                                  - TOO_MANY_REQUESTS - -  = 429 -
                                                  -
                                                  - -
                                                  - UNAUTHORIZED - -  = 401 -
                                                  -
                                                  - -
                                                  - - - - -
                                                  -

                                                  - Constants - -

                                                  -
                                                  -

                                                  - BAD_GATEWAY - -

                                                  - - - - - - public - mixed - BAD_GATEWAY - = 502 - - - -
                                                  - -
                                                  - - - -
                                                  -
                                                  -

                                                  - BAD_REQUEST - -

                                                  - - - - - - public - mixed - BAD_REQUEST - = 400 - - - -
                                                  - -
                                                  - - - -
                                                  -
                                                  -

                                                  - CONFLICT - -

                                                  - - - - - - public - mixed - CONFLICT - = 409 - - - -
                                                  - -
                                                  - - - -
                                                  -
                                                  -

                                                  - CREATED - -

                                                  - - - - - - public - mixed - CREATED - = 201 - - - -
                                                  - -
                                                  - - - -
                                                  -
                                                  -

                                                  - FORBIDDEN - -

                                                  - - - - - - public - mixed - FORBIDDEN - = 403 - - - -
                                                  - -
                                                  - - - -
                                                  -
                                                  -

                                                  - INTERNAL_SERVER_ERROR - -

                                                  - - - - - - public - mixed - INTERNAL_SERVER_ERROR - = 500 - - - -
                                                  - -
                                                  - - - -
                                                  -
                                                  -

                                                  - NO_CONTENT - -

                                                  - - - - - - public - mixed - NO_CONTENT - = 204 - - - -
                                                  - -
                                                  - - - -
                                                  -
                                                  -

                                                  - NOT_FOUND - -

                                                  - - - - - - public - mixed - NOT_FOUND - = 404 - - - -
                                                  - -
                                                  - - - -
                                                  -
                                                  -

                                                  - OK - -

                                                  - - - - - - public - mixed - OK - = 200 - - - -
                                                  - -
                                                  - - - -
                                                  -
                                                  -

                                                  - REQUEST_ENTITY_TOO_LARGE - -

                                                  - - - - - - public - mixed - REQUEST_ENTITY_TOO_LARGE - = 413 - - - -
                                                  - -
                                                  - - - -
                                                  -
                                                  -

                                                  - REQUEST_TIMEOUT - -

                                                  - - - - - - public - mixed - REQUEST_TIMEOUT - = 408 - - - -
                                                  - -
                                                  - - - -
                                                  -
                                                  -

                                                  - TOO_MANY_REQUESTS - -

                                                  - - - - - - public - mixed - TOO_MANY_REQUESTS - = 429 - - - -
                                                  - -
                                                  - - - -
                                                  -
                                                  -

                                                  - UNAUTHORIZED - -

                                                  - - - - - - public - mixed - UNAUTHORIZED - = 401 - - - -
                                                  - -
                                                  - - - -
                                                  -
                                                  - - - - - - - -
                                                  -
                                                  -
                                                  -
                                                  -

                                                  Search results

                                                  - -
                                                  -
                                                  -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    - - -
                                                    - - - - - - - - diff --git a/doc/classes/Doofinder-Shared-Interfaces-HttpClientInterface.html b/doc/classes/Doofinder-Shared-Interfaces-HttpClientInterface.html deleted file mode 100644 index cca423b..0000000 --- a/doc/classes/Doofinder-Shared-Interfaces-HttpClientInterface.html +++ /dev/null @@ -1,491 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                    -

                                                    Documentation

                                                    - - - - - -
                                                    - -
                                                    -
                                                    - - - - -
                                                    - - -
                                                    -

                                                    - HttpClientInterface -
                                                    - in - -
                                                    -

                                                    - - - -

                                                    Http client's interface

                                                    - - - - - - - - - -

                                                    - Table of Contents - -

                                                    - -
                                                    -
                                                    - METHOD_DELETE - -  = 'DELETE' -
                                                    -
                                                    - -
                                                    - METHOD_GET - -  = 'GET' -
                                                    -
                                                    - -
                                                    - METHOD_PATCH - -  = 'PATCH' -
                                                    -
                                                    - -
                                                    - METHOD_POST - -  = 'POST' -
                                                    -
                                                    - -
                                                    - METHOD_PUT - -  = 'PUT' -
                                                    -
                                                    - -
                                                    - request() - -  : HttpResponseInterface -
                                                    -
                                                    - -
                                                    - - - - -
                                                    -

                                                    - Constants - -

                                                    -
                                                    -

                                                    - METHOD_DELETE - -

                                                    - - - - - - public - mixed - METHOD_DELETE - = 'DELETE' - - - -
                                                    - -
                                                    - - - -
                                                    -
                                                    -

                                                    - METHOD_GET - -

                                                    - - - - - - public - mixed - METHOD_GET - = 'GET' - - - -
                                                    - -
                                                    - - - -
                                                    -
                                                    -

                                                    - METHOD_PATCH - -

                                                    - - - - - - public - mixed - METHOD_PATCH - = 'PATCH' - - - -
                                                    - -
                                                    - - - -
                                                    -
                                                    -

                                                    - METHOD_POST - -

                                                    - - - - - - public - mixed - METHOD_POST - = 'POST' - - - -
                                                    - -
                                                    - - - -
                                                    -
                                                    -

                                                    - METHOD_PUT - -

                                                    - - - - - - public - mixed - METHOD_PUT - = 'PUT' - - - -
                                                    - -
                                                    - - - -
                                                    -
                                                    - -
                                                    -

                                                    - Methods - -

                                                    -
                                                    -

                                                    - request() - -

                                                    - - - - - public - request(string $url, string $method, array<string|int, mixed> $params, array<string|int, mixed> $headers) : HttpResponseInterface - - -
                                                    Parameters
                                                    -
                                                    -
                                                    - $url - : string -
                                                    -
                                                    - -
                                                    -
                                                    - $method - : string -
                                                    -
                                                    - -
                                                    -
                                                    - $params - : array<string|int, mixed> -
                                                    -
                                                    - -
                                                    -
                                                    - $headers - : array<string|int, mixed> -
                                                    -
                                                    - -
                                                    -
                                                    - - - -
                                                    Return values
                                                    - HttpResponseInterface - — - - -
                                                    -
                                                    - - - - -
                                                    -
                                                    -
                                                    -
                                                    -

                                                    Search results

                                                    - -
                                                    -
                                                    -
                                                      -
                                                      -
                                                      -
                                                      -
                                                      -
                                                      - - -
                                                      - - - - - - - - diff --git a/doc/classes/Doofinder-Shared-Interfaces-HttpResponseInterface.html b/doc/classes/Doofinder-Shared-Interfaces-HttpResponseInterface.html deleted file mode 100644 index 9ca9b30..0000000 --- a/doc/classes/Doofinder-Shared-Interfaces-HttpResponseInterface.html +++ /dev/null @@ -1,418 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                      -

                                                      Documentation

                                                      - - - - - -
                                                      - -
                                                      -
                                                      - - - - -
                                                      - - -
                                                      -

                                                      - HttpResponseInterface -
                                                      - in - -
                                                      -

                                                      - - - -

                                                      Http response's interface

                                                      - - - - - - - - - -

                                                      - Table of Contents - -

                                                      - -
                                                      -
                                                      - create() - -  : mixed -
                                                      -
                                                      - -
                                                      - getBody() - -  : mixed -
                                                      -
                                                      - -
                                                      - getStatusCode() - -  : int -
                                                      -
                                                      - -
                                                      - setBody() - -  : mixed -
                                                      -
                                                      - -
                                                      - - - - - -
                                                      -

                                                      - Methods - -

                                                      -
                                                      -

                                                      - create() - -

                                                      - - - - - public - static create(int $statusCode[, mixed $body = null ]) : mixed - - -
                                                      Parameters
                                                      -
                                                      -
                                                      - $statusCode - : int -
                                                      -
                                                      - -
                                                      -
                                                      - $body - : mixed - = null
                                                      -
                                                      - -
                                                      -
                                                      - - - -
                                                      Return values
                                                      - mixed - — - - -
                                                      -
                                                      -

                                                      - getBody() - -

                                                      - - - - - public - getBody() : mixed - - - - - -
                                                      Return values
                                                      - mixed - — - - -
                                                      -
                                                      -

                                                      - getStatusCode() - -

                                                      - - - - - public - getStatusCode() : int - - - - - -
                                                      Return values
                                                      - int - — - - -
                                                      -
                                                      -

                                                      - setBody() - -

                                                      - - - - - public - setBody(mixed $body) : mixed - - -
                                                      Parameters
                                                      -
                                                      -
                                                      - $body - : mixed -
                                                      -
                                                      - -
                                                      -
                                                      - - - -
                                                      Return values
                                                      - mixed - — - - -
                                                      -
                                                      - - - - -
                                                      -
                                                      -
                                                      -
                                                      -

                                                      Search results

                                                      - -
                                                      -
                                                      -
                                                        -
                                                        -
                                                        -
                                                        -
                                                        -
                                                        - - -
                                                        - - - - - - - - diff --git a/doc/classes/Doofinder-Shared-Interfaces-ModelInterface.html b/doc/classes/Doofinder-Shared-Interfaces-ModelInterface.html deleted file mode 100644 index 7342896..0000000 --- a/doc/classes/Doofinder-Shared-Interfaces-ModelInterface.html +++ /dev/null @@ -1,287 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                        -

                                                        Documentation

                                                        - - - - - -
                                                        - -
                                                        -
                                                        - - - - -
                                                        - - -
                                                        -

                                                        - ModelInterface - - extends - JsonSerializable -
                                                        - in - -
                                                        -

                                                        - - - -

                                                        Model's interface

                                                        - - - - - - - - - -

                                                        - Table of Contents - -

                                                        - -
                                                        -
                                                        - createFromArray() - -  : ModelInterface -
                                                        -
                                                        - -
                                                        - - - - - -
                                                        -

                                                        - Methods - -

                                                        -
                                                        -

                                                        - createFromArray() - -

                                                        - - - - - public - static createFromArray(array<string|int, mixed> $data) : ModelInterface - - -
                                                        Parameters
                                                        -
                                                        -
                                                        - $data - : array<string|int, mixed> -
                                                        -
                                                        - -
                                                        -
                                                        - - - -
                                                        Return values
                                                        - ModelInterface - — - - -
                                                        -
                                                        - - - - -
                                                        -
                                                        -
                                                        -
                                                        -

                                                        Search results

                                                        - -
                                                        -
                                                        -
                                                          -
                                                          -
                                                          -
                                                          -
                                                          -
                                                          - - -
                                                          - - - - - - - - diff --git a/doc/classes/Doofinder-Shared-Resource.html b/doc/classes/Doofinder-Shared-Resource.html deleted file mode 100644 index 38e7215..0000000 --- a/doc/classes/Doofinder-Shared-Resource.html +++ /dev/null @@ -1,734 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                          -

                                                          Documentation

                                                          - - - - - -
                                                          - -
                                                          -
                                                          - - - - -
                                                          - - -
                                                          -

                                                          - Resource - - -
                                                          - in package - -
                                                          - - -

                                                          - - - -

                                                          A resource class is in charge to communicate with the API and return a formatted response

                                                          - - - - - - - - - -

                                                          - Table of Contents - -

                                                          - -
                                                          -
                                                          - $baseUrl - -  : string -
                                                          -
                                                          - -
                                                          - $config - -  : Configuration -
                                                          -
                                                          - -
                                                          - $httpClient - -  : HttpClientInterface -
                                                          -
                                                          - -
                                                          - getUrl() - -  : string -
                                                          -
                                                          - -
                                                          - __construct() - -  : mixed -
                                                          -
                                                          - -
                                                          - requestWithJwt() - -  : HttpResponseInterface -
                                                          -
                                                          It does a http request with Jwt authentication. If there is an error throws an ApiException
                                                          - -
                                                          - requestWithToken() - -  : HttpResponseInterface -
                                                          -
                                                          It does a http request with Token authentication. If there is an error throws an ApiException
                                                          - -
                                                          - request() - -  : HttpResponseInterface -
                                                          -
                                                          It does a http request. If there is an error throws an ApiException
                                                          - -
                                                          - - - - - - -
                                                          -

                                                          - Properties - -

                                                          -
                                                          -

                                                          - $baseUrl - - - -

                                                          - - - - - protected - string - $baseUrl - - - - - - -
                                                          - - -
                                                          - -
                                                          -

                                                          - Methods - -

                                                          -
                                                          -

                                                          - getUrl() - -

                                                          - - - - - public - abstract getUrl() : string - - - - - -
                                                          Return values
                                                          - string - — - - -
                                                          - -
                                                          -

                                                          - requestWithJwt() - -

                                                          - - -

                                                          It does a http request with Jwt authentication. If there is an error throws an ApiException

                                                          - - - protected - requestWithJwt(string $url, string $method[, class-string<\Doofinder\Shared\Interfaces\ModelInterface> $model = null ][, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $headers = [] ]) : HttpResponseInterface - - -
                                                          Parameters
                                                          -
                                                          -
                                                          - $url - : string -
                                                          -
                                                          - -
                                                          -
                                                          - $method - : string -
                                                          -
                                                          - -
                                                          -
                                                          - $model - : class-string<\Doofinder\Shared\Interfaces\ModelInterface> - = null
                                                          -
                                                          - -
                                                          -
                                                          - $params - : array<string|int, mixed> - = []
                                                          -
                                                          - -
                                                          -
                                                          - $headers - : array<string|int, mixed> - = []
                                                          -
                                                          - -
                                                          -
                                                          - - -
                                                          - Tags - -
                                                          -
                                                          -
                                                          - throws -
                                                          -
                                                          - ApiException - - -
                                                          -
                                                          - -
                                                          Return values
                                                          - HttpResponseInterface - — - - -
                                                          -
                                                          -

                                                          - requestWithToken() - -

                                                          - - -

                                                          It does a http request with Token authentication. If there is an error throws an ApiException

                                                          - - - protected - requestWithToken(string $url, string $method[, class-string<\Doofinder\Shared\Interfaces\ModelInterface> $model = null ][, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $headers = [] ]) : HttpResponseInterface - - -
                                                          Parameters
                                                          -
                                                          -
                                                          - $url - : string -
                                                          -
                                                          - -
                                                          -
                                                          - $method - : string -
                                                          -
                                                          - -
                                                          -
                                                          - $model - : class-string<\Doofinder\Shared\Interfaces\ModelInterface> - = null
                                                          -
                                                          - -
                                                          -
                                                          - $params - : array<string|int, mixed> - = []
                                                          -
                                                          - -
                                                          -
                                                          - $headers - : array<string|int, mixed> - = []
                                                          -
                                                          - -
                                                          -
                                                          - - -
                                                          - Tags - -
                                                          -
                                                          -
                                                          - throws -
                                                          -
                                                          - ApiException - - -
                                                          -
                                                          - -
                                                          Return values
                                                          - HttpResponseInterface - — - - -
                                                          -
                                                          -

                                                          - request() - -

                                                          - - -

                                                          It does a http request. If there is an error throws an ApiException

                                                          - - - private - request(string $url, string $method[, class-string<\Doofinder\Shared\Interfaces\ModelInterface> $model = null ][, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $headers = [] ]) : HttpResponseInterface - - -
                                                          Parameters
                                                          -
                                                          -
                                                          - $url - : string -
                                                          -
                                                          - -
                                                          -
                                                          - $method - : string -
                                                          -
                                                          - -
                                                          -
                                                          - $model - : class-string<\Doofinder\Shared\Interfaces\ModelInterface> - = null
                                                          -
                                                          - -
                                                          -
                                                          - $params - : array<string|int, mixed> - = []
                                                          -
                                                          - -
                                                          -
                                                          - $headers - : array<string|int, mixed> - = []
                                                          -
                                                          - -
                                                          -
                                                          - - -
                                                          - Tags - -
                                                          -
                                                          -
                                                          - throws -
                                                          -
                                                          - ApiException - - -
                                                          -
                                                          - -
                                                          Return values
                                                          - HttpResponseInterface - — - - -
                                                          -
                                                          - - - - -
                                                          -
                                                          -
                                                          -
                                                          -

                                                          Search results

                                                          - -
                                                          -
                                                          -
                                                            -
                                                            -
                                                            -
                                                            -
                                                            -
                                                            - - -
                                                            - - - - - - - - diff --git a/doc/classes/Doofinder-Shared-Services-Jwt.html b/doc/classes/Doofinder-Shared-Services-Jwt.html deleted file mode 100644 index 203e92e..0000000 --- a/doc/classes/Doofinder-Shared-Services-Jwt.html +++ /dev/null @@ -1,389 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                            -

                                                            Documentation

                                                            - - - - - -
                                                            - -
                                                            -
                                                            - - - - -
                                                            - - -
                                                            -

                                                            - Jwt - - -
                                                            - in package - -
                                                            - - -

                                                            - - - -

                                                            Utility to generate a Json Web Token (JWT) to do requests to Doofinder API services

                                                            - - - - - - - - - -

                                                            - Table of Contents - -

                                                            - -
                                                            -
                                                            - HEADER - -  = '{"alg": "HS256", "typ": "JWT"}' -
                                                            -
                                                            - -
                                                            - generateToken() - -  : string -
                                                            -
                                                            Given an api token and secret generates a JWT
                                                            - -
                                                            - base64url_encode() - -  : array<string|int, mixed>|string|array<string|int, string> -
                                                            -
                                                            - -
                                                            - - - - -
                                                            -

                                                            - Constants - -

                                                            -
                                                            -

                                                            - HEADER - -

                                                            - - - - - - public - mixed - HEADER - = '{"alg": "HS256", "typ": "JWT"}' - - - -
                                                            - -
                                                            - - - -
                                                            -
                                                            - - - -
                                                            -

                                                            - Methods - -

                                                            -
                                                            -

                                                            - generateToken() - -

                                                            - - -

                                                            Given an api token and secret generates a JWT

                                                            - - - public - static generateToken(string $secret, string $name) : string - - -
                                                            Parameters
                                                            -
                                                            -
                                                            - $secret - : string -
                                                            -
                                                            - -
                                                            -
                                                            - $name - : string -
                                                            -
                                                            - -
                                                            -
                                                            - - - -
                                                            Return values
                                                            - string - — - - -
                                                            -
                                                            -

                                                            - base64url_encode() - -

                                                            - - - - - private - static base64url_encode(string $data) : array<string|int, mixed>|string|array<string|int, string> - - -
                                                            Parameters
                                                            -
                                                            -
                                                            - $data - : string -
                                                            -
                                                            - -
                                                            -
                                                            - - - -
                                                            Return values
                                                            - array<string|int, mixed>|string|array<string|int, string> - — - - -
                                                            -
                                                            - - - - -
                                                            -
                                                            -
                                                            -
                                                            -

                                                            Search results

                                                            - -
                                                            -
                                                            -
                                                              -
                                                              -
                                                              -
                                                              -
                                                              -
                                                              - - -
                                                              - - - - - - - - diff --git a/doc/classes/Doofinder-Shared-Utils-ErrorHandler.html b/doc/classes/Doofinder-Shared-Utils-ErrorHandler.html deleted file mode 100644 index 7ef60a4..0000000 --- a/doc/classes/Doofinder-Shared-Utils-ErrorHandler.html +++ /dev/null @@ -1,433 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                              -

                                                              Documentation

                                                              - - - - - -
                                                              - -
                                                              -
                                                              - - - - -
                                                              - - -
                                                              -

                                                              - ErrorHandler - - -
                                                              - in package - -
                                                              - - -

                                                              - - - -

                                                              Class in charge on mapping response message to client message

                                                              - - - - - - - - - -

                                                              - Table of Contents - -

                                                              - -
                                                              -
                                                              - DEFAULT_FIELD - -  = 'default' -
                                                              -
                                                              - -
                                                              - MESSAGES - -  = [DoofinderSharedHttpStatusCode::BAD_REQUEST => ['bad_params' => 'Request contains wrong parameter or values.', 'index_internal_error' => 'Request contains wrong parameter or values.', 'invalid_boost_value' => 'Invalid value for item boost field.', 'invalid_field_name' => 'Items field names contains invalid characters.', self::DEFAULT_FIELD => 'The client made a bad request.'], DoofinderSharedHttpStatusCode::UNAUTHORIZED => 'The user hasn't provided valid authorization.', DoofinderSharedHttpStatusCode::FORBIDDEN => 'The user does not have permissions to perform this operation.', DoofinderSharedHttpStatusCode::NOT_FOUND => 'Not Found.', DoofinderSharedHttpStatusCode::REQUEST_TIMEOUT => 'Operation has surpassed time limit.', DoofinderSharedHttpStatusCode::CONFLICT => ['searchengine_locked' => 'The request search engine is locked by another operation.', 'too_many_temporary' => 'There are too many temporary index.', self::DEFAULT_FIELD => 'Request conflict.'], DoofinderSharedHttpStatusCode::REQUEST_ENTITY_TOO_LARGE => 'Requests contains too many items.', DoofinderSharedHttpStatusCode::TOO_MANY_REQUESTS => 'Too many requests by second.', DoofinderSharedHttpStatusCode::INTERNAL_SERVER_ERROR => 'Server error.', DoofinderSharedHttpStatusCode::BAD_GATEWAY => 'Bad Gateway Error connecting to Doofinder.', self::DEFAULT_FIELD => 'Unknown error'] -
                                                              -
                                                              - -
                                                              - create() - -  : ApiException -
                                                              -
                                                              - -
                                                              - getErrorCode() - -  : string|array<string|int, mixed> -
                                                              -
                                                              - -
                                                              - - - - -
                                                              -

                                                              - Constants - -

                                                              -
                                                              -

                                                              - DEFAULT_FIELD - -

                                                              - - - - - - public - mixed - DEFAULT_FIELD - = 'default' - - - -
                                                              - -
                                                              - - - -
                                                              -
                                                              -

                                                              - MESSAGES - -

                                                              - - - - - - public - mixed - MESSAGES - = [DoofinderSharedHttpStatusCode::BAD_REQUEST => ['bad_params' => 'Request contains wrong parameter or values.', 'index_internal_error' => 'Request contains wrong parameter or values.', 'invalid_boost_value' => 'Invalid value for item boost field.', 'invalid_field_name' => 'Items field names contains invalid characters.', self::DEFAULT_FIELD => 'The client made a bad request.'], DoofinderSharedHttpStatusCode::UNAUTHORIZED => 'The user hasn't provided valid authorization.', DoofinderSharedHttpStatusCode::FORBIDDEN => 'The user does not have permissions to perform this operation.', DoofinderSharedHttpStatusCode::NOT_FOUND => 'Not Found.', DoofinderSharedHttpStatusCode::REQUEST_TIMEOUT => 'Operation has surpassed time limit.', DoofinderSharedHttpStatusCode::CONFLICT => ['searchengine_locked' => 'The request search engine is locked by another operation.', 'too_many_temporary' => 'There are too many temporary index.', self::DEFAULT_FIELD => 'Request conflict.'], DoofinderSharedHttpStatusCode::REQUEST_ENTITY_TOO_LARGE => 'Requests contains too many items.', DoofinderSharedHttpStatusCode::TOO_MANY_REQUESTS => 'Too many requests by second.', DoofinderSharedHttpStatusCode::INTERNAL_SERVER_ERROR => 'Server error.', DoofinderSharedHttpStatusCode::BAD_GATEWAY => 'Bad Gateway Error connecting to Doofinder.', self::DEFAULT_FIELD => 'Unknown error'] - - - -
                                                              - -
                                                              - - - -
                                                              -
                                                              - - - -
                                                              -

                                                              - Methods - -

                                                              -
                                                              -

                                                              - create() - -

                                                              - - - - - public - static create(int $statusCode, string $response[, Throwable $exception = null ]) : ApiException - - -
                                                              Parameters
                                                              -
                                                              -
                                                              - $statusCode - : int -
                                                              -
                                                              - -
                                                              -
                                                              - $response - : string -
                                                              -
                                                              - -
                                                              -
                                                              - $exception - : Throwable - = null
                                                              -
                                                              - -
                                                              -
                                                              - - - -
                                                              Return values
                                                              - ApiException - — - - -
                                                              -
                                                              -

                                                              - getErrorCode() - -

                                                              - - - - - private - static getErrorCode(string $response) : string|array<string|int, mixed> - - -
                                                              Parameters
                                                              -
                                                              -
                                                              - $response - : string -
                                                              -
                                                              - -
                                                              -
                                                              - - - -
                                                              Return values
                                                              - string|array<string|int, mixed> - — -

                                                              $headers

                                                              -
                                                              - - -
                                                              -
                                                              - - - - -
                                                              -
                                                              -
                                                              -
                                                              -

                                                              Search results

                                                              - -
                                                              -
                                                              -
                                                                -
                                                                -
                                                                -
                                                                -
                                                                -
                                                                - - -
                                                                - - - - - - - - diff --git a/doc/css/base.css b/doc/css/base.css deleted file mode 100644 index db4e807..0000000 --- a/doc/css/base.css +++ /dev/null @@ -1,1087 +0,0 @@ - -:root { - /* Typography */ - --font-primary: 'Source Sans Pro', Helvetica, Arial, sans-serif; - --font-secondary: 'Source Sans Pro', 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)); - - /* Colors */ - --primary-color: hsl(96, 57%, 60%); - --primary-color-darken: hsl(96, 57%, 40%); - --primary-color-darker: hsl(96, 57%, 20%); - --primary-color-darkest: hsl(96, 57%, 10%); - --primary-color-lighten: hsl(96, 57%, 80%); - --primary-color-lighter: hsl(96, 57%, 99%); - --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: #f7faf5; - --code-border-color: #d6e7cb; - --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-darken); - --link-hover-color-primary: var(--primary-color-darker); - --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); -} - -.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 -{ - 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-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-lg); - position: relative; - width: 100%; -} - -@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; -} - -.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; -} -div.phpdocumentor-list > ul, -ul.phpdocumentor-list { - list-style: circle inside; -} - -ol.phpdocumentor-list { - list-style: decimal inside; -} - -div.phpdocumentor-list > ul, -ol.phpdocumentor-list, -ul.phpdocumentor-list { - margin-top: 0; - padding-left: 0; - margin-bottom: var(--spacing-md); -} - -dl { - margin-bottom: var(--spacing-md); -} - -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: var(--spacing-xs) 0 var(--spacing-xs) calc(var(--spacing-xs) * 2); -} - -li.phpdocumentor-list { - margin-bottom: var(--spacing-md); -} - -.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-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: 30.6666666667%; - 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 { - 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-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-content { - position: relative; -} - -.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; -} - -.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; -} - -.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; -} - -/* Used for screen readers and such */ -.visually-hidden { - display: none; -} - -.float-right { - float: right; -} - -.float-left { - float: left; -} diff --git a/doc/css/normalize.css b/doc/css/normalize.css deleted file mode 100644 index 579152b..0000000 --- a/doc/css/normalize.css +++ /dev/null @@ -1,427 +0,0 @@ -/*! 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; -} - -/* 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/doc/css/template.css b/doc/css/template.css deleted file mode 100644 index 31f00e3..0000000 --- a/doc/css/template.css +++ /dev/null @@ -1,188 +0,0 @@ -.phpdocumentor-summary { - font-style: italic; -} -.phpdocumentor-description { - margin-bottom: var(--spacing-md); -} -.phpdocumentor-element { - position: relative; -} - -.phpdocumentor .phpdocumentor-element__name { - line-height: 1; -} - -.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-element:not(:last-child) { - border-bottom: 1px solid var(--primary-color-lighten); - padding-bottom: var(--spacing-lg); -} - -.phpdocumentor-element.-deprecated .phpdocumentor-element__name { - text-decoration: line-through; -} - -.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-signature { - display: inline-block; - font-size: var(--text-sm); - margin-bottom: var(--spacing-md); -} - -.phpdocumentor-signature.-deprecated .phpdocumentor-signature__name { - text-decoration: line-through; -} -.phpdocumentor-table-of-contents { -} - -.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry { - padding-top: var(--spacing-xs); - 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'; - background-image: url('data:image/svg+xml;utf8,'); -} - -.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-function:before { - content: 'M'; - 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 dd { - font-style: italic; - margin-left: 2rem; -} -.phpdocumentor-element-found-in { - position: absolute; - top: 0; - right: 0; - font-size: var(--text-sm); - color: gray; -} - -.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/doc/files/src-configuration.html b/doc/files/src-configuration.html deleted file mode 100644 index 85fd280..0000000 --- a/doc/files/src-configuration.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                -

                                                                Documentation

                                                                - - - - - -
                                                                - -
                                                                -
                                                                - - - - -
                                                                -
                                                                  -
                                                                - -
                                                                -

                                                                Configuration.php

                                                                - - -
                                                                - - - - - - -

                                                                - Interfaces, Classes and Traits - -

                                                                - -
                                                                - -
                                                                Configuration
                                                                -
                                                                Class with API configuration
                                                                - -
                                                                - - - - - - - - -
                                                                -
                                                                -
                                                                -
                                                                -

                                                                Search results

                                                                - -
                                                                -
                                                                -
                                                                  -
                                                                  -
                                                                  -
                                                                  -
                                                                  -
                                                                  - - -
                                                                  - - - - - - - - diff --git a/doc/files/src-management-managementclient.html b/doc/files/src-management-managementclient.html deleted file mode 100644 index 75092e8..0000000 --- a/doc/files/src-management-managementclient.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                  -

                                                                  Documentation

                                                                  - - - - - -
                                                                  - -
                                                                  -
                                                                  - - - - -
                                                                  -
                                                                    -
                                                                  - -
                                                                  -

                                                                  ManagementClient.php

                                                                  - - -
                                                                  - - - - - - -

                                                                  - Interfaces, Classes and Traits - -

                                                                  - -
                                                                  - -
                                                                  ManagementClient
                                                                  -
                                                                  This class is used to do management actions against search engines, index and items through calling an API.
                                                                  - -
                                                                  - - - - - - - - -
                                                                  -
                                                                  -
                                                                  -
                                                                  -

                                                                  Search results

                                                                  - -
                                                                  -
                                                                  -
                                                                    -
                                                                    -
                                                                    -
                                                                    -
                                                                    -
                                                                    - - -
                                                                    - - - - - - - - diff --git a/doc/files/src-management-model-datasource.html b/doc/files/src-management-model-datasource.html deleted file mode 100644 index e892463..0000000 --- a/doc/files/src-management-model-datasource.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                    -

                                                                    Documentation

                                                                    - - - - - -
                                                                    - -
                                                                    -
                                                                    - - - - -
                                                                    -
                                                                      -
                                                                    - -
                                                                    -

                                                                    DataSource.php

                                                                    - - -
                                                                    - - - - - - -

                                                                    - Interfaces, Classes and Traits - -

                                                                    - -
                                                                    - -
                                                                    DataSource
                                                                    -
                                                                    Model with data of a given data source
                                                                    - -
                                                                    - - - - - - - - -
                                                                    -
                                                                    -
                                                                    -
                                                                    -

                                                                    Search results

                                                                    - -
                                                                    -
                                                                    -
                                                                      -
                                                                      -
                                                                      -
                                                                      -
                                                                      -
                                                                      - - -
                                                                      - - - - - - - - diff --git a/doc/files/src-management-model-datasourceoption.html b/doc/files/src-management-model-datasourceoption.html deleted file mode 100644 index 89a1d70..0000000 --- a/doc/files/src-management-model-datasourceoption.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                      -

                                                                      Documentation

                                                                      - - - - - -
                                                                      - -
                                                                      -
                                                                      - - - - -
                                                                      -
                                                                        -
                                                                      - -
                                                                      -

                                                                      DataSourceOption.php

                                                                      - - -
                                                                      - - - - - - -

                                                                      - Interfaces, Classes and Traits - -

                                                                      - -
                                                                      - -
                                                                      DataSourceOption
                                                                      -
                                                                      Model with data of a given data source option
                                                                      - -
                                                                      - - - - - - - - -
                                                                      -
                                                                      -
                                                                      -
                                                                      -

                                                                      Search results

                                                                      - -
                                                                      -
                                                                      -
                                                                        -
                                                                        -
                                                                        -
                                                                        -
                                                                        -
                                                                        - - -
                                                                        - - - - - - - - diff --git a/doc/files/src-management-model-datasourceoptionbigcommerce.html b/doc/files/src-management-model-datasourceoptionbigcommerce.html deleted file mode 100644 index 9d0bf59..0000000 --- a/doc/files/src-management-model-datasourceoptionbigcommerce.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                        -

                                                                        Documentation

                                                                        - - - - - -
                                                                        - -
                                                                        -
                                                                        - - - - -
                                                                        -
                                                                          -
                                                                        - -
                                                                        -

                                                                        DataSourceOptionBigCommerce.php

                                                                        - - -
                                                                        - - - - - - -

                                                                        - Interfaces, Classes and Traits - -

                                                                        - -
                                                                        - -
                                                                        DataSourceOptionBigCommerce
                                                                        -
                                                                        Model with data of a given "big commerce" data source option
                                                                        - -
                                                                        - - - - - - - - -
                                                                        -
                                                                        -
                                                                        -
                                                                        -

                                                                        Search results

                                                                        - -
                                                                        -
                                                                        -
                                                                          -
                                                                          -
                                                                          -
                                                                          -
                                                                          -
                                                                          - - -
                                                                          - - - - - - - - diff --git a/doc/files/src-management-model-datasourceoptionekm.html b/doc/files/src-management-model-datasourceoptionekm.html deleted file mode 100644 index 88846fa..0000000 --- a/doc/files/src-management-model-datasourceoptionekm.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                          -

                                                                          Documentation

                                                                          - - - - - -
                                                                          - -
                                                                          -
                                                                          - - - - -
                                                                          -
                                                                            -
                                                                          - -
                                                                          -

                                                                          DataSourceOptionEkm.php

                                                                          - - -
                                                                          - - - - - - -

                                                                          - Interfaces, Classes and Traits - -

                                                                          - -
                                                                          - -
                                                                          DataSourceOptionEkm
                                                                          -
                                                                          Model with data of a given "ekm" data source option
                                                                          - -
                                                                          - - - - - - - - -
                                                                          -
                                                                          -
                                                                          -
                                                                          -

                                                                          Search results

                                                                          - -
                                                                          -
                                                                          -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            - - -
                                                                            - - - - - - - - diff --git a/doc/files/src-management-model-datasourceoptionfile.html b/doc/files/src-management-model-datasourceoptionfile.html deleted file mode 100644 index 1f816af..0000000 --- a/doc/files/src-management-model-datasourceoptionfile.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                            -

                                                                            Documentation

                                                                            - - - - - -
                                                                            - -
                                                                            -
                                                                            - - - - -
                                                                            -
                                                                              -
                                                                            - -
                                                                            -

                                                                            DataSourceOptionFile.php

                                                                            - - -
                                                                            - - - - - - -

                                                                            - Interfaces, Classes and Traits - -

                                                                            - -
                                                                            - -
                                                                            DataSourceOptionFile
                                                                            -
                                                                            Model with data of a given "file" data source option
                                                                            - -
                                                                            - - - - - - - - -
                                                                            -
                                                                            -
                                                                            -
                                                                            -

                                                                            Search results

                                                                            - -
                                                                            -
                                                                            -
                                                                              -
                                                                              -
                                                                              -
                                                                              -
                                                                              -
                                                                              - - -
                                                                              - - - - - - - - diff --git a/doc/files/src-management-model-datasourceoptionmagento.html b/doc/files/src-management-model-datasourceoptionmagento.html deleted file mode 100644 index 9b005fc..0000000 --- a/doc/files/src-management-model-datasourceoptionmagento.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                              -

                                                                              Documentation

                                                                              - - - - - -
                                                                              - -
                                                                              -
                                                                              - - - - -
                                                                              -
                                                                                -
                                                                              - -
                                                                              -

                                                                              DataSourceOptionMagento.php

                                                                              - - -
                                                                              - - - - - - -

                                                                              - Interfaces, Classes and Traits - -

                                                                              - -
                                                                              - -
                                                                              DataSourceOptionMagento
                                                                              -
                                                                              Model with data of a given "magento" data source option
                                                                              - -
                                                                              - - - - - - - - -
                                                                              -
                                                                              -
                                                                              -
                                                                              -

                                                                              Search results

                                                                              - -
                                                                              -
                                                                              -
                                                                                -
                                                                                -
                                                                                -
                                                                                -
                                                                                -
                                                                                - - -
                                                                                - - - - - - - - diff --git a/doc/files/src-management-model-datasourceoptionshopify.html b/doc/files/src-management-model-datasourceoptionshopify.html deleted file mode 100644 index 80d6c38..0000000 --- a/doc/files/src-management-model-datasourceoptionshopify.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                -

                                                                                Documentation

                                                                                - - - - - -
                                                                                - -
                                                                                -
                                                                                - - - - -
                                                                                -
                                                                                  -
                                                                                - -
                                                                                -

                                                                                DataSourceOptionShopify.php

                                                                                - - -
                                                                                - - - - - - -

                                                                                - Interfaces, Classes and Traits - -

                                                                                - -
                                                                                - -
                                                                                DataSourceOptionShopify
                                                                                -
                                                                                Model with data of a given "shopify" data source option
                                                                                - -
                                                                                - - - - - - - - -
                                                                                -
                                                                                -
                                                                                -
                                                                                -

                                                                                Search results

                                                                                - -
                                                                                -
                                                                                -
                                                                                  -
                                                                                  -
                                                                                  -
                                                                                  -
                                                                                  -
                                                                                  - - -
                                                                                  - - - - - - - - diff --git a/doc/files/src-management-model-index.html b/doc/files/src-management-model-index.html deleted file mode 100644 index 4f30846..0000000 --- a/doc/files/src-management-model-index.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                  -

                                                                                  Documentation

                                                                                  - - - - - -
                                                                                  - -
                                                                                  -
                                                                                  - - - - -
                                                                                  -
                                                                                    -
                                                                                  - -
                                                                                  -

                                                                                  Index.php

                                                                                  - - -
                                                                                  - - - - - - -

                                                                                  - Interfaces, Classes and Traits - -

                                                                                  - -
                                                                                  - -
                                                                                  Index
                                                                                  -
                                                                                  Model with data of a given index
                                                                                  - -
                                                                                  - - - - - - - - -
                                                                                  -
                                                                                  -
                                                                                  -
                                                                                  -

                                                                                  Search results

                                                                                  - -
                                                                                  -
                                                                                  -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    - - -
                                                                                    - - - - - - - - diff --git a/doc/files/src-management-model-item.html b/doc/files/src-management-model-item.html deleted file mode 100644 index 3b4cf6f..0000000 --- a/doc/files/src-management-model-item.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                    -

                                                                                    Documentation

                                                                                    - - - - - -
                                                                                    - -
                                                                                    -
                                                                                    - - - - -
                                                                                    -
                                                                                      -
                                                                                    - -
                                                                                    -

                                                                                    Item.php

                                                                                    - - -
                                                                                    - - - - - - -

                                                                                    - Interfaces, Classes and Traits - -

                                                                                    - -
                                                                                    - -
                                                                                    Item
                                                                                    -
                                                                                    Model with data of a given item
                                                                                    - -
                                                                                    - - - - - - - - -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    -

                                                                                    Search results

                                                                                    - -
                                                                                    -
                                                                                    -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      - - -
                                                                                      - - - - - - - - diff --git a/doc/files/src-management-model-searchengine.html b/doc/files/src-management-model-searchengine.html deleted file mode 100644 index 409045d..0000000 --- a/doc/files/src-management-model-searchengine.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                      -

                                                                                      Documentation

                                                                                      - - - - - -
                                                                                      - -
                                                                                      -
                                                                                      - - - - -
                                                                                      -
                                                                                        -
                                                                                      - -
                                                                                      -

                                                                                      SearchEngine.php

                                                                                      - - -
                                                                                      - - - - - - -

                                                                                      - Interfaces, Classes and Traits - -

                                                                                      - -
                                                                                      - -
                                                                                      SearchEngine
                                                                                      -
                                                                                      Model with data of a given search engine
                                                                                      - -
                                                                                      - - - - - - - - -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -

                                                                                      Search results

                                                                                      - -
                                                                                      -
                                                                                      -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        - - - - - - - - diff --git a/doc/files/src-management-resources-index.html b/doc/files/src-management-resources-index.html deleted file mode 100644 index 52c2b5b..0000000 --- a/doc/files/src-management-resources-index.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                        -

                                                                                        Documentation

                                                                                        - - - - - -
                                                                                        - -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                          -
                                                                                        - -
                                                                                        -

                                                                                        Index.php

                                                                                        - - -
                                                                                        - - - - - - -

                                                                                        - Interfaces, Classes and Traits - -

                                                                                        - -
                                                                                        - -
                                                                                        Index
                                                                                        -
                                                                                        Index class is responsible for making the requests to the index's endpoints and return a response
                                                                                        - -
                                                                                        - - - - - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Search results

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          - - -
                                                                                          - - - - - - - - diff --git a/doc/files/src-management-resources-item.html b/doc/files/src-management-resources-item.html deleted file mode 100644 index 10b5606..0000000 --- a/doc/files/src-management-resources-item.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                          -

                                                                                          Documentation

                                                                                          - - - - - -
                                                                                          - -
                                                                                          -
                                                                                          - - - - -
                                                                                          -
                                                                                            -
                                                                                          - -
                                                                                          -

                                                                                          Item.php

                                                                                          - - -
                                                                                          - - - - - - -

                                                                                          - Interfaces, Classes and Traits - -

                                                                                          - -
                                                                                          - -
                                                                                          Item
                                                                                          -
                                                                                          Item class is responsible for making the requests to the item's endpoints and return a response
                                                                                          - -
                                                                                          - - - - - - - - -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          -

                                                                                          Search results

                                                                                          - -
                                                                                          -
                                                                                          -
                                                                                            -
                                                                                            -
                                                                                            -
                                                                                            -
                                                                                            -
                                                                                            - - -
                                                                                            - - - - - - - - diff --git a/doc/files/src-management-resources-managementresource.html b/doc/files/src-management-resources-managementresource.html deleted file mode 100644 index 94688ea..0000000 --- a/doc/files/src-management-resources-managementresource.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                            -

                                                                                            Documentation

                                                                                            - - - - - -
                                                                                            - -
                                                                                            -
                                                                                            - - - - -
                                                                                            -
                                                                                              -
                                                                                            - -
                                                                                            -

                                                                                            ManagementResource.php

                                                                                            - - -
                                                                                            - - - - - - -

                                                                                            - Interfaces, Classes and Traits - -

                                                                                            - -
                                                                                            - -
                                                                                            ManagementResource
                                                                                            -
                                                                                            A resource class is in charge to communicate with the API and return a formatted response
                                                                                            - -
                                                                                            - - - - - - - - -
                                                                                            -
                                                                                            -
                                                                                            -
                                                                                            -

                                                                                            Search results

                                                                                            - -
                                                                                            -
                                                                                            -
                                                                                              -
                                                                                              -
                                                                                              -
                                                                                              -
                                                                                              -
                                                                                              - - -
                                                                                              - - - - - - - - diff --git a/doc/files/src-management-resources-searchengine.html b/doc/files/src-management-resources-searchengine.html deleted file mode 100644 index 7e503df..0000000 --- a/doc/files/src-management-resources-searchengine.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                              -

                                                                                              Documentation

                                                                                              - - - - - -
                                                                                              - -
                                                                                              -
                                                                                              - - - - -
                                                                                              -
                                                                                                -
                                                                                              - -
                                                                                              -

                                                                                              SearchEngine.php

                                                                                              - - -
                                                                                              - - - - - - -

                                                                                              - Interfaces, Classes and Traits - -

                                                                                              - -
                                                                                              - -
                                                                                              SearchEngine
                                                                                              -
                                                                                              SearchEngines class is responsible for making the requests to the search_engine's endpoints and return a response
                                                                                              - -
                                                                                              - - - - - - - - -
                                                                                              -
                                                                                              -
                                                                                              -
                                                                                              -

                                                                                              Search results

                                                                                              - -
                                                                                              -
                                                                                              -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                - - -
                                                                                                - - - - - - - - diff --git a/doc/files/src-search-resources-search.html b/doc/files/src-search-resources-search.html deleted file mode 100644 index eba23bb..0000000 --- a/doc/files/src-search-resources-search.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                -

                                                                                                Documentation

                                                                                                - - - - - -
                                                                                                - -
                                                                                                -
                                                                                                - - - - -
                                                                                                -
                                                                                                  -
                                                                                                - -
                                                                                                -

                                                                                                Search.php

                                                                                                - - -
                                                                                                - - - - - - -

                                                                                                - Interfaces, Classes and Traits - -

                                                                                                - -
                                                                                                - -
                                                                                                Search
                                                                                                -
                                                                                                Search class is responsible for making the requests to the search's endpoint and return a response
                                                                                                - -
                                                                                                - - - - - - - - -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -

                                                                                                Search results

                                                                                                - -
                                                                                                -
                                                                                                -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  - - -
                                                                                                  - - - - - - - - diff --git a/doc/files/src-search-resources-searchresource.html b/doc/files/src-search-resources-searchresource.html deleted file mode 100644 index 0ce7b8f..0000000 --- a/doc/files/src-search-resources-searchresource.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                  -

                                                                                                  Documentation

                                                                                                  - - - - - -
                                                                                                  - -
                                                                                                  -
                                                                                                  - - - - -
                                                                                                  -
                                                                                                    -
                                                                                                  - -
                                                                                                  -

                                                                                                  SearchResource.php

                                                                                                  - - -
                                                                                                  - - - - - - -

                                                                                                  - Interfaces, Classes and Traits - -

                                                                                                  - -
                                                                                                  - -
                                                                                                  SearchResource
                                                                                                  -
                                                                                                  A resource class is in charge to communicate with the API and return a formatted response
                                                                                                  - -
                                                                                                  - - - - - - - - -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -

                                                                                                  Search results

                                                                                                  - -
                                                                                                  -
                                                                                                  -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    - - -
                                                                                                    - - - - - - - - diff --git a/doc/files/src-search-resources-stats.html b/doc/files/src-search-resources-stats.html deleted file mode 100644 index 8ee6bfc..0000000 --- a/doc/files/src-search-resources-stats.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                    -

                                                                                                    Documentation

                                                                                                    - - - - - -
                                                                                                    - -
                                                                                                    -
                                                                                                    - - - - -
                                                                                                    -
                                                                                                      -
                                                                                                    - -
                                                                                                    -

                                                                                                    Stats.php

                                                                                                    - - -
                                                                                                    - - - - - - -

                                                                                                    - Interfaces, Classes and Traits - -

                                                                                                    - -
                                                                                                    - -
                                                                                                    Stats
                                                                                                    -
                                                                                                    Stats class is responsible for making the requests to the Stats's endpoint and return a response
                                                                                                    - -
                                                                                                    - - - - - - - - -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -

                                                                                                    Search results

                                                                                                    - -
                                                                                                    -
                                                                                                    -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      - - -
                                                                                                      - - - - - - - - diff --git a/doc/files/src-search-searchclient.html b/doc/files/src-search-searchclient.html deleted file mode 100644 index 95e801d..0000000 --- a/doc/files/src-search-searchclient.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                      -

                                                                                                      Documentation

                                                                                                      - - - - - -
                                                                                                      - -
                                                                                                      -
                                                                                                      - - - - -
                                                                                                      -
                                                                                                        -
                                                                                                      - -
                                                                                                      -

                                                                                                      SearchClient.php

                                                                                                      - - -
                                                                                                      - - - - - - -

                                                                                                      - Interfaces, Classes and Traits - -

                                                                                                      - -
                                                                                                      - -
                                                                                                      SearchClient
                                                                                                      -
                                                                                                      This class is used to do searches through calling an API.
                                                                                                      - -
                                                                                                      - - - - - - - - -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -

                                                                                                      Search results

                                                                                                      - -
                                                                                                      -
                                                                                                      -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        - - -
                                                                                                        - - - - - - - - diff --git a/doc/files/src-shared-exceptions-apiexception.html b/doc/files/src-shared-exceptions-apiexception.html deleted file mode 100644 index 36f23bc..0000000 --- a/doc/files/src-shared-exceptions-apiexception.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                        -

                                                                                                        Documentation

                                                                                                        - - - - - -
                                                                                                        - -
                                                                                                        -
                                                                                                        - - - - -
                                                                                                        -
                                                                                                          -
                                                                                                        - -
                                                                                                        -

                                                                                                        ApiException.php

                                                                                                        - - -
                                                                                                        - - - - - - -

                                                                                                        - Interfaces, Classes and Traits - -

                                                                                                        - -
                                                                                                        - -
                                                                                                        ApiException
                                                                                                        -
                                                                                                        Exception used when API request returns a not OK response
                                                                                                        - -
                                                                                                        - - - - - - - - -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -

                                                                                                        Search results

                                                                                                        - -
                                                                                                        -
                                                                                                        -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          - - -
                                                                                                          - - - - - - - - diff --git a/doc/files/src-shared-exceptions-requestexception.html b/doc/files/src-shared-exceptions-requestexception.html deleted file mode 100644 index af789fb..0000000 --- a/doc/files/src-shared-exceptions-requestexception.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                          -

                                                                                                          Documentation

                                                                                                          - - - - - -
                                                                                                          - -
                                                                                                          -
                                                                                                          - - - - -
                                                                                                          -
                                                                                                            -
                                                                                                          - -
                                                                                                          -

                                                                                                          RequestException.php

                                                                                                          - - -
                                                                                                          - - - - - - -

                                                                                                          - Interfaces, Classes and Traits - -

                                                                                                          - -
                                                                                                          - -
                                                                                                          RequestException
                                                                                                          -
                                                                                                          Exception used when there is an error in the http request
                                                                                                          - -
                                                                                                          - - - - - - - - -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -

                                                                                                          Search results

                                                                                                          - -
                                                                                                          -
                                                                                                          -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            - - -
                                                                                                            - - - - - - - - diff --git a/doc/files/src-shared-httpclient.html b/doc/files/src-shared-httpclient.html deleted file mode 100644 index e69bb0c..0000000 --- a/doc/files/src-shared-httpclient.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                            -

                                                                                                            Documentation

                                                                                                            - - - - - -
                                                                                                            - -
                                                                                                            -
                                                                                                            - - - - -
                                                                                                            -
                                                                                                              -
                                                                                                            - -
                                                                                                            -

                                                                                                            HttpClient.php

                                                                                                            - - -
                                                                                                            - - - - - - -

                                                                                                            - Interfaces, Classes and Traits - -

                                                                                                            - -
                                                                                                            - -
                                                                                                            HttpClient
                                                                                                            -
                                                                                                            Class to do requests though curl utility
                                                                                                            - -
                                                                                                            - - - - - - - - -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -

                                                                                                            Search results

                                                                                                            - -
                                                                                                            -
                                                                                                            -
                                                                                                              -
                                                                                                              -
                                                                                                              -
                                                                                                              -
                                                                                                              -
                                                                                                              - - -
                                                                                                              - - - - - - - - diff --git a/doc/files/src-shared-httpresponse.html b/doc/files/src-shared-httpresponse.html deleted file mode 100644 index 8d77b84..0000000 --- a/doc/files/src-shared-httpresponse.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                              -

                                                                                                              Documentation

                                                                                                              - - - - - -
                                                                                                              - -
                                                                                                              -
                                                                                                              - - - - -
                                                                                                              -
                                                                                                                -
                                                                                                              - -
                                                                                                              -

                                                                                                              HttpResponse.php

                                                                                                              - - -
                                                                                                              - - - - - - -

                                                                                                              - Interfaces, Classes and Traits - -

                                                                                                              - -
                                                                                                              - -
                                                                                                              HttpResponse
                                                                                                              -
                                                                                                              Class to return a formatted info comming from API
                                                                                                              - -
                                                                                                              - - - - - - - - -
                                                                                                              -
                                                                                                              -
                                                                                                              -
                                                                                                              -

                                                                                                              Search results

                                                                                                              - -
                                                                                                              -
                                                                                                              -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                - - -
                                                                                                                - - - - - - - - diff --git a/doc/files/src-shared-httpstatuscode.html b/doc/files/src-shared-httpstatuscode.html deleted file mode 100644 index 66d9cad..0000000 --- a/doc/files/src-shared-httpstatuscode.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                                -

                                                                                                                Documentation

                                                                                                                - - - - - -
                                                                                                                - -
                                                                                                                -
                                                                                                                - - - - -
                                                                                                                -
                                                                                                                  -
                                                                                                                - -
                                                                                                                -

                                                                                                                HttpStatusCode.php

                                                                                                                - - -
                                                                                                                - - - - - - -

                                                                                                                - Interfaces, Classes and Traits - -

                                                                                                                - -
                                                                                                                - -
                                                                                                                HttpStatusCode
                                                                                                                -
                                                                                                                Class to store all http status code used in the API
                                                                                                                - -
                                                                                                                - - - - - - - - -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                -

                                                                                                                Search results

                                                                                                                - -
                                                                                                                -
                                                                                                                -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  - - -
                                                                                                                  - - - - - - - - diff --git a/doc/files/src-shared-interfaces-httpclientinterface.html b/doc/files/src-shared-interfaces-httpclientinterface.html deleted file mode 100644 index a652234..0000000 --- a/doc/files/src-shared-interfaces-httpclientinterface.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                                  -

                                                                                                                  Documentation

                                                                                                                  - - - - - -
                                                                                                                  - -
                                                                                                                  -
                                                                                                                  - - - - -
                                                                                                                  -
                                                                                                                    -
                                                                                                                  - -
                                                                                                                  -

                                                                                                                  HttpClientInterface.php

                                                                                                                  - - -
                                                                                                                  - - - - - - -

                                                                                                                  - Interfaces, Classes and Traits - -

                                                                                                                  - -
                                                                                                                  -
                                                                                                                  HttpClientInterface
                                                                                                                  -
                                                                                                                  Http client's interface
                                                                                                                  - - -
                                                                                                                  - - - - - - - - -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -

                                                                                                                  Search results

                                                                                                                  - -
                                                                                                                  -
                                                                                                                  -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    - - -
                                                                                                                    - - - - - - - - diff --git a/doc/files/src-shared-interfaces-httpresponseinterface.html b/doc/files/src-shared-interfaces-httpresponseinterface.html deleted file mode 100644 index 3c33969..0000000 --- a/doc/files/src-shared-interfaces-httpresponseinterface.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                                    -

                                                                                                                    Documentation

                                                                                                                    - - - - - -
                                                                                                                    - -
                                                                                                                    -
                                                                                                                    - - - - -
                                                                                                                    -
                                                                                                                      -
                                                                                                                    - -
                                                                                                                    -

                                                                                                                    HttpResponseInterface.php

                                                                                                                    - - -
                                                                                                                    - - - - - - -

                                                                                                                    - Interfaces, Classes and Traits - -

                                                                                                                    - -
                                                                                                                    -
                                                                                                                    HttpResponseInterface
                                                                                                                    -
                                                                                                                    Http response's interface
                                                                                                                    - - -
                                                                                                                    - - - - - - - - -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -

                                                                                                                    Search results

                                                                                                                    - -
                                                                                                                    -
                                                                                                                    -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      - - -
                                                                                                                      - - - - - - - - diff --git a/doc/files/src-shared-interfaces-modelinterface.html b/doc/files/src-shared-interfaces-modelinterface.html deleted file mode 100644 index 9e3c071..0000000 --- a/doc/files/src-shared-interfaces-modelinterface.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                                      -

                                                                                                                      Documentation

                                                                                                                      - - - - - -
                                                                                                                      - -
                                                                                                                      -
                                                                                                                      - - - - -
                                                                                                                      -
                                                                                                                        -
                                                                                                                      - -
                                                                                                                      -

                                                                                                                      ModelInterface.php

                                                                                                                      - - -
                                                                                                                      - - - - - - -

                                                                                                                      - Interfaces, Classes and Traits - -

                                                                                                                      - -
                                                                                                                      -
                                                                                                                      ModelInterface
                                                                                                                      -
                                                                                                                      Model's interface
                                                                                                                      - - -
                                                                                                                      - - - - - - - - -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -

                                                                                                                      Search results

                                                                                                                      - -
                                                                                                                      -
                                                                                                                      -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        - - -
                                                                                                                        - - - - - - - - diff --git a/doc/files/src-shared-resource.html b/doc/files/src-shared-resource.html deleted file mode 100644 index 8a7e7bf..0000000 --- a/doc/files/src-shared-resource.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                                        -

                                                                                                                        Documentation

                                                                                                                        - - - - - -
                                                                                                                        - -
                                                                                                                        -
                                                                                                                        - - - - -
                                                                                                                        -
                                                                                                                          -
                                                                                                                        - -
                                                                                                                        -

                                                                                                                        Resource.php

                                                                                                                        - - -
                                                                                                                        - - - - - - -

                                                                                                                        - Interfaces, Classes and Traits - -

                                                                                                                        - -
                                                                                                                        - -
                                                                                                                        Resource
                                                                                                                        -
                                                                                                                        A resource class is in charge to communicate with the API and return a formatted response
                                                                                                                        - -
                                                                                                                        - - - - - - - - -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -

                                                                                                                        Search results

                                                                                                                        - -
                                                                                                                        -
                                                                                                                        -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          - - - - - - - - diff --git a/doc/files/src-shared-services-jwt.html b/doc/files/src-shared-services-jwt.html deleted file mode 100644 index a2911ff..0000000 --- a/doc/files/src-shared-services-jwt.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                                          -

                                                                                                                          Documentation

                                                                                                                          - - - - - -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - - - - -
                                                                                                                          -
                                                                                                                            -
                                                                                                                          - -
                                                                                                                          -

                                                                                                                          Jwt.php

                                                                                                                          - - -
                                                                                                                          - - - - - - -

                                                                                                                          - Interfaces, Classes and Traits - -

                                                                                                                          - -
                                                                                                                          - -
                                                                                                                          Jwt
                                                                                                                          -
                                                                                                                          Utility to generate a Json Web Token (JWT) to do requests to Doofinder API services
                                                                                                                          - -
                                                                                                                          - - - - - - - - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          Search results

                                                                                                                          - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            - - - - - - - - diff --git a/doc/files/src-shared-utils-errorhandler.html b/doc/files/src-shared-utils-errorhandler.html deleted file mode 100644 index ceb1945..0000000 --- a/doc/files/src-shared-utils-errorhandler.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                                            -

                                                                                                                            Documentation

                                                                                                                            - - - - - -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - - - - -
                                                                                                                            -
                                                                                                                              -
                                                                                                                            - -
                                                                                                                            -

                                                                                                                            ErrorHandler.php

                                                                                                                            - - -
                                                                                                                            - - - - - - -

                                                                                                                            - Interfaces, Classes and Traits - -

                                                                                                                            - -
                                                                                                                            - -
                                                                                                                            ErrorHandler
                                                                                                                            -
                                                                                                                            Class in charge on mapping response message to client message
                                                                                                                            - -
                                                                                                                            - - - - - - - - -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -

                                                                                                                            Search results

                                                                                                                            - -
                                                                                                                            -
                                                                                                                            -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              - - -
                                                                                                                              - - - - - - - - diff --git a/doc/graphs/classes.html b/doc/graphs/classes.html deleted file mode 100644 index fdcb500..0000000 --- a/doc/graphs/classes.html +++ /dev/null @@ -1,119 +0,0 @@ - - - - - Documentation - - - - - - - - -
                                                                                                                              -

                                                                                                                              Documentation

                                                                                                                              - - - - - -
                                                                                                                              - -
                                                                                                                              -
                                                                                                                              - - - - -
                                                                                                                              -
                                                                                                                              - -
                                                                                                                              - -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -

                                                                                                                              Search results

                                                                                                                              - -
                                                                                                                              -
                                                                                                                              -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                - - -
                                                                                                                                - - - - - - - - diff --git a/doc/index.html b/doc/index.html deleted file mode 100644 index b1c1f46..0000000 --- a/doc/index.html +++ /dev/null @@ -1,146 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                                                -

                                                                                                                                Documentation

                                                                                                                                - - - - - -
                                                                                                                                - -
                                                                                                                                -
                                                                                                                                - - - - -
                                                                                                                                -

                                                                                                                                Documentation

                                                                                                                                - - -

                                                                                                                                - Packages - -

                                                                                                                                - -
                                                                                                                                -
                                                                                                                                Application
                                                                                                                                -
                                                                                                                                - -

                                                                                                                                - Namespaces - -

                                                                                                                                - -
                                                                                                                                -
                                                                                                                                Doofinder
                                                                                                                                -
                                                                                                                                - - - - - - - -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -

                                                                                                                                Search results

                                                                                                                                - -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  - - -
                                                                                                                                  - - - - - - - - diff --git a/doc/indices/files.html b/doc/indices/files.html deleted file mode 100644 index a505ca6..0000000 --- a/doc/indices/files.html +++ /dev/null @@ -1,182 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                                                  -

                                                                                                                                  Documentation

                                                                                                                                  - - - - - -
                                                                                                                                  - -
                                                                                                                                  - - - -
                                                                                                                                  - - - - - - - - diff --git a/doc/js/search.js b/doc/js/search.js deleted file mode 100644 index 093d6d0..0000000 --- a/doc/js/search.js +++ /dev/null @@ -1,173 +0,0 @@ -// 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/doc/js/searchIndex.js b/doc/js/searchIndex.js deleted file mode 100644 index 20d7e1b..0000000 --- a/doc/js/searchIndex.js +++ /dev/null @@ -1,1484 +0,0 @@ -Search.appendIndex( - [ - { - "fqsen": "\\Doofinder\\Configuration", - "name": "Configuration", - "summary": "Class\u0020with\u0020API\u0020configuration", - "url": "classes/Doofinder-Configuration.html" - }, { - "fqsen": "\\Doofinder\\Configuration\u003A\u003A__construct\u0028\u0029", - "name": "__construct", - "summary": "", - "url": "classes/Doofinder-Configuration.html#method___construct" - }, { - "fqsen": "\\Doofinder\\Configuration\u003A\u003Acreate\u0028\u0029", - "name": "create", - "summary": "", - "url": "classes/Doofinder-Configuration.html#method_create" - }, { - "fqsen": "\\Doofinder\\Configuration\u003A\u003AgetBaseUrl\u0028\u0029", - "name": "getBaseUrl", - "summary": "", - "url": "classes/Doofinder-Configuration.html#method_getBaseUrl" - }, { - "fqsen": "\\Doofinder\\Configuration\u003A\u003AgetToken\u0028\u0029", - "name": "getToken", - "summary": "", - "url": "classes/Doofinder-Configuration.html#method_getToken" - }, { - "fqsen": "\\Doofinder\\Configuration\u003A\u003AgetUserId\u0028\u0029", - "name": "getUserId", - "summary": "", - "url": "classes/Doofinder-Configuration.html#method_getUserId" - }, { - "fqsen": "\\Doofinder\\Configuration\u003A\u003A\u0024host", - "name": "host", - "summary": "", - "url": "classes/Doofinder-Configuration.html#property_host" - }, { - "fqsen": "\\Doofinder\\Configuration\u003A\u003A\u0024token", - "name": "token", - "summary": "", - "url": "classes/Doofinder-Configuration.html#property_token" - }, { - "fqsen": "\\Doofinder\\Configuration\u003A\u003A\u0024userId", - "name": "userId", - "summary": "", - "url": "classes/Doofinder-Configuration.html#property_userId" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient", - "name": "ManagementClient", - "summary": "This\u0020class\u0020is\u0020used\u0020to\u0020do\u0020management\u0020actions\u0020against\u0020search\u0020engines,\u0020index\u0020and\u0020items\u0020through\u0020calling\u0020an\u0020API.", - "url": "classes/Doofinder-Management-ManagementClient.html" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003A__construct\u0028\u0029", - "name": "__construct", - "summary": "", - "url": "classes/Doofinder-Management-ManagementClient.html#method___construct" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003Acreate\u0028\u0029", - "name": "create", - "summary": "", - "url": "classes/Doofinder-Management-ManagementClient.html#method_create" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AcreateSearchEngine\u0028\u0029", - "name": "createSearchEngine", - "summary": "Creates\u0020a\u0020new\u0020search\u0020engine\u0020with\u0020the\u0020provided\u0020data.\u0020It\u0020is\u0020not\u0020possible\u0020to\u0020run\u0020searches\u0020against\u0020the\u0020new\u0020search\nengine\u0020as\u0020it\u0020does\u0020not\u0020have\u0020any\u0020index\u0020yet.\u0020You\u0020must\u0020create\u0020an\u0020index\u0020belonging\u0020to\u0020the\u0020new\u0020search\u0020engine\u0020to\u0020be\u0020able\nto\u0020make\u0020searches.", - "url": "classes/Doofinder-Management-ManagementClient.html#method_createSearchEngine" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AupdateSearchEngine\u0028\u0029", - "name": "updateSearchEngine", - "summary": "Given\u0020a\u0020hashId\u0020and\u0020data\u0020updates\u0020a\u0020search\u0020engine.", - "url": "classes/Doofinder-Management-ManagementClient.html#method_updateSearchEngine" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AgetSearchEngine\u0028\u0029", - "name": "getSearchEngine", - "summary": "Given\u0020a\u0020hashId\u0020gets\u0020a\u0020search\u0020engine\u0020details.", - "url": "classes/Doofinder-Management-ManagementClient.html#method_getSearchEngine" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AlistSearchEngines\u0028\u0029", - "name": "listSearchEngines", - "summary": "Lists\u0020all\u0020user\u0027s\u0020search\u0020engines.", - "url": "classes/Doofinder-Management-ManagementClient.html#method_listSearchEngines" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AdeleteSearchEngine\u0028\u0029", - "name": "deleteSearchEngine", - "summary": "Given\u0020a\u0020hashId\u0020deletes\u0020a\u0020search\u0020engine.", - "url": "classes/Doofinder-Management-ManagementClient.html#method_deleteSearchEngine" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AcreateIndex\u0028\u0029", - "name": "createIndex", - "summary": "Given\u0020a\u0020hashId\u0020and\u0020index\u0020data,\u0020creates\u0020a\u0020new\u0020index", - "url": "classes/Doofinder-Management-ManagementClient.html#method_createIndex" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AupdateIndex\u0028\u0029", - "name": "updateIndex", - "summary": "Given\u0020a\u0020hashId,\u0020indexName\u0020and\u0020data\u0020updates\u0020an\u0020index.", - "url": "classes/Doofinder-Management-ManagementClient.html#method_updateIndex" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AgetIndex\u0028\u0029", - "name": "getIndex", - "summary": "Given\u0020a\u0020hashId\u0020and\u0020indexName,\u0020it\u0020gets\u0020an\u0020index.", - "url": "classes/Doofinder-Management-ManagementClient.html#method_getIndex" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AlistIndexes\u0028\u0029", - "name": "listIndexes", - "summary": "Given\u0020a\u0020hashId,\u0020list\u0020index\u0027s\u0020search\u0020engine.", - "url": "classes/Doofinder-Management-ManagementClient.html#method_listIndexes" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AdeleteIndex\u0028\u0029", - "name": "deleteIndex", - "summary": "Given\u0020a\u0020hashId\u0020and\u0020indexName,\u0020removes\u0020an\u0020index", - "url": "classes/Doofinder-Management-ManagementClient.html#method_deleteIndex" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AcreateItem\u0028\u0029", - "name": "createItem", - "summary": "Given\u0020a\u0020hashId,\u0020index\u0020id\u0020and\u0020item\u0020data,\u0020creates\u0020a\u0020new\u0020item", - "url": "classes/Doofinder-Management-ManagementClient.html#method_createItem" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AupdateItem\u0028\u0029", - "name": "updateItem", - "summary": "Given\u0020a\u0020hashId,\u0020indexName,\u0020item\u0020id\u0020and\u0020data\u0020updates\u0020an\u0020item.", - "url": "classes/Doofinder-Management-ManagementClient.html#method_updateItem" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AgetItem\u0028\u0029", - "name": "getItem", - "summary": "Given\u0020a\u0020hashId,\u0020indexName\u0020and\u0020item\u0020id,\u0020it\u0020gets\u0020an\u0020item.", - "url": "classes/Doofinder-Management-ManagementClient.html#method_getItem" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AscrollIndex\u0028\u0029", - "name": "scrollIndex", - "summary": "Given\u0020a\u0020hashId\u0020and\u0020index\u0020name,\u0020scrolls\u0020index", - "url": "classes/Doofinder-Management-ManagementClient.html#method_scrollIndex" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AdeleteItem\u0028\u0029", - "name": "deleteItem", - "summary": "Given\u0020a\u0020hashId,\u0020indexName\u0020and\u0020item\u0020id,\u0020removes\u0020an\u0020item", - "url": "classes/Doofinder-Management-ManagementClient.html#method_deleteItem" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AcreateTemporaryIndex\u0028\u0029", - "name": "createTemporaryIndex", - "summary": "Given\u0020a\u0020hashId\u0020and\u0020index\u0020name,\u0020creates\u0020a\u0020new\u0020temporary\u0020index", - "url": "classes/Doofinder-Management-ManagementClient.html#method_createTemporaryIndex" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AdeleteTemporaryIndex\u0028\u0029", - "name": "deleteTemporaryIndex", - "summary": "Given\u0020a\u0020hashId\u0020and\u0020index\u0020name,\u0020deletes\u0020a\u0020temporary\u0020index", - "url": "classes/Doofinder-Management-ManagementClient.html#method_deleteTemporaryIndex" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AreplaceIndex\u0028\u0029", - "name": "replaceIndex", - "summary": "Given\u0020a\u0020hashId\u0020and\u0020index\u0020name,\u0020replaces\u0020the\u0020content\u0020of\u0020the\u0020current\u0020\u0022production\u0022\u0020index\u0020with\u0020the\u0020content\u0020of\u0020the\u0020temporary\u0020one", - "url": "classes/Doofinder-Management-ManagementClient.html#method_replaceIndex" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AreindexIntoTemporary\u0028\u0029", - "name": "reindexIntoTemporary", - "summary": "Given\u0020a\u0020hashId\u0020and\u0020index\u0020name,\u0020reindex\u0020all\u0020items\u0020from\u0020real\u0020and\u0020index\u0020them\u0020onto\u0020the\u0020temporary.", - "url": "classes/Doofinder-Management-ManagementClient.html#method_reindexIntoTemporary" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AreindexTaskStatus\u0028\u0029", - "name": "reindexTaskStatus", - "summary": "Given\u0020a\u0020hashId\u0020and\u0020index\u0020name,\u0020returns\u0020the\u0020status\u0020of\u0020the\u0020last\u0020scheduled\u0020reindexing\u0020tasks.", - "url": "classes/Doofinder-Management-ManagementClient.html#method_reindexTaskStatus" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AprocessSearchEngine\u0028\u0029", - "name": "processSearchEngine", - "summary": "Given\u0020a\u0020hashId\u0020schedules\u0020a\u0020task\u0020for\u0020processing\u0020all\u0020search\u0020engine\u0027s\u0020data\u0020sources.", - "url": "classes/Doofinder-Management-ManagementClient.html#method_processSearchEngine" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AgetSearchEngineProcessStatus\u0028\u0029", - "name": "getSearchEngineProcessStatus", - "summary": "Given\u0020a\u0020hashId\u0020gets\u0020the\u0020status\u0020of\u0020the\u0020last\u0020process\u0020task.", - "url": "classes/Doofinder-Management-ManagementClient.html#method_getSearchEngineProcessStatus" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AcreateItemInTemporalIndex\u0028\u0029", - "name": "createItemInTemporalIndex", - "summary": "Given\u0020a\u0020hashId,\u0020index\u0020id\u0020and\u0020item\u0020data,\u0020creates\u0020a\u0020new\u0020item\u0020in\u0020temporal\u0020index", - "url": "classes/Doofinder-Management-ManagementClient.html#method_createItemInTemporalIndex" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AupdateItemInTemporalIndex\u0028\u0029", - "name": "updateItemInTemporalIndex", - "summary": "Given\u0020a\u0020hashId,\u0020indexName,\u0020item\u0020id\u0020and\u0020data\u0020updates\u0020an\u0020item\u0020on\u0020temporal\u0020index.", - "url": "classes/Doofinder-Management-ManagementClient.html#method_updateItemInTemporalIndex" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AgetItemFromTemporalIndex\u0028\u0029", - "name": "getItemFromTemporalIndex", - "summary": "Given\u0020a\u0020hashId,\u0020indexName\u0020and\u0020item\u0020id,\u0020it\u0020gets\u0020an\u0020item\u0020from\u0020temporal\u0020index.", - "url": "classes/Doofinder-Management-ManagementClient.html#method_getItemFromTemporalIndex" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AdeleteItemFromTemporalIndex\u0028\u0029", - "name": "deleteItemFromTemporalIndex", - "summary": "Given\u0020a\u0020hashId,\u0020indexName\u0020and\u0020item\u0020id,\u0020removes\u0020an\u0020item\u0020from\u0020temporal\u0020index", - "url": "classes/Doofinder-Management-ManagementClient.html#method_deleteItemFromTemporalIndex" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AfindItemsFromTemporalIndex\u0028\u0029", - "name": "findItemsFromTemporalIndex", - "summary": "Given\u0020a\u0020hashId,\u0020indexName\u0020and\u0020params,\u0020it\u0020gets\u0020an\u0020item\u0020list\u0020from\u0020temporal\u0020index.", - "url": "classes/Doofinder-Management-ManagementClient.html#method_findItemsFromTemporalIndex" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AfindItems\u0028\u0029", - "name": "findItems", - "summary": "Given\u0020a\u0020hashId,\u0020indexName\u0020and\u0020params,\u0020it\u0020gets\u0020an\u0020item\u0020list.", - "url": "classes/Doofinder-Management-ManagementClient.html#method_findItems" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AcountItems\u0028\u0029", - "name": "countItems", - "summary": "Given\u0020a\u0020hashId\u0020and\u0020indexName,\u0020returns\u0020the\u0020total\u0020number\u0020of\u0020items\u0020in\u0020the\u0020index.", - "url": "classes/Doofinder-Management-ManagementClient.html#method_countItems" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AcreateItemsInBulkInTemporalIndex\u0028\u0029", - "name": "createItemsInBulkInTemporalIndex", - "summary": "Given\u0020a\u0020hashId,\u0020index\u0020id\u0020and\u0020items\u0020data,\u0020creates\u0020new\u0020items\u0020in\u0020temporal\u0020index", - "url": "classes/Doofinder-Management-ManagementClient.html#method_createItemsInBulkInTemporalIndex" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AupdateItemsInBulkInTemporalIndex\u0028\u0029", - "name": "updateItemsInBulkInTemporalIndex", - "summary": "Given\u0020a\u0020hashId,\u0020index\u0020id\u0020and\u0020items\u0020data,\u0020updates\u0020items\u0020in\u0020temporal\u0020index", - "url": "classes/Doofinder-Management-ManagementClient.html#method_updateItemsInBulkInTemporalIndex" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AdeleteItemsInBulkInTemporalIndex\u0028\u0029", - "name": "deleteItemsInBulkInTemporalIndex", - "summary": "Given\u0020a\u0020hashId,\u0020index\u0020id\u0020and\u0020items\u0020id,\u0020deletes\u0020items\u0020in\u0020temporal\u0020index", - "url": "classes/Doofinder-Management-ManagementClient.html#method_deleteItemsInBulkInTemporalIndex" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AcreateItemsInBulk\u0028\u0029", - "name": "createItemsInBulk", - "summary": "Given\u0020a\u0020hashId,\u0020index\u0020id\u0020and\u0020items\u0020data,\u0020creates\u0020new\u0020items", - "url": "classes/Doofinder-Management-ManagementClient.html#method_createItemsInBulk" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AupdateItemsInBulk\u0028\u0029", - "name": "updateItemsInBulk", - "summary": "Given\u0020a\u0020hashId,\u0020index\u0020id\u0020and\u0020items\u0020data,\u0020updates\u0020items", - "url": "classes/Doofinder-Management-ManagementClient.html#method_updateItemsInBulk" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003AdeleteItemsInBulk\u0028\u0029", - "name": "deleteItemsInBulk", - "summary": "Given\u0020a\u0020hashId,\u0020index\u0020id\u0020and\u0020items\u0020id,\u0020deletes\u0020items", - "url": "classes/Doofinder-Management-ManagementClient.html#method_deleteItemsInBulk" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003A\u0024searchEnginesResource", - "name": "searchEnginesResource", - "summary": "", - "url": "classes/Doofinder-Management-ManagementClient.html#property_searchEnginesResource" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003A\u0024itemsResource", - "name": "itemsResource", - "summary": "", - "url": "classes/Doofinder-Management-ManagementClient.html#property_itemsResource" - }, { - "fqsen": "\\Doofinder\\Management\\ManagementClient\u003A\u003A\u0024indexResource", - "name": "indexResource", - "summary": "", - "url": "classes/Doofinder-Management-ManagementClient.html#property_indexResource" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSource", - "name": "DataSource", - "summary": "Model\u0020with\u0020data\u0020of\u0020a\u0020given\u0020data\u0020source", - "url": "classes/Doofinder-Management-Model-DataSource.html" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSource\u003A\u003A__construct\u0028\u0029", - "name": "__construct", - "summary": "", - "url": "classes/Doofinder-Management-Model-DataSource.html#method___construct" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSource\u003A\u003AcreateFromArray\u0028\u0029", - "name": "createFromArray", - "summary": "", - "url": "classes/Doofinder-Management-Model-DataSource.html#method_createFromArray" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSource\u003A\u003AjsonSerialize\u0028\u0029", - "name": "jsonSerialize", - "summary": "", - "url": "classes/Doofinder-Management-Model-DataSource.html#method_jsonSerialize" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSource\u003A\u003AFQCN_OPTIONS", - "name": "FQCN_OPTIONS", - "summary": "", - "url": "classes/Doofinder-Management-Model-DataSource.html#constant_FQCN_OPTIONS" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSource\u003A\u003A\u0024options", - "name": "options", - "summary": "", - "url": "classes/Doofinder-Management-Model-DataSource.html#property_options" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSource\u003A\u003A\u0024type", - "name": "type", - "summary": "", - "url": "classes/Doofinder-Management-Model-DataSource.html#property_type" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSourceOption", - "name": "DataSourceOption", - "summary": "Model\u0020with\u0020data\u0020of\u0020a\u0020given\u0020data\u0020source\u0020option", - "url": "classes/Doofinder-Management-Model-DataSourceOption.html" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSourceOption\u003A\u003A__construct\u0028\u0029", - "name": "__construct", - "summary": "", - "url": "classes/Doofinder-Management-Model-DataSourceOption.html#method___construct" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSourceOption\u003A\u003AgetUrl\u0028\u0029", - "name": "getUrl", - "summary": "", - "url": "classes/Doofinder-Management-Model-DataSourceOption.html#method_getUrl" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSourceOption\u003A\u003A\u0024url", - "name": "url", - "summary": "", - "url": "classes/Doofinder-Management-Model-DataSourceOption.html#property_url" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSourceOptionBigCommerce", - "name": "DataSourceOptionBigCommerce", - "summary": "Model\u0020with\u0020data\u0020of\u0020a\u0020given\u0020\u0022big\u0020commerce\u0022\u0020data\u0020source\u0020option", - "url": "classes/Doofinder-Management-Model-DataSourceOptionBigCommerce.html" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSourceOptionBigCommerce\u003A\u003AcreateFromArray\u0028\u0029", - "name": "createFromArray", - "summary": "", - "url": "classes/Doofinder-Management-Model-DataSourceOptionBigCommerce.html#method_createFromArray" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSourceOptionBigCommerce\u003A\u003AjsonSerialize\u0028\u0029", - "name": "jsonSerialize", - "summary": "", - "url": "classes/Doofinder-Management-Model-DataSourceOptionBigCommerce.html#method_jsonSerialize" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSourceOptionBigCommerce\u003A\u003AgetAccessToken\u0028\u0029", - "name": "getAccessToken", - "summary": "", - "url": "classes/Doofinder-Management-Model-DataSourceOptionBigCommerce.html#method_getAccessToken" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSourceOptionBigCommerce\u003A\u003AgetStoreHash\u0028\u0029", - "name": "getStoreHash", - "summary": "", - "url": "classes/Doofinder-Management-Model-DataSourceOptionBigCommerce.html#method_getStoreHash" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSourceOptionBigCommerce\u003A\u003A\u0024accessToken", - "name": "accessToken", - "summary": "", - "url": "classes/Doofinder-Management-Model-DataSourceOptionBigCommerce.html#property_accessToken" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSourceOptionBigCommerce\u003A\u003A\u0024storeHash", - "name": "storeHash", - "summary": "", - "url": "classes/Doofinder-Management-Model-DataSourceOptionBigCommerce.html#property_storeHash" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSourceOptionEkm", - "name": "DataSourceOptionEkm", - "summary": "Model\u0020with\u0020data\u0020of\u0020a\u0020given\u0020\u0022ekm\u0022\u0020data\u0020source\u0020option", - "url": "classes/Doofinder-Management-Model-DataSourceOptionEkm.html" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSourceOptionEkm\u003A\u003AcreateFromArray\u0028\u0029", - "name": "createFromArray", - "summary": "", - "url": "classes/Doofinder-Management-Model-DataSourceOptionEkm.html#method_createFromArray" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSourceOptionEkm\u003A\u003AjsonSerialize\u0028\u0029", - "name": "jsonSerialize", - "summary": "", - "url": "classes/Doofinder-Management-Model-DataSourceOptionEkm.html#method_jsonSerialize" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSourceOptionEkm\u003A\u003AgetRefreshToken\u0028\u0029", - "name": "getRefreshToken", - "summary": "", - "url": "classes/Doofinder-Management-Model-DataSourceOptionEkm.html#method_getRefreshToken" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSourceOptionEkm\u003A\u003A\u0024refreshToken", - "name": "refreshToken", - "summary": "", - "url": "classes/Doofinder-Management-Model-DataSourceOptionEkm.html#property_refreshToken" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSourceOptionFile", - "name": "DataSourceOptionFile", - "summary": "Model\u0020with\u0020data\u0020of\u0020a\u0020given\u0020\u0022file\u0022\u0020data\u0020source\u0020option", - "url": "classes/Doofinder-Management-Model-DataSourceOptionFile.html" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSourceOptionFile\u003A\u003AcreateFromArray\u0028\u0029", - "name": "createFromArray", - "summary": "", - "url": "classes/Doofinder-Management-Model-DataSourceOptionFile.html#method_createFromArray" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSourceOptionFile\u003A\u003AjsonSerialize\u0028\u0029", - "name": "jsonSerialize", - "summary": "", - "url": "classes/Doofinder-Management-Model-DataSourceOptionFile.html#method_jsonSerialize" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSourceOptionFile\u003A\u003AgetPageSize\u0028\u0029", - "name": "getPageSize", - "summary": "", - "url": "classes/Doofinder-Management-Model-DataSourceOptionFile.html#method_getPageSize" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSourceOptionFile\u003A\u003A\u0024pageSize", - "name": "pageSize", - "summary": "", - "url": "classes/Doofinder-Management-Model-DataSourceOptionFile.html#property_pageSize" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSourceOptionMagento", - "name": "DataSourceOptionMagento", - "summary": "Model\u0020with\u0020data\u0020of\u0020a\u0020given\u0020\u0022magento\u0022\u0020data\u0020source\u0020option", - "url": "classes/Doofinder-Management-Model-DataSourceOptionMagento.html" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSourceOptionMagento\u003A\u003AcreateFromArray\u0028\u0029", - "name": "createFromArray", - "summary": "", - "url": "classes/Doofinder-Management-Model-DataSourceOptionMagento.html#method_createFromArray" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSourceOptionMagento\u003A\u003AjsonSerialize\u0028\u0029", - "name": "jsonSerialize", - "summary": "", - "url": "classes/Doofinder-Management-Model-DataSourceOptionMagento.html#method_jsonSerialize" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSourceOptionShopify", - "name": "DataSourceOptionShopify", - "summary": "Model\u0020with\u0020data\u0020of\u0020a\u0020given\u0020\u0022shopify\u0022\u0020data\u0020source\u0020option", - "url": "classes/Doofinder-Management-Model-DataSourceOptionShopify.html" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSourceOptionShopify\u003A\u003AcreateFromArray\u0028\u0029", - "name": "createFromArray", - "summary": "", - "url": "classes/Doofinder-Management-Model-DataSourceOptionShopify.html#method_createFromArray" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSourceOptionShopify\u003A\u003AjsonSerialize\u0028\u0029", - "name": "jsonSerialize", - "summary": "", - "url": "classes/Doofinder-Management-Model-DataSourceOptionShopify.html#method_jsonSerialize" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSourceOptionShopify\u003A\u003AgetToken\u0028\u0029", - "name": "getToken", - "summary": "", - "url": "classes/Doofinder-Management-Model-DataSourceOptionShopify.html#method_getToken" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\DataSourceOptionShopify\u003A\u003A\u0024token", - "name": "token", - "summary": "", - "url": "classes/Doofinder-Management-Model-DataSourceOptionShopify.html#property_token" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Index", - "name": "Index", - "summary": "Model\u0020with\u0020data\u0020of\u0020a\u0020given\u0020index", - "url": "classes/Doofinder-Management-Model-Index.html" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Index\u003A\u003A__construct\u0028\u0029", - "name": "__construct", - "summary": "", - "url": "classes/Doofinder-Management-Model-Index.html#method___construct" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Index\u003A\u003AcreateFromArray\u0028\u0029", - "name": "createFromArray", - "summary": "", - "url": "classes/Doofinder-Management-Model-Index.html#method_createFromArray" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Index\u003A\u003AjsonSerialize\u0028\u0029", - "name": "jsonSerialize", - "summary": "", - "url": "classes/Doofinder-Management-Model-Index.html#method_jsonSerialize" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Index\u003A\u003AgetName\u0028\u0029", - "name": "getName", - "summary": "", - "url": "classes/Doofinder-Management-Model-Index.html#method_getName" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Index\u003A\u003AgetPreset\u0028\u0029", - "name": "getPreset", - "summary": "", - "url": "classes/Doofinder-Management-Model-Index.html#method_getPreset" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Index\u003A\u003AgetOptions\u0028\u0029", - "name": "getOptions", - "summary": "", - "url": "classes/Doofinder-Management-Model-Index.html#method_getOptions" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Index\u003A\u003AgetDataSources\u0028\u0029", - "name": "getDataSources", - "summary": "", - "url": "classes/Doofinder-Management-Model-Index.html#method_getDataSources" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Index\u003A\u003A\u0024name", - "name": "name", - "summary": "", - "url": "classes/Doofinder-Management-Model-Index.html#property_name" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Index\u003A\u003A\u0024preset", - "name": "preset", - "summary": "", - "url": "classes/Doofinder-Management-Model-Index.html#property_preset" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Index\u003A\u003A\u0024options", - "name": "options", - "summary": "", - "url": "classes/Doofinder-Management-Model-Index.html#property_options" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Index\u003A\u003A\u0024dataSources", - "name": "dataSources", - "summary": "", - "url": "classes/Doofinder-Management-Model-Index.html#property_dataSources" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Item", - "name": "Item", - "summary": "Model\u0020with\u0020data\u0020of\u0020a\u0020given\u0020item", - "url": "classes/Doofinder-Management-Model-Item.html" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Item\u003A\u003A__construct\u0028\u0029", - "name": "__construct", - "summary": "", - "url": "classes/Doofinder-Management-Model-Item.html#method___construct" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Item\u003A\u003AcreateFromArray\u0028\u0029", - "name": "createFromArray", - "summary": "", - "url": "classes/Doofinder-Management-Model-Item.html#method_createFromArray" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Item\u003A\u003AjsonSerialize\u0028\u0029", - "name": "jsonSerialize", - "summary": "", - "url": "classes/Doofinder-Management-Model-Item.html#method_jsonSerialize" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Item\u003A\u003AgetId\u0028\u0029", - "name": "getId", - "summary": "", - "url": "classes/Doofinder-Management-Model-Item.html#method_getId" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Item\u003A\u003AgetDfGroupingId\u0028\u0029", - "name": "getDfGroupingId", - "summary": "", - "url": "classes/Doofinder-Management-Model-Item.html#method_getDfGroupingId" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Item\u003A\u003AgetDfGroupLeader\u0028\u0029", - "name": "getDfGroupLeader", - "summary": "", - "url": "classes/Doofinder-Management-Model-Item.html#method_getDfGroupLeader" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Item\u003A\u003AgetDfManualBoost\u0028\u0029", - "name": "getDfManualBoost", - "summary": "", - "url": "classes/Doofinder-Management-Model-Item.html#method_getDfManualBoost" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Item\u003A\u003AgetCategories\u0028\u0029", - "name": "getCategories", - "summary": "", - "url": "classes/Doofinder-Management-Model-Item.html#method_getCategories" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Item\u003A\u003AgetBestPrice\u0028\u0029", - "name": "getBestPrice", - "summary": "", - "url": "classes/Doofinder-Management-Model-Item.html#method_getBestPrice" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Item\u003A\u003AgetAdditionalFields\u0028\u0029", - "name": "getAdditionalFields", - "summary": "", - "url": "classes/Doofinder-Management-Model-Item.html#method_getAdditionalFields" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Item\u003A\u003ASETTED_FIELDS", - "name": "SETTED_FIELDS", - "summary": "", - "url": "classes/Doofinder-Management-Model-Item.html#constant_SETTED_FIELDS" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Item\u003A\u003A\u0024id", - "name": "id", - "summary": "", - "url": "classes/Doofinder-Management-Model-Item.html#property_id" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Item\u003A\u003A\u0024dfGroupingId", - "name": "dfGroupingId", - "summary": "", - "url": "classes/Doofinder-Management-Model-Item.html#property_dfGroupingId" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Item\u003A\u003A\u0024dfGroupLeader", - "name": "dfGroupLeader", - "summary": "", - "url": "classes/Doofinder-Management-Model-Item.html#property_dfGroupLeader" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Item\u003A\u003A\u0024dfManualBoost", - "name": "dfManualBoost", - "summary": "", - "url": "classes/Doofinder-Management-Model-Item.html#property_dfManualBoost" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Item\u003A\u003A\u0024categories", - "name": "categories", - "summary": "", - "url": "classes/Doofinder-Management-Model-Item.html#property_categories" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Item\u003A\u003A\u0024bestPrice", - "name": "bestPrice", - "summary": "", - "url": "classes/Doofinder-Management-Model-Item.html#property_bestPrice" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\Item\u003A\u003A\u0024additionalFields", - "name": "additionalFields", - "summary": "", - "url": "classes/Doofinder-Management-Model-Item.html#property_additionalFields" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\SearchEngine", - "name": "SearchEngine", - "summary": "Model\u0020with\u0020data\u0020of\u0020a\u0020given\u0020search\u0020engine", - "url": "classes/Doofinder-Management-Model-SearchEngine.html" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\SearchEngine\u003A\u003A__construct\u0028\u0029", - "name": "__construct", - "summary": "", - "url": "classes/Doofinder-Management-Model-SearchEngine.html#method___construct" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\SearchEngine\u003A\u003AcreateFromArray\u0028\u0029", - "name": "createFromArray", - "summary": "", - "url": "classes/Doofinder-Management-Model-SearchEngine.html#method_createFromArray" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\SearchEngine\u003A\u003AgetCurrency\u0028\u0029", - "name": "getCurrency", - "summary": "", - "url": "classes/Doofinder-Management-Model-SearchEngine.html#method_getCurrency" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\SearchEngine\u003A\u003AgetHashid\u0028\u0029", - "name": "getHashid", - "summary": "", - "url": "classes/Doofinder-Management-Model-SearchEngine.html#method_getHashid" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\SearchEngine\u003A\u003AgetIndices\u0028\u0029", - "name": "getIndices", - "summary": "", - "url": "classes/Doofinder-Management-Model-SearchEngine.html#method_getIndices" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\SearchEngine\u003A\u003AisInactive\u0028\u0029", - "name": "isInactive", - "summary": "", - "url": "classes/Doofinder-Management-Model-SearchEngine.html#method_isInactive" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\SearchEngine\u003A\u003AgetLanguage\u0028\u0029", - "name": "getLanguage", - "summary": "", - "url": "classes/Doofinder-Management-Model-SearchEngine.html#method_getLanguage" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\SearchEngine\u003A\u003AgetName\u0028\u0029", - "name": "getName", - "summary": "", - "url": "classes/Doofinder-Management-Model-SearchEngine.html#method_getName" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\SearchEngine\u003A\u003AgetSearchUrl\u0028\u0029", - "name": "getSearchUrl", - "summary": "", - "url": "classes/Doofinder-Management-Model-SearchEngine.html#method_getSearchUrl" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\SearchEngine\u003A\u003AgetSiteUrl\u0028\u0029", - "name": "getSiteUrl", - "summary": "", - "url": "classes/Doofinder-Management-Model-SearchEngine.html#method_getSiteUrl" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\SearchEngine\u003A\u003AisStopwords\u0028\u0029", - "name": "isStopwords", - "summary": "", - "url": "classes/Doofinder-Management-Model-SearchEngine.html#method_isStopwords" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\SearchEngine\u003A\u003AgetPlatform\u0028\u0029", - "name": "getPlatform", - "summary": "", - "url": "classes/Doofinder-Management-Model-SearchEngine.html#method_getPlatform" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\SearchEngine\u003A\u003AisHasGrouping\u0028\u0029", - "name": "isHasGrouping", - "summary": "", - "url": "classes/Doofinder-Management-Model-SearchEngine.html#method_isHasGrouping" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\SearchEngine\u003A\u003AjsonSerialize\u0028\u0029", - "name": "jsonSerialize", - "summary": "", - "url": "classes/Doofinder-Management-Model-SearchEngine.html#method_jsonSerialize" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\SearchEngine\u003A\u003A\u0024currency", - "name": "currency", - "summary": "", - "url": "classes/Doofinder-Management-Model-SearchEngine.html#property_currency" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\SearchEngine\u003A\u003A\u0024hashid", - "name": "hashid", - "summary": "", - "url": "classes/Doofinder-Management-Model-SearchEngine.html#property_hashid" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\SearchEngine\u003A\u003A\u0024indices", - "name": "indices", - "summary": "", - "url": "classes/Doofinder-Management-Model-SearchEngine.html#property_indices" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\SearchEngine\u003A\u003A\u0024inactive", - "name": "inactive", - "summary": "", - "url": "classes/Doofinder-Management-Model-SearchEngine.html#property_inactive" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\SearchEngine\u003A\u003A\u0024language", - "name": "language", - "summary": "", - "url": "classes/Doofinder-Management-Model-SearchEngine.html#property_language" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\SearchEngine\u003A\u003A\u0024name", - "name": "name", - "summary": "", - "url": "classes/Doofinder-Management-Model-SearchEngine.html#property_name" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\SearchEngine\u003A\u003A\u0024searchUrl", - "name": "searchUrl", - "summary": "", - "url": "classes/Doofinder-Management-Model-SearchEngine.html#property_searchUrl" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\SearchEngine\u003A\u003A\u0024siteUrl", - "name": "siteUrl", - "summary": "", - "url": "classes/Doofinder-Management-Model-SearchEngine.html#property_siteUrl" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\SearchEngine\u003A\u003A\u0024stopwords", - "name": "stopwords", - "summary": "", - "url": "classes/Doofinder-Management-Model-SearchEngine.html#property_stopwords" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\SearchEngine\u003A\u003A\u0024platform", - "name": "platform", - "summary": "", - "url": "classes/Doofinder-Management-Model-SearchEngine.html#property_platform" - }, { - "fqsen": "\\Doofinder\\Management\\Model\\SearchEngine\u003A\u003A\u0024hasGrouping", - "name": "hasGrouping", - "summary": "", - "url": "classes/Doofinder-Management-Model-SearchEngine.html#property_hasGrouping" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Index", - "name": "Index", - "summary": "Index\u0020class\u0020is\u0020responsible\u0020for\u0020making\u0020the\u0020requests\u0020to\u0020the\u0020index\u0027s\u0020endpoints\u0020and\u0020return\u0020a\u0020response", - "url": "classes/Doofinder-Management-Resources-Index.html" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Index\u003A\u003Acreate\u0028\u0029", - "name": "create", - "summary": "", - "url": "classes/Doofinder-Management-Resources-Index.html#method_create" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Index\u003A\u003AgetBaseUrl\u0028\u0029", - "name": "getBaseUrl", - "summary": "", - "url": "classes/Doofinder-Management-Resources-Index.html#method_getBaseUrl" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Index\u003A\u003AcreateIndex\u0028\u0029", - "name": "createIndex", - "summary": "Given\u0020a\u0020hashId\u0020and\u0020index\u0020data,\u0020creates\u0020a\u0020new\u0020index", - "url": "classes/Doofinder-Management-Resources-Index.html#method_createIndex" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Index\u003A\u003AupdateIndex\u0028\u0029", - "name": "updateIndex", - "summary": "Given\u0020a\u0020hashId,\u0020indexName\u0020and\u0020data\u0020updates\u0020an\u0020index", - "url": "classes/Doofinder-Management-Resources-Index.html#method_updateIndex" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Index\u003A\u003AgetIndex\u0028\u0029", - "name": "getIndex", - "summary": "Given\u0020a\u0020hashId,\u0020indexName\u0020and\u0020data,\u0020it\u0020gets\u0020an\u0020index", - "url": "classes/Doofinder-Management-Resources-Index.html#method_getIndex" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Index\u003A\u003AlistIndexes\u0028\u0029", - "name": "listIndexes", - "summary": "Given\u0020a\u0020hashId,\u0020lists\u0020index\u0027s\u0020search\u0020engine", - "url": "classes/Doofinder-Management-Resources-Index.html#method_listIndexes" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Index\u003A\u003AdeleteIndex\u0028\u0029", - "name": "deleteIndex", - "summary": "Given\u0020a\u0020hashId\u0020and\u0020indexName,\u0020deletes\u0020an\u0020index", - "url": "classes/Doofinder-Management-Resources-Index.html#method_deleteIndex" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Index\u003A\u003AcreateTemporaryIndex\u0028\u0029", - "name": "createTemporaryIndex", - "summary": "Given\u0020a\u0020hashId\u0020and\u0020index\u0020name,\u0020creates\u0020a\u0020new\u0020temporary\u0020index", - "url": "classes/Doofinder-Management-Resources-Index.html#method_createTemporaryIndex" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Index\u003A\u003AdeleteTemporaryIndex\u0028\u0029", - "name": "deleteTemporaryIndex", - "summary": "Given\u0020a\u0020hashId\u0020and\u0020index\u0020name,\u0020deletes\u0020a\u0020temporary\u0020index", - "url": "classes/Doofinder-Management-Resources-Index.html#method_deleteTemporaryIndex" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Index\u003A\u003AreplaceIndex\u0028\u0029", - "name": "replaceIndex", - "summary": "Given\u0020a\u0020hashId\u0020and\u0020index\u0020name,\u0020replaces\u0020the\u0020content\u0020of\u0020the\u0020current\u0020\u0022production\u0022\u0020index\u0020with\u0020the\u0020content\u0020of\u0020the\u0020temporary\u0020one", - "url": "classes/Doofinder-Management-Resources-Index.html#method_replaceIndex" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Index\u003A\u003AreindexIntoTemporary\u0028\u0029", - "name": "reindexIntoTemporary", - "summary": "Given\u0020a\u0020hashId\u0020and\u0020index\u0020name,\u0020reindex\u0020all\u0020items\u0020from\u0020real\u0020and\u0020index\u0020them\u0020onto\u0020the\u0020temporary.", - "url": "classes/Doofinder-Management-Resources-Index.html#method_reindexIntoTemporary" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Index\u003A\u003AreindexTaskStatus\u0028\u0029", - "name": "reindexTaskStatus", - "summary": "Given\u0020a\u0020hashId\u0020and\u0020index\u0020name,\u0020returns\u0020the\u0020status\u0020of\u0020the\u0020last\u0020scheduled\u0020reindexing\u0020tasks.", - "url": "classes/Doofinder-Management-Resources-Index.html#method_reindexTaskStatus" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Item", - "name": "Item", - "summary": "Item\u0020class\u0020is\u0020responsible\u0020for\u0020making\u0020the\u0020requests\u0020to\u0020the\u0020item\u0027s\u0020endpoints\u0020and\u0020return\u0020a\u0020response", - "url": "classes/Doofinder-Management-Resources-Item.html" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Item\u003A\u003Acreate\u0028\u0029", - "name": "create", - "summary": "", - "url": "classes/Doofinder-Management-Resources-Item.html#method_create" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Item\u003A\u003AgetBaseUrl\u0028\u0029", - "name": "getBaseUrl", - "summary": "", - "url": "classes/Doofinder-Management-Resources-Item.html#method_getBaseUrl" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Item\u003A\u003AcreateItem\u0028\u0029", - "name": "createItem", - "summary": "Given\u0020a\u0020hashId,\u0020index\u0020name\u0020and\u0020item\u0020data,\u0020creates\u0020a\u0020new\u0020item", - "url": "classes/Doofinder-Management-Resources-Item.html#method_createItem" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Item\u003A\u003AupdateItem\u0028\u0029", - "name": "updateItem", - "summary": "Given\u0020a\u0020hashId,\u0020indexName,\u0020item\u0020id\u0020and\u0020data,\u0020updates\u0020an\u0020item", - "url": "classes/Doofinder-Management-Resources-Item.html#method_updateItem" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Item\u003A\u003AgetItem\u0028\u0029", - "name": "getItem", - "summary": "Given\u0020a\u0020hashId,\u0020indexName\u0020and\u0020item\u0020id,\u0020it\u0020gets\u0020an\u0020item", - "url": "classes/Doofinder-Management-Resources-Item.html#method_getItem" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Item\u003A\u003AscrollIndex\u0028\u0029", - "name": "scrollIndex", - "summary": "Given\u0020a\u0020hashId\u0020and\u0020index\u0020name,\u0020scrolls\u0020index", - "url": "classes/Doofinder-Management-Resources-Item.html#method_scrollIndex" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Item\u003A\u003AdeleteItem\u0028\u0029", - "name": "deleteItem", - "summary": "Given\u0020a\u0020hashId,\u0020indexName\u0020and\u0020item\u0020id,\u0020deletes\u0020an\u0020item", - "url": "classes/Doofinder-Management-Resources-Item.html#method_deleteItem" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Item\u003A\u003AcreateItemInTemporalIndex\u0028\u0029", - "name": "createItemInTemporalIndex", - "summary": "Given\u0020a\u0020hashId,\u0020index\u0020name\u0020and\u0020item\u0020data,\u0020creates\u0020a\u0020new\u0020item\u0020in\u0020temporal\u0020index", - "url": "classes/Doofinder-Management-Resources-Item.html#method_createItemInTemporalIndex" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Item\u003A\u003AupdateItemInTemporalIndex\u0028\u0029", - "name": "updateItemInTemporalIndex", - "summary": "Given\u0020a\u0020hashId,\u0020indexName,\u0020item\u0020id\u0020and\u0020data,\u0020updates\u0020an\u0020item\u0020in\u0020temporal\u0020index", - "url": "classes/Doofinder-Management-Resources-Item.html#method_updateItemInTemporalIndex" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Item\u003A\u003AgetItemFromTemporalIndex\u0028\u0029", - "name": "getItemFromTemporalIndex", - "summary": "Given\u0020a\u0020hashId,\u0020indexName\u0020and\u0020item\u0020id,\u0020it\u0020gets\u0020an\u0020item\u0020from\u0020temporal\u0020index", - "url": "classes/Doofinder-Management-Resources-Item.html#method_getItemFromTemporalIndex" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Item\u003A\u003AdeleteItemFromTemporalIndex\u0028\u0029", - "name": "deleteItemFromTemporalIndex", - "summary": "Given\u0020a\u0020hashId,\u0020indexName\u0020and\u0020item\u0020id,\u0020deletes\u0020an\u0020item\u0020from\u0020temporal\u0020index", - "url": "classes/Doofinder-Management-Resources-Item.html#method_deleteItemFromTemporalIndex" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Item\u003A\u003AfindItemsFromTemporalIndex\u0028\u0029", - "name": "findItemsFromTemporalIndex", - "summary": "Given\u0020a\u0020hashId,\u0020indexName\u0020and\u0020params,\u0020it\u0020gets\u0020an\u0020item\u0020list\u0020from\u0020temporal\u0020index", - "url": "classes/Doofinder-Management-Resources-Item.html#method_findItemsFromTemporalIndex" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Item\u003A\u003AfindItems\u0028\u0029", - "name": "findItems", - "summary": "Given\u0020a\u0020hashId,\u0020indexName\u0020and\u0020params,\u0020it\u0020gets\u0020an\u0020item\u0020list", - "url": "classes/Doofinder-Management-Resources-Item.html#method_findItems" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Item\u003A\u003AcountItems\u0028\u0029", - "name": "countItems", - "summary": "Given\u0020a\u0020hashId\u0020and\u0020indexName,\u0020returns\u0020the\u0020total\u0020number\u0020of\u0020items\u0020in\u0020the\u0020index.", - "url": "classes/Doofinder-Management-Resources-Item.html#method_countItems" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Item\u003A\u003AcreateItemsInBulkInTemporalIndex\u0028\u0029", - "name": "createItemsInBulkInTemporalIndex", - "summary": "Given\u0020a\u0020hashId,\u0020index\u0020name\u0020and\u0020items\u0020data,\u0020creates\u0020new\u0020items\u0020in\u0020temporal\u0020index", - "url": "classes/Doofinder-Management-Resources-Item.html#method_createItemsInBulkInTemporalIndex" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Item\u003A\u003AupdateItemsInBulkInTemporalIndex\u0028\u0029", - "name": "updateItemsInBulkInTemporalIndex", - "summary": "Given\u0020a\u0020hashId,\u0020index\u0020name\u0020and\u0020items\u0020data,\u0020updates\u0020items\u0020in\u0020temporal\u0020index", - "url": "classes/Doofinder-Management-Resources-Item.html#method_updateItemsInBulkInTemporalIndex" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Item\u003A\u003AdeleteItemsInBulkInTemporalIndex\u0028\u0029", - "name": "deleteItemsInBulkInTemporalIndex", - "summary": "Given\u0020a\u0020hashId,\u0020index\u0020name\u0020and\u0020items\u0020id,\u0020deletes\u0020items\u0020in\u0020temporal\u0020index", - "url": "classes/Doofinder-Management-Resources-Item.html#method_deleteItemsInBulkInTemporalIndex" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Item\u003A\u003AcreateItemsInBulk\u0028\u0029", - "name": "createItemsInBulk", - "summary": "Given\u0020a\u0020hashId,\u0020index\u0020name\u0020and\u0020items\u0020data,\u0020creates\u0020new\u0020items\u0020in\u0020index", - "url": "classes/Doofinder-Management-Resources-Item.html#method_createItemsInBulk" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Item\u003A\u003AupdateItemsInBulk\u0028\u0029", - "name": "updateItemsInBulk", - "summary": "Given\u0020a\u0020hashId,\u0020index\u0020name\u0020and\u0020items\u0020data,\u0020updates\u0020items\u0020in\u0020index", - "url": "classes/Doofinder-Management-Resources-Item.html#method_updateItemsInBulk" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\Item\u003A\u003AdeleteItemsInBulk\u0028\u0029", - "name": "deleteItemsInBulk", - "summary": "Given\u0020a\u0020hashId,\u0020index\u0020name\u0020and\u0020items\u0020id,\u0020deletes\u0020items\u0020in\u0020index", - "url": "classes/Doofinder-Management-Resources-Item.html#method_deleteItemsInBulk" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\ManagementResource", - "name": "ManagementResource", - "summary": "A\u0020resource\u0020class\u0020is\u0020in\u0020charge\u0020to\u0020communicate\u0020with\u0020the\u0020API\u0020and\u0020return\u0020a\u0020formatted\u0020response", - "url": "classes/Doofinder-Management-Resources-ManagementResource.html" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\ManagementResource\u003A\u003AgetUrl\u0028\u0029", - "name": "getUrl", - "summary": "Returns\u0020versioned\u0020url", - "url": "classes/Doofinder-Management-Resources-ManagementResource.html#method_getUrl" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\SearchEngine", - "name": "SearchEngine", - "summary": "SearchEngines\u0020class\u0020is\u0020responsible\u0020for\u0020making\u0020the\u0020requests\u0020to\u0020the\u0020search_engine\u0027s\u0020endpoints\u0020and\u0020return\u0020a\u0020response", - "url": "classes/Doofinder-Management-Resources-SearchEngine.html" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\SearchEngine\u003A\u003Acreate\u0028\u0029", - "name": "create", - "summary": "", - "url": "classes/Doofinder-Management-Resources-SearchEngine.html#method_create" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\SearchEngine\u003A\u003AgetBaseUrl\u0028\u0029", - "name": "getBaseUrl", - "summary": "", - "url": "classes/Doofinder-Management-Resources-SearchEngine.html#method_getBaseUrl" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\SearchEngine\u003A\u003AcreateSearchEngine\u0028\u0029", - "name": "createSearchEngine", - "summary": "Creates\u0020a\u0020new\u0020search\u0020engine", - "url": "classes/Doofinder-Management-Resources-SearchEngine.html#method_createSearchEngine" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\SearchEngine\u003A\u003AupdateSearchEngine\u0028\u0029", - "name": "updateSearchEngine", - "summary": "Given\u0020a\u0020hashId\u0020and\u0020data\u0020updates\u0020a\u0020search\u0020engine", - "url": "classes/Doofinder-Management-Resources-SearchEngine.html#method_updateSearchEngine" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\SearchEngine\u003A\u003AgetSearchEngine\u0028\u0029", - "name": "getSearchEngine", - "summary": "Given\u0020a\u0020hashId\u0020gets\u0020a\u0020search\u0020engine", - "url": "classes/Doofinder-Management-Resources-SearchEngine.html#method_getSearchEngine" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\SearchEngine\u003A\u003AlistSearchEngines\u0028\u0029", - "name": "listSearchEngines", - "summary": "List\u0020a\u0020user\u0027s\u0020search\u0020engines", - "url": "classes/Doofinder-Management-Resources-SearchEngine.html#method_listSearchEngines" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\SearchEngine\u003A\u003AdeleteSearchEngine\u0028\u0029", - "name": "deleteSearchEngine", - "summary": "Given\u0020a\u0020hashId\u0020deletes\u0020a\u0020search\u0020engine", - "url": "classes/Doofinder-Management-Resources-SearchEngine.html#method_deleteSearchEngine" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\SearchEngine\u003A\u003AprocessSearchEngine\u0028\u0029", - "name": "processSearchEngine", - "summary": "Given\u0020a\u0020hashId\u0020schedules\u0020a\u0020task\u0020for\u0020processing\u0020all\u0020search\u0020engine\u0027s\u0020data\u0020sources.", - "url": "classes/Doofinder-Management-Resources-SearchEngine.html#method_processSearchEngine" - }, { - "fqsen": "\\Doofinder\\Management\\Resources\\SearchEngine\u003A\u003AgetSearchEngineProcessStatus\u0028\u0029", - "name": "getSearchEngineProcessStatus", - "summary": "Given\u0020a\u0020hashId\u0020gets\u0020the\u0020status\u0020of\u0020the\u0020last\u0020process\u0020task.", - "url": "classes/Doofinder-Management-Resources-SearchEngine.html#method_getSearchEngineProcessStatus" - }, { - "fqsen": "\\Doofinder\\Search\\Resources\\Search", - "name": "Search", - "summary": "Search\u0020class\u0020is\u0020responsible\u0020for\u0020making\u0020the\u0020requests\u0020to\u0020the\u0020search\u0027s\u0020endpoint\u0020and\u0020return\u0020a\u0020response", - "url": "classes/Doofinder-Search-Resources-Search.html" - }, { - "fqsen": "\\Doofinder\\Search\\Resources\\Search\u003A\u003Acreate\u0028\u0029", - "name": "create", - "summary": "", - "url": "classes/Doofinder-Search-Resources-Search.html#method_create" - }, { - "fqsen": "\\Doofinder\\Search\\Resources\\Search\u003A\u003AgetBaseUrl\u0028\u0029", - "name": "getBaseUrl", - "summary": "", - "url": "classes/Doofinder-Search-Resources-Search.html#method_getBaseUrl" - }, { - "fqsen": "\\Doofinder\\Search\\Resources\\Search\u003A\u003Asearch\u0028\u0029", - "name": "search", - "summary": "Given\u0020a\u0020hashId\u0020and\u0020search\u0020params,\u0020makes\u0020a\u0020search", - "url": "classes/Doofinder-Search-Resources-Search.html#method_search" - }, { - "fqsen": "\\Doofinder\\Search\\Resources\\Search\u003A\u003Asuggest\u0028\u0029", - "name": "suggest", - "summary": "Given\u0020a\u0020hashId\u0020and\u0020suggest\u0020params,\u0020it\u0020returns\u0020a\u0020suggest\u0020list", - "url": "classes/Doofinder-Search-Resources-Search.html#method_suggest" - }, { - "fqsen": "\\Doofinder\\Search\\Resources\\SearchResource", - "name": "SearchResource", - "summary": "A\u0020resource\u0020class\u0020is\u0020in\u0020charge\u0020to\u0020communicate\u0020with\u0020the\u0020API\u0020and\u0020return\u0020a\u0020formatted\u0020response", - "url": "classes/Doofinder-Search-Resources-SearchResource.html" - }, { - "fqsen": "\\Doofinder\\Search\\Resources\\SearchResource\u003A\u003AgetUrl\u0028\u0029", - "name": "getUrl", - "summary": "Returns\u0020versioned\u0020url", - "url": "classes/Doofinder-Search-Resources-SearchResource.html#method_getUrl" - }, { - "fqsen": "\\Doofinder\\Search\\Resources\\Stats", - "name": "Stats", - "summary": "Stats\u0020class\u0020is\u0020responsible\u0020for\u0020making\u0020the\u0020requests\u0020to\u0020the\u0020Stats\u0027s\u0020endpoint\u0020and\u0020return\u0020a\u0020response", - "url": "classes/Doofinder-Search-Resources-Stats.html" - }, { - "fqsen": "\\Doofinder\\Search\\Resources\\Stats\u003A\u003Acreate\u0028\u0029", - "name": "create", - "summary": "", - "url": "classes/Doofinder-Search-Resources-Stats.html#method_create" - }, { - "fqsen": "\\Doofinder\\Search\\Resources\\Stats\u003A\u003AgetBaseUrl\u0028\u0029", - "name": "getBaseUrl", - "summary": "", - "url": "classes/Doofinder-Search-Resources-Stats.html#method_getBaseUrl" - }, { - "fqsen": "\\Doofinder\\Search\\Resources\\Stats\u003A\u003AinitSession\u0028\u0029", - "name": "initSession", - "summary": "Given\u0020a\u0020hashId\u0020and\u0020search\u0020params,\u0020starts\u0020a\u0020session", - "url": "classes/Doofinder-Search-Resources-Stats.html#method_initSession" - }, { - "fqsen": "\\Doofinder\\Search\\Resources\\Stats\u003A\u003AlogRedirection\u0028\u0029", - "name": "logRedirection", - "summary": "Given\u0020a\u0020hashId\u0020and\u0020redirection\u0020params,\u0020log\u0020a\u0020redirection", - "url": "classes/Doofinder-Search-Resources-Stats.html#method_logRedirection" - }, { - "fqsen": "\\Doofinder\\Search\\Resources\\Stats\u003A\u003AlogBanner\u0028\u0029", - "name": "logBanner", - "summary": "Given\u0020a\u0020hashId\u0020and\u0020banner\u0020params,\u0020log\u0020a\u0020banner\u0020click", - "url": "classes/Doofinder-Search-Resources-Stats.html#method_logBanner" - }, { - "fqsen": "\\Doofinder\\Search\\Resources\\Stats\u003A\u003AlogCheckout\u0028\u0029", - "name": "logCheckout", - "summary": "Given\u0020a\u0020hashId\u0020and\u0020sessionId,\u0020logs\u0020a\u0020checkout", - "url": "classes/Doofinder-Search-Resources-Stats.html#method_logCheckout" - }, { - "fqsen": "\\Doofinder\\Search\\Resources\\Stats\u003A\u003AlogClick\u0028\u0029", - "name": "logClick", - "summary": "Given\u0020a\u0020hashId,\u0020session\u0020id,\u0020item\u0020id\u0020and\u0020click\u0020params,\u0020log\u0020a\u0020click", - "url": "classes/Doofinder-Search-Resources-Stats.html#method_logClick" - }, { - "fqsen": "\\Doofinder\\Search\\Resources\\Stats\u003A\u003AlogAddToCart\u0028\u0029", - "name": "logAddToCart", - "summary": "Log\u0020an\u0020\u0022Add\u0020to\u0020cart\u0022\u0020event", - "url": "classes/Doofinder-Search-Resources-Stats.html#method_logAddToCart" - }, { - "fqsen": "\\Doofinder\\Search\\Resources\\Stats\u003A\u003AlogRemoveFromCart\u0028\u0029", - "name": "logRemoveFromCart", - "summary": "Log\u0020\u0022Remove\u0020from\u0020cart\u0022\u0020event", - "url": "classes/Doofinder-Search-Resources-Stats.html#method_logRemoveFromCart" - }, { - "fqsen": "\\Doofinder\\Search\\Resources\\Stats\u003A\u003AclearCart\u0028\u0029", - "name": "clearCart", - "summary": "Erase\u0020completely\u0020a\u0020cart", - "url": "classes/Doofinder-Search-Resources-Stats.html#method_clearCart" - }, { - "fqsen": "\\Doofinder\\Search\\SearchClient", - "name": "SearchClient", - "summary": "This\u0020class\u0020is\u0020used\u0020to\u0020do\u0020searches\u0020through\u0020calling\u0020an\u0020API.", - "url": "classes/Doofinder-Search-SearchClient.html" - }, { - "fqsen": "\\Doofinder\\Search\\SearchClient\u003A\u003A__construct\u0028\u0029", - "name": "__construct", - "summary": "", - "url": "classes/Doofinder-Search-SearchClient.html#method___construct" - }, { - "fqsen": "\\Doofinder\\Search\\SearchClient\u003A\u003Acreate\u0028\u0029", - "name": "create", - "summary": "", - "url": "classes/Doofinder-Search-SearchClient.html#method_create" - }, { - "fqsen": "\\Doofinder\\Search\\SearchClient\u003A\u003Asearch\u0028\u0029", - "name": "search", - "summary": "Search\u0020through\u0020indexed\u0020items\u0020of\u0020a\u0020search\u0020engine.", - "url": "classes/Doofinder-Search-SearchClient.html#method_search" - }, { - "fqsen": "\\Doofinder\\Search\\SearchClient\u003A\u003Asuggest\u0028\u0029", - "name": "suggest", - "summary": "Search\u0020through\u0020indexed\u0020suggestions\u0020of\u0020a\u0020search\u0020engine.", - "url": "classes/Doofinder-Search-SearchClient.html#method_suggest" - }, { - "fqsen": "\\Doofinder\\Search\\SearchClient\u003A\u003AinitSession\u0028\u0029", - "name": "initSession", - "summary": "Starts\u0020a\u0020session\u0020identified\u0020by\u0020a\u0020session_id.\u0020The\u0020session\u0020is\u0020used\u0020to\u0020\u0022group\u0022\u0020events.", - "url": "classes/Doofinder-Search-SearchClient.html#method_initSession" - }, { - "fqsen": "\\Doofinder\\Search\\SearchClient\u003A\u003AlogRedirection\u0028\u0029", - "name": "logRedirection", - "summary": "Logs\u0020a\u0020\u0022redirection\u0020triggered\u0022\u0020event\u0020in\u0020stats\u0020logs.", - "url": "classes/Doofinder-Search-SearchClient.html#method_logRedirection" - }, { - "fqsen": "\\Doofinder\\Search\\SearchClient\u003A\u003AlogBanner\u0028\u0029", - "name": "logBanner", - "summary": "Logs\u0020a\u0020\u0022click\u0020on\u0020banner\u0020image\u0022\u0020event\u0020in\u0020stats\u0020logs.", - "url": "classes/Doofinder-Search-SearchClient.html#method_logBanner" - }, { - "fqsen": "\\Doofinder\\Search\\SearchClient\u003A\u003AlogCheckout\u0028\u0029", - "name": "logCheckout", - "summary": "Logs\u0020a\u0020checkout\u0020event\u0020in\u0020stats\u0020logs.", - "url": "classes/Doofinder-Search-SearchClient.html#method_logCheckout" - }, { - "fqsen": "\\Doofinder\\Search\\SearchClient\u003A\u003AlogClick\u0028\u0029", - "name": "logClick", - "summary": "Save\u0020click\u0020event\u0020on\u0020doofinder\u0020statistics", - "url": "classes/Doofinder-Search-SearchClient.html#method_logClick" - }, { - "fqsen": "\\Doofinder\\Search\\SearchClient\u003A\u003AlogAddToCart\u0028\u0029", - "name": "logAddToCart", - "summary": "Adds\u0020an\u0020item\u0020to\u0020the\u0020cart,\u0020or\u0020creates\u0020a\u0020new\u0020cart\u0020for\u0020the\u0020given\u0020session\u0020if\u0020it\u0020does\u0020not\u0020exists", - "url": "classes/Doofinder-Search-SearchClient.html#method_logAddToCart" - }, { - "fqsen": "\\Doofinder\\Search\\SearchClient\u003A\u003AlogRemoveFromCart\u0028\u0029", - "name": "logRemoveFromCart", - "summary": "Removes\u0020an\u0020amount\u0020from\u0020the\u0020given\u0020item\u0020in\u0020the\u0020cart,\u0020removing\u0020it\u0020completely\u0020if\u0020the\u0020amount\u0020present\u0020in\u0020the\u0020cart\u0020minus\nthe\u0020amount\u0020specified\u0020in\u0020this\u0020call\u0020is\u0020zero\u0020or\u0020negative,\u0020else,\u0020it\u0020will\u0020be\u0020updated\u0020with\u0020the\u0020new\u0020calculated\u0020amount.", - "url": "classes/Doofinder-Search-SearchClient.html#method_logRemoveFromCart" - }, { - "fqsen": "\\Doofinder\\Search\\SearchClient\u003A\u003AclearCart\u0028\u0029", - "name": "clearCart", - "summary": "This\u0020call\u0020will\u0020erase\u0020completely\u0020a\u0020cart\u0020identified\u0020by\u0020the\u0020pair\u0020of\u0020hashid\u0020and\u0020session\u0020ID,\u0020if\u0020it\u0020does\u0020exist", - "url": "classes/Doofinder-Search-SearchClient.html#method_clearCart" - }, { - "fqsen": "\\Doofinder\\Search\\SearchClient\u003A\u003A\u0024searchResource", - "name": "searchResource", - "summary": "", - "url": "classes/Doofinder-Search-SearchClient.html#property_searchResource" - }, { - "fqsen": "\\Doofinder\\Search\\SearchClient\u003A\u003A\u0024statsResource", - "name": "statsResource", - "summary": "", - "url": "classes/Doofinder-Search-SearchClient.html#property_statsResource" - }, { - "fqsen": "\\Doofinder\\Shared\\Exceptions\\ApiException", - "name": "ApiException", - "summary": "Exception\u0020used\u0020when\u0020API\u0020request\u0020returns\u0020a\u0020not\u0020OK\u0020response", - "url": "classes/Doofinder-Shared-Exceptions-ApiException.html" - }, { - "fqsen": "\\Doofinder\\Shared\\Exceptions\\ApiException\u003A\u003A__construct\u0028\u0029", - "name": "__construct", - "summary": "", - "url": "classes/Doofinder-Shared-Exceptions-ApiException.html#method___construct" - }, { - "fqsen": "\\Doofinder\\Shared\\Exceptions\\ApiException\u003A\u003AgetBody\u0028\u0029", - "name": "getBody", - "summary": "", - "url": "classes/Doofinder-Shared-Exceptions-ApiException.html#method_getBody" - }, { - "fqsen": "\\Doofinder\\Shared\\Exceptions\\ApiException\u003A\u003A\u0024body", - "name": "body", - "summary": "", - "url": "classes/Doofinder-Shared-Exceptions-ApiException.html#property_body" - }, { - "fqsen": "\\Doofinder\\Shared\\Exceptions\\RequestException", - "name": "RequestException", - "summary": "Exception\u0020used\u0020when\u0020there\u0020is\u0020an\u0020error\u0020in\u0020the\u0020http\u0020request", - "url": "classes/Doofinder-Shared-Exceptions-RequestException.html" - }, { - "fqsen": "\\Doofinder\\Shared\\HttpClient", - "name": "HttpClient", - "summary": "Class\u0020to\u0020do\u0020requests\u0020though\u0020curl\u0020utility", - "url": "classes/Doofinder-Shared-HttpClient.html" - }, { - "fqsen": "\\Doofinder\\Shared\\HttpClient\u003A\u003Arequest\u0028\u0029", - "name": "request", - "summary": "", - "url": "classes/Doofinder-Shared-HttpClient.html#method_request" - }, { - "fqsen": "\\Doofinder\\Shared\\HttpClient\u003A\u003AgetHeader\u0028\u0029", - "name": "getHeader", - "summary": "It\u0020generates\u0020the\u0020http\u0020header", - "url": "classes/Doofinder-Shared-HttpClient.html#method_getHeader" - }, { - "fqsen": "\\Doofinder\\Shared\\HttpResponse", - "name": "HttpResponse", - "summary": "Class\u0020to\u0020return\u0020a\u0020formatted\u0020info\u0020comming\u0020from\u0020API", - "url": "classes/Doofinder-Shared-HttpResponse.html" - }, { - "fqsen": "\\Doofinder\\Shared\\HttpResponse\u003A\u003A__construct\u0028\u0029", - "name": "__construct", - "summary": "", - "url": "classes/Doofinder-Shared-HttpResponse.html#method___construct" - }, { - "fqsen": "\\Doofinder\\Shared\\HttpResponse\u003A\u003Acreate\u0028\u0029", - "name": "create", - "summary": "", - "url": "classes/Doofinder-Shared-HttpResponse.html#method_create" - }, { - "fqsen": "\\Doofinder\\Shared\\HttpResponse\u003A\u003AgetBody\u0028\u0029", - "name": "getBody", - "summary": "", - "url": "classes/Doofinder-Shared-HttpResponse.html#method_getBody" - }, { - "fqsen": "\\Doofinder\\Shared\\HttpResponse\u003A\u003AgetStatusCode\u0028\u0029", - "name": "getStatusCode", - "summary": "", - "url": "classes/Doofinder-Shared-HttpResponse.html#method_getStatusCode" - }, { - "fqsen": "\\Doofinder\\Shared\\HttpResponse\u003A\u003AsetBody\u0028\u0029", - "name": "setBody", - "summary": "", - "url": "classes/Doofinder-Shared-HttpResponse.html#method_setBody" - }, { - "fqsen": "\\Doofinder\\Shared\\HttpResponse\u003A\u003A\u0024statusCode", - "name": "statusCode", - "summary": "", - "url": "classes/Doofinder-Shared-HttpResponse.html#property_statusCode" - }, { - "fqsen": "\\Doofinder\\Shared\\HttpResponse\u003A\u003A\u0024body", - "name": "body", - "summary": "", - "url": "classes/Doofinder-Shared-HttpResponse.html#property_body" - }, { - "fqsen": "\\Doofinder\\Shared\\HttpStatusCode", - "name": "HttpStatusCode", - "summary": "Class\u0020to\u0020store\u0020all\u0020http\u0020status\u0020code\u0020used\u0020in\u0020the\u0020API", - "url": "classes/Doofinder-Shared-HttpStatusCode.html" - }, { - "fqsen": "\\Doofinder\\Shared\\HttpStatusCode\u003A\u003AOK", - "name": "OK", - "summary": "", - "url": "classes/Doofinder-Shared-HttpStatusCode.html#constant_OK" - }, { - "fqsen": "\\Doofinder\\Shared\\HttpStatusCode\u003A\u003ACREATED", - "name": "CREATED", - "summary": "", - "url": "classes/Doofinder-Shared-HttpStatusCode.html#constant_CREATED" - }, { - "fqsen": "\\Doofinder\\Shared\\HttpStatusCode\u003A\u003ANO_CONTENT", - "name": "NO_CONTENT", - "summary": "", - "url": "classes/Doofinder-Shared-HttpStatusCode.html#constant_NO_CONTENT" - }, { - "fqsen": "\\Doofinder\\Shared\\HttpStatusCode\u003A\u003ABAD_REQUEST", - "name": "BAD_REQUEST", - "summary": "", - "url": "classes/Doofinder-Shared-HttpStatusCode.html#constant_BAD_REQUEST" - }, { - "fqsen": "\\Doofinder\\Shared\\HttpStatusCode\u003A\u003AUNAUTHORIZED", - "name": "UNAUTHORIZED", - "summary": "", - "url": "classes/Doofinder-Shared-HttpStatusCode.html#constant_UNAUTHORIZED" - }, { - "fqsen": "\\Doofinder\\Shared\\HttpStatusCode\u003A\u003AFORBIDDEN", - "name": "FORBIDDEN", - "summary": "", - "url": "classes/Doofinder-Shared-HttpStatusCode.html#constant_FORBIDDEN" - }, { - "fqsen": "\\Doofinder\\Shared\\HttpStatusCode\u003A\u003ANOT_FOUND", - "name": "NOT_FOUND", - "summary": "", - "url": "classes/Doofinder-Shared-HttpStatusCode.html#constant_NOT_FOUND" - }, { - "fqsen": "\\Doofinder\\Shared\\HttpStatusCode\u003A\u003AREQUEST_TIMEOUT", - "name": "REQUEST_TIMEOUT", - "summary": "", - "url": "classes/Doofinder-Shared-HttpStatusCode.html#constant_REQUEST_TIMEOUT" - }, { - "fqsen": "\\Doofinder\\Shared\\HttpStatusCode\u003A\u003ACONFLICT", - "name": "CONFLICT", - "summary": "", - "url": "classes/Doofinder-Shared-HttpStatusCode.html#constant_CONFLICT" - }, { - "fqsen": "\\Doofinder\\Shared\\HttpStatusCode\u003A\u003AREQUEST_ENTITY_TOO_LARGE", - "name": "REQUEST_ENTITY_TOO_LARGE", - "summary": "", - "url": "classes/Doofinder-Shared-HttpStatusCode.html#constant_REQUEST_ENTITY_TOO_LARGE" - }, { - "fqsen": "\\Doofinder\\Shared\\HttpStatusCode\u003A\u003ATOO_MANY_REQUESTS", - "name": "TOO_MANY_REQUESTS", - "summary": "", - "url": "classes/Doofinder-Shared-HttpStatusCode.html#constant_TOO_MANY_REQUESTS" - }, { - "fqsen": "\\Doofinder\\Shared\\HttpStatusCode\u003A\u003AINTERNAL_SERVER_ERROR", - "name": "INTERNAL_SERVER_ERROR", - "summary": "", - "url": "classes/Doofinder-Shared-HttpStatusCode.html#constant_INTERNAL_SERVER_ERROR" - }, { - "fqsen": "\\Doofinder\\Shared\\HttpStatusCode\u003A\u003ABAD_GATEWAY", - "name": "BAD_GATEWAY", - "summary": "", - "url": "classes/Doofinder-Shared-HttpStatusCode.html#constant_BAD_GATEWAY" - }, { - "fqsen": "\\Doofinder\\Shared\\Interfaces\\HttpClientInterface", - "name": "HttpClientInterface", - "summary": "Http\u0020client\u0027s\u0020interface", - "url": "classes/Doofinder-Shared-Interfaces-HttpClientInterface.html" - }, { - "fqsen": "\\Doofinder\\Shared\\Interfaces\\HttpClientInterface\u003A\u003Arequest\u0028\u0029", - "name": "request", - "summary": "", - "url": "classes/Doofinder-Shared-Interfaces-HttpClientInterface.html#method_request" - }, { - "fqsen": "\\Doofinder\\Shared\\Interfaces\\HttpClientInterface\u003A\u003AMETHOD_POST", - "name": "METHOD_POST", - "summary": "", - "url": "classes/Doofinder-Shared-Interfaces-HttpClientInterface.html#constant_METHOD_POST" - }, { - "fqsen": "\\Doofinder\\Shared\\Interfaces\\HttpClientInterface\u003A\u003AMETHOD_GET", - "name": "METHOD_GET", - "summary": "", - "url": "classes/Doofinder-Shared-Interfaces-HttpClientInterface.html#constant_METHOD_GET" - }, { - "fqsen": "\\Doofinder\\Shared\\Interfaces\\HttpClientInterface\u003A\u003AMETHOD_PATCH", - "name": "METHOD_PATCH", - "summary": "", - "url": "classes/Doofinder-Shared-Interfaces-HttpClientInterface.html#constant_METHOD_PATCH" - }, { - "fqsen": "\\Doofinder\\Shared\\Interfaces\\HttpClientInterface\u003A\u003AMETHOD_PUT", - "name": "METHOD_PUT", - "summary": "", - "url": "classes/Doofinder-Shared-Interfaces-HttpClientInterface.html#constant_METHOD_PUT" - }, { - "fqsen": "\\Doofinder\\Shared\\Interfaces\\HttpClientInterface\u003A\u003AMETHOD_DELETE", - "name": "METHOD_DELETE", - "summary": "", - "url": "classes/Doofinder-Shared-Interfaces-HttpClientInterface.html#constant_METHOD_DELETE" - }, { - "fqsen": "\\Doofinder\\Shared\\Interfaces\\HttpResponseInterface", - "name": "HttpResponseInterface", - "summary": "Http\u0020response\u0027s\u0020interface", - "url": "classes/Doofinder-Shared-Interfaces-HttpResponseInterface.html" - }, { - "fqsen": "\\Doofinder\\Shared\\Interfaces\\HttpResponseInterface\u003A\u003Acreate\u0028\u0029", - "name": "create", - "summary": "", - "url": "classes/Doofinder-Shared-Interfaces-HttpResponseInterface.html#method_create" - }, { - "fqsen": "\\Doofinder\\Shared\\Interfaces\\HttpResponseInterface\u003A\u003AgetBody\u0028\u0029", - "name": "getBody", - "summary": "", - "url": "classes/Doofinder-Shared-Interfaces-HttpResponseInterface.html#method_getBody" - }, { - "fqsen": "\\Doofinder\\Shared\\Interfaces\\HttpResponseInterface\u003A\u003AgetStatusCode\u0028\u0029", - "name": "getStatusCode", - "summary": "", - "url": "classes/Doofinder-Shared-Interfaces-HttpResponseInterface.html#method_getStatusCode" - }, { - "fqsen": "\\Doofinder\\Shared\\Interfaces\\HttpResponseInterface\u003A\u003AsetBody\u0028\u0029", - "name": "setBody", - "summary": "", - "url": "classes/Doofinder-Shared-Interfaces-HttpResponseInterface.html#method_setBody" - }, { - "fqsen": "\\Doofinder\\Shared\\Interfaces\\ModelInterface", - "name": "ModelInterface", - "summary": "Model\u0027s\u0020interface", - "url": "classes/Doofinder-Shared-Interfaces-ModelInterface.html" - }, { - "fqsen": "\\Doofinder\\Shared\\Interfaces\\ModelInterface\u003A\u003AcreateFromArray\u0028\u0029", - "name": "createFromArray", - "summary": "", - "url": "classes/Doofinder-Shared-Interfaces-ModelInterface.html#method_createFromArray" - }, { - "fqsen": "\\Doofinder\\Shared\\Resource", - "name": "Resource", - "summary": "A\u0020resource\u0020class\u0020is\u0020in\u0020charge\u0020to\u0020communicate\u0020with\u0020the\u0020API\u0020and\u0020return\u0020a\u0020formatted\u0020response", - "url": "classes/Doofinder-Shared-Resource.html" - }, { - "fqsen": "\\Doofinder\\Shared\\Resource\u003A\u003A__construct\u0028\u0029", - "name": "__construct", - "summary": "", - "url": "classes/Doofinder-Shared-Resource.html#method___construct" - }, { - "fqsen": "\\Doofinder\\Shared\\Resource\u003A\u003AgetUrl\u0028\u0029", - "name": "getUrl", - "summary": "", - "url": "classes/Doofinder-Shared-Resource.html#method_getUrl" - }, { - "fqsen": "\\Doofinder\\Shared\\Resource\u003A\u003Arequest\u0028\u0029", - "name": "request", - "summary": "It\u0020does\u0020a\u0020http\u0020request.\u0020If\u0020there\u0020is\u0020an\u0020error\u0020throws\u0020an\u0020ApiException", - "url": "classes/Doofinder-Shared-Resource.html#method_request" - }, { - "fqsen": "\\Doofinder\\Shared\\Resource\u003A\u003ArequestWithJwt\u0028\u0029", - "name": "requestWithJwt", - "summary": "It\u0020does\u0020a\u0020http\u0020request\u0020with\u0020Jwt\u0020authentication.\u0020If\u0020there\u0020is\u0020an\u0020error\u0020throws\u0020an\u0020ApiException", - "url": "classes/Doofinder-Shared-Resource.html#method_requestWithJwt" - }, { - "fqsen": "\\Doofinder\\Shared\\Resource\u003A\u003ArequestWithToken\u0028\u0029", - "name": "requestWithToken", - "summary": "It\u0020does\u0020a\u0020http\u0020request\u0020with\u0020Token\u0020authentication.\u0020If\u0020there\u0020is\u0020an\u0020error\u0020throws\u0020an\u0020ApiException", - "url": "classes/Doofinder-Shared-Resource.html#method_requestWithToken" - }, { - "fqsen": "\\Doofinder\\Shared\\Resource\u003A\u003A\u0024httpClient", - "name": "httpClient", - "summary": "", - "url": "classes/Doofinder-Shared-Resource.html#property_httpClient" - }, { - "fqsen": "\\Doofinder\\Shared\\Resource\u003A\u003A\u0024config", - "name": "config", - "summary": "", - "url": "classes/Doofinder-Shared-Resource.html#property_config" - }, { - "fqsen": "\\Doofinder\\Shared\\Resource\u003A\u003A\u0024baseUrl", - "name": "baseUrl", - "summary": "", - "url": "classes/Doofinder-Shared-Resource.html#property_baseUrl" - }, { - "fqsen": "\\Doofinder\\Shared\\Services\\Jwt", - "name": "Jwt", - "summary": "Utility\u0020to\u0020generate\u0020a\u0020Json\u0020Web\u0020Token\u0020\u0028JWT\u0029\u0020to\u0020do\u0020requests\u0020to\u0020Doofinder\u0020API\u0020services", - "url": "classes/Doofinder-Shared-Services-Jwt.html" - }, { - "fqsen": "\\Doofinder\\Shared\\Services\\Jwt\u003A\u003AgenerateToken\u0028\u0029", - "name": "generateToken", - "summary": "Given\u0020an\u0020api\u0020token\u0020and\u0020secret\u0020generates\u0020a\u0020JWT", - "url": "classes/Doofinder-Shared-Services-Jwt.html#method_generateToken" - }, { - "fqsen": "\\Doofinder\\Shared\\Services\\Jwt\u003A\u003Abase64url_encode\u0028\u0029", - "name": "base64url_encode", - "summary": "", - "url": "classes/Doofinder-Shared-Services-Jwt.html#method_base64url_encode" - }, { - "fqsen": "\\Doofinder\\Shared\\Services\\Jwt\u003A\u003AHEADER", - "name": "HEADER", - "summary": "", - "url": "classes/Doofinder-Shared-Services-Jwt.html#constant_HEADER" - }, { - "fqsen": "\\Doofinder\\Shared\\Utils\\ErrorHandler", - "name": "ErrorHandler", - "summary": "Class\u0020in\u0020charge\u0020on\u0020mapping\u0020response\u0020message\u0020to\u0020client\u0020message", - "url": "classes/Doofinder-Shared-Utils-ErrorHandler.html" - }, { - "fqsen": "\\Doofinder\\Shared\\Utils\\ErrorHandler\u003A\u003Acreate\u0028\u0029", - "name": "create", - "summary": "", - "url": "classes/Doofinder-Shared-Utils-ErrorHandler.html#method_create" - }, { - "fqsen": "\\Doofinder\\Shared\\Utils\\ErrorHandler\u003A\u003AgetErrorCode\u0028\u0029", - "name": "getErrorCode", - "summary": "", - "url": "classes/Doofinder-Shared-Utils-ErrorHandler.html#method_getErrorCode" - }, { - "fqsen": "\\Doofinder\\Shared\\Utils\\ErrorHandler\u003A\u003ADEFAULT_FIELD", - "name": "DEFAULT_FIELD", - "summary": "", - "url": "classes/Doofinder-Shared-Utils-ErrorHandler.html#constant_DEFAULT_FIELD" - }, { - "fqsen": "\\Doofinder\\Shared\\Utils\\ErrorHandler\u003A\u003AMESSAGES", - "name": "MESSAGES", - "summary": "", - "url": "classes/Doofinder-Shared-Utils-ErrorHandler.html#constant_MESSAGES" - }, { - "fqsen": "\\", - "name": "\\", - "summary": "", - "url": "namespaces/default.html" - }, { - "fqsen": "\\Doofinder", - "name": "Doofinder", - "summary": "", - "url": "namespaces/doofinder.html" - }, { - "fqsen": "\\Doofinder\\Management", - "name": "Management", - "summary": "", - "url": "namespaces/doofinder-management.html" - }, { - "fqsen": "\\Doofinder\\Management\\Model", - "name": "Model", - "summary": "", - "url": "namespaces/doofinder-management-model.html" - }, { - "fqsen": "\\Doofinder\\Management\\Resources", - "name": "Resources", - "summary": "", - "url": "namespaces/doofinder-management-resources.html" - }, { - "fqsen": "\\Doofinder\\Search\\Resources", - "name": "Resources", - "summary": "", - "url": "namespaces/doofinder-search-resources.html" - }, { - "fqsen": "\\Doofinder\\Search", - "name": "Search", - "summary": "", - "url": "namespaces/doofinder-search.html" - }, { - "fqsen": "\\Doofinder\\Shared\\Exceptions", - "name": "Exceptions", - "summary": "", - "url": "namespaces/doofinder-shared-exceptions.html" - }, { - "fqsen": "\\Doofinder\\Shared", - "name": "Shared", - "summary": "", - "url": "namespaces/doofinder-shared.html" - }, { - "fqsen": "\\Doofinder\\Shared\\Interfaces", - "name": "Interfaces", - "summary": "", - "url": "namespaces/doofinder-shared-interfaces.html" - }, { - "fqsen": "\\Doofinder\\Shared\\Services", - "name": "Services", - "summary": "", - "url": "namespaces/doofinder-shared-services.html" - }, { - "fqsen": "\\Doofinder\\Shared\\Utils", - "name": "Utils", - "summary": "", - "url": "namespaces/doofinder-shared-utils.html" - } ] -); diff --git a/doc/namespaces/default.html b/doc/namespaces/default.html deleted file mode 100644 index 6f459d7..0000000 --- a/doc/namespaces/default.html +++ /dev/null @@ -1,142 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                                                  -

                                                                                                                                  Documentation

                                                                                                                                  - - - - - -
                                                                                                                                  - -
                                                                                                                                  -
                                                                                                                                  - - - - -
                                                                                                                                  -
                                                                                                                                    -
                                                                                                                                  - -
                                                                                                                                  -

                                                                                                                                  API Documentation

                                                                                                                                  - - -

                                                                                                                                  - Namespaces - -

                                                                                                                                  - -
                                                                                                                                  -
                                                                                                                                  Doofinder
                                                                                                                                  -
                                                                                                                                  - - - - - - - -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -

                                                                                                                                  Search results

                                                                                                                                  - -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    - - -
                                                                                                                                    - - - - - - - - diff --git a/doc/namespaces/doofinder-management-model.html b/doc/namespaces/doofinder-management-model.html deleted file mode 100644 index 97cef81..0000000 --- a/doc/namespaces/doofinder-management-model.html +++ /dev/null @@ -1,165 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                                                    -

                                                                                                                                    Documentation

                                                                                                                                    - - - - - -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - - - - -
                                                                                                                                    - - -
                                                                                                                                    -

                                                                                                                                    Model

                                                                                                                                    - - - -

                                                                                                                                    - Interfaces, Classes and Traits - -

                                                                                                                                    - -
                                                                                                                                    - -
                                                                                                                                    DataSource
                                                                                                                                    -
                                                                                                                                    Model with data of a given data source
                                                                                                                                    -
                                                                                                                                    DataSourceOption
                                                                                                                                    -
                                                                                                                                    Model with data of a given data source option
                                                                                                                                    -
                                                                                                                                    DataSourceOptionBigCommerce
                                                                                                                                    -
                                                                                                                                    Model with data of a given "big commerce" data source option
                                                                                                                                    -
                                                                                                                                    DataSourceOptionEkm
                                                                                                                                    -
                                                                                                                                    Model with data of a given "ekm" data source option
                                                                                                                                    -
                                                                                                                                    DataSourceOptionFile
                                                                                                                                    -
                                                                                                                                    Model with data of a given "file" data source option
                                                                                                                                    -
                                                                                                                                    DataSourceOptionMagento
                                                                                                                                    -
                                                                                                                                    Model with data of a given "magento" data source option
                                                                                                                                    -
                                                                                                                                    DataSourceOptionShopify
                                                                                                                                    -
                                                                                                                                    Model with data of a given "shopify" data source option
                                                                                                                                    -
                                                                                                                                    Index
                                                                                                                                    -
                                                                                                                                    Model with data of a given index
                                                                                                                                    -
                                                                                                                                    Item
                                                                                                                                    -
                                                                                                                                    Model with data of a given item
                                                                                                                                    -
                                                                                                                                    SearchEngine
                                                                                                                                    -
                                                                                                                                    Model with data of a given search engine
                                                                                                                                    - -
                                                                                                                                    - - - - - - -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -

                                                                                                                                    Search results

                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      - - -
                                                                                                                                      - - - - - - - - diff --git a/doc/namespaces/doofinder-management-resources.html b/doc/namespaces/doofinder-management-resources.html deleted file mode 100644 index 23f3a56..0000000 --- a/doc/namespaces/doofinder-management-resources.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      -

                                                                                                                                      Documentation

                                                                                                                                      - - - - - -
                                                                                                                                      - -
                                                                                                                                      -
                                                                                                                                      - - - - -
                                                                                                                                      - - -
                                                                                                                                      -

                                                                                                                                      Resources

                                                                                                                                      - - - -

                                                                                                                                      - Interfaces, Classes and Traits - -

                                                                                                                                      - -
                                                                                                                                      - -
                                                                                                                                      Index
                                                                                                                                      -
                                                                                                                                      Index class is responsible for making the requests to the index's endpoints and return a response
                                                                                                                                      -
                                                                                                                                      Item
                                                                                                                                      -
                                                                                                                                      Item class is responsible for making the requests to the item's endpoints and return a response
                                                                                                                                      -
                                                                                                                                      ManagementResource
                                                                                                                                      -
                                                                                                                                      A resource class is in charge to communicate with the API and return a formatted response
                                                                                                                                      -
                                                                                                                                      SearchEngine
                                                                                                                                      -
                                                                                                                                      SearchEngines class is responsible for making the requests to the search_engine's endpoints and return a response
                                                                                                                                      - -
                                                                                                                                      - - - - - - -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -

                                                                                                                                      Search results

                                                                                                                                      - -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - - -
                                                                                                                                        - - - - - - - - diff --git a/doc/namespaces/doofinder-management.html b/doc/namespaces/doofinder-management.html deleted file mode 100644 index 08bfddc..0000000 --- a/doc/namespaces/doofinder-management.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        -

                                                                                                                                        Documentation

                                                                                                                                        - - - - - -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        - - - - -
                                                                                                                                        - - -
                                                                                                                                        -

                                                                                                                                        Management

                                                                                                                                        - - -

                                                                                                                                        - Namespaces - -

                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        Model
                                                                                                                                        -
                                                                                                                                        Resources
                                                                                                                                        -
                                                                                                                                        - -

                                                                                                                                        - Interfaces, Classes and Traits - -

                                                                                                                                        - -
                                                                                                                                        - -
                                                                                                                                        ManagementClient
                                                                                                                                        -
                                                                                                                                        This class is used to do management actions against search engines, index and items through calling an API.
                                                                                                                                        - -
                                                                                                                                        - - - - - - -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Search results

                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - - -
                                                                                                                                          - - - - - - - - diff --git a/doc/namespaces/doofinder-search-resources.html b/doc/namespaces/doofinder-search-resources.html deleted file mode 100644 index f0a14e3..0000000 --- a/doc/namespaces/doofinder-search-resources.html +++ /dev/null @@ -1,151 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                                                          -

                                                                                                                                          Documentation

                                                                                                                                          - - - - - -
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          - - - - -
                                                                                                                                          - - -
                                                                                                                                          -

                                                                                                                                          Resources

                                                                                                                                          - - - -

                                                                                                                                          - Interfaces, Classes and Traits - -

                                                                                                                                          - -
                                                                                                                                          - -
                                                                                                                                          Search
                                                                                                                                          -
                                                                                                                                          Search class is responsible for making the requests to the search's endpoint and return a response
                                                                                                                                          -
                                                                                                                                          SearchResource
                                                                                                                                          -
                                                                                                                                          A resource class is in charge to communicate with the API and return a formatted response
                                                                                                                                          -
                                                                                                                                          Stats
                                                                                                                                          -
                                                                                                                                          Stats class is responsible for making the requests to the Stats's endpoint and return a response
                                                                                                                                          - -
                                                                                                                                          - - - - - - -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          Search results

                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - - -
                                                                                                                                            - - - - - - - - diff --git a/doc/namespaces/doofinder-search.html b/doc/namespaces/doofinder-search.html deleted file mode 100644 index 3184811..0000000 --- a/doc/namespaces/doofinder-search.html +++ /dev/null @@ -1,154 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                                                            -

                                                                                                                                            Documentation

                                                                                                                                            - - - - - -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - - - - -
                                                                                                                                            - - -
                                                                                                                                            -

                                                                                                                                            Search

                                                                                                                                            - - -

                                                                                                                                            - Namespaces - -

                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            Resources
                                                                                                                                            -
                                                                                                                                            - -

                                                                                                                                            - Interfaces, Classes and Traits - -

                                                                                                                                            - -
                                                                                                                                            - -
                                                                                                                                            SearchClient
                                                                                                                                            -
                                                                                                                                            This class is used to do searches through calling an API.
                                                                                                                                            - -
                                                                                                                                            - - - - - - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            Search results

                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - - -
                                                                                                                                              - - - - - - - - diff --git a/doc/namespaces/doofinder-shared-exceptions.html b/doc/namespaces/doofinder-shared-exceptions.html deleted file mode 100644 index 2febe62..0000000 --- a/doc/namespaces/doofinder-shared-exceptions.html +++ /dev/null @@ -1,149 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                                                              -

                                                                                                                                              Documentation

                                                                                                                                              - - - - - -
                                                                                                                                              - -
                                                                                                                                              -
                                                                                                                                              - - - - -
                                                                                                                                              - - -
                                                                                                                                              -

                                                                                                                                              Exceptions

                                                                                                                                              - - - -

                                                                                                                                              - Interfaces, Classes and Traits - -

                                                                                                                                              - -
                                                                                                                                              - -
                                                                                                                                              ApiException
                                                                                                                                              -
                                                                                                                                              Exception used when API request returns a not OK response
                                                                                                                                              -
                                                                                                                                              RequestException
                                                                                                                                              -
                                                                                                                                              Exception used when there is an error in the http request
                                                                                                                                              - -
                                                                                                                                              - - - - - - -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -

                                                                                                                                              Search results

                                                                                                                                              - -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                - - -
                                                                                                                                                - - - - - - - - diff --git a/doc/namespaces/doofinder-shared-interfaces.html b/doc/namespaces/doofinder-shared-interfaces.html deleted file mode 100644 index 5b9f2e8..0000000 --- a/doc/namespaces/doofinder-shared-interfaces.html +++ /dev/null @@ -1,151 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                -

                                                                                                                                                Documentation

                                                                                                                                                - - - - - -
                                                                                                                                                - -
                                                                                                                                                -
                                                                                                                                                - - - - -
                                                                                                                                                - - - -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -

                                                                                                                                                Search results

                                                                                                                                                - -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - - -
                                                                                                                                                  - - - - - - - - diff --git a/doc/namespaces/doofinder-shared-services.html b/doc/namespaces/doofinder-shared-services.html deleted file mode 100644 index cf849ca..0000000 --- a/doc/namespaces/doofinder-shared-services.html +++ /dev/null @@ -1,147 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                  -

                                                                                                                                                  Documentation

                                                                                                                                                  - - - - - -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  - - - - -
                                                                                                                                                  - - -
                                                                                                                                                  -

                                                                                                                                                  Services

                                                                                                                                                  - - - -

                                                                                                                                                  - Interfaces, Classes and Traits - -

                                                                                                                                                  - -
                                                                                                                                                  - -
                                                                                                                                                  Jwt
                                                                                                                                                  -
                                                                                                                                                  Utility to generate a Json Web Token (JWT) to do requests to Doofinder API services
                                                                                                                                                  - -
                                                                                                                                                  - - - - - - -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -

                                                                                                                                                  Search results

                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    - - -
                                                                                                                                                    - - - - - - - - diff --git a/doc/namespaces/doofinder-shared-utils.html b/doc/namespaces/doofinder-shared-utils.html deleted file mode 100644 index 2995171..0000000 --- a/doc/namespaces/doofinder-shared-utils.html +++ /dev/null @@ -1,147 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                    -

                                                                                                                                                    Documentation

                                                                                                                                                    - - - - - -
                                                                                                                                                    - -
                                                                                                                                                    -
                                                                                                                                                    - - - - -
                                                                                                                                                    - - -
                                                                                                                                                    -

                                                                                                                                                    Utils

                                                                                                                                                    - - - -

                                                                                                                                                    - Interfaces, Classes and Traits - -

                                                                                                                                                    - -
                                                                                                                                                    - -
                                                                                                                                                    ErrorHandler
                                                                                                                                                    -
                                                                                                                                                    Class in charge on mapping response message to client message
                                                                                                                                                    - -
                                                                                                                                                    - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                    -

                                                                                                                                                    Search results

                                                                                                                                                    - -
                                                                                                                                                    -
                                                                                                                                                    -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - - -
                                                                                                                                                      - - - - - - - - diff --git a/doc/namespaces/doofinder-shared.html b/doc/namespaces/doofinder-shared.html deleted file mode 100644 index cbb2658..0000000 --- a/doc/namespaces/doofinder-shared.html +++ /dev/null @@ -1,163 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                      -

                                                                                                                                                      Documentation

                                                                                                                                                      - - - - - -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      - - - - -
                                                                                                                                                      - - -
                                                                                                                                                      -

                                                                                                                                                      Shared

                                                                                                                                                      - - -

                                                                                                                                                      - Namespaces - -

                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      Exceptions
                                                                                                                                                      -
                                                                                                                                                      Interfaces
                                                                                                                                                      -
                                                                                                                                                      Services
                                                                                                                                                      -
                                                                                                                                                      Utils
                                                                                                                                                      -
                                                                                                                                                      - -

                                                                                                                                                      - Interfaces, Classes and Traits - -

                                                                                                                                                      - -
                                                                                                                                                      - -
                                                                                                                                                      HttpClient
                                                                                                                                                      -
                                                                                                                                                      Class to do requests though curl utility
                                                                                                                                                      -
                                                                                                                                                      HttpResponse
                                                                                                                                                      -
                                                                                                                                                      Class to return a formatted info comming from API
                                                                                                                                                      -
                                                                                                                                                      HttpStatusCode
                                                                                                                                                      -
                                                                                                                                                      Class to store all http status code used in the API
                                                                                                                                                      -
                                                                                                                                                      Resource
                                                                                                                                                      -
                                                                                                                                                      A resource class is in charge to communicate with the API and return a formatted response
                                                                                                                                                      - -
                                                                                                                                                      - - - - - - -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      Search results

                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        - - -
                                                                                                                                                        - - - - - - - - diff --git a/doc/namespaces/doofinder.html b/doc/namespaces/doofinder.html deleted file mode 100644 index cad4ba4..0000000 --- a/doc/namespaces/doofinder.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                        -

                                                                                                                                                        Documentation

                                                                                                                                                        - - - - - -
                                                                                                                                                        - -
                                                                                                                                                        -
                                                                                                                                                        - - - - -
                                                                                                                                                        -
                                                                                                                                                          -
                                                                                                                                                        - -
                                                                                                                                                        -

                                                                                                                                                        Doofinder

                                                                                                                                                        - - -

                                                                                                                                                        - Namespaces - -

                                                                                                                                                        - -
                                                                                                                                                        -
                                                                                                                                                        Management
                                                                                                                                                        -
                                                                                                                                                        Search
                                                                                                                                                        -
                                                                                                                                                        Shared
                                                                                                                                                        -
                                                                                                                                                        - -

                                                                                                                                                        - Interfaces, Classes and Traits - -

                                                                                                                                                        - -
                                                                                                                                                        - -
                                                                                                                                                        Configuration
                                                                                                                                                        -
                                                                                                                                                        Class with API configuration
                                                                                                                                                        - -
                                                                                                                                                        - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -

                                                                                                                                                        Search results

                                                                                                                                                        - -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          - - -
                                                                                                                                                          - - - - - - - - diff --git a/doc/packages/Application.html b/doc/packages/Application.html deleted file mode 100644 index 0f4e19f..0000000 --- a/doc/packages/Application.html +++ /dev/null @@ -1,205 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                          -

                                                                                                                                                          Documentation

                                                                                                                                                          - - - - - -
                                                                                                                                                          - -
                                                                                                                                                          -
                                                                                                                                                          - - - - -
                                                                                                                                                          -
                                                                                                                                                            -
                                                                                                                                                          - -
                                                                                                                                                          -

                                                                                                                                                          Application

                                                                                                                                                          - - - -

                                                                                                                                                          - Interfaces, Classes and Traits - -

                                                                                                                                                          - -
                                                                                                                                                          -
                                                                                                                                                          HttpClientInterface
                                                                                                                                                          -
                                                                                                                                                          Http client's interface
                                                                                                                                                          -
                                                                                                                                                          HttpResponseInterface
                                                                                                                                                          -
                                                                                                                                                          Http response's interface
                                                                                                                                                          -
                                                                                                                                                          ModelInterface
                                                                                                                                                          -
                                                                                                                                                          Model's interface
                                                                                                                                                          - -
                                                                                                                                                          Configuration
                                                                                                                                                          -
                                                                                                                                                          Class with API configuration
                                                                                                                                                          -
                                                                                                                                                          ManagementClient
                                                                                                                                                          -
                                                                                                                                                          This class is used to do management actions against search engines, index and items through calling an API.
                                                                                                                                                          -
                                                                                                                                                          DataSource
                                                                                                                                                          -
                                                                                                                                                          Model with data of a given data source
                                                                                                                                                          -
                                                                                                                                                          DataSourceOption
                                                                                                                                                          -
                                                                                                                                                          Model with data of a given data source option
                                                                                                                                                          -
                                                                                                                                                          DataSourceOptionBigCommerce
                                                                                                                                                          -
                                                                                                                                                          Model with data of a given "big commerce" data source option
                                                                                                                                                          -
                                                                                                                                                          DataSourceOptionEkm
                                                                                                                                                          -
                                                                                                                                                          Model with data of a given "ekm" data source option
                                                                                                                                                          -
                                                                                                                                                          DataSourceOptionFile
                                                                                                                                                          -
                                                                                                                                                          Model with data of a given "file" data source option
                                                                                                                                                          -
                                                                                                                                                          DataSourceOptionMagento
                                                                                                                                                          -
                                                                                                                                                          Model with data of a given "magento" data source option
                                                                                                                                                          -
                                                                                                                                                          DataSourceOptionShopify
                                                                                                                                                          -
                                                                                                                                                          Model with data of a given "shopify" data source option
                                                                                                                                                          -
                                                                                                                                                          Index
                                                                                                                                                          -
                                                                                                                                                          Model with data of a given index
                                                                                                                                                          -
                                                                                                                                                          Item
                                                                                                                                                          -
                                                                                                                                                          Model with data of a given item
                                                                                                                                                          -
                                                                                                                                                          SearchEngine
                                                                                                                                                          -
                                                                                                                                                          Model with data of a given search engine
                                                                                                                                                          -
                                                                                                                                                          Index
                                                                                                                                                          -
                                                                                                                                                          Index class is responsible for making the requests to the index's endpoints and return a response
                                                                                                                                                          -
                                                                                                                                                          Item
                                                                                                                                                          -
                                                                                                                                                          Item class is responsible for making the requests to the item's endpoints and return a response
                                                                                                                                                          -
                                                                                                                                                          ManagementResource
                                                                                                                                                          -
                                                                                                                                                          A resource class is in charge to communicate with the API and return a formatted response
                                                                                                                                                          -
                                                                                                                                                          SearchEngine
                                                                                                                                                          -
                                                                                                                                                          SearchEngines class is responsible for making the requests to the search_engine's endpoints and return a response
                                                                                                                                                          -
                                                                                                                                                          Search
                                                                                                                                                          -
                                                                                                                                                          Search class is responsible for making the requests to the search's endpoint and return a response
                                                                                                                                                          -
                                                                                                                                                          SearchResource
                                                                                                                                                          -
                                                                                                                                                          A resource class is in charge to communicate with the API and return a formatted response
                                                                                                                                                          -
                                                                                                                                                          Stats
                                                                                                                                                          -
                                                                                                                                                          Stats class is responsible for making the requests to the Stats's endpoint and return a response
                                                                                                                                                          -
                                                                                                                                                          SearchClient
                                                                                                                                                          -
                                                                                                                                                          This class is used to do searches through calling an API.
                                                                                                                                                          -
                                                                                                                                                          ApiException
                                                                                                                                                          -
                                                                                                                                                          Exception used when API request returns a not OK response
                                                                                                                                                          -
                                                                                                                                                          RequestException
                                                                                                                                                          -
                                                                                                                                                          Exception used when there is an error in the http request
                                                                                                                                                          -
                                                                                                                                                          HttpClient
                                                                                                                                                          -
                                                                                                                                                          Class to do requests though curl utility
                                                                                                                                                          -
                                                                                                                                                          HttpResponse
                                                                                                                                                          -
                                                                                                                                                          Class to return a formatted info comming from API
                                                                                                                                                          -
                                                                                                                                                          HttpStatusCode
                                                                                                                                                          -
                                                                                                                                                          Class to store all http status code used in the API
                                                                                                                                                          -
                                                                                                                                                          Resource
                                                                                                                                                          -
                                                                                                                                                          A resource class is in charge to communicate with the API and return a formatted response
                                                                                                                                                          -
                                                                                                                                                          Jwt
                                                                                                                                                          -
                                                                                                                                                          Utility to generate a Json Web Token (JWT) to do requests to Doofinder API services
                                                                                                                                                          -
                                                                                                                                                          ErrorHandler
                                                                                                                                                          -
                                                                                                                                                          Class in charge on mapping response message to client message
                                                                                                                                                          - -
                                                                                                                                                          - - - - - - -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -

                                                                                                                                                          Search results

                                                                                                                                                          - -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            - - -
                                                                                                                                                            - - - - - - - - diff --git a/doc/packages/default.html b/doc/packages/default.html deleted file mode 100644 index 6532c9f..0000000 --- a/doc/packages/default.html +++ /dev/null @@ -1,142 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                            -

                                                                                                                                                            Documentation

                                                                                                                                                            - - - - - -
                                                                                                                                                            - -
                                                                                                                                                            -
                                                                                                                                                            - - - - -
                                                                                                                                                            -
                                                                                                                                                              -
                                                                                                                                                            - -
                                                                                                                                                            -

                                                                                                                                                            API Documentation

                                                                                                                                                            - -

                                                                                                                                                            - Packages - -

                                                                                                                                                            - -
                                                                                                                                                            -
                                                                                                                                                            Application
                                                                                                                                                            -
                                                                                                                                                            - - - - - - - - -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -

                                                                                                                                                            Search results

                                                                                                                                                            - -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              - - -
                                                                                                                                                              - - - - - - - - diff --git a/doc/reports/deprecated.html b/doc/reports/deprecated.html deleted file mode 100644 index 74269c4..0000000 --- a/doc/reports/deprecated.html +++ /dev/null @@ -1,154 +0,0 @@ - - - - - Documentation » Deprecated elements - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                              -

                                                                                                                                                              Documentation

                                                                                                                                                              - - - - - -
                                                                                                                                                              - -
                                                                                                                                                              -
                                                                                                                                                              - - - - -
                                                                                                                                                              - - -
                                                                                                                                                              -

                                                                                                                                                              Deprecated

                                                                                                                                                              - -

                                                                                                                                                              Table of Contents

                                                                                                                                                              - - - - -
                                                                                                                                                              src/Management/Model/SearchEngine.php
                                                                                                                                                              - - -

                                                                                                                                                              SearchEngine.php

                                                                                                                                                              - - - - - - - - - - - - - - - - -
                                                                                                                                                              LineElementReason
                                                                                                                                                              175SearchEngine::getSiteUrl()
                                                                                                                                                              51SearchEngine::$siteUrl
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -

                                                                                                                                                              Search results

                                                                                                                                                              - -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                - - -
                                                                                                                                                                - - - - - - - - diff --git a/doc/reports/errors.html b/doc/reports/errors.html deleted file mode 100644 index 262d094..0000000 --- a/doc/reports/errors.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - Documentation » Compilation errors - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                -

                                                                                                                                                                Documentation

                                                                                                                                                                - - - - - -
                                                                                                                                                                - -
                                                                                                                                                                -
                                                                                                                                                                - - - - -
                                                                                                                                                                - - -
                                                                                                                                                                -

                                                                                                                                                                Errors

                                                                                                                                                                - - -
                                                                                                                                                                No errors have been found in this project.
                                                                                                                                                                - -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                -

                                                                                                                                                                Search results

                                                                                                                                                                - -
                                                                                                                                                                -
                                                                                                                                                                -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  - - -
                                                                                                                                                                  - - - - - - - - diff --git a/doc/reports/markers.html b/doc/reports/markers.html deleted file mode 100644 index 21ef1b0..0000000 --- a/doc/reports/markers.html +++ /dev/null @@ -1,154 +0,0 @@ - - - - - Documentation » Markers - - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                                  -

                                                                                                                                                                  Documentation

                                                                                                                                                                  - - - - - -
                                                                                                                                                                  - -
                                                                                                                                                                  -
                                                                                                                                                                  - - - - -
                                                                                                                                                                  - - -
                                                                                                                                                                  -

                                                                                                                                                                  Markers

                                                                                                                                                                  - -

                                                                                                                                                                  Table of Contents

                                                                                                                                                                  - - - - - -
                                                                                                                                                                  src/Shared/HttpStatusCode.php1
                                                                                                                                                                  - - -

                                                                                                                                                                  HttpStatusCode.php

                                                                                                                                                                  - - - - - - - - - - - - - - - -
                                                                                                                                                                  TypeLineDescription
                                                                                                                                                                  TODO10Remove the unused constants after implement the whole PHP library.
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  Search results

                                                                                                                                                                  - -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    -
                                                                                                                                                                    - - -
                                                                                                                                                                    - - - - - - - - diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..35d4067 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,11 @@ +# docker-compose.yml for php-doofinder (tests only; single service) +version: '3.8' +services: + tests: + build: . # Uses Dockerfile + image: php-doofinder-tests + volumes: + - .:/app + working_dir: /app + command: composer tests # Default: run tests + # To install first: docker-compose run --rm tests composer install --dev diff --git a/src/Search/README_SEARCH.md b/src/Search/README_SEARCH.md index ac6a1dc..886a33d 100644 --- a/src/Search/README_SEARCH.md +++ b/src/Search/README_SEARCH.md @@ -247,14 +247,6 @@ $body = $response->getBody(); // **** Logs add to cart **** $response = $searchClient->logAddToCart($hashId, $sessionId, $amount, $itemId, $indexId, $price, $title); $body = $response->getBody(); - -// **** Logs remove from cart **** -$response = $searchClient->logRemoveFromCart($hashId, $sessionId, $amount, $itemId, $indexId); -$body = $response->getBody(); - -// **** Logs clear cart **** -$response = $searchClient->clearCart($hashId, $sessionId); -$body = $response->getBody(); ``` ### Documentation for Stats methods @@ -267,8 +259,6 @@ $body = $response->getBody(); | **logCheckout** | Logs a checkout event in stats logs | [Status response](#status-response) | | **logClick** | Save click event on doofinder statistics | [Status response](#status-response) | | **logAddToCart** | Adds an item to the cart, or creates a new cart for the given session if it does not exists | [Status response](#status-response) | -| **logRemoveFromCart** | Removes an amount from the given item in the cart | [Status response](#status-response) | -| **clearCart** | his call will erase completely a cart identified by the pair of hashid and session ID | [Status response](#status-response) | #### Status response diff --git a/src/Search/Resources/Stats.php b/src/Search/Resources/Stats.php index fb2f399..15a5bd5 100644 --- a/src/Search/Resources/Stats.php +++ b/src/Search/Resources/Stats.php @@ -184,45 +184,4 @@ public function logAddToCart($hashId, $sessionId, $amount, $itemId, $indexId, $p ] ); } - - /** - * Log "Remove from cart" event - * - * @param string $hashId - * @param string $sessionId - * @param integer $amount - * @param string $itemId - * @param string $indexId - * @return HttpResponseInterface - * @throws ApiException - */ - public function logRemoveFromCart($hashId, $sessionId, $amount, $itemId, $indexId) - { - return $this->requestWithToken( - $this->getBaseUrl($hashId) . '/cart/' . $sessionId, - HttpClientInterface::METHOD_PATCH, - null, - [ - 'amount' => $amount, - 'id' => $itemId, - 'index' => $indexId - ] - ); - } - - /** - * Erase completely a cart - * - * @param string $hashId - * @param string $sessionId - * @return HttpResponseInterface - * @throws ApiException - */ - public function clearCart($hashId, $sessionId) - { - return $this->requestWithToken( - $this->getBaseUrl($hashId) . '/cart/' . $sessionId, - HttpClientInterface::METHOD_DELETE - ); - } } \ No newline at end of file diff --git a/src/Search/SearchClient.php b/src/Search/SearchClient.php index 6356a0b..b24a8c7 100644 --- a/src/Search/SearchClient.php +++ b/src/Search/SearchClient.php @@ -194,42 +194,4 @@ public function logAddToCart($hashId, $sessionId, $amount, $itemId, $indexId, $p throw ErrorHandler::create($e->getCode(), $e->getMessage(), $e); } } - - /** - * Removes an amount from the given item in the cart, removing it completely if the amount present in the cart minus - * the amount specified in this call is zero or negative, else, it will be updated with the new calculated amount. - * - * @param string $hashId - * @param string $sessionId - * @param integer $amount - * @param string $itemId - * @param string $indexId - * @return HttpResponseInterface - * @throws ApiException - */ - public function logRemoveFromCart($hashId, $sessionId, $amount, $itemId, $indexId) - { - try { - return $this->statsResource->logRemoveFromCart($hashId, $sessionId, $amount, $itemId, $indexId); - } catch (ApiException $e) { - throw ErrorHandler::create($e->getCode(), $e->getMessage(), $e); - } - } - - /** - * This call will erase completely a cart identified by the pair of hashid and session ID, if it does exist - * - * @param string $hashId - * @param string $sessionId - * @return HttpResponseInterface - * @throws ApiException - */ - public function clearCart($hashId, $sessionId) - { - try { - return $this->statsResource->clearCart($hashId, $sessionId); - } catch (ApiException $e) { - throw ErrorHandler::create($e->getCode(), $e->getMessage(), $e); - } - } } \ No newline at end of file diff --git a/tests/Unit/Management/BaseManagementClientTest.php b/tests/Unit/Management/BaseManagementClientTest.php index b8b1ba2..899f5c3 100644 --- a/tests/Unit/Management/BaseManagementClientTest.php +++ b/tests/Unit/Management/BaseManagementClientTest.php @@ -8,23 +8,23 @@ use Doofinder\Management\Resources\SearchEngine; use Doofinder\Shared\Exceptions\ApiException; use Doofinder\Shared\HttpStatusCode; -use PHPUnit_Framework_MockObject_MockObject; +use PHPUnit\Framework\MockObject\MockObject; -abstract class BaseManagementClientTest extends \PHPUnit_Framework_TestCase +abstract class BaseManagementClientTest extends \PHPUnit\Framework\TestCase { /** - * @var PHPUnit_Framework_MockObject_MockObject + * @var MockObject */ protected $searchEngineResource; /** - * @var PHPUnit_Framework_MockObject_MockObject + * @var MockObject */ protected $itemResource; /** - * @var PHPUnit_Framework_MockObject_MockObject + * @var MockObject */ protected $indexResource; @@ -43,7 +43,7 @@ abstract class BaseManagementClientTest extends \PHPUnit_Framework_TestCase */ protected $notFoundException; - protected function setUp() + protected function setUp(): void { $this->unauthorizedException = new ApiException('', HttpStatusCode::UNAUTHORIZED); $this->badParametersException = new ApiException( diff --git a/tests/Unit/Management/ManagementClientIndexTest.php b/tests/Unit/Management/ManagementClientIndexTest.php index 841a62b..49ce8ec 100644 --- a/tests/Unit/Management/ManagementClientIndexTest.php +++ b/tests/Unit/Management/ManagementClientIndexTest.php @@ -13,7 +13,7 @@ class ManagementClientIndexTest extends BaseManagementClientTest */ private $index; - public function setUp() + public function setUp(): void { parent::setUp(); diff --git a/tests/Unit/Management/ManagementClientItemTest.php b/tests/Unit/Management/ManagementClientItemTest.php index f9adb10..721e89e 100644 --- a/tests/Unit/Management/ManagementClientItemTest.php +++ b/tests/Unit/Management/ManagementClientItemTest.php @@ -19,7 +19,7 @@ class ManagementClientItemTest extends BaseManagementClientTest */ private $itemParams; - public function setUp() + public function setUp(): void { parent::setUp(); diff --git a/tests/Unit/Management/ManagementClientSearchEngineTest.php b/tests/Unit/Management/ManagementClientSearchEngineTest.php index 06bed5a..3c5b75b 100644 --- a/tests/Unit/Management/ManagementClientSearchEngineTest.php +++ b/tests/Unit/Management/ManagementClientSearchEngineTest.php @@ -14,7 +14,7 @@ class ManagementClientSearchEngineTest extends BaseManagementClientTest */ private $searchEngine; - public function setUp() + public function setUp(): void { parent::setUp(); diff --git a/tests/Unit/Management/Resources/BaseResourceTest.php b/tests/Unit/Management/Resources/BaseResourceTest.php index ece5dc2..ca879cb 100644 --- a/tests/Unit/Management/Resources/BaseResourceTest.php +++ b/tests/Unit/Management/Resources/BaseResourceTest.php @@ -4,23 +4,24 @@ use Doofinder\Configuration; use Doofinder\Shared\HttpClient; +use PHPUnit\Framework\MockObject\MockObject; -abstract class BaseResourceTest extends \PHPUnit_Framework_TestCase +abstract class BaseResourceTest extends \PHPUnit\Framework\TestCase { const BASE_URL = 'https://fake_url.com/random'; const TOKEN = 'fake_token'; /** - * @var \PHPUnit_Framework_MockObject_MockObject + * @var MockObject */ protected $httpClient; /** - * @var \PHPUnit_Framework_MockObject_MockObject + * @var MockObject */ protected $config; - public function setUp() + public function setUp(): void { $this->httpClient = $this->createMock(HttpClient::class); $this->config = $this->createMock(Configuration::class); diff --git a/tests/Unit/Search/Resources/StatTest.php b/tests/Unit/Search/Resources/StatTest.php index 199bd4e..76f36fb 100644 --- a/tests/Unit/Search/Resources/StatTest.php +++ b/tests/Unit/Search/Resources/StatTest.php @@ -723,218 +723,4 @@ public function testLogAddToCartHashIdNotFound() $this->assertTrue($thrownException); } - public function testLogRemoveFromCartSuccess() - { - $body = ['result' => 'registered']; - - $response = HttpResponse::create(HttpStatusCode::OK, json_encode($body)); - - $sessionId = 'rand_fake_session_id'; - $id = 'fake_id'; - $hashId = '3a0811e861d36f76cedca60723e03291'; - $amount = 2; - $indexName = 'fake_index'; - - $this->httpClient - ->expects($this->once()) - ->method('request') - ->with( - $this->getUrl($hashId) . '/cart/' . $sessionId, - HttpClientInterface::METHOD_PATCH, - [ - 'amount' => $amount, - 'id' => $id, - 'index' => $indexName, - ], - ['Authorization: Token ' . self::TOKEN] - ) - ->willReturn($response); - - $this->setConfig(); - - $response = $this->createSut()->logRemoveFromCart($hashId, $sessionId, $amount, $id, $indexName); - - $this->assertSame(HttpStatusCode::OK, $response->getStatusCode()); - $this->assertEquals($response->getBody(), $body); - } - - public function testLogRemoveFromCartInvalidParams() - { - $response = HttpResponse::create(HttpStatusCode::BAD_REQUEST, '{"error" : {"code": "bad_params"}}'); - $hashId = '3a0811e861d36f76cedca60723e03291'; - $sessionId = 'rand_fake_session_id'; - $id = 'fake_id'; - $amount = 2; - $indexName = 'fake_index'; - - $this->httpClient - ->expects($this->once()) - ->method('request') - ->with( - $this->getUrl($hashId) . '/cart/' . $sessionId, - HttpClientInterface::METHOD_PATCH, - [ - 'amount' => $amount, - 'id' => $id, - 'index' => $indexName, - ], - ['Authorization: Token ' . self::TOKEN] - ) - ->willReturn($response); - - $this->setConfig(); - - $thrownException = false; - - try { - $this->createSut()->logRemoveFromCart($hashId, $sessionId, $amount, $id, $indexName); - } catch (ApiException $e) { - $thrownException = true; - $this->assertSame(HttpStatusCode::BAD_REQUEST, $e->getCode()); - /** @var HttpResponseInterface $response */ - $response = $e->getBody(); - $this->assertSame('bad_params', $response->getBody()['error']['code']); - } - - $this->assertTrue($thrownException); - } - - public function testLogRemoveFromCartHashIdNotFound() - { - $hashId = '3a0811e861d36f76cedca60723e03291'; - - $response = HttpResponse::create(HttpStatusCode::NOT_FOUND, '{"error" : {"code": "not_found"}}'); - $sessionId = 'rand_fake_session_id'; - $id = 'fake_id'; - $amount = 2; - $indexName = 'fake_index'; - - $this->httpClient - ->expects($this->once()) - ->method('request') - ->with( - $this->getUrl($hashId) . '/cart/' . $sessionId, - HttpClientInterface::METHOD_PATCH, - [ - 'amount' => $amount, - 'id' => $id, - 'index' => $indexName, - ], - ['Authorization: Token ' . self::TOKEN] - ) - ->willReturn($response); - - $this->setConfig(); - - $thrownException = false; - - try { - $this->createSut()->logRemoveFromCart($hashId, $sessionId, $amount, $id, $indexName); - } catch (ApiException $e) { - $thrownException = true; - $this->assertSame(HttpStatusCode::NOT_FOUND, $e->getCode()); - /** @var HttpResponseInterface $response */ - $response = $e->getBody(); - $this->assertSame('not_found', $response->getBody()['error']['code']); - } - - $this->assertTrue($thrownException); - } - - public function testClearCartSuccess() - { - $body = ['result' => 'registered']; - - $response = HttpResponse::create(HttpStatusCode::OK, json_encode($body)); - - $sessionId = 'rand_fake_session_id'; - $hashId = '3a0811e861d36f76cedca60723e03291'; - - $this->httpClient - ->expects($this->once()) - ->method('request') - ->with( - $this->getUrl($hashId) . '/cart/' . $sessionId, - HttpClientInterface::METHOD_DELETE, - [], - ['Authorization: Token ' . self::TOKEN] - ) - ->willReturn($response); - - $this->setConfig(); - - $response = $this->createSut()->clearCart($hashId, $sessionId); - - $this->assertSame(HttpStatusCode::OK, $response->getStatusCode()); - $this->assertEquals($response->getBody(), $body); - } - - public function testClearCartInvalidParams() - { - $response = HttpResponse::create(HttpStatusCode::BAD_REQUEST, '{"error" : {"code": "bad_params"}}'); - $hashId = '3a0811e861d36f76cedca60723e03291'; - $sessionId = 'rand_fake_session_id'; - - $this->httpClient - ->expects($this->once()) - ->method('request') - ->with( - $this->getUrl($hashId) . '/cart/' . $sessionId, - HttpClientInterface::METHOD_DELETE, - [], - ['Authorization: Token ' . self::TOKEN] - ) - ->willReturn($response); - - $this->setConfig(); - - $thrownException = false; - - try { - $this->createSut()->clearCart($hashId, $sessionId); - } catch (ApiException $e) { - $thrownException = true; - $this->assertSame(HttpStatusCode::BAD_REQUEST, $e->getCode()); - /** @var HttpResponseInterface $response */ - $response = $e->getBody(); - $this->assertSame('bad_params', $response->getBody()['error']['code']); - } - - $this->assertTrue($thrownException); - } - - public function testClearCartHashIdNotFound() - { - $hashId = '3a0811e861d36f76cedca60723e03291'; - - $response = HttpResponse::create(HttpStatusCode::NOT_FOUND, '{"error" : {"code": "not_found"}}'); - $sessionId = 'rand_fake_session_id'; - - $this->httpClient - ->expects($this->once()) - ->method('request') - ->with( - $this->getUrl($hashId) . '/cart/' . $sessionId, - HttpClientInterface::METHOD_DELETE, - [], - ['Authorization: Token ' . self::TOKEN] - ) - ->willReturn($response); - - $this->setConfig(); - - $thrownException = false; - - try { - $this->createSut()->clearCart($hashId, $sessionId); - } catch (ApiException $e) { - $thrownException = true; - $this->assertSame(HttpStatusCode::NOT_FOUND, $e->getCode()); - /** @var HttpResponseInterface $response */ - $response = $e->getBody(); - $this->assertSame('not_found', $response->getBody()['error']['code']); - } - - $this->assertTrue($thrownException); - } } \ No newline at end of file diff --git a/tests/Unit/Search/SearchClientTest.php b/tests/Unit/Search/SearchClientTest.php index 786ca1e..0f82cc0 100644 --- a/tests/Unit/Search/SearchClientTest.php +++ b/tests/Unit/Search/SearchClientTest.php @@ -9,7 +9,7 @@ use Doofinder\Shared\HttpResponse; use Doofinder\Shared\HttpStatusCode; -class SearchClientTest extends \PHPUnit_Framework_TestCase +class SearchClientTest extends \PHPUnit\Framework\TestCase { /** * @var Search @@ -36,7 +36,7 @@ class SearchClientTest extends \PHPUnit_Framework_TestCase */ protected $notFoundException; - protected function setUp() + protected function setUp(): void { parent::setUp(); @@ -746,157 +746,4 @@ public function testLogAddToCartNotFound() $this->assertTrue($thrownException); } - - public function testLogDeleteFromCartSuccess() - { - $hashId = '3a0811e861d36f76cedca60723e03291'; - $sessionId = 'fake_session_id'; - $body = ['status' => 'registered']; - - $httpResponse = HttpResponse::create(HttpStatusCode::OK, json_encode($body)); - $id = 'fake_id'; - $amount = 2; - $indexName = 'fake_index'; - - $this->statsResource - ->expects($this->once()) - ->method('logRemoveFromCart') - ->with($hashId, $sessionId, $amount, $id, $indexName) - ->willReturn($httpResponse); - - $searchClient = $this->createSut(); - $response = $searchClient->logRemoveFromCart($hashId, $sessionId, $amount, $id, $indexName); - - $this->assertSame(HttpStatusCode::OK, $response->getStatusCode()); - $this->assertSame($body, $response->getBody()); - } - - public function testLogDeleteFromCartNoAuthorization() - { - $hashId = '3a0811e861d36f76cedca60723e03291'; - $sessionId = 'fake_session_id'; - $id = 'fake_id'; - $amount = 2; - $indexName = 'fake_index'; - $forbiddenException = new ApiException('', HttpStatusCode::FORBIDDEN); - - $this->statsResource - ->expects($this->once()) - ->method('logRemoveFromCart') - ->with($hashId, $sessionId, $amount, $id, $indexName) - ->willThrowException($forbiddenException); - - $searchClient = $this->createSut(); - $thrownException = false; - - try { - $searchClient->logRemoveFromCart($hashId, $sessionId, $amount, $id, $indexName); - } catch (ApiException $e) { - $thrownException = true; - $this->assertSame(HttpStatusCode::FORBIDDEN, $e->getCode()); - $this->assertSame('The user does not have permissions to perform this operation.', $e->getMessage()); - } - - $this->assertTrue($thrownException); - } - - public function testLogDeleteFromCartNotFound() - { - $hashId = '3a0811e861d36f76cedca60723e03291'; - $sessionId = 'fake_session_id'; - $id = 'fake_id'; - $amount = 2; - $indexName = 'fake_index'; - - $this->statsResource - ->expects($this->once()) - ->method('logRemoveFromCart') - ->with($hashId, $sessionId, $amount, $id, $indexName) - ->willThrowException($this->notFoundException); - - $searchClient = $this->createSut(); - $thrownException = false; - - try { - $searchClient->logRemoveFromCart($hashId, $sessionId, $amount, $id, $indexName); - } catch (ApiException $e) { - $thrownException = true; - $this->assertSame(HttpStatusCode::NOT_FOUND, $e->getCode()); - $this->assertSame('Not Found.', $e->getMessage()); - } - - $this->assertTrue($thrownException); - } - - public function testClearCartSuccess() - { - $hashId = '3a0811e861d36f76cedca60723e03291'; - $sessionId = 'fake_session_id'; - $body = ['status' => 'registered']; - - $httpResponse = HttpResponse::create(HttpStatusCode::OK, json_encode($body)); - - $this->statsResource - ->expects($this->once()) - ->method('clearCart') - ->with($hashId, $sessionId) - ->willReturn($httpResponse); - - $searchClient = $this->createSut(); - $response = $searchClient->clearCart($hashId, $sessionId); - - $this->assertSame(HttpStatusCode::OK, $response->getStatusCode()); - $this->assertSame($body, $response->getBody()); - } - - public function testClearCartNoAuthorization() - { - $hashId = '3a0811e861d36f76cedca60723e03291'; - $sessionId = 'fake_session_id'; - $forbiddenException = new ApiException('', HttpStatusCode::FORBIDDEN); - - $this->statsResource - ->expects($this->once()) - ->method('clearCart') - ->with($hashId, $sessionId) - ->willThrowException($forbiddenException); - - $searchClient = $this->createSut(); - $thrownException = false; - - try { - $searchClient->clearCart($hashId, $sessionId); - } catch (ApiException $e) { - $thrownException = true; - $this->assertSame(HttpStatusCode::FORBIDDEN, $e->getCode()); - $this->assertSame('The user does not have permissions to perform this operation.', $e->getMessage()); - } - - $this->assertTrue($thrownException); - } - - public function testClearCartNotFound() - { - $hashId = '3a0811e861d36f76cedca60723e03291'; - $sessionId = 'fake_session_id'; - - $this->statsResource - ->expects($this->once()) - ->method('clearCart') - ->with($hashId, $sessionId) - ->willThrowException($this->notFoundException); - - $searchClient = $this->createSut(); - $thrownException = false; - - try { - $searchClient->clearCart($hashId, $sessionId); - } catch (ApiException $e) { - $thrownException = true; - $this->assertSame(HttpStatusCode::NOT_FOUND, $e->getCode()); - $this->assertSame('Not Found.', $e->getMessage()); - } - - $this->assertTrue($thrownException); - } } \ No newline at end of file diff --git a/tests/Unit/Shared/Services/JwtTest.php b/tests/Unit/Shared/Services/JwtTest.php index 2339d9e..0970161 100644 --- a/tests/Unit/Shared/Services/JwtTest.php +++ b/tests/Unit/Shared/Services/JwtTest.php @@ -3,8 +3,9 @@ namespace Tests\Unit\Shared\Services; use Doofinder\Shared\Services\Jwt; +use PHPUnit\Framework\TestCase; -class JwtTest extends \PHPUnit_Framework_TestCase +class JwtTest extends TestCase { public function testGenerateToken() { diff --git a/tests/Unit/Shared/Utils/ErrorHandlerTest.php b/tests/Unit/Shared/Utils/ErrorHandlerTest.php index aefeede..12a809f 100644 --- a/tests/Unit/Shared/Utils/ErrorHandlerTest.php +++ b/tests/Unit/Shared/Utils/ErrorHandlerTest.php @@ -5,10 +5,10 @@ use Doofinder\Shared\Exceptions\ApiException; use Doofinder\Shared\HttpStatusCode; use Doofinder\Shared\Utils\ErrorHandler; -use PHPUnit_Framework_TestCase; +use PHPUnit\Framework\TestCase; use Exception; -class ErrorHandlerTest extends PHPUnit_Framework_TestCase +class ErrorHandlerTest extends TestCase { public function errorsProvider() {