Address::markAsDeparted() - Code Metrics - Inspection of "Update Route.php" - route4me/route4me-php-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( ba89cf...799599 )

by Oleg

created 2018-12-19 08:26 UTC

Address::markAsDeparted() A

↳ Parent: Address

Complexity

Conditions	5
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
nc	1
nop	1
dl	0
loc	15
rs	9.4555
c	0
b	0
f	0

<?php
namespace Route4Me;

use Route4Me\Exception\BadParam;
use Route4Me\Route4Me;
use Route4Me\Common;
use Route4Me\Enum\Endpoint;

class Address extends Common
{
    public $route_destination_id;
    public $alias;
    public $member_id;
    public $address;
    public $addressUpdate;
    public $is_depot = false;
    public $lat;
    public $lng;
    public $route_id;
    public $original_route_id;
    public $optimization_problem_id;
    public $sequence_no;
    public $geocoded;
    public $preferred_geocoding;
    public $failed_geocoding;
    public $geocodings = array();
    public $contact_id;
    public $is_visited;
    public $customer_po;
    public $invoice_no;
    public $reference_no;
    public $order_no;
    public $weight;
    public $cost;
    public $revenue;
    public $cube;
    public $pieces;
    public $email;
    public $phone;
    public $tracking_number;
    public $destination_note_count;
    public $drive_time_to_next_destination;
    public $distance_to_next_destination;
    public $generated_time_window_start;
    public $generated_time_window_end;
    public $time_window_start;
    public $time_window_end;
    public $time;
    public $notes;
    public $timestamp_last_visited;
    public $custom_fields = array();
    public $manifest = array();
    
    public $first_name;
    public $last_name;
    public $is_departed;
    public $timestamp_last_departed;
    public $order_id;
    public $priority;
    public $curbside_lat;
    public $curbside_lng;
    public $time_window_start_2;
    public $time_window_end_2;

    public static function fromArray(array $params)
    {
        $address = new Address();
        foreach ($params as $key => $value) {
            if (property_exists($address, $key)) {
                $address->{$key} = $value;
            }
        }
        
        return $address;
    }

    public static function getAddress($routeId, $addressId)
    {
        $address = Route4Me::makeRequst(array(
            'url'    => Endpoint::ADDRESS_V4,
            'method' => 'GET',
            'query'  => array(
                'route_id'             => $routeId,
                'route_destination_id' => $addressId,
            )
        ));
    
        return Address::fromArray($address);
    }
    
    /*Get notes from the specified route destination
     * Returns an address object with notes, if an address exists, otherwise - return null.
     */
    public static function GetAddressesNotes($noteParams)

    {
        $address = Route4Me::makeRequst(array(
            'url'    => Endpoint::ADDRESS_V4,
            'method' => 'GET',
            'query'  => array(
                'route_id'             => isset($noteParams['route_id']) ? $noteParams['route_id'] : null, 
                'route_destination_id' => isset($noteParams['route_destination_id']) 
                                             ? $noteParams['route_destination_id'] : null,
                'notes'                => 1,
            )
        ));
    
        return $address;
    }

    public function update()

    {
        $addressUpdate = Route4Me::makeRequst(array(
            'url'    => Endpoint::ADDRESS_V4,
            'method' => 'PUT',
            'body'   => $this->toArray(),
            'query'  => array(
                'route_id'             => $this->route_id,
                'route_destination_id' => $this->route_destination_id,
            ),
        ));
    
        return Address::fromArray($addressUpdate);
    }
    
    public function markAddress($params, $body)

    {
        $result = Route4Me::makeRequst(array(
            'url'    => Endpoint::ADDRESS_V4,
            'method' => 'PUT',
            'query'  => array(
                'route_id'             => isset($params['route_id']) ? $params['route_id'] : null, 
                'route_destination_id' => isset($params['route_destination_id']) ? $params['route_destination_id'] : null,
            ),
            'body'   => $body
        ));
    
        return $result;
    }
    
    public function markAsDeparted($params)
    {
        $address = Route4Me::makeRequst(array(
            'url'    => Endpoint::MARK_ADDRESS_DEPARTED,
            'method' => 'GET',
            'query'  => array(
                'route_id'     => isset($params['route_id']) ? $params['route_id'] : null,
                'address_id'   => isset($params['address_id']) ? $params['address_id'] : null,
                'is_departed'  => isset($params['is_departed']) ? $params['is_departed'] : null,
                'member_id'    => isset($params['member_id']) ? $params['member_id'] : null,
            ),
        ));
    
        return $address;
    }
    
    public function markAsVisited($params)

    {
        $address = Route4Me::makeRequst(array(
            'url'    => Endpoint::UPDATE_ADDRESS_VISITED,
            'method' => 'GET',
            'query'  => array(
                'route_id'   => isset($params['route_id']) ? $params['route_id'] : null,
                'address_id' => isset($params['address_id']) ? $params['address_id'] : null,
                'member_id'  => isset($params['member_id']) ? $params['member_id'] : null,
            ),
            'body'  =>  array(
                'is_visited' => isset($params['is_visited']) ? $params['is_visited'] : null
            )
        ));
    
        return $address;
    }

    public function delete()

    {
        $address = Route4Me::makeRequst(array(
            'url'    => Endpoint::ADDRESS_V4,
            'method' => 'DELETE',
            'query'  => array(
                'route_id'             => $this->route_id,
                'route_destination_id' => $this->route_destination_id,
            )
        ));
    
        return (bool)$address['deleted'];
    }
    
    public function moveDestinationToRoute($params)
    {
        $result = Route4Me::makeRequst(array(
            'url'    => Endpoint::MOVE_ROUTE_DESTINATION,
            'method' => 'POST',
            'body'  => array(
                'to_route_id'          => isset($params['to_route_id']) ? $params['to_route_id'] : null,
                'route_destination_id' => isset($params['route_destination_id']) ? $params['route_destination_id'] : null,
                'after_destination_id' => isset($params['after_destination_id']) ? $params['after_destination_id'] : null
            ),
            'HTTPHEADER'  => 'Content-Type: multipart/form-data'
        ));

        return $result;
    }
    
    public function AddAddressNote($params)

    {
        $result = Route4Me::makeRequst(array(
            'url'    => Endpoint::ROUTE_NOTES_ADD,
            'method' => 'POST',
            'query'  => array(
                'route_id'     =>  isset($params['route_id']) ? $params['route_id'] : null,
                'address_id'   =>  isset($params['address_id']) ? $params['address_id'] : null,
                'dev_lat'      =>  isset($params['dev_lat']) ? $params['dev_lat'] : null,
                'dev_lng'      =>  isset($params['dev_lng']) ? $params['dev_lng'] : null,
                'device_type'  =>  isset($params['device_type']) ? $params['device_type'] : null
            ),
            'body'  => array(
                'strNoteContents' => isset($params['strNoteContents']) ? $params['strNoteContents'] : null,
                'strUpdateType'   => isset($params['strUpdateType']) ? $params['strUpdateType'] : null
            ),
            'HTTPHEADER'  => 'Content-Type: multipart/form-data'
        ));

        return $result;
    }

    public function AddNoteFile($params)

    {
        $result = Route4Me::fileUploadRequest(array(
            'url'    => Endpoint::ROUTE_NOTES_ADD,
            'method' => 'POST',
            'query'  => array(
                'route_id'      =>  isset($params['route_id']) ? $params['route_id'] : null,
                'address_id'    =>  isset($params['address_id']) ? $params['address_id'] : null,
                'dev_lat'       =>  isset($params['dev_lat']) ? $params['dev_lat'] : null,
                'dev_lng'       =>  isset($params['dev_lng']) ? $params['dev_lng'] : null,
                'device_type'   =>  isset($params['device_type']) ? $params['device_type'] : null,
                'strUpdateType' =>  isset($params['strUpdateType']) ? $params['strUpdateType'] : null
            ),
            'body'  => array(
                'strFilename' => isset($params['strFilename']) ? $params['strFilename'] : null
            ),
            'HTTPHEADER'  => 'Content-Type: multipart/form-data'
        ));

        return $result;
    }

    public function createCustomNoteType($params)

    {
        $result = Route4Me::makeRequst(array(
            'url'    => Endpoint::NOTE_CUSTOM_TYPES_V4,
            'method' => 'POST',
            'body'   => array(
                'type'   => isset($params['type']) ? $params['type'] : null,
                'values' => isset($params['values']) ? $params['values'] : null
            )
        ));

        return $result;
    }
    
    public function removeCustomNoteType($params)

    {
        $result = Route4Me::makeRequst(array(
            'url'    => Endpoint::NOTE_CUSTOM_TYPES_V4,
            'method' => 'DELETE',
            'body'   => array(
                'id' => isset($params['id']) ? $params['id'] : null
            )
        ));

        return $result;
    }
    
    public function getAllCustomNoteTypes()
    {
        $result = Route4Me::makeRequst(array(
            'url'    => Endpoint::NOTE_CUSTOM_TYPES_V4,
            'method' => 'GET'
        ));

        return $result;
    }
    
    public function addCustomNoteToRoute($params)
    {
        $customArray = array();
        
        foreach ($params as $key => $value) {
            $kpos = strpos($key, "custom_note_type");
            
            if ($kpos!==false) {
                $customArray[$key] = $value;
            }
        }
        
        $result = Route4Me::makeRequst(array(
            'url'    => Endpoint::ROUTE_NOTES_ADD,
            'method' => 'POST',
            'query'  => array(
                'route_id'      =>  isset($params['route_id']) ? $params['route_id'] : null,
                'address_id'    =>  isset($params['address_id']) ? $params['address_id'] : null,
                'format'        =>  isset($params['format']) ? $params['format'] : null,
                'dev_lat'       =>  isset($params['dev_lat']) ? $params['dev_lat'] : null,
                'dev_lng'       =>  isset($params['dev_lng']) ? $params['dev_lng'] : null
            ),
            'body'  => array_merge(array(
                'strUpdateType'   =>  isset($params['strUpdateType']) ? $params['strUpdateType'] : null,
                'strUpdateType'   =>  isset($params['strUpdateType']) ? $params['strUpdateType'] : null,
                'strNoteContents' =>  isset($params['strNoteContents']) ? $params['strNoteContents'] : null
            ), $customArray),
            'HTTPHEADER'  => 'Content-Type: multipart/form-data'
        ));

        return $result;
    }

    function getAddressId()

    {
        return $this->route_destination_id;
    }
}


1		<?php
2		namespace Route4Me;
3
4		use Route4Me\Exception\BadParam;
5		use Route4Me\Route4Me;
6		use Route4Me\Common;
7		use Route4Me\Enum\Endpoint;
8
9		class Address extends Common
10		{
11		public $route_destination_id;
12		public $alias;
13		public $member_id;
14		public $address;
15		public $addressUpdate;
16		public $is_depot = false;
17		public $lat;
18		public $lng;
19		public $route_id;
20		public $original_route_id;
21		public $optimization_problem_id;
22		public $sequence_no;
23		public $geocoded;
24		public $preferred_geocoding;
25		public $failed_geocoding;
26		public $geocodings = array();
27		public $contact_id;
28		public $is_visited;
29		public $customer_po;
30		public $invoice_no;
31		public $reference_no;
32		public $order_no;
33		public $weight;
34		public $cost;
35		public $revenue;
36		public $cube;
37		public $pieces;
38		public $email;
39		public $phone;
40		public $tracking_number;
41		public $destination_note_count;
42		public $drive_time_to_next_destination;
43		public $distance_to_next_destination;
44		public $generated_time_window_start;
45		public $generated_time_window_end;
46		public $time_window_start;
47		public $time_window_end;
48		public $time;
49		public $notes;
50		public $timestamp_last_visited;
51		public $custom_fields = array();
52		public $manifest = array();
53
54		public $first_name;
55		public $last_name;
56		public $is_departed;
57		public $timestamp_last_departed;
58		public $order_id;
59		public $priority;
60		public $curbside_lat;
61		public $curbside_lng;
62		public $time_window_start_2;
63		public $time_window_end_2;
64
65		public static function fromArray(array $params)
66		{
67		$address = new Address();
68		foreach ($params as $key => $value) {
69		if (property_exists($address, $key)) {
70		$address->{$key} = $value;
71		}
72		}
73
74		return $address;
75		}
76
77		public static function getAddress($routeId, $addressId)
78		{
79		$address = Route4Me::makeRequst(array(
80		'url' => Endpoint::ADDRESS_V4,
81		'method' => 'GET',
82		'query' => array(
83		'route_id' => $routeId,
84		'route_destination_id' => $addressId,
85		)
86		));
87
88		return Address::fromArray($address);
89		}
90
91		/*Get notes from the specified route destination
92		* Returns an address object with notes, if an address exists, otherwise - return null.
93		*/
94	View Code Duplication	public static function GetAddressesNotes($noteParams)
		0 ignored issues – show Duplication introduced 2017-11-21 07:38 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
95		{
96		$address = Route4Me::makeRequst(array(
97		'url' => Endpoint::ADDRESS_V4,
98		'method' => 'GET',
99		'query' => array(
100		'route_id' => isset($noteParams['route_id']) ? $noteParams['route_id'] : null,
101		'route_destination_id' => isset($noteParams['route_destination_id'])
102		? $noteParams['route_destination_id'] : null,
103		'notes' => 1,
104		)
105		));
106
107		return $address;
108		}
109
110	View Code Duplication	public function update()
		0 ignored issues – show Duplication introduced 2017-11-21 07:38 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
111		{
112		$addressUpdate = Route4Me::makeRequst(array(
113		'url' => Endpoint::ADDRESS_V4,
114		'method' => 'PUT',
115		'body' => $this->toArray(),
116		'query' => array(
117		'route_id' => $this->route_id,
118		'route_destination_id' => $this->route_destination_id,
119		),
120		));
121
122		return Address::fromArray($addressUpdate);
123		}
124
125	View Code Duplication	public function markAddress($params, $body)
		0 ignored issues – show Duplication introduced 2017-11-01 15:33 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
126		{
127		$result = Route4Me::makeRequst(array(
128		'url' => Endpoint::ADDRESS_V4,
129		'method' => 'PUT',
130		'query' => array(
131		'route_id' => isset($params['route_id']) ? $params['route_id'] : null,
132		'route_destination_id' => isset($params['route_destination_id']) ? $params['route_destination_id'] : null,
133		),
134		'body' => $body
135		));
136
137		return $result;
138		}
139
140		public function markAsDeparted($params)
141		{
142		$address = Route4Me::makeRequst(array(
143		'url' => Endpoint::MARK_ADDRESS_DEPARTED,
144		'method' => 'GET',
145		'query' => array(
146		'route_id' => isset($params['route_id']) ? $params['route_id'] : null,
147		'address_id' => isset($params['address_id']) ? $params['address_id'] : null,
148		'is_departed' => isset($params['is_departed']) ? $params['is_departed'] : null,
149		'member_id' => isset($params['member_id']) ? $params['member_id'] : null,
150		),
151		));
152
153		return $address;
154		}
155
156	View Code Duplication	public function markAsVisited($params)
		0 ignored issues – show Duplication introduced 2017-10-26 15:50 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
157		{
158		$address = Route4Me::makeRequst(array(
159		'url' => Endpoint::UPDATE_ADDRESS_VISITED,
160		'method' => 'GET',
161		'query' => array(
162		'route_id' => isset($params['route_id']) ? $params['route_id'] : null,
163		'address_id' => isset($params['address_id']) ? $params['address_id'] : null,
164		'member_id' => isset($params['member_id']) ? $params['member_id'] : null,
165		),
166		'body' => array(
167		'is_visited' => isset($params['is_visited']) ? $params['is_visited'] : null
168		)
169		));
170
171		return $address;
172		}
173
174	View Code Duplication	public function delete()
		0 ignored issues – show Duplication introduced 2017-10-26 15:50 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
175		{
176		$address = Route4Me::makeRequst(array(
177		'url' => Endpoint::ADDRESS_V4,
178		'method' => 'DELETE',
179		'query' => array(
180		'route_id' => $this->route_id,
181		'route_destination_id' => $this->route_destination_id,
182		)
183		));
184
185		return (bool)$address['deleted'];
186		}
187
188		public function moveDestinationToRoute($params)
189		{
190		$result = Route4Me::makeRequst(array(
191		'url' => Endpoint::MOVE_ROUTE_DESTINATION,
192		'method' => 'POST',
193		'body' => array(
194		'to_route_id' => isset($params['to_route_id']) ? $params['to_route_id'] : null,
195		'route_destination_id' => isset($params['route_destination_id']) ? $params['route_destination_id'] : null,
196		'after_destination_id' => isset($params['after_destination_id']) ? $params['after_destination_id'] : null
197		),
198		'HTTPHEADER' => 'Content-Type: multipart/form-data'
199		));
200
201		return $result;
202		}
203
204	View Code Duplication	public function AddAddressNote($params)
		0 ignored issues – show Duplication introduced 2018-12-17 11:33 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
205		{
206		$result = Route4Me::makeRequst(array(
207		'url' => Endpoint::ROUTE_NOTES_ADD,
208		'method' => 'POST',
209		'query' => array(
210		'route_id' => isset($params['route_id']) ? $params['route_id'] : null,
211		'address_id' => isset($params['address_id']) ? $params['address_id'] : null,
212		'dev_lat' => isset($params['dev_lat']) ? $params['dev_lat'] : null,
213		'dev_lng' => isset($params['dev_lng']) ? $params['dev_lng'] : null,
214		'device_type' => isset($params['device_type']) ? $params['device_type'] : null
215		),
216		'body' => array(
217		'strNoteContents' => isset($params['strNoteContents']) ? $params['strNoteContents'] : null,
218		'strUpdateType' => isset($params['strUpdateType']) ? $params['strUpdateType'] : null
219		),
220		'HTTPHEADER' => 'Content-Type: multipart/form-data'
221		));
222
223		return $result;
224		}
225
226	View Code Duplication	public function AddNoteFile($params)
		0 ignored issues – show Duplication introduced 2018-12-17 11:33 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
227		{
228		$result = Route4Me::fileUploadRequest(array(
229		'url' => Endpoint::ROUTE_NOTES_ADD,
230		'method' => 'POST',
231		'query' => array(
232		'route_id' => isset($params['route_id']) ? $params['route_id'] : null,
233		'address_id' => isset($params['address_id']) ? $params['address_id'] : null,
234		'dev_lat' => isset($params['dev_lat']) ? $params['dev_lat'] : null,
235		'dev_lng' => isset($params['dev_lng']) ? $params['dev_lng'] : null,
236		'device_type' => isset($params['device_type']) ? $params['device_type'] : null,
237		'strUpdateType' => isset($params['strUpdateType']) ? $params['strUpdateType'] : null
238		),
239		'body' => array(
240		'strFilename' => isset($params['strFilename']) ? $params['strFilename'] : null
241		),
242		'HTTPHEADER' => 'Content-Type: multipart/form-data'
243		));
244
245		return $result;
246		}
247
248	View Code Duplication	public function createCustomNoteType($params)
		0 ignored issues – show Duplication introduced 2018-12-17 11:33 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
249		{
250		$result = Route4Me::makeRequst(array(
251		'url' => Endpoint::NOTE_CUSTOM_TYPES_V4,
252		'method' => 'POST',
253		'body' => array(
254		'type' => isset($params['type']) ? $params['type'] : null,
255		'values' => isset($params['values']) ? $params['values'] : null
256		)
257		));
258
259		return $result;
260		}
261
262	View Code Duplication	public function removeCustomNoteType($params)
		0 ignored issues – show Duplication introduced 2018-12-17 11:33 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
263		{
264		$result = Route4Me::makeRequst(array(
265		'url' => Endpoint::NOTE_CUSTOM_TYPES_V4,
266		'method' => 'DELETE',
267		'body' => array(
268		'id' => isset($params['id']) ? $params['id'] : null
269		)
270		));
271
272		return $result;
273		}
274
275		public function getAllCustomNoteTypes()
276		{
277		$result = Route4Me::makeRequst(array(
278		'url' => Endpoint::NOTE_CUSTOM_TYPES_V4,
279		'method' => 'GET'
280		));
281
282		return $result;
283		}
284
285		public function addCustomNoteToRoute($params)
286		{
287		$customArray = array();
288
289		foreach ($params as $key => $value) {
290		$kpos = strpos($key, "custom_note_type");
291
292		if ($kpos!==false) {
293		$customArray[$key] = $value;
294		}
295		}
296
297		$result = Route4Me::makeRequst(array(
298		'url' => Endpoint::ROUTE_NOTES_ADD,
299		'method' => 'POST',
300		'query' => array(
301		'route_id' => isset($params['route_id']) ? $params['route_id'] : null,
302		'address_id' => isset($params['address_id']) ? $params['address_id'] : null,
303		'format' => isset($params['format']) ? $params['format'] : null,
304		'dev_lat' => isset($params['dev_lat']) ? $params['dev_lat'] : null,
305		'dev_lng' => isset($params['dev_lng']) ? $params['dev_lng'] : null
306		),
307		'body' => array_merge(array(
308		'strUpdateType' => isset($params['strUpdateType']) ? $params['strUpdateType'] : null,
309		'strUpdateType' => isset($params['strUpdateType']) ? $params['strUpdateType'] : null,
310		'strNoteContents' => isset($params['strNoteContents']) ? $params['strNoteContents'] : null
311		), $customArray),
312		'HTTPHEADER' => 'Content-Type: multipart/form-data'
313		));
314
315		return $result;
316		}
317
318		function getAddressId()
		0 ignored issues – show Best Practice introduced 2017-01-26 07:21 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
319		{
320		return $this->route_destination_id;
321		}
322		}
323

route4me / route4me-php-sdk

GitHub Access Token became invalid

Push — master ( ba89cf...799599 )

Address::markAsDeparted() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like