Route4Me\Address

Complexity

Total Complexity

23

Size/Duplication

Total Lines	282
Duplicated Lines	31.91 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	fromArray()	0	11	3
A	getAddress()	0	13	1
A	update()	14	14	1
A	GetAddressesNotes()	0	15	3
A	markAddress()	14	14	1
A	markAsDeparted()	12	12	1
A	markAsVisited()	12	12	1
A	deleteAddress()	13	13	1
A	moveDestinationToRoute()	13	13	1
A	AddAddressNote()	0	15	1
A	AddNoteFile()	0	15	1
A	createCustomNoteType()	0	12	1
A	removeCustomNoteType()	12	12	2
A	getAllCustomNoteTypes()	0	9	1
A	addCustomNoteToRoute()	0	23	3
A	getAddressId()	0	4	1

<?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()

This method seems to be duplicated in your project.

    {
        $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)

This method seems to be duplicated in your project.

    {
        $allQueryFields = array('route_id', 'route_destination_id');
        $allBodyFields = array('is_visited', 'is_departed');
        
        $result = Route4Me::makeRequst(array(
            'url'    => Endpoint::ADDRESS_V4,
            'method' => 'PUT',
            'query'  => Route4Me::generateRequestParameters($allQueryFields, $params),
            'body'   => Route4Me::generateRequestParameters($allBodyFields, $params)
        ));
    
        return $result;
    }
    
    public function markAsDeparted($params)

This method seems to be duplicated in your project.

    {
        $allQueryFields = array('route_id', 'address_id', 'is_departed', 'member_id');
        
        $address = Route4Me::makeRequst(array(
            'url'    => Endpoint::MARK_ADDRESS_DEPARTED,
            'method' => 'PUT',
            'query'  => Route4Me::generateRequestParameters($allQueryFields, $params)
        ));
    
        return $address;
    }
    
    public function markAsVisited($params)

This method seems to be duplicated in your project.

    {
        $allQueryFields = array('route_id', 'address_id', 'is_visited', 'member_id');
        
        $address = Route4Me::makeRequst(array(
            'url'    => Endpoint::UPDATE_ADDRESS_VISITED,
            'method' => 'PUT',
            'query'  => Route4Me::generateRequestParameters($allQueryFields, $params)
        ));
    
        return $address;
    }

    public function deleteAddress()

This method seems to be duplicated in your project.

    {
        $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)

This method seems to be duplicated in your project.

    {
        $allBodyFields = array('to_route_id', 'route_destination_id', 'after_destination_id');
        
        $result = Route4Me::makeRequst(array(
            'url'    => Endpoint::MOVE_ROUTE_DESTINATION,
            'method' => 'POST',
            'body'   => Route4Me::generateRequestParameters($allBodyFields, $params),
            'HTTPHEADER'  => 'Content-Type: multipart/form-data'
        ));

        return $result;
    }
    
    public function AddAddressNote($params)
    {
        $allQueryFields = array('route_id', 'address_id', 'dev_lat', 'dev_lng', 'device_type');
        $allBodyFields = array('strNoteContents', 'strUpdateType');
        
        $result = Route4Me::makeRequst(array(
            'url'    => Endpoint::ROUTE_NOTES_ADD,
            'method' => 'POST',
            'query'  => Route4Me::generateRequestParameters($allQueryFields, $params),
            'body'   => Route4Me::generateRequestParameters($allBodyFields, $params),
            'HTTPHEADER'  => 'Content-Type: multipart/form-data'
        ));

        return $result;
    }

    public function AddNoteFile($params)
    {
        $allQueryFields = array('route_id', 'address_id', 'dev_lat', 'dev_lng', 'device_type', 'strUpdateType');
        $allBodyFields = array('strFilename');
        
        $result = Route4Me::fileUploadRequest(array(
            'url'    => Endpoint::ROUTE_NOTES_ADD,
            'method' => 'POST',
            'query'  => Route4Me::generateRequestParameters($allQueryFields, $params),
            'body'   => Route4Me::generateRequestParameters($allBodyFields, $params),
            'HTTPHEADER'  => 'Content-Type: multipart/form-data'
        ));

        return $result;
    }

    public function createCustomNoteType($params)
    {
        $allBodyFields = array('type', 'values');
        
        $result = Route4Me::makeRequst(array(
            'url'    => Endpoint::NOTE_CUSTOM_TYPES_V4,
            'method' => 'POST',
            'body'   => Route4Me::generateRequestParameters($allBodyFields, $params)
        ));

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

This method seems to be duplicated in your project.

    {
        $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) {
            if (strpos($key, "custom_note_type")!==false) {
                $customArray[$key] = $value;
            }
        }
        
        $allQueryFields = array('route_id', 'address_id', 'format', 'dev_lat', 'dev_lng');
        $allBodyFields = array('strUpdateType', 'strUpdateType', 'strNoteContents');
        
        $result = Route4Me::makeRequst(array(
            'url'    => Endpoint::ROUTE_NOTES_ADD,
            'method' => 'POST',
            'query'  => Route4Me::generateRequestParameters($allQueryFields, $params),
            'body'  => array_merge(Route4Me::generateRequestParameters($allBodyFields, $params), $customArray),
            'HTTPHEADER'  => 'Content-Type: multipart/form-data'
        ));

        return $result;
    }

    function getAddressId()

It is generally recommended to explicitly declare the visibility for methods.

    {
        return $this->route_destination_id;
    }
}