|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* @link http://www.yiiframework.com/
|
|
|
|
* @copyright Copyright © 2008-2011 Yii Software LLC
|
|
|
|
* @license http://www.yiiframework.com/license/
|
|
|
|
*/
|
|
|
|
|
|
|
|
namespace yii\sphinx;
|
|
|
|
|
|
|
|
use yii\base\Object;
|
|
|
|
use yii\base\InvalidParamException;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* IndexSchema represents the metadata of a Sphinx index.
|
|
|
|
*
|
|
|
|
* @property array $columnNames List of column names. This property is read-only.
|
|
|
|
*
|
|
|
|
* @author Paul Klimov <klimov.paul@gmail.com>
|
|
|
|
* @since 2.0
|
|
|
|
*/
|
|
|
|
class IndexSchema extends Object
|
|
|
|
{
|
|
|
|
/**
|
|
|
|
* @var string name of this index.
|
|
|
|
*/
|
|
|
|
public $name;
|
|
|
|
/**
|
|
|
|
* @var string primary key of this index.
|
|
|
|
*/
|
|
|
|
public $primaryKey;
|
|
|
|
/**
|
|
|
|
* @var ColumnSchema[] column metadata of this index. Each array element is a [[ColumnSchema]] object, indexed by column names.
|
|
|
|
*/
|
|
|
|
public $columns = [];
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets the named column metadata.
|
|
|
|
* This is a convenient method for retrieving a named column even if it does not exist.
|
|
|
|
* @param string $name column name
|
|
|
|
* @return ColumnSchema metadata of the named column. Null if the named column does not exist.
|
|
|
|
*/
|
|
|
|
public function getColumn($name)
|
|
|
|
{
|
|
|
|
return isset($this->columns[$name]) ? $this->columns[$name] : null;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the names of all columns in this table.
|
|
|
|
* @return array list of column names
|
|
|
|
*/
|
|
|
|
public function getColumnNames()
|
|
|
|
{
|
|
|
|
return array_keys($this->columns);
|
|
|
|
}
|
|
|
|
}
|