PHP Class yii\sphinx\IndexSchema

Since: 2.0
Author: Paul Klimov ([email protected])
Inheritance: extends yii\base\Object
Show file Open project: yiisoft/yii2-sphinx

Public Properties

Property Type Description
$columns column metadata of this index. Each array element is a ColumnSchema object, indexed by column names.
$isRuntime whether this index is a runtime index.
$name name of this index.
$primaryKey primary key of this index.
$type type of the index.

Public Methods

Method Description
getColumn ( string $name ) : ColumnSchema Gets the named column metadata.
getColumnNames ( ) : array Returns the names of all columns in this table.

Method Details

getColumn() public method

This is a convenient method for retrieving a named column even if it does not exist.
public getColumn ( string $name ) : ColumnSchema
$name string column name
return 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 getColumnNames ( ) : array
return array list of column names

Property Details

$columns public property

column metadata of this index. Each array element is a ColumnSchema object, indexed by column names.
public $columns

$isRuntime public property

whether this index is a runtime index.
public $isRuntime

$name public property

name of this index.
public $name

$primaryKey public property

primary key of this index.
public $primaryKey

$type public property

type of the index.
public $type