1. class
  2. Automad
  3. \
  4. UI
  5. \
  6. Models
  7. \
  8. ReplacementModel

ReplacementModel

class ReplacementModel (View source)

The Replacement model.

Properties

private $regexFlags The search regex flags.
private $replaceValue The replace value.
private $searchValue The search value.

Methods

__construct(string $searchValue, string $replaceValue, bool $isRegex, bool $isCaseSensitive)

Initialize a new replacement model.

bool
replaceInFiles(array $fileKeysArray)

Replace matches with a given string in a given list of files.

array
replaceInBlocksRecursively(array $blocks)

Replace matches in block data recursively.

array
replaceInData(array $data, array $keys)

Replace matches in data for a given list of keys.

mixed
replaceInValueRecursively(array|object|string $value)

Replace searched string in a value that is either a string or an multidimensional array of strings.

Details

at line 77
__construct(string $searchValue, string $replaceValue, bool $isRegex, bool $isCaseSensitive)

Initialize a new replacement model.

Parameters

string $searchValue
string $replaceValue
bool $isRegex
bool $isCaseSensitive

at line 99
bool replaceInFiles(array $fileKeysArray)

Replace matches with a given string in a given list of files.

Parameters

array $fileKeysArray

Return Value

bool true on success

See also

FileKeysModel

at line 123
private array replaceInBlocksRecursively(array $blocks)

Replace matches in block data recursively.

Parameters

array $blocks

Return Value

array the processed blocks

at line 144
private array replaceInData(array $data, array $keys)

Replace matches in data for a given list of keys.

Parameters

array $data
array $keys

Return Value

array the processed data array

at line 173
private mixed replaceInValueRecursively(array|object|string $value)

Replace searched string in a value that is either a string or an multidimensional array of strings.

Parameters

array|object|string $value

Return Value

mixed $value