campusunion/sked-laravel

Laravel Service Provider for Sked.

v0.0.5 2016-09-14 04:20 UTC

Requires

• php: >=7.0
• campusunion/sked: 0.*

Requires (Dev)

• laravel/framework: ~5.2

MIT

• Mark Potter

• php
• schedule
• calendar

README

Laravel 5 Service Provider for Sked.

Installation & Setup

Install the Sked Service Provider via Composer by adding the camusunion/sked-laravel package to the require object in your project's composer.json.

{
    ...
    "require": {
        "camusunion/sked-laravel": "dev-master"
    },
    ...
}

NOTE: This package automatically requires camusunion/sked, so you do NOT have to add it separately to your composer.json.

Then run composer update.

Next, add the Sked Service Provider to the providers array in config/app.php.

    'providers' => [
        ...
        CampusUnion\SkedServiceProvider::class,
    ],

Add the Sked facade to the aliases array in config/app.php.

    'aliases' => [
        ...
        'Sked' => CampusUnion\SkedFacade::class,
    ],

Configuration

The following environment variables are used to configure Sked:

SKED_DC_NAME=PDO
SKED_DC_DRIVER=mysql
SKED_DC_HOST=${DB_HOST}
SKED_DC_DBNAME=${DB_DATABASE}
SKED_DC_USER=${DB_USERNAME}
SKED_DC_PASS=${DB_PASSWORD}

Optional

To customize the configuration options, publish the configuration file using Artisan:

php artisan vendor:publish

Update your settings in the generated app/config/sked.php configuration file.

Usage

foreach (Sked::skeDates() as $skeDate) {
    // do something
}