route4me / route4me-php-sdk

src/Route4Me/V5/RecurringRoutes/PageInfo.php

Indentation +57 added lines, -57 removed lines

@@ -13,72 +13,72 @@
  */
 class PageInfo extends Common
 {
-    /**
-     * URL of first page
-     */
-    public ?string $url_of_first_page = null;
+	/**
+	 * URL of first page
+	 */
+	public ?string $url_of_first_page = null;
 
-    /**
-     * URL of last page
-     */
-    public ?string $url_of_last_page = null;
+	/**
+	 * URL of last page
+	 */
+	public ?string $url_of_last_page = null;
 
-    /**
-     * URL of previous page
-     */
-    public ?string $url_of_previous_page = null;
+	/**
+	 * URL of previous page
+	 */
+	public ?string $url_of_previous_page = null;
 
-    /**
-     * URL of next page
-     */
-    public ?string $url_of_next_page = null;
+	/**
+	 * URL of next page
+	 */
+	public ?string $url_of_next_page = null;
 
-    /**
-     * Number of current page
-     */
-    public ?int $number_of_current_page = null;
+	/**
+	 * Number of current page
+	 */
+	public ?int $number_of_current_page = null;
 
-    /**
-     * Number of last page
-     */
-    public ?int $number_of_last_page = null;
+	/**
+	 * Number of last page
+	 */
+	public ?int $number_of_last_page = null;
 
-    /**
-     * Items per page
-     */
-    public ?int $items_per_page = null;
+	/**
+	 * Items per page
+	 */
+	public ?int $items_per_page = null;
 
-    /**
-     * Index of first item on page
-     */
-    public ?int $index_of_first = null;
+	/**
+	 * Index of first item on page
+	 */
+	public ?int $index_of_first = null;
 
-    /**
-     * Index of last item on page
-     */
-    public ?int $index_of_last = null;
+	/**
+	 * Index of last item on page
+	 */
+	public ?int $index_of_last = null;
 
-    /**
-     * Total items
-     */
-    public ?int $total_items = null;
+	/**
+	 * Total items
+	 */
+	public ?int $total_items = null;
 
-    public function __construct(array $links = null, array $meta = null)
-    {
-        if ($links !== null && is_array($links)) {
-            $this->url_of_first_page = Common::getValue($links, 'first');
-            $this->url_of_last_page = Common::getValue($links, 'last');
-            $this->url_of_previous_page = Common::getValue($links, 'prev');
-            $this->url_of_next_page = Common::getValue($links, 'next');
-        }
+	public function __construct(array $links = null, array $meta = null)
+	{
+		if ($links !== null && is_array($links)) {
+			$this->url_of_first_page = Common::getValue($links, 'first');
+			$this->url_of_last_page = Common::getValue($links, 'last');
+			$this->url_of_previous_page = Common::getValue($links, 'prev');
+			$this->url_of_next_page = Common::getValue($links, 'next');
+		}
 
-        if ($meta !== null && is_array($meta)) {
-            $this->number_of_current_page = Common::getValue($meta, 'current_page');
-            $this->number_of_last_page = Common::getValue($meta, 'last_page');
-            $this->items_per_page = Common::getValue($meta, 'per_page');
-            $this->index_of_first = Common::getValue($meta, 'from');
-            $this->index_of_last = Common::getValue($meta, 'to');
-            $this->total_items = Common::getValue($meta, 'total');
-        }
-    }
+		if ($meta !== null && is_array($meta)) {
+			$this->number_of_current_page = Common::getValue($meta, 'current_page');
+			$this->number_of_last_page = Common::getValue($meta, 'last_page');
+			$this->items_per_page = Common::getValue($meta, 'per_page');
+			$this->index_of_first = Common::getValue($meta, 'from');
+			$this->index_of_last = Common::getValue($meta, 'to');
+			$this->total_items = Common::getValue($meta, 'total');
+		}
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -65,14 +65,14 @@
 
     public function __construct(array $links = null, array $meta = null)
     {
-        if ($links !== null && is_array($links)) {
+        if ($links!==null && is_array($links)) {
             $this->url_of_first_page = Common::getValue($links, 'first');
             $this->url_of_last_page = Common::getValue($links, 'last');
             $this->url_of_previous_page = Common::getValue($links, 'prev');
             $this->url_of_next_page = Common::getValue($links, 'next');
         }
 
-        if ($meta !== null && is_array($meta)) {
+        if ($meta!==null && is_array($meta)) {
             $this->number_of_current_page = Common::getValue($meta, 'current_page');
             $this->number_of_last_page = Common::getValue($meta, 'last_page');
             $this->items_per_page = Common::getValue($meta, 'per_page');

src/Route4Me/V5/RecurringRoutes/Schedule.php

Indentation +36 added lines, -36 removed lines

@@ -13,40 +13,40 @@
  */
 class Schedule extends Common
 {
-    /**
-     * The Schedule ID
-     */
-    public ?string $schedule_uid = null;
-
-    /**
-     * The name of Schedule
-     */
-    public ?string $name = null;
-
-    /**
-     * Array of blacklisted dates as string 'YYYY-MM-DD'.
-     */
-    public ?array $schedule_blacklist = null;
-
-    public int $advance_interval = 1;
-
-    public int $advance_schedule_interval_days = 0;
-
-    /**
-     * Schedule as JSON string
-     * e.g. '{"enabled":true,"mode":"daily","daily":{"every":2}, "from":"2019-06-05","timestamp":1558538737}'
-     */
-    public ?string $schedule = null;
-
-    /**
-     * Timezone as 'America/New_York'.
-     */
-    public ?string $timezone = null;
-
-    public function __construct(?array $params = null)
-    {
-        if ($params !== null) {
-            $this->fillFromArray($params);
-        }
-    }
+	/**
+	 * The Schedule ID
+	 */
+	public ?string $schedule_uid = null;
+
+	/**
+	 * The name of Schedule
+	 */
+	public ?string $name = null;
+
+	/**
+	 * Array of blacklisted dates as string 'YYYY-MM-DD'.
+	 */
+	public ?array $schedule_blacklist = null;
+
+	public int $advance_interval = 1;
+
+	public int $advance_schedule_interval_days = 0;
+
+	/**
+	 * Schedule as JSON string
+	 * e.g. '{"enabled":true,"mode":"daily","daily":{"every":2}, "from":"2019-06-05","timestamp":1558538737}'
+	 */
+	public ?string $schedule = null;
+
+	/**
+	 * Timezone as 'America/New_York'.
+	 */
+	public ?string $timezone = null;
+
+	public function __construct(?array $params = null)
+	{
+		if ($params !== null) {
+			$this->fillFromArray($params);
+		}
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -45,7 +45,7 @@
 
     public function __construct(?array $params = null)
     {
-        if ($params !== null) {
+        if ($params!==null) {
             $this->fillFromArray($params);
         }
     }

src/Route4Me/V5/RecurringRoutes/Schedules.php

Indentation +494 added lines, -494 removed lines

@@ -19,498 +19,498 @@
  */
 class Schedules extends Common
 {
-    public function __construct()
-    {
-        Route4Me::setBaseUrl('');
-    }
-
-    /**
-     * Create a new Schedule by sending the corresponding data.
-     *
-     * @since 1.2.3
-     *
-     * @param  array    $params
-     *   string   schedule_uid - Schedule ID,
-     *   int      root_member_id,
-     *   string   name - Name of Schedule,
-     *   string[] schedule_blacklist - An array of blacklisted dates as 'YYYY-MM-DD',
-     *   int      advance_interval,
-     *   int      advance_schedule_interval_days,
-     *   string   schedule - Schedule as JSON string e.g. '{"enabled":true,"mode":"daily",
-     *                           "daily":{"every":2}, "from":"2019-06-05","timestamp":1558538737}',
-     *   string   timezone - Timezone as 'America/New_York'
-     * @return Schedule
-     * @throws Exception\ApiError
-     */
-    public function createSchedule(array $params) : Schedule
-    {
-        $allBodyFields = ['schedule_uid', 'root_member_id', 'name', 'schedule_blacklist',
-            'advance_interval', 'advance_schedule_interval_days', 'schedule', 'timezone'];
-
-        return $this->toSchedule(Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_SCHEDULES,
-            'method' => 'POST',
-            'HTTPHEADER' => 'Content-Type: application/json',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
-        ]));
-    }
-
-    /**
-     * Get the Schedule by specifying the Schedule ID.
-     *
-     * @since 1.2.3
-     *
-     * @param  string $scheduleId Schedule ID.
-     * @return Schedule
-     * @throws Exception\ApiError
-     */
-    public function getSchedule(string $scheduleId) : Schedule
-    {
-        return $this->toSchedule(Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_SCHEDULES . '/' . $scheduleId,
-            'method' => 'GET'
-        ]));
-    }
-
-    /**
-     * Get the list of all Schedules.
-     *
-     * @since 1.2.3
-     *
-     * @return Schedule[]
-      * @throws Exception\ApiError
-    */
-    public function getAllSchedules() : array
-    {
-        $result = Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_SCHEDULES,
-            'method' => 'GET'
-        ]);
-
-        if (is_array($result) && isset($result['data'])) {
-            $data = $result['data'];
-            if (is_array($data) && isset($data[0]) && is_array($data[0])) {
-                $arr = [];
-                foreach ($data as $key => $value) {
-                    array_push($arr, new Schedule($value));
-                }
-                return $arr;
-            }
-        }
-        return null;
-    }
-
-    /**
-     * Get paginated list of Schedules.
-     *
-     * @since 1.2.3
-     *
-     * @param  int   $page Requested page.
-     * @param  int   $per_page Number of Schedules per page.
-     * @return array
-     * @throws Exception\ApiError
-     */
-    public function getSchedules(int $page = 1, int $per_page = 15) : array
-    {
-        $result = Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_SCHEDULES_PAGINATION,
-            'method' => 'GET',
-            'query' => [
-                'with_pagination' => true,
-                'page' => $page,
-                'per_page' => $per_page
-            ]
-        ]);
-
-        if (is_array($result) && isset($result['data'])) {
-            $data = $result['data'];
-            $schedules = [];
-            if (is_array($data) && isset($data[0]) && is_array($data[0])) {
-                foreach ($data as $key => $value) {
-                    array_push($schedules, new Schedule($value));
-                }
-            }
-            return [
-                'schedules' => $schedules,
-                'page_info' => new PageInfo($result['links'], $result['meta'])
-            ];
-        }
-        return null;
-    }
-
-    /**
-     * Update the existing Schedule by sending the corresponding data.
-     *
-     * @since 1.2.3
-     *
-     * @param  string   $schedule_uid Schedule ID
-     * @param  array    $params
-     *   string   schedule_uid - Schedule ID,
-     *   int      root_member_id,
-     *   string   name - Name of Schedule,
-     *   string[] schedule_blacklist - An array of blacklisted dates as 'YYYY-MM-DD',
-     *   int      advance_interval,
-     *   int      advance_schedule_interval_days,
-     *   string   schedule - Schedule as JSON string e.g. '{"enabled":true,"mode":"daily",
-     *                           "daily":{"every":2}, "from":"2019-06-05","timestamp":1558538737}',
-     *   string   timezone - Timezone as 'America/New_York'
-     * @return Schedule
-     * @throws Exception\ApiError
-     */
-    public function updateSchedule(string $scheduleId, array $params) : Schedule
-    {
-        $allBodyFields = ['root_member_id', 'name', 'schedule_blacklist',
-            'advance_interval', 'advance_schedule_interval_days', 'schedule', 'timezone'];
-
-        return $this->toSchedule(Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_SCHEDULES . '/' . $scheduleId,
-            'method' => 'PUT',
-            'HTTPHEADER' => 'Content-Type: application/json',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
-        ]));
-    }
-
-    /**
-     * Delete the specified Schedule with the option to delete the associated route.
-     *
-     * @since 1.2.3
-     *
-     * @param  string $schedule_uid Schedule ID
-     * @param  bool   $withRoutes Delete the Schedule that matches the specified Schedule ID.
-     *                            If the deleted Schedule has one or multiple associated Routes,
-     *                            these Routes are also deleted.
-     * @return Schedule
-     * @throws Exception\ApiError
-     */
-    public function deleteSchedule(string $scheduleId, bool $withRoutes = false) : Schedule
-    {
-        return $this->toSchedule(Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_SCHEDULES . '/' . $scheduleId,
-            'method' => 'DELETE',
-            'query' => ['with_routes' => $withRoutes]
-        ]));
-    }
-
-    /**
-     * Create a new Route Schedule by sending the corresponding data.
-     *
-     * @since 1.2.3
-     *
-     * @param  array  $params
-     *   string route_id - Route ID,
-     *   string schedule_uid - Schedule ID,
-     *   int    member_id - A unique ID of the root member,
-     *   string vehicle_id - Vehicle ID
-     * @return RouteSchedule
-     * @throws Exception\ApiError
-     */
-    public function createRouteSchedule(array $params) : RouteSchedule
-    {
-        $allBodyFields = ['route_id', 'schedule_uid', 'member_id', 'vehicle_id'];
-
-        return $this->toRouteSchedule(Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES,
-            'method' => 'POST',
-            'HTTPHEADER' => 'Content-Type: application/json',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
-        ]));
-    }
-
-    /**
-     * Get the Route Schedule by specifying the Route ID.
-     *
-     * @since 1.2.3
-     *
-     * @param  string $routeId Route ID.
-     * @return RouteSchedule
-     * @throws Exception\ApiError
-     */
-    public function getRouteSchedule(string $route_id) : RouteSchedule
-    {
-        return $this->toRouteSchedule(Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES . '/' . $route_id,
-            'method' => 'GET'
-        ]));
-    }
-
-    /**
-     * Get the list of all Route Schedules.
-     *
-     * @since 1.2.3
-     *
-     * @return RouteSchedule[]
-     * @throws Exception\ApiError
-     */
-    public function getAllRouteSchedules() : array
-    {
-        $result = Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES,
-            'method' => 'GET'
-        ]);
-
-        if (is_array($result) && isset($result['data'])) {
-            $data = $result['data'];
-            if (is_array($data) && isset($data[0]) && is_array($data[0])) {
-                $arr = [];
-                foreach ($data as $key => $value) {
-                    array_push($arr, new RouteSchedule($value));
-                }
-                return $arr;
-            }
-        }
-        return null;
-    }
-
-    /**
-     * Get paginated list of Route Schedules.
-     *
-     * @since 1.2.3
-     *
-     * @param  int $page Requested page.
-     * @param  int $per_page Number of Route Schedules per page.
-     * @return array
-     * @throws Exception\ApiError
-     */
-    public function getRouteSchedules(int $page = 1, int $per_page = 15) : array
-    {
-        $result = Route4Me::makeRequst([
-            'url' =>    Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES_PAGINATION,
-            'method' => 'GET',
-            'query' => [
-                'with_pagination' => true,
-                'page' => $page,
-                'per_page' => $per_page
-            ]
-        ]);
-
-        if (is_array($result) && isset($result['data'])) {
-            $data = $result['data'];
-            $route_schedules = [];
-            if (is_array($data) && isset($data[0]) && is_array($data[0])) {
-                foreach ($data as $key => $value) {
-                    array_push($route_schedules, new RouteSchedule($value));
-                }
-            }
-            return [
-                'route_schedules' => $route_schedules,
-                'page_info' => new PageInfo($result['links'], $result['meta'])
-            ];
-        }
-        return null;
-    }
-
-    /**
-     * Update the existing Route Schedule by sending the corresponding data.
-     *
-     * @since 1.2.3
-     *
-     * @param  string $route_id Route ID
-     * @param  array  $params
-     *   string schedule_uid - Schedule ID,
-     *   int    member_id - A unique ID of the root member,
-     *   string vehicle_id - Vehicle ID
-     * @return RouteSchedule
-     * @throws Exception\ApiError
-     */
-    public function updateRouteSchedule(string $route_id, array $params) : RouteSchedule
-    {
-        $allBodyFields = ['schedule_uid', 'member_id', 'vehicle_id'];
-
-        return $this->toRouteSchedule(Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES . '/' . $route_id,
-            'method' => 'PUT',
-            'HTTPHEADER' => 'Content-Type: application/json',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
-        ]));
-    }
-
-    /**
-     * Delete the Route Schedules.
-     * @todo request return true instead of return json status
-     *
-     * @since 1.2.3
-     *
-     * @param  string $route_id Route ID
-     * @return bool
-     * @throws Exception\ApiError
-     */
-    public function deleteRouteSchedules(string $route_id) : bool
-    {
-        $result = Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES . '/' . $route_id,
-            'method' => 'DELETE'
-        ]);
-        return ($result == 1 ? true : false);
-    }
-
-    /**
-     * Delete the specified Route Schedule.
-     *
-     * @since 1.2.3
-     *
-     * @param  string $route_id Route ID
-     * @return RouteSchedule
-     * @throws Exception\ApiError
-     */
-    public function deleteRouteSchedule(string $route_id) : RouteSchedule
-    {
-        return $this->toRouteSchedule(Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES . '/' . $route_id  . '/items',
-            'method' => 'DELETE'
-        ]));
-    }
-
-    /**
-     * Replace the existing Route Schedule by sending the corresponding data.
-     *
-     * @since 1.2.3
-     *
-     * @param  string   $route_id Route ID.
-     * @param  array    $params
-     *   int      member_id - A unique ID of the root member,
-     *   string   vehicle_id - Vehicle ID,
-     *   string   schedule_uid - Schedule ID,
-     *   string   name,
-     *   string[] schedule_blacklist - Blacklisted dates as YYYY-MM-DD,
-     *   int      advance_interval,
-     *   int      advance_schedule_interval_days,
-     *   string   schedule - Schedule as JSON string e.g. '{"enabled":true,"mode":"daily",
-     *                           "daily":{"every":2}, "from":"2019-06-05","timestamp":1558538737}',
-     *   string   timezone - Timezone as 'America/New_York'
-     * @return RouteSchedule
-     * @throws Exception\ApiError
-     */
-    public function replaceRouteSchedule(string $route_id, array $params)
-    {
-        $allBodyFields = ['member_id', 'vehicle_id', 'schedule_uid', 'name', 'schedule_blacklist',
-            'advance_interval', 'advance_schedule_interval_days', 'schedule', 'timezone'];
-
-        return $this->toRouteSchedule(Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES_REPLACE . '/' . $route_id,
-            'method' => 'PUT',
-            'HTTPHEADER' => 'Content-Type: application/json',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
-        ]));
-    }
-
-    /**
-     * Get the Route Schedule preview by specifying the 'route_id'.
-     *
-     * @since 1.2.3
-     *
-     * @param  string $routeId Route ID.
-     * @param  string $start Start date as 'YYYY-MM-DD'
-     * @param  string $end End date as 'YYYY-MM-DD'
-     * @return array
-     * @throws Exception\ApiError
-     */
-    public function getRouteSchedulePreview(string $route_id, string $start, string $end) : array
-    {
-        return Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES . '/' . $route_id . '/preview',
-            'method' => 'GET',
-            'query' => ['start' => $start, 'end' => $end]
-        ]);
-    }
-
-    /**
-     * Check if the Scheduled Route was copied by specifying the 'route_id'.
-     * @todo request return true instead of return json status
-     *
-     * @since 1.2.3
-     *
-     * @param  string $routeId Route ID.
-     * @return bool
-     * @throws Exception\ApiError
-     */
-    public function isScheduledRouteCopy(string $route_id) : bool
-    {
-        return Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_SCHEDULED_ROUTES_IS_COPY . '/' . $route_id,
-            'method' => 'GET'
-        ]);
-    }
-
-    /**
-     * Get all routes copied from the specified Scheduled Route by sending
-     * the corresponding data.
-     *
-     * @since 1.2.3
-     *
-     * @param  string   $route_id Route ID.
-     * @param  string   $schedule_uid Schedule ID.
-     * @param  string   $route_date Route date as 'YYYY-MM-DD'.
-     * @return array
-     * @throws Exception\ApiError
-     */
-    public function getScheduledRoutesCopies(string $route_id, string $schedule_uid, string $route_date) : array
-    {
-        return Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_SCHEDULED_ROUTES_GET_COPIES,
-            'method' => 'POST',
-            'HTTPHEADER' => 'Content-Type: application/json',
-            'body' => [
-                'route_id' => $route_id,
-                'schedule_uid' => $schedule_uid,
-                'route_date' => $route_date
-            ]
-        ]);
-    }
-
-    /**
-     * Create a new Master Route by sending the corresponding data.
-     * @todo request return true instead of return json status
-     *
-     * @since 1.2.3
-     *
-     * @param  array    $params
-     *   string   route_id - Route ID,
-     *   string   route_name,
-     *   int      member_id - A unique ID of the root member,
-     *   string   vehicle_id - Vehicle ID,
-     *   string   schedule_uid - Schedule ID,
-     *   string   name,
-     *   string[] schedule_blacklist - Blacklisted dates as YYYY-MM-DD,
-     *   int      advance_interval,
-     *   int      advance_schedule_interval_days,
-     *   string   schedule - Schedule as JSON string e.g. '{"enabled":true,"mode":"daily",
-     *                           "daily":{"every":2}, "from":"2019-06-05","timestamp":1558538737}',
-     *   string   timezone - Timezone as 'America/New_York'
-     * @return bool
-     * @throws Exception\ApiError
-     */
-    public function createMasterRoute(array $params) : bool
-    {
-        $allBodyFields = ['route_id', 'route_name', 'member_id', 'schedule_uid', 'vehicle_id', 'name',
-            'schedule_blacklist', 'advance_schedule_interval_days', 'schedule', 'timezone'];
-
-        return Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_MASTER_ROUTES,
-            'method' => 'POST',
-            'HTTPHEADER' => 'Content-Type: application/json',
-            'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
-        ]);
-    }
-
-    private function toSchedule($result) : Schedule
-    {
-        if (is_array($result) && isset($result['data'])) {
-            $data = $result['data'];
-            if (is_array($data) && isset($data[0]) && is_array($data[0])) {
-                return new Schedule($data[0]);
-            }
-        }
-        throw new ApiError('Can not convert result to Schedule object.');
-    }
-
-    private function toRouteSchedule($result) : RouteSchedule
-    {
-        if (is_array($result) && isset($result['data'])) {
-            $data = $result['data'];
-            if (is_array($data) && isset($data[0]) && is_array($data[0])) {
-                return new RouteSchedule($data[0]);
-            }
-        }
-        throw new ApiError('Can not convert result to RouteSchedule object.');
-    }
+	public function __construct()
+	{
+		Route4Me::setBaseUrl('');
+	}
+
+	/**
+	 * Create a new Schedule by sending the corresponding data.
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  array    $params
+	 *   string   schedule_uid - Schedule ID,
+	 *   int      root_member_id,
+	 *   string   name - Name of Schedule,
+	 *   string[] schedule_blacklist - An array of blacklisted dates as 'YYYY-MM-DD',
+	 *   int      advance_interval,
+	 *   int      advance_schedule_interval_days,
+	 *   string   schedule - Schedule as JSON string e.g. '{"enabled":true,"mode":"daily",
+	 *                           "daily":{"every":2}, "from":"2019-06-05","timestamp":1558538737}',
+	 *   string   timezone - Timezone as 'America/New_York'
+	 * @return Schedule
+	 * @throws Exception\ApiError
+	 */
+	public function createSchedule(array $params) : Schedule
+	{
+		$allBodyFields = ['schedule_uid', 'root_member_id', 'name', 'schedule_blacklist',
+			'advance_interval', 'advance_schedule_interval_days', 'schedule', 'timezone'];
+
+		return $this->toSchedule(Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_SCHEDULES,
+			'method' => 'POST',
+			'HTTPHEADER' => 'Content-Type: application/json',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
+		]));
+	}
+
+	/**
+	 * Get the Schedule by specifying the Schedule ID.
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  string $scheduleId Schedule ID.
+	 * @return Schedule
+	 * @throws Exception\ApiError
+	 */
+	public function getSchedule(string $scheduleId) : Schedule
+	{
+		return $this->toSchedule(Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_SCHEDULES . '/' . $scheduleId,
+			'method' => 'GET'
+		]));
+	}
+
+	/**
+	 * Get the list of all Schedules.
+	 *
+	 * @since 1.2.3
+	 *
+	 * @return Schedule[]
+	 * @throws Exception\ApiError
+	 */
+	public function getAllSchedules() : array
+	{
+		$result = Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_SCHEDULES,
+			'method' => 'GET'
+		]);
+
+		if (is_array($result) && isset($result['data'])) {
+			$data = $result['data'];
+			if (is_array($data) && isset($data[0]) && is_array($data[0])) {
+				$arr = [];
+				foreach ($data as $key => $value) {
+					array_push($arr, new Schedule($value));
+				}
+				return $arr;
+			}
+		}
+		return null;
+	}
+
+	/**
+	 * Get paginated list of Schedules.
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  int   $page Requested page.
+	 * @param  int   $per_page Number of Schedules per page.
+	 * @return array
+	 * @throws Exception\ApiError
+	 */
+	public function getSchedules(int $page = 1, int $per_page = 15) : array
+	{
+		$result = Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_SCHEDULES_PAGINATION,
+			'method' => 'GET',
+			'query' => [
+				'with_pagination' => true,
+				'page' => $page,
+				'per_page' => $per_page
+			]
+		]);
+
+		if (is_array($result) && isset($result['data'])) {
+			$data = $result['data'];
+			$schedules = [];
+			if (is_array($data) && isset($data[0]) && is_array($data[0])) {
+				foreach ($data as $key => $value) {
+					array_push($schedules, new Schedule($value));
+				}
+			}
+			return [
+				'schedules' => $schedules,
+				'page_info' => new PageInfo($result['links'], $result['meta'])
+			];
+		}
+		return null;
+	}
+
+	/**
+	 * Update the existing Schedule by sending the corresponding data.
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  string   $schedule_uid Schedule ID
+	 * @param  array    $params
+	 *   string   schedule_uid - Schedule ID,
+	 *   int      root_member_id,
+	 *   string   name - Name of Schedule,
+	 *   string[] schedule_blacklist - An array of blacklisted dates as 'YYYY-MM-DD',
+	 *   int      advance_interval,
+	 *   int      advance_schedule_interval_days,
+	 *   string   schedule - Schedule as JSON string e.g. '{"enabled":true,"mode":"daily",
+	 *                           "daily":{"every":2}, "from":"2019-06-05","timestamp":1558538737}',
+	 *   string   timezone - Timezone as 'America/New_York'
+	 * @return Schedule
+	 * @throws Exception\ApiError
+	 */
+	public function updateSchedule(string $scheduleId, array $params) : Schedule
+	{
+		$allBodyFields = ['root_member_id', 'name', 'schedule_blacklist',
+			'advance_interval', 'advance_schedule_interval_days', 'schedule', 'timezone'];
+
+		return $this->toSchedule(Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_SCHEDULES . '/' . $scheduleId,
+			'method' => 'PUT',
+			'HTTPHEADER' => 'Content-Type: application/json',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
+		]));
+	}
+
+	/**
+	 * Delete the specified Schedule with the option to delete the associated route.
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  string $schedule_uid Schedule ID
+	 * @param  bool   $withRoutes Delete the Schedule that matches the specified Schedule ID.
+	 *                            If the deleted Schedule has one or multiple associated Routes,
+	 *                            these Routes are also deleted.
+	 * @return Schedule
+	 * @throws Exception\ApiError
+	 */
+	public function deleteSchedule(string $scheduleId, bool $withRoutes = false) : Schedule
+	{
+		return $this->toSchedule(Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_SCHEDULES . '/' . $scheduleId,
+			'method' => 'DELETE',
+			'query' => ['with_routes' => $withRoutes]
+		]));
+	}
+
+	/**
+	 * Create a new Route Schedule by sending the corresponding data.
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  array  $params
+	 *   string route_id - Route ID,
+	 *   string schedule_uid - Schedule ID,
+	 *   int    member_id - A unique ID of the root member,
+	 *   string vehicle_id - Vehicle ID
+	 * @return RouteSchedule
+	 * @throws Exception\ApiError
+	 */
+	public function createRouteSchedule(array $params) : RouteSchedule
+	{
+		$allBodyFields = ['route_id', 'schedule_uid', 'member_id', 'vehicle_id'];
+
+		return $this->toRouteSchedule(Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES,
+			'method' => 'POST',
+			'HTTPHEADER' => 'Content-Type: application/json',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
+		]));
+	}
+
+	/**
+	 * Get the Route Schedule by specifying the Route ID.
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  string $routeId Route ID.
+	 * @return RouteSchedule
+	 * @throws Exception\ApiError
+	 */
+	public function getRouteSchedule(string $route_id) : RouteSchedule
+	{
+		return $this->toRouteSchedule(Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES . '/' . $route_id,
+			'method' => 'GET'
+		]));
+	}
+
+	/**
+	 * Get the list of all Route Schedules.
+	 *
+	 * @since 1.2.3
+	 *
+	 * @return RouteSchedule[]
+	 * @throws Exception\ApiError
+	 */
+	public function getAllRouteSchedules() : array
+	{
+		$result = Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES,
+			'method' => 'GET'
+		]);
+
+		if (is_array($result) && isset($result['data'])) {
+			$data = $result['data'];
+			if (is_array($data) && isset($data[0]) && is_array($data[0])) {
+				$arr = [];
+				foreach ($data as $key => $value) {
+					array_push($arr, new RouteSchedule($value));
+				}
+				return $arr;
+			}
+		}
+		return null;
+	}
+
+	/**
+	 * Get paginated list of Route Schedules.
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  int $page Requested page.
+	 * @param  int $per_page Number of Route Schedules per page.
+	 * @return array
+	 * @throws Exception\ApiError
+	 */
+	public function getRouteSchedules(int $page = 1, int $per_page = 15) : array
+	{
+		$result = Route4Me::makeRequst([
+			'url' =>    Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES_PAGINATION,
+			'method' => 'GET',
+			'query' => [
+				'with_pagination' => true,
+				'page' => $page,
+				'per_page' => $per_page
+			]
+		]);
+
+		if (is_array($result) && isset($result['data'])) {
+			$data = $result['data'];
+			$route_schedules = [];
+			if (is_array($data) && isset($data[0]) && is_array($data[0])) {
+				foreach ($data as $key => $value) {
+					array_push($route_schedules, new RouteSchedule($value));
+				}
+			}
+			return [
+				'route_schedules' => $route_schedules,
+				'page_info' => new PageInfo($result['links'], $result['meta'])
+			];
+		}
+		return null;
+	}
+
+	/**
+	 * Update the existing Route Schedule by sending the corresponding data.
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  string $route_id Route ID
+	 * @param  array  $params
+	 *   string schedule_uid - Schedule ID,
+	 *   int    member_id - A unique ID of the root member,
+	 *   string vehicle_id - Vehicle ID
+	 * @return RouteSchedule
+	 * @throws Exception\ApiError
+	 */
+	public function updateRouteSchedule(string $route_id, array $params) : RouteSchedule
+	{
+		$allBodyFields = ['schedule_uid', 'member_id', 'vehicle_id'];
+
+		return $this->toRouteSchedule(Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES . '/' . $route_id,
+			'method' => 'PUT',
+			'HTTPHEADER' => 'Content-Type: application/json',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
+		]));
+	}
+
+	/**
+	 * Delete the Route Schedules.
+	 * @todo request return true instead of return json status
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  string $route_id Route ID
+	 * @return bool
+	 * @throws Exception\ApiError
+	 */
+	public function deleteRouteSchedules(string $route_id) : bool
+	{
+		$result = Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES . '/' . $route_id,
+			'method' => 'DELETE'
+		]);
+		return ($result == 1 ? true : false);
+	}
+
+	/**
+	 * Delete the specified Route Schedule.
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  string $route_id Route ID
+	 * @return RouteSchedule
+	 * @throws Exception\ApiError
+	 */
+	public function deleteRouteSchedule(string $route_id) : RouteSchedule
+	{
+		return $this->toRouteSchedule(Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES . '/' . $route_id  . '/items',
+			'method' => 'DELETE'
+		]));
+	}
+
+	/**
+	 * Replace the existing Route Schedule by sending the corresponding data.
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  string   $route_id Route ID.
+	 * @param  array    $params
+	 *   int      member_id - A unique ID of the root member,
+	 *   string   vehicle_id - Vehicle ID,
+	 *   string   schedule_uid - Schedule ID,
+	 *   string   name,
+	 *   string[] schedule_blacklist - Blacklisted dates as YYYY-MM-DD,
+	 *   int      advance_interval,
+	 *   int      advance_schedule_interval_days,
+	 *   string   schedule - Schedule as JSON string e.g. '{"enabled":true,"mode":"daily",
+	 *                           "daily":{"every":2}, "from":"2019-06-05","timestamp":1558538737}',
+	 *   string   timezone - Timezone as 'America/New_York'
+	 * @return RouteSchedule
+	 * @throws Exception\ApiError
+	 */
+	public function replaceRouteSchedule(string $route_id, array $params)
+	{
+		$allBodyFields = ['member_id', 'vehicle_id', 'schedule_uid', 'name', 'schedule_blacklist',
+			'advance_interval', 'advance_schedule_interval_days', 'schedule', 'timezone'];
+
+		return $this->toRouteSchedule(Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES_REPLACE . '/' . $route_id,
+			'method' => 'PUT',
+			'HTTPHEADER' => 'Content-Type: application/json',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
+		]));
+	}
+
+	/**
+	 * Get the Route Schedule preview by specifying the 'route_id'.
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  string $routeId Route ID.
+	 * @param  string $start Start date as 'YYYY-MM-DD'
+	 * @param  string $end End date as 'YYYY-MM-DD'
+	 * @return array
+	 * @throws Exception\ApiError
+	 */
+	public function getRouteSchedulePreview(string $route_id, string $start, string $end) : array
+	{
+		return Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES . '/' . $route_id . '/preview',
+			'method' => 'GET',
+			'query' => ['start' => $start, 'end' => $end]
+		]);
+	}
+
+	/**
+	 * Check if the Scheduled Route was copied by specifying the 'route_id'.
+	 * @todo request return true instead of return json status
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  string $routeId Route ID.
+	 * @return bool
+	 * @throws Exception\ApiError
+	 */
+	public function isScheduledRouteCopy(string $route_id) : bool
+	{
+		return Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_SCHEDULED_ROUTES_IS_COPY . '/' . $route_id,
+			'method' => 'GET'
+		]);
+	}
+
+	/**
+	 * Get all routes copied from the specified Scheduled Route by sending
+	 * the corresponding data.
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  string   $route_id Route ID.
+	 * @param  string   $schedule_uid Schedule ID.
+	 * @param  string   $route_date Route date as 'YYYY-MM-DD'.
+	 * @return array
+	 * @throws Exception\ApiError
+	 */
+	public function getScheduledRoutesCopies(string $route_id, string $schedule_uid, string $route_date) : array
+	{
+		return Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_SCHEDULED_ROUTES_GET_COPIES,
+			'method' => 'POST',
+			'HTTPHEADER' => 'Content-Type: application/json',
+			'body' => [
+				'route_id' => $route_id,
+				'schedule_uid' => $schedule_uid,
+				'route_date' => $route_date
+			]
+		]);
+	}
+
+	/**
+	 * Create a new Master Route by sending the corresponding data.
+	 * @todo request return true instead of return json status
+	 *
+	 * @since 1.2.3
+	 *
+	 * @param  array    $params
+	 *   string   route_id - Route ID,
+	 *   string   route_name,
+	 *   int      member_id - A unique ID of the root member,
+	 *   string   vehicle_id - Vehicle ID,
+	 *   string   schedule_uid - Schedule ID,
+	 *   string   name,
+	 *   string[] schedule_blacklist - Blacklisted dates as YYYY-MM-DD,
+	 *   int      advance_interval,
+	 *   int      advance_schedule_interval_days,
+	 *   string   schedule - Schedule as JSON string e.g. '{"enabled":true,"mode":"daily",
+	 *                           "daily":{"every":2}, "from":"2019-06-05","timestamp":1558538737}',
+	 *   string   timezone - Timezone as 'America/New_York'
+	 * @return bool
+	 * @throws Exception\ApiError
+	 */
+	public function createMasterRoute(array $params) : bool
+	{
+		$allBodyFields = ['route_id', 'route_name', 'member_id', 'schedule_uid', 'vehicle_id', 'name',
+			'schedule_blacklist', 'advance_schedule_interval_days', 'schedule', 'timezone'];
+
+		return Route4Me::makeRequst([
+			'url' => Endpoint::RECURRING_ROUTES_MASTER_ROUTES,
+			'method' => 'POST',
+			'HTTPHEADER' => 'Content-Type: application/json',
+			'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
+		]);
+	}
+
+	private function toSchedule($result) : Schedule
+	{
+		if (is_array($result) && isset($result['data'])) {
+			$data = $result['data'];
+			if (is_array($data) && isset($data[0]) && is_array($data[0])) {
+				return new Schedule($data[0]);
+			}
+		}
+		throw new ApiError('Can not convert result to Schedule object.');
+	}
+
+	private function toRouteSchedule($result) : RouteSchedule
+	{
+		if (is_array($result) && isset($result['data'])) {
+			$data = $result['data'];
+			if (is_array($data) && isset($data[0]) && is_array($data[0])) {
+				return new RouteSchedule($data[0]);
+			}
+		}
+		throw new ApiError('Can not convert result to RouteSchedule object.');
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -67,7 +67,7 @@ 
     public function getSchedule(string $scheduleId) : Schedule
     {
         return $this->toSchedule(Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_SCHEDULES . '/' . $scheduleId,
+            'url' => Endpoint::RECURRING_ROUTES_SCHEDULES.'/'.$scheduleId,
             'method' => 'GET'
         ]));
     }
@@ -163,7 +163,7 @@ 
             'advance_interval', 'advance_schedule_interval_days', 'schedule', 'timezone'];
 
         return $this->toSchedule(Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_SCHEDULES . '/' . $scheduleId,
+            'url' => Endpoint::RECURRING_ROUTES_SCHEDULES.'/'.$scheduleId,
             'method' => 'PUT',
             'HTTPHEADER' => 'Content-Type: application/json',
             'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
@@ -185,7 +185,7 @@ 
     public function deleteSchedule(string $scheduleId, bool $withRoutes = false) : Schedule
     {
         return $this->toSchedule(Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_SCHEDULES . '/' . $scheduleId,
+            'url' => Endpoint::RECURRING_ROUTES_SCHEDULES.'/'.$scheduleId,
             'method' => 'DELETE',
             'query' => ['with_routes' => $withRoutes]
         ]));
@@ -228,7 +228,7 @@ 
     public function getRouteSchedule(string $route_id) : RouteSchedule
     {
         return $this->toRouteSchedule(Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES . '/' . $route_id,
+            'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES.'/'.$route_id,
             'method' => 'GET'
         ]));
     }
@@ -317,7 +317,7 @@ 
         $allBodyFields = ['schedule_uid', 'member_id', 'vehicle_id'];
 
         return $this->toRouteSchedule(Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES . '/' . $route_id,
+            'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES.'/'.$route_id,
             'method' => 'PUT',
             'HTTPHEADER' => 'Content-Type: application/json',
             'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
@@ -337,10 +337,10 @@ 
     public function deleteRouteSchedules(string $route_id) : bool
     {
         $result = Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES . '/' . $route_id,
+            'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES.'/'.$route_id,
             'method' => 'DELETE'
         ]);
-        return ($result == 1 ? true : false);
+        return ($result==1 ? true : false);
     }
 
     /**
@@ -355,7 +355,7 @@ 
     public function deleteRouteSchedule(string $route_id) : RouteSchedule
     {
         return $this->toRouteSchedule(Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES . '/' . $route_id  . '/items',
+            'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES.'/'.$route_id.'/items',
             'method' => 'DELETE'
         ]));
     }
@@ -386,7 +386,7 @@ 
             'advance_interval', 'advance_schedule_interval_days', 'schedule', 'timezone'];
 
         return $this->toRouteSchedule(Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES_REPLACE . '/' . $route_id,
+            'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES_REPLACE.'/'.$route_id,
             'method' => 'PUT',
             'HTTPHEADER' => 'Content-Type: application/json',
             'body' => Route4Me::generateRequestParameters($allBodyFields, $params)
@@ -407,7 +407,7 @@ 
     public function getRouteSchedulePreview(string $route_id, string $start, string $end) : array
     {
         return Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES . '/' . $route_id . '/preview',
+            'url' => Endpoint::RECURRING_ROUTES_ROUTE_SCHEDULES.'/'.$route_id.'/preview',
             'method' => 'GET',
             'query' => ['start' => $start, 'end' => $end]
         ]);
@@ -426,7 +426,7 @@ 
     public function isScheduledRouteCopy(string $route_id) : bool
     {
         return Route4Me::makeRequst([
-            'url' => Endpoint::RECURRING_ROUTES_SCHEDULED_ROUTES_IS_COPY . '/' . $route_id,
+            'url' => Endpoint::RECURRING_ROUTES_SCHEDULED_ROUTES_IS_COPY.'/'.$route_id,
             'method' => 'GET'
         ]);
     }

src/Route4Me/Common.php

Indentation +19 added lines, -19 removed lines

@@ -4,26 +4,26 @@
 
 class Common
 {
-    public static function getValue($array, $item, $default = null)
-    {
-        return (isset($array[$item])) ? $array[$item] : $default;
-    }
+	public static function getValue($array, $item, $default = null)
+	{
+		return (isset($array[$item])) ? $array[$item] : $default;
+	}
 
-    public function toArray()
-    {
-        $params = array_filter(get_object_vars($this), function ($item) {
-            return (null !== $item) && !(is_array($item) && !count($item));
-        });
+	public function toArray()
+	{
+		$params = array_filter(get_object_vars($this), function ($item) {
+			return (null !== $item) && !(is_array($item) && !count($item));
+		});
 
-        return $params;
-    }
+		return $params;
+	}
 
-    protected function fillFromArray(array $params)
-    {
-        foreach ($this as $key => $value) {
-            if (isset($params[$key])) {
-                $this->{$key} = $params[$key];
-            }
-        }
-    }
+	protected function fillFromArray(array $params)
+	{
+		foreach ($this as $key => $value) {
+			if (isset($params[$key])) {
+				$this->{$key} = $params[$key];
+			}
+		}
+	}
 }