Class yii\sphinx\gii\model\Generator

Inheritanceyii\sphinx\gii\model\Generator » yii\gii\Generator » yii\base\Model » yii\base\Component » yii\base\BaseObject
ImplementsArrayAccess, IteratorAggregate, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
Uses Traitsyii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Available since version2.0
Source Code https://github.com/yiisoft/yii2-sphinx/blob/master/gii/model/Generator.php

This generator will generate one or multiple ActiveRecord classes for the specified Sphinx index.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$baseClass yii\sphinx\gii\model\Generator
$db yii\sphinx\gii\model\Generator
$enableI18N boolean Whether the strings will be generated using Yii::t() or normal strings. yii\gii\Generator
$indexName yii\sphinx\gii\model\Generator
$messageCategory string The message category used by Yii::t() when $enableI18N is true. yii\gii\Generator
$modelClass yii\sphinx\gii\model\Generator
$ns yii\sphinx\gii\model\Generator
$template string The name of the code template that the user has selected. yii\gii\Generator
$templates array A list of available code templates. yii\gii\Generator
$useIndexPrefix yii\sphinx\gii\model\Generator

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\Component
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() Constructor. yii\base\BaseObject
__get() Returns the value of a component property. yii\base\Component
__isset() Checks if a property is set, i.e. defined and not null. yii\base\Component
__set() Sets the value of a component property. yii\base\Component
__unset() Sets a component property to be null. yii\base\Component
activeAttributes() Returns the attribute names that are subject to validation in the current scenario. yii\base\Model
addError() Adds a new error to the specified attribute. yii\base\Model
addErrors() Adds a list of errors. yii\base\Model
afterValidate() This method is invoked after validation ends. yii\base\Model
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
attributeHints() Returns the attribute hints. yii\base\Model
attributeLabels() {@inheritdoc} yii\sphinx\gii\model\Generator
attributes() Returns the list of attribute names. yii\base\Model
autoCompleteData() {@inheritdoc} yii\sphinx\gii\model\Generator
beforeValidate() This method is invoked before validation starts. yii\base\Model
behaviors() Returns a list of behaviors that this component should behave as. yii\base\Component
canGetProperty() Returns a value indicating whether a property can be read. yii\base\Component
canSetProperty() Returns a value indicating whether a property can be set. yii\base\Component
className() Returns the fully qualified name of this class. yii\base\BaseObject
clearErrors() Removes errors for all attributes or a single attribute. yii\base\Model
createValidators() Creates validator objects based on the validation rules specified in rules(). yii\base\Model
defaultTemplate() Returns the root path to the default code template files. yii\gii\Generator
detachBehavior() Detaches a behavior from the component. yii\base\Component
detachBehaviors() Detaches all behaviors from the component. yii\base\Component
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component. yii\base\Component
extraFields() Returns the list of fields that can be expanded further and returned by toArray(). yii\base\ArrayableTrait
fields() Returns the list of fields that should be returned by default by toArray() when no specific fields are specified. yii\base\ArrayableTrait
formName() Returns the form name that this model class should use. yii\base\Model
formView() Returns the view file for the input form of the generator. yii\gii\Generator
generate() {@inheritdoc} yii\sphinx\gii\model\Generator
generateAttributeLabel() Generates a user friendly attribute label based on the give attribute name. yii\base\Model
generateIndexName() Generates the table name by considering table prefix. yii\sphinx\gii\model\Generator
generateLabels() Generates the attribute labels for the specified table. yii\sphinx\gii\model\Generator
generateRules() Generates validation rules for the specified index. yii\sphinx\gii\model\Generator
generateString() Generates a string depending on enableI18N property yii\gii\Generator
getActiveValidators() Returns the validators applicable to the current \yii\base\scenario. yii\base\Model
getAttributeHint() Returns the text hint for the specified attribute. yii\base\Model
getAttributeLabel() Returns the text label for the specified attribute. yii\base\Model
getAttributes() Returns attribute values. yii\base\Model
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
getDescription() {@inheritdoc} yii\sphinx\gii\model\Generator
getErrorSummary() Returns the errors for all attributes as a one-dimensional array. yii\base\Model
getErrors() Returns the errors for all attributes or a single attribute. yii\base\Model
getFirstError() Returns the first error of the specified attribute. yii\base\Model
getFirstErrors() Returns the first error of every attribute in the model. yii\base\Model
getIterator() Returns an iterator for traversing the attributes in the model. yii\base\Model
getName() {@inheritdoc} yii\sphinx\gii\model\Generator
getScenario() Returns the scenario that this model is used in. yii\base\Model
getStickyDataFile() yii\gii\Generator
getTemplatePath() yii\gii\Generator
getValidators() Returns all the validators declared in rules(). yii\base\Model
hasErrors() Returns a value indicating whether there is any validation error. yii\base\Model
hasEventHandlers() Returns a value indicating whether there is any handler attached to the named event. yii\base\Component
hasMethod() Returns a value indicating whether a method is defined. yii\base\Component
hasProperty() Returns a value indicating whether a property is defined for this component. yii\base\Component
hints() {@inheritdoc} yii\sphinx\gii\model\Generator
init() {@inheritdoc} yii\gii\Generator
instance() Returns static class instance, which can be used to obtain meta information. yii\base\StaticInstanceTrait
isAttributeActive() Returns a value indicating whether the attribute is active in the current scenario. yii\base\Model
isAttributeRequired() Returns a value indicating whether the attribute is required. yii\base\Model
isAttributeSafe() Returns a value indicating whether the attribute is safe for massive assignments. yii\base\Model
isReservedKeyword() yii\gii\Generator
load() Populates the model with input data. yii\base\Model
loadMultiple() Populates a set of models with the data from end user. yii\base\Model
loadStickyAttributes() Loads sticky attributes from an internal file and populates them into the generator. yii\gii\Generator
off() Detaches an existing event handler from this component. yii\base\Component
offsetExists() Returns whether there is an element at the specified offset. yii\base\Model
offsetGet() Returns the element at the specified offset. yii\base\Model
offsetSet() Sets the element at the specified offset. yii\base\Model
offsetUnset() Sets the element value at the specified offset to null. yii\base\Model
on() Attaches an event handler to an event. yii\base\Component
onUnsafeAttribute() This method is invoked when an unsafe attribute is being massively assigned. yii\base\Model
render() Generates code using the specified code template and parameters. yii\gii\Generator
requiredTemplates() {@inheritdoc} yii\sphinx\gii\model\Generator
rules() {@inheritdoc} yii\sphinx\gii\model\Generator
safeAttributes() Returns the attribute names that are safe to be massively assigned in the current scenario. yii\base\Model
save() Saves the generated code into files. yii\gii\Generator
saveStickyAttributes() Saves sticky attributes into an internal file. yii\gii\Generator
scenarios() Returns a list of scenarios and the corresponding active attributes. yii\base\Model
setAttributes() Sets the attribute values in a massive way. yii\base\Model
setScenario() Sets the scenario for the model. yii\base\Model
stickyAttributes() {@inheritdoc} yii\sphinx\gii\model\Generator
successMessage() Returns the message to be displayed when the newly generated code is saved successfully. yii\gii\Generator
toArray() Converts the model into an array. yii\base\ArrayableTrait
trigger() Triggers an event. yii\base\Component
validate() Performs the data validation. yii\base\Model
validateClass() An inline validator that checks if the attribute value refers to an existing class name. yii\gii\Generator
validateDb() Validates the $db attribute. yii\sphinx\gii\model\Generator
validateIndexName() Validates the $indexName attribute. yii\sphinx\gii\model\Generator
validateMessageCategory() Checks if message category is not empty when I18N is enabled. yii\gii\Generator
validateModelClass() Validates the $modelClass attribute. yii\sphinx\gii\model\Generator
validateMultiple() Validates multiple models. yii\base\Model
validateNamespace() Validates the $ns attribute. yii\sphinx\gii\model\Generator
validateNewClass() An inline validator that checks if the attribute value refers to a valid namespaced class name. yii\gii\Generator
validateTemplate() Validates the template selection. yii\gii\Generator

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
extractFieldsFor() Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id". yii\base\ArrayableTrait
extractRootFields() Extracts the root field names from nested fields. yii\base\ArrayableTrait
generateClassName() Generates a class name from the specified table name. yii\sphinx\gii\model\Generator
getDbConnection() yii\sphinx\gii\model\Generator
getIndexNames() yii\sphinx\gii\model\Generator
resolveFields() Determines which fields can be returned by toArray(). yii\base\ArrayableTrait

Events

Hide inherited events

EventTypeDescriptionDefined By
EVENT_AFTER_VALIDATE yii\base\Event An event raised at the end of validate() yii\base\Model
EVENT_BEFORE_VALIDATE yii\base\ModelEvent An event raised at the beginning of validate(). yii\base\Model

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
SCENARIO_DEFAULT 'default' The name of the default scenario. yii\base\Model

Property Details

$baseClass public property
public $baseClass 'yii\sphinx\ActiveRecord'
$db public property
public $db 'sphinx'
$indexName public property
public $indexName null
$modelClass public property
public $modelClass null
$ns public property
public $ns 'app\models'
$useIndexPrefix public property
public $useIndexPrefix false

Method Details

attributeLabels() public method

{@inheritdoc}

public void attributeLabels ( )
autoCompleteData() public method

{@inheritdoc}

public void autoCompleteData ( )
generate() public method

{@inheritdoc}

public void generate ( )
generateClassName() protected method

Generates a class name from the specified table name.

protected string generateClassName ( $indexName )
$indexName string

The table name (which may contain schema prefix)

return string

The generated class name

generateIndexName() public method

Generates the table name by considering table prefix.

If $useIndexPrefix is false, the table name will be returned without change.

public string generateIndexName ( $indexName )
$indexName string

The table name (which may contain schema prefix)

return string

The generated table name

generateLabels() public method

Generates the attribute labels for the specified table.

public array generateLabels ( $table )
$table yii\db\TableSchema

The table schema

return array

The generated attribute labels (name => label)

generateRules() public method

Generates validation rules for the specified index.

public array generateRules ( $index )
$index yii\sphinx\IndexSchema

The index schema

return array

The generated validation rules

getDbConnection() protected method

protected yii\sphinx\Connection getDbConnection ( )
return yii\sphinx\Connection

The Sphinx connection as specified by $db.

getDescription() public method

{@inheritdoc}

public void getDescription ( )
getIndexNames() protected method

protected array getIndexNames ( )
return array

The index names that match the pattern specified by $indexName.

getName() public method

{@inheritdoc}

public void getName ( )
hints() public method

{@inheritdoc}

public void hints ( )
requiredTemplates() public method

{@inheritdoc}

public void requiredTemplates ( )
rules() public method

{@inheritdoc}

public void rules ( )
stickyAttributes() public method

{@inheritdoc}

public void stickyAttributes ( )
validateDb() public method

Validates the $db attribute.

public void validateDb ( )
validateIndexName() public method

Validates the $indexName attribute.

public void validateIndexName ( )
validateModelClass() public method

Validates the $modelClass attribute.

public void validateModelClass ( )
validateNamespace() public method

Validates the $ns attribute.

public void validateNamespace ( )