H4ad / laravel-scheduler

src/Scheduler/Scheduler.php

Indentation +192 added lines, -192 removed lines

@@ -18,196 +18,196 @@
 
 class Scheduler
 {
-    /**
-     * Laravel application
-     *
-     * @var \Illuminate\Foundation\Application
-     */
-    public $app;
-
-    /**
-     * Create a new confide instance.
-     *
-     * @param \Illuminate\Foundation\Application $app
-     *
-     * @return void
-     */
-    public function __construct($app)
-    {
-        $this->app = $app;
-    }
-
-    /**
-     * Escopo de uma consulta que busca horarios pela data de início.
-     *
-     * @param string $model_type
-     * @param string|\Carbon\Carbon $start_at
-     * @param string|\Carbon\Carbon $end_at
-     * @return bool
-     */
-    public function hasScheduleBetween($model_type, $start_at, $end_at)
-    {
-        if(!Config::get('scheduler.enable_schedule_conflict'))
-            return false;
-
-        return !is_null(
-            Schedule::latest()
-                ->where('model_type', $model_type)
-                ->where('start_at', '>=', $start_at)
-                ->where('end_at', '<=', $end_at)
-                ->first()
-        );
-    }
-
-    /**
-     * Retorna os horários disponiveis hoje para uma determinada model.
-     * .
-     * @param  string  $model_type Tipo da model
-     * @param  int    $duration Serve para facilitar na hora de buscar horários livres
-     *                          que precisem ter uma certa duração.
-     * @param \Carbon\Carbon|null $openingTime Serve como referencia para buscar horários livres.
-     *                                         Se for nulo, ele busca a referencia da config.
-     * @return array
-     */
-    public function availableToday($model_type, $duration, $openingTime = null)
-    {
-        return $this->availableOn($model_type, Carbon::now(), $duration, $openingTime);
-    }
-
-    /**
-     * Retorna os horários disponiveis em um determinado dia para uma certa model.
-     *
-     * @param  string  $model_type Tipo da model
-     * @param  \Carbon\Carbon $today Data para o qual ele irá fazer a busca.
-     * @param  int    $durationMinutes Serve para facilitar na hora de buscar horários livres
-     *                          que precisem ter uma certa duração.
-     * @param \Carbon\Carbon|null $openingTime Serve como referencia para buscar horários livres.
-     *                                         Se for nulo, ele busca a referencia da config.
-     * @return array
-     */
-    public function availableOn($model_type, $today, $durationMinutes, $openingTime = null)
-    {
-        $openingTime = $openingTime ?? Carbon::parse(Config::get('scheduler.opening_time'))->setDateFrom($today);
-        $closingTime = Carbon::parse(Config::get('scheduler.closing_time'))->setDateFrom($today);
-
-        $livres = [];
-        $today = Carbon::parse($today->toDateString());
-        while($openingTime <= $closingTime)
-        {
-            $add = true;
-
-            $opening = Carbon::parse($openingTime->toDateTimeString());
-            $closing = Carbon::parse($openingTime->toDateTimeString())->addMinutes($durationMinutes);
-
-            foreach (Schedule::where('model_type', $model_type)->orderBy('start_at', 'DESC')->cursor() as $schedule) {
-                $start = Carbon::parse($schedule->start_at);
-                $begin = Carbon::parse($start->toDateString());
-
-                if($begin->greaterThan($today))
-                    break;
-
-                if($begin->notEqualTo($today))
-                    continue;
-
-                $end = Carbon::parse($schedule->end_at);
-
-                if($this->isShouldntAdd($opening, $closing, $start, $end))
-                    $add = false;
-            }
-
-            if($add && $closing->lessThanOrEqualTo($closingTime))
-                $livres[] = [
-                    'start_at' => $opening,
-                    'end_at' => $closing
-                ];
-
-            $openingTime->addMinutes($durationMinutes);
-        }
-
-        return $livres;
-    }
-
-    /**
-     * Verifica se ele não deve ser adicionado ao array de horários livres.
-     *
-     * @param  \Carbon\Carbon  $opening
-     * @param  \Carbon\Carbon  $closing
-     * @param  \Carbon\Carbon  $start
-     * @param  \Carbon\Carbon  $end
-     * @return boolean
-     */
-    private function isShouldntAdd($opening, $closing, $start, $end)
-    {
-        return $start <= $opening && $end >= $closing;
-    }
-
-    /**
-     * Valida e retorna os dados formatados de forma correta em um [array].
-     *
-     * @param  \Carbon\Carbon|string $start_at  Data em que será agendado, pode ser em string ou em numa classe Carbon.
-     * @param  \Carbon\Carbon|string|int|null $end_at   Data em que acabada esse agendamento, pode ser em string, ou numa classe Carbon
-     *                                                  ou em int(sendo considerado os minutos de duração).
-     * @param  int|null $status Status desse horário ao ser agendado.
-     * @return array
-     *
-     * @throws \H4ad\Scheduler\Exceptions\CantAddWithoutEnd
-     * @throws \H4ad\Scheduler\Exceptions\EndCantBeforeStart
-     * @throws \H4ad\Scheduler\Exceptions\CantAddWithSameStartAt
-     */
-    public function validateSchedule($model_type, $start_at, $end_at = null, $status = null)
-    {
-        if(!Config::get('scheduler.enable_schedule_without_end') && is_null($end_at))
-            throw new CantAddWithoutEnd;
-
-        $start_at  = $this->parseToCarbon($start_at);
-
-        if(!is_null($end_at)) {
-            $end_at = $this->parseToCarbon($end_at, $start_at);
-
-            if($start_at->greaterThan($end_at))
-                throw new EndCantBeforeStart;
-        }
-
-        if($this->hasScheduleBetween($model_type, $start_at, $end_at ?? $start_at))
-            throw new CantAddWithSameStartAt;
-
-        return compact('model_type', 'start_at', 'end_at', 'status');
-    }
-
-    /**
-     * Faz um parse na data e retorna uma instância em Carbon.
-     *
-     * @param  \Carbon\Carbon|string|int $date Data final que será transformada numa instancia Carbon.
-     * @param  \Carbon\Carbon $reference Data de referencia quando o [date] é inteiro.
-     * @return \Carbon\Carbon
-     *
-     * @throws \H4ad\Scheduler\Exceptions\IntInvalidArgument
-     */
-    public function parseToCarbon($date, $reference = null)
-    {
-        if($date instanceof Carbon)
-            return $date;
-
-        if(is_string($date))
-            return Carbon::parse($date);
-
-        if(is_int($date) && !is_null($reference))
-            return Carbon::parse($reference->toDateTimeString())->addMinutes($date);
-
-        throw new IntInvalidArgument;
-    }
-
-    /**
-     * Faz um parse e retorna um Schedule.
-     *
-     * @param  \Carbon\Carbon|string|int $value Valor que representará a data ou o id a ser buscado.
-     * @return \H4ad\Scheduler\Models\Schedule|null
-     */
-    public function parseToSchedule($value)
-    {
-        if(is_int($value))
-            return Schedule::find($value);
-
-        return Schedule::byStartAt($value)->first();
-    }
+	/**
+	 * Laravel application
+	 *
+	 * @var \Illuminate\Foundation\Application
+	 */
+	public $app;
+
+	/**
+	 * Create a new confide instance.
+	 *
+	 * @param \Illuminate\Foundation\Application $app
+	 *
+	 * @return void
+	 */
+	public function __construct($app)
+	{
+		$this->app = $app;
+	}
+
+	/**
+	 * Escopo de uma consulta que busca horarios pela data de início.
+	 *
+	 * @param string $model_type
+	 * @param string|\Carbon\Carbon $start_at
+	 * @param string|\Carbon\Carbon $end_at
+	 * @return bool
+	 */
+	public function hasScheduleBetween($model_type, $start_at, $end_at)
+	{
+		if(!Config::get('scheduler.enable_schedule_conflict'))
+			return false;
+
+		return !is_null(
+			Schedule::latest()
+				->where('model_type', $model_type)
+				->where('start_at', '>=', $start_at)
+				->where('end_at', '<=', $end_at)
+				->first()
+		);
+	}
+
+	/**
+	 * Retorna os horários disponiveis hoje para uma determinada model.
+	 * .
+	 * @param  string  $model_type Tipo da model
+	 * @param  int    $duration Serve para facilitar na hora de buscar horários livres
+	 *                          que precisem ter uma certa duração.
+	 * @param \Carbon\Carbon|null $openingTime Serve como referencia para buscar horários livres.
+	 *                                         Se for nulo, ele busca a referencia da config.
+	 * @return array
+	 */
+	public function availableToday($model_type, $duration, $openingTime = null)
+	{
+		return $this->availableOn($model_type, Carbon::now(), $duration, $openingTime);
+	}
+
+	/**
+	 * Retorna os horários disponiveis em um determinado dia para uma certa model.
+	 *
+	 * @param  string  $model_type Tipo da model
+	 * @param  \Carbon\Carbon $today Data para o qual ele irá fazer a busca.
+	 * @param  int    $durationMinutes Serve para facilitar na hora de buscar horários livres
+	 *                          que precisem ter uma certa duração.
+	 * @param \Carbon\Carbon|null $openingTime Serve como referencia para buscar horários livres.
+	 *                                         Se for nulo, ele busca a referencia da config.
+	 * @return array
+	 */
+	public function availableOn($model_type, $today, $durationMinutes, $openingTime = null)
+	{
+		$openingTime = $openingTime ?? Carbon::parse(Config::get('scheduler.opening_time'))->setDateFrom($today);
+		$closingTime = Carbon::parse(Config::get('scheduler.closing_time'))->setDateFrom($today);
+
+		$livres = [];
+		$today = Carbon::parse($today->toDateString());
+		while($openingTime <= $closingTime)
+		{
+			$add = true;
+
+			$opening = Carbon::parse($openingTime->toDateTimeString());
+			$closing = Carbon::parse($openingTime->toDateTimeString())->addMinutes($durationMinutes);
+
+			foreach (Schedule::where('model_type', $model_type)->orderBy('start_at', 'DESC')->cursor() as $schedule) {
+				$start = Carbon::parse($schedule->start_at);
+				$begin = Carbon::parse($start->toDateString());
+
+				if($begin->greaterThan($today))
+					break;
+
+				if($begin->notEqualTo($today))
+					continue;
+
+				$end = Carbon::parse($schedule->end_at);
+
+				if($this->isShouldntAdd($opening, $closing, $start, $end))
+					$add = false;
+			}
+
+			if($add && $closing->lessThanOrEqualTo($closingTime))
+				$livres[] = [
+					'start_at' => $opening,
+					'end_at' => $closing
+				];
+
+			$openingTime->addMinutes($durationMinutes);
+		}
+
+		return $livres;
+	}
+
+	/**
+	 * Verifica se ele não deve ser adicionado ao array de horários livres.
+	 *
+	 * @param  \Carbon\Carbon  $opening
+	 * @param  \Carbon\Carbon  $closing
+	 * @param  \Carbon\Carbon  $start
+	 * @param  \Carbon\Carbon  $end
+	 * @return boolean
+	 */
+	private function isShouldntAdd($opening, $closing, $start, $end)
+	{
+		return $start <= $opening && $end >= $closing;
+	}
+
+	/**
+	 * Valida e retorna os dados formatados de forma correta em um [array].
+	 *
+	 * @param  \Carbon\Carbon|string $start_at  Data em que será agendado, pode ser em string ou em numa classe Carbon.
+	 * @param  \Carbon\Carbon|string|int|null $end_at   Data em que acabada esse agendamento, pode ser em string, ou numa classe Carbon
+	 *                                                  ou em int(sendo considerado os minutos de duração).
+	 * @param  int|null $status Status desse horário ao ser agendado.
+	 * @return array
+	 *
+	 * @throws \H4ad\Scheduler\Exceptions\CantAddWithoutEnd
+	 * @throws \H4ad\Scheduler\Exceptions\EndCantBeforeStart
+	 * @throws \H4ad\Scheduler\Exceptions\CantAddWithSameStartAt
+	 */
+	public function validateSchedule($model_type, $start_at, $end_at = null, $status = null)
+	{
+		if(!Config::get('scheduler.enable_schedule_without_end') && is_null($end_at))
+			throw new CantAddWithoutEnd;
+
+		$start_at  = $this->parseToCarbon($start_at);
+
+		if(!is_null($end_at)) {
+			$end_at = $this->parseToCarbon($end_at, $start_at);
+
+			if($start_at->greaterThan($end_at))
+				throw new EndCantBeforeStart;
+		}
+
+		if($this->hasScheduleBetween($model_type, $start_at, $end_at ?? $start_at))
+			throw new CantAddWithSameStartAt;
+
+		return compact('model_type', 'start_at', 'end_at', 'status');
+	}
+
+	/**
+	 * Faz um parse na data e retorna uma instância em Carbon.
+	 *
+	 * @param  \Carbon\Carbon|string|int $date Data final que será transformada numa instancia Carbon.
+	 * @param  \Carbon\Carbon $reference Data de referencia quando o [date] é inteiro.
+	 * @return \Carbon\Carbon
+	 *
+	 * @throws \H4ad\Scheduler\Exceptions\IntInvalidArgument
+	 */
+	public function parseToCarbon($date, $reference = null)
+	{
+		if($date instanceof Carbon)
+			return $date;
+
+		if(is_string($date))
+			return Carbon::parse($date);
+
+		if(is_int($date) && !is_null($reference))
+			return Carbon::parse($reference->toDateTimeString())->addMinutes($date);
+
+		throw new IntInvalidArgument;
+	}
+
+	/**
+	 * Faz um parse e retorna um Schedule.
+	 *
+	 * @param  \Carbon\Carbon|string|int $value Valor que representará a data ou o id a ser buscado.
+	 * @return \H4ad\Scheduler\Models\Schedule|null
+	 */
+	public function parseToSchedule($value)
+	{
+		if(is_int($value))
+			return Schedule::find($value);
+
+		return Schedule::byStartAt($value)->first();
+	}
 }
\ No newline at end of file

src/Scheduler/Traits/SchedulerModelTrait.php

Indentation +20 added lines, -20 removed lines

@@ -24,27 +24,27 @@ 
 trait SchedulerModelTrait
 {
 	/**
-     * Define a one-to-one relationship.
-     *
-     * @param  string  $related
-     * @param  string  $foreignKey
-     * @param  string  $localKey
-     * @return \Illuminate\Database\Eloquent\Relations\HasOne
-     */
-    abstract public function hasOne($related, $foreignKey = null, $localKey = null);
+	 * Define a one-to-one relationship.
+	 *
+	 * @param  string  $related
+	 * @param  string  $foreignKey
+	 * @param  string  $localKey
+	 * @return \Illuminate\Database\Eloquent\Relations\HasOne
+	 */
+	abstract public function hasOne($related, $foreignKey = null, $localKey = null);
 
 	/**
-     * Get the value of the model's primary key.
-     *
-     * @return mixed
-     */
+	 * Get the value of the model's primary key.
+	 *
+	 * @return mixed
+	 */
 	abstract public function getKey();
 
 	/**
-     * Retorna apenas o horário que possui o mesmo [model_id] do [parent] dessa [trait].
-     *
-     * @return \Illuminate\Database\Eloquent\Relations\HasOne
-     */
+	 * Retorna apenas o horário que possui o mesmo [model_id] do [parent] dessa [trait].
+	 *
+	 * @return \Illuminate\Database\Eloquent\Relations\HasOne
+	 */
 	public function schedules()
 	{
 		return $this->hasOne(Config::get('scheduler.schedules_table'), 'model_id');
@@ -72,8 +72,8 @@ 
 	 *
 	 * @param  int    $duration Serve para facilitar na hora de buscar horários livres
 	 *                          que precisem ter uma certa duração.
-     * @param \Carbon\Carbon|null $openingTime Serve como referencia para buscar horários livres.
-     *                                         Se for nulo, ele busca a referencia da config.
+	 * @param \Carbon\Carbon|null $openingTime Serve como referencia para buscar horários livres.
+	 *                                         Se for nulo, ele busca a referencia da config.
 	 * @return array
 	 */
 	public function availableToday($duration = 0, $openingTime = null)
@@ -87,8 +87,8 @@ 
 	 * @param  string|\Carbon\Carbon $date Data para o qual ele irá fazer a busca.
 	 * @param  int    $duration Serve para facilitar na hora de buscar horários livres
 	 *                          que precisem ter uma certa duração.
-     * @param \Carbon\Carbon|null $openingTime Serve como referencia para buscar horários livres.
-     *                                         Se for nulo, ele busca a referencia da config.
+	 * @param \Carbon\Carbon|null $openingTime Serve como referencia para buscar horários livres.
+	 *                                         Se for nulo, ele busca a referencia da config.
 	 * @return array
 	 */
 	public function availableOn($date, $duration = 0, $openingTime = null)

src/Scheduler/Contracts/SchedulerModelTrait.php

Indentation +20 added lines, -20 removed lines

@@ -11,27 +11,27 @@ 
 interface SchedulerModelInterface
 {
 	/**
-     * Define a one-to-one relationship.
-     *
-     * @param  string  $related
-     * @param  string  $foreignKey
-     * @param  string  $localKey
-     * @return \Illuminate\Database\Eloquent\Relations\HasOne
-     */
-    abstract public function hasOne($related, $foreignKey = null, $localKey = null);
+	 * Define a one-to-one relationship.
+	 *
+	 * @param  string  $related
+	 * @param  string  $foreignKey
+	 * @param  string  $localKey
+	 * @return \Illuminate\Database\Eloquent\Relations\HasOne
+	 */
+	abstract public function hasOne($related, $foreignKey = null, $localKey = null);
 
 	/**
-     * Get the value of the model's primary key.
-     *
-     * @return mixed
-     */
+	 * Get the value of the model's primary key.
+	 *
+	 * @return mixed
+	 */
 	abstract public function getKey();
 
 	/**
-     * Retorna apenas os horários que possuem o mesmo [model_type] do [parent] dessa [trait].
-     *
-     * @return \Illuminate\Database\Eloquent\Relations\HasMany
-     */
+	 * Retorna apenas os horários que possuem o mesmo [model_type] do [parent] dessa [trait].
+	 *
+	 * @return \Illuminate\Database\Eloquent\Relations\HasMany
+	 */
 	public function schedules();
 
 	/**
@@ -50,8 +50,8 @@ 
 	 *
 	 * @param  int    $duration Serve para facilitar na hora de buscar horários livres
 	 *                          que precisem ter uma certa duração.
-     * @param \Carbon\Carbon|null $openingTime Serve como referencia para buscar horários livres.
-     *                                         Se for nulo, ele busca a referencia da config.
+	 * @param \Carbon\Carbon|null $openingTime Serve como referencia para buscar horários livres.
+	 *                                         Se for nulo, ele busca a referencia da config.
 	 * @return array
 	 */
 	public function availableToday($duration = 0, $openingTime = null);
@@ -62,8 +62,8 @@ 
 	 * @param  string|\Carbon\Carbon $date Data para o qual ele irá fazer a busca.
 	 * @param  int    $duration Serve para facilitar na hora de buscar horários livres
 	 *                          que precisem ter uma certa duração.
-     * @param \Carbon\Carbon|null $openingTime Serve como referencia para buscar horários livres.
-     *                                         Se for nulo, ele busca a referencia da config.
+	 * @param \Carbon\Carbon|null $openingTime Serve como referencia para buscar horários livres.
+	 *                                         Se for nulo, ele busca a referencia da config.
 	 * @return array
 	 */
 	public function availableOn($date, $duration = 0, $openingTime = null);