Doc how to use

Tables of contents

• The easiest way
• The smartest way

---

The easiest way

Fast and easy.

// Add namespace at the top
use Performance\Performance;

// Set measure point
Performance::point();

//
// Run test code
//

// Finish all tasks and show test results
Performance::results();

The smartest way

Scalable, point label is automatically filled in by the function name.

use Performance\Performance;
use Performance\Config;

class Foo
{
    public function __construct()
    {
        // You can specify the characters you want to strip
        Config::setPointLabelLTrim('synchronize');
        Config::setPointLabelRTrim('Run');
        Config::setPointLabelNice(true);

        $this->synchronizeTaskA();
        $this->synchronizeTaskB();

        // Finish all tasks and show test results
        Performance::results();
    }

    public function synchronizeTaskA()
    {
        // Set point Task A
        Performance::point(__FUNCTION__);

        //
        // Run code
        sleep(1);
        //

        // Finish point Task A
        Performance::finish();
    }

    public function synchronizeTaskB()
    {
        // Set point Task B
        Performance::point(__FUNCTION__);

        //
        // Run code
        sleep(1);
        //

        // Finish point Task B
        Performance::finish();
    }
}