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

libs/Zend/Dojo/View/Helper/Dojo.php

@@ -0,0 +1,176 @@
+<?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 View
+ * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
+ * @version    $Id: Dojo.php 10024 2008-07-10 14:04:33Z matthew $
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ */
+
+/** Zend_Registry */
+require_once 'Zend/Registry.php';
+
+/**
+ * Zend_Dojo_View_Helper_Dojo: Dojo View Helper
+ *
+ * Allows specifying stylesheets, path to dojo, module paths, and onLoad 
+ * events. 
+ * 
+ * @package    Zend_Dojo
+ * @subpackage View
+ * @copyright  Copyright (C) 2008 - Present, Zend Technologies, Inc.
+ * @license    New BSD {@link http://framework.zend.com/license/new-bsd}
+ */
+class Zend_Dojo_View_Helper_Dojo 
+{ 
+    /**#@+
+     * @const Programmatic dijit creation style constants
+     */
+    const PROGRAMMATIC_SCRIPT = 1;
+    const PROGRAMMATIC_NOSCRIPT = -1;
+    /**#@-*/
+
+    /**
+     * @var Zend_View_Interface
+     */
+    public $view; 
+
+    /**
+     * @var Zend_Dojo_View_Helper_Dojo_Container
+     */
+    protected $_container;
+
+    /**
+     * @var bool Whether or not dijits should be declared programmatically
+     */
+    protected static $_useProgrammatic = true;
+
+    /**
+     * Initialize helper
+     *
+     * Retrieve container from registry or create new container and store in 
+     * registry.
+     * 
+     * @return void
+     */
+    public function __construct()
+    {
+        $registry = Zend_Registry::getInstance();
+        if (!isset($registry[__CLASS__])) {
+            require_once 'Zend/Dojo/View/Helper/Dojo/Container.php';
+            $container = new Zend_Dojo_View_Helper_Dojo_Container();
+            $registry[__CLASS__] = $container;
+        }
+        $this->_container = $registry[__CLASS__];
+    }
+
+    /**
+     * Set view object
+     * 
+     * @param  Zend_Dojo_View_Interface $view 
+     * @return void
+     */
+    public function setView(Zend_View_Interface $view)
+    {
+        $this->view = $view;
+        $this->_container->setView($view);
+    }
+
+    /**
+     * Return dojo container
+     * 
+     * @return Zend_Dojo_View_Helper_Dojo_Container
+     */
+    public function dojo()
+    {
+        return $this->_container;
+    }
+
+    /**
+     * Proxy to container methods
+     * 
+     * @param  string $method 
+     * @param  array $args 
+     * @return mixed
+     * @throws Zend_Dojo_View_Exception For invalid method calls
+     */
+    public function __call($method, $args)
+    {
+        if (!method_exists($this->_container, $method)) {
+            require_once 'Zend/Dojo/View/Exception.php';
+            throw new Zend_Dojo_View_Exception(sprintf('Invalid method "%s" called on dojo view helper', $method));
+        }
+
+        return call_user_func_array(array($this->_container, $method), $args);
+    }
+
+    /**
+     * Set whether or not dijits should be created declaratively
+     * 
+     * @return void
+     */
+    public static function setUseDeclarative()
+    {
+        self::$_useProgrammatic = false;
+    }
+
+    /**
+     * Set whether or not dijits should be created programmatically
+     *
+     * Optionally, specifiy whether or not dijit helpers should generate the 
+     * programmatic dojo.
+     * 
+     * @param  int $style 
+     * @return void
+     */
+    public static function setUseProgrammatic($style = self::PROGRAMMATIC_SCRIPT)
+    {
+        if (!in_array($style, array(self::PROGRAMMATIC_SCRIPT, self::PROGRAMMATIC_NOSCRIPT))) {
+            $style = self::PROGRAMMATIC_SCRIPT;
+        }
+        self::$_useProgrammatic = $style;
+    }
+
+    /**
+     * Should dijits be created declaratively?
+     * 
+     * @return bool
+     */
+    public static function useDeclarative()
+    {
+        return (false === self::$_useProgrammatic);
+    }
+
+    /**
+     * Should dijits be created programmatically?
+     * 
+     * @return bool
+     */
+    public static function useProgrammatic()
+    {
+        return (false !== self::$_useProgrammatic);
+    }
+
+    /**
+     * Should dijits be created programmatically but without scripts?
+     * 
+     * @return bool
+     */
+    public static function useProgrammaticNoScript()
+    {
+        return (self::PROGRAMMATIC_NOSCRIPT === self::$_useProgrammatic);
+    }
+}