clue/caret-notation

^B A dead-simple PHP library to add caret notation in order to safely show strings that contain ASCII control characters (unprintable characters)

v0.2.0 2015-06-19 18:29 UTC

README

^B A dead-simple PHP library to add caret notation in order to safely show strings that contain ASCII control characters (unprintable characters)

Quickstart example

Once installed, you can use the following code to use caret notation for any string that (may possibly) contain binary control characters:

$encoder = new Encoder();

$string = "Hello\r\nworld\0";
// Output: Hello^M^Jworld^@
echo $encoder->encode($string);

$string = "No control chars";
// Output: No control chars
echo $encoder->encode($string);

Install

The recommended way to install this library is through composer. New to composer?

{
    "require": {
        "clue/caret-notation": "~0.2.0"
    }
}

License

MIT