timegridio / concierge

src/Booking/Strategies/BookingStrategy.php

Doc Comments +5 added lines

@@ -30,6 +30,11 @@
         }
     }
 
+    /**
+     * @param string $comments
+     *
+     * @return Appointment
+     */
     public function generateAppointment(
         $issuerId,
         Business $business,

src/Booking/Strategies/BookingTimeslotStrategy.php

Doc Comments +2 added lines, -2 removed lines

@@ -46,7 +46,7 @@ 
      *
      * @param Collection $vacancies
      *
-     * @return Illuminate\Database\Eloquent\Collection
+     * @return Collection
      */
     public function removeBookedVacancies(Collection $vacancies)
     {
@@ -62,7 +62,7 @@ 
      *
      * @param Collection $vacancies
      *
-     * @return Illuminate\Database\Eloquent\Collection
+     * @return Collection
      */
     public function removeSelfBooked(Collection $vacancies, $userId)
     {

src/Concierge.php

Doc Comments +3 added lines, -5 removed lines

@@ -48,7 +48,7 @@ 
     /**
      * is available for at least one reservation.
      *
-     * @param User $user  Potential issuer of reservation
+     * @param User $userId  Potential issuer of reservation
      * @param int  $limit Quantiy of days from "today"
      *
      * @return bool There exist vacancies to reserve
@@ -83,7 +83,7 @@ 
     /**
      * get Vacancies.
      *
-     * @param User $user  To present to User
+     * @param User $userId  To present to User
      * @param int  $limit For a maximum of $limit days
      *
      * @return array Array of vacancies for each date
@@ -96,7 +96,6 @@ 
     /**
      * get Unarchived Appointments For.
      *
-     * @param User $user This User
      *
      * @return Illuminate\Support\Collection Collection of Appointments
      */
@@ -120,7 +119,7 @@ 
     /**
      * make Reservation.
      *
-     * @param User     $issuer   Requested by User as issuer
+     * @param User     $issuerId   Requested by User as issuer
      * @param Business $business For Business
      * @param Contact  $contact  On behalf of Contact
      * @param Service  $service  For Service
@@ -168,7 +167,6 @@ 
     /**
      * Attempt an action over an indicated Appointment.
      *
-     * @param User        $user
      * @param Appointment $appointment
      * @param string      $action
      *

src/Models/Appointment.php

Doc Comments +5 added lines, -5 removed lines

@@ -81,7 +81,7 @@ 
     /**
      * Get the issuer (the User that generated the Appointment).
      *
-     * @return Timegridio\Concierge\Models\User
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
      */
     public function issuer()
     {
@@ -91,7 +91,7 @@ 
     /**
      * Get the target Contact (for whom is reserved the Appointment).
      *
-     * @return Contact
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
      */
     public function contact()
     {
@@ -101,7 +101,7 @@ 
     /**
      * Get the holding Business (that has taken the reservation).
      *
-     * @return Business
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
      */
     public function business()
     {
@@ -111,7 +111,7 @@ 
     /**
      * Get the reserved Service.
      *
-     * @return Service
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
      */
     public function service()
     {
@@ -122,7 +122,7 @@ 
      * Get the Vacancy (that justifies the availability of resources for the
      * Appointment generation).
      *
-     * @return Vacancy
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
      */
     public function vacancy()
     {

Indentation +4 added lines, -4 removed lines

@@ -542,19 +542,19 @@
 
                 $query->where(function ($query) use ($startAt, $finishAt) {
                     $query->where('finish_at', '>=', $finishAt->timezone('UTC'))
-                          ->where('start_at', '<=', $startAt->timezone('UTC'));
+                            ->where('start_at', '<=', $startAt->timezone('UTC'));
                 })
                 ->orWhere(function ($query) use ($startAt, $finishAt) {
                     $query->where('finish_at', '<', $finishAt->timezone('UTC'))
-                          ->where('finish_at', '>', $startAt->timezone('UTC'));
+                            ->where('finish_at', '>', $startAt->timezone('UTC'));
                 })
                 ->orWhere(function ($query) use ($startAt, $finishAt) {
                     $query->where('start_at', '>', $startAt->timezone('UTC'))
-                          ->where('start_at', '<', $finishAt->timezone('UTC'));
+                            ->where('start_at', '<', $finishAt->timezone('UTC'));
                 })
                 ->orWhere(function ($query) use ($startAt, $finishAt) {
                     $query->where('start_at', '>', $startAt->timezone('UTC'))
-                          ->where('finish_at', '<', $finishAt->timezone('UTC'));
+                            ->where('finish_at', '<', $finishAt->timezone('UTC'));
                 });
 
             });

Spacing +7 added lines, -7 removed lines

@@ -412,10 +412,10 @@ 
     public function scopeUnarchived($query)
     {
         return $query
-            ->where(function ($query) {
+            ->where(function($query) {
                 $query->whereIn('status', [Self::STATUS_RESERVED, Self::STATUS_CONFIRMED])
                     ->where('start_at', '<=', Carbon::parse('today midnight')->timezone('UTC'))
-                    ->orWhere(function ($query) {
+                    ->orWhere(function($query) {
                         $query->where('start_at', '>=', Carbon::parse('today midnight')->timezone('UTC'));
                     });
             });
@@ -538,21 +538,21 @@ 
     public function scopeAffectingInterval($query, Carbon $startAt, Carbon $finishAt)
     {
         return $query
-            ->where(function ($query) use ($startAt, $finishAt) {
+            ->where(function($query) use ($startAt, $finishAt) {
 
-                $query->where(function ($query) use ($startAt, $finishAt) {
+                $query->where(function($query) use ($startAt, $finishAt) {
                     $query->where('finish_at', '>=', $finishAt->timezone('UTC'))
                           ->where('start_at', '<=', $startAt->timezone('UTC'));
                 })
-                ->orWhere(function ($query) use ($startAt, $finishAt) {
+                ->orWhere(function($query) use ($startAt, $finishAt) {
                     $query->where('finish_at', '<', $finishAt->timezone('UTC'))
                           ->where('finish_at', '>', $startAt->timezone('UTC'));
                 })
-                ->orWhere(function ($query) use ($startAt, $finishAt) {
+                ->orWhere(function($query) use ($startAt, $finishAt) {
                     $query->where('start_at', '>', $startAt->timezone('UTC'))
                           ->where('start_at', '<', $finishAt->timezone('UTC'));
                 })
-                ->orWhere(function ($query) use ($startAt, $finishAt) {
+                ->orWhere(function($query) use ($startAt, $finishAt) {
                     $query->where('start_at', '>', $startAt->timezone('UTC'))
                           ->where('finish_at', '<', $finishAt->timezone('UTC'));
                 });

src/Models/Business.php

Doc Comments +7 added lines, -8 removed lines

@@ -68,7 +68,7 @@ 
     /**
      * belongs to Category.
      *
-     * @return Illuminate\Database\Query Relationship Business Category query
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo Relationship Business Category query
      */
     public function category()
     {
@@ -92,7 +92,7 @@ 
     /**
      * provides Services.
      *
-     * @return Illuminate\Database\Query Relationship Business provided Services query
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany Relationship Business provided Services query
      */
     public function services()
     {
@@ -102,7 +102,7 @@ 
     /**
      * provides Service types.
      *
-     * @return Illuminate\Database\Query Relationship
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany Relationship
      */
     public function servicetypes()
     {
@@ -112,7 +112,7 @@ 
     /**
      * publishes Vacancies.
      *
-     * @return Illuminate\Database\Query Relationship Business published Vacancies query
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany Relationship Business published Vacancies query
      */
     public function vacancies()
     {
@@ -123,7 +123,7 @@ 
      * ToDo: Should be renamed to "appointments"
      * holds Appointments booking.
      *
-     * @return Illuminate\Database\Query Relationship Business holds Appointments query
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany Relationship Business holds Appointments query
      */
     public function bookings()
     {
@@ -133,7 +133,7 @@ 
     /**
      * belongs to Users.
      *
-     * @return Illuminate\Database\Query Relationship Business belongs to User (owners) query
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany Relationship Business belongs to User (owners) query
      */
     public function owners()
     {
@@ -257,7 +257,7 @@ 
     /**
      * set Postal Address.
      *
-     * @param string $postal_address Postal address
+     * @param string $postalAddress Postal address
      */
     public function setPostalAddressAttribute($postalAddress)
     {
@@ -267,7 +267,6 @@ 
     /**
      * set Social Facebook.
      *
-     * @param string $social_facebook Facebook User URL
      */
     public function setSocialFacebookAttribute($facebookPageUrl)
     {

Spacing +1 added lines, -1 removed lines

@@ -38,7 +38,7 @@
     {
         parent::boot();
 
-        static::creating(function ($business) {
+        static::creating(function($business) {
 
             $business->slug = $business->makeSlug($business->name);
 

src/Models/Contact.php

Doc Comments +3 added lines, -3 removed lines

@@ -31,7 +31,7 @@ 
     /**
      * is profile of User.
      *
-     * @return Illuminate\Database\Query Relationship Contact belongs to User query
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo Relationship Contact belongs to User query
      */
     public function user()
     {
@@ -41,7 +41,7 @@ 
     /**
      * belongs to Business.
      *
-     * @return Illuminate\Database\Query Relationship Contact is part of Businesses addressbooks query
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany Relationship Contact is part of Businesses addressbooks query
      */
     public function businesses()
     {
@@ -51,7 +51,7 @@ 
     /**
      * has Appointments.
      *
-     * @return Illuminate\Database\Query Relationship Contact has booked Appointments query
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany Relationship Contact has booked Appointments query
      */
     public function appointments()
     {

src/Models/Preference.php

Doc Comments +1 added lines, -1 removed lines

@@ -36,7 +36,7 @@
     /**
      * [getDefault description].
      *
-     * @param [type] $model [description]
+     * @param \Timegridio\Concierge\Traits\Preferenceable $model [description]
      * @param [type] $key   [description]
      *
      * @return [type] [description]

src/Models/Service.php

Doc Comments +2 added lines, -2 removed lines

@@ -23,7 +23,7 @@ 
     /**
      * Belongs to service type.
      *
-     * @return Illuminate\Database\Query Relationship Service belongs to type query
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo Relationship Service belongs to type query
      */
     public function type()
     {
@@ -47,7 +47,7 @@ 
     /**
      * belongs to Business.
      *
-     * @return Illuminate\Database\Query Relationship Service belongs to Business query
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo Relationship Service belongs to Business query
      */
     public function business()
     {

src/Models/Vacancy.php

Doc Comments +3 added lines, -3 removed lines

@@ -35,7 +35,7 @@ 
     /**
      * belongs to Business.
      *
-     * @return Illuminate\Database\Query Relationship Vacancy belongs to Business query
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo Relationship Vacancy belongs to Business query
      */
     public function business()
     {
@@ -45,7 +45,7 @@ 
     /**
      * for Service.
      *
-     * @return Illuminate\Database\Query Relationship Vacancy is for providing Service query
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo Relationship Vacancy is for providing Service query
      */
     public function service()
     {
@@ -55,7 +55,7 @@ 
     /**
      * holds many Appointments.
      *
-     * @return Illuminate\Database\Query Relationship Vacancy belongs to Business query
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany Relationship Vacancy belongs to Business query
      */
     public function appointments()
     {

Indentation +4 added lines, -4 removed lines

@@ -90,7 +90,7 @@ 
     public function scopeForDateTime($query, Carbon $datetime)
     {
         return $query->where('start_at', '<=', $datetime->toDateTimeString())
-                     ->where('finish_at', '>=', $datetime->toDateTimeString());
+                        ->where('finish_at', '>=', $datetime->toDateTimeString());
     }
 
     /**
@@ -195,9 +195,9 @@ 
     public function hasRoomBetween(Carbon $startAt, Carbon $finishAt)
     {
         return $this->capacity > $this->appointments()
-                                      ->active()
-                                      ->affectingInterval($startAt, $finishAt)
-                                      ->count() &&
+                                        ->active()
+                                        ->affectingInterval($startAt, $finishAt)
+                                        ->count() &&
             ($this->start_at <= $startAt && $this->finish_at >= $finishAt);
     }