Documentation

StringReplacement
in package
implements FilterInterface

String replacement filter

Tags
category

Pop

author

Chris Corbyn, from the SwiftMailer library https://github.com/swiftmailer/swiftmailer

version
3.6.0

Interfaces, Classes, Traits and Enums

FilterInterface
Stream filter interface

Table of Contents

$replace  : string|array<string|int, mixed>
The replacement(s) to make
$search  : string|array<string|int, mixed>
The needle(s) to search for
__construct()  : mixed
Create a new StringReplacementFilter with $search and $replace
filter()  : string
Perform the actual replacements on $buffer and return the result
shouldBuffer()  : bool
Returns true if based on the buffer passed more bytes should be buffered

Properties

$replace

The replacement(s) to make

private string|array<string|int, mixed> $replace

$search

The needle(s) to search for

private string|array<string|int, mixed> $search

Methods

__construct()

Create a new StringReplacementFilter with $search and $replace

public __construct(string|array<string|int, mixed> $search, string|array<string|int, mixed> $replace) : mixed
Parameters
$search : string|array<string|int, mixed>
$replace : string|array<string|int, mixed>
Return values
mixed —

filter()

Perform the actual replacements on $buffer and return the result

public filter(string $buffer) : string
Parameters
$buffer : string
Return values
string —

shouldBuffer()

Returns true if based on the buffer passed more bytes should be buffered

public shouldBuffer(string $buffer) : bool
Parameters
$buffer : string
Return values
bool —

Search results