import v1.0.0-RC4 | 2009-05-20

libs/Zend/Dojo/Form/Element/Dijit.php

@@ -0,0 +1,188 @@
+<?php
+/**
+ * Zend Framework
+ *
+ * LICENSE
+ *
+ * This source file is subject to the new BSD license that is bundled
+ * with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * http://framework.zend.com/license/new-bsd
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@zend.com so we can send you a copy immediately.
+ *
+ * @category   Zend
+ * @package    Zend_Dojo
+ * @subpackage Form_Element
+ * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ */
+
+/** Zend_Form_Element */
+require_once 'Zend/Form/Element.php';
+
+/**
+ * Base element for dijit elements
+ * 
+ * @category   Zend
+ * @package    Zend_Dojo
+ * @subpackage Form_Element
+ * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ * @version    $Id: Dijit.php 10076 2008-07-13 12:58:08Z matthew $
+ */
+abstract class Zend_Dojo_Form_Element_Dijit extends Zend_Form_Element
+{
+    /**
+     * Dijit parameters
+     * @var array
+     */
+    public $dijitParams = array();
+
+    /**
+     * View helper to use
+     * @var string
+     */
+    public $helper;
+
+    /**
+     * Constructor
+     * 
+     * @todo Should we set dojo view helper paths here?
+     * @param  mixed $spec 
+     * @param  mixed $options 
+     * @return void
+     */
+    public function __construct($spec, $options = null)
+    {
+        $this->addPrefixPath('Zend_Dojo_Form_Decorator', 'Zend/Dojo/Form/Decorator', 'decorator');
+        parent::__construct($spec, $options);
+    }
+
+    /**
+     * Set a dijit parameter
+     * 
+     * @param  string $key 
+     * @param  mixed $value 
+     * @return Zend_Dojo_Form_Element_Dijit
+     */
+    public function setDijitParam($key, $value)
+    {
+        $key = (string) $key;
+        $this->dijitParams[$key] = $value;
+        return $this;
+    }
+
+    /**
+     * Set multiple dijit params at once
+     * 
+     * @param  array $params 
+     * @return Zend_Dojo_Form_Element_Dijit
+     */
+    public function setDijitParams(array $params)
+    {
+        $this->dijitParams = array_merge($this->dijitParams, $params);
+        return $this;
+    }
+
+    /**
+     * Does the given dijit parameter exist?
+     * 
+     * @param  string $key 
+     * @return bool
+     */
+    public function hasDijitParam($key)
+    {
+        return array_key_exists($key, $this->dijitParams);
+    }
+
+    /**
+     * Get a single dijit parameter
+     * 
+     * @param  string $key 
+     * @return mixed
+     */
+    public function getDijitParam($key)
+    {
+        $key = (string) $key;
+        if ($this->hasDijitParam($key)) {
+            return $this->dijitParams[$key];
+        }
+        return null;
+    }
+
+    /**
+     * Retrieve all dijit parameters
+     * 
+     * @return array
+     */
+    public function getDijitParams()
+    {
+        return $this->dijitParams;
+    }
+
+    /**
+     * Remove a single dijit parameter
+     * 
+     * @param  string $key 
+     * @return Zend_Dojo_Form_Element_Dijit
+     */
+    public function removeDijitParam($key)
+    {
+        $key = (string) $key;
+        if (array_key_exists($key, $this->dijitParams)) {
+            unset($this->dijitParams[$key]);
+        }
+        return $this;
+    }
+
+    /**
+     * Clear all dijit parameters
+     * 
+     * @return Zend_Dojo_Form_Element_Dijit
+     */
+    public function clearDijitParams()
+    {
+        $this->dijitParams = array();
+        return $this;
+    }
+
+    /**
+     * Load default decorators
+     * 
+     * @return void
+     */
+    public function loadDefaultDecorators()
+    {
+        if ($this->loadDefaultDecoratorsIsDisabled()) {
+            return;
+        }
+
+        $decorators = $this->getDecorators();
+        if (empty($decorators)) {
+            $this->addDecorator('DijitElement')
+                 ->addDecorator('Errors')
+                 ->addDecorator('HtmlTag', array('tag' => 'dd'))
+                 ->addDecorator('Label', array('tag' => 'dt'));
+        }
+    }
+
+    /**
+     * Set the view object
+     *
+     * Ensures that the view object has the dojo view helper path set.
+     * 
+     * @param  Zend_View_Interface $view 
+     * @return Zend_Dojo_Form_Element_Dijit
+     */
+    public function setView(Zend_View_Interface $view = null)
+    {
+        if (null !== $view) {
+            if (false === $view->getPluginLoader('helper')->getPaths('Zend_Dojo_View_Helper')) {
+                $view->addHelperPath('Zend/Dojo/View/Helper', 'Zend_Dojo_View_Helper');
+            }
+        }
+        return parent::setView($view);
+    }
+}