interface/modules/zend_modules/library/Zend/Filter/StringToUpper.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Filter;
  11
  12 use Traversable;
  13
  14 class StringToUpper extends AbstractUnicode
  15 {
  16     /**
  17      * @var array
  18      */
  19     protected $options = array(
  20         'encoding' => null,
  21     );
  22
  23     /**
  24      * Constructor
  25      *
  26      * @param string|array|Traversable $encodingOrOptions OPTIONAL
  27      */
  28     public function __construct($encodingOrOptions = null)
  29     {
  30         if ($encodingOrOptions !== null) {
  31             if (!static::isOptions($encodingOrOptions)) {
  32                 $this->setEncoding($encodingOrOptions);
  33             } else {
  34                 $this->setOptions($encodingOrOptions);
  35             }
  36         }
  37     }
  38
  39     /**
  40      * Defined by Zend\Filter\FilterInterface
  41      *
  42      * Returns the string $value, converting characters to uppercase as necessary
  43      *
  44      * If the value provided is non-scalar, the value will remain unfiltered
  45      * and an E_USER_WARNING will be raised indicating it's unfilterable.
  46      *
  47      * @param  string $value
  48      * @return string|mixed
  49      */
  50     public function filter($value)
  51     {
  52         if (null === $value) {
  53             return null;
  54         }
  55
  56         if (!is_scalar($value)) {
  57             trigger_error(
  58                 sprintf(
  59                     '%s expects parameter to be scalar, "%s" given; cannot filter',
  60                     __METHOD__,
  61                     (is_object($value) ? get_class($value) : gettype($value))
  62                 ),
  63                 E_USER_WARNING
  64             );
  65             return $value;
  66         }
  67
  68         if ($this->options['encoding'] !== null) {
  69             return mb_strtoupper((string) $value,  $this->options['encoding']);
  70         }
  71
  72         return strtoupper((string) $value);
  73     }
  74 }