clevertech / YiiBooster

src/actions/TbToggleAction.php

<?php
/**
 *## TbToggleAction class file
 *
 * @author antonio ramirez <antonio@clevertech.biz>
 */

/**
 *## TbToggleAction CAction Component
 *
 * It is a component that works in conjunction of TbToggleColumn widget. Just attach to the controller you wish to
 * make the calls to.
 *
 * @package booster.actions
 */
class TbToggleAction extends CAction
{
	/**
	 * @var string the name of the model we are going to toggle values to
	 */
	public $modelName;

	/**
	 * @var bool whether to throw an exception if we cannot find a model requested by the id
	 */
	public $exceptionOnNullModel = true;

	/**
	 * @var array additional criteria to use to get the model
	 */
	public $additionalCriteriaOnLoadModel = array();

	/**
	 * @var mixed the route to redirect the call after updating attribute
	 */
	public $redirectRoute;

	/**
	 * @var int|string the value to update the model to [yes|no] standard toggle options, but you can toggle any value.
	 */
	public $yesValue = 1;

	/**
	 * @var int|string the value to update the model to [yes|no]
	 */
	public $noValue = 0;

	/**
	 * @var mixed the response to return to an AJAX call when the attribute was successfully saved.
	 */
	public $ajaxResponseOnSuccess = 1;

	/**
	 * @var mixed the response to return to an AJAX call when failed to update the attribute.
	 */
	public $ajaxResponseOnFailed = 0;


	/**
	 * Widgets run function
	 *
	 * @throws CHttpException
	 */
	public function run() {
		
		$pk = Yii::app()->request->getParam('pk');
		$attribute = Yii::app()->request->getParam('attribute');
		
		if (!Yii::app()->getRequest()->isPostRequest)
			throw new CHttpException(400);

		$model = $this->loadModel($pk);
		$model->$attribute = ($model->$attribute == $this->noValue) ? $this->yesValue : $this->noValue;
		$success = $model->save(false, array($attribute));

		if (Yii::app()->getRequest()->isAjaxRequest) {
			echo $success ? $this->ajaxResponseOnSuccess : $this->ajaxResponseOnFailed;
			return;
		}
		if ($this->redirectRoute !== null) {
			$this->getController()->redirect($this->redirectRoute);
		}
	}

	/**
	 * Loads the requested data model.
	 *
	 * @param integer $id the model ID
	 *
	 * @return CActiveRecord the model instance.
	 * @throws CHttpException if the model cannot be found
	 */
	protected function loadModel($id)
	{
		$finder = CActiveRecord::model($this->modelName);
		if ($this->additionalCriteriaOnLoadModel) {

The expression $this->additionalCriteriaOnLoadModel of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

			$c = new CDbCriteria($this->additionalCriteriaOnLoadModel);
			$c->mergeWith(
				array(
					'condition' => $finder->tableSchema->primaryKey . '=:id',
					'params' => array(':id' => $id),
				)
			);
			$model = $finder->find($c);
		} else {
			$model = $finder->findByPk($id);
		}

		if (!$model)
			throw new CHttpException(404, 'Unable to find the requested object.');

		return $model;
	}
}