File: README.md

Recommend this page to a friend!

README.md

File:	`README.md`
Role:	Documentation
Content type:	`text/markdown`
Description:	Documentation
Class:	PHP Load Page Time Calculate the time a script or a page takes to run
Author:	By Josantonius
Last change:
Date:	6 years ago
Size:	`5,372 bytes`

Download

PHP LoadTime library

Versi�n en espa�ol

Calculate load time of pages or scripts.

Requirements
Installation
Available Methods
Quick Start
Usage
Tests
TODO
Contribute
Repository
License
Copyright

Requirements

This library is supported by PHP versions 5.6 or higher and is compatible with HHVM versions 3.0 or higher.

Installation

The preferred way to install this extension is through Composer.

To install PHP LoadTime library, simply:

$ composer require Josantonius/LoadTime

The previous command will only install the necessary files, if you prefer to download the entire source code you can use:

$ composer require Josantonius/LoadTime --prefer-source

You can also clone the complete repository with Git:

$ git clone https://github.com/Josantonius/PHP-LoadTime.git

Or install it manually:

Download LoadTime.php:

$ wget https://raw.githubusercontent.com/Josantonius/PHP-LoadTime/master/src/LoadTime.php

Available Methods

Available methods in this library:

- Set initial time:

LoadTime::start();

# Return (float) ? microtime

- Set end time:

LoadTime::end();

# Return (float) ? seconds

- Check if the timer has been started:

LoadTime::isActive();

# Return (boolean)

Quick Start

To use this library with Composer:

require __DIR__ . '/vendor/autoload.php';

use Josantonius\LoadTime\LoadTime;

Or If you installed it manually, use it:

require_once __DIR__ . '/LoadTime.php';

use Josantonius\LoadTime\LoadTime;

Usage

Example of use for this library:

<?php
require __DIR__ . '/vendor/autoload.php';

use Josantonius\LoadTime\LoadTime;

LoadTime::start();

for ($i=0; $i < 100000; $i++) { 
    // print_r($i . ' ');
}

print_r('Script executed in: ' . LoadTime::end() . ' seconds.'); 

/Script executed in: 0.0012 seconds./

Tests

To run tests you just need composer and to execute the following:

$ git clone https://github.com/Josantonius/PHP-LoadTime.git

$ cd PHP-LoadTime

$ composer install

Run unit tests with PHPUnit:

$ composer phpunit

Run PSR2 code standard tests with PHPCS:

$ composer phpcs

Run PHP Mess Detector tests to detect inconsistencies in code style:

$ composer phpmd

Run all previous tests:

$ composer tests

? TODO

[ ] Add new feature.
[ ] Improve tests.
[ ] Improve documentation.
[ ] Refactor code for disabled code style rules. See phpmd.xml and .php_cs.dist.

Contribute

If you would like to help, please take a look at the list of issues or the To Do checklist.

Pull requests

Fork and clone.
Run the command `composer install` to install the dependencies. This will also install the dev dependencies.
Run the command `composer fix` to excute code standard fixers.
Run the tests.
Create a branch, commit, push and send me a pull request.