Inheritance diagram for Zend_Filter_Inflector:

Public Member Functions
	__construct ($options=null)

	getPluginLoader ()

	setPluginLoader (Zend_Loader_PluginLoader_Interface $pluginLoader)

	setConfig (Zend_Config $config)

	setOptions ($options)

	addFilterPrefixPath ($prefix, $path)

	setThrowTargetExceptionsOn ($throwTargetExceptionsOn)

	isThrowTargetExceptionsOn ()

	setTargetReplacementIdentifier ($targetReplacementIdentifier)

	getTargetReplacementIdentifier ()

	setTarget ($target)

	getTarget ()

	setTargetReference (&$target)

	setRules (Array $rules)

	addRules (Array $rules)

	getRules ($spec=null)

	getRule ($spec, $index)

	clearRules ()

	setFilterRule ($spec, $ruleSet)

	addFilterRule ($spec, $ruleSet)

	setStaticRule ($name, $value)

	setStaticRuleReference ($name, &$reference)

	filter ($source)

Protected Member Functions
	_normalizeSpec ($spec)

	_getRule ($rule)

Protected Attributes
	$_pluginLoader = null

	$_target = null

	$_throwTargetExceptionsOn = true

	$_targetReplacementIdentifier = ':'

	$_rules = array()

Detailed Description

Definition at line 41 of file Inflector.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( $options = null )

Constructor

Parameters

string | array $options Options to set

Definition at line 73 of file Inflector.php.

     {
         if ($options instanceof Zend_Config) {
             $options = $options->toArray();
         } else 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);
     }

Member Function Documentation

◆ _getRule()

_getRule ( $rule )

protected

Resolve named filters and convert them to filter objects.

Parameters

string $rule

Returns: Zend_Filter_Interface

Definition at line 510 of file Inflector.php.

     {
         if ($rule instanceof Zend_Filter_Interface) {
             return $rule;
         }
 
         $rule = (string) $rule;
 
         $className  = $this->getPluginLoader()->load($rule);
         $ruleObject = new $className();
         if (!$ruleObject instanceof Zend_Filter_Interface) {
             #require_once 'Zend/Filter/Exception.php';
             throw new Zend_Filter_Exception('No class named ' . $rule . ' implementing Zend_Filter_Interface could be found');
         }
 
         return $ruleObject;
     }

◆ _normalizeSpec()

_normalizeSpec ( $spec )

protected

Normalize spec string

Parameters

string $spec

Returns: string

Definition at line 499 of file Inflector.php.

     {
         return ltrim((string) $spec, ':&');
     }

◆ addFilterPrefixPath()

addFilterPrefixPath	(	$prefix,
		$path
	)

Convienence method to add prefix and path to PluginLoader

Parameters

string	$prefix
string	$path

Returns: Zend_Filter_Inflector

Definition at line 187 of file Inflector.php.

     {
         $this->getPluginLoader()->addPrefixPath($prefix, $path);
         return $this;
     }

◆ addFilterRule()

addFilterRule	(	$spec,
		$ruleSet
	)

Add a filter rule for a spec

Parameters

mixed	$spec
mixed	$ruleSet

Returns: void

Definition at line 393 of file Inflector.php.

     {
         $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;
     }

◆ addRules()

addRules ( Array $rules )

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' );

Parameters

array

Returns: Zend_Filter_Inflector

Definition at line 306 of file Inflector.php.

     {
         $keys = array_keys($rules);
         foreach ($keys as $spec) {
             if ($spec[0] == ':') {
                 $this->addFilterRule($spec, $rules[$spec]);
             } else {
                 $this->setStaticRule($spec, $rules[$spec]);
             }
         }
 
         return $this;
     }

◆ clearRules()

clearRules ( )

ClearRules() clears the rules currently in the inflector

Returns: Zend_Filter_Inflector

Definition at line 365 of file Inflector.php.

     {
         $this->_rules = array();
         return $this;
     }

◆ filter()

filter ( $source )

Inflect

Parameters

string | array $source

Returns: string

Implements Zend_Filter_Interface.

Definition at line 455 of file Inflector.php.

     {
         // 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->filter($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)) {
             #require_once 'Zend/Filter/Exception.php';
             throw new Zend_Filter_Exception('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;
     }

◆ getPluginLoader()

getPluginLoader ( )

Retreive PluginLoader

Returns: Zend_Loader_PluginLoader_Interface

Definition at line 108 of file Inflector.php.

     {
         if (!$this->_pluginLoader instanceof Zend_Loader_PluginLoader_Interface) {
             $this->_pluginLoader = new Zend_Loader_PluginLoader(array('Zend_Filter_' => 'Zend/Filter/'), __CLASS__);
         }
 
         return $this->_pluginLoader;
     }

◆ getRule()

getRule	(	$spec,
		$index
	)

getRule() returns a rule set by setFilterRule(), a numeric index must be provided

Parameters

string	$spec
int	$index

Returns: Zend_Filter_Interface|false

Definition at line 349 of file Inflector.php.

     {
         $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;
     }

◆ getRules()

getRules ( $spec = null )

Get rules

By default, returns all rules. If a $spec is provided, will return those rules if found, false otherwise.

Parameters

string $spec

Returns: array|false

Definition at line 329 of file Inflector.php.

     {
         if (null !== $spec) {
             $spec = $this->_normalizeSpec($spec);
             if (isset($this->_rules[$spec])) {
                 return $this->_rules[$spec];
             }
             return false;
         }
 
         return $this->_rules;
     }

◆ getTarget()

getTarget ( )

Retrieve target

Returns: string

Definition at line 259 of file Inflector.php.

     {
         return $this->_target;
     }

◆ getTargetReplacementIdentifier()

getTargetReplacementIdentifier ( )

Get Target Replacement Identifier

Returns: string

Definition at line 236 of file Inflector.php.

     {
         return $this->_targetReplacementIdentifier;
     }

◆ isThrowTargetExceptionsOn()

isThrowTargetExceptionsOn ( )

Will exceptions be thrown?

Returns: bool

Definition at line 211 of file Inflector.php.

     {
         return $this->_throwTargetExceptionsOn;
     }

◆ setConfig()

setConfig ( Zend_Config $config )

Use Zend_Config object to set object state

Deprecated:: Use setOptions() instead

Parameters

Zend_Config $config

Returns: Zend_Filter_Inflector

Definition at line 136 of file Inflector.php.

     {
         return $this->setOptions($config);
     }

◆ setFilterRule()

setFilterRule	(	$spec,
		$ruleSet
	)

Set a filtering rule for a spec. $ruleSet can be a string, Filter object or an array of strings or filter objects.

Parameters

string	$spec
array \| string \| Zend_Filter_Interface	$ruleSet

Returns: Zend_Filter_Inflector

Definition at line 379 of file Inflector.php.

     {
         $spec = $this->_normalizeSpec($spec);
         $this->_rules[$spec] = array();
         return $this->addFilterRule($spec, $ruleSet);
     }

◆ setOptions()

setOptions ( $options )

Set options

Parameters

array $options

Returns: Zend_Filter_Inflector

Definition at line 147 of file Inflector.php.

                                          {
         if ($options instanceof Zend_Config) {
             $options = $options->toArray();
         }
 
         // Set Präfix Path
         if (array_key_exists('filterPrefixPath', $options)) {
             if (!is_scalar($options['filterPrefixPath'])) {
                 foreach ($options['filterPrefixPath'] as $prefix => $path) {
                     $this->addFilterPrefixPath($prefix, $path);
                 }
             }
         }
 
         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;
     }

◆ setPluginLoader()

setPluginLoader ( Zend_Loader_PluginLoader_Interface $pluginLoader )

Set PluginLoader

Parameters

Zend_Loader_PluginLoader_Interface $pluginLoader

Returns: Zend_Filter_Inflector

Definition at line 123 of file Inflector.php.

     {
         $this->_pluginLoader = $pluginLoader;
         return $this;
     }

◆ setRules()

setRules ( Array $rules )

SetRules() is the same as calling addRules() with the exception that it clears the rules before adding them.

Parameters

array $rules

Returns: Zend_Filter_Inflector

Definition at line 283 of file Inflector.php.

     {
         $this->clearRules();
         $this->addRules($rules);
         return $this;
     }

◆ setStaticRule()

setStaticRule	(	$name,
		$value
	)

Set a static rule for a spec. This is a single string value

Parameters

string	$name
string	$value

Returns: Zend_Filter_Inflector

Definition at line 424 of file Inflector.php.

     {
         $name = $this->_normalizeSpec($name);
         $this->_rules[$name] = (string) $value;
         return $this;
     }

◆ setStaticRuleReference()

setStaticRuleReference	(		$name,
		&	$reference
	)

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.

Parameters

string	$name
mixed	$reference

Returns: Zend_Filter_Inflector

Definition at line 442 of file Inflector.php.

     {
         $name = $this->_normalizeSpec($name);
         $this->_rules[$name] =& $reference;
         return $this;
     }

◆ setTarget()

setTarget ( $target )

Set a Target ex: 'scripts/:controller/:action.:suffix'

Parameters

string

Returns: Zend_Filter_Inflector

Definition at line 248 of file Inflector.php.

     {
         $this->_target = (string) $target;
         return $this;
     }

◆ setTargetReference()

setTargetReference ( & $target )

Set Target Reference

Parameters

reference $target

Returns: Zend_Filter_Inflector

Definition at line 270 of file Inflector.php.

     {
         $this->_target =& $target;
         return $this;
     }

◆ setTargetReplacementIdentifier()

setTargetReplacementIdentifier ( $targetReplacementIdentifier )

Set the Target Replacement Identifier, by default ':'

Parameters

string $targetReplacementIdentifier

Returns: Zend_Filter_Inflector

Definition at line 222 of file Inflector.php.

     {
         if ($targetReplacementIdentifier) {
             $this->_targetReplacementIdentifier = (string) $targetReplacementIdentifier;
         }
 
         return $this;
     }

◆ setThrowTargetExceptionsOn()

setThrowTargetExceptionsOn ( $throwTargetExceptionsOn )

Set Whether or not the inflector should throw an exception when a replacement identifier is still found within an inflected target.

Parameters

bool $throwTargetExceptions

Returns: Zend_Filter_Inflector

Definition at line 200 of file Inflector.php.

     {
         $this->_throwTargetExceptionsOn = ($throwTargetExceptionsOn == true) ? true : false;
         return $this;
     }

Field Documentation

◆ $_pluginLoader

$_pluginLoader = null

protected

Definition at line 46 of file Inflector.php.

◆ $_rules

$_rules = array()

protected

Definition at line 66 of file Inflector.php.

◆ $_target

$_target = null

protected

Definition at line 51 of file Inflector.php.

◆ $_targetReplacementIdentifier

$_targetReplacementIdentifier = ':'

protected

Definition at line 61 of file Inflector.php.

◆ $_throwTargetExceptionsOn

$_throwTargetExceptionsOn = true

protected

Definition at line 56 of file Inflector.php.

The documentation for this class was generated from the following file:

vendor/magento/zendframework1/library/Zend/Filter/Inflector.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getRule()

◆ _normalizeSpec()

◆ addFilterPrefixPath()

◆ addFilterRule()

◆ addRules()

◆ clearRules()

◆ filter()

◆ getPluginLoader()

◆ getRule()

◆ getRules()

◆ getTarget()

◆ getTargetReplacementIdentifier()

◆ isThrowTargetExceptionsOn()

◆ setConfig()

◆ setFilterRule()

◆ setOptions()

◆ setPluginLoader()

◆ setRules()

◆ setStaticRule()

◆ setStaticRuleReference()

◆ setTarget()

◆ setTargetReference()

◆ setTargetReplacementIdentifier()

◆ setThrowTargetExceptionsOn()

Field Documentation

◆ $_pluginLoader

◆ $_rules

◆ $_target

◆ $_targetReplacementIdentifier

◆ $_throwTargetExceptionsOn