calq / calq
Calq API client for PHP
Installs: 4 526
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 2
Forks: 1
Open Issues: 1
Requires
- php: >=5.3.0
- ext-json: *
- lib-curl: *
This package is not auto-updated.
Last update: 2025-07-29 12:02:53 UTC
README
The full quick start and reference docs can be found at: https://www.calq.io/docs/client/php
Installation
###Using composer (recommended)
Install the latest release of the library through Composer with the following command:
composer require calq/calq
###Old-style copy-and-paste
Grab the latest release and add it to your project.
You will need to include the CalqClient library where you intend to use it. The library requires PHP 5.2 or higher.
require_once("/path/to/Client-PHP/lib/CalqClient.php");
Getting a client instance
The easiest way to get an instance of the client is to use the static CalqClient::fromCurrentRequest method. This will create a client using any cookie already data set for the current web request. If the current user has never been seen before the client will remember them in future by writing a cookie to the response.
You will need to add your Calq project's write key where it says YOUR_WRITE_KEY_HERE. You can find your write key from the project settings option inside Calq.
// Get an instance populated from the current request $calq = CalqClient::fromCurrentRequest('YOUR_WRITE_KEY_HERE');
The PHP client is compatible with the JavaScript client. Any properties set client side using JavaScript will be read by the PHP client when using the CalqClient::fromCurrentRequest method. Likewise any properties set server side will be persisted to a cookie to be read browser side.
Tracking actions
Calq performs analytics based on actions that user's take. You can track an action using track. Specify the action and any associated data you wish to record.
// Track a new action called 'Product Review' with a custom rating $calq->track('Product Review', array('Rating' => 9.0));
The array parameter allows you to send additional custom data about the action. This extra data can be used to make advanced queries within Calq.
Documentation
The full quick start can be found at: https://www.calq.io/docs/client/php
The reference can be found at: https://www.calq.io/docs/client/php/reference