Filter/Inflector.php
Show:
inherited
inherited
Classes
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled
with this package in the file LICENSE.txt.
It is also available through the world-wide-web at this URL:
http://framework.zend.com/license/new-bsd
If you did not receive a copy of the license and are unable to
obtain it through the world-wide-web, please send an email
to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Filter
- Version
- $Id$
\Zend_Filter_Inflector
Package: Zend_Filter
Returns
Returns
Returns
Filter chain for string inflection
- Implements
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
\Zend_Loader_PluginLoader_Interface $_pluginLoader = nullDefault value
nullDetailsarray $_rules = array()Default value
array()Details- Type
- array
string $_target = nullDefault value
nullDetails- Type
- string
string $_targetReplacementIdentifier = ':'Default value
':'Details- Type
- string
bool $_throwTargetExceptionsOn = trueDefault value
trueDetails- Type
- bool
Methods
__construct(string | array $options = null) : voidConstructor
Parameters
| Name | Type | Description |
|---|---|---|
| $options | string | array | Options to set |
_getRule(string $rule) : \Zend_Filter_InterfaceResolve named filters and convert them to filter objects.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $rule | string |
| Type | Description |
|---|---|
| \Zend_Filter_Interface |
_normalizeSpec(string $spec) : stringNormalize spec string
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $spec | string |
| Type | Description |
|---|---|
| string |
addFilterPrefixPath(string $prefix, string $path) : \Zend_Filter_InflectorConvienence method to add prefix and path to PluginLoader
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $prefix | string | |
| $path | string |
| Type | Description |
|---|---|
| \Zend_Filter_Inflector |
addFilterRule(mixed $spec, mixed $ruleSet) : voidAdd a filter rule for a spec
Parameters
| Name | Type | Description |
|---|---|---|
| $spec | mixed | |
| $ruleSet | mixed |
addRules( $rules) : \Zend_Filter_InflectorAddRules(): 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| Name | Type | Description |
|---|---|---|
| $rules |
| Type | Description |
|---|---|
| \Zend_Filter_Inflector |
clearRules() : \Zend_Filter_InflectorClearRules() clears the rules currently in the inflector
Returns
| Type | Description |
|---|---|
| \Zend_Filter_Inflector |
filter(string | array $source) : stringInflect
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $source | string | array |
| Type | Description |
|---|---|
| string |
getPluginLoader() : \Zend_Loader_PluginLoader_InterfaceRetreive PluginLoader
Returns
| Type | Description |
|---|---|
| \Zend_Loader_PluginLoader_Interface |
getRule(string $spec, int $index) : \Zend_Filter_Interface | falsegetRule() returns a rule set by setFilterRule(), a numeric index must be provided
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $spec | string | |
| $index | int |
| Type | Description |
|---|---|
| \Zend_Filter_Interface | false |
getRules(string $spec = null) : array | falseGet rules
By default, returns all rules. If a $spec is provided, will return those
rules if found, false otherwise.
Parameters| Name | Type | Description |
|---|---|---|
| $spec | string |
| Type | Description |
|---|---|
| array | false |
getTarget() : stringRetrieve target
Returns
| Type | Description |
|---|---|
| string |
getTargetReplacementIdentifier() : stringGet Target Replacement Identifier
Returns
| Type | Description |
|---|---|
| string |
isThrowTargetExceptionsOn() : boolWill exceptions be thrown?
Returns
| Type | Description |
|---|---|
| bool |
setConfig(\Zend_Config $config) : \Zend_Filter_InflectorUse Zend_Config object to set object state
Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $config | \Zend_Config |
| Type | Description |
|---|---|
| \Zend_Filter_Inflector |
- Deprecated
- Use setOptions() instead
setFilterRule(string $spec, array | string | \Zend_Filter_Interface $ruleSet) : \Zend_Filter_InflectorSet a filtering rule for a spec. $ruleSet can be a string, Filter object or an array of strings or filter objects.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $spec | string | |
| $ruleSet | array | string | \Zend_Filter_Interface |
| Type | Description |
|---|---|
| \Zend_Filter_Inflector |
setOptions(array $options) : \Zend_Filter_InflectorSet options
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $options | array |
| Type | Description |
|---|---|
| \Zend_Filter_Inflector |
setPluginLoader(\Zend_Loader_PluginLoader_Interface $pluginLoader) : \Zend_Filter_InflectorSet PluginLoader
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $pluginLoader | \Zend_Loader_PluginLoader_Interface |
| Type | Description |
|---|---|
| \Zend_Filter_Inflector |
setRules(array $rules) : \Zend_Filter_InflectorSetRules() is the same as calling addRules() with the exception that it clears the rules before adding them.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $rules | array |
| Type | Description |
|---|---|
| \Zend_Filter_Inflector |
setStaticRule(string $name, string $value) : \Zend_Filter_InflectorSet a static rule for a spec. This is a single string value
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $name | string | |
| $value | string |
| Type | Description |
|---|---|
| \Zend_Filter_Inflector |
setStaticRuleReference(string $name, mixed $reference) : \Zend_Filter_InflectorSet 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| Name | Type | Description |
|---|---|---|
| $name | string | |
| $reference | mixed |
| Type | Description |
|---|---|
| \Zend_Filter_Inflector |
setTarget( $target) : \Zend_Filter_InflectorSet a Target ex: 'scripts/:controller/:action.:suffix'
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $target |
| Type | Description |
|---|---|
| \Zend_Filter_Inflector |
setTargetReference(\reference $target) : \Zend_Filter_InflectorSet Target Reference
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $target | \reference |
| Type | Description |
|---|---|
| \Zend_Filter_Inflector |
setTargetReplacementIdentifier(string $targetReplacementIdentifier) : \Zend_Filter_InflectorSet the Target Replacement Identifier, by default ':'
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $targetReplacementIdentifier | string |
| Type | Description |
|---|---|
| \Zend_Filter_Inflector |
setThrowTargetExceptionsOn( $throwTargetExceptionsOn) : \Zend_Filter_InflectorSet Whether or not the inflector should throw an exception when a replacement identifier is still found within an inflected target.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $throwTargetExceptionsOn |
| Type | Description |
|---|---|
| \Zend_Filter_Inflector |