PHP Class PhpSandbox\SandboxedString

This class wraps sandboxed strings to intercept and check callable invocations
Author: Elijah Horton ([email protected])
Inheritance: implements ArrayAccess, implements IteratorAggregate
Show file Open project: Corveda/PHPSandbox

Public Methods

Method Description
__construct ( string $value, PHPSandbox $sandbox ) Constructs the SandboxedString
__invoke ( ) : mixed | null Checks the string value against the sandbox function whitelists and blacklists for callback violations
__toString ( ) : string Returns the original string value
getIterator ( ) : ArrayIterator Return iterator for string value
offsetExists ( mixed $offset ) : boolean Check if specified offset exists in string value
offsetGet ( mixed $offset ) : string Get string value at specified offset
offsetSet ( mixed $offset, mixed $value ) Set string value at specified offset
offsetUnset ( mixed $offset ) Unset string value at specified offset

Method Details

__construct() public method

Constructs the SandboxedString
public __construct ( string $value, PHPSandbox $sandbox )
$value string Original string value
$sandbox PHPSandbox The current sandbox instance to test against

__invoke() public method

Checks the string value against the sandbox function whitelists and blacklists for callback violations
public __invoke ( ) : mixed | null
return mixed | null

__toString() public method

Returns the original string value
public __toString ( ) : string
return string

getIterator() public method

Return iterator for string value
public getIterator ( ) : ArrayIterator
return ArrayIterator Array iterator to return

offsetExists() public method

Check if specified offset exists in string value
public offsetExists ( mixed $offset ) : boolean
$offset mixed Offset to check
return boolean Return true if offset exists, false otherwise

offsetGet() public method

Get string value at specified offset
public offsetGet ( mixed $offset ) : string
$offset mixed Offset to get value
return string Value to return

offsetSet() public method

Set string value at specified offset
public offsetSet ( mixed $offset, mixed $value )
$offset mixed Offset to set value
$value mixed Value to set

offsetUnset() public method

Unset string value at specified offset
public offsetUnset ( mixed $offset )
$offset mixed Offset to unset