\PHPSandboxPHPSandbox

__construct()

__construct(array  $options = array(), array  $functions = array(), array  $variables = array(), array  $constants = array(), array  $namespaces = array(), array  $aliases = array(), array  $superglobals = array(), array  $magic_constants = array(), array  $classes = array(), array  $interfaces = array(), array  $traits = array()) 

PHPSandbox class constructor

Parameters

Examples

= new PHPSandbox\PHPSandbox; You can pass optional arrays of predefined functions, variables, etc. to the sandbox through the constructor

** File not found : $sandbox **

create()

create(array  $options = array(), array  $functions = array(), array  $variables = array(), array  $constants = array(), array  $namespaces = array(), array  $aliases = array(), array  $superglobals = array(), array  $magic_constants = array(), array  $classes = array(), array  $interfaces = array(), array  $traits = array()) : $this

PHPSandbox static factory method

You can pass optional arrays of predefined functions, variables, etc. to the sandbox through the constructor

Parameters

Returns

The returned PHPSandbox variable

Examples

= PHPSandbox\PHPSandbox::create();

** File not found : $sandbox **

__invoke()

__invoke(\Closure|callable|string  $code) : mixed

PHPSandbox __invoke magic method

Besides the code or closure to be executed, you can also pass additional arguments that will overwrite the default values of their respective arguments defined in the code

Parameters

Returns

The output of the executed sandboxed code

Examples

= new PHPSandbox\PHPSandbox; $sandbox(function(){ echo 'Hello world!'; });

** File not found : $sandbox **

__sleep()

__sleep() : array

PHPSandbox __sleep magic method

Returns

An array of property keys to be serialized

Examples

= new PHPSandbox\PHPSandbox; serialize($sandbox);

** File not found : $sandbox **

__wakeup()

__wakeup() 

PHPSandbox __wakeup magic method

Examples

= unserialize($sandbox_string);

** File not found : $sandbox **

import()

import(array|string  $template, integer  $import_flag) : $this

Import JSON template into sandbox

Parameters

Throws

\PHPSandbox\Error

Throws exception if JSON template could not be imported

Returns

Returns the PHPSandbox instance for fluent querying

Examples

=> 'echo "Hello World!";']);

** File not found : $sandbox->import(['code' **

** File not found : $sandbox->import(file_get_contents("template.json")); **

importJSON()

importJSON(array|string  $template, integer  $import_flag) : $this

Import JSON template into sandbox

Parameters

Throws

\PHPSandbox\Error

Throws exception if JSON template could not be imported

Returns

Returns the PHPSandbox instance for fluent querying

Examples

=> 'echo "Hello World!";']);

** File not found : $sandbox->importJSON(['code' **

** File not found : $sandbox->importJSON(file_get_contents("template.json")); **

getName()

getName() : string

Get name of PHPSandbox variable

Returns

The name of the PHPSandbox variable

setOption()

setOption(string|array  $option, boolean|integer|null  $value = null) : $this

Set PHPSandbox option

You can pass an $option name to set to $value, an array of $option names to set to $value, or an associative array of $option names and their values to set.

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

=> true]);

** File not found : $sandbox->setOption(['allow_functions' **

'allow_classes'], true);

** File not found : $sandbox->setOption(['allow_functions', **

true);

** File not found : $sandbox->setOption('allow_functions', **

setOptions()

setOptions(array|string  $options, boolean|integer|null  $value = null) : $this

Set PHPSandbox options by array

You can pass an array of option names to set to $value, or an associative array of option names and their values to set.

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

=> true]);

** File not found : $sandbox->setOption(['allow_functions' **

'allow_classes'], true);

** File not found : $sandbox->setOption(['allow_functions', **

resetOptions()

resetOptions() : $this

Reset PHPSandbox options to their default values

Returns

Returns the PHPSandbox instance for fluent querying

Examples

** File not found : $sandbox->resetOptions(); **

getOption()

getOption(string  $option) : boolean|integer|null

Get PHPSandbox option

You pass a string $option name to get its associated value

Parameters

Returns

Returns the value of the requested option

Examples

** File not found : $sandbox->getOption('allow_functions'); **

setValidator()

setValidator(string  $type, callable  $callable) : \PHPSandbox\PHPSandbox

Set validation callable for specified $type

Validator callable must accept two parameters: a string of the normalized name of the checked element, and the PHPSandbox instance

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

function($function, PHPSandbox $sandbox){ return true; });

** File not found : $sandbox->setValidator('function', **

getValidator()

getValidator(string  $type) : callable|null

Get validation callable for specified $type

Parameters

Returns

Examples

//return callable

** File not found : $sandbox->getValidator('function'); **

unsetValidator()

unsetValidator(string  $type) : \PHPSandbox\PHPSandbox

Unset validation callable for specified $type

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

//clear custom validation

** File not found : $sandbox->unsetValidator('function'); **

setFuncValidator()

setFuncValidator(callable  $callable) : \PHPSandbox\PHPSandbox

Set validation callable for functions

Validator callable must accept two parameters: a string of the normalized name of the checked element, and the PHPSandbox instance. NOTE: Normalized function names include the namespace and are lowercase!

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

PHPSandbox $sandbox){ return true; });

** File not found : $sandbox->setFuncValidator(function($function, **

getFuncValidator()

getFuncValidator() : callable|null

Get validation for functions

Returns

Examples

//return callable

** File not found : $sandbox->getFuncValidator(); **

unsetFuncValidator()

unsetFuncValidator() : \PHPSandbox\PHPSandbox

Unset validation callable for functions

Returns

Returns the PHPSandbox instance for fluent querying

Examples

//clear custom validation

** File not found : $sandbox->unsetFuncValidator(); **

setVarValidator()

setVarValidator(callable  $callable) : \PHPSandbox\PHPSandbox

Set validation callable for variables

Validator callable must accept two parameters: a string of the normalized name of the checked element, and the PHPSandbox instance

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

PHPSandbox $sandbox){ return true; });

** File not found : $sandbox->setVarValidator(function($variable, **

getVarValidator()

getVarValidator() : callable|null

Get validation callable for variables

Returns

Examples

//return callable

** File not found : $sandbox->getVarValidator(); **

unsetVarValidator()

unsetVarValidator() : \PHPSandbox\PHPSandbox

Unset validation callable for variables

Returns

Returns the PHPSandbox instance for fluent querying

Examples

//clear custom validation

** File not found : $sandbox->unsetVarValidator(); **

setGlobalValidator()

setGlobalValidator(callable  $callable) : \PHPSandbox\PHPSandbox

Set validation callable for globals

Validator callable must accept two parameters: a string of the normalized name of the checked element, and the PHPSandbox instance

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

PHPSandbox $sandbox){ return true; });

** File not found : $sandbox->setGlobalValidator(function($global, **

getGlobalValidator()

getGlobalValidator() : callable|null

Get validation callable for globals

Returns

Examples

//return callable

** File not found : $sandbox->getGlobalValidator(); **

unsetGlobalValidator()

unsetGlobalValidator() : \PHPSandbox\PHPSandbox

Unset validation callable for globals

Returns

Returns the PHPSandbox instance for fluent querying

Examples

//clear custom validation

** File not found : $sandbox->unsetGlobalValidator(); **

setSuperglobalValidator()

setSuperglobalValidator(callable  $callable) : \PHPSandbox\PHPSandbox

Set validation callable for superglobals

Validator callable must accept two parameters: a string of the normalized name of the checked element, and the PHPSandbox instance. NOTE: Normalized superglobal names are uppercase and without a leading _

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

PHPSandbox $sandbox){ return true; });

** File not found : $sandbox->setSuperglobalValidator(function($superglobal, **

getSuperglobalValidator()

getSuperglobalValidator() : callable|null

Get validation callable for superglobals

Returns

Examples

//return callable

** File not found : $sandbox->getSuperglobalValidator(); **

unsetSuperglobalValidator()

unsetSuperglobalValidator() : \PHPSandbox\PHPSandbox

Unset validation callable for superglobals

Returns

Returns the PHPSandbox instance for fluent querying

Examples

//clear custom validation

** File not found : $sandbox->unsetSuperglobalValidator(); **

setConstValidator()

setConstValidator(callable  $callable) : \PHPSandbox\PHPSandbox

Set validation callable for constants

Validator callable must accept two parameters: a string of the normalized name of the checked element, and the PHPSandbox instance

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

PHPSandbox $sandbox){ return true; });

** File not found : $sandbox->setConstValidator(function($constant, **

getConstValidator()

getConstValidator() : callable|null

Get validation callable for constants

Returns

Examples

//return callable

** File not found : $sandbox->getConstValidator(); **

unsetConstValidator()

unsetConstValidator() : \PHPSandbox\PHPSandbox

Unset validation callable for constants

Returns

Returns the PHPSandbox instance for fluent querying

Examples

//clear custom validation

** File not found : $sandbox->unsetConstValidator(); **

setMagicConstValidator()

setMagicConstValidator(callable  $callable) : \PHPSandbox\PHPSandbox

Set validation callable for magic constants

Validator callable must accept two parameters: a string of the normalized name of the checked element, and the PHPSandbox instance. NOTE: Normalized magic constant names are upper case and trimmed of __

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

PHPSandbox $sandbox){ return true; });

** File not found : $sandbox->setMagicConstValidator(function($magic_constant, **

getMagicConstValidator()

getMagicConstValidator() : callable|null

Get validation callable for magic constants

Returns

Examples

//return callable

** File not found : $sandbox->getMagicConstValidator(); **

unsetMagicConstValidator()

unsetMagicConstValidator() : \PHPSandbox\PHPSandbox

Unset validation callable for magic constants

Returns

Returns the PHPSandbox instance for fluent querying

Examples

//clear custom validation

** File not found : $sandbox->unsetMagicConstValidator(); **

setNamespaceValidator()

setNamespaceValidator(callable  $callable) : \PHPSandbox\PHPSandbox

Set validation callable for namespaces

Validator callable must accept two parameters: a string of the normalized name of the checked element, and the PHPSandbox instance

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

PHPSandbox $sandbox){ return true; });

** File not found : $sandbox->setNamespaceValidator(function($namespace, **

getNamespaceValidator()

getNamespaceValidator() : callable|null

Get validation callable for namespaces

Returns

Examples

//return callable

** File not found : $sandbox->getNamespaceValidator(); **

unsetNamespaceValidator()

unsetNamespaceValidator() : \PHPSandbox\PHPSandbox

Unset validation callable for namespaces

Returns

Returns the PHPSandbox instance for fluent querying

Examples

//clear custom validation

** File not found : $sandbox->unsetNamespaceValidator(); **

setAliasValidator()

setAliasValidator(callable  $callable) : \PHPSandbox\PHPSandbox

Set validation callable for aliases

Validator callable must accept two parameters: a string of the normalized name of the checked element, and the PHPSandbox instance

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

PHPSandbox $sandbox){ return true; });

** File not found : $sandbox->setAliasValidator(function($alias, **

getAliasValidator()

getAliasValidator() : callable|null

Get validation callable for aliases

Returns

Examples

//return callable

** File not found : $sandbox->getAliasValidator(); **

unsetAliasValidator()

unsetAliasValidator() : \PHPSandbox\PHPSandbox

Unset validation callable for aliases

Returns

Returns the PHPSandbox instance for fluent querying

Examples

//clear custom validation

** File not found : $sandbox->unsetAliasValidator(); **

setUseValidator()

setUseValidator(callable  $callable) : \PHPSandbox\PHPSandbox

Set validation callable for uses (aka aliases)

Validator callable must accept two parameters: a string of the normalized name of the checked element, and the PHPSandbox instance

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

PHPSandbox $sandbox){ return true; });

** File not found : $sandbox->setUseValidator(function($use, **

getUseValidator()

getUseValidator() : callable|null

Get validation callable for uses (aka aliases)

Returns

Examples

//return callable

** File not found : $sandbox->getUseValidator(); **

unsetUseValidator()

unsetUseValidator() : \PHPSandbox\PHPSandbox

Unset validation callable for uses (aka aliases)

Returns

Returns the PHPSandbox instance for fluent querying

Examples

//clear custom validation

** File not found : $sandbox->unsetUseValidator(); **

setClassValidator()

setClassValidator(callable  $callable) : \PHPSandbox\PHPSandbox

Set validation callable for classes

Validator callable must accept two parameters: a string of the normalized name of the checked element, and the PHPSandbox instance. NOTE: Normalized class names are lowercase

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

PHPSandbox $sandbox){ return true; });

** File not found : $sandbox->setClassValidator(function($class, **

getClassValidator()

getClassValidator() : callable|null

Get validation callable for classes

Returns

Examples

//return callable

** File not found : $sandbox->getClassValidator(); **

unsetClassValidator()

unsetClassValidator() : \PHPSandbox\PHPSandbox

Unset validation callable for classes

Returns

Returns the PHPSandbox instance for fluent querying

Examples

//clear custom validation

** File not found : $sandbox->unsetClassValidator(); **

setInterfaceValidator()

setInterfaceValidator(callable  $callable) : \PHPSandbox\PHPSandbox

Set validation callable for interfaces

Validator callable must accept two parameters: a string of the normalized name of the checked element, and the PHPSandbox instance. NOTE: Normalized interface names are lowercase

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

PHPSandbox $sandbox){ return true; });

** File not found : $sandbox->setInterfaceValidator(function($interface, **

getInterfaceValidator()

getInterfaceValidator() : callable|null

Get validation callable for interfaces

Returns

Examples

//return callable

** File not found : $sandbox->getInterfaceValidator(); **

unsetInterfaceValidator()

unsetInterfaceValidator() : \PHPSandbox\PHPSandbox

Unset validation callable for interfaces

Returns

Returns the PHPSandbox instance for fluent querying

Examples

//clear custom validation

** File not found : $sandbox->unsetInterfaceValidator(); **

setTraitValidator()

setTraitValidator(callable  $callable) : \PHPSandbox\PHPSandbox

Set validation callable for traits

Validator callable must accept two parameters: a string of the normalized name of the checked element, and the PHPSandbox instance. NOTE: Normalized trait names are lowercase

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

PHPSandbox $sandbox){ return true; });

** File not found : $sandbox->setTraitValidator(function($trait, **

getTraitValidator()

getTraitValidator() : callable|null

Get validation callable for traits

Returns

Examples

//return callable

** File not found : $sandbox->getTraitValidator(); **

unsetTraitValidator()

unsetTraitValidator() : \PHPSandbox\PHPSandbox

Unset validation callable for traits

Returns

Returns the PHPSandbox instance for fluent querying

Examples

//clear custom validation

** File not found : $sandbox->unsetTraitValidator(); **

setKeywordValidator()

setKeywordValidator(callable  $callable) : \PHPSandbox\PHPSandbox

Set validation callable for keywords

Validator callable must accept two parameters: a string of the normalized name of the checked element, and the PHPSandbox instance

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

PHPSandbox $sandbox){ return true; });

** File not found : $sandbox->setKeywordValidator(function($keyword, **

getKeywordValidator()

getKeywordValidator() : callable|null

Get validation callable for keywords

Returns

Examples

//return callable

** File not found : $sandbox->getKeywordValidator(); **

unsetKeywordValidator()

unsetKeywordValidator() : \PHPSandbox\PHPSandbox

Unset validation callable for keywords

Returns

Returns the PHPSandbox instance for fluent querying

Examples

//clear custom validation

** File not found : $sandbox->unsetKeywordValidator(); **

setOperatorValidator()

setOperatorValidator(callable  $callable) : \PHPSandbox\PHPSandbox

Set validation callable for operators

Validator callable must accept two parameters: a string of the normalized name of the checked element, and the PHPSandbox instance

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

PHPSandbox $sandbox){ return true; });

** File not found : $sandbox->setOperatorValidator(function($operator, **

getOperatorValidator()

getOperatorValidator() : callable|null

Get validation callable for operators

Returns

Examples

//return callable

** File not found : $sandbox->getOperatorValidator(); **

unsetOperatorValidator()

unsetOperatorValidator() : \PHPSandbox\PHPSandbox

Unset validation callable for operators

Returns

Returns the PHPSandbox instance for fluent querying

Examples

//clear custom validation

** File not found : $sandbox->unsetOperatorValidator(); **

setPrimitiveValidator()

setPrimitiveValidator(callable  $callable) : \PHPSandbox\PHPSandbox

Set validation callable for primitives

Validator callable must accept two parameters: a string of the normalized name of the checked element, and the PHPSandbox instance

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

PHPSandbox $sandbox){ return true; });

** File not found : $sandbox->setPrimitiveValidator(function($primitive, **

getPrimitiveValidator()

getPrimitiveValidator() : callable|null

Get validation callable for primitives

Returns

Examples

//return callable

** File not found : $sandbox->getPrimitiveValidator(); **

unsetPrimitiveValidator()

unsetPrimitiveValidator() : \PHPSandbox\PHPSandbox

Unset validation callable for primitives

Returns

Returns the PHPSandbox instance for fluent querying

Examples

//clear custom validation

** File not found : $sandbox->unsetPrimitiveValidator(); **

setTypeValidator()

setTypeValidator(callable  $callable) : \PHPSandbox\PHPSandbox

Set validation callable for types

Validator callable must accept two parameters: a string of the normalized name of the checked element, and the PHPSandbox instance

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

PHPSandbox $sandbox){ return true; });

** File not found : $sandbox->setTypeValidator(function($type, **

getTypeValidator()

getTypeValidator() : callable|null

Get validation callable for types

Returns

Examples

//return callable

** File not found : $sandbox->getTypeValidator(); **

unsetTypeValidator()

unsetTypeValidator() : $this

Unset validation callable for types

Returns

Returns the PHPSandbox instance for fluent querying

Examples

//clear custom validation

** File not found : $sandbox->unsetTypeValidator(); **

setPrependedCode()

setPrependedCode(string  $prepended_code = '') : $this

Set PHPSandbox prepended code

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

setAppendedCode()

setAppendedCode(string  $appended_code = '') : $this

Set PHPSandbox appended code

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

setPreparsedCode()

setPreparsedCode(string  $preparsed_code = '') : $this

Set PHPSandbox preparsed code

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

setParsedAST()

setParsedAST(array  $parsed_ast = array()) : $this

Set PHPSandbox parsed AST array

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

setPreparedCode()

setPreparedCode(string  $prepared_code = '') : $this

Set PHPSandbox prepared code

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

setPreparedAST()

setPreparedAST(array  $prepared_ast = array()) : $this

Set PHPSandbox prepared AST array

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

setGeneratedCode()

setGeneratedCode(string  $generated_code = '') : $this

Set PHPSandbox generated code

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

setCode()

setCode(string  $generated_code = '') : $this

Set PHPSandbox generated code

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

getPrependedCode()

getPrependedCode() : string

Get PHPSandbox prepended code

Returns

Returns a string of the prepended code

getAppendedCode()

getAppendedCode() : string

Get PHPSandbox appended code

Returns

Returns a string of the appended code

getPreparsedCode()

getPreparsedCode() : string

Get PHPSandbox preparsed code

Returns

Returns a string of the preparsed code

getParsedAST()

getParsedAST() : array

Get PHPSandbox parsed AST array

Returns

Returns an array of the parsed AST code

getPreparedCode()

getPreparedCode() : string

Get PHPSandbox prepared code

Returns

Returns a string of the prepared code

getPreparedAST()

getPreparedAST() : array

Get PHPSandbox prepared AST array

Returns

Returns an array of the prepared AST code

getGeneratedCode()

getGeneratedCode() : string

Get PHPSandbox generated code

Returns

Returns a string of the generated code

getCode()

getCode() : string

Get PHPSandbox generated code

Returns

Returns a string of the generated code

_get_defined_functions()

_get_defined_functions(array  $functions = array()) : array

Get PHPSandbox redefined functions in place of get_defined_functions(). This is an internal PHPSandbox function but requires public access to work.

Parameters

Returns

Returns the redefined functions array

_get_defined_vars()

_get_defined_vars(array  $variables = array()) : array

Get PHPSandbox redefined variables in place of get_defined_vars(). This is an internal PHPSandbox function but requires public access to work.

Parameters

Returns

Returns the redefined variables array

_get_superglobal()

_get_superglobal(string  $name) : array

Get PHPSandbox redefined superglobal. This is an internal PHPSandbox function but requires public access to work.

Parameters

Returns

Returns the redefined superglobal

_get_magic_const()

_get_magic_const(string  $name) : array

Get PHPSandbox redefined magic constant. This is an internal PHPSandbox function but requires public access to work.

Parameters

Returns

Returns the redefined magic constant

_get_defined_constants()

_get_defined_constants(array  $constants = array()) : array

Get PHPSandbox redefined constants in place of get_defined_constants(). This is an internal PHPSandbox function but requires public access to work.

Parameters

Returns

Returns the redefined constants

_get_declared_classes()

_get_declared_classes(array  $classes = array()) : array

Get PHPSandbox redefined classes in place of get_declared_classes(). This is an internal PHPSandbox function but requires public access to work.

Parameters

Returns

Returns the redefined classes

_get_declared_interfaces()

_get_declared_interfaces(array  $interfaces = array()) : array

Get PHPSandbox redefined interfaces in place of get_declared_interfaces(). This is an internal PHPSandbox function but requires public access to work.

Parameters

Returns

Returns the redefined interfaces

_get_declared_traits()

_get_declared_traits(array  $traits = array()) : array

Get PHPSandbox redefined traits in place of get_declared_traits(). This is an internal PHPSandbox function but requires public access to work.

Parameters

Returns

Returns the redefined traits

_func_get_args()

_func_get_args(array  $arguments = array()) : array

Get PHPSandbox redefined function arguments array

Parameters

Returns

Returns the redefined arguments array

_func_get_arg()

_func_get_arg(array  $arguments = array(), integer  $index) : array

Get PHPSandbox redefined function argument

Parameters

Returns

Returns the redefined argument

_func_num_args()

_func_num_args(array  $arguments = array()) : integer

Get PHPSandbox redefined number of function arguments

Parameters

Returns

Returns the redefined number of function arguments

_var_dump()

_var_dump() : array

Get PHPSandbox redefined var_dump

Returns

Returns the redefined var_dump

_print_r()

_print_r() : array

Get PHPSandbox redefined print_r

Returns

Returns the redefined print_r

_var_export()

_var_export() : array

Get PHPSandbox redefined var_export

Returns

Returns the redefined var_export

_intval()

_intval(mixed  $value) : integer

Return integer value of SandboxedString or mixed value

Parameters

Returns

Returns the integer value

_floatval()

_floatval(mixed  $value) : float

Return float value of SandboxedString or mixed value

Parameters

Returns

Returns the float value

_boolval()

_boolval(mixed  $value) : boolean

Return boolean value of SandboxedString or mixed value

Parameters

Returns

Returns the boolean value

_arrayval()

_arrayval(mixed  $value) : array

Return array value of SandboxedString or mixed value

Parameters

Returns

Returns the array value

_objectval()

_objectval(mixed  $value) : object

Return object value of SandboxedString or mixed value

Parameters

Returns

Returns the object value

_is_string()

_is_string(mixed  $value) : boolean

Return is_string value of SandboxedString or mixed value

Parameters

Returns

Returns the is_string value

_is_object()

_is_object(mixed  $value) : boolean

Return is_object value of SandboxedString or mixed value

Parameters

Returns

Returns the is_object value

_is_scalar()

_is_scalar(mixed  $value) : boolean

Return is_scalar value of SandboxedString or mixed value

Parameters

Returns

Returns the is_scalar value

_is_callable()

_is_callable(mixed  $value) : boolean

Return is_callable value of SandboxedString or mixed value

Parameters

Returns

Returns the is_callable value

_get_included_files()

_get_included_files() : array

Return get_included_files() and sandboxed included files

Returns

Returns array of get_included_files() and sandboxed included files

_include()

_include(string  $file) : mixed

Sandbox included file

Parameters

Returns

Returns value passed from included file

_include_once()

_include_once(string  $file) : mixed

Sandbox included once file

Parameters

Returns

Returns value passed from included once file

_require()

_require(string  $file) : mixed

Sandbox required file

Parameters

Returns

Returns value passed from required file

_require_once()

_require_once(string  $file) : mixed

Sandbox required once file

Parameters

Returns

Returns value passed from required once file

call_func()

call_func() : mixed

Get PHPSandbox redefined function. This is an internal PHPSandbox function but requires public access to work.

Throws

\PHPSandbox\Error

Will throw exception if invalid function requested

Returns

Returns the redefined function result

define()

define(string|array  $type, string|array|null  $name = null, mixed|null  $value = null) : $this

Define PHPSandbox definitions, such as functions, constants, namespaces, etc.

You can pass a string of the $type, $name and $value, or pass an associative array of definitions types and an associative array of their corresponding values

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

'test', function(){ echo 'test'; });

** File not found : $sandbox->define('functions', **

=> ['test' => function(){ echo 'test'; }]]);

** File not found : $sandbox->define(['functions' **

undefine()

undefine(string|array  $type, string|array  $name = null) : $this

Undefine PHPSandbox definitions, such as functions, constants, namespaces, etc.

You can pass a string of the $type and $name to undefine, or pass an associative array of definitions types and an array of key names to undefine

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

'test');

** File not found : $sandbox->undefine('functions', **

=> ['test']]);

** File not found : $sandbox->undefine(['functions' **

defineFunc()

defineFunc(string|array  $name, callable  $function, boolean  $pass_sandbox = false) : $this

Define PHPSandbox function

You can pass the function $name and $function closure or callable to define, or an associative array of functions to define, which can have callable values or arrays of the function callable and $pass_sandbox flag

Parameters

Throws

\PHPSandbox\Error

Throws exception if unnamed or uncallable $function is defined

Returns

Returns the PHPSandbox instance for fluent querying

Examples

function(){ echo 'test'; });

** File not found : $sandbox->defineFunc('test', **

=> function(){ echo 'test'; }]]);

** File not found : $sandbox->defineFunc(['test' **

=> [function(){ echo 'test'; }, true]]);

** File not found : $sandbox->defineFunc(['test' **

defineFuncs()

defineFuncs(array  $functions = array()) : $this

Define PHPSandbox functions by array

You can pass an associative array of functions to define

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

=> function(){ echo 'test'; }]);

** File not found : $sandbox->defineFuncs(['test' **

hasDefinedFuncs()

hasDefinedFuncs() : integer

Query whether PHPSandbox instance has defined functions

Returns

Returns the number of functions this instance has defined

Examples

//returns number of defined functions, or zero if none defined

** File not found : $sandbox->hasDefinedFuncs(); **

isDefinedFunc()

isDefinedFunc(string  $name) : boolean

Check if PHPSandbox instance has $name function defined

Parameters

Returns

Returns true if PHPSandbox instance has defined function, false otherwise

Examples

** File not found : $sandbox->isDefinedFunc('test'); **

undefineFunc()

undefineFunc(string|array  $name) : $this

Undefine PHPSandbox function

You can pass a string of function $name to undefine, or pass an array of function names to undefine

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

** File not found : $sandbox->undefineFunc('test'); **

'test2']);

** File not found : $sandbox->undefineFunc(['test', **

undefineFuncs()

undefineFuncs(array  $functions = array()) : $this

Undefine PHPSandbox functions by array

You can pass an array of function names to undefine, or an empty array or null argument to undefine all functions

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

'test2']);

** File not found : $sandbox->undefineFuncs(['test', **

//WILL UNDEFINE ALL FUNCTIONS!

** File not found : $sandbox->undefineFuncs(); **

defineVar()

defineVar(string|array  $name, mixed  $value) : $this

Define PHPSandbox variable

You can pass the variable $name and $value to define, or an associative array of variables to define

Parameters

Throws

\PHPSandbox\Error

Throws exception if unnamed variable is defined

Returns

Returns the PHPSandbox instance for fluent querying

Examples

);

** File not found : $sandbox->defineVar('test', **

=> 1]);

** File not found : $sandbox->defineVar(['test' **

defineVars()

defineVars(array  $variables = array()) : $this

Define PHPSandbox variables by array

You can pass an associative array of variables to define

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

=> 1]);

** File not found : $sandbox->defineVars(['test' **

hasDefinedVars()

hasDefinedVars() : integer

Query whether PHPSandbox instance has defined variables

Returns

Returns the number of variables this instance has defined

Examples

//returns number of defined variables, or zero if none defined

** File not found : $sandbox->hasDefinedVars(); **

isDefinedVar()

isDefinedVar(string  $name) : boolean

Check if PHPSandbox instance has $name variable defined

Parameters

Returns

Returns true if PHPSandbox instance has defined variable, false otherwise

Examples

** File not found : $sandbox->isDefinedVar('test'); **

undefineVar()

undefineVar(string|array  $name) : $this

Undefine PHPSandbox variable

You can pass a string of variable $name to undefine, or an array of variable names to undefine

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

** File not found : $sandbox->undefineVar('test'); **

'test2']);

** File not found : $sandbox->undefineVar(['test', **

undefineVars()

undefineVars(array  $variables = array()) : $this

Undefine PHPSandbox variables by array

You can pass an array of variable names to undefine, or an empty array or null argument to undefine all variables

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

'test2']);

** File not found : $sandbox->undefineVars(['test', **

//WILL UNDEFINE ALL VARIABLES!

** File not found : $sandbox->undefineVars(); **

defineSuperglobal()

defineSuperglobal(string|array  $name, mixed  $value) : $this

Define PHPSandbox superglobal

You can pass the superglobal $name and $value to define, or an associative array of superglobals to define, or a third variable to define the $key

Parameters

Throws

\PHPSandbox\Error

Throws exception if unnamed superglobal is defined

Returns

Returns the PHPSandbox instance for fluent querying

Examples

['page' => 1]);

** File not found : $sandbox->defineSuperglobal('_GET', **

=> ['page' => 1]]);

** File not found : $sandbox->defineSuperglobal(['_GET' **

'page', 1);

** File not found : $sandbox->defineSuperglobal('_GET', **

defineSuperglobals()

defineSuperglobals(array  $superglobals = array()) : $this

Define PHPSandbox superglobals by array

You can pass an associative array of superglobals to define

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

=> ['page' => 1]]);

** File not found : $sandbox->defineSuperglobals(['_GET' **

hasDefinedSuperglobals()

hasDefinedSuperglobals(string|null  $name = null) : integer|boolean

Query whether PHPSandbox instance has defined superglobals, or if superglobal $name has defined keys

Parameters

Returns

Returns the number of superglobals or superglobal keys this instance has defined, or false if invalid superglobal name specified

Examples

//returns number of defined superglobals, or zero if none defined

** File not found : $sandbox->hasDefinedSuperglobals(); **

//returns number of defined superglobal _GET keys, or zero if none defined

** File not found : $sandbox->hasDefinedSuperglobals('_GET'); **

isDefinedSuperglobal()

isDefinedSuperglobal(string  $name, string|null  $key = null) : boolean

Check if PHPSandbox instance has $name superglobal defined, or if superglobal $name key is defined

Parameters

Returns

Returns true if PHPSandbox instance has defined superglobal, false otherwise

Examples

** File not found : $sandbox->isDefinedSuperglobal('_GET'); **

'page');

** File not found : $sandbox->isDefinedSuperglobal('_GET', **

undefineSuperglobal()

undefineSuperglobal(string|array  $name, string|null  $key = null) : $this

Undefine PHPSandbox superglobal or superglobal key

You can pass a string of superglobal $name to undefine, or a superglobal $key to undefine, or an array of superglobal names to undefine, or an an associative array of superglobal names and keys to undefine

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

** File not found : $sandbox->undefineSuperglobal('_GET'); **

'page');

** File not found : $sandbox->undefineSuperglobal('_GET', **

'_POST']);

** File not found : $sandbox->undefineSuperglobal(['_GET', **

undefineSuperglobals()

undefineSuperglobals(array  $superglobals = array()) : $this

Undefine PHPSandbox superglobals by array

You can pass an array of superglobal names to undefine, or an associative array of superglobals names and key to undefine, or an empty array or null to undefine all superglobals

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

'_POST']);

** File not found : $sandbox->undefineSuperglobals(['_GET', **

=> 'page', '_POST' => 'page']);

** File not found : $sandbox->undefineSuperglobals(['_GET' **

//WILL UNDEFINE ALL SUPERGLOBALS!

** File not found : $sandbox->undefineSuperglobals(); **

defineConst()

defineConst(string|array  $name, mixed  $value) : $this

Define PHPSandbox constant

You can pass the constant $name and $value to define, or an associative array of constants to define

Parameters

Throws

\PHPSandbox\Error

Throws exception if unnamed constant is defined

Returns

Returns the PHPSandbox instance for fluent querying

Examples

);

** File not found : $sandbox->defineConst('TEST', **

=> 1]);

** File not found : $sandbox->defineConst(['TEST' **

defineConsts()

defineConsts(array  $constants = array()) : $this

Define PHPSandbox constants by array

You can pass an associative array of constants to define

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

=> 1]);

** File not found : $sandbox->defineConsts(['test' **

hasDefinedConsts()

hasDefinedConsts() : integer

Query whether PHPSandbox instance has defined constants

Returns

Returns the number of constants this instance has defined

Examples

//returns number of defined constants, or zero if none defined

** File not found : $sandbox->hasDefinedConsts(); **

isDefinedConst()

isDefinedConst(string  $name) : boolean

Check if PHPSandbox instance has $name constant defined

Parameters

Returns

Returns true if PHPSandbox instance has defined constant, false otherwise

Examples

** File not found : $sandbox->isDefinedConst('test'); **

undefineConst()

undefineConst(string|array  $name) : $this

Undefine PHPSandbox constant

You can pass a string of constant $name to undefine, or an array of constant names to undefine

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

** File not found : $sandbox->undefineConst('test'); **

'test2']);

** File not found : $sandbox->undefineConst(['test', **

undefineConsts()

undefineConsts(array  $constants = array()) : $this

Undefine PHPSandbox constants by array

You can pass an array of constant names to undefine, or an empty array or null argument to undefine all constants

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

'test2']);

** File not found : $sandbox->undefineConsts(['test', **

//WILL UNDEFINE ALL CONSTANTS!

** File not found : $sandbox->undefineConsts(); **

defineMagicConst()

defineMagicConst(string|array  $name, mixed  $value) : $this

Define PHPSandbox magic constant

You can pass the magic constant $name and $value to define, or an associative array of magic constants to define

Parameters

Throws

\PHPSandbox\Error

Throws exception if unnamed magic constant is defined

Returns

Returns the PHPSandbox instance for fluent querying

Examples

);

** File not found : $sandbox->defineMagicConst('__LINE__', **

=> 1]);

** File not found : $sandbox->defineMagicConst(['__LINE__' **

defineMagicConsts()

defineMagicConsts(array  $magic_constants = array()) : $this

Define PHPSandbox magic constants by array

You can pass an associative array of magic constants to define

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

=> 1]);

** File not found : $sandbox->defineMagicConsts(['__LINE__' **

hasDefinedMagicConsts()

hasDefinedMagicConsts() : integer

Query whether PHPSandbox instance has defined magic constants

Returns

Returns the number of magic constants this instance has defined

Examples

//returns number of defined magic constants, or zero if none defined

** File not found : $sandbox->hasDefinedMagicConsts(); **

isDefinedMagicConst()

isDefinedMagicConst(string  $name) : boolean

Check if PHPSandbox instance has $name magic constant defined

Parameters

Returns

Returns true if PHPSandbox instance has defined magic constant, false otherwise

Examples

** File not found : $sandbox->isDefinedMagicConst('__LINE__'); **

undefineMagicConst()

undefineMagicConst(string|array  $name) : $this

Undefine PHPSandbox magic constant

You can pass an a string of magic constant $name to undefine, or array of magic constant names to undefine

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

** File not found : $sandbox->undefineMagicConst('__LINE__'); **

'__FILE__']);

** File not found : $sandbox->undefineMagicConst(['__LINE__', **

undefineMagicConsts()

undefineMagicConsts(array  $magic_constants = array()) : $this

Undefine PHPSandbox magic constants by array

You can pass an array of magic constant names to undefine, or an empty array or null argument to undefine all magic constants

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

'__FILE__']);

** File not found : $sandbox->undefineMagicConsts(['__LINE__', **

//WILL UNDEFINE ALL MAGIC CONSTANTS!

** File not found : $sandbox->undefineMagicConsts(); **

defineNamespace()

defineNamespace(string|array  $name) : $this

Define PHPSandbox namespace

You can pass the namespace $name and $value to define, or an array of namespaces to define

Parameters

Throws

\PHPSandbox\Error

Throws exception if unnamed namespace is defined

Returns

Returns the PHPSandbox instance for fluent querying

Examples

** File not found : $sandbox->defineNamespace('Foo'); **

'Bar']);

** File not found : $sandbox->defineNamespace(['Foo', **

defineNamespaces()

defineNamespaces(array  $namespaces = array()) : $this

Define PHPSandbox namespaces by array

You can pass an array of namespaces to define

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

'Bar']);

** File not found : $sandbox->defineNamespaces(['Foo', **

hasDefinedNamespaces()

hasDefinedNamespaces() : integer

Query whether PHPSandbox instance has defined namespaces

Returns

Returns the number of namespaces this instance has defined

Examples

//returns number of defined namespaces, or zero if none defined

** File not found : $sandbox->hasDefinedNamespaces(); **

isDefinedNamespace()

isDefinedNamespace(string  $name) : boolean

Check if PHPSandbox instance has $name namespace defined

Parameters

Returns

Returns true if PHPSandbox instance has defined namespace, false otherwise

Examples

** File not found : $sandbox->isDefinedNamespace('Foo'); **

getDefinedNamespace()

getDefinedNamespace(string  $name) : string

Get defined namespace of $name

Parameters

Throws

\PHPSandbox\Error

Throws an exception if an invalid namespace name is requested

Returns

Returns string of defined namespace value

Examples

** File not found : $sandbox->getDefinedNamespace('Test'); **

undefineNamespace()

undefineNamespace(string|array  $name) : $this

Undefine PHPSandbox namespace

You can pass a string of namespace $name to undefine, or an array of namespace names to undefine

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

** File not found : $sandbox->undefineNamespace('Foo'); **

'Bar']);

** File not found : $sandbox->undefineNamespace(['Foo', **

undefineNamespaces()

undefineNamespaces(array  $namespaces = array()) : $this

Undefine PHPSandbox namespaces by array

You can pass an array of namespace names to undefine, or an empty array or null argument to undefine all namespaces

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

'Bar']);

** File not found : $sandbox->undefineNamespaces(['Foo', **

//WILL UNDEFINE ALL NAMESPACES!

** File not found : $sandbox->undefineNamespaces(); **

defineAlias()

defineAlias(string|array  $name, string|null  $alias = null) : $this

Define PHPSandbox alias

You can pass the namespace $name and $alias to use, an array of namespaces to use, or an associative array of namespaces to use and their aliases

Parameters

Throws

\PHPSandbox\Error

Throws exception if unnamed namespace is used

Returns

Returns the PHPSandbox instance for fluent querying

Examples

//use Foo;

** File not found : $sandbox->defineAlias('Foo'); **

'Bar'); //use Foo as Bar;

** File not found : $sandbox->defineAlias('Foo', **

'Bar']); //use Foo; use Bar;

** File not found : $sandbox->defineAlias(['Foo', **

=> 'Bar']); //use Foo as Bar;

** File not found : $sandbox->defineAlias(['Foo' **

defineAliases()

defineAliases(array  $aliases = array()) : $this

Define PHPSandbox aliases by array

You can pass an array of namespaces to use, or an associative array of namespaces to use and their aliases

Parameters

Throws

\PHPSandbox\Error

Throws exception if unnamed namespace is used

Returns

Returns the PHPSandbox instance for fluent querying

Examples

'Bar']); //use Foo; use Bar;

** File not found : $sandbox->defineAliases(['Foo', **

=> 'Bar']); //use Foo as Bar;

** File not found : $sandbox->defineAliases(['Foo' **

hasDefinedAliases()

hasDefinedAliases() : integer

Query whether PHPSandbox instance has defined aliases

Returns

Returns the number of aliases this instance has defined

Examples

//returns number of defined aliases, or zero if none defined

** File not found : $sandbox->hasDefinedAliases(); **

isDefinedAlias()

isDefinedAlias(string  $name) : boolean

Check if PHPSandbox instance has $name alias defined

Parameters

Returns

Returns true if PHPSandbox instance has defined aliases, false otherwise

Examples

** File not found : $sandbox->isDefinedAlias('Foo'); **

undefineAlias()

undefineAlias(string|array  $name) : $this

Undefine PHPSandbox alias

You can pass a string of alias $name to undefine, or an array of alias names to undefine

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

** File not found : $sandbox->undefineAlias('Foo'); **

'Bar']);

** File not found : $sandbox->undefineAlias(['Foo', **

undefineAliases()

undefineAliases(array  $aliases = array()) : $this

Undefine PHPSandbox aliases by array

You can pass an array of alias names to undefine, or an empty array or null argument to undefine all aliases

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

'Bar']);

** File not found : $sandbox->undefineAliases(['Foo', **

//WILL UNDEFINE ALL ALIASES!

** File not found : $sandbox->undefineAliases(); **

defineUse()

defineUse(string|array  $name, string|null  $alias = null) : $this

Define PHPSandbox use (or alias)

Parameters

Throws

\PHPSandbox\Error

Throws exception if unnamed namespace is used

Returns

Returns the PHPSandbox instance for fluent querying

Examples

//use Foo;

** File not found : $sandbox->defineUse('Foo'); **

'Bar'); //use Foo as Bar;

** File not found : $sandbox->defineUse('Foo', **

'Bar']); //use Foo; use Bar;

** File not found : $sandbox->defineUse(['Foo', **

=> 'Bar']); //use Foo as Bar;

** File not found : $sandbox->defineUse(['Foo' **

defineUses()

defineUses(array  $uses = array()) : $this

Define PHPSandbox uses (or aliases) by array

Parameters

Throws

\PHPSandbox\Error

Throws exception if unnamed namespace is used

Returns

Returns the PHPSandbox instance for fluent querying

Examples

'Bar']); //use Foo; use Bar;

** File not found : $sandbox->defineUses(['Foo', **

=> 'Bar']); //use Foo as Bar;

** File not found : $sandbox->defineUses(['Foo' **

hasDefinedUses()

hasDefinedUses() : integer

Query whether PHPSandbox instance has defined uses (or aliases)

Returns

Returns the number of uses (or aliases) this instance has defined

Examples

//returns number of defined uses (or aliases) or zero if none defined

** File not found : $sandbox->hasDefinedUses(); **

isDefinedUse()

isDefinedUse(string  $name) : boolean

Check if PHPSandbox instance has $name uses (or alias) defined

Parameters

Returns

Returns true if PHPSandbox instance has defined uses (or aliases) and false otherwise

Examples

** File not found : $sandbox->isDefinedUse('Foo'); **

undefineUse()

undefineUse(string|array  $name) : $this

Undefine PHPSandbox use (or alias)

You can pass a string of use (or alias) $name to undefine, or an array of use (or alias) names to undefine

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

** File not found : $sandbox->undefineUse('Foo'); **

'Bar']);

** File not found : $sandbox->undefineUse(['Foo', **

undefineUses()

undefineUses(array  $uses = array()) : $this

Undefine PHPSandbox uses (or aliases) by array

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

'Bar']);

** File not found : $sandbox->undefineUses(['Foo', **

//WILL UNDEFINE ALL USES (OR ALIASES!)

** File not found : $sandbox->undefineUses(); **

defineClass()

defineClass(string|array  $name, mixed  $value) : $this

Define PHPSandbox class

You can pass the class $name and $value to define, or an associative array of classes to define

Parameters

Throws

\PHPSandbox\Error

Throws exception if unnamed class is defined

Returns

Returns the PHPSandbox instance for fluent querying

Examples

'Test2');

** File not found : $sandbox->defineClass('Test', **

=> 'Test2']);

** File not found : $sandbox->defineClass(['Test' **

defineClasses()

defineClasses(array  $classes = array()) : $this

Define PHPSandbox classes by array

You can pass an associative array of classes to define

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

=> 'Test2']);

** File not found : $sandbox->defineClasses(['Test' **

hasDefinedClasses()

hasDefinedClasses() : integer

Query whether PHPSandbox instance has defined classes

Returns

Returns the number of classes this instance has defined

Examples

//returns number of defined classes, or zero if none defined

** File not found : $sandbox->hasDefinedClasses(); **

isDefinedClass()

isDefinedClass(string  $name) : boolean

Check if PHPSandbox instance has $name class defined

Parameters

Returns

Returns true if PHPSandbox instance has defined class, false otherwise

Examples

** File not found : $sandbox->isDefinedClass('Test'); **

getDefinedClass()

getDefinedClass(string  $name) : string

Get defined class of $name

Parameters

Throws

\PHPSandbox\Error

Throws an exception if an invalid class name is requested

Returns

Returns string of defined class value

Examples

** File not found : $sandbox->getDefinedClass('Test'); **

undefineClass()

undefineClass(string|array  $name) : $this

Undefine PHPSandbox class

You can pass a string of class $name to undefine, or an array of class names to undefine

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

** File not found : $sandbox->undefineClass('Test'); **

'Test2']);

** File not found : $sandbox->undefineClass(['Test', **

undefineClasses()

undefineClasses(array  $classes = array()) : $this

Undefine PHPSandbox classes by array

You can pass an array of class names to undefine, or an empty array or null argument to undefine all classes

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

'Test2']);

** File not found : $sandbox->undefineClasses(['Test', **

//WILL UNDEFINE ALL CLASSES!

** File not found : $sandbox->undefineClasses(); **

defineInterface()

defineInterface(string|array  $name, mixed  $value) : $this

Define PHPSandbox interface

You can pass the interface $name and $value to define, or an associative array of interfaces to define

Parameters

Throws

\PHPSandbox\Error

Throws exception if unnamed interface is defined

Returns

Returns the PHPSandbox instance for fluent querying

Examples

'Test2');

** File not found : $sandbox->defineInterface('Test', **

=> 'Test2']);

** File not found : $sandbox->defineInterface(['Test' **

defineInterfaces()

defineInterfaces(array  $interfaces = array()) : $this

Define PHPSandbox interfaces by array

You can pass an associative array of interfaces to define

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

=> 'Test2']);

** File not found : $sandbox->defineInterfaces(['Test' **

hasDefinedInterfaces()

hasDefinedInterfaces() : integer

Query whether PHPSandbox instance has defined interfaces

Returns

Returns the number of interfaces this instance has defined

Examples

//returns number of defined interfaces, or zero if none defined

** File not found : $sandbox->hasDefinedInterfaces(); **

isDefinedInterface()

isDefinedInterface(string  $name) : boolean

Check if PHPSandbox instance has $name interface defined

Parameters

Returns

Returns true if PHPSandbox instance has defined interface, false otherwise

Examples

** File not found : $sandbox->isDefinedInterface('Test'); **

getDefinedInterface()

getDefinedInterface(string  $name) : string

Get defined interface of $name

Parameters

Throws

\PHPSandbox\Error

Throws an exception if an invalid interface name is requested

Returns

Returns string of defined interface value

Examples

** File not found : $sandbox->getDefinedInterface('Test'); **

undefineInterface()

undefineInterface(string|array  $name) : $this

Undefine PHPSandbox interface

You can pass a string of interface $name to undefine, or an array of interface names to undefine

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

** File not found : $sandbox->undefineInterface('Test'); **

'Test2']);

** File not found : $sandbox->undefineInterface(['Test', **

undefineInterfaces()

undefineInterfaces(array  $interfaces = array()) : $this

Undefine PHPSandbox interfaces by array

You can pass an array of interface names to undefine, or an empty array or null argument to undefine all interfaces

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

'Test2']);

** File not found : $sandbox->undefineInterfaces(['Test', **

//WILL UNDEFINE ALL INTERFACES!

** File not found : $sandbox->undefineInterfaces(); **

defineTrait()

defineTrait(string|array  $name, mixed  $value) : $this

Define PHPSandbox trait

You can pass the trait $name and $value to define, or an associative array of traits to define

Parameters

Throws

\PHPSandbox\Error

Throws exception if unnamed trait is defined

Returns

Returns the PHPSandbox instance for fluent querying

Examples

'Test2');

** File not found : $sandbox->defineTrait('Test', **

=> 'Test2']);

** File not found : $sandbox->defineTrait(['Test' **

defineTraits()

defineTraits(array  $traits = array()) : $this

Define PHPSandbox traits by array

You can pass an associative array of traits to define

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

=> 'Test2']);

** File not found : $sandbox->defineTraits(['Test' **

hasDefinedTraits()

hasDefinedTraits() : integer

Query whether PHPSandbox instance has defined traits

Returns

Returns the number of traits this instance has defined

Examples

//returns number of defined traits, or zero if none defined

** File not found : $sandbox->hasDefinedTraits(); **

isDefinedTrait()

isDefinedTrait(string  $name) : boolean

Check if PHPSandbox instance has $name trait defined

Parameters

Returns

Returns true if PHPSandbox instance has defined trait, false otherwise

Examples

** File not found : $sandbox->isDefinedTrait('Test'); **

getDefinedTrait()

getDefinedTrait(string  $name) : string

Get defined trait of $name

Parameters

Throws

\PHPSandbox\Error

Throws an exception if an invalid trait name is requested

Returns

Returns string of defined trait value

Examples

** File not found : $sandbox->getDefinedTrait('Test'); **

undefineTrait()

undefineTrait(string|array  $name) : $this

Undefine PHPSandbox trait

You can pass a string of trait $name to undefine, or an array of trait names to undefine

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

** File not found : $sandbox->undefineTrait('Test'); **

'Test2']);

** File not found : $sandbox->undefineTrait(['Test', **

undefineTraits()

undefineTraits(array  $traits = array()) : $this

Undefine PHPSandbox traits by array

You can pass an array of trait names to undefine, or an empty array or null argument to undefine all traits

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

'Test2']);

** File not found : $sandbox->undefineTraits(['Test', **

//WILL UNDEFINE ALL TRAITS!

** File not found : $sandbox->undefineTraits(); **

whitelist()

whitelist(string|array  $type, string|array|null  $name = null) : $this

Whitelist PHPSandbox definitions, such as functions, constants, classes, etc. to set

You can pass an associative array of whitelist types and their names, or a string $type and array of $names, or pass a string of the $type and $name

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

=> ['test']]);

** File not found : $sandbox->whitelist(['functions' **

['test']);

** File not found : $sandbox->whitelist('functions', **

'test');

** File not found : $sandbox->whitelist('functions', **

blacklist()

blacklist(string|array  $type, string|array|null  $name = null) : $this

Blacklist PHPSandbox definitions, such as functions, constants, classes, etc. to set

You can pass an associative array of blacklist types and their names, or a string $type and array of $names, or pass a string of the $type and $name

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

=> ['test']]);

** File not found : $sandbox->blacklist(['functions' **

['test']);

** File not found : $sandbox->blacklist('functions', **

'test');

** File not found : $sandbox->blacklist('functions', **

dewhitelist()

dewhitelist(string|array  $type, string|array|null  $name) : $this

Remove PHPSandbox definitions, such as functions, constants, classes, etc. from whitelist

You can pass an associative array of whitelist types and their names, or a string $type and array of $names, or pass a string of the $type and $name to unset

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

=> ['test']]);

** File not found : $sandbox->dewhitelist(['functions' **

['test']);

** File not found : $sandbox->dewhitelist('functions', **

'test');

** File not found : $sandbox->dewhitelist('functions', **

deblacklist()

deblacklist(string|array  $type, string|array|null  $name) : $this

Remove PHPSandbox definitions, such as functions, constants, classes, etc. from blacklist

You can pass an associative array of blacklist types and their names, or a string $type and array of $names, or pass a string of the $type and $name to unset

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

=> ['test']]);

** File not found : $sandbox->deblacklist(['functions' **

['test']);

** File not found : $sandbox->deblacklist('functions', **

'test');

** File not found : $sandbox->deblacklist('functions', **

hasWhitelist()

hasWhitelist(string  $type) : integer

Query whether PHPSandbox instance has whitelist type

Parameters

Returns

Returns the number of whitelists this instance has defined

Examples

//returns number of whitelisted functions, or zero if none whitelisted

** File not found : $sandbox->hasWhitelist('functions'); **

hasBlacklist()

hasBlacklist(string  $type) : integer

Query whether PHPSandbox instance has blacklist type.

Parameters

Returns

Returns the number of blacklists this instance has defined

Examples

//returns number of blacklisted functions, or zero if none blacklisted

** File not found : $sandbox->hasBlacklist('functions'); **

isWhitelisted()

isWhitelisted(string  $type, string  $name) : boolean

Check if PHPSandbox instance has whitelist type and name set

Parameters

Returns

Returns true if PHPSandbox instance has whitelisted $type and $name, false otherwise

Examples

'test');

** File not found : $sandbox->isWhitelisted('functions', **

isBlacklisted()

isBlacklisted(string  $type, string  $name) : boolean

Check if PHPSandbox instance has blacklist type and name set

Parameters

Returns

Returns true if PHPSandbox instance has blacklisted $type and $name, false otherwise

Examples

'test');

** File not found : $sandbox->isBlacklisted('functions', **

hasWhitelistedFuncs()

hasWhitelistedFuncs() : integer

Query whether PHPSandbox instance has whitelisted functions.

Returns

Returns the number of whitelisted functions this instance has defined

Examples

//returns number of whitelisted functions, or zero if none whitelisted

** File not found : $sandbox->hasWhitelistedFuncs(); **

hasBlacklistedFuncs()

hasBlacklistedFuncs() : integer

Query whether PHPSandbox instance has blacklisted functions.

Returns

Returns the number of blacklisted functions this instance has defined

Examples

//returns number of blacklisted functions, or zero if none blacklisted

** File not found : $sandbox->hasBlacklistedFuncs(); **

isWhitelistedFunc()

isWhitelistedFunc(string  $name) : boolean

Check if PHPSandbox instance has whitelisted function name set

Parameters

Returns

Returns true if PHPSandbox instance has whitelisted function $name, false otherwise

Examples

** File not found : $sandbox->isWhitelistedFunc('test'); **

isBlacklistedFunc()

isBlacklistedFunc(string  $name) : boolean

Check if PHPSandbox instance has blacklisted function name set

Parameters

Returns

Returns true if PHPSandbox instance has blacklisted function $name, false otherwise

Examples

** File not found : $sandbox->isBlacklistedFunc('test'); **

hasWhitelistedVars()

hasWhitelistedVars() : integer

Query whether PHPSandbox instance has whitelisted variables.

Returns

Returns the number of whitelisted variables this instance has defined

Examples

//returns number of whitelisted variables, or zero if none whitelisted

** File not found : $sandbox->hasWhitelistedVars(); **

hasBlacklistedVars()

hasBlacklistedVars() : integer

Query whether PHPSandbox instance has blacklisted variables.

Returns

Returns the number of blacklisted variables this instance has defined

Examples

//returns number of blacklisted variables, or zero if none blacklisted

** File not found : $sandbox->hasBlacklistedVars(); **

isWhitelistedVar()

isWhitelistedVar(string  $name) : boolean

Check if PHPSandbox instance has whitelisted variable name set

Parameters

Returns

Returns true if PHPSandbox instance has whitelisted variable $name, false otherwise

Examples

** File not found : $sandbox->isWhitelistedVar('test'); **

isBlacklistedVar()

isBlacklistedVar(string  $name) : boolean

Check if PHPSandbox instance has blacklisted variable name set

Parameters

Returns

Returns true if PHPSandbox instance has blacklisted variable $name, false otherwise

Examples

** File not found : $sandbox->isBlacklistedVar('test'); **

hasWhitelistedGlobals()

hasWhitelistedGlobals() : integer

Query whether PHPSandbox instance has whitelisted globals.

Returns

Returns the number of whitelisted globals this instance has defined

Examples

//returns number of whitelisted globals, or zero if none whitelisted

** File not found : $sandbox->hasWhitelistedGlobals(); **

hasBlacklistedGlobals()

hasBlacklistedGlobals() : integer

Query whether PHPSandbox instance has blacklisted globals.

Returns

Returns the number of blacklisted globals this instance has defined

Examples

//returns number of blacklisted globals, or zero if none blacklisted

** File not found : $sandbox->hasBlacklistedGlobals(); **

isWhitelistedGlobal()

isWhitelistedGlobal(string  $name) : boolean

Check if PHPSandbox instance has whitelisted global name set

Parameters

Returns

Returns true if PHPSandbox instance has whitelisted global $name, false otherwise

Examples

** File not found : $sandbox->isWhitelistedGlobal('test'); **

isBlacklistedGlobal()

isBlacklistedGlobal(string  $name) : boolean

Check if PHPSandbox instance has blacklisted global name set

Parameters

Returns

Returns true if PHPSandbox instance has blacklisted global $name, false otherwise

Examples

** File not found : $sandbox->isBlacklistedGlobal('test'); **

hasWhitelistedSuperglobals()

hasWhitelistedSuperglobals(string  $name = null) : integer

Query whether PHPSandbox instance has whitelisted superglobals, or superglobal keys

Parameters

Returns

Returns the number of whitelisted superglobals or superglobal keys this instance has defined

Examples

//returns number of whitelisted superglobals, or zero if none whitelisted

** File not found : $sandbox->hasWhitelistedSuperglobals(); **

//returns number of whitelisted superglobal keys, or zero if none whitelisted

** File not found : $sandbox->hasWhitelistedSuperglobals('_GET'); **

hasBlacklistedSuperglobals()

hasBlacklistedSuperglobals(string  $name = null) : integer

Query whether PHPSandbox instance has blacklisted superglobals, or superglobal keys

Parameters

Returns

Returns the number of blacklisted superglobals or superglobal keys this instance has defined

Examples

//returns number of blacklisted superglobals, or zero if none blacklisted

** File not found : $sandbox->hasBlacklistedSuperglobals(); **

//returns number of blacklisted superglobal keys, or zero if none blacklisted

** File not found : $sandbox->hasBlacklistedSuperglobals('_GET'); **

isWhitelistedSuperglobal()

isWhitelistedSuperglobal(string  $name, string  $key = null) : boolean

Check if PHPSandbox instance has whitelisted superglobal or superglobal key set

Parameters

Returns

Returns true if PHPSandbox instance has whitelisted superglobal key or superglobal, false otherwise

Examples

** File not found : $sandbox->isWhitelistedSuperglobal('_GET'); **

'page');

** File not found : $sandbox->isWhitelistedSuperglobal('_GET', **

isBlacklistedSuperglobal()

isBlacklistedSuperglobal(string  $name, string  $key = null) : boolean

Check if PHPSandbox instance has blacklisted superglobal or superglobal key set

Parameters

Returns

Returns true if PHPSandbox instance has blacklisted superglobal key or superglobal, false otherwise

Examples

** File not found : $sandbox->isBlacklistedSuperglobal('_GET'); **

'page');

** File not found : $sandbox->isBlacklistedSuperglobal('_GET', **

hasWhitelistedConsts()

hasWhitelistedConsts() : integer

Query whether PHPSandbox instance has whitelisted constants.

Returns

Returns the number of whitelisted constants this instance has defined

Examples

//returns number of whitelisted constants, or zero if none whitelisted

** File not found : $sandbox->hasWhitelistedConsts(); **

hasBlacklistedConsts()

hasBlacklistedConsts() : integer

Query whether PHPSandbox instance has blacklisted constants.

Returns

Returns the number of blacklisted constants this instance has defined

Examples

//returns number of blacklisted constants, or zero if none blacklisted

** File not found : $sandbox->hasBlacklistedConsts(); **

isWhitelistedConst()

isWhitelistedConst(string  $name) : boolean

Check if PHPSandbox instance has whitelisted constant name set

Parameters

Returns

Returns true if PHPSandbox instance has whitelisted constant $name, false otherwise

Examples

** File not found : $sandbox->isWhitelistedConst('TEST'); **

isBlacklistedConst()

isBlacklistedConst(string  $name) : boolean

Check if PHPSandbox instance has blacklisted constant name set

Parameters

Returns

Returns true if PHPSandbox instance has blacklisted constant $name, false otherwise

Examples

** File not found : $sandbox->isBlacklistedConst('TEST'); **

hasWhitelistedMagicConsts()

hasWhitelistedMagicConsts() : integer

Query whether PHPSandbox instance has whitelisted magic constants.

Returns

Returns the number of whitelisted magic constants this instance has defined

Examples

//returns number of whitelisted magic constants, or zero if none whitelisted

** File not found : $sandbox->hasWhitelistedMagicConsts(); **

hasBlacklistedMagicConsts()

hasBlacklistedMagicConsts() : integer

Query whether PHPSandbox instance has blacklisted magic constants.

Returns

Returns the number of blacklisted magic constants this instance has defined

Examples

//returns number of blacklisted magic constants, or zero if none blacklisted

** File not found : $sandbox->hasBlacklistedMagicConsts(); **

isWhitelistedMagicConst()

isWhitelistedMagicConst(string  $name) : boolean

Check if PHPSandbox instance has whitelisted magic constant name set

Parameters

Returns

Returns true if PHPSandbox instance has whitelisted magic constant $name, false otherwise

Examples

** File not found : $sandbox->isWhitelistedMagicConst('__LINE__'); **

isBlacklistedMagicConst()

isBlacklistedMagicConst(string  $name) : boolean

Check if PHPSandbox instance has blacklisted magic constant name set

Parameters

Returns

Returns true if PHPSandbox instance has blacklisted magic constant $name, false otherwise

Examples

** File not found : $sandbox->isBlacklistedMagicConst('__LINE__'); **

hasWhitelistedNamespaces()

hasWhitelistedNamespaces() : integer

Query whether PHPSandbox instance has whitelisted namespaces.

Returns

Returns the number of whitelisted namespaces this instance has defined

Examples

//returns number of whitelisted namespaces, or zero if none whitelisted

** File not found : $sandbox->hasWhitelistedNamespaces(); **

hasBlacklistedNamespaces()

hasBlacklistedNamespaces() : integer

Query whether PHPSandbox instance has blacklisted namespaces.

Returns

Returns the number of blacklisted namespaces this instance has defined

Examples

//returns number of blacklisted namespaces, or zero if none blacklisted

** File not found : $sandbox->hasBlacklistedNamespaces(); **

isWhitelistedNamespace()

isWhitelistedNamespace(string  $name) : boolean

Check if PHPSandbox instance has whitelisted namespace name set

Parameters

Returns

Returns true if PHPSandbox instance has whitelisted namespace $name, false otherwise

Examples

** File not found : $sandbox->isWhitelistedNamespace('Test'); **

isBlacklistedNamespace()

isBlacklistedNamespace(string  $name) : boolean

Check if PHPSandbox instance has blacklisted namespace name set

Parameters

Returns

Returns true if PHPSandbox instance has blacklisted namespace $name, false otherwise

Examples

** File not found : $sandbox->isBlacklistedNamespace('Test'); **

hasWhitelistedAliases()

hasWhitelistedAliases() : integer

Query whether PHPSandbox instance has whitelisted aliases.

Returns

Returns the number of whitelisted aliases this instance has defined

Examples

//returns number of whitelisted aliases, or zero if none whitelisted

** File not found : $sandbox->hasWhitelistedAliases(); **

hasBlacklistedAliases()

hasBlacklistedAliases() : integer

Query whether PHPSandbox instance has blacklisted aliases.

Returns

Returns the number of blacklisted aliases this instance has defined

Examples

//returns number of blacklisted aliases, or zero if none blacklisted

** File not found : $sandbox->hasBlacklistedAliases(); **

isWhitelistedAlias()

isWhitelistedAlias(string  $name) : boolean

Check if PHPSandbox instance has whitelisted alias name set

Parameters

Returns

Returns true if PHPSandbox instance has whitelisted alias $name, false otherwise

Examples

** File not found : $sandbox->isWhitelistedAlias('Test'); **

isBlacklistedAlias()

isBlacklistedAlias(string  $name) : boolean

Check if PHPSandbox instance has blacklisted alias name set

Parameters

Returns

Returns true if PHPSandbox instance has blacklisted alias $name, false otherwise

Examples

** File not found : $sandbox->isBlacklistedAlias('Test'); **

hasWhitelistedUses()

hasWhitelistedUses() : integer

Query whether PHPSandbox instance has whitelisted uses (or aliases.)

Returns

Returns the number of whitelisted uses (or aliases) this instance has defined

Examples

//returns number of whitelisted uses (or aliases) or zero if none whitelisted

** File not found : $sandbox->hasWhitelistedUses(); **

hasBlacklistedUses()

hasBlacklistedUses() : integer

Query whether PHPSandbox instance has blacklisted uses (or aliases.)

Returns

Returns the number of blacklisted uses (or aliases) this instance has defined

Examples

//returns number of blacklisted uses (or aliases) or zero if none blacklisted

** File not found : $sandbox->hasBlacklistedUses(); **

isWhitelistedUse()

isWhitelistedUse(string  $name) : boolean

Check if PHPSandbox instance has whitelisted use (or alias) name set

Parameters

Returns

Returns true if PHPSandbox instance has whitelisted use (or alias) $name, false otherwise

Examples

** File not found : $sandbox->isWhitelistedUse('Test'); **

isBlacklistedUse()

isBlacklistedUse(string  $name) : boolean

Check if PHPSandbox instance has blacklisted use (or alias) name set

Parameters

Returns

Returns true if PHPSandbox instance has blacklisted use (or alias) $name, false otherwise

Examples

** File not found : $sandbox->isBlacklistedUse('Test'); **

hasWhitelistedClasses()

hasWhitelistedClasses() : integer

Query whether PHPSandbox instance has whitelisted classes.

Returns

Returns the number of whitelisted classes this instance has defined

Examples

//returns number of whitelisted classes, or zero if none whitelisted

** File not found : $sandbox->hasWhitelistClasses(); **

hasBlacklistedClasses()

hasBlacklistedClasses() : integer

Query whether PHPSandbox instance has blacklisted classes.

Returns

Returns the number of blacklisted classes this instance has defined

Examples

//returns number of blacklisted classes, or zero if none blacklisted

** File not found : $sandbox->hasBlacklistedClasses(); **

isWhitelistedClass()

isWhitelistedClass(string  $name) : boolean

Check if PHPSandbox instance has whitelisted class name set

Parameters

Returns

Returns true if PHPSandbox instance has whitelisted class $name, false otherwise

Examples

** File not found : $sandbox->isWhitelistedClass('Test'); **

isBlacklistedClass()

isBlacklistedClass(string  $name) : boolean

Check if PHPSandbox instance has blacklisted class name set

Parameters

Returns

Returns true if PHPSandbox instance has blacklisted class $name, false otherwise

Examples

** File not found : $sandbox->isBlacklistedClass('Test'); **

hasWhitelistedInterfaces()

hasWhitelistedInterfaces() : integer

Query whether PHPSandbox instance has whitelisted interfaces.

Returns

Returns the number of whitelisted interfaces this instance has defined

Examples

//returns number of whitelisted interfaces, or zero if none whitelisted

** File not found : $sandbox->hasWhitelistedInterfaces(); **

hasBlacklistedInterfaces()

hasBlacklistedInterfaces() : integer

Query whether PHPSandbox instance has blacklisted interfaces.

Returns

Returns the number of blacklisted interfaces this instance has defined

Examples

//returns number of blacklisted interfaces, or zero if none blacklisted

** File not found : $sandbox->hasBlacklistedInterfaces(); **

isWhitelistedInterface()

isWhitelistedInterface(string  $name) : boolean

Check if PHPSandbox instance has whitelisted interface name set

Parameters

Returns

Returns true if PHPSandbox instance has whitelisted interface $name, false otherwise

Examples

** File not found : $sandbox->isWhitelistedInterface('Test'); **

isBlacklistedInterface()

isBlacklistedInterface(string  $name) : boolean

Check if PHPSandbox instance has blacklisted interface name set

Parameters

Returns

Returns true if PHPSandbox instance has blacklisted interface $name, false otherwise

Examples

** File not found : $sandbox->isBlacklistedInterface('Test'); **

hasWhitelistedTraits()

hasWhitelistedTraits() : integer

Query whether PHPSandbox instance has whitelisted traits.

Returns

Returns the number of whitelisted traits this instance has defined

Examples

//returns number of whitelisted traits, or zero if none whitelisted

** File not found : $sandbox->hasWhitelistedTraits(); **

hasBlacklistedTraits()

hasBlacklistedTraits() : integer

Query whether PHPSandbox instance has blacklisted traits.

Returns

Returns the number of blacklisted traits this instance has defined

Examples

//returns number of blacklisted traits, or zero if none blacklisted

** File not found : $sandbox->hasBlacklistedTraits(); **

isWhitelistedTrait()

isWhitelistedTrait(string  $name) : boolean

Check if PHPSandbox instance has whitelisted trait name set

Parameters

Returns

Returns true if PHPSandbox instance has whitelisted trait $name, false otherwise

Examples

** File not found : $sandbox->isWhitelistedTrait('Test'); **

isBlacklistedTrait()

isBlacklistedTrait(string  $name) : boolean

Check if PHPSandbox instance has blacklisted trait name set

Parameters

Returns

Returns true if PHPSandbox instance has blacklisted trait $name, false otherwise

Examples

** File not found : $sandbox->isBlacklistedTrait('Test'); **

hasWhitelistKeywords()

hasWhitelistKeywords() : integer

Query whether PHPSandbox instance has whitelisted keywords.

Returns

Returns the number of whitelisted keywords this instance has defined

Examples

//returns number of whitelisted keywords, or zero if none whitelisted

** File not found : $sandbox->hasWhitelistKeywords(); **

hasBlacklistedKeywords()

hasBlacklistedKeywords() : integer

Query whether PHPSandbox instance has blacklisted keywords.

Returns

Returns the number of blacklisted keywords this instance has defined

Examples

//returns number of blacklisted keywords, or zero if none blacklisted

** File not found : $sandbox->hasBlacklistedKeywords(); **

isWhitelistedKeyword()

isWhitelistedKeyword(string  $name) : boolean

Check if PHPSandbox instance has whitelisted keyword name set

Parameters

Returns

Returns true if PHPSandbox instance has whitelisted keyword $name, false otherwise

Examples

** File not found : $sandbox->isWhitelistedKeyword('echo'); **

isBlacklistedKeyword()

isBlacklistedKeyword(string  $name) : boolean

Check if PHPSandbox instance has blacklisted keyword name set

Parameters

Returns

Returns true if PHPSandbox instance has blacklisted keyword $name, false otherwise

Examples

** File not found : $sandbox->isBlacklistedKeyword('echo'); **

hasWhitelistedOperators()

hasWhitelistedOperators() : integer

Query whether PHPSandbox instance has whitelisted operators.

Returns

Returns the number of whitelisted operators this instance has defined

Examples

//returns number of whitelisted operators, or zero if none whitelisted

** File not found : $sandbox->hasWhitelistOperators(); **

hasBlacklistedOperators()

hasBlacklistedOperators() : integer

Query whether PHPSandbox instance has blacklisted operators.

Returns

Returns the number of blacklisted operators this instance has defined

Examples

//returns number of blacklisted operators, or zero if none blacklisted

** File not found : $sandbox->hasBlacklistOperators(); **

isWhitelistedOperator()

isWhitelistedOperator(string  $name) : boolean

Check if PHPSandbox instance has whitelisted operator name set

Parameters

Returns

Returns true if PHPSandbox instance has whitelisted operator $name, false otherwise

Examples

** File not found : $sandbox->isWhitelistedOperator('+'); **

isBlacklistedOperator()

isBlacklistedOperator(string  $name) : boolean

Check if PHPSandbox instance has blacklisted operator name set

Parameters

Returns

Returns true if PHPSandbox instance has blacklisted operator $name, false otherwise

Examples

** File not found : $sandbox->isBlacklistedOperator('+'); **

hasWhitelistedPrimitives()

hasWhitelistedPrimitives() : integer

Query whether PHPSandbox instance has whitelisted primitives.

Returns

Returns the number of whitelisted primitives this instance has defined

Examples

//returns number of whitelisted primitives, or zero if none whitelisted

** File not found : $sandbox->hasWhitelistedPrimitives(); **

hasBlacklistedPrimitives()

hasBlacklistedPrimitives() : integer

Query whether PHPSandbox instance has blacklisted primitives.

Returns

Returns the number of blacklisted primitives this instance has defined

Examples

//returns number of blacklisted primitives, or zero if none blacklisted

** File not found : $sandbox->hasBlacklistedPrimitives(); **

isWhitelistedPrimitive()

isWhitelistedPrimitive(string  $name) : boolean

Check if PHPSandbox instance has whitelisted primitive name set

Parameters

Returns

Returns true if PHPSandbox instance has whitelisted primitive $name, false otherwise

Examples

** File not found : $sandbox->isWhitelistedPrimitive('array'); **

isBlacklistedPrimitive()

isBlacklistedPrimitive(string  $name) : boolean

Check if PHPSandbox instance has blacklisted primitive name set

Parameters

Returns

Returns true if PHPSandbox instance has blacklisted primitive $name, false otherwise

Examples

** File not found : $sandbox->isBlacklistedPrimitive('array'); **

hasWhitelistedTypes()

hasWhitelistedTypes() : integer

Query whether PHPSandbox instance has whitelisted types.

Returns

Returns the number of whitelisted types this instance has defined

Examples

//returns number of whitelisted types, or zero if none whitelisted

** File not found : $sandbox->hasWhitelistedTypes(); **

hasBlacklistedTypes()

hasBlacklistedTypes() : integer

Query whether PHPSandbox instance has blacklisted types.

Returns

Returns the number of blacklisted types this instance has defined

Examples

//returns number of blacklisted types, or zero if none blacklisted

** File not found : $sandbox->hasBlacklistedTypes(); **

isWhitelistedType()

isWhitelistedType(string  $name) : boolean

Check if PHPSandbox instance has whitelisted type name set

Parameters

Returns

Returns true if PHPSandbox instance has whitelisted type $name, false otherwise

Examples

** File not found : $sandbox->isWhitelistedType('array'); **

isBlacklistedType()

isBlacklistedType(string  $name) : boolean

Check if PHPSandbox instance has blacklisted type name set

Parameters

Returns

Returns true if PHPSandbox instance has blacklisted type $name, false otherwise

Examples

** File not found : $sandbox->isBlacklistedType('array'); **

whitelistFunc()

whitelistFunc(string|array  $name) : $this

Whitelist function

You can pass a string of the function name, or pass an array of function names to whitelist

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

** File not found : $sandbox->whitelistFunc('var_dump'); **

'print_r');

** File not found : $sandbox->whitelistFunc('var_dump', **

'print_r']);

** File not found : $sandbox->whitelistFunc(['var_dump', **

blacklistFunc()

blacklistFunc(string|array  $name) : $this

Blacklist function

You can pass a string of the function name, or pass an array of function names to blacklist

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

** File not found : $sandbox->blacklistFunc('var_dump'); **

'print_r']);

** File not found : $sandbox->blacklistFunc(['var_dump', **

dewhitelistFunc()

dewhitelistFunc(string|array  $name) : $this

Remove function from whitelist

You can pass a string of the function name, or pass an array of function names to remove from whitelist

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

** File not found : $sandbox->dewhitelistFunc('var_dump'); **

'print_r']);

** File not found : $sandbox->dewhitelistFunc(['var_dump', **

deblacklistFunc()

deblacklistFunc(string|array  $name) : $this

Remove function from blacklist

You can pass a string of the function name, or pass an array of function names to remove from blacklist

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

** File not found : $sandbox->deblacklistFunc('var_dump'); **

'print_r']);

** File not found : $sandbox->deblacklistFunc(['var_dump', **

whitelistVar()

whitelistVar(string|array  $name) : $this

Whitelist variable

You can pass a string of variable name, or pass an array of the variable names to whitelist

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

** File not found : $sandbox->whitelistVar('a'); **

'b']);

** File not found : $sandbox->whitelistVar(['a', **

blacklistVar()

blacklistVar(string|array  $name) : $this

Blacklist variable

You can pass a string of variable name, or pass an array of the variable names to blacklist

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

** File not found : $sandbox->blacklistVar('a'); **

'b']);

** File not found : $sandbox->blacklistVar(['a', **

dewhitelistVar()

dewhitelistVar(string|array  $name) : $this

Remove variable from whitelist

You can pass a string of variable name, or pass an array of the variable names to remove from whitelist

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

** File not found : $sandbox->dewhitelistVar('a'); **

'b']);

** File not found : $sandbox->dewhitelistVar(['a', **

deblacklistVar()

deblacklistVar(string|array  $name) : $this

Remove function from blacklist

You can pass a string of variable name, or pass an array of the variable names to remove from blacklist

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

** File not found : $sandbox->deblacklistVar('a'); **

'b']);

** File not found : $sandbox->deblacklistVar(['a', **

whitelistGlobal()

whitelistGlobal(string|array  $name) : $this

Whitelist global

You can pass a string of global name, or pass an array of the global names to whitelist

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

** File not found : $sandbox->whitelistGlobal('a'); **

'b']);

** File not found : $sandbox->whitelistGlobal(['a', **

blacklistGlobal()

blacklistGlobal(string|array  $name) : $this

Blacklist global

You can pass a string of global name, or pass an array of the global names to blacklist

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

** File not found : $sandbox->blacklistGlobal('a'); **

'b']);

** File not found : $sandbox->blacklistGlobal(['a', **

dewhitelistGlobal()

dewhitelistGlobal(string|array  $name) : $this

Remove global from whitelist

You can pass a string of global name, or pass an array of the global names to remove from whitelist

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

** File not found : $sandbox->dewhitelistGlobal('a'); **

'b']);

** File not found : $sandbox->dewhitelistGlobal(['a', **

deblacklistGlobal()

deblacklistGlobal(string|array  $name) : $this

Remove global from blacklist

You can pass a string of global name, or pass an array of the global names to remove from blacklist

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

** File not found : $sandbox->deblacklistGlobal('a'); **

'b']);

** File not found : $sandbox->deblacklistGlobal(['a', **

whitelistSuperglobal()

whitelistSuperglobal(string|array  $name, string  $key = null) : $this

Whitelist superglobal or superglobal key

You can pass a string of the superglobal name, or a string of the superglobal name and a string of the key, or pass an array of superglobal names, or an associative array of superglobal names and their keys to whitelist

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

** File not found : $sandbox->whitelistSuperglobal('_GET'); **

'page');

** File not found : $sandbox->whitelistSuperglobal('_GET', **

'_POST']);

** File not found : $sandbox->whitelistSuperglobal(['_GET', **

=> 'page']);

** File not found : $sandbox->whitelistSuperglobal(['_GET' **

blacklistSuperglobal()

blacklistSuperglobal(string|array  $name, string  $key = null) : $this

Blacklist superglobal or superglobal key * You can pass a string of the superglobal name, or a string of the superglobal name and a string of the key, or pass an array of superglobal names, or an associative array of superglobal names and their keys to blacklist

Parameters

Returns

Returns the PHPSandbox instance for fluent querying

Examples

** File not found : $sandbox->blacklistSuperglobal('_GET'); **

'page');

** File not found : $sandbox->blacklistSuperglobal('_GET', **

'_POST']);

** File not found : $sandbox->blacklistSuperglobal(['_GET', **

=> 'page']);

** File not found : $sandbox->blacklistSuperglobal(['_GET' **

dewhitelistSuperglobal()

dewhitelistSuperglobal(string|array  $name, string  $key = null) : $this

Remove superglobal or superglobal key from whitelist * You can pass a string of the superglobal name, or a string of the superglobal name and a string of the key, or pass an array of superglobal names, or an associative array of superglobal names and their keys to remove from whitelist