midnite81/timekeeper

A series of scopes for Laravel Models to do with Time Management.

Installs: 2 718

Dependents: 0

Suggesters: 0

Stars: 1

Watchers: 2

Forks: 1

Open Issues: 0

Type:php

0.2.1 2016-06-20 19:10 UTC

README

A series of scopes for Laravel Models to do with Time Management.

Please note: This project is a work in progress.

Relationship Diagram

Relationship Diagram

#Installation

This package requires PHP 5.6+ and Laravel 5.

To install through composer include the package in your composer.json.

"midnite81/timekeeper": "0.2.*"

Run composer install or composer update to download the dependencies or you can run composer require midnite81/timekeeper.

##Laravel 5 Integration

There is no service provider to install. Simply include the trait to the model you need to use it on.

Example Usage

On your model simply add the use statement to the Model you want to use it on.

use Midnite81\TimeKeeper\Traits\TimeKeeper;

class YourModel
{
    use TimeKeeper;

    ...

}

Then reference it in your controller or service etc;

public function check() {

    $overlap = YourModel::overlapsWith('2016-01-01 15:32:00', '2016-01-01 16:46:00')->exists();

    $after = YourModel::after('2016-01-01 10:00:00', 2016-01-01 11:00:00', 'start', 'end')->exists();

    ...

}

All scopes take the following arguments

  • Start DateTime (yyyy-mm-dd hh:ii)
  • End DateTime (yyyy-mm-dd hh:ii)
  • Start Time Column in Database (optional, defaults to start_time)
  • End Time Column in Database (optional, defaults to end_time)