Feat: add 4 features

.gitignore

@@ -0,0 +1,8 @@
+*.cache
+.idea/
+.php_cs.cache
+/tests/cache/
+/vendor/
+composer.lock
+tests/QualityTools/vendor
+tests/QualityTools/composer.lock

.php_cs.dist

@@ -0,0 +1,24 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->exclude([__DIR__.DIRECTORY_SEPARATOR.'tests/QualityTools'])
+    ->in(__DIR__.DIRECTORY_SEPARATOR.'tests')
+    ->in(__DIR__.DIRECTORY_SEPARATOR.'src')
+    ->append(['.php_cs.dist']);
+
+$rules = [
+    '@Symfony' => true,
+    '@PhpCsFixer' => true,
+    'multiline_whitespace_before_semicolons' => true,
+    'php_unit_test_class_requires_covers' => false,
+    'phpdoc_no_empty_return' => false,
+    'array_syntax' => ['syntax' => 'short'],
+    'yoda_style' => false,
+];
+
+$rules['increment_style'] = ['style' => 'post'];
+
+return PhpCsFixer\Config::create()
+    ->setUsingCache(true)
+    ->setRules($rules)
+    ->setFinder($finder);

.travis.yml

@@ -0,0 +1,28 @@
+language: php
+
+sudo: true
+
+php:
+  - 5.6
+  - 7.0
+  - 7.1
+  - 7.2
+  - 7.3
+  - nightly
+
+env:
+  - COMPOSER_FLAGS="--prefer-lowest"
+  - COMPOSER_FLAGS=""
+matrix:
+  allow_failures:
+    - php : nightly
+
+before_script:
+  - travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-source
+  - wget https://alg.li/algolia-keys && chmod +x algolia-keys
+
+script:
+  - if [[$(phpenv version-name) >= "7.2" ]]; then composer install:quality-tools; fi
+  - if [[$(phpenv version-name) >= "7.2" ]]; then composer test:quality-tools; fi
+  - eval $(./algolia-keys export)
+  - composer test

CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+

CONTRIBUTING.md

@@ -0,0 +1,25 @@
+CONTRIBUTING
+============
+
+
+Contributions are welcome, and are accepted via pull requests. Please review these guidelines before submitting any pull requests.
+
+
+## Guidelines
+
+* Please follow the [PSR-2 Coding Style Guide](http://www.php-fig.org/psr/psr-2/), enforced by [PHP-CS-Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer).
+* Ensure that the current tests pass, and if you've added something new, add the tests where relevant.
+* Send a coherent commit history, making sure each individual commit in your pull request is meaningful.
+* You may need to [rebase](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) to avoid merge conflicts.
+* If you are changing the behavior, or the public api, you may need to update the docs.
+* Please remember that we follow [SemVer](http://semver.org/).
+
+We have [PHP-CS-Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer) setup to automatically fix any code style issues.
+```bash
+vendor/bin/php-cs-fixer fix
+```
+
+We have a Quality-Tools test suite  setup to automatically find any potential errors.
+```bash
+composer test:quality-tools
+```

LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019-Present Algolia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

MAINTAINERS.md

@@ -0,0 +1,6 @@
+## `/algolia/algoliasearch-client-php-helper` maintainers
+
+| Name            | Email                       |
+|-----------------|-----------------------------|
+| Nuno Maduro     | nuno.maduro@algolia.com     |
+| Tom Klotz       |   tom.klotz@algolia.com     |

composer.json

@@ -0,0 +1,50 @@
+{
+  "name": "algolia/algoliasearch-client-php-helper",
+  "description": "Algolia extension for search API Client",
+  "keywords": ["algolia", "search", "api", "client", "php", "helper"],
+  "type": "library",
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Algolia Team",
+      "email": "contact@algolia.com"
+    }
+  ],
+  "require": {
+    "php": "^5.6 || ^7.0",
+    "algolia/algoliasearch-client-php": "^2.2"
+  },
+  "suggest": {
+    "ext-dom": "Required to use the HTML Splitter."
+  },
+  "require-dev": {
+    "friendsofphp/php-cs-fixer": "^2.15.1",
+    "fzaninotto/faker": "^1.8",
+    "phpunit/phpunit": "^5.7.27"
+  },
+  "autoload": {
+    "psr-4": {
+      "Algolia\\AlgoliaSearch\\Helper\\": "src/"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "Algolia\\AlgoliaSearch\\Helper\\Tests\\": "tests/"
+    }
+  },
+  "scripts": {
+    "install:quality-tools": "composer update -d tests/QualityTools/",
+    "phpstan": "tests/QualityTools/vendor/bin/phpstan analyse --ansi",
+    "phpinsights": "tests/QualityTools/vendor/bin/phpinsights analyse --ansi --min-quality=88.3 --min-complexity=58.7 --min-architecture=95.2 --min-style=91.3",
+    "phpunit": "phpunit --colors=always",
+    "php-cs-fixer": "php-cs-fixer fix -v --dry-run",
+    "test:quality-tools": [
+      "@phpstan",
+      "@phpinsights"
+    ],
+    "test": [
+      "@php-cs-fixer",
+      "@phpunit"
+    ]
+  }
+}

phpstan.neon.dist

@@ -0,0 +1,18 @@
+includes:
+    - tests/QualityTools/vendor/phpstan/phpstan-strict-rules/rules.neon
+    - tests/QualityTools/vendor/localheinz/phpstan-rules/rules.neon
+    - tests/QualityTools/vendor/thecodingmachine/phpstan-strict-rules/phpstan-strict-rules.neon
+    - tests/QualityTools/vendor/roave/no-floaters/rules.neon
+
+parameters:
+    level: max
+    paths:
+        - src
+        - tests/Integration
+    ignoreErrors:
+        - '#return type can be added. More info#'
+        - '#Parameter \#1 \$indexName \(string\) of method Algolia\\AlgoliaSearch\\Helper\\SearchClient::initIndex\(\) should be contravariant with parameter \$indexName \(mixed\) of method Algolia\\AlgoliaSearch\\SearchClient::initIndex\(\)#'
+        - '#In method.*type-hinted.*More info#'
+        - '#In method \"Algolia\\AlgoliaSearch\\Helper\\Splitters\\HtmlSplitter::split\", caught \"Exception\" must be rethrown. Either catch a more specific exception or add a \"throw\" clause in the \"catch\" block to propagate the exception.#'
+        - '#Method.*has parameter \$tags with null as default value.#'
+        - '#Constructor.*has parameter \$tags with default value.#'

phpunit.xml.dist

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit colors="true" bootstrap="tests/bootstrap.php">
+    <ini name="date.timezone" value="UTC"/>
+    <testsuite>
+        <testsuite name="Integration">
+            <directory suffix="Test.php">tests/Integration/</directory>
+        </testsuite>
+    </testsuite>
+</phpunit>

src/Contracts/SettingContract.php

@@ -0,0 +1,29 @@
+<?php
+
+/**
+ * This file is part of AlgoliaSearch Client PHP Helper.
+ *
+ * (c) Algolia Team <contact@algolia.com>
+ *
+ *  For the full copyright and license information, please view the LICENSE
+ *  file that was distributed with this source code.
+ */
+
+namespace Algolia\AlgoliaSearch\Helper\Contracts;
+
+/**
+ * @internal
+ */
+interface SettingContract
+{
+    /**
+     * Checks if the given key/value is a setting.
+     *
+     * @param int|string                            $key
+     * @param null|array<int, string>|object|string $value
+     * @param array<int, string>                    $detectedSettings
+     *
+     * @return array<int, int|string>
+     */
+    public function getDetectedSettings($key, $value, $detectedSettings);
+}

src/Contracts/SplitterContract.php

@@ -0,0 +1,24 @@
+<?php
+
+/**
+ * This file is part of AlgoliaSearch Client PHP Helper.
+ *
+ * (c) Algolia Team <contact@algolia.com>
+ *
+ *  For the full copyright and license information, please view the LICENSE
+ *  file that was distributed with this source code.
+ */
+
+namespace Algolia\AlgoliaSearch\Helper\Contracts;
+
+interface SplitterContract
+{
+    /**
+     * Splits the given value.
+     *
+     * @param string $value
+     *
+     * @return array<int, array>
+     */
+    public function split($value);
+}

src/Helpers/Str.php

@@ -0,0 +1,49 @@
+<?php
+
+/**
+ * This file is part of Laravel.
+ *
+ * https://github.com/laravel/framework/blob/master/src/Illuminate/Support/Str.php
+ *
+ * It was modified by Algolia Team <contact@algolia.com>
+ *
+ *  For the full copyright and license information, please view the LICENSE
+ *  file that was distributed with this source code.
+ */
+
+namespace Algolia\AlgoliaSearch\Helper\Helpers;
+
+/**
+ * @internal
+ */
+final class Str
+{
+    /**
+     * Determine if a given string matches a given pattern.
+     *
+     * @param array<int, string>|string $pattern
+     * @param null|int|string           $value
+     *
+     * @return bool
+     */
+    public static function is($pattern, $value)
+    {
+        $patterns = is_array($pattern) ? $pattern : (array) $pattern;
+
+        if (null === $value || 0 === count($patterns)) {
+            return false;
+        }
+        foreach ($patterns as $patternValue) {
+            if ($patternValue === $value) {
+                return true;
+            }
+            $patternValue = preg_quote($patternValue, '#');
+            $patternValue = str_replace('\*', '.*', $patternValue);
+            if (1 === preg_match('#^'.$patternValue.'\z#u', (string) $value)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+}

src/SearchClient.php

@@ -0,0 +1,27 @@
+<?php
+
+/**
+ * This file is part of AlgoliaSearch Client PHP Helper.
+ *
+ * (c) Algolia Team <contact@algolia.com>
+ *
+ *  For the full copyright and license information, please view the LICENSE
+ *  file that was distributed with this source code.
+ */
+
+namespace Algolia\AlgoliaSearch\Helper;
+
+final class SearchClient extends \Algolia\AlgoliaSearch\SearchClient
+{
+    /**
+     * Creates a new instance of the Search Client.
+     *
+     * @param string $indexName
+     *
+     * @return \Algolia\AlgoliaSearch\Helper\SearchIndex
+     */
+    public function initIndex($indexName)
+    {
+        return new SearchIndex($indexName, $this->api, $this->config);
+    }
+}

src/SearchIndex.php

@@ -0,0 +1,27 @@
+<?php
+
+/**
+ * This file is part of AlgoliaSearch Client PHP Helper.
+ *
+ * (c) Algolia Team <contact@algolia.com>
+ *
+ *  For the full copyright and license information, please view the LICENSE
+ *  file that was distributed with this source code.
+ */
+
+namespace Algolia\AlgoliaSearch\Helper;
+
+final class SearchIndex extends \Algolia\AlgoliaSearch\SearchIndex
+{
+    /**
+     * Count number of records of the index.
+     *
+     * @return int
+     */
+    public function count()
+    {
+        $response = $this->search('');
+
+        return $response['nbHits'];
+    }
+}