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

Commit 744cfd5

Browse files
fieryprophetfieryprophet
committed
- Updated documentation
1 parent 647f5d5 commit 744cfd5

File tree

10 files changed

+150
-173
lines changed

10 files changed

+150
-173
lines changed

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
- 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!
55
- Fixed issue with toolkit giving incorrect error and exception messages
66
- 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())
7+
- Updated documentation
78

89
##05/06/2014
910
- Corrected defined alias case-sensitivity issue (see: issue #10)

‎MANUAL.html‎

Lines changed: 130 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ <h3>1 - About PHPSandbox &amp; PHPSandbox Toolkit</h3>
3434
</a>
3535
<br/>
3636
<h1 style="margin: 0;">
37-
PHPSandbox Toolkit 1.3.6
37+
PHPSandbox Toolkit 1.3.7
3838
</h1>
3939
<br/>
4040
<strong>Developed by: </strong> <a href="http://www.fieryprophet.com" target="_blank">Elijah Horton</a>
@@ -120,6 +120,135 @@ <h3>Options</h3>
120120
<pre>$sandbox->set_option('allow_functions', false);</pre>
121121
<h4>Option Descriptions</h4>
122122
<ul>
123+
<li>
124+
<strong>Validate Functions: </strong> &mdash; Default Value: <em>true</em>
125+
<br/>
126+
If this flag is set the sandbox will validate functions within the sandboxed code. If this flag is
127+
disabled then all function validation, including custom function validation, will be ignored.
128+
<hr/>
129+
</li>
130+
<li>
131+
<strong>Validate Variables: </strong> &mdash; Default Value: <em>true</em>
132+
<br/>
133+
If this flag is set the sandbox will validate variables within the sandboxed code. If this flag is
134+
disabled then all variable validation, including custom variable validation, will be ignored.
135+
<hr/>
136+
</li>
137+
<li>
138+
<strong>Validate Globals: </strong> &mdash; Default Value: <em>true</em>
139+
<br/>
140+
If this flag is set the sandbox will validate globals within the sandboxed code. If this flag is
141+
disabled then all global validation, including custom global validation, will be ignored.
142+
<hr/>
143+
</li>
144+
<li>
145+
<strong>Validate Superglobals: </strong> &mdash; Default Value: <em>true</em>
146+
<br/>
147+
If this flag is set the sandbox will validate superglobals within the sandboxed code. If this flag is
148+
disabled then all superglobal validation, including custom superglobal validation, will be ignored.
149+
<hr/>
150+
</li>
151+
<li>
152+
<strong>Validate Constants: </strong> &mdash; Default Value: <em>true</em>
153+
<br/>
154+
If this flag is set the sandbox will validate constants within the sandboxed code. If this flag is
155+
disabled then all constant validation, including custom constant validation, will be ignored.
156+
<hr/>
157+
</li>
158+
<li>
159+
<strong>Validate Magic Constants: </strong> &mdash; Default Value: <em>true</em>
160+
<br/>
161+
If this flag is set the sandbox will validate magic constants within the sandboxed code. If this flag is
162+
disabled then all magic constant validation, including custom magic constant validation, will be ignored.
163+
<hr/>
164+
</li>
165+
<li>
166+
<strong>Validate Namespaces: </strong> &mdash; Default Value: <em>true</em>
167+
<br/>
168+
If this flag is set the sandbox will validate namespaces within the sandboxed code. If this flag is
169+
disabled then all namespace validation, including custom namespace validation, will be ignored.
170+
<hr/>
171+
</li>
172+
<li>
173+
<strong>Validate Aliases (aka Use): </strong> &mdash; Default Value: <em>true</em>
174+
<br/>
175+
If this flag is set the sandbox will validate aliases within the sandboxed code. If this flag is
176+
disabled then all alias validation, including custom alias validation, will be ignored.
177+
<hr/>
178+
</li>
179+
<li>
180+
<strong>Validate Classes: </strong> &mdash; Default Value: <em>true</em>
181+
<br/>
182+
If this flag is set the sandbox will validate classes within the sandboxed code. If this flag is
183+
disabled then all class validation, including custom class validation, will be ignored.
184+
<hr/>
185+
</li>
186+
<li>
187+
<strong>Validate Interfaces: </strong> &mdash; Default Value: <em>true</em>
188+
<br/>
189+
If this flag is set the sandbox will validate interfaces within the sandboxed code. If this flag is
190+
disabled then all interface validation, including custom interface validation, will be ignored.
191+
<hr/>
192+
</li>
193+
<li>
194+
<strong>Validate Traits: </strong> &mdash; Default Value: <em>true</em>
195+
<br/>
196+
If this flag is set the sandbox will validate traits within the sandboxed code. If this flag is
197+
disabled then all trait validation, including custom trait validation, will be ignored.
198+
<hr/>
199+
</li>
200+
<li>
201+
<strong>Validate Keywords: </strong> &mdash; Default Value: <em>true</em>
202+
<br/>
203+
If this flag is set the sandbox will validate keywords within the sandboxed code. If this flag is
204+
disabled then all keyword validation, including custom keyword validation, will be ignored.
205+
<hr/>
206+
</li>
207+
<li>
208+
<strong>Validate Operators: </strong> &mdash; Default Value: <em>true</em>
209+
<br/>
210+
If this flag is set the sandbox will validate operators within the sandboxed code. If this flag is
211+
disabled then all operator validation, including custom operator validation, will be ignored.
212+
<hr/>
213+
</li>
214+
<li>
215+
<strong>Validate Primitives: </strong> &mdash; Default Value: <em>true</em>
216+
<br/>
217+
If this flag is set the sandbox will validate primitives within the sandboxed code. If this flag is
218+
disabled then all primitive validation, including custom primitive validation, will be ignored.
219+
<hr/>
220+
</li>
221+
<li>
222+
<strong>Validate Types: </strong> &mdash; Default Value: <em>true</em>
223+
<br/>
224+
If this flag is set the sandbox will validate types within the sandboxed code. If this flag is
225+
disabled then all type validation, including custom type validation, will be ignored.
226+
<hr/>
227+
</li>
228+
<li>
229+
<strong>Error Level: </strong> &mdash; Default Value: <em>null</em>
230+
<br/>
231+
If this option is set then sandbox will set the error level to this value before executing the sandboxed code.
232+
<hr/>
233+
</li>
234+
<li>
235+
<strong>Restore Error Level: </strong> &mdash; Default Value: <em>true</em>
236+
<br/>
237+
If this flag is set the sandbox will restore the error level after the sandboxed code has executed.
238+
<hr/>
239+
</li>
240+
<li>
241+
<strong>Convert Errors: </strong> &mdash; Default Value: <em>false</em>
242+
<br/>
243+
If this flag is set the sandbox will convert errors to exceptions during execution of the sandboxed code.
244+
<hr/>
245+
</li>
246+
<li>
247+
<strong>Capture Output: </strong> &mdash; Default Value: <em>false</em>
248+
<br/>
249+
If this flag is set the sandbox will return all output generated by the executed code.
250+
<hr/>
251+
</li>
123252
<li>
124253
<strong>Auto Whitelist Trusted Code: </strong> &mdash; Default Value: <em>true</em>
125254
<br/>

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ It also utilizes [FunctionParser](https://github.com/jeremeamia/FunctionParser)
88

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

11-
[![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)
11+
[![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)
1212

1313
##Features:
1414

‎src/Error.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
* @namespace PHPSandbox
1212
*
1313
* @author Elijah Horton <fieryprophet@yahoo.com>
14-
* @version 1.3.6
14+
* @version 1.3.7
1515
*/
1616
class Error extends \Exception {
1717
/* START ERROR CODES */

0 commit comments

Comments
 (0)