Download the PHP package celpax/dailypulse without Composer

On this page you can find all versions of the php package celpax/dailypulse. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Informations about the package dailypulse

DailyPulse Client API

This is the Celpax's PHP DailyPulse Client API. Note that:

It matches pretty much the NodeJS API Client.

API Client Architecture

Installation

The PHP DailyPulse client is distributed as a composer package.

You can either include the a dependency in your composer.json file or use composer to download the code to your project.

To install the package to your project do

That will download the package and all the dependencies in to the vendor directory. Remember to:

If you also use composer, you just need to add the dependency to your composer.json as

Check the Composer Package Manager for additional information.

Instanciate the client

In order to instanciate the dailypulse client and start making request you need to do:

You can download your access and secret api keys from DailyPulse dashboard.

Get your sites

DailyPulse can be deployed on one or more company sites. In either case you will need to know the Site ID before you can download metrics related to it.

You can get your sites as follows:

Mood KPI

You can retrieve the latest calculated Mood KPI for a give site as follows:

Note that in some cases the Mood KPI cannot be calculated (for example during rollout) and will be returned as null. A date member will also be included indicating when the Mood KPI was last updated.

Alternatively, you can retrieve the latest calculated global Mood KPI of all the sites of the account as follows:

Historical Mood KPI

You can retrieve the historical calculated Mood KPI for a given site and the number of days to fetch since today as follows:

The maximum number of allowed days to be fetched can be configured in the Celpax Dashboard console. You need administrator privileges for accessing to the configuration section.

Alternatively you can retrieve the historical calculated global mood KPI of all the sites of the account as follows:

Pulses in a Typical Day

Dailypulse will track how many pulses are registered in a typical day. DailyPulse will detect and exclude from this statist days such as weekends in which a couple of people turn up to work, or company parties when there might be an unusual number of pulses.

Again, pulses per typical day might not be calculated for a given site yet, in which case null can be returned.

You can get it in a similar way by doing:

A date member will also be returned indicating when the pulses per typical day was last updated.

Alternatively, you can retrieve the global pulses in a typical day of all the sites of the account as follows:

Historical Pulses in a Typical Day

You can retrieve the historical Pulses in a Typical day for a given site and the number of days to fetch since today as follows:

The maximum number of allowed days to be fetched can be configured in the Celpax Dashboard console. You need administrator privileges for accessing to the configuration section.

Alternatively, you can retrieve the historical global pulses per typical day of all the sites of the account as follows:

User Interface Design

We have released user interface elements, such as: colours, fonts, widgets available in the github project: DailyPulse-Resources

The resources provided match the User Interface of the DailyPulse Dashboard.

Testing

An echo test method has also been include so that you can test your setup as much as you want before pulling real data.

You can use it as follows, for example in one of your unit tests:

Additional information

The tests run through all the API calls available, check them.


All versions of dailypulse with dependencies

PHP Build Version
Package Version
Requires php Version >=5.5
guzzlehttp/guzzle Version ^6.3
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package celpax/dailypulse contains the following files

Loading the files please wait ....