clevertech / YiiBooster

src/widgets/TbEditableDetailView.php

<?php
/**
 * TbEditableDetailView class file.
 *
 * @author Vitaliy Potapov <noginsk@rambler.ru>
 * @link https://github.com/vitalets/x-editable-yii
 * @copyright Copyright &copy; Vitaliy Potapov 2012
 * @version 1.3.1
 */

Yii::import('booster.widgets.TbEditableField');
Yii::import('zii.widgets.CDetailView');

/**
 * TbEditableDetailView widget makes editable CDetailView (several attributes of single model shown as name-value table).
 *
 * @package widgets
 */
class TbEditableDetailView extends CDetailView
{

    public function init()
    {
        if (!$this->data instanceof CModel) {

The class CModel does not exist. Did you forget a USE statement, or did you not list all dependencies?

            throw new CException('Property "data" should be of CModel class.');
        }

        //set bootstrap css
        /* TODO if(yii::app()->editable->form === 'bootstrap') { */
            $this->htmlOptions = array('class'=> 'table table-bordered table-striped table-hover');
            //disable loading Yii's css for bootstrap
            $this->cssFile = false;
        // }

        parent::init();
    }

    protected function renderItem($options, $templateData)
    {
        //apply editable if not set 'editable' params or set and not false
        $apply = !empty($options['name']) && (!isset($options['editable']) || $options['editable'] !== false);

        if ($apply) {
            //ensure $options['editable'] is array
            if(!isset($options['editable'])) $options['editable'] = array();

            //merge options with defaults: url, params, etc.
            $options['editable'] = CMap::mergeArray($this->_data, $options['editable']);

            //options to be passed into TbEditableField (constructed from $options['editable'])
            $widgetOptions = array(
                'model'     => $this->data,
                'attribute' => $options['name']
            );

            //if value in detailview options provided, set text directly (as value here means text)
            if(isset($options['value']) && $options['value'] !== null) {
                $widgetOptions['text'] = $templateData['{value}'];
                $widgetOptions['encode'] = false;
            }

            $widgetOptions = CMap::mergeArray($widgetOptions, $options['editable']);

            $widget = $this->controller->createWidget('TbEditableField', $widgetOptions);

            //'apply' maybe changed during init of widget (e.g. if related model has unsafe attribute)
            if($widget->apply) {
                ob_start();
                $widget->run();
                $templateData['{value}'] = ob_get_clean();
            }
        }

        parent::renderItem($options, $templateData);
    }

    //***************************************************************************************
    // Generic getter/setter implementation to accept default configuration for TbEditableField
    //***************************************************************************************

    /** Data for default fields of TbEditableField */
    private $_data = array();
    /** Valid attributes for TbEditableField (singleton) */
    private $_editableProperties;

    /**
     * Get the properties available for {@link TbEditableField}.
     *
     * These properties can also be set for the {@link TbEditableDetailView} as default values.
     */
    private function getEditableProperties()
    {
        if(!isset($this->_editableProperties))
        {
            $reflection = new ReflectionClass('TbEditableField');
            $this->_editableProperties = array_map(
	            function(ReflectionProperty $d) { return $d->getName(); },
	            $reflection->getProperties()
            );
        }
        return $this->_editableProperties;
    }

	/**
	 * (non-PHPdoc)
	 * @see CComponent::__get()
	 *
	 * @param string $key
	 *
	 * @throws CException
	 * @return mixed
	 */
    public function __get($key) {
        return (array_key_exists($key,$this->_data) ? $this->_data[$key] : parent::__get($key));
    }

	/**
	 * (non-PHPdoc)
	 * @see CComponent::__set()
	 *
	 * @param string $key
	 * @param mixed $value
	 *
	 * @throws CException
	 * @return mixed|void
	 */
    public function __set($key, $value) {
        if(in_array($key,$this->getEditableProperties())) {
            $this->_data[$key] = $value;
        } else {
            parent::__set($key,$value);
        }
    }

	/**
	 * (non-PHPdoc)
	 * @see CComponent::__isset()
	 *
	 * @param string $name
	 *
	 * @return bool
	 */
    public function __isset($name) {
        return array_key_exists($name,$this->_data)||parent::__isset($name);
    }
}