current() public method Returns the current dataset. This method is required by the interface Iterator. public mixed current ( )return mixed The current dataset.

getIterator() public method Returns an iterator for traversing the headers in the collection. This method is required by the SPL interface IteratorAggregate. It will be implicitly called when you use foreach to traverse the collection. public ArrayIterator getIterator ( )return ArrayIterator An iterator for traversing the headers in the collection.

$trueValue public property The value representing true status. Defaults to '1'. public mixed $trueValue = '1'

snippetByModel() public method Sets the snippetCallback() to fetchSnippetSourceFromModels(), which allows to fetch the snippet source strings from the Active Record models, using method yii\sphinx\ActiveRecord::getSnippetSource(). For example: class Article extends ActiveRecord { public function getSnippetSource() { return file_get_contents('/path/to/source/files/' . $this->id . '.txt');; } } $articles = Article::find()->snippetByModel()->all(); Warning: this

load() public method Loads data into the panel public void load ( $data )$data mixed

setHtmlBody() public abstract method Sets message HTML content. public abstract $this setHtmlBody ( $html )$html string Message HTML content. return $this Self reference.

getIndexSchema() public method Obtains the schema information for the named index. public yii\sphinx\IndexSchema getIndexSchema ( $name, $refresh = false )$name string Index name. $refresh boolean Whether to reload the table schema even if it is found in the cache. return yii\sphinx\IndexSchema Index schema information. Null if the named index does not exist.

defaultViewOptions() protected method Returns the default $viewOptions value. Particular client may override this method in order to provide specific default view options. protected array defaultViewOptions ( )return array List of default $viewOptions

fileInput() public method Renders a file input. This method will generate the name and value tag attributes automatically for the model attribute unless they are explicitly specified in $options. public $this fileInput ( $options = [] )$options array The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. The values will be HTML-encoded using yii\helpers\Html::encode(). If you set a custom id for the input element, you may need to adju

$absoluteAuthTimeoutParam public property The session variable name used to store the value of absolute expiration timestamp of the authenticated state. This is used when $absoluteAuthTimeout is set. public string $absoluteAuthTimeoutParam = '__absoluteExpire'