sphinx\ActiveRecord update()

Saves the changes to this active record into the associated Sphinx index.

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. save 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_UPDATE, EVENT_AFTER_UPDATE and EVENT_AFTER_VALIDATE will be raised by the corresponding methods.

Only the \yii\sphinx\changedAttributes will be saved into database.

For example, to update an article record:

$article = Article::findOne($id);
$article->genre_id = $genreId;
$article->group_id = $groupId;
$article->update();

Note that it is possible the update does not affect any row in the table. In this case, this method will return 0. For this reason, you should use the following code to check if update() is successful or not:

if ($this->update() !== false) {
    // update successful
} else {
    // update failed
}