crixuamg/laravel-simplicate

This package is abandoned and no longer maintained. No replacement package was suggested.
There is no license information available for the latest version (1.5.1) of this package.

Laravel Simplicate API Client

1.5.1 2023-08-30 13:06 UTC

This package is auto-updated.

Last update: 2024-02-29 12:39:15 UTC


README

For communicating with the Simplicate API.

W.I.P.

Version Compatibility

Laravel Package
5.3.x and older 0.9.x

Installation

Via Composer:

$ composer require CrixuAMG/laravel-simplicate

If you don't use auto-discover, register the Service Provider in your config/app.php:

<?php
    'providers' => [
        // ...
        CrixuAMG\Simplicate\Providers\SimplicateServiceProvider::class,
    ],

Publish the configuration file:

php artisan vendor:publish --provider="CrixuAMG\Simplicate\Providers\SimplicateServiceProvider"

Configuration

Set up your .env file for the following values:

SIMPLICATE_DOMAIN=yoursimplicatesubdomain
SIMPLICATE_API_KEY=yoursimplicateapikey
SIMPLICATE_API_SECRET=yoursimplicateapisecret

Usage

To Do.

Fluent list syntax

For filterable, orderable listings, you can use fluent syntax to set parameters:

<?php
/** @var \CrixuAMG\Simplicate\Services\SimplicateService $service */
$leaveRecords = $service->hrm()
    ->offset(2)
    ->limit(10)
    ->sort('start_date')->descending()
    ->filter(['employee.id' => 'employee:aa24f3857730be716d44e34a3f0f8c3a'])
    ->allLeave();

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.