Class yii\sphinx\IndexSchema

All Classes | Properties | Methods

Inheritance	yii\sphinx\IndexSchema » yii\base\BaseObject
Implements	yii\base\Configurable
Available since version	2.0
Source Code	https://github.com/yiisoft/yii2-sphinx/blob/master/IndexSchema.php

IndexSchema represents the metadata of a Sphinx index.

Public Properties

Property	Type	Description	Defined By
$columns	yii\sphinx\ColumnSchema[]	Column metadata of this index.	yii\sphinx\IndexSchema
$isRt	boolean	Whether this index is a real-time index.	yii\sphinx\IndexSchema
$name	string	Name of this index.	yii\sphinx\IndexSchema
$primaryKey	string	Primary key of this index.	yii\sphinx\IndexSchema
$type	string	Type of the index.	yii\sphinx\IndexSchema

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\BaseObject
__construct()	Constructor.	yii\base\BaseObject
__get()	Returns the value of an object property.	yii\base\BaseObject
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\BaseObject
__set()	Sets value of an object property.	yii\base\BaseObject
__unset()	Sets an object property to null.	yii\base\BaseObject
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\BaseObject
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\BaseObject
className()	Returns the fully qualified name of this class.	yii\base\BaseObject
getColumn()	Gets the named column metadata.	yii\sphinx\IndexSchema
getColumnNames()	Returns the names of all columns in this table.	yii\sphinx\IndexSchema
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\BaseObject
hasProperty()	Returns a value indicating whether a property is defined.	yii\base\BaseObject
init()	Initializes the object.	yii\base\BaseObject
isIsRuntime()		yii\sphinx\IndexSchema
setIsRuntime()		yii\sphinx\IndexSchema

$columns public property

Column metadata of this index. Each array element is a yii\sphinx\ColumnSchema object, indexed by column names.

$isRt public property

Whether this index is a real-time index.

public boolean $isRt = null

$name public property

Name of this index.

public string $name = null

$primaryKey public property

Primary key of this index.

$type public property

Type of the index.

public string $type = null

getColumn() public method

Gets the named column metadata.

This is a convenient method for retrieving a named column even if it does not exist.

public yii\sphinx\ColumnSchema getColumn ( $name )
$name	string	Column name
return	yii\sphinx\ColumnSchema	Metadata of the named column. Null if the named column does not exist.

getColumnNames() public method

Returns the names of all columns in this table.

public array getColumnNames ( )
return	array	List of column names

isIsRuntime() public method (available since version 2.0.9)

Deprecated This method is deprecated, use $isRt instead.

public boolean isIsRuntime ( )
return	boolean	Whether this index is a real-time index.

setIsRuntime() public method (available since version 2.0.9)

Deprecated This method is deprecated, use $isRt instead.

public void setIsRuntime ( $isRuntime )
$isRuntime	boolean	Whether this index is a real-time index.