Класс yii\sphinx\IndexSchema
| Наследование | yii\sphinx\IndexSchema » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2-sphinx/blob/master/IndexSchema.php |
IndexSchema представляет метаданные индекса Sphinx.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $columnNames | массив | Список имён столбцов | yii\sphinx\IndexSchema |
| $columns | yii\sphinx\ColumnSchema[] | Метаданные столбцов этого индекса. | yii\sphinx\IndexSchema |
| $isRt | boolean | Является ли этот индекс индексом реального времени. | yii\sphinx\IndexSchema |
| $isRuntime | boolean | Является ли этот индекс индексом реального времени. | yii\sphinx\IndexSchema |
| $name | строка | Имя этого индекса. | yii\sphinx\IndexSchema |
| $primaryKey | строка | Первичный ключ этого индекса. | yii\sphinx\IndexSchema |
| $type | строка | Тип индекса. | yii\sphinx\IndexSchema |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает метод, который не является методом класса. | yii\base\Object |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в null. | yii\base\Object |
| canGetProperty() | Возвращает значение, указывающее, можно ли прочитать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное квалифицированное имя этого класса. | yii\base\Object |
| getColumn() | Получает метаданные указанного столбца. | yii\sphinx\IndexSchema |
| getColumnNames() | Возвращает имена всех столбцов в этой таблице. | yii\sphinx\IndexSchema |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует объект. | yii\base\Object |
| isIsRuntime() | yii\sphinx\IndexSchema | |
| setIsRuntime() | yii\sphinx\IndexSchema |
Подробности свойств
$columnNames публичное свойство только для чтения
Список имён столбцов
public array getColumnNames ( )
$columns публичное свойство
Метаданные столбцов этого индекса. Каждый элемент массива — объект yii\sphinx\ColumnSchema, индексированный по именам столбцов.
public yii\sphinx\ColumnSchema[] $columns = []
$isRt публичное свойство
Является ли этот индекс индексом реального времени.
public boolean $isRt = null
$isRuntime публичное свойство только для записи
Является ли этот индекс индексом реального времени.
public void setIsRuntime ( $isRuntime )
$name публичное свойство
Имя этого индекса.
public string $name = null
$primaryKey публичное свойство
Первичный ключ этого индекса.
public string $primaryKey = null
$type публичное свойство
Тип индекса.
public string $type = null
Подробности методов
getColumn() публичный метод
Получает метаданные указанного столбца.
Это удобный метод для получения метаданных столбца, даже если он не существует.
| public yii\sphinx\ColumnSchema getColumn ( $name ) | ||
|---|---|---|
| $name | строка |
Имя столбца |
| return | yii\sphinx\ColumnSchema |
Метаданные указанного столбца. Null, если столбец не существует. |
getColumnNames() публичный метод
Возвращает имена всех столбцов в этой таблице.
| public массив getColumnNames ( ) | ||
|---|---|---|
| return | массив |
Список имён столбцов |
isIsRuntime() публичный метод (доступен с версии 2.0.9)
Устарело Этот метод устарел, используйте $isRt вместо него.| public boolean isIsRuntime ( ) | ||
|---|---|---|
| return | boolean |
Является ли этот индекс индексом реального времени. |
setIsRuntime() публичный метод (доступен с версии 2.0.9)
Устарело Этот метод устарел, используйте $isRt вместо него.| public void setIsRuntime ( $isRuntime ) | ||
|---|---|---|
| $isRuntime | boolean |
Является ли этот индекс индексом реального времени. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-sphinx-indexschema.html
