Route4Me\AddressBookLocation

Complexity

Total Complexity

77

Size/Duplication

Total Lines	450
Duplicated Lines	32.44 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

18 Methods

Rating	Name	Duplication	Size	Complexity
A	fromArray()	0	12	3
A	getAddressBookLocation()	13	13	1
A	searchAddressBookLocations()	12	12	1
A	getAddressBookLocations()	12	12	1
A	getAddressBookLocationsByIDs()	0	12	1
A	getRandomAddressBookLocation()	0	15	3
A	addAdressBookLocation()	12	12	1
A	deleteAdressBookLocation()	12	12	1
A	updateAdressBookLocation()	0	12	1
A	validateScheduleMode()	0	10	2
A	validateScheduleEnable()	0	10	2
A	validateScheduleEvery()	0	8	2
A	validateScheduleWeekDays()	18	19	6
A	validateScheduleMonthlyMode()	0	10	2
A	validateScheduleMonthlyDates()	18	19	6
A	validateScheduleNthN()	0	12	3
A	validateScheduleNthWhat()	0	12	3
F	addLocationsFromCsvFile()	49	165	38

<?php
namespace Route4Me;

use Route4Me\Common;
use Route4Me\Enum\Endpoint;

class AddressBookLocation extends Common
{
    public $address_id;
    public $address_group;
    public $address_alias;
    public $address_1;
    public $address_2;
    public $first_name;
    public $last_name;
    public $address_email;
    public $address_phone_number;
    public $address_city;
    public $address_state_id;
    public $address_country_id;
    public $address_zip;
    public $cached_lat;
    public $cached_lng;
    public $curbside_lat;
    public $curbside_lng;
    public $color;
    public $address_custom_data;
    public $schedule;
    
    public $created_timestamp;
    public $member_id;
    public $schedule_blacklist;
    public $in_route_count;
    public $last_visited_timestamp;
    public $last_routed_timestamp;
    public $local_time_window_start;
    public $local_time_window_end;
    public $local_time_window_start_2;
    public $local_time_window_end_2;
    public $service_time;
    public $local_timezone_string;
    public $address_icon;
    public $address_stop_type;
    public $address_cube;
    public $address_pieces;
    public $address_reference_no;
    public $address_revenue;
    public $address_weight;
    public $address_priority;
    public $address_customer_po;
    
    public static function fromArray(array $params)
    {
        $addressbooklocation = new AddressBookLocation();
        
        foreach ($params as $key => $value) {
            if (property_exists($addressbooklocation, $key)) {
                $addressbooklocation->{$key} = $value;
            }
        }
        
        return $addressbooklocation;
    }
    
    
    
    public static function getAddressBookLocation($addressId)

This method seems to be duplicated in your project.

    {
        $ablocations = Route4Me::makeRequst(array(
            'url'    => Endpoint::ADDRESS_BOOK_V4,
            'method' => 'GET',
            'query'  => array(
                'query' => $addressId,
                'limit' => 30
            )
        ));

        return $ablocations;
    }
    
    public static function searchAddressBookLocations($params)

This method seems to be duplicated in your project.

    {
        $allQueryFields = array('display', 'query', 'fields', 'limit', 'offset');
        
        $result = Route4Me::makeRequst(array(
            'url'    => Endpoint::ADDRESS_BOOK_V4,
            'method' => 'GET',
            'query'  => Route4Me::generateRequestParameters($allQueryFields, $params)
        ));

        return $result;
    }
    
    public static function getAddressBookLocations($params)

This method seems to be duplicated in your project.

    {
        $allQueryFields = array('limit', 'offset');
        
        $ablocations = Route4Me::makeRequst(array(
            'url'    => Endpoint::ADDRESS_BOOK_V4,
            'method' => 'GET',
            'query'  => Route4Me::generateRequestParameters($allQueryFields, $params)
        ));

        return $ablocations;
    }
    
    public static function getAddressBookLocationsByIDs($ids)
    {
        $ablocations = Route4Me::makeRequst(array(
            'url'    => Endpoint::ADDRESS_BOOK_V4,
            'method' => 'GET',
            'query'  => array(
                'address_id' => $ids
            )
        ));

        return $ablocations;
    }
    
    public static function getRandomAddressBookLocation($params)

The parameter $params is not used and could be removed.

    {
        $ablocations = self::getAddressBookLocations(array('offset' => 0, 'limit' => 20));
        
        if (isset($ablocations["results"])) {
            $locationsSize = sizeof($ablocations["results"]);
            
            if ($locationsSize>0) {
                $randomLocationIndex = rand(0, $locationsSize - 1);
                return $ablocations["results"][$randomLocationIndex];
            } 
        } 

        return null;
    }
    
    /**
     * @param AddressBookLocation $params
    */
    public static function addAdressBookLocation($params)

This method seems to be duplicated in your project.

    {
        $allBodyFields = Route4Me::getObjectProperties(new AddressBookLocation(), array('address_id', 'in_route_count'));
        
        $response = Route4Me::makeRequst(array(
            'url'    => Endpoint::ADDRESS_BOOK_V4,
            'method' => 'POST',
            'body'   => Route4Me::generateRequestParameters($allBodyFields, $params)
        ));

        return $response;
    }
    
    public function deleteAdressBookLocation($address_ids)

This method seems to be duplicated in your project.

    {
        $result = Route4Me::makeRequst(array(
            'url'    => Endpoint::ADDRESS_BOOK_V4,
            'method' => 'DELETEARRAY',
            'query'  => array(
                'address_ids' => $address_ids
            )
        ));

        return $result;
    }
    
    public function updateAdressBookLocation($params)
    {
        $allBodyFields = Route4Me::getObjectProperties(new AddressBookLocation(), array('in_route_count'));

        $response = Route4Me::makeRequst(array(
            'url'    => Endpoint::ADDRESS_BOOK_V4,
            'method' => 'PUT',
            'body'   => Route4Me::generateRequestParameters($allBodyFields, $params)
        ));

        return $response;
    }
        
    public static function validateScheduleMode($scheduleMode)
    {
        $schedMmodes = array("daily", "weekly", "monthly", "annually");
        
        if (in_array($scheduleMode, $schedMmodes)) {
            return TRUE; 
        } else {
            return FALSE;
        }
    }
    
    public static function validateScheduleEnable($scheduleEnabled)
    {
        $schedEnables = array(TRUE, FALSE);
        
        if (in_array($scheduleEnabled, $schedEnables)) {
            return TRUE;
        } else {
            return FALSE;
        }
    }
    
    public static function validateScheduleEvery($scheduleEvery)
    {
        if (is_numeric($scheduleEvery)) {
            return TRUE;
        } else {
            return FALSE;
        }
    }
    
    public static function validateScheduleWeekDays($scheduleWeekDays)

This method seems to be duplicated in your project.

    {
        $weekdays = explode(',', $scheduleWeekDays);
        
        if (sizeof($weekdays)<1) return FALSE;
        
        $isValid = TRUE;
        
        for ($i=0; $i<sizeof($weekdays); $i++) { 

It seems like you are calling the size function sizeof() as part of the test condition. You might want to compute the size beforehand, and not on each iteration.

            if (is_numeric($weekdays[$i])) {
                $wday = intval($weekdays[$i]);
                if ($wday<1 || $wday>7) $isValid = FALSE;
            } else {
                $isValid = FALSE;
            }
        }
        
        return $isValid;
    }
    
    public static function validateScheduleMonthlyMode($scheduleMonthlyMode)
    {
        $schedMonthlyMmodes = array("dates", "nth");
        
        if (in_array($scheduleMonthlyMode, $schedMonthlyMmodes)) {
            return TRUE;
        } else {
            return FALSE;
        }
    }
    
    public static function validateScheduleMonthlyDates($scheduleMonthlyDates)

This method seems to be duplicated in your project.

    {
        $monthlyDates = explode(',', $scheduleMonthlyDates);
        
        if (sizeof($monthlyDates) <1) return FALSE;
        
        $isValid = TRUE;
        
        for ($i=0; $i < sizeof($monthlyDates); $i++) { 

It seems like you are calling the size function sizeof() as part of the test condition. You might want to compute the size beforehand, and not on each iteration.

            if (is_numeric($monthlyDates[$i])) {
                $mday = intval($monthlyDates[$i]);
                if ($mday <1 || $mday > 31) $isValid = FALSE;
            } else {
                $isValid = FALSE;
            }
        }

        return $isValid;
    }
    
    public static function validateScheduleNthN($scheduleNthN)
    {
        if (!is_numeric($scheduleNthN)) return FALSE;
        
        $schedNthNs = array(1, 2, 3, 4, 5, -1);
        
        if (in_array($scheduleNthN, $schedNthNs)) {
            return TRUE;
        } else {
            return FALSE;
        }
    }
    
    public static function validateScheduleNthWhat($scheduleNthWhat)
    {
        if (!is_numeric($scheduleNthWhat)) return FALSE;
        
        $schedNthWhats = array(1, 2, 3, 4, 5, 6, 7, 8, 9, 10);
        
        if (in_array($scheduleNthWhat, $schedNthWhats)) {
            return TRUE;
        } else {
            return FALSE;
        }
    }
    
    /** Function adds the locations (with/without schedule) from the CSV file. 
     * $csvFileHandle - a file handler.
     * Returns array $results which contains two arrays: fail and succes.
     */
    public function addLocationsFromCsvFile($csvFileHandle, $locationsFieldsMapping)
    {
        $max_line_length = 512;
        $delemietr = ',';
        
        $results = array();
        $results['fail'] = array();
        $results['success'] = array();
        
        $columns = fgetcsv($csvFileHandle, $max_line_length, $delemietr);
        
        $addressBookFields = Route4Me::getObjectProperties(new AddressBookLocation(), array('address_id', 'in_route_count'));

        if (empty($columns)) {
            array_push($results['fail'], 'Empty CSV table');
            return ($results);
        }

        $iRow = 1;
        
        while (($rows = fgetcsv($csvFileHandle, $max_line_length, $delemietr))!==false) {
            if (!isset($rows[$locationsFieldsMapping['cached_lat']]) || !isset($rows[$locationsFieldsMapping['cached_lng']]) 
                  || !isset($rows[$locationsFieldsMapping['address_1']]) || array(null)==$rows) {
                continue;
            }
                      
            $curSchedule = "";
            $mode = "";
            
            $failCount = sizeof($results['fail']); 
            
            if (isset($rows[$locationsFieldsMapping['schedule_mode']])) {

This code seems to be duplicated across your project.

                if ($this->validateScheduleMode($rows[$locationsFieldsMapping['schedule_mode']])) {
                    $curSchedule = '"mode":"'.$rows[$locationsFieldsMapping['schedule_mode']].'",'; 
                    $mode = $rows[$locationsFieldsMapping['schedule_mode']];
                } else {
                    array_push($results['fail'], "$iRow --> Wrong schedule mode parameter"); 
                }
            } else {
                array_push($results['fail'], "$iRow --> The schedule mode parameter is not set"); 
            }
            
            if (isset($rows[$locationsFieldsMapping['schedule_enabled']])) {
                if ($this->validateScheduleEnable($rows[$locationsFieldsMapping['schedule_enabled']])) { 
                    $curSchedule .= '"enabled":'.$rows[$locationsFieldsMapping['schedule_enabled']].',';
                } else {
                    array_push($results['fail'], "$iRow --> The schedule enabled parameter is not set ");  
                }
            }
            
            if (isset($rows[$locationsFieldsMapping['schedule_every']])) {
                if ($this->validateScheduleEvery($rows[$locationsFieldsMapping['schedule_every']])) {
                    $curSchedule.='"'.$mode.'":{'.'"every":'.$rows[$locationsFieldsMapping['schedule_every']].','; 
                    if ($mode=='daily') {
                        $curSchedule = trim($curSchedule,',');
                        $curSchedule.='}';
                    }
                } else {
                    array_push($results['fail'], "$iRow --> The parameter sched_every is not set"); 
                }
            }
            
            if ($mode!='daily') {
                switch ($mode) {
                    case 'weekly':
                        if (isset($rows[$locationsFieldsMapping['schedule_weekdays']])) {

This code seems to be duplicated across your project.

                            if ($this->validateScheduleWeekDays($rows[$locationsFieldsMapping['schedule_weekdays']])) {
                                 $curSchedule .= '"weekdays":['.$rows[$locationsFieldsMapping['schedule_weekdays']].']}';
                            } else {
                                array_push($results['fail'], "$iRow --> Wrong weekdays"); 
                            }
                        } else {
                            array_push($results['fail'], "$iRow --> The parameters sched_weekdays is not set"); 
                        }
                        break;
                    case 'monthly':
                        $monthlyMode = "";
                        if (isset($rows[$locationsFieldsMapping['monthly_mode']])) {

This code seems to be duplicated across your project.

                            if ($this->validateScheduleMonthlyMode($rows[$locationsFieldsMapping['monthly_mode']])) {
                                 $monthlyMode = $rows[$locationsFieldsMapping['monthly_mode']];
                                 $curSchedule .= '"mode": "'.$rows[$locationsFieldsMapping['monthly_mode']].'",';
                            } else {
                                array_push($results['fail'], "$iRow --> Wrong monthly mode"); 
                            }
                        } else {
                            array_push($results['fail'], "$iRow --> The parameter sched_monthly_mode is not set"); 
                        }
                        
                        if ($monthlyMode!="") {
                            switch ($monthlyMode) {
                                case 'dates':
                                    if (isset($rows[$locationsFieldsMapping['monthly_dates']])) {
                                        if ($this->validateScheduleMonthlyDates($rows[$locationsFieldsMapping['monthly_dates']])) {
                                             $curSchedule .= '"dates":['.$rows[$locationsFieldsMapping['monthly_dates']].']}';
                                        } else {
                                            array_push($results['fail'], "$iRow --> Wrong monthly dates"); 
                                        }
                                    }
                                    break;
                                case 'nth':
                                    if (isset($rows[$locationsFieldsMapping['monthly_nth_n']])) {

This code seems to be duplicated across your project.

                                        if ($this->validateScheduleNthN($rows[$locationsFieldsMapping['monthly_nth_n']])) {
                                             $curSchedule .= '"nth":{"n":'.$rows[$locationsFieldsMapping['monthly_nth_n']].',';
                                        } else {
                                            array_push($results['fail'], "$iRow --> Wrong parameter sched_nth_n"); 
                                        }
                                    } else {
                                        array_push($results['fail'], "$iRow --> The parameter sched_nth_n is not set"); 
                                    }
                                    
                                    if ($curSchedule!="") {

This code seems to be duplicated across your project.

                                        if (isset($rows[$locationsFieldsMapping['monthly_nth_wwhat']])) {
                                            if ($this->validateScheduleNthWhat($rows[$locationsFieldsMapping['monthly_nth_wwhat']])) {
                                                 $curSchedule .= '"what":'.$rows[$locationsFieldsMapping['monthly_nth_wwhat']].'}}';
                                            } else {
                                                array_push($results['fail'], "$iRow --> Wrong parameter sched_nth_what"); 
                                            }
                                        } else {
                                            array_push($results['fail'], "$iRow --> The parameter sched_nth_what is not set"); 
                                        }
                                    }
                                    break;
                            }
                        }
                        break;
                    default:
                        $curSchedule = "";
                        break;
                }
            }

            if (sizeof($results['fail'])>$failCount) {
                $curSchedule = "";
            }

            if (($mode=='daily' || $mode=='weekly' || $mode=='monthy') && $curSchedule=="") {
                $iRow++; 
                continue;
            }
            
            $curSchedule = strtolower($curSchedule);
            
            $curSchedule = '[{'.$curSchedule.'}]';

            $oSchedule = json_decode($curSchedule,TRUE);

$oSchedule is not used, you could remove the assignment.

            
            $parametersArray = array();
            
            foreach ($addressBookFields as $addressBookField) {
                if (isset($locationsFieldsMapping[$addressBookField])) {
                    $parametersArray[$addressBookField] = $rows[$locationsFieldsMapping[$addressBookField]];
                }
            }
            
            $AdressBookLocationParameters = AddressBookLocation::fromArray($parametersArray);
            
            $abContacts = new AddressBookLocation();

            $abcResults = $abContacts->addAdressBookLocation($AdressBookLocationParameters); //temporarry
            
            array_push($results['success'], "The schedule location with address_id = ".strval($abcResults["address_id"])." added successfuly.");
        }

        return $results;
    }

 }