Skip to content
This repository has been archived by the owner on Sep 5, 2018. It is now read-only.

Commit

Permalink
- Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@fieryprophet
fieryprophet committed Jun 19, 2014
1 parent 647f5d5 commit 744cfd5
Show file tree
Hide file tree
Showing 10 changed files with 150 additions and 173 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
- Added flags to enable/disable validation checks for every type (for example, this will help in situations where someone wants to enable all functions but not blacklist a fake function name to remove the function whitelist.) Disabling a validation check also ignores any custom validation check for that type!
- Fixed issue with toolkit giving incorrect error and exception messages
- Added ability for sandbox to overwrite static type hints that are redefined to other class names (NOTE: All statically referenced class/interface/trait names are treated as classes by the parser and the sandbox, therefore they must be redefined via define_class())
- Updated documentation

##05/06/2014
- Corrected defined alias case-sensitivity issue (see: issue #10)
Expand Down
131 changes: 130 additions & 1 deletion MANUAL.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ <h3>1 - About PHPSandbox &amp; PHPSandbox Toolkit</h3>
</a>
<br/>
<h1 style="margin: 0;">
PHPSandbox Toolkit 1.3.6
PHPSandbox Toolkit 1.3.7
</h1>
<br/>
<strong>Developed by: </strong> <a href="http://www.fieryprophet.com" target="_blank">Elijah Horton</a>
Expand Down Expand Up @@ -120,6 +120,135 @@ <h3>Options</h3>
<pre>$sandbox->set_option('allow_functions', false);</pre>
<h4>Option Descriptions</h4>
<ul>
<li>
<strong>Validate Functions: </strong> &mdash; Default Value: <em>true</em>
<br/>
If this flag is set the sandbox will validate functions within the sandboxed code. If this flag is
disabled then all function validation, including custom function validation, will be ignored.
<hr/>
</li>
<li>
<strong>Validate Variables: </strong> &mdash; Default Value: <em>true</em>
<br/>
If this flag is set the sandbox will validate variables within the sandboxed code. If this flag is
disabled then all variable validation, including custom variable validation, will be ignored.
<hr/>
</li>
<li>
<strong>Validate Globals: </strong> &mdash; Default Value: <em>true</em>
<br/>
If this flag is set the sandbox will validate globals within the sandboxed code. If this flag is
disabled then all global validation, including custom global validation, will be ignored.
<hr/>
</li>
<li>
<strong>Validate Superglobals: </strong> &mdash; Default Value: <em>true</em>
<br/>
If this flag is set the sandbox will validate superglobals within the sandboxed code. If this flag is
disabled then all superglobal validation, including custom superglobal validation, will be ignored.
<hr/>
</li>
<li>
<strong>Validate Constants: </strong> &mdash; Default Value: <em>true</em>
<br/>
If this flag is set the sandbox will validate constants within the sandboxed code. If this flag is
disabled then all constant validation, including custom constant validation, will be ignored.
<hr/>
</li>
<li>
<strong>Validate Magic Constants: </strong> &mdash; Default Value: <em>true</em>
<br/>
If this flag is set the sandbox will validate magic constants within the sandboxed code. If this flag is
disabled then all magic constant validation, including custom magic constant validation, will be ignored.
<hr/>
</li>
<li>
<strong>Validate Namespaces: </strong> &mdash; Default Value: <em>true</em>
<br/>
If this flag is set the sandbox will validate namespaces within the sandboxed code. If this flag is
disabled then all namespace validation, including custom namespace validation, will be ignored.
<hr/>
</li>
<li>
<strong>Validate Aliases (aka Use): </strong> &mdash; Default Value: <em>true</em>
<br/>
If this flag is set the sandbox will validate aliases within the sandboxed code. If this flag is
disabled then all alias validation, including custom alias validation, will be ignored.
<hr/>
</li>
<li>
<strong>Validate Classes: </strong> &mdash; Default Value: <em>true</em>
<br/>
If this flag is set the sandbox will validate classes within the sandboxed code. If this flag is
disabled then all class validation, including custom class validation, will be ignored.
<hr/>
</li>
<li>
<strong>Validate Interfaces: </strong> &mdash; Default Value: <em>true</em>
<br/>
If this flag is set the sandbox will validate interfaces within the sandboxed code. If this flag is
disabled then all interface validation, including custom interface validation, will be ignored.
<hr/>
</li>
<li>
<strong>Validate Traits: </strong> &mdash; Default Value: <em>true</em>
<br/>
If this flag is set the sandbox will validate traits within the sandboxed code. If this flag is
disabled then all trait validation, including custom trait validation, will be ignored.
<hr/>
</li>
<li>
<strong>Validate Keywords: </strong> &mdash; Default Value: <em>true</em>
<br/>
If this flag is set the sandbox will validate keywords within the sandboxed code. If this flag is
disabled then all keyword validation, including custom keyword validation, will be ignored.
<hr/>
</li>
<li>
<strong>Validate Operators: </strong> &mdash; Default Value: <em>true</em>
<br/>
If this flag is set the sandbox will validate operators within the sandboxed code. If this flag is
disabled then all operator validation, including custom operator validation, will be ignored.
<hr/>
</li>
<li>
<strong>Validate Primitives: </strong> &mdash; Default Value: <em>true</em>
<br/>
If this flag is set the sandbox will validate primitives within the sandboxed code. If this flag is
disabled then all primitive validation, including custom primitive validation, will be ignored.
<hr/>
</li>
<li>
<strong>Validate Types: </strong> &mdash; Default Value: <em>true</em>
<br/>
If this flag is set the sandbox will validate types within the sandboxed code. If this flag is
disabled then all type validation, including custom type validation, will be ignored.
<hr/>
</li>
<li>
<strong>Error Level: </strong> &mdash; Default Value: <em>null</em>
<br/>
If this option is set then sandbox will set the error level to this value before executing the sandboxed code.
<hr/>
</li>
<li>
<strong>Restore Error Level: </strong> &mdash; Default Value: <em>true</em>
<br/>
If this flag is set the sandbox will restore the error level after the sandboxed code has executed.
<hr/>
</li>
<li>
<strong>Convert Errors: </strong> &mdash; Default Value: <em>false</em>
<br/>
If this flag is set the sandbox will convert errors to exceptions during execution of the sandboxed code.
<hr/>
</li>
<li>
<strong>Capture Output: </strong> &mdash; Default Value: <em>false</em>
<br/>
If this flag is set the sandbox will return all output generated by the executed code.
<hr/>
</li>
<li>
<strong>Auto Whitelist Trusted Code: </strong> &mdash; Default Value: <em>true</em>
<br/>
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ It also utilizes [FunctionParser](https://github.com/jeremeamia/FunctionParser)

**Online API Documentation:** [http://fieryprophet.com/phpsandbox-docs/](http://fieryprophet.com/phpsandbox-docs/)

[![Build Status](https://travis-ci.org/fieryprophet/php-sandbox.png?branch=master)](https://travis-ci.org/fieryprophet/php-sandbox) [![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/fieryprophet/php-sandbox/badges/quality-score.png?s=4f2d82525b9e2c6bae18e26cf643ca3fd09333fc)](https://scrutinizer-ci.com/g/fieryprophet/php-sandbox/) [![Code Coverage](https://scrutinizer-ci.com/g/fieryprophet/php-sandbox/badges/coverage.png?s=d6cef7d18a66d2ac39b76410b76c89fa15d84b8c)](https://scrutinizer-ci.com/g/fieryprophet/php-sandbox/) [![Latest Stable Version](https://poser.pugx.org/fieryprophet/php-sandbox/v/stable.png)](https://packagist.org/packages/fieryprophet/php-sandbox) [![Total Downloads](https://poser.pugx.org/fieryprophet/php-sandbox/downloads.png)](https://packagist.org/packages/fieryprophet/php-sandbox) [![Latest Unstable Version](https://poser.pugx.org/fieryprophet/php-sandbox/v/unstable.png)](https://packagist.org/packages/fieryprophet/php-sandbox) [![License](https://poser.pugx.org/fieryprophet/php-sandbox/license.png)](https://packagist.org/packages/fieryprophet/php-sandbox)
[![Build Status](https://travis-ci.org/fieryprophet/php-sandbox.png?branch=master)](https://travis-ci.org/fieryprophet/php-sandbox) [![Latest Stable Version](https://poser.pugx.org/fieryprophet/php-sandbox/v/stable.png)](https://packagist.org/packages/fieryprophet/php-sandbox) [![Total Downloads](https://poser.pugx.org/fieryprophet/php-sandbox/downloads.png)](https://packagist.org/packages/fieryprophet/php-sandbox) [![Latest Unstable Version](https://poser.pugx.org/fieryprophet/php-sandbox/v/unstable.png)](https://packagist.org/packages/fieryprophet/php-sandbox) [![License](https://poser.pugx.org/fieryprophet/php-sandbox/license.png)](https://packagist.org/packages/fieryprophet/php-sandbox)

##Features:

Expand Down
2 changes: 1 addition & 1 deletion src/Error.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
* @namespace PHPSandbox
*
* @author Elijah Horton <[email protected]>
* @version 1.3.6
* @version 1.3.7
*/
class Error extends \Exception {
/* START ERROR CODES */
Expand Down
Loading

0 comments on commit 744cfd5

Please sign in to comment.