sphinx\ActiveRecord insert()

insert() public method

Inserts a row into the associated Sphinx index using the attribute values of this record.

This method performs the following steps in order:

  1. call beforeValidate() when $runValidation is true. If validation fails, it will skip the rest of the steps;
  2. call afterValidate() when $runValidation is true.
  3. call beforeSave(). If the method returns false, it will skip the rest of the steps;
  4. insert the record into index. If this fails, it will skip the rest of the steps;
  5. call afterSave();

In the above step 1, 2, 3 and 5, events EVENT_BEFORE_VALIDATE, EVENT_BEFORE_INSERT, EVENT_AFTER_INSERT and EVENT_AFTER_VALIDATE will be raised by the corresponding methods.

Only the \yii\sphinx\changedAttributes will be inserted.

For example, to insert an article record:

$article = new Article();
$article->id = $id;
$article->genre_id = $genreId;
$article->content = $content;
$article->insert();
public boolean insert ( $runValidation = true, $attributes = null )
$runValidation boolean

Whether to perform validation before saving the record. If the validation fails, the record will not be inserted.

$attributes array

List of attributes that need to be saved. Defaults to null, meaning all attributes that are loaded from index will be saved.

return boolean

Whether the attributes are valid and the record is inserted successfully.

throws Exception

in case insert failed.

doc_Yii
2016-10-30 17:11:38
Comments
Leave a Comment

Please login to continue.