eventespresso / event-espresso-core

core/domain/entities/GenericAddress.php

Indentation +201 added lines, -201 removed lines

@@ -12,205 +12,205 @@
  */
 class GenericAddress implements \EEI_Address
 {
-    // phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
-    private $_address = '';
-
-    private $_address2 = '';
-
-    private $_city = '';
-
-    private $_state_ID = '';
-
-    private $_state_obj = '';
-
-    private $_zip = '';
-
-    private $_country_ID = '';
-
-    private $_country_obj = '';
-    // phpcs:enable
-
-    // phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
-    /**
-     * @param string               $address
-     * @param string               $address2
-     * @param string               $city
-     * @param \EE_State | string   $state
-     * @param string               $zip
-     * @param \EE_Country | string $country
-     * @return GenericAddress
-     */
-    public function __construct($address, $address2, $city, $state, $zip, $country)
-    {
-        $this->_address = $address;
-        $this->_address2 = $address2;
-        $this->_city = $city;
-        if ($state instanceof \EE_State) {
-            $this->_state_obj = $state;
-        } else {
-            $this->_state_ID = $state;
-            $this->_state_obj = $this->_get_state_obj();
-        }
-        $this->_zip = $zip;
-        if ($country instanceof \EE_Country) {
-            $this->_country_obj = $country;
-        } else {
-            $this->_country_ID = $country;
-            $this->_country_obj = $this->_get_country_obj();
-        }
-    }
-
-
-    /**
-     * @return string
-     */
-    public function address()
-    {
-        return $this->_address;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function address2()
-    {
-        return $this->_address2;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function city()
-    {
-        return $this->_city;
-    }
-
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-
-    /**
-     * @return \EE_State
-     */
-    private function _get_state_obj()
-    {
-        return $this->_state_obj instanceof \EE_State
-            ? $this->_state_obj
-            : \EE_Registry::instance()->load_model('State')->get_one_by_ID($this->_state_ID);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function state_ID()
-    {
-        return $this->_state_ID;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function state_abbrev()
-    {
-        return $this->state_obj() instanceof \EE_State
-            ? $this->state_obj()->abbrev()
-            : '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function state_name()
-    {
-        return $this->state_obj() instanceof \EE_State
-            ? $this->state_obj()->name()
-            : '';
-    }
-
-
-    /**
-     * @return \EE_State
-     */
-    public function state_obj()
-    {
-        return $this->_state_obj;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function state()
-    {
-        if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) {
-            return $this->state_obj()->abbrev();
-        } else {
-            return $this->state_name();
-        }
-    }
-
-
-    /**
-     * @return \EE_Country
-     */
-    private function _get_country_obj()
-    {
-        return $this->_country_obj instanceof \EE_Country
-            ? $this->_country_obj
-            : \EE_Registry::instance()->load_model('Country')->get_one_by_ID($this->_country_ID);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function country_ID()
-    {
-        return $this->_country_ID;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function country_name()
-    {
-        return $this->country_obj() instanceof \EE_Country
-            ? $this->country_obj()->name()
-            : '';
-    }
-
-
-    /**
-     * @return \EE_Country
-     */
-    public function country_obj()
-    {
-        return $this->_country_obj;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function country()
-    {
-        if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) {
-            return $this->country_ID();
-        } else {
-            return $this->country_name();
-        }
-    }
-
-
-    /**
-     * @return string
-     */
-    public function zip()
-    {
-        return $this->_zip;
-    }
+	// phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
+	private $_address = '';
+
+	private $_address2 = '';
+
+	private $_city = '';
+
+	private $_state_ID = '';
+
+	private $_state_obj = '';
+
+	private $_zip = '';
+
+	private $_country_ID = '';
+
+	private $_country_obj = '';
+	// phpcs:enable
+
+	// phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
+	/**
+	 * @param string               $address
+	 * @param string               $address2
+	 * @param string               $city
+	 * @param \EE_State | string   $state
+	 * @param string               $zip
+	 * @param \EE_Country | string $country
+	 * @return GenericAddress
+	 */
+	public function __construct($address, $address2, $city, $state, $zip, $country)
+	{
+		$this->_address = $address;
+		$this->_address2 = $address2;
+		$this->_city = $city;
+		if ($state instanceof \EE_State) {
+			$this->_state_obj = $state;
+		} else {
+			$this->_state_ID = $state;
+			$this->_state_obj = $this->_get_state_obj();
+		}
+		$this->_zip = $zip;
+		if ($country instanceof \EE_Country) {
+			$this->_country_obj = $country;
+		} else {
+			$this->_country_ID = $country;
+			$this->_country_obj = $this->_get_country_obj();
+		}
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function address()
+	{
+		return $this->_address;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function address2()
+	{
+		return $this->_address2;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function city()
+	{
+		return $this->_city;
+	}
+
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+
+	/**
+	 * @return \EE_State
+	 */
+	private function _get_state_obj()
+	{
+		return $this->_state_obj instanceof \EE_State
+			? $this->_state_obj
+			: \EE_Registry::instance()->load_model('State')->get_one_by_ID($this->_state_ID);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function state_ID()
+	{
+		return $this->_state_ID;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function state_abbrev()
+	{
+		return $this->state_obj() instanceof \EE_State
+			? $this->state_obj()->abbrev()
+			: '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function state_name()
+	{
+		return $this->state_obj() instanceof \EE_State
+			? $this->state_obj()->name()
+			: '';
+	}
+
+
+	/**
+	 * @return \EE_State
+	 */
+	public function state_obj()
+	{
+		return $this->_state_obj;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function state()
+	{
+		if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) {
+			return $this->state_obj()->abbrev();
+		} else {
+			return $this->state_name();
+		}
+	}
+
+
+	/**
+	 * @return \EE_Country
+	 */
+	private function _get_country_obj()
+	{
+		return $this->_country_obj instanceof \EE_Country
+			? $this->_country_obj
+			: \EE_Registry::instance()->load_model('Country')->get_one_by_ID($this->_country_ID);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function country_ID()
+	{
+		return $this->_country_ID;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function country_name()
+	{
+		return $this->country_obj() instanceof \EE_Country
+			? $this->country_obj()->name()
+			: '';
+	}
+
+
+	/**
+	 * @return \EE_Country
+	 */
+	public function country_obj()
+	{
+		return $this->_country_obj;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function country()
+	{
+		if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) {
+			return $this->country_ID();
+		} else {
+			return $this->country_name();
+		}
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function zip()
+	{
+		return $this->_zip;
+	}
 }

core/domain/services/wp_queries/EventListQuery.php

Spacing +2 added lines, -2 removed lines

@@ -91,7 +91,7 @@ 
                 // set the property value
                 $this->{$property} = $value;
                 // then remove it from the array of args that will later be passed to WP_Query()
-                unset($args[ $property ]);
+                unset($args[$property]);
             }
         }
         return $args;
@@ -188,7 +188,7 @@ 
      */
     public function event_list_title($event_list_title = '')
     {
-        if (! empty($this->title)) {
+        if ( ! empty($this->title)) {
             return $this->title;
         }
         return $event_list_title;

Indentation +194 added lines, -194 removed lines

@@ -15,198 +15,198 @@
  */
 class EventListQuery extends WP_Query
 {
-    /**
-     * @var string $title
-     */
-    private $title;
-
-    /**
-     * @var integer $limit
-     */
-    private $limit = 10;
-
-    /**
-     * @var string $css_class
-     */
-    private $css_class;
-
-    /**
-     * @var boolean $show_expired
-     */
-    private $show_expired = false;
-
-    /**
-     * @var string $month
-     */
-    private $month;
-
-    /**
-     * @var string $category_slug
-     */
-    private $category_slug;
-
-    /**
-     * @var string $order_by
-     */
-    private $order_by;
-
-    /**
-     * @var string $sort
-     */
-    private $sort;
-
-    /**
-     * @var boolean $show_title
-     */
-    private $show_title = true;
-
-
-    /**
-     * EE_Event_List_Query Constructor     *
-     *
-     * @param array $args
-     */
-    public function __construct($args = array())
-    {
-        $args = $this->parseArgs((array) $args);
-        $this->setupEventQueryHelper();
-        $this->setupFilters();
-        $args = $this->getQueryArgs($args);
-        // run the query
-        parent::__construct($args);
-    }
-
-
-    /**
-     * @param array $args
-     * @return array
-     */
-    private function parseArgs(array $args)
-    {
-        // incoming args could be a mix of WP query args + EE shortcode args
-        foreach ($args as $property => $value) {
-            // if the arg is a property of this class, then it's an EE shortcode arg
-            if (property_exists($this, $property) && ! property_exists('WP_Query', $property)) {
-                // set the property value
-                $this->{$property} = $value;
-                // then remove it from the array of args that will later be passed to WP_Query()
-                unset($args[ $property ]);
-            }
-        }
-        return $args;
-    }
-
-
-    private function setupEventQueryHelper()
-    {
-        // add query filters
-        EEH_Event_Query::add_query_filters();
-        // set params that will get used by the filters
-        EEH_Event_Query::set_query_params(
-            $this->month,
-            $this->category_slug,
-            $this->show_expired,
-            $this->order_by,
-            $this->sort
-        );
-    }
-
-
-    private function setupFilters()
-    {
-        // first off, let's remove any filters from previous queries
-        remove_filter(
-            'FHEE__archive_espresso_events_template__show_header',
-            array($this, 'show_event_list_title')
-        );
-        remove_filter(
-            'FHEE__archive_espresso_events_template__upcoming_events_h1',
-            array($this, 'event_list_title')
-        );
-        remove_all_filters('FHEE__content_espresso_events__event_class');
-        // Event List Title ?
-        add_filter(
-            'FHEE__archive_espresso_events_template__show_header',
-            array($this, 'show_event_list_title')
-        );
-        add_filter(
-            'FHEE__archive_espresso_events_template__upcoming_events_h1',
-            array($this, 'event_list_title'),
-            10,
-            1
-        );
-        // add the css class
-        add_filter(
-            'FHEE__content_espresso_events__event_class',
-            array($this, 'event_list_css'),
-            10,
-            1
-        );
-    }
-
-
-    private function getQueryArgs(array $args)
-    {
-        // the current "page" we are viewing
-        $paged = max(1, get_query_var('paged'));
-        // Force these args
-        return array_merge(
-            $args,
-            array(
-                'post_type'              => 'espresso_events',
-                'posts_per_page'         => $this->limit,
-                'update_post_term_cache' => false,
-                'update_post_meta_cache' => false,
-                'paged'                  => $paged,
-                'offset'                 => ($paged - 1) * $this->limit,
-            )
-        );
-    }
-
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-
-    /**
-     * show_event_list_title
-     *
-     * @return boolean
-     */
-    public function show_event_list_title()
-    {
-        return filter_var(
-            $this->show_title,
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
-
-
-    /**
-     * callback for FHEE__archive_espresso_events_template__upcoming_events_h1 filter
-     *
-     * @param string $event_list_title
-     * @return    string
-     */
-    public function event_list_title($event_list_title = '')
-    {
-        if (! empty($this->title)) {
-            return $this->title;
-        }
-        return $event_list_title;
-    }
-
-
-    /**
-     * callback for FHEE__content_espresso_events__event_class filter
-     *
-     * @param string $event_list_css
-     * @return string
-     */
-    public function event_list_css($event_list_css = '')
-    {
-        $event_list_css .= ! empty($event_list_css) ? ' ' : '';
-        $event_list_css .= ! empty($this->css_class) ? $this->css_class : '';
-        $event_list_css .= ! empty($event_list_css) ? ' ' : '';
-        $event_list_css .= ! empty($this->category_slug) ? $this->category_slug : '';
-        return $event_list_css;
-    }
-    // phpcs:enable
+	/**
+	 * @var string $title
+	 */
+	private $title;
+
+	/**
+	 * @var integer $limit
+	 */
+	private $limit = 10;
+
+	/**
+	 * @var string $css_class
+	 */
+	private $css_class;
+
+	/**
+	 * @var boolean $show_expired
+	 */
+	private $show_expired = false;
+
+	/**
+	 * @var string $month
+	 */
+	private $month;
+
+	/**
+	 * @var string $category_slug
+	 */
+	private $category_slug;
+
+	/**
+	 * @var string $order_by
+	 */
+	private $order_by;
+
+	/**
+	 * @var string $sort
+	 */
+	private $sort;
+
+	/**
+	 * @var boolean $show_title
+	 */
+	private $show_title = true;
+
+
+	/**
+	 * EE_Event_List_Query Constructor     *
+	 *
+	 * @param array $args
+	 */
+	public function __construct($args = array())
+	{
+		$args = $this->parseArgs((array) $args);
+		$this->setupEventQueryHelper();
+		$this->setupFilters();
+		$args = $this->getQueryArgs($args);
+		// run the query
+		parent::__construct($args);
+	}
+
+
+	/**
+	 * @param array $args
+	 * @return array
+	 */
+	private function parseArgs(array $args)
+	{
+		// incoming args could be a mix of WP query args + EE shortcode args
+		foreach ($args as $property => $value) {
+			// if the arg is a property of this class, then it's an EE shortcode arg
+			if (property_exists($this, $property) && ! property_exists('WP_Query', $property)) {
+				// set the property value
+				$this->{$property} = $value;
+				// then remove it from the array of args that will later be passed to WP_Query()
+				unset($args[ $property ]);
+			}
+		}
+		return $args;
+	}
+
+
+	private function setupEventQueryHelper()
+	{
+		// add query filters
+		EEH_Event_Query::add_query_filters();
+		// set params that will get used by the filters
+		EEH_Event_Query::set_query_params(
+			$this->month,
+			$this->category_slug,
+			$this->show_expired,
+			$this->order_by,
+			$this->sort
+		);
+	}
+
+
+	private function setupFilters()
+	{
+		// first off, let's remove any filters from previous queries
+		remove_filter(
+			'FHEE__archive_espresso_events_template__show_header',
+			array($this, 'show_event_list_title')
+		);
+		remove_filter(
+			'FHEE__archive_espresso_events_template__upcoming_events_h1',
+			array($this, 'event_list_title')
+		);
+		remove_all_filters('FHEE__content_espresso_events__event_class');
+		// Event List Title ?
+		add_filter(
+			'FHEE__archive_espresso_events_template__show_header',
+			array($this, 'show_event_list_title')
+		);
+		add_filter(
+			'FHEE__archive_espresso_events_template__upcoming_events_h1',
+			array($this, 'event_list_title'),
+			10,
+			1
+		);
+		// add the css class
+		add_filter(
+			'FHEE__content_espresso_events__event_class',
+			array($this, 'event_list_css'),
+			10,
+			1
+		);
+	}
+
+
+	private function getQueryArgs(array $args)
+	{
+		// the current "page" we are viewing
+		$paged = max(1, get_query_var('paged'));
+		// Force these args
+		return array_merge(
+			$args,
+			array(
+				'post_type'              => 'espresso_events',
+				'posts_per_page'         => $this->limit,
+				'update_post_term_cache' => false,
+				'update_post_meta_cache' => false,
+				'paged'                  => $paged,
+				'offset'                 => ($paged - 1) * $this->limit,
+			)
+		);
+	}
+
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+
+	/**
+	 * show_event_list_title
+	 *
+	 * @return boolean
+	 */
+	public function show_event_list_title()
+	{
+		return filter_var(
+			$this->show_title,
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
+
+
+	/**
+	 * callback for FHEE__archive_espresso_events_template__upcoming_events_h1 filter
+	 *
+	 * @param string $event_list_title
+	 * @return    string
+	 */
+	public function event_list_title($event_list_title = '')
+	{
+		if (! empty($this->title)) {
+			return $this->title;
+		}
+		return $event_list_title;
+	}
+
+
+	/**
+	 * callback for FHEE__content_espresso_events__event_class filter
+	 *
+	 * @param string $event_list_css
+	 * @return string
+	 */
+	public function event_list_css($event_list_css = '')
+	{
+		$event_list_css .= ! empty($event_list_css) ? ' ' : '';
+		$event_list_css .= ! empty($this->css_class) ? $this->css_class : '';
+		$event_list_css .= ! empty($event_list_css) ? ' ' : '';
+		$event_list_css .= ! empty($this->category_slug) ? $this->category_slug : '';
+		return $event_list_css;
+	}
+	// phpcs:enable
 }

core/domain/services/registration/CreateRegistrationService.php

Spacing +2 added lines, -2 removed lines

@@ -70,14 +70,14 @@
                 'REG_code'        => $reg_code,
             )
         );
-        if (! $registration instanceof EE_Registration) {
+        if ( ! $registration instanceof EE_Registration) {
             throw new UnexpectedEntityException($registration, 'EE_Registration');
         }
         // save registration so that we have an ID
         $registration->save();
         // track reservation on reg but don't adjust ticket and datetime reserved counts
         // because that is done as soon as the tickets are added/removed from the cart
-        $registration->reserve_ticket(false, 'CreateRegistrationService:' . __LINE__);
+        $registration->reserve_ticket(false, 'CreateRegistrationService:'.__LINE__);
         $registration->_add_relation_to($event, 'Event', array(), $event->ID());
         $registration->_add_relation_to($ticket, 'Ticket', array(), $ticket->ID());
         $transaction->_add_relation_to($registration, 'Registration', array(), $registration->ID());

Indentation +94 added lines, -94 removed lines

@@ -27,102 +27,102 @@
  */
 class CreateRegistrationService extends DomainService
 {
-    /**
-     * @param EE_Event        $event
-     * @param EE_Transaction  $transaction
-     * @param EE_Ticket       $ticket
-     * @param EE_Line_Item    $ticket_line_item
-     * @param                 $reg_count
-     * @param                 $reg_group_size
-     * @param string          $reg_status
-     * @return EE_Registration
-     * @throws OutOfRangeException
-     * @throws EE_Error
-     * @throws UnexpectedEntityException
-     */
-    public function create(
-        EE_Event $event,
-        EE_Transaction $transaction,
-        EE_Ticket $ticket,
-        EE_Line_Item $ticket_line_item,
-        $reg_count,
-        $reg_group_size,
-        $reg_status = EEM_Registration::status_id_incomplete
-    ) {
-        $registrations = $transaction->registrations();
-        $reg_count = $reg_count ? $reg_count : count($registrations) + 1;
-        $reg_url_link = new RegUrlLink($reg_count, $ticket_line_item);
-        $reg_code = new RegCode($reg_url_link, $transaction, $ticket);
-        // generate new EE_Registration
-        $registration = EE_Registration::new_instance(
-            array(
-                'EVT_ID'          => $event->ID(),
-                'TXN_ID'          => $transaction->ID(),
-                'TKT_ID'          => $ticket->ID(),
-                'STS_ID'          => $reg_status,
-                'REG_final_price' => $this->resolveFinalPrice($transaction, $ticket, $ticket_line_item),
-                'REG_session'     => EE_Registry::instance()->SSN->id(),
-                'REG_count'       => $reg_count,
-                'REG_group_size'  => $reg_group_size ? $reg_group_size : $this->incrementRegGroupSize($registrations),
-                'REG_url_link'    => $reg_url_link,
-                'REG_code'        => $reg_code,
-            )
-        );
-        if (! $registration instanceof EE_Registration) {
-            throw new UnexpectedEntityException($registration, 'EE_Registration');
-        }
-        // save registration so that we have an ID
-        $registration->save();
-        // track reservation on reg but don't adjust ticket and datetime reserved counts
-        // because that is done as soon as the tickets are added/removed from the cart
-        $registration->reserve_ticket(false, 'CreateRegistrationService:' . __LINE__);
-        $registration->_add_relation_to($event, 'Event', array(), $event->ID());
-        $registration->_add_relation_to($ticket, 'Ticket', array(), $ticket->ID());
-        $transaction->_add_relation_to($registration, 'Registration', array(), $registration->ID());
-        $registration->save();
-        return $registration;
-    }
+	/**
+	 * @param EE_Event        $event
+	 * @param EE_Transaction  $transaction
+	 * @param EE_Ticket       $ticket
+	 * @param EE_Line_Item    $ticket_line_item
+	 * @param                 $reg_count
+	 * @param                 $reg_group_size
+	 * @param string          $reg_status
+	 * @return EE_Registration
+	 * @throws OutOfRangeException
+	 * @throws EE_Error
+	 * @throws UnexpectedEntityException
+	 */
+	public function create(
+		EE_Event $event,
+		EE_Transaction $transaction,
+		EE_Ticket $ticket,
+		EE_Line_Item $ticket_line_item,
+		$reg_count,
+		$reg_group_size,
+		$reg_status = EEM_Registration::status_id_incomplete
+	) {
+		$registrations = $transaction->registrations();
+		$reg_count = $reg_count ? $reg_count : count($registrations) + 1;
+		$reg_url_link = new RegUrlLink($reg_count, $ticket_line_item);
+		$reg_code = new RegCode($reg_url_link, $transaction, $ticket);
+		// generate new EE_Registration
+		$registration = EE_Registration::new_instance(
+			array(
+				'EVT_ID'          => $event->ID(),
+				'TXN_ID'          => $transaction->ID(),
+				'TKT_ID'          => $ticket->ID(),
+				'STS_ID'          => $reg_status,
+				'REG_final_price' => $this->resolveFinalPrice($transaction, $ticket, $ticket_line_item),
+				'REG_session'     => EE_Registry::instance()->SSN->id(),
+				'REG_count'       => $reg_count,
+				'REG_group_size'  => $reg_group_size ? $reg_group_size : $this->incrementRegGroupSize($registrations),
+				'REG_url_link'    => $reg_url_link,
+				'REG_code'        => $reg_code,
+			)
+		);
+		if (! $registration instanceof EE_Registration) {
+			throw new UnexpectedEntityException($registration, 'EE_Registration');
+		}
+		// save registration so that we have an ID
+		$registration->save();
+		// track reservation on reg but don't adjust ticket and datetime reserved counts
+		// because that is done as soon as the tickets are added/removed from the cart
+		$registration->reserve_ticket(false, 'CreateRegistrationService:' . __LINE__);
+		$registration->_add_relation_to($event, 'Event', array(), $event->ID());
+		$registration->_add_relation_to($ticket, 'Ticket', array(), $ticket->ID());
+		$transaction->_add_relation_to($registration, 'Registration', array(), $registration->ID());
+		$registration->save();
+		return $registration;
+	}
 
 
-    /**
-     * @param EE_Transaction $transaction
-     * @param EE_Ticket      $ticket
-     * @param EE_Line_Item   $ticket_line_item
-     * @return float
-     * @throws EE_Error
-     * @throws OutOfRangeException
-     */
-    protected function resolveFinalPrice(
-        EE_Transaction $transaction,
-        EE_Ticket $ticket,
-        EE_Line_Item $ticket_line_item
-    ) {
-        $final_price = EEH_Line_Item::calculate_final_price_for_ticket_line_item(
-            $transaction->total_line_item(),
-            $ticket_line_item
-        );
-        $final_price = $final_price !== null ? $final_price : $ticket->get_ticket_total_with_taxes();
-        return (float) $final_price;
-    }
+	/**
+	 * @param EE_Transaction $transaction
+	 * @param EE_Ticket      $ticket
+	 * @param EE_Line_Item   $ticket_line_item
+	 * @return float
+	 * @throws EE_Error
+	 * @throws OutOfRangeException
+	 */
+	protected function resolveFinalPrice(
+		EE_Transaction $transaction,
+		EE_Ticket $ticket,
+		EE_Line_Item $ticket_line_item
+	) {
+		$final_price = EEH_Line_Item::calculate_final_price_for_ticket_line_item(
+			$transaction->total_line_item(),
+			$ticket_line_item
+		);
+		$final_price = $final_price !== null ? $final_price : $ticket->get_ticket_total_with_taxes();
+		return (float) $final_price;
+	}
 
 
-    /**
-     * @param  EE_Registration[] $registrations
-     * @param  boolean           $update_existing_registrations
-     * @return int
-     * @throws EE_Error
-     */
-    protected function incrementRegGroupSize(array $registrations, $update_existing_registrations = true)
-    {
-        $new_reg_group_size = count($registrations) + 1;
-        if ($update_existing_registrations) {
-            foreach ($registrations as $registration) {
-                if ($registration instanceof EE_Registration) {
-                    $registration->set_group_size($new_reg_group_size);
-                    $registration->save();
-                }
-            }
-        }
-        return $new_reg_group_size;
-    }
+	/**
+	 * @param  EE_Registration[] $registrations
+	 * @param  boolean           $update_existing_registrations
+	 * @return int
+	 * @throws EE_Error
+	 */
+	protected function incrementRegGroupSize(array $registrations, $update_existing_registrations = true)
+	{
+		$new_reg_group_size = count($registrations) + 1;
+		if ($update_existing_registrations) {
+			foreach ($registrations as $registration) {
+				if ($registration instanceof EE_Registration) {
+					$registration->set_group_size($new_reg_group_size);
+					$registration->save();
+				}
+			}
+		}
+		return $new_reg_group_size;
+	}
 }

core/domain/services/registration/CopyRegistrationService.php

Spacing +5 added lines, -5 removed lines

@@ -83,7 +83,7 @@ 
         $reindexed_answers = array();
         foreach ($answers as $answer) {
             if ($answer instanceof EE_Answer) {
-                $reindexed_answers[ $answer->question_ID() ] = $answer->value();
+                $reindexed_answers[$answer->question_ID()] = $answer->value();
             }
         }
         return $reindexed_answers;
@@ -103,8 +103,8 @@ 
         EE_Registration $registration,
         $previous_answers
     ) {
-        $old_answer_value = isset($previous_answers[ $question->ID() ])
-            ? $previous_answers[ $question->ID() ]
+        $old_answer_value = isset($previous_answers[$question->ID()])
+            ? $previous_answers[$question->ID()]
             : '';
         $new_answer = EE_Answer::new_instance(
             array(
@@ -113,7 +113,7 @@ 
                 'ANS_value' => $old_answer_value,
             )
         );
-        if (! $new_answer instanceof EE_Answer) {
+        if ( ! $new_answer instanceof EE_Answer) {
             throw new UnexpectedEntityException($new_answer, 'EE_Answer');
         }
         $new_answer->save();
@@ -150,7 +150,7 @@ 
                         'RPY_amount' => $payment_amount,
                     )
                 );
-                if (! $new_registration_payment instanceof EE_Registration_Payment) {
+                if ( ! $new_registration_payment instanceof EE_Registration_Payment) {
                     throw new UnexpectedEntityException($new_registration_payment, 'EE_Registration_Payment');
                 }
                 $new_registration_payment->save();

Indentation +142 added lines, -142 removed lines

@@ -25,152 +25,152 @@
  */
 class CopyRegistrationService extends DomainService
 {
-    /**
-     * @param EE_Registration $target_registration
-     * @param EE_Registration $registration_to_copy
-     * @return bool
-     * @throws UnexpectedEntityException
-     * @throws EntityNotFoundException
-     * @throws RuntimeException
-     * @throws EE_Error
-     */
-    public function copyRegistrationDetails(
-        EE_Registration $target_registration,
-        EE_Registration $registration_to_copy
-    ) {
-        // copy attendee
-        $target_registration->set_attendee_id($registration_to_copy->attendee_ID());
-        $target_registration->updateStatusBasedOnTotalPaid(false);
-        $target_registration->save();
-        // get answers to previous reg questions
-        $answers = $this->reindexAnswersByQuestionId($registration_to_copy->answers());
-        // get questions to new event reg form
-        $new_event = $target_registration->event();
-        $field_name = 'Event_Question_Group.'
-            . EEM_Event_Question_Group::instance()->fieldNameForContext(
-                $registration_to_copy->is_primary_registrant()
-            );
-        $question_groups = $new_event->question_groups([
-                [
-                    'Event.EVT_ID' => $new_event->ID(),
-                    $field_name => true,
-                ],
-                'order_by' => ['QSG_order' => 'ASC'],
-            ]);
-        foreach ($question_groups as $question_group) {
-            if ($question_group instanceof \EE_Question_Group) {
-                foreach ($question_group->questions() as $question) {
-                    if ($question instanceof EE_Question) {
-                        $this->generateNewAnswer(
-                            $question,
-                            $target_registration,
-                            $answers
-                        );
-                    }
-                }
-            }
-        }
-        return true;
-    }
+	/**
+	 * @param EE_Registration $target_registration
+	 * @param EE_Registration $registration_to_copy
+	 * @return bool
+	 * @throws UnexpectedEntityException
+	 * @throws EntityNotFoundException
+	 * @throws RuntimeException
+	 * @throws EE_Error
+	 */
+	public function copyRegistrationDetails(
+		EE_Registration $target_registration,
+		EE_Registration $registration_to_copy
+	) {
+		// copy attendee
+		$target_registration->set_attendee_id($registration_to_copy->attendee_ID());
+		$target_registration->updateStatusBasedOnTotalPaid(false);
+		$target_registration->save();
+		// get answers to previous reg questions
+		$answers = $this->reindexAnswersByQuestionId($registration_to_copy->answers());
+		// get questions to new event reg form
+		$new_event = $target_registration->event();
+		$field_name = 'Event_Question_Group.'
+			. EEM_Event_Question_Group::instance()->fieldNameForContext(
+				$registration_to_copy->is_primary_registrant()
+			);
+		$question_groups = $new_event->question_groups([
+				[
+					'Event.EVT_ID' => $new_event->ID(),
+					$field_name => true,
+				],
+				'order_by' => ['QSG_order' => 'ASC'],
+			]);
+		foreach ($question_groups as $question_group) {
+			if ($question_group instanceof \EE_Question_Group) {
+				foreach ($question_group->questions() as $question) {
+					if ($question instanceof EE_Question) {
+						$this->generateNewAnswer(
+							$question,
+							$target_registration,
+							$answers
+						);
+					}
+				}
+			}
+		}
+		return true;
+	}
 
 
-    /**
-     * @param EE_Answer[] $answers
-     * @return array
-     * @throws EE_Error
-     */
-    protected function reindexAnswersByQuestionId(array $answers)
-    {
-        $reindexed_answers = array();
-        foreach ($answers as $answer) {
-            if ($answer instanceof EE_Answer) {
-                $reindexed_answers[ $answer->question_ID() ] = $answer->value();
-            }
-        }
-        return $reindexed_answers;
-    }
+	/**
+	 * @param EE_Answer[] $answers
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function reindexAnswersByQuestionId(array $answers)
+	{
+		$reindexed_answers = array();
+		foreach ($answers as $answer) {
+			if ($answer instanceof EE_Answer) {
+				$reindexed_answers[ $answer->question_ID() ] = $answer->value();
+			}
+		}
+		return $reindexed_answers;
+	}
 
 
-    /**
-     * @param EE_Question      $question
-     * @param EE_Registration  $registration
-     * @param                  $previous_answers
-     * @return EE_Answer
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function generateNewAnswer(
-        EE_Question $question,
-        EE_Registration $registration,
-        $previous_answers
-    ) {
-        $old_answer_value = isset($previous_answers[ $question->ID() ])
-            ? $previous_answers[ $question->ID() ]
-            : '';
-        $new_answer = EE_Answer::new_instance(
-            array(
-                'QST_ID'    => $question->ID(),
-                'REG_ID'    => $registration->ID(),
-                'ANS_value' => $old_answer_value,
-            )
-        );
-        if (! $new_answer instanceof EE_Answer) {
-            throw new UnexpectedEntityException($new_answer, 'EE_Answer');
-        }
-        $new_answer->save();
-        return $new_answer;
-    }
+	/**
+	 * @param EE_Question      $question
+	 * @param EE_Registration  $registration
+	 * @param                  $previous_answers
+	 * @return EE_Answer
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function generateNewAnswer(
+		EE_Question $question,
+		EE_Registration $registration,
+		$previous_answers
+	) {
+		$old_answer_value = isset($previous_answers[ $question->ID() ])
+			? $previous_answers[ $question->ID() ]
+			: '';
+		$new_answer = EE_Answer::new_instance(
+			array(
+				'QST_ID'    => $question->ID(),
+				'REG_ID'    => $registration->ID(),
+				'ANS_value' => $old_answer_value,
+			)
+		);
+		if (! $new_answer instanceof EE_Answer) {
+			throw new UnexpectedEntityException($new_answer, 'EE_Answer');
+		}
+		$new_answer->save();
+		return $new_answer;
+	}
 
 
-    /**
-     * @param EE_Registration $target_registration
-     * @param EE_Registration $registration_to_copy
-     * @return bool
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    public function copyPaymentDetails(
-        EE_Registration $target_registration,
-        EE_Registration $registration_to_copy
-    ) {
-        $save = false;
-        $previous_registration_payments = $registration_to_copy->registration_payments();
-        $new_registration_payment_total = 0;
-        $registration_to_copy_total = $registration_to_copy->paid();
-        foreach ($previous_registration_payments as $previous_registration_payment) {
-            if (
-                $previous_registration_payment instanceof EE_Registration_Payment
-                && $previous_registration_payment->payment() instanceof EE_Payment
-                && $previous_registration_payment->payment()->is_approved()
-            ) {
-                $payment_amount = $previous_registration_payment->amount();
-                $new_registration_payment = EE_Registration_Payment::new_instance(
-                    array(
-                        'REG_ID'     => $target_registration->ID(),
-                        'PAY_ID'     => $previous_registration_payment->payment()->ID(),
-                        'RPY_amount' => $payment_amount,
-                    )
-                );
-                if (! $new_registration_payment instanceof EE_Registration_Payment) {
-                    throw new UnexpectedEntityException($new_registration_payment, 'EE_Registration_Payment');
-                }
-                $new_registration_payment->save();
-                // if new reg payment is good, then set old reg payment amount to zero
-                $previous_registration_payment->set_amount(0);
-                $previous_registration_payment->save();
-                // now  increment/decrement payment amounts
-                $new_registration_payment_total += $payment_amount;
-                $registration_to_copy_total -= $payment_amount;
-                $save = true;
-            }
-        }
-        if ($save) {
-            $target_registration->set_paid($new_registration_payment_total);
-            $target_registration->save();
-            $registration_to_copy->set_paid($registration_to_copy_total);
-            $registration_to_copy->save();
-        }
-        return true;
-    }
+	/**
+	 * @param EE_Registration $target_registration
+	 * @param EE_Registration $registration_to_copy
+	 * @return bool
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	public function copyPaymentDetails(
+		EE_Registration $target_registration,
+		EE_Registration $registration_to_copy
+	) {
+		$save = false;
+		$previous_registration_payments = $registration_to_copy->registration_payments();
+		$new_registration_payment_total = 0;
+		$registration_to_copy_total = $registration_to_copy->paid();
+		foreach ($previous_registration_payments as $previous_registration_payment) {
+			if (
+				$previous_registration_payment instanceof EE_Registration_Payment
+				&& $previous_registration_payment->payment() instanceof EE_Payment
+				&& $previous_registration_payment->payment()->is_approved()
+			) {
+				$payment_amount = $previous_registration_payment->amount();
+				$new_registration_payment = EE_Registration_Payment::new_instance(
+					array(
+						'REG_ID'     => $target_registration->ID(),
+						'PAY_ID'     => $previous_registration_payment->payment()->ID(),
+						'RPY_amount' => $payment_amount,
+					)
+				);
+				if (! $new_registration_payment instanceof EE_Registration_Payment) {
+					throw new UnexpectedEntityException($new_registration_payment, 'EE_Registration_Payment');
+				}
+				$new_registration_payment->save();
+				// if new reg payment is good, then set old reg payment amount to zero
+				$previous_registration_payment->set_amount(0);
+				$previous_registration_payment->save();
+				// now  increment/decrement payment amounts
+				$new_registration_payment_total += $payment_amount;
+				$registration_to_copy_total -= $payment_amount;
+				$save = true;
+			}
+		}
+		if ($save) {
+			$target_registration->set_paid($new_registration_payment_total);
+			$target_registration->save();
+			$registration_to_copy->set_paid($registration_to_copy_total);
+			$registration_to_copy->save();
+		}
+		return true;
+	}
 }

vendor/squizlabs/php_codesniffer/src/Util/Standards.php

Spacing +4 added lines, -4 removed lines

@@ -71,8 +71,8 @@ 
      * @see    getInstalledStandardPaths()
      */
     public static function getInstalledStandardDetails(
-        $includeGeneric=false,
-        $standardsDir=''
+        $includeGeneric = false,
+        $standardsDir = ''
     ) {
         $rulesets = [];
 
@@ -156,8 +156,8 @@ 
      * @see    isInstalledStandard()
      */
     public static function getInstalledStandards(
-        $includeGeneric=false,
-        $standardsDir=''
+        $includeGeneric = false,
+        $standardsDir = ''
     ) {
         $installedStandards = [];
 

Indentation +319 added lines, -319 removed lines

@@ -15,325 +15,325 @@
 {
 
 
-    /**
-     * Get a list of paths where standards are installed.
-     *
-     * Unresolvable relative paths will be excluded from the results.
-     *
-     * @return array
-     */
-    public static function getInstalledStandardPaths()
-    {
-        $ds = DIRECTORY_SEPARATOR;
-
-        $installedPaths = [dirname(dirname(__DIR__)).$ds.'src'.$ds.'Standards'];
-        $configPaths    = Config::getConfigData('installed_paths');
-        if ($configPaths !== null) {
-            $installedPaths = array_merge($installedPaths, explode(',', $configPaths));
-        }
-
-        $resolvedInstalledPaths = [];
-        foreach ($installedPaths as $installedPath) {
-            if (substr($installedPath, 0, 1) === '.') {
-                $installedPath = Common::realPath(__DIR__.$ds.'..'.$ds.'..'.$ds.$installedPath);
-                if ($installedPath === false) {
-                    continue;
-                }
-            }
-
-            $resolvedInstalledPaths[] = $installedPath;
-        }
-
-        return $resolvedInstalledPaths;
-
-    }//end getInstalledStandardPaths()
-
-
-    /**
-     * Get the details of all coding standards installed.
-     *
-     * Coding standards are directories located in the
-     * CodeSniffer/Standards directory. Valid coding standards
-     * include a Sniffs subdirectory.
-     *
-     * The details returned for each standard are:
-     * - path:      the path to the coding standard's main directory
-     * - name:      the name of the coding standard, as sourced from the ruleset.xml file
-     * - namespace: the namespace used by the coding standard, as sourced from the ruleset.xml file
-     *
-     * If you only need the paths to the installed standards,
-     * use getInstalledStandardPaths() instead as it performs less work to
-     * retrieve coding standard names.
-     *
-     * @param boolean $includeGeneric If true, the special "Generic"
-     *                                coding standard will be included
-     *                                if installed.
-     * @param string  $standardsDir   A specific directory to look for standards
-     *                                in. If not specified, PHP_CodeSniffer will
-     *                                look in its default locations.
-     *
-     * @return array
-     * @see    getInstalledStandardPaths()
-     */
-    public static function getInstalledStandardDetails(
-        $includeGeneric=false,
-        $standardsDir=''
-    ) {
-        $rulesets = [];
-
-        if ($standardsDir === '') {
-            $installedPaths = self::getInstalledStandardPaths();
-        } else {
-            $installedPaths = [$standardsDir];
-        }
-
-        foreach ($installedPaths as $standardsDir) {
-            // Check if the installed dir is actually a standard itself.
-            $csFile = $standardsDir.'/ruleset.xml';
-            if (is_file($csFile) === true) {
-                $rulesets[] = $csFile;
-                continue;
-            }
-
-            if (is_dir($standardsDir) === false) {
-                continue;
-            }
-
-            $di = new \DirectoryIterator($standardsDir);
-            foreach ($di as $file) {
-                if ($file->isDir() === true && $file->isDot() === false) {
-                    $filename = $file->getFilename();
-
-                    // Ignore the special "Generic" standard.
-                    if ($includeGeneric === false && $filename === 'Generic') {
-                        continue;
-                    }
-
-                    // Valid coding standard dirs include a ruleset.
-                    $csFile = $file->getPathname().'/ruleset.xml';
-                    if (is_file($csFile) === true) {
-                        $rulesets[] = $csFile;
-                    }
-                }
-            }
-        }//end foreach
-
-        $installedStandards = [];
-
-        foreach ($rulesets as $rulesetPath) {
-            $ruleset = @simplexml_load_string(file_get_contents($rulesetPath));
-            if ($ruleset === false) {
-                continue;
-            }
-
-            $standardName = (string) $ruleset['name'];
-            $dirname      = basename(dirname($rulesetPath));
-
-            if (isset($ruleset['namespace']) === true) {
-                $namespace = (string) $ruleset['namespace'];
-            } else {
-                $namespace = $dirname;
-            }
-
-            $installedStandards[$dirname] = [
-                'path'      => dirname($rulesetPath),
-                'name'      => $standardName,
-                'namespace' => $namespace,
-            ];
-        }//end foreach
-
-        return $installedStandards;
-
-    }//end getInstalledStandardDetails()
-
-
-    /**
-     * Get a list of all coding standards installed.
-     *
-     * Coding standards are directories located in the
-     * CodeSniffer/Standards directory. Valid coding standards
-     * include a Sniffs subdirectory.
-     *
-     * @param boolean $includeGeneric If true, the special "Generic"
-     *                                coding standard will be included
-     *                                if installed.
-     * @param string  $standardsDir   A specific directory to look for standards
-     *                                in. If not specified, PHP_CodeSniffer will
-     *                                look in its default locations.
-     *
-     * @return array
-     * @see    isInstalledStandard()
-     */
-    public static function getInstalledStandards(
-        $includeGeneric=false,
-        $standardsDir=''
-    ) {
-        $installedStandards = [];
-
-        if ($standardsDir === '') {
-            $installedPaths = self::getInstalledStandardPaths();
-        } else {
-            $installedPaths = [$standardsDir];
-        }
-
-        foreach ($installedPaths as $standardsDir) {
-            // Check if the installed dir is actually a standard itself.
-            $csFile = $standardsDir.'/ruleset.xml';
-            if (is_file($csFile) === true) {
-                $basename = basename($standardsDir);
-                $installedStandards[$basename] = $basename;
-                continue;
-            }
-
-            if (is_dir($standardsDir) === false) {
-                // Doesn't exist.
-                continue;
-            }
-
-            $di = new \DirectoryIterator($standardsDir);
-            $standardsInDir = [];
-            foreach ($di as $file) {
-                if ($file->isDir() === true && $file->isDot() === false) {
-                    $filename = $file->getFilename();
-
-                    // Ignore the special "Generic" standard.
-                    if ($includeGeneric === false && $filename === 'Generic') {
-                        continue;
-                    }
-
-                    // Valid coding standard dirs include a ruleset.
-                    $csFile = $file->getPathname().'/ruleset.xml';
-                    if (is_file($csFile) === true) {
-                        $standardsInDir[$filename] = $filename;
-                    }
-                }
-            }
-
-            natsort($standardsInDir);
-            $installedStandards += $standardsInDir;
-        }//end foreach
-
-        return $installedStandards;
-
-    }//end getInstalledStandards()
-
-
-    /**
-     * Determine if a standard is installed.
-     *
-     * Coding standards are directories located in the
-     * CodeSniffer/Standards directory. Valid coding standards
-     * include a ruleset.xml file.
-     *
-     * @param string $standard The name of the coding standard.
-     *
-     * @return boolean
-     * @see    getInstalledStandards()
-     */
-    public static function isInstalledStandard($standard)
-    {
-        $path = self::getInstalledStandardPath($standard);
-        if ($path !== null && strpos($path, 'ruleset.xml') !== false) {
-            return true;
-        } else {
-            // This could be a custom standard, installed outside our
-            // standards directory.
-            $standard = Common::realPath($standard);
-            if ($standard === false) {
-                return false;
-            }
-
-            // Might be an actual ruleset file itUtil.
-            // If it has an XML extension, let's at least try it.
-            if (is_file($standard) === true
-                && (substr(strtolower($standard), -4) === '.xml'
-                || substr(strtolower($standard), -9) === '.xml.dist')
-            ) {
-                return true;
-            }
-
-            // If it is a directory with a ruleset.xml file in it,
-            // it is a standard.
-            $ruleset = rtrim($standard, ' /\\').DIRECTORY_SEPARATOR.'ruleset.xml';
-            if (is_file($ruleset) === true) {
-                return true;
-            }
-        }//end if
-
-        return false;
-
-    }//end isInstalledStandard()
-
-
-    /**
-     * Return the path of an installed coding standard.
-     *
-     * Coding standards are directories located in the
-     * CodeSniffer/Standards directory. Valid coding standards
-     * include a ruleset.xml file.
-     *
-     * @param string $standard The name of the coding standard.
-     *
-     * @return string|null
-     */
-    public static function getInstalledStandardPath($standard)
-    {
-        if (strpos($standard, '.') !== false) {
-            return null;
-        }
-
-        $installedPaths = self::getInstalledStandardPaths();
-        foreach ($installedPaths as $installedPath) {
-            $standardPath = $installedPath.DIRECTORY_SEPARATOR.$standard;
-            if (file_exists($standardPath) === false) {
-                if (basename($installedPath) !== $standard) {
-                    continue;
-                }
-
-                $standardPath = $installedPath;
-            }
-
-            $path = Common::realpath($standardPath.DIRECTORY_SEPARATOR.'ruleset.xml');
-
-            if ($path !== false && is_file($path) === true) {
-                return $path;
-            } else if (Common::isPharFile($standardPath) === true) {
-                $path = Common::realpath($standardPath);
-                if ($path !== false) {
-                    return $path;
-                }
-            }
-        }//end foreach
-
-        return null;
-
-    }//end getInstalledStandardPath()
-
-
-    /**
-     * Prints out a list of installed coding standards.
-     *
-     * @return void
-     */
-    public static function printInstalledStandards()
-    {
-        $installedStandards = self::getInstalledStandards();
-        $numStandards       = count($installedStandards);
-
-        if ($numStandards === 0) {
-            echo 'No coding standards are installed.'.PHP_EOL;
-        } else {
-            $lastStandard = array_pop($installedStandards);
-            if ($numStandards === 1) {
-                echo "The only coding standard installed is $lastStandard".PHP_EOL;
-            } else {
-                $standardList  = implode(', ', $installedStandards);
-                $standardList .= ' and '.$lastStandard;
-                echo 'The installed coding standards are '.$standardList.PHP_EOL;
-            }
-        }
-
-    }//end printInstalledStandards()
+	/**
+	 * Get a list of paths where standards are installed.
+	 *
+	 * Unresolvable relative paths will be excluded from the results.
+	 *
+	 * @return array
+	 */
+	public static function getInstalledStandardPaths()
+	{
+		$ds = DIRECTORY_SEPARATOR;
+
+		$installedPaths = [dirname(dirname(__DIR__)).$ds.'src'.$ds.'Standards'];
+		$configPaths    = Config::getConfigData('installed_paths');
+		if ($configPaths !== null) {
+			$installedPaths = array_merge($installedPaths, explode(',', $configPaths));
+		}
+
+		$resolvedInstalledPaths = [];
+		foreach ($installedPaths as $installedPath) {
+			if (substr($installedPath, 0, 1) === '.') {
+				$installedPath = Common::realPath(__DIR__.$ds.'..'.$ds.'..'.$ds.$installedPath);
+				if ($installedPath === false) {
+					continue;
+				}
+			}
+
+			$resolvedInstalledPaths[] = $installedPath;
+		}
+
+		return $resolvedInstalledPaths;
+
+	}//end getInstalledStandardPaths()
+
+
+	/**
+	 * Get the details of all coding standards installed.
+	 *
+	 * Coding standards are directories located in the
+	 * CodeSniffer/Standards directory. Valid coding standards
+	 * include a Sniffs subdirectory.
+	 *
+	 * The details returned for each standard are:
+	 * - path:      the path to the coding standard's main directory
+	 * - name:      the name of the coding standard, as sourced from the ruleset.xml file
+	 * - namespace: the namespace used by the coding standard, as sourced from the ruleset.xml file
+	 *
+	 * If you only need the paths to the installed standards,
+	 * use getInstalledStandardPaths() instead as it performs less work to
+	 * retrieve coding standard names.
+	 *
+	 * @param boolean $includeGeneric If true, the special "Generic"
+	 *                                coding standard will be included
+	 *                                if installed.
+	 * @param string  $standardsDir   A specific directory to look for standards
+	 *                                in. If not specified, PHP_CodeSniffer will
+	 *                                look in its default locations.
+	 *
+	 * @return array
+	 * @see    getInstalledStandardPaths()
+	 */
+	public static function getInstalledStandardDetails(
+		$includeGeneric=false,
+		$standardsDir=''
+	) {
+		$rulesets = [];
+
+		if ($standardsDir === '') {
+			$installedPaths = self::getInstalledStandardPaths();
+		} else {
+			$installedPaths = [$standardsDir];
+		}
+
+		foreach ($installedPaths as $standardsDir) {
+			// Check if the installed dir is actually a standard itself.
+			$csFile = $standardsDir.'/ruleset.xml';
+			if (is_file($csFile) === true) {
+				$rulesets[] = $csFile;
+				continue;
+			}
+
+			if (is_dir($standardsDir) === false) {
+				continue;
+			}
+
+			$di = new \DirectoryIterator($standardsDir);
+			foreach ($di as $file) {
+				if ($file->isDir() === true && $file->isDot() === false) {
+					$filename = $file->getFilename();
+
+					// Ignore the special "Generic" standard.
+					if ($includeGeneric === false && $filename === 'Generic') {
+						continue;
+					}
+
+					// Valid coding standard dirs include a ruleset.
+					$csFile = $file->getPathname().'/ruleset.xml';
+					if (is_file($csFile) === true) {
+						$rulesets[] = $csFile;
+					}
+				}
+			}
+		}//end foreach
+
+		$installedStandards = [];
+
+		foreach ($rulesets as $rulesetPath) {
+			$ruleset = @simplexml_load_string(file_get_contents($rulesetPath));
+			if ($ruleset === false) {
+				continue;
+			}
+
+			$standardName = (string) $ruleset['name'];
+			$dirname      = basename(dirname($rulesetPath));
+
+			if (isset($ruleset['namespace']) === true) {
+				$namespace = (string) $ruleset['namespace'];
+			} else {
+				$namespace = $dirname;
+			}
+
+			$installedStandards[$dirname] = [
+				'path'      => dirname($rulesetPath),
+				'name'      => $standardName,
+				'namespace' => $namespace,
+			];
+		}//end foreach
+
+		return $installedStandards;
+
+	}//end getInstalledStandardDetails()
+
+
+	/**
+	 * Get a list of all coding standards installed.
+	 *
+	 * Coding standards are directories located in the
+	 * CodeSniffer/Standards directory. Valid coding standards
+	 * include a Sniffs subdirectory.
+	 *
+	 * @param boolean $includeGeneric If true, the special "Generic"
+	 *                                coding standard will be included
+	 *                                if installed.
+	 * @param string  $standardsDir   A specific directory to look for standards
+	 *                                in. If not specified, PHP_CodeSniffer will
+	 *                                look in its default locations.
+	 *
+	 * @return array
+	 * @see    isInstalledStandard()
+	 */
+	public static function getInstalledStandards(
+		$includeGeneric=false,
+		$standardsDir=''
+	) {
+		$installedStandards = [];
+
+		if ($standardsDir === '') {
+			$installedPaths = self::getInstalledStandardPaths();
+		} else {
+			$installedPaths = [$standardsDir];
+		}
+
+		foreach ($installedPaths as $standardsDir) {
+			// Check if the installed dir is actually a standard itself.
+			$csFile = $standardsDir.'/ruleset.xml';
+			if (is_file($csFile) === true) {
+				$basename = basename($standardsDir);
+				$installedStandards[$basename] = $basename;
+				continue;
+			}
+
+			if (is_dir($standardsDir) === false) {
+				// Doesn't exist.
+				continue;
+			}
+
+			$di = new \DirectoryIterator($standardsDir);
+			$standardsInDir = [];
+			foreach ($di as $file) {
+				if ($file->isDir() === true && $file->isDot() === false) {
+					$filename = $file->getFilename();
+
+					// Ignore the special "Generic" standard.
+					if ($includeGeneric === false && $filename === 'Generic') {
+						continue;
+					}
+
+					// Valid coding standard dirs include a ruleset.
+					$csFile = $file->getPathname().'/ruleset.xml';
+					if (is_file($csFile) === true) {
+						$standardsInDir[$filename] = $filename;
+					}
+				}
+			}
+
+			natsort($standardsInDir);
+			$installedStandards += $standardsInDir;
+		}//end foreach
+
+		return $installedStandards;
+
+	}//end getInstalledStandards()
+
+
+	/**
+	 * Determine if a standard is installed.
+	 *
+	 * Coding standards are directories located in the
+	 * CodeSniffer/Standards directory. Valid coding standards
+	 * include a ruleset.xml file.
+	 *
+	 * @param string $standard The name of the coding standard.
+	 *
+	 * @return boolean
+	 * @see    getInstalledStandards()
+	 */
+	public static function isInstalledStandard($standard)
+	{
+		$path = self::getInstalledStandardPath($standard);
+		if ($path !== null && strpos($path, 'ruleset.xml') !== false) {
+			return true;
+		} else {
+			// This could be a custom standard, installed outside our
+			// standards directory.
+			$standard = Common::realPath($standard);
+			if ($standard === false) {
+				return false;
+			}
+
+			// Might be an actual ruleset file itUtil.
+			// If it has an XML extension, let's at least try it.
+			if (is_file($standard) === true
+				&& (substr(strtolower($standard), -4) === '.xml'
+				|| substr(strtolower($standard), -9) === '.xml.dist')
+			) {
+				return true;
+			}
+
+			// If it is a directory with a ruleset.xml file in it,
+			// it is a standard.
+			$ruleset = rtrim($standard, ' /\\').DIRECTORY_SEPARATOR.'ruleset.xml';
+			if (is_file($ruleset) === true) {
+				return true;
+			}
+		}//end if
+
+		return false;
+
+	}//end isInstalledStandard()
+
+
+	/**
+	 * Return the path of an installed coding standard.
+	 *
+	 * Coding standards are directories located in the
+	 * CodeSniffer/Standards directory. Valid coding standards
+	 * include a ruleset.xml file.
+	 *
+	 * @param string $standard The name of the coding standard.
+	 *
+	 * @return string|null
+	 */
+	public static function getInstalledStandardPath($standard)
+	{
+		if (strpos($standard, '.') !== false) {
+			return null;
+		}
+
+		$installedPaths = self::getInstalledStandardPaths();
+		foreach ($installedPaths as $installedPath) {
+			$standardPath = $installedPath.DIRECTORY_SEPARATOR.$standard;
+			if (file_exists($standardPath) === false) {
+				if (basename($installedPath) !== $standard) {
+					continue;
+				}
+
+				$standardPath = $installedPath;
+			}
+
+			$path = Common::realpath($standardPath.DIRECTORY_SEPARATOR.'ruleset.xml');
+
+			if ($path !== false && is_file($path) === true) {
+				return $path;
+			} else if (Common::isPharFile($standardPath) === true) {
+				$path = Common::realpath($standardPath);
+				if ($path !== false) {
+					return $path;
+				}
+			}
+		}//end foreach
+
+		return null;
+
+	}//end getInstalledStandardPath()
+
+
+	/**
+	 * Prints out a list of installed coding standards.
+	 *
+	 * @return void
+	 */
+	public static function printInstalledStandards()
+	{
+		$installedStandards = self::getInstalledStandards();
+		$numStandards       = count($installedStandards);
+
+		if ($numStandards === 0) {
+			echo 'No coding standards are installed.'.PHP_EOL;
+		} else {
+			$lastStandard = array_pop($installedStandards);
+			if ($numStandards === 1) {
+				echo "The only coding standard installed is $lastStandard".PHP_EOL;
+			} else {
+				$standardList  = implode(', ', $installedStandards);
+				$standardList .= ' and '.$lastStandard;
+				echo 'The installed coding standards are '.$standardList.PHP_EOL;
+			}
+		}
+
+	}//end printInstalledStandards()
 
 
 }//end class

vendor/squizlabs/php_codesniffer/src/Util/Timing.php

Spacing +1 added lines, -1 removed lines

@@ -48,7 +48,7 @@
      *
      * @return void
      */
-    public static function printRunTime($force=false)
+    public static function printRunTime($force = false)
     {
         if ($force === false && self::$printed === true) {
             // A double call.

Indentation +69 added lines, -69 removed lines

@@ -12,75 +12,75 @@
 class Timing
 {
 
-    /**
-     * The start time of the run.
-     *
-     * @var float
-     */
-    private static $startTime;
-
-    /**
-     * Used to make sure we only print the run time once per run.
-     *
-     * @var boolean
-     */
-    private static $printed = false;
-
-
-    /**
-     * Start recording time for the run.
-     *
-     * @return void
-     */
-    public static function startTiming()
-    {
-
-        self::$startTime = microtime(true);
-
-    }//end startTiming()
-
-
-    /**
-     * Print information about the run.
-     *
-     * @param boolean $force If TRUE, prints the output even if it has
-     *                       already been printed during the run.
-     *
-     * @return void
-     */
-    public static function printRunTime($force=false)
-    {
-        if ($force === false && self::$printed === true) {
-            // A double call.
-            return;
-        }
-
-        if (self::$startTime === null) {
-            // Timing was never started.
-            return;
-        }
-
-        $time = ((microtime(true) - self::$startTime) * 1000);
-
-        if ($time > 60000) {
-            $mins = floor($time / 60000);
-            $secs = round((fmod($time, 60000) / 1000), 2);
-            $time = $mins.' mins';
-            if ($secs !== 0) {
-                $time .= ", $secs secs";
-            }
-        } else if ($time > 1000) {
-            $time = round(($time / 1000), 2).' secs';
-        } else {
-            $time = round($time).'ms';
-        }
-
-        $mem = round((memory_get_peak_usage(true) / (1024 * 1024)), 2).'MB';
-        echo "Time: $time; Memory: $mem".PHP_EOL.PHP_EOL;
-
-        self::$printed = true;
-
-    }//end printRunTime()
+	/**
+	 * The start time of the run.
+	 *
+	 * @var float
+	 */
+	private static $startTime;
+
+	/**
+	 * Used to make sure we only print the run time once per run.
+	 *
+	 * @var boolean
+	 */
+	private static $printed = false;
+
+
+	/**
+	 * Start recording time for the run.
+	 *
+	 * @return void
+	 */
+	public static function startTiming()
+	{
+
+		self::$startTime = microtime(true);
+
+	}//end startTiming()
+
+
+	/**
+	 * Print information about the run.
+	 *
+	 * @param boolean $force If TRUE, prints the output even if it has
+	 *                       already been printed during the run.
+	 *
+	 * @return void
+	 */
+	public static function printRunTime($force=false)
+	{
+		if ($force === false && self::$printed === true) {
+			// A double call.
+			return;
+		}
+
+		if (self::$startTime === null) {
+			// Timing was never started.
+			return;
+		}
+
+		$time = ((microtime(true) - self::$startTime) * 1000);
+
+		if ($time > 60000) {
+			$mins = floor($time / 60000);
+			$secs = round((fmod($time, 60000) / 1000), 2);
+			$time = $mins.' mins';
+			if ($secs !== 0) {
+				$time .= ", $secs secs";
+			}
+		} else if ($time > 1000) {
+			$time = round(($time / 1000), 2).' secs';
+		} else {
+			$time = round($time).'ms';
+		}
+
+		$mem = round((memory_get_peak_usage(true) / (1024 * 1024)), 2).'MB';
+		echo "Time: $time; Memory: $mem".PHP_EOL.PHP_EOL;
+
+		self::$printed = true;
+
+	}//end printRunTime()
 
 
 }//end class

vendor/squizlabs/php_codesniffer/src/Util/Common.php

Switch Indentation +13 added lines, -13 removed lines

@@ -407,19 +407,19 @@
         } else {
             $lowerVarType = strtolower($varType);
             switch ($lowerVarType) {
-            case 'bool':
-            case 'boolean':
-                return 'boolean';
-            case 'double':
-            case 'real':
-            case 'float':
-                return 'float';
-            case 'int':
-            case 'integer':
-                return 'integer';
-            case 'array()':
-            case 'array':
-                return 'array';
+            	case 'bool':
+            	case 'boolean':
+                	return 'boolean';
+            	case 'double':
+            	case 'real':
+            	case 'float':
+                	return 'float';
+            	case 'int':
+            	case 'integer':
+                	return 'integer';
+            	case 'array()':
+            	case 'array':
+                	return 'array';
             }//end switch
 
             if (strpos($lowerVarType, 'array(') !== false) {

Indentation +553 added lines, -553 removed lines

@@ -12,559 +12,559 @@
 class Common
 {
 
-    /**
-     * An array of variable types for param/var we will check.
-     *
-     * @var string[]
-     */
-    public static $allowedTypes = [
-        'array',
-        'boolean',
-        'float',
-        'integer',
-        'mixed',
-        'object',
-        'string',
-        'resource',
-        'callable',
-    ];
-
-
-    /**
-     * Return TRUE if the path is a PHAR file.
-     *
-     * @param string $path The path to use.
-     *
-     * @return mixed
-     */
-    public static function isPharFile($path)
-    {
-        if (strpos($path, 'phar://') === 0) {
-            return true;
-        }
-
-        return false;
-
-    }//end isPharFile()
-
-
-    /**
-     * Checks if a file is readable.
-     *
-     * Addresses PHP bug related to reading files from network drives on Windows.
-     * e.g. when using WSL2.
-     *
-     * @param string $path The path to the file.
-     *
-     * @return boolean
-     */
-    public static function isReadable($path)
-    {
-        if (@is_readable($path) === true) {
-            return true;
-        }
-
-        if (@file_exists($path) === true && @is_file($path) === true) {
-            $f = @fopen($path, 'rb');
-            if (fclose($f) === true) {
-                return true;
-            }
-        }
-
-        return false;
-
-    }//end isReadable()
-
-
-    /**
-     * CodeSniffer alternative for realpath.
-     *
-     * Allows for PHAR support.
-     *
-     * @param string $path The path to use.
-     *
-     * @return mixed
-     */
-    public static function realpath($path)
-    {
-        // Support the path replacement of ~ with the user's home directory.
-        if (substr($path, 0, 2) === '~/') {
-            $homeDir = getenv('HOME');
-            if ($homeDir !== false) {
-                $path = $homeDir.substr($path, 1);
-            }
-        }
-
-        // Check for process substitution.
-        if (strpos($path, '/dev/fd') === 0) {
-            return str_replace('/dev/fd', 'php://fd', $path);
-        }
-
-        // No extra work needed if this is not a phar file.
-        if (self::isPharFile($path) === false) {
-            return realpath($path);
-        }
-
-        // Before trying to break down the file path,
-        // check if it exists first because it will mostly not
-        // change after running the below code.
-        if (file_exists($path) === true) {
-            return $path;
-        }
-
-        $phar  = \Phar::running(false);
-        $extra = str_replace('phar://'.$phar, '', $path);
-        $path  = realpath($phar);
-        if ($path === false) {
-            return false;
-        }
-
-        $path = 'phar://'.$path.$extra;
-        if (file_exists($path) === true) {
-            return $path;
-        }
-
-        return false;
-
-    }//end realpath()
-
-
-    /**
-     * Removes a base path from the front of a file path.
-     *
-     * @param string $path     The path of the file.
-     * @param string $basepath The base path to remove. This should not end
-     *                         with a directory separator.
-     *
-     * @return string
-     */
-    public static function stripBasepath($path, $basepath)
-    {
-        if (empty($basepath) === true) {
-            return $path;
-        }
-
-        $basepathLen = strlen($basepath);
-        if (substr($path, 0, $basepathLen) === $basepath) {
-            $path = substr($path, $basepathLen);
-        }
-
-        $path = ltrim($path, DIRECTORY_SEPARATOR);
-        if ($path === '') {
-            $path = '.';
-        }
-
-        return $path;
-
-    }//end stripBasepath()
-
-
-    /**
-     * Detects the EOL character being used in a string.
-     *
-     * @param string $contents The contents to check.
-     *
-     * @return string
-     */
-    public static function detectLineEndings($contents)
-    {
-        if (preg_match("/\r\n?|\n/", $contents, $matches) !== 1) {
-            // Assume there are no newlines.
-            $eolChar = "\n";
-        } else {
-            $eolChar = $matches[0];
-        }
-
-        return $eolChar;
-
-    }//end detectLineEndings()
-
-
-    /**
-     * Check if STDIN is a TTY.
-     *
-     * @return boolean
-     */
-    public static function isStdinATTY()
-    {
-        // The check is slow (especially calling `tty`) so we static
-        // cache the result.
-        static $isTTY = null;
-
-        if ($isTTY !== null) {
-            return $isTTY;
-        }
-
-        if (defined('STDIN') === false) {
-            return false;
-        }
-
-        // If PHP has the POSIX extensions we will use them.
-        if (function_exists('posix_isatty') === true) {
-            $isTTY = (posix_isatty(STDIN) === true);
-            return $isTTY;
-        }
-
-        // Next try is detecting whether we have `tty` installed and use that.
-        if (defined('PHP_WINDOWS_VERSION_PLATFORM') === true) {
-            $devnull = 'NUL';
-            $which   = 'where';
-        } else {
-            $devnull = '/dev/null';
-            $which   = 'which';
-        }
-
-        $tty = trim(shell_exec("$which tty 2> $devnull"));
-        if (empty($tty) === false) {
-            exec("tty -s 2> $devnull", $output, $returnValue);
-            $isTTY = ($returnValue === 0);
-            return $isTTY;
-        }
-
-        // Finally we will use fstat.  The solution borrowed from
-        // https://stackoverflow.com/questions/11327367/detect-if-a-php-script-is-being-run-interactively-or-not
-        // This doesn't work on Mingw/Cygwin/... using Mintty but they
-        // have `tty` installed.
-        $type = [
-            'S_IFMT'  => 0170000,
-            'S_IFIFO' => 0010000,
-        ];
-
-        $stat  = fstat(STDIN);
-        $mode  = ($stat['mode'] & $type['S_IFMT']);
-        $isTTY = ($mode !== $type['S_IFIFO']);
-
-        return $isTTY;
-
-    }//end isStdinATTY()
-
-
-    /**
-     * Escape a path to a system command.
-     *
-     * @param string $cmd The path to the system command.
-     *
-     * @return string
-     */
-    public static function escapeshellcmd($cmd)
-    {
-        $cmd = escapeshellcmd($cmd);
-
-        if (stripos(PHP_OS, 'WIN') === 0) {
-            // Spaces are not escaped by escapeshellcmd on Windows, but need to be
-            // for the command to be able to execute.
-            $cmd = preg_replace('`(?<!^) `', '^ ', $cmd);
-        }
-
-        return $cmd;
-
-    }//end escapeshellcmd()
-
-
-    /**
-     * Prepares token content for output to screen.
-     *
-     * Replaces invisible characters so they are visible. On non-Windows
-     * operating systems it will also colour the invisible characters.
-     *
-     * @param string   $content The content to prepare.
-     * @param string[] $exclude A list of characters to leave invisible.
-     *                          Can contain \r, \n, \t and a space.
-     *
-     * @return string
-     */
-    public static function prepareForOutput($content, $exclude=[])
-    {
-        if (stripos(PHP_OS, 'WIN') === 0) {
-            if (in_array("\r", $exclude, true) === false) {
-                $content = str_replace("\r", '\r', $content);
-            }
-
-            if (in_array("\n", $exclude, true) === false) {
-                $content = str_replace("\n", '\n', $content);
-            }
-
-            if (in_array("\t", $exclude, true) === false) {
-                $content = str_replace("\t", '\t', $content);
-            }
-        } else {
-            if (in_array("\r", $exclude, true) === false) {
-                $content = str_replace("\r", "\033[30;1m\\r\033[0m", $content);
-            }
-
-            if (in_array("\n", $exclude, true) === false) {
-                $content = str_replace("\n", "\033[30;1m\\n\033[0m", $content);
-            }
-
-            if (in_array("\t", $exclude, true) === false) {
-                $content = str_replace("\t", "\033[30;1m\\t\033[0m", $content);
-            }
-
-            if (in_array(' ', $exclude, true) === false) {
-                $content = str_replace(' ', "\033[30;1m·\033[0m", $content);
-            }
-        }//end if
-
-        return $content;
-
-    }//end prepareForOutput()
-
-
-    /**
-     * Returns true if the specified string is in the camel caps format.
-     *
-     * @param string  $string      The string the verify.
-     * @param boolean $classFormat If true, check to see if the string is in the
-     *                             class format. Class format strings must start
-     *                             with a capital letter and contain no
-     *                             underscores.
-     * @param boolean $public      If true, the first character in the string
-     *                             must be an a-z character. If false, the
-     *                             character must be an underscore. This
-     *                             argument is only applicable if $classFormat
-     *                             is false.
-     * @param boolean $strict      If true, the string must not have two capital
-     *                             letters next to each other. If false, a
-     *                             relaxed camel caps policy is used to allow
-     *                             for acronyms.
-     *
-     * @return boolean
-     */
-    public static function isCamelCaps(
-        $string,
-        $classFormat=false,
-        $public=true,
-        $strict=true
-    ) {
-        // Check the first character first.
-        if ($classFormat === false) {
-            $legalFirstChar = '';
-            if ($public === false) {
-                $legalFirstChar = '[_]';
-            }
-
-            if ($strict === false) {
-                // Can either start with a lowercase letter, or multiple uppercase
-                // in a row, representing an acronym.
-                $legalFirstChar .= '([A-Z]{2,}|[a-z])';
-            } else {
-                $legalFirstChar .= '[a-z]';
-            }
-        } else {
-            $legalFirstChar = '[A-Z]';
-        }
-
-        if (preg_match("/^$legalFirstChar/", $string) === 0) {
-            return false;
-        }
-
-        // Check that the name only contains legal characters.
-        $legalChars = 'a-zA-Z0-9';
-        if (preg_match("|[^$legalChars]|", substr($string, 1)) > 0) {
-            return false;
-        }
-
-        if ($strict === true) {
-            // Check that there are not two capital letters next to each other.
-            $length          = strlen($string);
-            $lastCharWasCaps = $classFormat;
-
-            for ($i = 1; $i < $length; $i++) {
-                $ascii = ord($string[$i]);
-                if ($ascii >= 48 && $ascii <= 57) {
-                    // The character is a number, so it cant be a capital.
-                    $isCaps = false;
-                } else {
-                    if (strtoupper($string[$i]) === $string[$i]) {
-                        $isCaps = true;
-                    } else {
-                        $isCaps = false;
-                    }
-                }
-
-                if ($isCaps === true && $lastCharWasCaps === true) {
-                    return false;
-                }
-
-                $lastCharWasCaps = $isCaps;
-            }
-        }//end if
-
-        return true;
-
-    }//end isCamelCaps()
-
-
-    /**
-     * Returns true if the specified string is in the underscore caps format.
-     *
-     * @param string $string The string to verify.
-     *
-     * @return boolean
-     */
-    public static function isUnderscoreName($string)
-    {
-        // If there are space in the name, it can't be valid.
-        if (strpos($string, ' ') !== false) {
-            return false;
-        }
-
-        $validName = true;
-        $nameBits  = explode('_', $string);
-
-        if (preg_match('|^[A-Z]|', $string) === 0) {
-            // Name does not begin with a capital letter.
-            $validName = false;
-        } else {
-            foreach ($nameBits as $bit) {
-                if ($bit === '') {
-                    continue;
-                }
-
-                if ($bit[0] !== strtoupper($bit[0])) {
-                    $validName = false;
-                    break;
-                }
-            }
-        }
-
-        return $validName;
-
-    }//end isUnderscoreName()
-
-
-    /**
-     * Returns a valid variable type for param/var tags.
-     *
-     * If type is not one of the standard types, it must be a custom type.
-     * Returns the correct type name suggestion if type name is invalid.
-     *
-     * @param string $varType The variable type to process.
-     *
-     * @return string
-     */
-    public static function suggestType($varType)
-    {
-        if ($varType === '') {
-            return '';
-        }
-
-        if (in_array($varType, self::$allowedTypes, true) === true) {
-            return $varType;
-        } else {
-            $lowerVarType = strtolower($varType);
-            switch ($lowerVarType) {
-            case 'bool':
-            case 'boolean':
-                return 'boolean';
-            case 'double':
-            case 'real':
-            case 'float':
-                return 'float';
-            case 'int':
-            case 'integer':
-                return 'integer';
-            case 'array()':
-            case 'array':
-                return 'array';
-            }//end switch
-
-            if (strpos($lowerVarType, 'array(') !== false) {
-                // Valid array declaration:
-                // array, array(type), array(type1 => type2).
-                $matches = [];
-                $pattern = '/^array\(\s*([^\s^=^>]*)(\s*=>\s*(.*))?\s*\)/i';
-                if (preg_match($pattern, $varType, $matches) !== 0) {
-                    $type1 = '';
-                    if (isset($matches[1]) === true) {
-                        $type1 = $matches[1];
-                    }
-
-                    $type2 = '';
-                    if (isset($matches[3]) === true) {
-                        $type2 = $matches[3];
-                    }
-
-                    $type1 = self::suggestType($type1);
-                    $type2 = self::suggestType($type2);
-                    if ($type2 !== '') {
-                        $type2 = ' => '.$type2;
-                    }
-
-                    return "array($type1$type2)";
-                } else {
-                    return 'array';
-                }//end if
-            } else if (in_array($lowerVarType, self::$allowedTypes, true) === true) {
-                // A valid type, but not lower cased.
-                return $lowerVarType;
-            } else {
-                // Must be a custom type name.
-                return $varType;
-            }//end if
-        }//end if
-
-    }//end suggestType()
-
-
-    /**
-     * Given a sniff class name, returns the code for the sniff.
-     *
-     * @param string $sniffClass The fully qualified sniff class name.
-     *
-     * @return string
-     */
-    public static function getSniffCode($sniffClass)
-    {
-        $parts = explode('\\', $sniffClass);
-        $sniff = array_pop($parts);
-
-        if (substr($sniff, -5) === 'Sniff') {
-            // Sniff class name.
-            $sniff = substr($sniff, 0, -5);
-        } else {
-            // Unit test class name.
-            $sniff = substr($sniff, 0, -8);
-        }
-
-        $category = array_pop($parts);
-        $sniffDir = array_pop($parts);
-        $standard = array_pop($parts);
-        $code     = $standard.'.'.$category.'.'.$sniff;
-        return $code;
-
-    }//end getSniffCode()
-
-
-    /**
-     * Removes project-specific information from a sniff class name.
-     *
-     * @param string $sniffClass The fully qualified sniff class name.
-     *
-     * @return string
-     */
-    public static function cleanSniffClass($sniffClass)
-    {
-        $newName = strtolower($sniffClass);
-
-        $sniffPos = strrpos($newName, '\sniffs\\');
-        if ($sniffPos === false) {
-            // Nothing we can do as it isn't in a known format.
-            return $newName;
-        }
-
-        $end   = (strlen($newName) - $sniffPos + 1);
-        $start = strrpos($newName, '\\', ($end * -1));
-
-        if ($start === false) {
-            // Nothing needs to be cleaned.
-            return $newName;
-        }
-
-        $newName = substr($newName, ($start + 1));
-        return $newName;
-
-    }//end cleanSniffClass()
+	/**
+	 * An array of variable types for param/var we will check.
+	 *
+	 * @var string[]
+	 */
+	public static $allowedTypes = [
+		'array',
+		'boolean',
+		'float',
+		'integer',
+		'mixed',
+		'object',
+		'string',
+		'resource',
+		'callable',
+	];
+
+
+	/**
+	 * Return TRUE if the path is a PHAR file.
+	 *
+	 * @param string $path The path to use.
+	 *
+	 * @return mixed
+	 */
+	public static function isPharFile($path)
+	{
+		if (strpos($path, 'phar://') === 0) {
+			return true;
+		}
+
+		return false;
+
+	}//end isPharFile()
+
+
+	/**
+	 * Checks if a file is readable.
+	 *
+	 * Addresses PHP bug related to reading files from network drives on Windows.
+	 * e.g. when using WSL2.
+	 *
+	 * @param string $path The path to the file.
+	 *
+	 * @return boolean
+	 */
+	public static function isReadable($path)
+	{
+		if (@is_readable($path) === true) {
+			return true;
+		}
+
+		if (@file_exists($path) === true && @is_file($path) === true) {
+			$f = @fopen($path, 'rb');
+			if (fclose($f) === true) {
+				return true;
+			}
+		}
+
+		return false;
+
+	}//end isReadable()
+
+
+	/**
+	 * CodeSniffer alternative for realpath.
+	 *
+	 * Allows for PHAR support.
+	 *
+	 * @param string $path The path to use.
+	 *
+	 * @return mixed
+	 */
+	public static function realpath($path)
+	{
+		// Support the path replacement of ~ with the user's home directory.
+		if (substr($path, 0, 2) === '~/') {
+			$homeDir = getenv('HOME');
+			if ($homeDir !== false) {
+				$path = $homeDir.substr($path, 1);
+			}
+		}
+
+		// Check for process substitution.
+		if (strpos($path, '/dev/fd') === 0) {
+			return str_replace('/dev/fd', 'php://fd', $path);
+		}
+
+		// No extra work needed if this is not a phar file.
+		if (self::isPharFile($path) === false) {
+			return realpath($path);
+		}
+
+		// Before trying to break down the file path,
+		// check if it exists first because it will mostly not
+		// change after running the below code.
+		if (file_exists($path) === true) {
+			return $path;
+		}
+
+		$phar  = \Phar::running(false);
+		$extra = str_replace('phar://'.$phar, '', $path);
+		$path  = realpath($phar);
+		if ($path === false) {
+			return false;
+		}
+
+		$path = 'phar://'.$path.$extra;
+		if (file_exists($path) === true) {
+			return $path;
+		}
+
+		return false;
+
+	}//end realpath()
+
+
+	/**
+	 * Removes a base path from the front of a file path.
+	 *
+	 * @param string $path     The path of the file.
+	 * @param string $basepath The base path to remove. This should not end
+	 *                         with a directory separator.
+	 *
+	 * @return string
+	 */
+	public static function stripBasepath($path, $basepath)
+	{
+		if (empty($basepath) === true) {
+			return $path;
+		}
+
+		$basepathLen = strlen($basepath);
+		if (substr($path, 0, $basepathLen) === $basepath) {
+			$path = substr($path, $basepathLen);
+		}
+
+		$path = ltrim($path, DIRECTORY_SEPARATOR);
+		if ($path === '') {
+			$path = '.';
+		}
+
+		return $path;
+
+	}//end stripBasepath()
+
+
+	/**
+	 * Detects the EOL character being used in a string.
+	 *
+	 * @param string $contents The contents to check.
+	 *
+	 * @return string
+	 */
+	public static function detectLineEndings($contents)
+	{
+		if (preg_match("/\r\n?|\n/", $contents, $matches) !== 1) {
+			// Assume there are no newlines.
+			$eolChar = "\n";
+		} else {
+			$eolChar = $matches[0];
+		}
+
+		return $eolChar;
+
+	}//end detectLineEndings()
+
+
+	/**
+	 * Check if STDIN is a TTY.
+	 *
+	 * @return boolean
+	 */
+	public static function isStdinATTY()
+	{
+		// The check is slow (especially calling `tty`) so we static
+		// cache the result.
+		static $isTTY = null;
+
+		if ($isTTY !== null) {
+			return $isTTY;
+		}
+
+		if (defined('STDIN') === false) {
+			return false;
+		}
+
+		// If PHP has the POSIX extensions we will use them.
+		if (function_exists('posix_isatty') === true) {
+			$isTTY = (posix_isatty(STDIN) === true);
+			return $isTTY;
+		}
+
+		// Next try is detecting whether we have `tty` installed and use that.
+		if (defined('PHP_WINDOWS_VERSION_PLATFORM') === true) {
+			$devnull = 'NUL';
+			$which   = 'where';
+		} else {
+			$devnull = '/dev/null';
+			$which   = 'which';
+		}
+
+		$tty = trim(shell_exec("$which tty 2> $devnull"));
+		if (empty($tty) === false) {
+			exec("tty -s 2> $devnull", $output, $returnValue);
+			$isTTY = ($returnValue === 0);
+			return $isTTY;
+		}
+
+		// Finally we will use fstat.  The solution borrowed from
+		// https://stackoverflow.com/questions/11327367/detect-if-a-php-script-is-being-run-interactively-or-not
+		// This doesn't work on Mingw/Cygwin/... using Mintty but they
+		// have `tty` installed.
+		$type = [
+			'S_IFMT'  => 0170000,
+			'S_IFIFO' => 0010000,
+		];
+
+		$stat  = fstat(STDIN);
+		$mode  = ($stat['mode'] & $type['S_IFMT']);
+		$isTTY = ($mode !== $type['S_IFIFO']);
+
+		return $isTTY;
+
+	}//end isStdinATTY()
+
+
+	/**
+	 * Escape a path to a system command.
+	 *
+	 * @param string $cmd The path to the system command.
+	 *
+	 * @return string
+	 */
+	public static function escapeshellcmd($cmd)
+	{
+		$cmd = escapeshellcmd($cmd);
+
+		if (stripos(PHP_OS, 'WIN') === 0) {
+			// Spaces are not escaped by escapeshellcmd on Windows, but need to be
+			// for the command to be able to execute.
+			$cmd = preg_replace('`(?<!^) `', '^ ', $cmd);
+		}
+
+		return $cmd;
+
+	}//end escapeshellcmd()
+
+
+	/**
+	 * Prepares token content for output to screen.
+	 *
+	 * Replaces invisible characters so they are visible. On non-Windows
+	 * operating systems it will also colour the invisible characters.
+	 *
+	 * @param string   $content The content to prepare.
+	 * @param string[] $exclude A list of characters to leave invisible.
+	 *                          Can contain \r, \n, \t and a space.
+	 *
+	 * @return string
+	 */
+	public static function prepareForOutput($content, $exclude=[])
+	{
+		if (stripos(PHP_OS, 'WIN') === 0) {
+			if (in_array("\r", $exclude, true) === false) {
+				$content = str_replace("\r", '\r', $content);
+			}
+
+			if (in_array("\n", $exclude, true) === false) {
+				$content = str_replace("\n", '\n', $content);
+			}
+
+			if (in_array("\t", $exclude, true) === false) {
+				$content = str_replace("\t", '\t', $content);
+			}
+		} else {
+			if (in_array("\r", $exclude, true) === false) {
+				$content = str_replace("\r", "\033[30;1m\\r\033[0m", $content);
+			}
+
+			if (in_array("\n", $exclude, true) === false) {
+				$content = str_replace("\n", "\033[30;1m\\n\033[0m", $content);
+			}
+
+			if (in_array("\t", $exclude, true) === false) {
+				$content = str_replace("\t", "\033[30;1m\\t\033[0m", $content);
+			}
+
+			if (in_array(' ', $exclude, true) === false) {
+				$content = str_replace(' ', "\033[30;1m·\033[0m", $content);
+			}
+		}//end if
+
+		return $content;
+
+	}//end prepareForOutput()
+
+
+	/**
+	 * Returns true if the specified string is in the camel caps format.
+	 *
+	 * @param string  $string      The string the verify.
+	 * @param boolean $classFormat If true, check to see if the string is in the
+	 *                             class format. Class format strings must start
+	 *                             with a capital letter and contain no
+	 *                             underscores.
+	 * @param boolean $public      If true, the first character in the string
+	 *                             must be an a-z character. If false, the
+	 *                             character must be an underscore. This
+	 *                             argument is only applicable if $classFormat
+	 *                             is false.
+	 * @param boolean $strict      If true, the string must not have two capital
+	 *                             letters next to each other. If false, a
+	 *                             relaxed camel caps policy is used to allow
+	 *                             for acronyms.
+	 *
+	 * @return boolean
+	 */
+	public static function isCamelCaps(
+		$string,
+		$classFormat=false,
+		$public=true,
+		$strict=true
+	) {
+		// Check the first character first.
+		if ($classFormat === false) {
+			$legalFirstChar = '';
+			if ($public === false) {
+				$legalFirstChar = '[_]';
+			}
+
+			if ($strict === false) {
+				// Can either start with a lowercase letter, or multiple uppercase
+				// in a row, representing an acronym.
+				$legalFirstChar .= '([A-Z]{2,}|[a-z])';
+			} else {
+				$legalFirstChar .= '[a-z]';
+			}
+		} else {
+			$legalFirstChar = '[A-Z]';
+		}
+
+		if (preg_match("/^$legalFirstChar/", $string) === 0) {
+			return false;
+		}
+
+		// Check that the name only contains legal characters.
+		$legalChars = 'a-zA-Z0-9';
+		if (preg_match("|[^$legalChars]|", substr($string, 1)) > 0) {
+			return false;
+		}
+
+		if ($strict === true) {
+			// Check that there are not two capital letters next to each other.
+			$length          = strlen($string);
+			$lastCharWasCaps = $classFormat;
+
+			for ($i = 1; $i < $length; $i++) {
+				$ascii = ord($string[$i]);
+				if ($ascii >= 48 && $ascii <= 57) {
+					// The character is a number, so it cant be a capital.
+					$isCaps = false;
+				} else {
+					if (strtoupper($string[$i]) === $string[$i]) {
+						$isCaps = true;
+					} else {
+						$isCaps = false;
+					}
+				}
+
+				if ($isCaps === true && $lastCharWasCaps === true) {
+					return false;
+				}
+
+				$lastCharWasCaps = $isCaps;
+			}
+		}//end if
+
+		return true;
+
+	}//end isCamelCaps()
+
+
+	/**
+	 * Returns true if the specified string is in the underscore caps format.
+	 *
+	 * @param string $string The string to verify.
+	 *
+	 * @return boolean
+	 */
+	public static function isUnderscoreName($string)
+	{
+		// If there are space in the name, it can't be valid.
+		if (strpos($string, ' ') !== false) {
+			return false;
+		}
+
+		$validName = true;
+		$nameBits  = explode('_', $string);
+
+		if (preg_match('|^[A-Z]|', $string) === 0) {
+			// Name does not begin with a capital letter.
+			$validName = false;
+		} else {
+			foreach ($nameBits as $bit) {
+				if ($bit === '') {
+					continue;
+				}
+
+				if ($bit[0] !== strtoupper($bit[0])) {
+					$validName = false;
+					break;
+				}
+			}
+		}
+
+		return $validName;
+
+	}//end isUnderscoreName()
+
+
+	/**
+	 * Returns a valid variable type for param/var tags.
+	 *
+	 * If type is not one of the standard types, it must be a custom type.
+	 * Returns the correct type name suggestion if type name is invalid.
+	 *
+	 * @param string $varType The variable type to process.
+	 *
+	 * @return string
+	 */
+	public static function suggestType($varType)
+	{
+		if ($varType === '') {
+			return '';
+		}
+
+		if (in_array($varType, self::$allowedTypes, true) === true) {
+			return $varType;
+		} else {
+			$lowerVarType = strtolower($varType);
+			switch ($lowerVarType) {
+			case 'bool':
+			case 'boolean':
+				return 'boolean';
+			case 'double':
+			case 'real':
+			case 'float':
+				return 'float';
+			case 'int':
+			case 'integer':
+				return 'integer';
+			case 'array()':
+			case 'array':
+				return 'array';
+			}//end switch
+
+			if (strpos($lowerVarType, 'array(') !== false) {
+				// Valid array declaration:
+				// array, array(type), array(type1 => type2).
+				$matches = [];
+				$pattern = '/^array\(\s*([^\s^=^>]*)(\s*=>\s*(.*))?\s*\)/i';
+				if (preg_match($pattern, $varType, $matches) !== 0) {
+					$type1 = '';
+					if (isset($matches[1]) === true) {
+						$type1 = $matches[1];
+					}
+
+					$type2 = '';
+					if (isset($matches[3]) === true) {
+						$type2 = $matches[3];
+					}
+
+					$type1 = self::suggestType($type1);
+					$type2 = self::suggestType($type2);
+					if ($type2 !== '') {
+						$type2 = ' => '.$type2;
+					}
+
+					return "array($type1$type2)";
+				} else {
+					return 'array';
+				}//end if
+			} else if (in_array($lowerVarType, self::$allowedTypes, true) === true) {
+				// A valid type, but not lower cased.
+				return $lowerVarType;
+			} else {
+				// Must be a custom type name.
+				return $varType;
+			}//end if
+		}//end if
+
+	}//end suggestType()
+
+
+	/**
+	 * Given a sniff class name, returns the code for the sniff.
+	 *
+	 * @param string $sniffClass The fully qualified sniff class name.
+	 *
+	 * @return string
+	 */
+	public static function getSniffCode($sniffClass)
+	{
+		$parts = explode('\\', $sniffClass);
+		$sniff = array_pop($parts);
+
+		if (substr($sniff, -5) === 'Sniff') {
+			// Sniff class name.
+			$sniff = substr($sniff, 0, -5);
+		} else {
+			// Unit test class name.
+			$sniff = substr($sniff, 0, -8);
+		}
+
+		$category = array_pop($parts);
+		$sniffDir = array_pop($parts);
+		$standard = array_pop($parts);
+		$code     = $standard.'.'.$category.'.'.$sniff;
+		return $code;
+
+	}//end getSniffCode()
+
+
+	/**
+	 * Removes project-specific information from a sniff class name.
+	 *
+	 * @param string $sniffClass The fully qualified sniff class name.
+	 *
+	 * @return string
+	 */
+	public static function cleanSniffClass($sniffClass)
+	{
+		$newName = strtolower($sniffClass);
+
+		$sniffPos = strrpos($newName, '\sniffs\\');
+		if ($sniffPos === false) {
+			// Nothing we can do as it isn't in a known format.
+			return $newName;
+		}
+
+		$end   = (strlen($newName) - $sniffPos + 1);
+		$start = strrpos($newName, '\\', ($end * -1));
+
+		if ($start === false) {
+			// Nothing needs to be cleaned.
+			return $newName;
+		}
+
+		$newName = substr($newName, ($start + 1));
+		return $newName;
+
+	}//end cleanSniffClass()
 
 
 }//end class

Spacing +4 added lines, -4 removed lines

@@ -273,7 +273,7 @@ 
      *
      * @return string
      */
-    public static function prepareForOutput($content, $exclude=[])
+    public static function prepareForOutput($content, $exclude = [])
     {
         if (stripos(PHP_OS, 'WIN') === 0) {
             if (in_array("\r", $exclude, true) === false) {
@@ -332,9 +332,9 @@ 
      */
     public static function isCamelCaps(
         $string,
-        $classFormat=false,
-        $public=true,
-        $strict=true
+        $classFormat = false,
+        $public = true,
+        $strict = true
     ) {
         // Check the first character first.
         if ($classFormat === false) {

vendor/squizlabs/php_codesniffer/src/Standards/Squiz/Tests/NamingConventions/ValidFunctionNameUnitTest.php

Indentation +39 added lines, -39 removed lines

@@ -15,45 +15,45 @@
 {
 
 
-    /**
-     * Returns the lines where errors should occur.
-     *
-     * The key of the array should represent the line number and the value
-     * should represent the number of errors that should occur on that line.
-     *
-     * @return array<int, int>
-     */
-    public function getErrorList()
-    {
-        return [
-            4  => 1,
-            5  => 1,
-            6  => 1,
-            7  => 1,
-            8  => 1,
-            9  => 1,
-            11 => 1,
-            12 => 1,
-            13 => 1,
-            14 => 2,
-        ];
-
-    }//end getErrorList()
-
-
-    /**
-     * Returns the lines where warnings should occur.
-     *
-     * The key of the array should represent the line number and the value
-     * should represent the number of warnings that should occur on that line.
-     *
-     * @return array<int, int>
-     */
-    public function getWarningList()
-    {
-        return [];
-
-    }//end getWarningList()
+	/**
+	 * Returns the lines where errors should occur.
+	 *
+	 * The key of the array should represent the line number and the value
+	 * should represent the number of errors that should occur on that line.
+	 *
+	 * @return array<int, int>
+	 */
+	public function getErrorList()
+	{
+		return [
+			4  => 1,
+			5  => 1,
+			6  => 1,
+			7  => 1,
+			8  => 1,
+			9  => 1,
+			11 => 1,
+			12 => 1,
+			13 => 1,
+			14 => 2,
+		];
+
+	}//end getErrorList()
+
+
+	/**
+	 * Returns the lines where warnings should occur.
+	 *
+	 * The key of the array should represent the line number and the value
+	 * should represent the number of warnings that should occur on that line.
+	 *
+	 * @return array<int, int>
+	 */
+	public function getWarningList()
+	{
+		return [];
+
+	}//end getWarningList()
 
 
 }//end class

vendor/squizlabs/php_codesniffer/src/Standards/Squiz/Tests/NamingConventions/ValidFunctionNameUnitTest.inc

Indentation +2 added lines, -2 removed lines

@@ -21,7 +21,7 @@
 /* @codingStandardsIgnoreStart */
 class MyClass
 {
-    /* @codingStandardsIgnoreEnd */
-    public function __construct() {}
+	/* @codingStandardsIgnoreEnd */
+	public function __construct() {}
 }
 ?>

Spacing +1 added lines, -1 removed lines

@@ -16,7 +16,7 @@
 function XMLParser() {}
 function xmlParser() {}
 
-echo preg_replace_callback('~-([a-z])~', function ($match) { return strtoupper($match[1]); }, 'hello-world');
+echo preg_replace_callback('~-([a-z])~', function($match) { return strtoupper($match[1]); }, 'hello-world');
 
 /* @codingStandardsIgnoreStart */
 class MyClass