TbEditableSaver.php

Go to the documentation of this file.

<?php
class TbEditableSaver extends CComponent
{
        public $scenario = 'editable';

        public $modelClass;
        public $primaryKey;
        public $attribute;
        public $model;

        public $value;

        public $errorHttpCode = 400;

        protected $changedAttributes = array();

        public function __construct($modelClass)
        {
                if (empty($modelClass)) {
                        throw new CException(Yii::t(
                                'TbEditableSaver.editable',
                                'You should provide modelClass in constructor of EditableSaver.'
                        ));
                }

                $this->modelClass = $modelClass;

                //for non-namespaced models do ucfirst (for backwards compability)
                //see https://github.com/vitalets/x-editable-yii/issues/9
                if (strpos($this->modelClass, '\\') === false) {
                        $this->modelClass = ucfirst($this->modelClass);
                }
        }

        public function update()
        {
                //get params from request
                $this->primaryKey = yii::app()->request->getParam('pk');
                $this->attribute = yii::app()->request->getParam('name');
                $this->value = yii::app()->request->getParam('value');

                //checking params
                if (empty($this->attribute)) {
                        throw new CException(Yii::t('TbEditableSaver.editable', 'Property "attribute" should be defined.'));
                }
                if (empty($this->primaryKey)) {
                        throw new CException(Yii::t('TbEditableSaver.editable', 'Property "primaryKey" should be defined.'));
                }

                //loading model
                $this->model = CActiveRecord::model($this->modelClass)->findByPk($this->primaryKey);
                if (!$this->model) {
                        throw new CException(Yii::t(
                                'TbEditableSaver.editable',
                                'Model {class} not found by primary key "{pk}"',
                                array(
                                        '{class}' => get_class($this->model),
                                        '{pk}' => is_array($this->primaryKey) ? CJSON::encode($this->primaryKey) : $this->primaryKey
                                )
                        ));
                }

                //set scenario
                $this->model->setScenario($this->scenario);

                //commented to be able to work with virtual attributes
                //see https://github.com/vitalets/yii-bootstrap-editable/issues/15
                /*
                //is attribute exists
                if (!$this->model->hasAttribute($this->attribute)) {
                        throw new CException(Yii::t('EditableSaver.editable', 'Model {class} does not have attribute "{attr}"', array(
                          '{class}'=>get_class($this->model), '{attr}'=>$this->attribute)));
                }
                */

                //is attribute safe
                if (!$this->model->isAttributeSafe($this->attribute)) {
                        throw new CException(Yii::t(
                                'editable',
                                'Model {class} rules do not allow to update attribute "{attr}"',
                                array(
                                        '{class}' => get_class($this->model),
                                        '{attr}' => $this->attribute
                                )
                        ));
                }

                //setting new value
                $this->setAttribute($this->attribute, $this->value);

                //validate attribute
                $this->model->validate(array($this->attribute));
                $this->checkErrors();

                //trigger beforeUpdate event
                $this->beforeUpdate();
                $this->checkErrors();

                //saving (no validation, only changed attributes)
                if ($this->model->save(false, $this->changedAttributes)) {
                        //trigger afterUpdate event
                        $this->afterUpdate();
                } else {
                        $this->error(Yii::t('TbEditableSaver.editable', 'Error while saving record!'));
                }
        }

        public function checkErrors()
        {
                if ($this->model->hasErrors()) {
                        $msg = array();
                        foreach ($this->model->getErrors() as $attribute => $errors) {
                                // TODO: make use of $attribute elements
                                $msg = array_merge($msg, $errors);
                        }
                        // TODO: show several messages. should be checked in x-editable js
                        //$this->error(join("\n", $msg));
                        $this->error($msg[0]);
                }
        }

        public function error($msg)
        {
                throw new CHttpException($this->errorHttpCode, $msg);
        }

        public function setAttribute($name, $value)
        {
                $this->model->$name = $value;
                if (!in_array($name, $this->changedAttributes)) {
                        $this->changedAttributes[] = $name;
                }
        }

        public function onBeforeUpdate($event)
        {
                $this->raiseEvent('onBeforeUpdate', $event);
        }

        public function onAfterUpdate($event)
        {
                $this->raiseEvent('onAfterUpdate', $event);
        }

        protected function beforeUpdate()
        {
                $this->onBeforeUpdate(new CModelEvent($this));
        }

        protected function afterUpdate()
        {
                $this->onAfterUpdate(new CModelEvent($this));
        }
}