README

A Laravel package that provides a convenient wrapper around the YourStoryz PHP SDK. It handles authentication and service registration out of the box, so you can start interacting with the YourStoryz API right away.

use YourStoryz\LaravelYourStoryz\Facades\YourStoryz;

$companies = YourStoryz::companies()->all();
$me = YourStoryz::users()->me();

Installation

You can install the package via composer:

composer require sharestoryz/laravel-yourstoryz

You can publish the config file with:

php artisan vendor:publish --tag="laravel-yourstoryz-config"

This is the contents of the published config file:

return [

    'api_token' => env('YOURSTORYZ_API_TOKEN', ''),

    'base_url' => env('YOURSTORYZ_API_URL', 'https://dashboard.yourstoryz.com'),

];

Usage

use YourStoryz\LaravelYourStoryz\Facades\YourStoryz;

// Companies
$companies = YourStoryz::companies()->all();
$company = YourStoryz::companies()->get($companyId);
$stories = YourStoryz::companies()->stories($companyId);
$videos = YourStoryz::companies()->publishedVideos($companyId);

// Departments
$departments = YourStoryz::departments()->all();
$department = YourStoryz::departments()->get($departmentId);

// Stories
$stories = YourStoryz::stories()->all();
$story = YourStoryz::stories()->get($storyId);

// Users
$me = YourStoryz::users()->me();
$userStories = YourStoryz::users()->stories($userId);

// Published Videos
$video = YourStoryz::publishedVideos()->get($videoId);

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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

sharestoryz / laravel-yourstoryz

Maintainers

Package info

Fund package maintenance!

Statistics

Security