| Fully Qualified Name: | Laminas\Filter\PregReplace |
| Extends: | AbstractFilter |
| Name | Description | Defined By |
|---|---|---|
| __construct() | Constructor Supported options are 'pattern' => matching pattern 'replacement' => replace with this | PregReplace |
| __invoke() | Invoke filter as a command | AbstractFilter |
| filter() | Perform regexp replacement as filter | PregReplace |
| getOptions() | Retrieve options representing object state | AbstractFilter |
| getPattern() | Get currently set match pattern | PregReplace |
| getReplacement() | Get currently set replacement value | PregReplace |
| hasPcreUnicodeSupport() | AbstractFilter | |
| setOptions() | AbstractFilter | |
| setPattern() | Set the regex pattern to search for | PregReplace |
| setReplacement() | Set the replacement array/string | PregReplace |
Constructor Supported options are 'pattern' => matching pattern 'replacement' => replace with this
| Parameter Name | Type | Description |
|---|---|---|
| $options | array|\Traversable|string|null |
Returns:
Invoke filter as a command
Proxies to {@link filter()}
| Parameter Name | Type | Description |
|---|---|---|
| $value | mixed |
Returns: mixed
Perform regexp replacement as filter
| Parameter Name | Type | Description |
|---|---|---|
| $value | mixed |
Returns: mixed
Retrieve options representing object state
Returns: array
Get currently set match pattern
Returns: string|array
Get currently set replacement value
Returns: string|array
Returns: bool
| Parameter Name | Type | Description |
|---|---|---|
| $options | array|\Traversable |
Returns: self
Set the regex pattern to search for
| Parameter Name | Type | Description |
|---|---|---|
| $pattern | string|array | - |
Returns: self
Set the replacement array/string
| Parameter Name | Type | Description |
|---|---|---|
| $replacement | array|string | - |
Returns: self