library/ZendX/JQuery/View/Helper/JQuery.php

@@ -0,0 +1,167 @@
+<?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    ZendX
+ * @package     ZendX_JQuery
+ * @subpackage  View
+ * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license     http://framework.zend.com/license/new-bsd     New BSD License
+ * @version     $Id$
+ */
+
+/**
+ * @see ZendX_JQuery
+ */
+require_once "ZendX/JQuery.php";
+
+/**
+ * @see Zend_Registry
+ */
+require_once 'Zend/Registry.php';
+
+/**
+ * @see Zend_View_Helper_Abstract
+ */
+require_once 'Zend/View/Helper/Abstract.php';
+
+/**
+ * @see ZendX_JQuery_View_Helper_JQuery_Container
+ */
+require_once "ZendX/JQuery/View/Helper/JQuery/Container.php";
+
+/**
+ * jQuery Helper. Functions as a stack for code and loads all jQuery dependencies.
+ *
+ * @uses 	   Zend_Json
+ * @package    ZendX_JQuery
+ * @subpackage View
+ * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ */
+class ZendX_JQuery_View_Helper_JQuery extends Zend_View_Helper_Abstract
+{
+    /**
+     * @var Zend_View_Interface
+     */
+    public $view;
+
+	/**
+	 * jQuery no Conflict Mode
+	 *
+	 * @see	      http://docs.jquery.com/Using_jQuery_with_Other_Libraries
+	 * @staticvar Boolean Status of noConflict Mode
+	 */
+    private static $noConflictMode = false;
+
+   /**
+     * 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 'ZendX/JQuery/View/Helper/JQuery/Container.php';
+            $container = new ZendX_JQuery_View_Helper_JQuery_Container();
+            $registry[__CLASS__] = $container;
+        }
+        $this->_container = $registry[__CLASS__];
+    }
+
+	/**
+	 * Return jQuery View Helper class, to execute jQuery library related functions.
+	 *
+	 * @return ZendX_JQuery_View_Helper_JQuery_Container
+	 */
+    public function jQuery()
+    {
+        return $this->_container;
+    }
+
+    /**
+     * Set view object
+     *
+     * @param  Zend_View_Interface $view
+     * @return void
+     */
+    public function setView(Zend_View_Interface $view)
+    {
+        $this->view = $view;
+        $this->_container->setView($view);
+    }
+
+    /**
+     * Proxy to container methods
+     *
+     * @param  string $method
+     * @param  array  $args
+     * @return mixed
+     * @throws Zend_View_Exception For invalid method calls
+     */
+    public function __call($method, $args)
+    {
+        if (!method_exists($this->_container, $method)) {
+            require_once 'Zend/View/Exception.php';
+            throw new Zend_View_Exception(sprintf('Invalid method "%s" called on jQuery view helper', $method));
+        }
+
+        return call_user_func_array(array($this->_container, $method), $args);
+    }
+
+	/**
+	 * Enable the jQuery internal noConflict Mode to work with
+	 * other Javascript libraries. Will setup jQuery in the variable
+	 * $j instead of $ to overcome conflicts.
+	 *
+	 * @link http://docs.jquery.com/Using_jQuery_with_Other_Libraries
+	 */
+    public static function enableNoConflictMode()
+    {
+    	self::$noConflictMode = true;
+    }
+
+	/**
+	 * Disable noConflict Mode of jQuery if this was previously enabled.
+	 *
+	 * @return void
+	 */
+    public static function disableNoConflictMode()
+    {
+    	self::$noConflictMode = false;
+    }
+
+	/**
+	 * Return current status of the jQuery no Conflict Mode
+	 *
+	 * @return Boolean
+	 */
+    public static function getNoConflictMode()
+    {
+    	return self::$noConflictMode;
+    }
+
+    /**
+     * Return current jQuery handler based on noConflict mode settings.
+     *
+     * @return String
+     */
+    public static function getJQueryHandler()
+    {
+        return ((self::getNoConflictMode()==true)?'$j':'$');
+    }
+}