axy/evil

Necessary evil

axy\evil

, _(*1)

• The library does not require any dependencies.
• Tested on PHP 5.4+, PHP 7, HHVM (on Linux), PHP 5.5 (on Windows).
• Install: composer require axy/evil.
• License: MIT.

Documentation

Some language features are not recommended for frequent use. eval(), exit, global variables, direct access to super-global arrays., _(*2)

But sometimes it is necessary. If you use static code analyzer, it will swear. We'll have to suppress messages., _(*3)

/** @SuppressWarnings(PHPMD.Superglobals) */
$x = $_POST['x'];

This library encapsulates the "evil" features. You simply call methods and disclaims any sin., _(*4)

API

Classes are in the namespace axy\evil., _(*5)

Evil

It contains calls of "evil" functions. So how exit, echo and etc is keywords methods have other names., _(*6)

eval - execCode

Evil::execCode('2 + 2'); // 4

exit - stop

Evil::stop(); // exit
Evil::stop(5); // exit with code 5

breakpoint()

breakpoint(mixed $message [, bool $line [, bool $file [, int $status]);

Shows debugging information and terminates the current script (with the status from $status)., _(*7)

If $message is not a scalar then used print_r()., _(*8)

If specified $line: shows the line number of the breakpoint. For $file shows the file name., _(*9)

Evil::breakpoint('point'); // point
Evil::breakpoint('point', true); // 15: point
Evil::breakpoint('point', true, true); // /path/to/script.php:15: point

In CLI mode the $message completes new line. In HTTP mode the $message enclosed in <pre>., _(*10)

echo - out

Evil::out($message);

Sends a string to the stdout stream., _(*11)

Superglobals

Static methods of axy\evil\Superglobals:, _(*12)

• getSERVER()
• getGET()
• getPOST()
• getREQUEST()
• getCOOKIE()
• getFILES()
• getSESSION()
• getENV()

Return the corresponding superglobals arrays. The data is returned by reference., _(*13)

$session = Superglobals::getSESSION();
$session['var'] = 'value'; // no effect

$session = &Supeglobals::getSESSION();
$session['var'] = 'value'; // success

Globals

Static methods:, _(*14)

• getGLOBALS(): returns $_GLOBALS by reference
• get($name [, $default]): returns the value of a global variable (or $default if the variable not found)
• set($name, $value): set
• remove($name): unset