Route4Me\AddressBookLocation

Complexity

Total Complexity

151

Size/Duplication

Total Lines	444
Duplicated Lines	35.14 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	1	1
A	fromArray()	0	10	3
A	getAddressBookLocation()	13	13	1
B	searchRoutedLocation()	16	16	6
A	getAddressBookLocations()	13	13	3
A	getAddressBookLocationsByIds()	12	12	1
D	addAdressBookLocation()	0	46	36
A	deleteAdressBookLocation()	12	12	1
A	updateAdressBookLocation()	0	12	1
B	get()	15	15	5
A	validateScheduleMode()	0	6	2
A	validateScheduleEnable()	0	6	2
A	validateScheduleEvery()	0	4	2
B	validateScheduleWeekDays()	18	18	6
A	validateScheduleMonthlyMode()	0	6	2
B	validateScheduleMonthlyDates()	18	18	6
A	validateScheduleNthN()	0	7	3
A	validateScheduleNthWhat()	0	7	3
F	addLocationsFromCsvFile()	39	168	67

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 6 and the first side effect is on line 452.

	namespace Route4Me;
	
	use Route4Me\Common;
	
	class AddressBookLocation extends Common
	{
		static public $apiUrl = '/api.v4/address_book.php';
		static public $apiUrl00 = '/api/address_book/modify_contact.php';
		
		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 $offset;
		//public $limit;
		
		public function __construct () {  }
		
		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'    => self::$apiUrl,
	            'method' => 'GET',
	            'query'  => array(
	                'query' => $addressId,
	                'limit' => 30
	            )
	        ));

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

This method seems to be duplicated in your project.

	    {
	    	$result= Route4Me::makeRequst(array(
	            'url'    => self::$apiUrl,
	            'method' => 'GET',
	            'query'  => array(
	                'display' => isset($params['display']) ? $params['display']: null,
	                'query' => isset($params['query']) ? $params['query']: null,
	                'fields' => isset($params['fields']) ? $params['fields']: null,
	                'limit' => isset($params['limit']) ? $params['limit']: null,
	                'offset' => isset($params['offset']) ? $params['offset'] : null,
	            )
	        ));

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

This method seems to be duplicated in your project.

	    {
	    	$ablocations = Route4Me::makeRequst(array(
	            'url'    => self::$apiUrl,
	            'method' => 'GET',
	            'query'  => array(
	                'limit' => isset($params->limit) ? $params->limit: null,
	                'offset' => isset($params->offset) ? $params->offset : null,
	            )
	        ));

			return $ablocations;
		}
		
		public static function getAddressBookLocationsByIds($ids)

This method seems to be duplicated in your project.

	    {
	    	$ablocations = Route4Me::makeRequst(array(
	            'url'    => self::$apiUrl,
	            'method' => 'GET',
	            'query'  => array(
	                'address_id' => $ids
	            )
	        ));

			return $ablocations;
		}
		
		public static function addAdressBookLocation($params)
	    {
	    	$ablocations = Route4Me::makeRequst(array(
	            'url'    => self::$apiUrl,
	            'method' => 'POST',
	            'body'  => array(
	            	'address_1' => 	isset($params->address_1) ? $params->address_1: null,
	            	'address_2' =>    isset($params->address_2) ? $params->address_2: null,
	            	'address_alias' =>    isset($params->address_alias) ? $params->address_alias: null,
	                'cached_lat' => isset($params->cached_lat) ? $params->cached_lat : null,
	                'cached_lng' => isset($params->cached_lng) ? $params->cached_lng : null,
	                'curbside_lat' => isset($params->curbside_lat) ? $params->curbside_lat : null,
                    'curbside_lng' => isset($params->curbside_lng) ? $params->curbside_lng : null,
	                'address_phone_number' =>    isset($params->address_phone_number) ? $params->address_phone_number: null,
	                'address_group' =>    isset($params->address_group) ? $params->address_group: null,
	                'first_name' =>    isset($params->first_name) ? $params->first_name: null,
	                'last_name' =>    isset($params->last_name) ? $params->last_name: null,
                    'local_time_window_start' =>    isset($params->local_time_window_start) ? $params->local_time_window_start: null,
                    'local_time_window_end' =>    isset($params->local_time_window_end) ? $params->local_time_window_end: null,
                    'local_time_window_start_2' =>    isset($params->local_time_window_start_2) ? $params->local_time_window_start_2: null,
                    'local_time_window_end_2' =>    isset($params->local_time_window_end_2) ? $params->local_time_window_end_2: null,
	                'address_email' =>    isset($params->address_email) ? $params->address_email: null,
	                'address_city' =>    isset($params->address_city) ? $params->address_city: null,
	                'address_state_id' =>    isset($params->address_state_id) ? $params->address_state_id: null,
	                'address_country_id' =>    isset($params->address_country_id) ? $params->address_country_id: null,
	                'address_zip' =>    isset($params->address_zip) ? $params->address_zip: null,
	                'address_custom_data' =>    isset($params->address_custom_data) ? $params->address_custom_data: null,
	                'schedule' =>    isset($params->schedule) ? $params->schedule: null,
	                'schedule_blacklist' =>    isset($params->schedule_blacklist) ? $params->schedule_blacklist: null,
	                'service_time' =>    isset($params->service_time) ? $params->service_time: null,
	                'local_timezone_string' =>    isset($params->local_timezone_string) ? $params->local_timezone_string: null,
	                'color' =>    isset($params->color) ? $params->color: null,
	                'address_icon' =>    isset($params->address_icon) ? $params->address_icon: null,
	                'address_stop_type' =>    isset($params->address_stop_type) ? $params->address_stop_type: null,
	                'address_cube' =>    isset($params->address_cube) ? $params->address_cube: null,
	                'address_pieces' =>    isset($params->address_pieces) ? $params->address_pieces: null,
	                'address_reference_no' =>    isset($params->address_reference_no) ? $params->address_reference_no: null,
	                'address_revenue' =>    isset($params->address_revenue) ? $params->address_revenue: null,
	                'address_weight' =>    isset($params->address_weight) ? $params->address_weight: null,
	                'address_priority' =>    isset($params->address_priority) ? $params->address_priority: null,
	                'address_customer_po' =>    isset($params->address_customer_po) ? $params->address_customer_po: null,
	            )
	        ));

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

This method seems to be duplicated in your project.

	    {
	        $address = Route4Me::makeRequst(array(
	            'url'    => self::$apiUrl,
	            'method' => 'DELETEARRAY',
	            'query'  => array(
	                'address_ids'     => $address_ids
	            )
	        ));
	
	        return $address;
	    }
		
		public function updateAdressBookLocation($params)
	    {
	    	//echo "address_id --> ".$params["address_id"]."<br";

73% of this comment could be valid code. Did you maybe forget this after debugging?

	        $address = Route4Me::makeRequst(array(
	            'url'    => self::$apiUrl,
	            'method' => 'PUT',
	            'query'   => $params,

	        ));
	
	        return $address;
	    }
			
		public static function get($params)

This method seems to be duplicated in your project.

	    {
	    	$ablocations = Route4Me::makeRequst(array(
	            'url'    => self::$apiUrl,
	            'method' => 'ADD',
	            'query'  => array(
	                'first_name' => isset($params->first_name) ? $params->first_name : null,
	                'address_1' => isset($params->address_1) ? $params->address_1: null,
	                'cached_lat' => isset($params->cached_lat) ? $params->cached_lat : null,
	                'cached_lng' => isset($params->cached_lng) ? $params->cached_lng : null,
	            )
	        ));

			return $ablocations;
		}
        
        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)
        {
            $schedEnambles=array(TRUE,FALSE);
            
            if (in_array($scheduleEnabled, $schedEnambles)) 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;
            }
            //echo $scheduleWeekDays.' --- '. $isValid."<br>";

55% of this comment could be valid code. Did you maybe forget this after debugging?

            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['fail']=array();

$results was never initialized. Although not strictly required by PHP, it is generally a good practice to add $results = array(); before regardless.

            $results['success']=array();
            
            $columns = fgetcsv($csvFileHandle, $max_line_length, $delemietr);
            if (!$columns) {

The expression $columns of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

                array_push($results['fail'],'Empty CSV table');
                return ($results);
            }
                     
            $iRow=1;
            
            while (($rows = fgetcsv($csvFileHandle, $max_line_length, $delemietr)) !== false) {
                if ($rows[$locationsFieldsMapping['cached_lat']] && $rows[$locationsFieldsMapping['cached_lng']] && $rows[$locationsFieldsMapping['address_1']] && array(null) !== $rows) {
                    $schedule="";

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

                    $mode="";
                    
                    if (isset($rows[$locationsFieldsMapping['schedule_mode']])) {

This code seems to be duplicated across your project.

                        if ($this->validateScheduleMode($rows[$locationsFieldsMapping['schedule_mode']])) {
                            $schedule='"mode":"'.$rows[$locationsFieldsMapping['schedule_mode']].'",'; 
                            $mode=$rows[$locationsFieldsMapping['schedule_mode']];
                        }
                        else {array_push($results['fail'],"$iRow --> Wrong schedule mode parameter"); $schedule="";}
                    }
                    else {array_push($results['fail'],"$iRow --> The schedule mode parameter is not set"); $schedule="";}
                    
                    if (isset($rows[$locationsFieldsMapping['schedule_enabled']])) {
                        if ($this->validateScheduleEnable($rows[$locationsFieldsMapping['schedule_enabled']])) { 
                            $schedule.='"enabled":'.$rows[$locationsFieldsMapping['schedule_enabled']].',';
                        }
                        else {array_push($results['fail'],"$iRow --> The schedule enabled parameter is not set ");  $schedule="";}
                    }
                    
                    if (isset($rows[$locationsFieldsMapping['schedule_every']])) {
                        if ($this->validateScheduleEvery($rows[$locationsFieldsMapping['schedule_every']])) {
                            $schedule.='"'.$mode.'":{'.'"every":'.$rows[$locationsFieldsMapping['schedule_every']].','; 
                            if ($mode=='daily') {
                                $schedule=trim($schedule,',');
                                $schedule.='}';
                            }
                        }
                        else {array_push($results['fail'],"$iRow --> The parameter sched_every is not set"); $schedule=""; }
                    }
                    
                    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']])) {
                                         $schedule.='"weekdays":['.$rows[$locationsFieldsMapping['schedule_weekdays']].']}';
                                    }
                                    else {array_push($results['fail'],"$iRow --> Wrong weekdays"); $schedule="";}
                                }
                                else {array_push($results['fail'],"$iRow --> The parameters sched_weekdays is not set"); $schedule="";}
                                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']];
                                         $schedule.='"mode": "'.$rows[$locationsFieldsMapping['monthly_mode']].'",';
                                    }
                                    else {array_push($results['fail'],"$iRow --> Wrong monthly mode"); $schedule="";}
                                }
                                else {array_push($results['fail'],"$iRow --> The parameter sched_monthly_mode is not set"); $schedule="";}
                                
                                if ($monthlyMode!="") {
                                    switch ($monthlyMode) {
                                        case 'dates':
                                            if (isset($rows[$locationsFieldsMapping['monthly_dates']])) {
                                                if ($this->validateScheduleMonthlyDates($rows[$locationsFieldsMapping['monthly_dates']])) {
                                                     $schedule.='"dates":['.$rows[$locationsFieldsMapping['monthly_dates']].']}';
                                                }
                                                else {array_push($results['fail'],"$iRow --> Wrong monthly dates"); $schedule="";}
                                            }
                                            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']])) {
                                                     $schedule.='"nth":{"n":'.$rows[$locationsFieldsMapping['monthly_nth_n']].',';
                                                }
                                                else {array_push($results['fail'],"$iRow --> Wrong parameter sched_nth_n"); $schedule="";}
                                            }
                                            else {array_push($results['fail'],"$iRow --> The parameter sched_nth_n is not set"); $schedule="";}
                                            
                                            if ($schedule!="") {

This code seems to be duplicated across your project.

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

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

                    $oSchedule= json_decode($schedule,TRUE);
                    
                    $AdressBookLocationParameters=AddressBookLocation::fromArray(array(
                        "cached_lat"    => $rows[$locationsFieldsMapping['cached_lat']],
                        "cached_lng"    => $rows[$locationsFieldsMapping['cached_lng']],
                        "curbside_lat"     => isset($locationsFieldsMapping['curbside_lat']) ? $rows[$locationsFieldsMapping['curbside_lat']] : null,
                        "curbside_lng"     => isset($locationsFieldsMapping['curbside_lng']) ? $rows[$locationsFieldsMapping['curbside_lng']] : null,
                        "address_alias"     => isset($locationsFieldsMapping['address_alias']) ? $rows[$locationsFieldsMapping['address_alias']] : null,
                        "address_1"     => $rows[$locationsFieldsMapping['address_1']],
                        "address_2"     => isset($locationsFieldsMapping['address_2']) ? $rows[$locationsFieldsMapping['address_2']] : null,
                        "address_city"     => isset($locationsFieldsMapping['address_city']) ? $rows[$locationsFieldsMapping['address_city']] : null,
                        "address_state_id"     => isset($locationsFieldsMapping['address_state_id']) ? $rows[$locationsFieldsMapping['address_state_id']] : null,
                        "address_zip"     => isset($locationsFieldsMapping['address_zip']) ? $rows[$locationsFieldsMapping['address_zip']] : null,
                        "address_phone_number"  => isset($locationsFieldsMapping['address_phone_number']) ? $rows[$locationsFieldsMapping['address_phone_number']] : null,
                        "schedule" => isset($oSchedule) ? $oSchedule : null,
                        "address_group"  => isset($locationsFieldsMapping['address_group']) ? $rows[$locationsFieldsMapping['address_group']] : null,
                        "first_name"  => isset($locationsFieldsMapping['first_name']) ? $rows[$locationsFieldsMapping['first_name']] : null,
                        "last_name"  => isset($locationsFieldsMapping['last_name']) ? $rows[$locationsFieldsMapping['last_name']] : null,
                        "local_time_window_start"  => isset($locationsFieldsMapping['local_time_window_start']) ? $rows[$locationsFieldsMapping['local_time_window_start']] : null,
                        "local_time_window_end"  => isset($locationsFieldsMapping['local_time_window_end']) ? $rows[$locationsFieldsMapping['local_time_window_end']] : null,
                        "local_time_window_start_2"  => isset($locationsFieldsMapping['local_time_window_start_2']) ? $rows[$locationsFieldsMapping['local_time_window_start_2']] : null,
                        "local_time_window_end_2"  => isset($locationsFieldsMapping['local_time_window_end_2']) ? $rows[$locationsFieldsMapping['local_time_window_end_2']] : null,
                        "address_email"  => isset($locationsFieldsMapping['address_email']) ? $rows[$locationsFieldsMapping['address_email']] : null,
                        "address_country_id"  => isset($locationsFieldsMapping['address_country_id']) ? $rows[$locationsFieldsMapping['address_country_id']] : null,
                        "address_custom_data"  => isset($locationsFieldsMapping['address_custom_data']) ? $rows[$locationsFieldsMapping['address_custom_data']] : null,
                        "schedule_blacklist"  => isset($locationsFieldsMapping['schedule_blacklist']) ? $rows[$locationsFieldsMapping['schedule_blacklist']] : null,
                        "service_time"  => isset($locationsFieldsMapping['service_time']) ? $rows[$locationsFieldsMapping['service_time']] : null,
                        "local_timezone_string"  => isset($locationsFieldsMapping['local_timezone_string']) ? $rows[$locationsFieldsMapping['local_timezone_string']] : null,
                        "color"  => isset($locationsFieldsMapping['color']) ? $rows[$locationsFieldsMapping['color']] : null,
                        "address_icon"  => isset($locationsFieldsMapping['address_icon']) ? $rows[$locationsFieldsMapping['address_icon']] : null,
                        "address_stop_type"  => isset($locationsFieldsMapping['address_stop_type']) ? $rows[$locationsFieldsMapping['address_stop_type']] : null,
                        "address_cube"  => isset($locationsFieldsMapping['address_cube']) ? $rows[$locationsFieldsMapping['address_cube']] : null,
                        "address_pieces"  => isset($locationsFieldsMapping['address_pieces']) ? $rows[$locationsFieldsMapping['address_pieces']] : null,
                        "address_reference_no"  => isset($locationsFieldsMapping['address_reference_no']) ? $rows[$locationsFieldsMapping['address_reference_no']] : null,
                        "address_revenue"  => isset($locationsFieldsMapping['address_revenue']) ? $rows[$locationsFieldsMapping['address_revenue']] : null,
                        "address_weight"  => isset($locationsFieldsMapping['address_weight']) ? $rows[$locationsFieldsMapping['address_weight']] : null,
                        "address_priority"  => isset($locationsFieldsMapping['address_priority']) ? $rows[$locationsFieldsMapping['address_priority']] : null,
                        "address_customer_po"  => isset($locationsFieldsMapping['address_customer_po']) ? $rows[$locationsFieldsMapping['address_customer_po']] : null,
                    ));
                    
                    $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;
        }
	
	   
	}
	
?>

It is not recommended to use PHP's closing tag ?> in files other than templates.