library/Zend/View/Helper/HeadStyle.php

   1 <?php
   2 /**
   3  * Zend Framework
   4  *
   5  * LICENSE
   6  *
   7  * This source file is subject to the new BSD license that is bundled
   8  * with this package in the file LICENSE.txt.
   9  * It is also available through the world-wide-web at this URL:
  10  * http://framework.zend.com/license/new-bsd
  11  * If you did not receive a copy of the license and are unable to
  12  * obtain it through the world-wide-web, please send an email
  13  * to license@zend.com so we can send you a copy immediately.
  14  *
  15  * @category   Zend
  16  * @package    Zend_View
  17  * @subpackage Helper
  18  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  19  * @version    $Id: HeadStyle.php 16971 2009-07-22 18:05:45Z mikaelkael $
  20  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  21  */
  22
  23 /** Zend_View_Helper_Placeholder_Container_Standalone */
  24 require_once 'Zend/View/Helper/Placeholder/Container/Standalone.php';
  25
  26 /**
  27  * Helper for setting and retrieving stylesheets
  28  *
  29  * @uses       Zend_View_Helper_Placeholder_Container_Standalone
  30  * @package    Zend_View
  31  * @subpackage Helper
  32  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  33  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  34  */
  35 class Zend_View_Helper_HeadStyle extends Zend_View_Helper_Placeholder_Container_Standalone
  36 {
  37     /**
  38      * Registry key for placeholder
  39      * @var string
  40      */
  41     protected $_regKey = 'Zend_View_Helper_HeadStyle';
  42
  43     /**
  44      * Allowed optional attributes
  45      * @var array
  46      */
  47     protected $_optionalAttributes = array('lang', 'title', 'media', 'dir');
  48
  49     /**
  50      * Allowed media types
  51      * @var array
  52      */
  53     protected $_mediaTypes = array(
  54         'all', 'aural', 'braille', 'handheld', 'print',
  55         'projection', 'screen', 'tty', 'tv'
  56     );
  57
  58     /**
  59      * Capture type and/or attributes (used for hinting during capture)
  60      * @var string
  61      */
  62     protected $_captureAttrs = null;
  63
  64     /**
  65      * Capture lock
  66      * @var bool
  67      */
  68     protected $_captureLock;
  69
  70     /**
  71      * Capture type (append, prepend, set)
  72      * @var string
  73      */
  74     protected $_captureType;
  75
  76     /**
  77      * Constructor
  78      *
  79      * Set separator to PHP_EOL.
  80      *
  81      * @return void
  82      */
  83     public function __construct()
  84     {
  85         parent::__construct();
  86         $this->setSeparator(PHP_EOL);
  87     }
  88
  89     /**
  90      * Return headStyle object
  91      *
  92      * Returns headStyle helper object; optionally, allows specifying
  93      *
  94      * @param  string $content Stylesheet contents
  95      * @param  string $placement Append, prepend, or set
  96      * @param  string|array $attributes Optional attributes to utilize
  97      * @return Zend_View_Helper_HeadStyle
  98      */
  99     public function headStyle($content = null, $placement = 'APPEND', $attributes = array())
 100     {
 101         if ((null !== $content) && is_string($content)) {
 102             switch (strtoupper($placement)) {
 103                 case 'SET':
 104                     $action = 'setStyle';
 105                     break;
 106                 case 'PREPEND':
 107                     $action = 'prependStyle';
 108                     break;
 109                 case 'APPEND':
 110                 default:
 111                     $action = 'appendStyle';
 112                     break;
 113             }
 114             $this->$action($content, $attributes);
 115         }
 116
 117         return $this;
 118     }
 119
 120     /**
 121      * Overload method calls
 122      *
 123      * Allows the following method calls:
 124      * - appendStyle($content, $attributes = array())
 125      * - offsetSetStyle($index, $content, $attributes = array())
 126      * - prependStyle($content, $attributes = array())
 127      * - setStyle($content, $attributes = array())
 128      *
 129      * @param  string $method
 130      * @param  array $args
 131      * @return void
 132      * @throws Zend_View_Exception When no $content provided or invalid method
 133      */
 134     public function __call($method, $args)
 135     {
 136         if (preg_match('/^(?P<action>set|(ap|pre)pend|offsetSet)(Style)$/', $method, $matches)) {
 137             $index  = null;
 138             $argc   = count($args);
 139             $action = $matches['action'];
 140
 141             if ('offsetSet' == $action) {
 142                 if (0 < $argc) {
 143                     $index = array_shift($args);
 144                     --$argc;
 145                 }
 146             }
 147
 148             if (1 > $argc) {
 149                 require_once 'Zend/View/Exception.php';
 150                 throw new Zend_View_Exception(sprintf('Method "%s" requires minimally content for the stylesheet', $method));
 151             }
 152
 153             $content = $args[0];
 154             $attrs   = array();
 155             if (isset($args[1])) {
 156                 $attrs = (array) $args[1];
 157             }
 158
 159             $item = $this->createData($content, $attrs);
 160
 161             if ('offsetSet' == $action) {
 162                 $this->offsetSet($index, $item);
 163             } else {
 164                 $this->$action($item);
 165             }
 166
 167             return $this;
 168         }
 169
 170         return parent::__call($method, $args);
 171     }
 172
 173     /**
 174      * Determine if a value is a valid style tag
 175      *
 176      * @param  mixed $value
 177      * @param  string $method
 178      * @return boolean
 179      */
 180     protected function _isValid($value)
 181     {
 182         if ((!$value instanceof stdClass)
 183             || !isset($value->content)
 184             || !isset($value->attributes))
 185         {
 186             return false;
 187         }
 188
 189         return true;
 190     }
 191
 192     /**
 193      * Override append to enforce style creation
 194      *
 195      * @param  mixed $value
 196      * @return void
 197      */
 198     public function append($value)
 199     {
 200         if (!$this->_isValid($value)) {
 201             require_once 'Zend/View/Exception.php';
 202             throw new Zend_View_Exception('Invalid value passed to append; please use appendStyle()');
 203         }
 204
 205         return $this->getContainer()->append($value);
 206     }
 207
 208     /**
 209      * Override offsetSet to enforce style creation
 210      *
 211      * @param  string|int $index
 212      * @param  mixed $value
 213      * @return void
 214      */
 215     public function offsetSet($index, $value)
 216     {
 217         if (!$this->_isValid($value)) {
 218             require_once 'Zend/View/Exception.php';
 219             throw new Zend_View_Exception('Invalid value passed to offsetSet; please use offsetSetStyle()');
 220         }
 221
 222         return $this->getContainer()->offsetSet($index, $value);
 223     }
 224
 225     /**
 226      * Override prepend to enforce style creation
 227      *
 228      * @param  mixed $value
 229      * @return void
 230      */
 231     public function prepend($value)
 232     {
 233         if (!$this->_isValid($value)) {
 234             require_once 'Zend/View/Exception.php';
 235             throw new Zend_View_Exception('Invalid value passed to prepend; please use prependStyle()');
 236         }
 237
 238         return $this->getContainer()->prepend($value);
 239     }
 240
 241     /**
 242      * Override set to enforce style creation
 243      *
 244      * @param  mixed $value
 245      * @return void
 246      */
 247     public function set($value)
 248     {
 249         if (!$this->_isValid($value)) {
 250             require_once 'Zend/View/Exception.php';
 251             throw new Zend_View_Exception('Invalid value passed to set; please use setStyle()');
 252         }
 253
 254         return $this->getContainer()->set($value);
 255     }
 256
 257     /**
 258      * Start capture action
 259      *
 260      * @param  mixed $captureType
 261      * @param  string $typeOrAttrs
 262      * @return void
 263      */
 264     public function captureStart($type = Zend_View_Helper_Placeholder_Container_Abstract::APPEND, $attrs = null)
 265     {
 266         if ($this->_captureLock) {
 267             require_once 'Zend/View/Helper/Placeholder/Container/Exception.php';
 268             throw new Zend_View_Helper_Placeholder_Container_Exception('Cannot nest headStyle captures');
 269         }
 270
 271         $this->_captureLock        = true;
 272         $this->_captureAttrs       = $attrs;
 273         $this->_captureType        = $type;
 274         ob_start();
 275     }
 276
 277     /**
 278      * End capture action and store
 279      *
 280      * @return void
 281      */
 282     public function captureEnd()
 283     {
 284         $content             = ob_get_clean();
 285         $attrs               = $this->_captureAttrs;
 286         $this->_captureAttrs = null;
 287         $this->_captureLock  = false;
 288
 289         switch ($this->_captureType) {
 290             case Zend_View_Helper_Placeholder_Container_Abstract::SET:
 291                 $this->setStyle($content, $attrs);
 292                 break;
 293             case Zend_View_Helper_Placeholder_Container_Abstract::PREPEND:
 294                 $this->prependStyle($content, $attrs);
 295                 break;
 296             case Zend_View_Helper_Placeholder_Container_Abstract::APPEND:
 297             default:
 298                 $this->appendStyle($content, $attrs);
 299                 break;
 300         }
 301     }
 302
 303     /**
 304      * Convert content and attributes into valid style tag
 305      *
 306      * @param  stdClass $item Item to render
 307      * @param  string $indent Indentation to use
 308      * @return string
 309      */
 310     public function itemToString(stdClass $item, $indent)
 311     {
 312         $attrString = '';
 313         if (!empty($item->attributes)) {
 314             foreach ($item->attributes as $key => $value) {
 315                 if (!in_array($key, $this->_optionalAttributes)) {
 316                     continue;
 317                 }
 318                 if ('media' == $key) {
 319                     if(false === strpos($value, ',')) {
 320                         if (!in_array($value, $this->_mediaTypes)) {
 321                             continue;
 322                         }
 323                     } else {
 324                         $media_types = explode(',', $value);
 325                         $value = '';
 326                         foreach($media_types as $type) {
 327                             if (!in_array($type, $this->_mediaTypes)) {
 328                                 continue;
 329                             }
 330                             $value .= $type .',';
 331                         }
 332                         $value = substr($value, 0, -1);
 333                     }
 334                 }
 335                 $attrString .= sprintf(' %s="%s"', $key, htmlspecialchars($value));
 336             }
 337         }
 338
 339         $html = '<style type="text/css"' . $attrString . '>' . PHP_EOL
 340               . $indent . '<!--' . PHP_EOL . $indent . $item->content . PHP_EOL . $indent . '-->' . PHP_EOL
 341               . '</style>';
 342
 343         if (isset($item->attributes['conditional'])
 344             && !empty($item->attributes['conditional'])
 345             && is_string($item->attributes['conditional']))
 346         {
 347             $html = '<!--[if ' . $item->attributes['conditional'] . ']> ' . $html . '<![endif]-->';
 348         }
 349
 350         return $html;
 351     }
 352
 353     /**
 354      * Create string representation of placeholder
 355      *
 356      * @param  string|int $indent
 357      * @return string
 358      */
 359     public function toString($indent = null)
 360     {
 361         $indent = (null !== $indent)
 362                 ? $this->getWhitespace($indent)
 363                 : $this->getIndent();
 364
 365         $items = array();
 366         $this->getContainer()->ksort();
 367         foreach ($this as $item) {
 368             if (!$this->_isValid($item)) {
 369                 continue;
 370             }
 371             $items[] = $this->itemToString($item, $indent);
 372         }
 373
 374         $return = $indent . implode($this->getSeparator() . $indent, $items);
 375         $return = preg_replace("/(\r\n?|\n)/", '$1' . $indent, $return);
 376         return $return;
 377     }
 378
 379     /**
 380      * Create data item for use in stack
 381      *
 382      * @param  string $content
 383      * @param  array $attributes
 384      * @return stdClass
 385      */
 386     public function createData($content, array $attributes)
 387     {
 388         if (!isset($attributes['media'])) {
 389             $attributes['media'] = 'screen';
 390         } else if(is_array($attributes['media'])) {
 391             $attributes['media'] = implode(',', $attributes['media']);
 392         }
 393
 394         $data = new stdClass();
 395         $data->content    = $content;
 396         $data->attributes = $attributes;
 397
 398         return $data;
 399     }
 400 }