PHPackages locardi/php-sdk - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. locardi/php-sdk ActiveLibrary[Utility & Helpers](/categories/utility) locardi/php-sdk =============== A SDK for Locardi forensics v0.2.0(7y ago)0193PHPPHP >=5.6 Since Jul 7Pushed 7y ago2 watchersCompare [ Source](https://github.com/locardi/php-sdk)[ Packagist](https://packagist.org/packages/locardi/php-sdk)[ RSS](/packages/locardi-php-sdk/feed)WikiDiscussions master Synced 3d ago READMEChangelogDependencies (4)Versions (4)Used By (0) Locardi PHP SDK =============== [](#locardi-php-sdk) Installation ------------ [](#installation) ``` composer require locardi/php-sdk "dev-master" ``` Usage ----- [](#usage) ``` use Locardi\PhpSdk\Authentication\JwtAuthentication\TokenStorage\FileTokenStorage; use Locardi\PhpSdk\LocardiClient; use Locardi\PhpSdk\Api\OrganizationUserRequestApi; $client = new LocardiClient(array( 'debug' => true, 'username' => 'myusername', 'password' => 'mypassword', 'endpoint' => '', // this is optional and overrides the API endpoing (used for sandbox) 'tokenStorage' => new FileTokenStorage(__DIR__), 'timeout' => 10, // OPTIONAL number of senconds before curl timeout (default is 30 seconds) )); $client->send(array( 'organization_user_request' => array( // this is the type of the page that the user has opened (html_page,login,login_failed,download) 'request_type' => OrganizationUserRequestApi::REQUEST_TYPE_HTML_PAGE, // the IP Address of the user 'ip_address' => '8.8.8.8', // the HTTP method used by the user (GET,POST,OPTION,PUT,DELETE) 'http_method' => 'GET', // the timestamp when the user request was generated 'timestamp' => date('c'), // the user agent used by the user 'user_agent' => 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/57.0.2987.110 Safari/537.36', // the full address requested by the user (including query string, anchors etc) 'uri' => 'https://www.getlocardi.com/?param1=value1¶m2=value2', // the organization in which the user is 'organization' => array( 'id' => '123', // note that this is a string 'name' => 'Organization1', ), // some details on the user 'user' => array( 'id' => '123', // note that this is a string 'name' => 'User1', // you can fill this field with the username,email or any other unique id // this is the user type and represents whether the user is internal (like an admin/editor account) or external (like a normal user) 'type' => OrganizationUserRequestApi::USER_TYPE_INTERNAL, // the timezone where the user lives 'timezone' => 'Europe/London', ), ), )); ``` Request Types ------------- [](#request-types) You can send requests with different types base on what you need to track: - `OrganizationUserRequestApi::REQUEST_TYPE_HTML_PAGE` when the user visits a normal web page - `OrganizationUserRequestApi::REQUEST_TYPE_LOGIN` when the user is attempting the login - `OrganizationUserRequestApi::REQUEST_TYPE_LOGIN_FAILED` when the login attempt has failed for any reason - `OrganizationUserRequestApi::REQUEST_TYPE_DOWNLOAD` when the user has downloaded a file User types ---------- [](#user-types) You may have the need to differentiate between your own users' accounts (such as admin accounts etc) and your clients' accounts. - `OrganizationUserRequestApi::USER_TYPE_INTERNAL` these are users that you consider internal to your organization (i.e. admins, editors, etc) - `OrganizationUserRequestApi::USER_TYPE_EXTERNAL` these are users that are using your service (actual clients that you want to track) Token Storage ------------- [](#token-storage) The Locardi API implements a JSON Web Token authentication system. The SDK requires a way to store the JSON Web Token, for this reason we provide a `TokenStorageInterface` that you can use to save the token in any storage system. We provide a simple `FileTokenStorage` class that saves the token on the filesystem but you can write your own adapter simply using the `TokenStorageInterface`. ### Health Score 24 — LowBetter than 32% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity10 Limited adoption so far Community8 Small or concentrated contributor base Maturity50 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~215 days Total 3 Last Release 2804d ago PHP version history (2 changes)v0.1.0PHP >=5.3.9 v0.2.0PHP >=5.6 ### Community Maintainers ![](https://www.gravatar.com/avatar/c18450be41028098fd57d756875b900ba29b3ec8725deb05e94c31d7e7407193?d=identicon)[michcald](/maintainers/michcald) --- Top Contributors [![michcald](https://avatars.githubusercontent.com/u/5589662?v=4)](https://github.com/michcald "michcald (1 commits)") ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/locardi-php-sdk/health.svg) ``` [![Health](https://phpackages.com/badges/locardi-php-sdk/health.svg)](https://phpackages.com/packages/locardi-php-sdk) ``` PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)