cherrypulp/laravel-active-collab

A laravel active collab

dev-master 2019-10-04 09:30 UTC

This package is auto-updated.

Last update: 2022-11-11 05:09:53 UTC


README

Build Status styleci Scrutinizer Code Quality SensioLabsInsight Coverage Status

Packagist Packagist Packagist

Package description: Wrapper for the Active Collab SDK, adapted to Laravel

Installation

Install via composer

composer require cherrypulp/laravel-active-collab

Register Service Provider

Note! This and next step are optional if you use laravel>=5.5 with package auto discovery feature.

Add service provider to config/app.php in providers section

Cherrypulp\LaravelActiveCollab\ServiceProvider::class,

Register Facade

Register package facade in config/app.php in aliases section

Cherrypulp\LaravelActiveCollab\Facades\LaravelActiveCollab::class,

Publish Configuration File

php artisan vendor:publish --provider="Cherrypulp\LaravelActiveCollab\ServiceProvider" --tag="config"

Usage

Update the config in your env file.

ACTIVECOLLAB_COMPANY=******
ACTIVECOLLAB_APP_NAME=******
ACTIVECOLLAB_MAIL=******
ACTIVECOLLAB_PASSWORD=******
ACTIVECOLLAB_URL=******

Available methods:

  • getOpenProjects(): get all open projects
  • getProjectTasks($project_id): get the open tasks from a project
  • getCompanyUsers($company_id): get non-archived users of a company
  • getUserByEmail($email): get specified user
  • postTimeRecord($date, $duration, $user_id, $project_id, $task_id)
  • deleteRecordsByDay($date, $user_id)

Security

If you discover any security related issues, please email instead of using the issue tracker.

Credits

  • Simon Vreux

This package is bootstrapped with the help of cherrypulp/laravel-package-generator.