/vendor/zendframework/zendframework/library/Zend/Filter/Inflector.php
PHP | 472 lines | 228 code | 56 blank | 188 comment | 34 complexity | 535c0d7f12f9cfa2c0e1c1ec4e2fd27d MD5 | raw file
- <?php
- /**
- * Zend Framework (http://framework.zend.com/)
- *
- * @link http://github.com/zendframework/zf2 for the canonical source repository
- * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
- * @license http://framework.zend.com/license/new-bsd New BSD License
- */
- namespace Zend\Filter;
- use Traversable;
- use Zend\Stdlib\ArrayUtils;
- /**
- * Filter chain for string inflection
- */
- class Inflector extends AbstractFilter
- {
- /**
- * @var FilterPluginManager
- */
- protected $pluginManager = null;
- /**
- * @var string
- */
- protected $target = null;
- /**
- * @var bool
- */
- protected $throwTargetExceptionsOn = true;
- /**
- * @var string
- */
- protected $targetReplacementIdentifier = ':';
- /**
- * @var array
- */
- protected $rules = array();
- /**
- * Constructor
- *
- * @param string|array|Traversable $options Options to set
- */
- public function __construct($options = null)
- {
- if ($options instanceof Traversable) {
- $options = ArrayUtils::iteratorToArray($options);
- }
- if (!is_array($options)) {
- $options = func_get_args();
- $temp = array();
- if (!empty($options)) {
- $temp['target'] = array_shift($options);
- }
- if (!empty($options)) {
- $temp['rules'] = array_shift($options);
- }
- if (!empty($options)) {
- $temp['throwTargetExceptionsOn'] = array_shift($options);
- }
- if (!empty($options)) {
- $temp['targetReplacementIdentifier'] = array_shift($options);
- }
- $options = $temp;
- }
- $this->setOptions($options);
- }
- /**
- * Retrieve plugin manager
- *
- * @return FilterPluginManager
- */
- public function getPluginManager()
- {
- if (!$this->pluginManager instanceof FilterPluginManager) {
- $this->setPluginManager(new FilterPluginManager());
- }
- return $this->pluginManager;
- }
- /**
- * Set plugin manager
- *
- * @param FilterPluginManager $manager
- * @return Inflector
- */
- public function setPluginManager(FilterPluginManager $manager)
- {
- $this->pluginManager = $manager;
- return $this;
- }
- /**
- * Set options
- *
- * @param array|Traversable $options
- * @return Inflector
- */
- public function setOptions($options)
- {
- if ($options instanceof Traversable) {
- $options = ArrayUtils::iteratorToArray($options);
- }
- // Set plugin manager
- if (array_key_exists('pluginManager', $options)) {
- if (is_scalar($options['pluginManager']) && class_exists($options['pluginManager'])) {
- $options['pluginManager'] = new $options['pluginManager'];
- }
- $this->setPluginManager($options['pluginManager']);
- }
- if (array_key_exists('throwTargetExceptionsOn', $options)) {
- $this->setThrowTargetExceptionsOn($options['throwTargetExceptionsOn']);
- }
- if (array_key_exists('targetReplacementIdentifier', $options)) {
- $this->setTargetReplacementIdentifier($options['targetReplacementIdentifier']);
- }
- if (array_key_exists('target', $options)) {
- $this->setTarget($options['target']);
- }
- if (array_key_exists('rules', $options)) {
- $this->addRules($options['rules']);
- }
- return $this;
- }
- /**
- * Set Whether or not the inflector should throw an exception when a replacement
- * identifier is still found within an inflected target.
- *
- * @param bool $throwTargetExceptionsOn
- * @return Inflector
- */
- public function setThrowTargetExceptionsOn($throwTargetExceptionsOn)
- {
- $this->throwTargetExceptionsOn = ($throwTargetExceptionsOn == true) ? true : false;
- return $this;
- }
- /**
- * Will exceptions be thrown?
- *
- * @return bool
- */
- public function isThrowTargetExceptionsOn()
- {
- return $this->throwTargetExceptionsOn;
- }
- /**
- * Set the Target Replacement Identifier, by default ':'
- *
- * @param string $targetReplacementIdentifier
- * @return Inflector
- */
- public function setTargetReplacementIdentifier($targetReplacementIdentifier)
- {
- if ($targetReplacementIdentifier) {
- $this->targetReplacementIdentifier = (string) $targetReplacementIdentifier;
- }
- return $this;
- }
- /**
- * Get Target Replacement Identifier
- *
- * @return string
- */
- public function getTargetReplacementIdentifier()
- {
- return $this->targetReplacementIdentifier;
- }
- /**
- * Set a Target
- * ex: 'scripts/:controller/:action.:suffix'
- *
- * @param string
- * @return Inflector
- */
- public function setTarget($target)
- {
- $this->target = (string) $target;
- return $this;
- }
- /**
- * Retrieve target
- *
- * @return string
- */
- public function getTarget()
- {
- return $this->target;
- }
- /**
- * Set Target Reference
- *
- * @param reference $target
- * @return Inflector
- */
- public function setTargetReference(&$target)
- {
- $this->target =& $target;
- return $this;
- }
- /**
- * SetRules() is the same as calling addRules() with the exception that it
- * clears the rules before adding them.
- *
- * @param array $rules
- * @return Inflector
- */
- public function setRules(Array $rules)
- {
- $this->clearRules();
- $this->addRules($rules);
- return $this;
- }
- /**
- * AddRules(): multi-call to setting filter rules.
- *
- * If prefixed with a ":" (colon), a filter rule will be added. If not
- * prefixed, a static replacement will be added.
- *
- * ex:
- * array(
- * ':controller' => array('CamelCaseToUnderscore','StringToLower'),
- * ':action' => array('CamelCaseToUnderscore','StringToLower'),
- * 'suffix' => 'phtml'
- * );
- *
- * @param array
- * @return Inflector
- */
- public function addRules(Array $rules)
- {
- $keys = array_keys($rules);
- foreach ($keys as $spec) {
- if ($spec[0] == ':') {
- $this->addFilterRule($spec, $rules[$spec]);
- } else {
- $this->setStaticRule($spec, $rules[$spec]);
- }
- }
- return $this;
- }
- /**
- * Get rules
- *
- * By default, returns all rules. If a $spec is provided, will return those
- * rules if found, false otherwise.
- *
- * @param string $spec
- * @return array|false
- */
- public function getRules($spec = null)
- {
- if (null !== $spec) {
- $spec = $this->_normalizeSpec($spec);
- if (isset($this->rules[$spec])) {
- return $this->rules[$spec];
- }
- return false;
- }
- return $this->rules;
- }
- /**
- * getRule() returns a rule set by setFilterRule(), a numeric index must be provided
- *
- * @param string $spec
- * @param int $index
- * @return FilterInterface|false
- */
- public function getRule($spec, $index)
- {
- $spec = $this->_normalizeSpec($spec);
- if (isset($this->rules[$spec]) && is_array($this->rules[$spec])) {
- if (isset($this->rules[$spec][$index])) {
- return $this->rules[$spec][$index];
- }
- }
- return false;
- }
- /**
- * ClearRules() clears the rules currently in the inflector
- *
- * @return Inflector
- */
- public function clearRules()
- {
- $this->rules = array();
- return $this;
- }
- /**
- * Set a filtering rule for a spec. $ruleSet can be a string, Filter object
- * or an array of strings or filter objects.
- *
- * @param string $spec
- * @param array|string|\Zend\Filter\FilterInterface $ruleSet
- * @return Inflector
- */
- public function setFilterRule($spec, $ruleSet)
- {
- $spec = $this->_normalizeSpec($spec);
- $this->rules[$spec] = array();
- return $this->addFilterRule($spec, $ruleSet);
- }
- /**
- * Add a filter rule for a spec
- *
- * @param mixed $spec
- * @param mixed $ruleSet
- * @return Inflector
- */
- public function addFilterRule($spec, $ruleSet)
- {
- $spec = $this->_normalizeSpec($spec);
- if (!isset($this->rules[$spec])) {
- $this->rules[$spec] = array();
- }
- if (!is_array($ruleSet)) {
- $ruleSet = array($ruleSet);
- }
- if (is_string($this->rules[$spec])) {
- $temp = $this->rules[$spec];
- $this->rules[$spec] = array();
- $this->rules[$spec][] = $temp;
- }
- foreach ($ruleSet as $rule) {
- $this->rules[$spec][] = $this->_getRule($rule);
- }
- return $this;
- }
- /**
- * Set a static rule for a spec. This is a single string value
- *
- * @param string $name
- * @param string $value
- * @return Inflector
- */
- public function setStaticRule($name, $value)
- {
- $name = $this->_normalizeSpec($name);
- $this->rules[$name] = (string) $value;
- return $this;
- }
- /**
- * Set Static Rule Reference.
- *
- * This allows a consuming class to pass a property or variable
- * in to be referenced when its time to build the output string from the
- * target.
- *
- * @param string $name
- * @param mixed $reference
- * @return Inflector
- */
- public function setStaticRuleReference($name, &$reference)
- {
- $name = $this->_normalizeSpec($name);
- $this->rules[$name] =& $reference;
- return $this;
- }
- /**
- * Inflect
- *
- * @param string|array $source
- * @throws Exception\RuntimeException
- * @return string
- */
- public function filter($source)
- {
- // clean source
- foreach ((array) $source as $sourceName => $sourceValue) {
- $source[ltrim($sourceName, ':')] = $sourceValue;
- }
- $pregQuotedTargetReplacementIdentifier = preg_quote($this->targetReplacementIdentifier, '#');
- $processedParts = array();
- foreach ($this->rules as $ruleName => $ruleValue) {
- if (isset($source[$ruleName])) {
- if (is_string($ruleValue)) {
- // overriding the set rule
- $processedParts['#' . $pregQuotedTargetReplacementIdentifier . $ruleName . '#'] = str_replace('\\', '\\\\', $source[$ruleName]);
- } elseif (is_array($ruleValue)) {
- $processedPart = $source[$ruleName];
- foreach ($ruleValue as $ruleFilter) {
- $processedPart = $ruleFilter($processedPart);
- }
- $processedParts['#' . $pregQuotedTargetReplacementIdentifier . $ruleName . '#'] = str_replace('\\', '\\\\', $processedPart);
- }
- } elseif (is_string($ruleValue)) {
- $processedParts['#' . $pregQuotedTargetReplacementIdentifier . $ruleName . '#'] = str_replace('\\', '\\\\', $ruleValue);
- }
- }
- // all of the values of processedParts would have been str_replace('\\', '\\\\', ..)'d to disable preg_replace backreferences
- $inflectedTarget = preg_replace(array_keys($processedParts), array_values($processedParts), $this->target);
- if ($this->throwTargetExceptionsOn && (preg_match('#(?=' . $pregQuotedTargetReplacementIdentifier.'[A-Za-z]{1})#', $inflectedTarget) == true)) {
- throw new Exception\RuntimeException('A replacement identifier ' . $this->targetReplacementIdentifier . ' was found inside the inflected target, perhaps a rule was not satisfied with a target source? Unsatisfied inflected target: ' . $inflectedTarget);
- }
- return $inflectedTarget;
- }
- /**
- * Normalize spec string
- *
- * @param string $spec
- * @return string
- */
- protected function _normalizeSpec($spec)
- {
- return ltrim((string) $spec, ':&');
- }
- /**
- * Resolve named filters and convert them to filter objects.
- *
- * @param string $rule
- * @return FilterInterface
- */
- protected function _getRule($rule)
- {
- if ($rule instanceof FilterInterface) {
- return $rule;
- }
- $rule = (string) $rule;
- return $this->getPluginManager()->get($rule);
- }
- }