Download the PHP package jcm/footprint-php without Composer
On this page you can find all versions of the php package jcm/footprint-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jcm/footprint-php
More information about jcm/footprint-php
Files in jcm/footprint-php
Package footprint-php
Short Description composer package that allows you to monitor and retrieve custom stats about your running php script
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package footprint-php
footprint-php
Composer package that allows you to trace/monitor and retrieve/calculate/generate custom stats about your running php script.
It is build in a modular way and event triggers, really easy to follow and customize.
The package already comes with some modules likes:
- ChartJS line chart report (output only)
- CSV report (log and output)
- Time tracking (log)
- Memory tracking (log)
Code is really simple and short, so you can quickly pick it up and create your own code.
Quick intro
Installation
Step by Step usage example and output
In this code we want to measure how much time and memory a function call or class method uses.
Keep in mind that is a demo example, you will not have to initialize more than once if you code properly.
Basically in the example we create a class called SomeClassName with a method called testMethod and we are gonna measure time and memory usage of this method when its called.
We will do this example by creating a php project from scratch, if you already have a project, adjust the example to your needs.
Step 1: Create a php project with composer
Run composer init and create a project , name it as you want.
While the wizard asks you different questions about the project, it will ask you about what dependencies you want to install, leave it blank for now.
It looks something like this:
Would you like to define your dependencies (require) interactively [yes]? no answer no.
Step 2: Install footprint-php package
Run composer require jcm/footprint-php
You should get an output like this:
Step 4: Create an index.php with our code
Run touch index.php
With the following code inside
Step 5: Execute the example
From the command line run php -f index.php
Step 6: Check the results
If everything went ok, then you should have a file called report.html, and the content should look something like this:
Why this package?
This package was created in order to have a simple and small package, customizable, that could allow you to retrieve data while you execute your php scripts.
Documentation (Work in progress)
Please refer to the wiki section of the project to learn more about the package design, usage, and how to extend it.
Contributing to the project
Even though I am working on this package in order to improve it, feel free to open issues, send pull requests, creating new modules or enhancing the existing ones, etc.
It is possible to create advance modules (like a live dashboard with websocket connection to update data on it, so we can have a real-time dashboard, etc.), but for the first release of this package I wanted to keep it simple and functional.
All kind of help is welcome
Autor
Juan Carlos Morales [email protected]
