File indexing completed on 2024-12-29 05:27:31

0001 <?php
0002 /**
0003  * Zend Framework
0004  *
0005  * LICENSE
0006  *
0007  * This source file is subject to the new BSD license that is bundled
0008  * with this package in the file LICENSE.txt.
0009  * It is also available through the world-wide-web at this URL:
0010  * http://framework.zend.com/license/new-bsd
0011  * If you did not receive a copy of the license and are unable to
0012  * obtain it through the world-wide-web, please send an email
0013  * to license@zend.com so we can send you a copy immediately.
0014  *
0015  * @category   Zend
0016  * @package    Zend_Controller
0017  * @subpackage Zend_Controller_Action_Helper
0018  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
0019  * @license    http://framework.zend.com/license/new-bsd     New BSD License
0020  * @version    $Id$
0021  */
0022 
0023 /**
0024  * @see Zend_Controller_Action_Helper_ContextSwitch
0025  */
0026 // require_once 'Zend/Controller/Action/Helper/ContextSwitch.php';
0027 
0028 /**
0029  * Simplify AJAX context switching based on requested format
0030  *
0031  * @uses       Zend_Controller_Action_Helper_Abstract
0032  * @category   Zend
0033  * @package    Zend_Controller
0034  * @subpackage Zend_Controller_Action_Helper
0035  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
0036  * @license    http://framework.zend.com/license/new-bsd     New BSD License
0037  */
0038 class Zend_Controller_Action_Helper_AjaxContext extends Zend_Controller_Action_Helper_ContextSwitch
0039 {
0040     /**
0041      * Controller property to utilize for context switching
0042      * @var string
0043      */
0044     protected $_contextKey = 'ajaxable';
0045 
0046     /**
0047      * Constructor
0048      *
0049      * Add HTML context
0050      *
0051      * @return void
0052      */
0053     public function __construct()
0054     {
0055         parent::__construct();
0056         $this->addContext('html', array('suffix' => 'ajax'));
0057     }
0058 
0059     /**
0060      * Initialize AJAX context switching
0061      *
0062      * Checks for XHR requests; if detected, attempts to perform context switch.
0063      *
0064      * @param  string $format
0065      * @return void
0066      */
0067     public function initContext($format = null)
0068     {
0069         $this->_currentContext = null;
0070 
0071         $request = $this->getRequest();
0072         if (!method_exists($request, 'isXmlHttpRequest') ||
0073             !$this->getRequest()->isXmlHttpRequest())
0074         {
0075             return;
0076         }
0077 
0078         return parent::initContext($format);
0079     }
0080 }