Skip to content

Latest commit

 

History

History
97 lines (62 loc) · 2.43 KB

README.md

File metadata and controls

97 lines (62 loc) · 2.43 KB
Raw

PHP console.log()

PHP console.log() allows you to dump PHP variables in the browser's console. It is an easy-to-use and lightweight PHP library.

Installation

With Composer

composer require nyratas/php-console-log

Manually

Just download/clone this repository and require the autoload file:

require_once(__DIR__ . '/PHPConsoleLog/__autoload.php');

Usage

More detailed working examples can be found in the ./examples/ directory.

Don't forget to use the library's facade:

use PHPConsoleLog\Service as Console;

Basic PHP console.log()

Define a place where the library should output the console logs:

Console::exec();

You can now use the Console::log() method everywhere, as long as it is called before a Console::exec() call.

$myArray = ['one','two','three'];

Console::log($myArray);

You can use Console::log() with any type of variable. If you want to output an PHP array or object, the library will show a JavaScript Array or Object in the browser's console. A boolean will remain a boolean, an integer will remain an integer, a string remain a string, and so on.

Edit the <script> tag

All this library does is generating a <script>-tag at the location of the Console::exec() call.

This tag contains the required JavaScript logic in order to output the requested data in the browser's console. There is not much you can do on the generated JavaScript code, but you could want to add an attribute on the <script> tag.

The library generates the following default HTML markup:

<script type="text/javascript" data-php-console-log="true">
      [...]
</script>

You can remove or modify the data-php-console-log attribute by setting it as follows:

/*
 * Remove the attribute :
 */

Console::setAttribute();
      // or
Console::setAttribute(false);


/*
 * Edit the attribute :
 */

      // simple attribute
Console::setAttribute('data-my-attribute');
      // attribute with value
Console::setAttribute('data-my-attribute','attribute-value');

Wordpress tip

Do you want to use this library on a wordpress theme ? Just add the following line in your functions.php file and start Console::log()-ing right now !

add_action( 'wp_footer', function(){ Console::exec(); }, 100 );

What now ?

Well, I wrote this library in a hurry, so there's probably a lot to change/add. Feel free to contribute or to request some changes.

Enjoy!