jacobemerick/pqp

<?php

/*****************************************
 * Title : PHP Quick Profiler Console Class
 * Author : Created by Ryan Campbell
 * URL : http://particletree.com/features/php-quick-profiler/
 * Description : This class serves as a wrapper to hold onto
 *  various messages and profiling data
 *****************************************/

namespace Particletree\Pqp;

use Exception;

class Console
{

    /** @var  array */
    protected $store = array();

    /**
     * Logs data to the console
     * Accepts any data type
     *
     * @param mixed $data
     */
    public function log($data)
    {
        array_push($this->store, array(
          'data' => $data,
          'type' => 'log'
        ));
    }

    /**
     * Logs memory usage of a variable
     * If no parameter is passed in, logs current memory usage
     *
     * @param mixed $object
     * @param string $name
     * @param boolean $literal
     */
    public function logMemory($object = null, $name = 'PHP', $literal = false)
    {
        $memory = memory_get_usage();
        $dataType = '';
        if (!is_null($object) && !$literal) {
            $memory = strlen(serialize($object));
            $dataType = gettype($object);
        } else if (is_numeric($object) && $literal) {
            $memory = floatval($object);
        }

        array_push($this->store, array(
            'name'      => $name,
            'data'      => $memory,
            'data_type' => $dataType,
            'type'      => 'memory'
        ));
    }

    /**
     * Logs exception with optional message override
     *
     * @param Exception $exception
     * @param string    $message
     */
    public function logError(Exception $exception, $message = '')
    {
        if (empty($message)) {
            $message = $exception->getMessage();
        }

        array_push($this->store, array(
            'data' => $message,
            'file' => $exception->getFile(),
            'line' => $exception->getLine(),
            'type' => 'error'
        ));
    }

    /**
     * Logs current time with optional message
     *
     * @param string $name
     * @param float  $literalTime
     */
    public function logSpeed($name = 'Point in Time', $literalTime = null)
    {
        $time = microtime(true);
        if (!is_null($literalTime) && is_float($literalTime)) {
            $time = $literalTime;
        }

        array_push($this->store, array(
            'data' => $time,
            'name' => $name,
            'type' => 'speed'
        ));
    }

    /**
     * Returns the collected logs
     *
     * @returns array
     */
    public function getLogs()
    {
        return $this->store;
    }
}