0.9

pre-release

Author: KarelWintersky

interfaces/SphinxToolkitFoolzInterface.php

@@ -0,0 +1,105 @@
+<?php
+
+namespace Arris\Toolkit;
+
+use Closure;
+use Foolz\SphinxQL\Drivers\ResultSetInterface;
+use Foolz\SphinxQL\Exception\ConnectionException;
+use Foolz\SphinxQL\Exception\DatabaseException;
+use Foolz\SphinxQL\Exception\SphinxQLException;
+use Foolz\SphinxQL\SphinxQL;
+use PDO;
+
+/**
+ * Interface __SphinxToolkitFoolzInterface
+ *
+ *
+ *
+ * @package Arris\Toolkit
+ */
+interface SphinxToolkitFoolzInterface {
+
+    /**
+     * Инициализация статического интерфейса к методам
+     *
+     * @param string $sphinx_connection_host
+     * @param string $sphinx_connection_port
+     * @param array $options
+     */
+    public static function init(string $sphinx_connection_host, string $sphinx_connection_port, $options = []);
+
+    /**
+     * Создает коннекшен для множественных обновлений (в крон-скриптах, к примеру, вызывается после init() )
+     */
+    public static function initConnection();
+
+    /**
+     * Создает инстанс SphinxQL (для однократного обновления)
+     *
+     * @return SphinxQL
+     */
+    public static function createInstance();
+
+    /**
+     * Обновляет (UPDATE) реалтайм-индекс по набору данных
+     * с созданием коннекшена "сейчас"
+     *
+     * @param string $index_name
+     * @param array $updateset
+     * @return ResultSetInterface|null
+     *
+     * @throws DatabaseException
+     * @throws ConnectionException
+     * @throws SphinxQLException
+     */
+    public static function rt_UpdateIndex(string $index_name, array $updateset);
+
+    /**
+     * Замещает (REPLACE) реалтайм-индекс по набору данных
+     * с созданием коннекшена "сейчас"
+     *
+     * @param string $index_name
+     * @param array $updateset
+     * @return ResultSetInterface|null
+     *
+     * @throws DatabaseException
+     * @throws ConnectionException
+     * @throws SphinxQLException
+     */
+    public static function rt_ReplaceIndex(string $index_name, array $updateset);
+
+    /**
+     * Удаляет строку реалтайм-индекса
+     * с созданием коннекшена "сейчас"
+     *
+     * @param string $index_name        -- индекс
+     * @param string $field             -- поле для поиска индекса
+     * @param null $field_value         -- значение для поиска индекса
+     * @return ResultSetInterface|null
+     *
+     * @throws DatabaseException
+     * @throws ConnectionException
+     * @throws SphinxQLException
+     */
+    public static function rt_DeleteIndex(string $index_name, string $field, $field_value = null);
+
+    /**
+     * @param PDO $pdo_connection
+     * @param string $sql_source_table
+     * @param string $sphinx_index
+     * @param Closure $make_updateset_method
+     * @param string $condition
+     * @return int
+     * @throws DatabaseException
+     * @throws ConnectionException
+     * @throws SphinxQLException
+     */
+    public static function rt_RebuildAbstractIndex(PDO $pdo_connection, string $sql_source_table, string $sphinx_index, Closure $make_updateset_method, string $condition = '');
+
+    /**
+     * Получает инстанс (для множественных обновлений)
+     *
+     * @return SphinxQL
+     */
+    public static function getInstance();
+}

interfaces/SphinxToolkitMysqliInterface.php

@@ -0,0 +1,79 @@
+<?php
+
+namespace Arris\Toolkit;
+
+use Closure;
+use Exception;
+use PDO;
+
+/**
+ * Interface __SphinxToolkitMysqliInterface
+ *
+ *
+ *
+ * @package Arris\Toolkit
+ */
+interface SphinxToolkitMysqliInterface {
+
+    /**
+     * SphinxToolkit constructor.
+     *
+     * @param PDO $mysql_connection
+     * @param PDO $sphinx_connection
+     */
+    public function __construct(PDO $mysql_connection, PDO $sphinx_connection);
+
+    /**
+     * Устанавливает опции для перестроителя RT-индекса
+     *
+     * @param array $options - новый набор опций
+     * @return array - результирующий набор опций
+     */
+    public function setRebuildIndexOptions(array $options = []):array;
+
+    /**
+     * Перестраивает RT-индекс
+     *
+     * @param string $mysql_table               -- SQL-таблица исходник
+     * @param string $sphinx_index              -- имя индекса (таблицы)
+     * @param Closure $make_updateset_method    -- замыкание, анонимная функция, преобразующая исходный набор данных в то, что вставляется в индекс
+     * @param string $condition                 -- условие выборки из исходной таблицы (без WHERE !!!)
+     *
+     * @param bool $use_mva                     -- используются ли MultiValued-атрибуты в наборе данных?
+     * @param array $mva_indexes_list           -- список MVA-индексов, значения которых не нужно биндить через плейсхолдеры
+     *
+     * @return int                              -- количество обновленных записей в индексе
+     * @throws Exception
+     */
+    public function rebuildAbstractIndex(string $mysql_table, string $sphinx_index, Closure $make_updateset_method, string $condition = '', bool $use_mva = false, array $mva_indexes_list = []):int;
+
+    /**
+     * DEPRECATED
+     *
+     * @param string $mysql_table               -- SQL-таблица исходник
+     * @param string $sphinx_index              -- имя индекса (таблицы)
+     * @param Closure $make_updateset_method    -- замыкание, анонимная функция, преобразующая исходный набор данных в то, что вставляется в индекс
+     * @param string $condition                 -- условие выборки из исходной таблицы (без WHERE !!!)
+     * @param array $mva_indexes_list           -- список MVA-индексов, значения которых не нужно биндить через плейсхолдеры
+     *
+     * @return int
+     * @throws Exception
+     */
+    public function rebuildAbstractIndexMVA(string $mysql_table, string $sphinx_index, Closure $make_updateset_method, string $condition = '', array $mva_indexes_list = []):int;
+
+    /**
+     * Эмулирует BuildExcerpts из SphinxAPI
+     *
+     * @param $source
+     * @param $needle
+     * @param $options
+     * 'before_match' => '<strong>',    // Строка, вставляемая перед ключевым словом. По умолчанию "<strong>".
+     * 'after_match' => '</strong>',    // Строка, вставляемая после ключевого слова. По умолчанию "</strong>".
+     * 'chunk_separator' => '...',      // Строка, вставляемая между частями фрагмента. по умолчанию "...".
+     *
+     * опции 'limit', 'around', 'exact_phrase' и 'single_passage' в эмуляции не реализованы
+     *
+     * @return mixed
+     */
+    public static function EmulateBuildExcerpts($source, $needle, $options);
+}