BatchFileRename Libraryv1.0

BatchFileRenameOptions.php at line 253

Class BatchFileRenameOptionsBase

BatchFileRenameOptions
└─BatchFileRenameOptionsBase

public class BatchFileRenameOptionsBase
extends BatchFileRenameOptions

Controles the main BatchFileRename configuration options.

Author:
Mohamed ELkholy
License:
LGPL
Since:
Release: 1.0

Field Summary
protected bool

$multibyteSupport

Enables multibyte specific string functions (requires mbstring).

protected bool

$simulationMode

Enables simulation mode in which no actual file renaming occurs (no change is committed to the filesystem).

Constructor Summary
void

__construct(array options)

Constructor.

Method Summary
protected bool

validateMultibyteSupport(bool optionValue)

Validates the 'multibyteSupport' option.

protected bool

validateSimulationMode(bool optionValue)

Validates the 'simulationMode' option.

Methods inherited from BatchFileRename\BatchFileRenameOptions
__construct, getOption, getOptions, hasValue, isEmptyString, isOption, setOption, setOptions, validateBoolean, validateCallback, validateString

Field Detail

BatchFileRenameOptions.php at line 264

multibyteSupport

protected bool $multibyteSupport = null

Enables multibyte specific string functions (requires mbstring).

# Default value FALSE


BatchFileRenameOptions.php at line 275

simulationMode

protected bool $simulationMode

Enables simulation mode in which no actual file renaming occurs (no change is committed to the filesystem).

# Default value FALSE


Constructor Detail

BatchFileRenameOptions.php at line 284

__construct

public void __construct(array options)

Constructor.

Parameters:
options - Configuration options as an associative array with option names and their values

Method Detail

BatchFileRenameOptions.php at line 301

validateMultibyteSupport

protected bool validateMultibyteSupport(bool optionValue)

Validates the 'multibyteSupport' option.

Throws:
UnexpectedValueException

BatchFileRenameOptions.php at line 324

validateSimulationMode

protected bool validateSimulationMode(bool optionValue)

Validates the 'simulationMode' option.

Throws:
UnexpectedValueException - if the supplied paramater is not a valid boolean value