eventespresso / event-espresso-core

core/services/commands/CommandFactoryInterface.php

Indentation +9 added lines, -9 removed lines

@@ -9,13 +9,13 @@
 interface CommandFactoryInterface
 {
 
-    /**
-     * @param string $command_fqcn
-     * @param array  $arguments
-     * @return mixed
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function getNew($command_fqcn, $arguments = array());
+	/**
+	 * @param string $command_fqcn
+	 * @param array  $arguments
+	 * @return mixed
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function getNew($command_fqcn, $arguments = array());
 }

core/services/loaders/LoaderDecoratorInterface.php

Indentation +11 added lines, -11 removed lines

@@ -5,18 +5,18 @@
 interface LoaderDecoratorInterface
 {
 
-    /**
-     * @param string $fqcn
-     * @param array  $arguments
-     * @param bool   $shared
-     * @return mixed
-     */
-    public function load($fqcn, $arguments = array(), $shared = true);
+	/**
+	 * @param string $fqcn
+	 * @param array  $arguments
+	 * @param bool   $shared
+	 * @return mixed
+	 */
+	public function load($fqcn, $arguments = array(), $shared = true);
 
 
 
-    /**
-     * calls reset() on loader if method exists
-     */
-    public function reset();
+	/**
+	 * calls reset() on loader if method exists
+	 */
+	public function reset();
 }

core/services/helpers/datetime/PhpCompatLessFiveSixHelper.php

Spacing +1 added lines, -1 removed lines

@@ -59,7 +59,7 @@
         // although we don't know the TZ abbreviation, we know the UTC offset
         $timezone_string = timezone_name_from_abbr(null, $gmt_offset);
         // only use this timezone_string IF it's current offset matches the given offset
-        if (! empty($timezone_string)) {
+        if ( ! empty($timezone_string)) {
             $offset = null;
             try {
                 $offset = $this->getTimezoneOffset(new DateTimeZone($timezone_string));

Indentation +212 added lines, -212 removed lines

@@ -18,221 +18,221 @@
  */
 class PhpCompatLessFiveSixHelper extends AbstractHelper
 {
-    /**
-     * PhpCompatLessFiveSixHelper constructor.
-     *
-     * @throws DomainException
-     */
-    public function __construct()
-    {
-        if (PHP_VERSION_ID >= 50600) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'The %1$s is only usable on php versions less than 5.6.  You\'ll want to use %2$s instead.',
-                        'event_espresso'
-                    ),
-                    __CLASS__,
-                    'EventEspresso\core\services\helpers\datetime\PhpCompatGreaterFiveSixHelper'
-                )
-            );
-        }
-    }
+	/**
+	 * PhpCompatLessFiveSixHelper constructor.
+	 *
+	 * @throws DomainException
+	 */
+	public function __construct()
+	{
+		if (PHP_VERSION_ID >= 50600) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'The %1$s is only usable on php versions less than 5.6.  You\'ll want to use %2$s instead.',
+						'event_espresso'
+					),
+					__CLASS__,
+					'EventEspresso\core\services\helpers\datetime\PhpCompatGreaterFiveSixHelper'
+				)
+			);
+		}
+	}
 
-    /**
-     * Returns a timezone string for the provided gmt_offset.
-     *
-     * @param float|string $gmt_offset
-     * @return string
-     * @throws EE_Error
-     */
-    public function getTimezoneStringFromGmtOffset($gmt_offset = '')
-    {
-        $gmt_offset_or_timezone_string = $this->sanitizeInitialIncomingGmtOffsetForGettingTimezoneString($gmt_offset);
-        if (is_string($gmt_offset_or_timezone_string)) {
-            return $gmt_offset_or_timezone_string;
-        }
-        // well we know its a float, so let's roll with it.
-        $gmt_offset = $gmt_offset_or_timezone_string;
-        // convert GMT offset to seconds
-        $gmt_offset *= HOUR_IN_SECONDS;
-        // although we don't know the TZ abbreviation, we know the UTC offset
-        $timezone_string = timezone_name_from_abbr(null, $gmt_offset);
-        // only use this timezone_string IF it's current offset matches the given offset
-        if (! empty($timezone_string)) {
-            $offset = null;
-            try {
-                $offset = $this->getTimezoneOffset(new DateTimeZone($timezone_string));
-                if ($offset !== $gmt_offset) {
-                    $timezone_string = false;
-                }
-            } catch (Exception $e) {
-                $timezone_string = false;
-            }
-        }
-        // better have a valid timezone string by now, but if not, sigh... loop thru  the timezone_abbreviations_list()
-        // ...
-        $timezone_string = $timezone_string !== false
-            ? $timezone_string
-            : $this->getTimezoneStringFromAbbreviationsList($gmt_offset);
-        return $timezone_string;
-    }
+	/**
+	 * Returns a timezone string for the provided gmt_offset.
+	 *
+	 * @param float|string $gmt_offset
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function getTimezoneStringFromGmtOffset($gmt_offset = '')
+	{
+		$gmt_offset_or_timezone_string = $this->sanitizeInitialIncomingGmtOffsetForGettingTimezoneString($gmt_offset);
+		if (is_string($gmt_offset_or_timezone_string)) {
+			return $gmt_offset_or_timezone_string;
+		}
+		// well we know its a float, so let's roll with it.
+		$gmt_offset = $gmt_offset_or_timezone_string;
+		// convert GMT offset to seconds
+		$gmt_offset *= HOUR_IN_SECONDS;
+		// although we don't know the TZ abbreviation, we know the UTC offset
+		$timezone_string = timezone_name_from_abbr(null, $gmt_offset);
+		// only use this timezone_string IF it's current offset matches the given offset
+		if (! empty($timezone_string)) {
+			$offset = null;
+			try {
+				$offset = $this->getTimezoneOffset(new DateTimeZone($timezone_string));
+				if ($offset !== $gmt_offset) {
+					$timezone_string = false;
+				}
+			} catch (Exception $e) {
+				$timezone_string = false;
+			}
+		}
+		// better have a valid timezone string by now, but if not, sigh... loop thru  the timezone_abbreviations_list()
+		// ...
+		$timezone_string = $timezone_string !== false
+			? $timezone_string
+			: $this->getTimezoneStringFromAbbreviationsList($gmt_offset);
+		return $timezone_string;
+	}
 
 
-    /**
-     * @param int  $gmt_offset
-     * @param bool $coerce If true, we attempt to coerce with our adjustment table
-     * @see self::adjustInvalidGmtOffset
-     * @return string
-     * @throws EE_Error
-     */
-    protected function getTimezoneStringFromAbbreviationsList($gmt_offset = 0, $coerce = true)
-    {
-        $gmt_offset = (int) $gmt_offset;
-        /** @var array[] $abbreviations */
-        $abbreviations = DateTimeZone::listAbbreviations();
-        foreach ($abbreviations as $abbreviation) {
-            foreach ($abbreviation as $timezone) {
-                if ((int) $timezone['offset'] === $gmt_offset && (bool) $timezone['dst'] === false) {
-                    try {
-                        $offset = $this->getTimezoneOffset(new DateTimeZone($timezone['timezone_id']));
-                        if ($offset !== $gmt_offset) {
-                            continue;
-                        }
-                        return $timezone['timezone_id'];
-                    } catch (Exception $e) {
-                        continue;
-                    }
-                }
-            }
-        }
-        // if $coerce is true, let's see if we can get a timezone string after the offset is adjusted
-        if ($coerce === true) {
-            $timezone_string = $this->getTimezoneStringFromAbbreviationsList(
-                $this->adjustInvalidGmtOffsets($gmt_offset),
-                false
-            );
-            if ($timezone_string) {
-                return $timezone_string;
-            }
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    'The provided GMT offset (%1$s), is invalid, please check with %2$sthis list%3$s for what valid timezones can be used',
-                    'event_espresso'
-                ),
-                $gmt_offset / HOUR_IN_SECONDS,
-                '<a href="http://www.php.net/manual/en/timezones.php">',
-                '</a>'
-            )
-        );
-    }
+	/**
+	 * @param int  $gmt_offset
+	 * @param bool $coerce If true, we attempt to coerce with our adjustment table
+	 * @see self::adjustInvalidGmtOffset
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function getTimezoneStringFromAbbreviationsList($gmt_offset = 0, $coerce = true)
+	{
+		$gmt_offset = (int) $gmt_offset;
+		/** @var array[] $abbreviations */
+		$abbreviations = DateTimeZone::listAbbreviations();
+		foreach ($abbreviations as $abbreviation) {
+			foreach ($abbreviation as $timezone) {
+				if ((int) $timezone['offset'] === $gmt_offset && (bool) $timezone['dst'] === false) {
+					try {
+						$offset = $this->getTimezoneOffset(new DateTimeZone($timezone['timezone_id']));
+						if ($offset !== $gmt_offset) {
+							continue;
+						}
+						return $timezone['timezone_id'];
+					} catch (Exception $e) {
+						continue;
+					}
+				}
+			}
+		}
+		// if $coerce is true, let's see if we can get a timezone string after the offset is adjusted
+		if ($coerce === true) {
+			$timezone_string = $this->getTimezoneStringFromAbbreviationsList(
+				$this->adjustInvalidGmtOffsets($gmt_offset),
+				false
+			);
+			if ($timezone_string) {
+				return $timezone_string;
+			}
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					'The provided GMT offset (%1$s), is invalid, please check with %2$sthis list%3$s for what valid timezones can be used',
+					'event_espresso'
+				),
+				$gmt_offset / HOUR_IN_SECONDS,
+				'<a href="http://www.php.net/manual/en/timezones.php">',
+				'</a>'
+			)
+		);
+	}
 
 
-    /**
-     * Depending on PHP version,
-     * there might not be valid current timezone strings to match these gmt_offsets in its timezone tables.
-     * To get around that, for these fringe timezones we bump them to a known valid offset.
-     * This method should ONLY be called after first verifying an timezone_string cannot be retrieved for the offset.
-     *
-     * @param int $gmt_offset
-     * @return int
-     */
-    public function adjustInvalidGmtOffsets($gmt_offset = 0)
-    {
-        // make sure $gmt_offset is int
-        $gmt_offset = (int) $gmt_offset;
-        switch ($gmt_offset) {
-            // -12
-            case -43200:
-                $gmt_offset = -39600;
-                break;
-            // -11.5
-            case -41400:
-                $gmt_offset = -39600;
-                break;
-            // -10.5
-            case -37800:
-                $gmt_offset = -39600;
-                break;
-            // -8.5
-            case -30600:
-                $gmt_offset = -28800;
-                break;
-            // -7.5
-            case -27000:
-                $gmt_offset = -25200;
-                break;
-            // -6.5
-            case -23400:
-                $gmt_offset = -21600;
-                break;
-            // -5.5
-            case -19800:
-                $gmt_offset = -18000;
-                break;
-            // -4.5
-            case -16200:
-                $gmt_offset = -14400;
-                break;
-            // -3.5
-            case -12600:
-                $gmt_offset = -10800;
-                break;
-            // -2.5
-            case -9000:
-                $gmt_offset = -7200;
-                break;
-            // -1.5
-            case -5400:
-                $gmt_offset = -3600;
-                break;
-            // -0.5
-            case -1800:
-                $gmt_offset = 0;
-                break;
-            // .5
-            case 1800:
-                $gmt_offset = 3600;
-                break;
-            // 1.5
-            case 5400:
-                $gmt_offset = 7200;
-                break;
-            // 2.5
-            case 9000:
-                $gmt_offset = 10800;
-                break;
-            // 3.5
-            case 12600:
-                $gmt_offset = 14400;
-                break;
-            // 7.5
-            case 27000:
-                $gmt_offset = 28800;
-                break;
-            // 8.5
-            case 30600:
-                $gmt_offset = 31500;
-                break;
-            // 10.5
-            case 37800:
-                $gmt_offset = 39600;
-                break;
-            // 11.5
-            case 41400:
-                $gmt_offset = 43200;
-                break;
-            // 12.75
-            case 45900:
-                $gmt_offset = 46800;
-                break;
-            // 13.75
-            case 49500:
-                $gmt_offset = 50400;
-                break;
-        }
-        return $gmt_offset;
-    }
+	/**
+	 * Depending on PHP version,
+	 * there might not be valid current timezone strings to match these gmt_offsets in its timezone tables.
+	 * To get around that, for these fringe timezones we bump them to a known valid offset.
+	 * This method should ONLY be called after first verifying an timezone_string cannot be retrieved for the offset.
+	 *
+	 * @param int $gmt_offset
+	 * @return int
+	 */
+	public function adjustInvalidGmtOffsets($gmt_offset = 0)
+	{
+		// make sure $gmt_offset is int
+		$gmt_offset = (int) $gmt_offset;
+		switch ($gmt_offset) {
+			// -12
+			case -43200:
+				$gmt_offset = -39600;
+				break;
+			// -11.5
+			case -41400:
+				$gmt_offset = -39600;
+				break;
+			// -10.5
+			case -37800:
+				$gmt_offset = -39600;
+				break;
+			// -8.5
+			case -30600:
+				$gmt_offset = -28800;
+				break;
+			// -7.5
+			case -27000:
+				$gmt_offset = -25200;
+				break;
+			// -6.5
+			case -23400:
+				$gmt_offset = -21600;
+				break;
+			// -5.5
+			case -19800:
+				$gmt_offset = -18000;
+				break;
+			// -4.5
+			case -16200:
+				$gmt_offset = -14400;
+				break;
+			// -3.5
+			case -12600:
+				$gmt_offset = -10800;
+				break;
+			// -2.5
+			case -9000:
+				$gmt_offset = -7200;
+				break;
+			// -1.5
+			case -5400:
+				$gmt_offset = -3600;
+				break;
+			// -0.5
+			case -1800:
+				$gmt_offset = 0;
+				break;
+			// .5
+			case 1800:
+				$gmt_offset = 3600;
+				break;
+			// 1.5
+			case 5400:
+				$gmt_offset = 7200;
+				break;
+			// 2.5
+			case 9000:
+				$gmt_offset = 10800;
+				break;
+			// 3.5
+			case 12600:
+				$gmt_offset = 14400;
+				break;
+			// 7.5
+			case 27000:
+				$gmt_offset = 28800;
+				break;
+			// 8.5
+			case 30600:
+				$gmt_offset = 31500;
+				break;
+			// 10.5
+			case 37800:
+				$gmt_offset = 39600;
+				break;
+			// 11.5
+			case 41400:
+				$gmt_offset = 43200;
+				break;
+			// 12.75
+			case 45900:
+				$gmt_offset = 46800;
+				break;
+			// 13.75
+			case 49500:
+				$gmt_offset = 50400;
+				break;
+		}
+		return $gmt_offset;
+	}
 }

core/services/helpers/datetime/PhpCompatGreaterFiveSixHelper.php

Indentation +79 added lines, -79 removed lines

@@ -8,91 +8,91 @@
 
 class PhpCompatGreaterFiveSixHelper extends AbstractHelper
 {
-    /**
-     * PhpCompatLessFiveSixHelper constructor.
-     *
-     * @throws DomainException
-     */
-    public function __construct()
-    {
-        if (PHP_VERSION_ID < 50600) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'The %1$s is only usable on php versions greater than 5.6.  You\'ll want to use %2$s instead.',
-                        'event_espresso'
-                    ),
-                    __CLASS__,
-                    'EventEspresso\core\services\helpers\datetime\PhpCompatLessFiveSixHelper'
-                )
-            );
-        }
-    }
+	/**
+	 * PhpCompatLessFiveSixHelper constructor.
+	 *
+	 * @throws DomainException
+	 */
+	public function __construct()
+	{
+		if (PHP_VERSION_ID < 50600) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'The %1$s is only usable on php versions greater than 5.6.  You\'ll want to use %2$s instead.',
+						'event_espresso'
+					),
+					__CLASS__,
+					'EventEspresso\core\services\helpers\datetime\PhpCompatLessFiveSixHelper'
+				)
+			);
+		}
+	}
 
-    /**
-     * Returns a timezone string for the provided gmt_offset.
-     * This is a valid timezone string that can be sent into DateTimeZone
-     *
-     * @param float|string $gmt_offset
-     * @return string
-     */
-    public function getTimezoneStringFromGmtOffset($gmt_offset = '')
-    {
-        $gmt_offset_or_timezone_string = $this->sanitizeInitialIncomingGmtOffsetForGettingTimezoneString($gmt_offset);
-        return is_float($gmt_offset_or_timezone_string)
-            ? $this->convertWpGmtOffsetForDateTimeZone($gmt_offset_or_timezone_string)
-            : $gmt_offset_or_timezone_string;
-    }
+	/**
+	 * Returns a timezone string for the provided gmt_offset.
+	 * This is a valid timezone string that can be sent into DateTimeZone
+	 *
+	 * @param float|string $gmt_offset
+	 * @return string
+	 */
+	public function getTimezoneStringFromGmtOffset($gmt_offset = '')
+	{
+		$gmt_offset_or_timezone_string = $this->sanitizeInitialIncomingGmtOffsetForGettingTimezoneString($gmt_offset);
+		return is_float($gmt_offset_or_timezone_string)
+			? $this->convertWpGmtOffsetForDateTimeZone($gmt_offset_or_timezone_string)
+			: $gmt_offset_or_timezone_string;
+	}
 
 
 
-    /**
-     * Returns a formatted offset for use as an argument for constructing DateTimeZone
-     * @param float $gmt_offset This should be a float representing the gmt_offset.
-     * @return string
-     */
-    protected function convertWpGmtOffsetForDateTimeZone($gmt_offset)
-    {
-        $gmt_offset = (float) $gmt_offset;
-        $is_negative = $gmt_offset < 0;
-        $gmt_offset *= 100;
-        $gmt_offset = absint($gmt_offset);
-        // negative and need zero padding?
-        if (strlen($gmt_offset) < 4) {
-            $gmt_offset = str_pad($gmt_offset, 4, '0', STR_PAD_LEFT);
-        }
-        $gmt_offset = $this->convertToTimeFraction($gmt_offset);
-        // return something like -1300, -0200 or +1300, +0200
-        return $is_negative ? '-' . $gmt_offset : '+' . $gmt_offset;
-    }
+	/**
+	 * Returns a formatted offset for use as an argument for constructing DateTimeZone
+	 * @param float $gmt_offset This should be a float representing the gmt_offset.
+	 * @return string
+	 */
+	protected function convertWpGmtOffsetForDateTimeZone($gmt_offset)
+	{
+		$gmt_offset = (float) $gmt_offset;
+		$is_negative = $gmt_offset < 0;
+		$gmt_offset *= 100;
+		$gmt_offset = absint($gmt_offset);
+		// negative and need zero padding?
+		if (strlen($gmt_offset) < 4) {
+			$gmt_offset = str_pad($gmt_offset, 4, '0', STR_PAD_LEFT);
+		}
+		$gmt_offset = $this->convertToTimeFraction($gmt_offset);
+		// return something like -1300, -0200 or +1300, +0200
+		return $is_negative ? '-' . $gmt_offset : '+' . $gmt_offset;
+	}
 
 
-    /**
-     * Converts something like `1550` to `1530` or `0275` to `0245`
-     * Incoming offset should be a positive value, this will mutate negative values. Be aware!
-     * @param int $offset
-     * @return mixed
-     */
-    protected function convertToTimeFraction($offset)
-    {
-        $first_part = substr($offset, 0, 2);
-        $second_part = substr($offset, 2, 2);
-        $second_part = str_replace(array('25', '50', '75'), array('15', '30', '45'), $second_part);
-        return $first_part . $second_part;
-    }
+	/**
+	 * Converts something like `1550` to `1530` or `0275` to `0245`
+	 * Incoming offset should be a positive value, this will mutate negative values. Be aware!
+	 * @param int $offset
+	 * @return mixed
+	 */
+	protected function convertToTimeFraction($offset)
+	{
+		$first_part = substr($offset, 0, 2);
+		$second_part = substr($offset, 2, 2);
+		$second_part = str_replace(array('25', '50', '75'), array('15', '30', '45'), $second_part);
+		return $first_part . $second_part;
+	}
 
 
-    /**
-     * Get Timezone offset for given timezone object
-     *
-     * @param DateTimeZone $date_time_zone
-     * @param null|int     $time
-     * @return int
-     */
-    public function getTimezoneOffset(DateTimezone $date_time_zone, $time = null)
-    {
-        $time = is_int($time) || $time === null ? $time : (int) strtotime($time);
-        $time = preg_match(EE_Datetime_Field::unix_timestamp_regex, $time) ? $time : time();
-        return $date_time_zone->getOffset(new DateTime('@' . $time));
-    }
+	/**
+	 * Get Timezone offset for given timezone object
+	 *
+	 * @param DateTimeZone $date_time_zone
+	 * @param null|int     $time
+	 * @return int
+	 */
+	public function getTimezoneOffset(DateTimezone $date_time_zone, $time = null)
+	{
+		$time = is_int($time) || $time === null ? $time : (int) strtotime($time);
+		$time = preg_match(EE_Datetime_Field::unix_timestamp_regex, $time) ? $time : time();
+		return $date_time_zone->getOffset(new DateTime('@' . $time));
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -63,7 +63,7 @@ 
         }
         $gmt_offset = $this->convertToTimeFraction($gmt_offset);
         // return something like -1300, -0200 or +1300, +0200
-        return $is_negative ? '-' . $gmt_offset : '+' . $gmt_offset;
+        return $is_negative ? '-'.$gmt_offset : '+'.$gmt_offset;
     }
 
 
@@ -78,7 +78,7 @@ 
         $first_part = substr($offset, 0, 2);
         $second_part = substr($offset, 2, 2);
         $second_part = str_replace(array('25', '50', '75'), array('15', '30', '45'), $second_part);
-        return $first_part . $second_part;
+        return $first_part.$second_part;
     }
 
 
@@ -93,6 +93,6 @@ 
     {
         $time = is_int($time) || $time === null ? $time : (int) strtotime($time);
         $time = preg_match(EE_Datetime_Field::unix_timestamp_regex, $time) ? $time : time();
-        return $date_time_zone->getOffset(new DateTime('@' . $time));
+        return $date_time_zone->getOffset(new DateTime('@'.$time));
     }
 }

core/data_migration_scripts/4_6_0_stages/EE_DMS_4_6_0_billing_info.dmsstage.php

Spacing +4 added lines, -4 removed lines

@@ -25,9 +25,9 @@ 
         $old_billing_info = maybe_unserialize($old_row['meta_value']);
         $gateway_name = str_replace("billing_info_", '', $old_row['meta_key']);
         $repetitive_prefix = '_reg-page-billing-';
-        $repetitive_suffix = "-" . $gateway_name;
+        $repetitive_suffix = "-".$gateway_name;
         foreach ($old_billing_info as $old_input_name => $input_value) {
-            $old_input_name_important_part = str_replace(array( $repetitive_prefix, $repetitive_suffix ), array( '', ''), $old_input_name);
+            $old_input_name_important_part = str_replace(array($repetitive_prefix, $repetitive_suffix), array('', ''), $old_input_name);
 
             switch ($old_input_name_important_part) {
                 case 'fname':
@@ -61,7 +61,7 @@ 
                 default:
                     $new_input_name = $old_input_name_important_part;
             }
-            $new_billing_info[ $new_input_name ] = $input_value;
+            $new_billing_info[$new_input_name] = $input_value;
         }
         update_post_meta($old_row['post_id'], $old_row['meta_key'], $new_billing_info);
     }
@@ -74,6 +74,6 @@ 
     protected function _get_state_name_by_ID($id)
     {
         global $wpdb;
-        return $wpdb->get_var($wpdb->prepare("SELECT STA_name FROM " . $wpdb->prefix . "esp_state WHERE STA_ID = %d", $id));
+        return $wpdb->get_var($wpdb->prepare("SELECT STA_name FROM ".$wpdb->prefix."esp_state WHERE STA_ID = %d", $id));
     }
 }

Indentation +64 added lines, -64 removed lines

@@ -11,69 +11,69 @@
  */
 class EE_DMS_4_6_0_billing_info extends EE_Data_Migration_Script_Stage_Table
 {
-    public function __construct()
-    {
-        global $wpdb;
-        $this->_old_table = $wpdb->postmeta;
-        $this->_pretty_name = esc_html__('Billing Info', 'event_espresso');
-        $this->_extra_where_sql = "WHERE meta_key LIKE 'billing_info_%'";
-        parent::__construct();
-    }
-    protected function _migrate_old_row($old_row)
-    {
-        $new_billing_info = array();
-        $old_billing_info = maybe_unserialize($old_row['meta_value']);
-        $gateway_name = str_replace("billing_info_", '', $old_row['meta_key']);
-        $repetitive_prefix = '_reg-page-billing-';
-        $repetitive_suffix = "-" . $gateway_name;
-        foreach ($old_billing_info as $old_input_name => $input_value) {
-            $old_input_name_important_part = str_replace(array( $repetitive_prefix, $repetitive_suffix ), array( '', ''), $old_input_name);
+	public function __construct()
+	{
+		global $wpdb;
+		$this->_old_table = $wpdb->postmeta;
+		$this->_pretty_name = esc_html__('Billing Info', 'event_espresso');
+		$this->_extra_where_sql = "WHERE meta_key LIKE 'billing_info_%'";
+		parent::__construct();
+	}
+	protected function _migrate_old_row($old_row)
+	{
+		$new_billing_info = array();
+		$old_billing_info = maybe_unserialize($old_row['meta_value']);
+		$gateway_name = str_replace("billing_info_", '', $old_row['meta_key']);
+		$repetitive_prefix = '_reg-page-billing-';
+		$repetitive_suffix = "-" . $gateway_name;
+		foreach ($old_billing_info as $old_input_name => $input_value) {
+			$old_input_name_important_part = str_replace(array( $repetitive_prefix, $repetitive_suffix ), array( '', ''), $old_input_name);
 
-            switch ($old_input_name_important_part) {
-                case 'fname':
-                    $new_input_name = 'first_name';
-                    break;
-                case 'lname':
-                    $new_input_name = 'last_name';
-                    break;
-                case 'state':
-                    // we used to store the state's id ,but now we just store the name
-                    $new_input_name = $old_input_name_important_part;
-                    $input_value = $this->_get_state_name_by_ID($input_value);
-                    break;
-                case 'card-nmbr':
-                    $new_input_name = 'credit_card';
-                    break;
-                case 'card-type':// paypal pro only
-                    $new_input_name = 'credit_card_type';
-                    break;
-                case 'card-exp-date-mnth':
-                    $new_input_name = 'exp_month';
-                    $input_value = '';
-                    break;
-                case 'card-exp-date-year':
-                    $new_input_name = 'exp_year';
-                    $input_value = 0;
-                    break;
-                case 'ccv-code':
-                    $new_input_name = 'cvv';
-                    break;
-                default:
-                    $new_input_name = $old_input_name_important_part;
-            }
-            $new_billing_info[ $new_input_name ] = $input_value;
-        }
-        update_post_meta($old_row['post_id'], $old_row['meta_key'], $new_billing_info);
-    }
-    /**
-     *
-     * @global type $wpdb
-     * @param int $id
-     * @return string
-     */
-    protected function _get_state_name_by_ID($id)
-    {
-        global $wpdb;
-        return $wpdb->get_var($wpdb->prepare("SELECT STA_name FROM " . $wpdb->prefix . "esp_state WHERE STA_ID = %d", $id));
-    }
+			switch ($old_input_name_important_part) {
+				case 'fname':
+					$new_input_name = 'first_name';
+					break;
+				case 'lname':
+					$new_input_name = 'last_name';
+					break;
+				case 'state':
+					// we used to store the state's id ,but now we just store the name
+					$new_input_name = $old_input_name_important_part;
+					$input_value = $this->_get_state_name_by_ID($input_value);
+					break;
+				case 'card-nmbr':
+					$new_input_name = 'credit_card';
+					break;
+				case 'card-type':// paypal pro only
+					$new_input_name = 'credit_card_type';
+					break;
+				case 'card-exp-date-mnth':
+					$new_input_name = 'exp_month';
+					$input_value = '';
+					break;
+				case 'card-exp-date-year':
+					$new_input_name = 'exp_year';
+					$input_value = 0;
+					break;
+				case 'ccv-code':
+					$new_input_name = 'cvv';
+					break;
+				default:
+					$new_input_name = $old_input_name_important_part;
+			}
+			$new_billing_info[ $new_input_name ] = $input_value;
+		}
+		update_post_meta($old_row['post_id'], $old_row['meta_key'], $new_billing_info);
+	}
+	/**
+	 *
+	 * @global type $wpdb
+	 * @param int $id
+	 * @return string
+	 */
+	protected function _get_state_name_by_ID($id)
+	{
+		global $wpdb;
+		return $wpdb->get_var($wpdb->prepare("SELECT STA_name FROM " . $wpdb->prefix . "esp_state WHERE STA_ID = %d", $id));
+	}
 }

core/data_migration_scripts/4_9_0_stages/EE_DMS_4_9_0_Answers_With_No_Registration.dmsstage.php

Spacing +3 added lines, -3 removed lines

@@ -48,9 +48,9 @@
     {
         global $wpdb;
         $wpdb->delete(
-            $wpdb->prefix . 'esp_answer',
-            array( 'REG_ID' => 0 ),
-            array( '%d' )
+            $wpdb->prefix.'esp_answer',
+            array('REG_ID' => 0),
+            array('%d')
         );
         $this->set_completed();
         return 1;

Indentation +38 added lines, -38 removed lines

@@ -12,44 +12,44 @@
  */
 class EE_DMS_4_9_0_Answers_With_No_Registration extends EE_Data_Migration_Script_Stage
 {
-    /**
-     * Just initializes the status of the migration
-     *
-     * @return EE_DMS_4_9_0_Answers_With_No_Registration
-     */
-    public function __construct()
-    {
-        $this->_pretty_name = esc_html__('Answer Cleanup', 'event_espresso');
-        parent::__construct();
-    }
+	/**
+	 * Just initializes the status of the migration
+	 *
+	 * @return EE_DMS_4_9_0_Answers_With_No_Registration
+	 */
+	public function __construct()
+	{
+		$this->_pretty_name = esc_html__('Answer Cleanup', 'event_espresso');
+		parent::__construct();
+	}
 
-    /**
-     * Counts the records to migrate; the public version may cache it
-     * @return int
-     */
-    protected function _count_records_to_migrate()
-    {
-        return 1;
-    }
+	/**
+	 * Counts the records to migrate; the public version may cache it
+	 * @return int
+	 */
+	protected function _count_records_to_migrate()
+	{
+		return 1;
+	}
 
-    /**
-     * IMPORTANT: if an error is encountered, or everything is finished, this stage should update its status property accordingly.
-     * Note: it should not alter the count of items migrated. That is done in the public function that calls this.
-     * IMPORTANT: The count of items migrated should ONLY be less than $num_items_to_migrate when it's the last migration step, otherwise it
-     * should always return $num_items_to_migrate. (Eg, if we're migrating attendees rows from the database, and $num_items_to_migrate is set to 50,
-     * then we SHOULD actually migrate 50 rows,but at very least we MUST report/return 50 items migrated)
-     * @param int $num_items_to_migrate
-     * @return int number of items ACTUALLY migrated
-     */
-    protected function _migration_step($num_items_to_migrate = 50)
-    {
-        global $wpdb;
-        $wpdb->delete(
-            $wpdb->prefix . 'esp_answer',
-            array( 'REG_ID' => 0 ),
-            array( '%d' )
-        );
-        $this->set_completed();
-        return 1;
-    }
+	/**
+	 * IMPORTANT: if an error is encountered, or everything is finished, this stage should update its status property accordingly.
+	 * Note: it should not alter the count of items migrated. That is done in the public function that calls this.
+	 * IMPORTANT: The count of items migrated should ONLY be less than $num_items_to_migrate when it's the last migration step, otherwise it
+	 * should always return $num_items_to_migrate. (Eg, if we're migrating attendees rows from the database, and $num_items_to_migrate is set to 50,
+	 * then we SHOULD actually migrate 50 rows,but at very least we MUST report/return 50 items migrated)
+	 * @param int $num_items_to_migrate
+	 * @return int number of items ACTUALLY migrated
+	 */
+	protected function _migration_step($num_items_to_migrate = 50)
+	{
+		global $wpdb;
+		$wpdb->delete(
+			$wpdb->prefix . 'esp_answer',
+			array( 'REG_ID' => 0 ),
+			array( '%d' )
+		);
+		$this->set_completed();
+		return 1;
+	}
 }

core/data_migration_scripts/EE_Data_Migration_Script_Stage.core.php

Indentation +90 added lines, -90 removed lines

@@ -37,103 +37,103 @@
  */
 abstract class EE_Data_Migration_Script_Stage extends EE_Data_Migration_Class_Base
 {
-    /**
-     * The migration script this is a stage of
-     *
-     * @var EE_Data_Migration_Script_Base
-     */
-    protected $_migration_script;
+	/**
+	 * The migration script this is a stage of
+	 *
+	 * @var EE_Data_Migration_Script_Base
+	 */
+	protected $_migration_script;
 
-    /**
-     * This should eb called to essentially 'finalize' construction of the stage.
-     * This isn't done on the main constructor in order to avoid repetitive code. Instead, this is
-     * called by EE_Data_Migration_Script_Base's __construct() method so children don't have to
-     *
-     * @param EE_Data_Migration_Script_Base $migration_script
-     */
-    public function _construct_finalize($migration_script)
-    {
-        $this->_migration_script = $migration_script;
-    }
+	/**
+	 * This should eb called to essentially 'finalize' construction of the stage.
+	 * This isn't done on the main constructor in order to avoid repetitive code. Instead, this is
+	 * called by EE_Data_Migration_Script_Base's __construct() method so children don't have to
+	 *
+	 * @param EE_Data_Migration_Script_Base $migration_script
+	 */
+	public function _construct_finalize($migration_script)
+	{
+		$this->_migration_script = $migration_script;
+	}
 
-    /**
-     * Migrates X old records to the new format. If a fatal error is encountered it is NOT caught here,
-     * but is propagated upwards for catching. So basically, the _migration_step() function implemented by children
-     * needs to catch exceptions and decide what's a fatal error and what isn't.
-     *
-     * @param int $num_items_to_migrate
-     * @return int
-     */
-    public function migration_step($num_items_to_migrate = 50)
-    {
-        // before we run the migration step, we want ot take note of warnings that get outputted
-        ob_start();
-        $items_migrated = $this->_migration_step($num_items_to_migrate);
-        $output = ob_get_contents();
-        ob_end_clean();
-        if ($output) {
-            $this->add_error($output);
-        }
-        $this->_records_migrated += $items_migrated;
-        return $items_migrated;
-    }
+	/**
+	 * Migrates X old records to the new format. If a fatal error is encountered it is NOT caught here,
+	 * but is propagated upwards for catching. So basically, the _migration_step() function implemented by children
+	 * needs to catch exceptions and decide what's a fatal error and what isn't.
+	 *
+	 * @param int $num_items_to_migrate
+	 * @return int
+	 */
+	public function migration_step($num_items_to_migrate = 50)
+	{
+		// before we run the migration step, we want ot take note of warnings that get outputted
+		ob_start();
+		$items_migrated = $this->_migration_step($num_items_to_migrate);
+		$output = ob_get_contents();
+		ob_end_clean();
+		if ($output) {
+			$this->add_error($output);
+		}
+		$this->_records_migrated += $items_migrated;
+		return $items_migrated;
+	}
 
 
-    /**
-     * IMPORTANT: if an error is encountered, or everything is finished, this stage should update its status property
-     * accordingly. Note: it should not alter the count of items migrated. That is done in the public function that
-     * calls this. IMPORTANT: The count of items migrated should ONLY be less than $num_items_to_migrate when it's the
-     * last migration step, otherwise it should always return $num_items_to_migrate. (Eg, if we're migrating attendees
-     * rows from the database, and $num_items_to_migrate is set to 50, then we SHOULD actually migrate 50 rows,but at
-     * very least we MUST report/return 50 items migrated)
-     *
-     * @param int $num_items_to_migrate
-     * @return int number of items ACTUALLY migrated
-     */
-    abstract protected function _migration_step($num_items_to_migrate = 50);
+	/**
+	 * IMPORTANT: if an error is encountered, or everything is finished, this stage should update its status property
+	 * accordingly. Note: it should not alter the count of items migrated. That is done in the public function that
+	 * calls this. IMPORTANT: The count of items migrated should ONLY be less than $num_items_to_migrate when it's the
+	 * last migration step, otherwise it should always return $num_items_to_migrate. (Eg, if we're migrating attendees
+	 * rows from the database, and $num_items_to_migrate is set to 50, then we SHOULD actually migrate 50 rows,but at
+	 * very least we MUST report/return 50 items migrated)
+	 *
+	 * @param int $num_items_to_migrate
+	 * @return int number of items ACTUALLY migrated
+	 */
+	abstract protected function _migration_step($num_items_to_migrate = 50);
 
-    /**
-     * Counts the records that have been migrated so far
-     *
-     * @return int
-     */
-    public function count_records_migrated()
-    {
-        return $this->_records_migrated;
-    }
+	/**
+	 * Counts the records that have been migrated so far
+	 *
+	 * @return int
+	 */
+	public function count_records_migrated()
+	{
+		return $this->_records_migrated;
+	}
 
-    /**
-     * returns an array of strings describing errors
-     *
-     * @return array
-     */
-    public function get_errors()
-    {
-        return $this->_errors;
-    }
+	/**
+	 * returns an array of strings describing errors
+	 *
+	 * @return array
+	 */
+	public function get_errors()
+	{
+		return $this->_errors;
+	}
 
 
-    /**
-     * Sets all of the properties of this script stage to match what's in the array, which is assumed
-     * to have been made from the properties_as_array() function.
-     *
-     * @param array $array_of_properties like what's produced from properties_as_array() method
-     */
-    public function instantiate_from_array_of_properties($array_of_properties)
-    {
-        unset($array_of_properties['class']);
-        foreach ($array_of_properties as $property_name => $property_value) {
-            $this->{$property_name} = $property_value;
-        }
-    }
+	/**
+	 * Sets all of the properties of this script stage to match what's in the array, which is assumed
+	 * to have been made from the properties_as_array() function.
+	 *
+	 * @param array $array_of_properties like what's produced from properties_as_array() method
+	 */
+	public function instantiate_from_array_of_properties($array_of_properties)
+	{
+		unset($array_of_properties['class']);
+		foreach ($array_of_properties as $property_name => $property_value) {
+			$this->{$property_name} = $property_value;
+		}
+	}
 
-    /**
-     * Gets the script this is a stage of
-     *
-     * @return EE_Data_Migration_Script_Base
-     */
-    protected function get_migration_script()
-    {
-        return $this->_migration_script;
-    }
+	/**
+	 * Gets the script this is a stage of
+	 *
+	 * @return EE_Data_Migration_Script_Base
+	 */
+	protected function get_migration_script()
+	{
+		return $this->_migration_script;
+	}
 }

core/admin/EE_Help_Tour.core.php

Spacing +3 added lines, -3 removed lines

@@ -256,8 +256,8 @@ 
     public function get_stops()
     {
         foreach ($this->_stops as $ind => $stop) {
-            if (! isset($stop['button_text'])) {
-                $this->_stops[ $ind ]['button_text'] = $this->_options['button_text'];
+            if ( ! isset($stop['button_text'])) {
+                $this->_stops[$ind]['button_text'] = $this->_options['button_text'];
             }
         }
         return $this->_stops;
@@ -277,6 +277,6 @@ 
                 $this->_options['pauseAfter'][] = $ind;
             }
         }
-        return apply_filters('FHEE__' . get_class($this) . '__get_options', $this->_options, $this);
+        return apply_filters('FHEE__'.get_class($this).'__get_options', $this->_options, $this);
     }
 }

Indentation +267 added lines, -267 removed lines

@@ -17,271 +17,271 @@
  */
 abstract class EE_Help_Tour extends EE_Base
 {
-    /**
-     * This is the label for the tour. It is used when regenerating restart buttons for the tour. Set this in the
-     * constructor of the child class.
-     *
-     * @access protected
-     * @var string
-     */
-    protected $_label = '';
-
-
-    /**
-     * This is the slug for the tour.  It should be unique from all tours and is used for starting a tour and setting
-     * cookies for the tour. Set this in the constructor of the child class.
-     *
-     * @access protected
-     * @var string
-     */
-    protected $_slug = '';
-
-
-    /**
-     * This will contain the formatted array for the stops that gets used by EE_Admin_Page->_add_help_tour() for
-     * setting up a tour on a given page. format for array is: array(
-     *        0 => array(
-     *            'id' => 'id_element', //if attached to an css id for an element then use this param. id's will take
-     *            precendence even if you also set class.
-     *            'class' => 'class_element', //if attached to a css class for an element anchoring the stop then use
-     *            this param. The first element for that class is the anchor. If the class or the id are empty then the
-     *            stop will be a modal on the page anchored to the main body.
-     *            'custom_class' => 'some_custom_class', //optional custom class to add for this stop.
-     *            'button_text' => 'custom text for button', //optional
-     *            'content' => 'The content for the stop', //required
-     *            'pause_after' => false, //indicate if you want the tour to pause after this stop and it will get
-     *            added to the pauseAfter global option array setup for the joyride instance. This is only applicable
-     *            when this tour has been set to run on timer.
-     *            'options' => array(
-     *                //override any of the global options set via the help_tour "option_callback" for the joyride
-     *                instance on this specific stop.
-     *                )
-     *            )
-     *        );
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_stops = array();
-
-
-    /**
-     * This contains any stop specific options for the tour.
-     * defaults are set but child classes can override.
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_options = array();
-
-
-    /**
-     * holds anything found in the request object (however we override any _gets with _post data).
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_req_data = array();
-
-
-    /**
-     * a flag that is set on init for whether this help_tour is happening on a caf install or not.
-     *
-     * @var boolean
-     */
-    protected $_is_caf = false;
-
-
-    /**
-     * _constructor
-     * initialized the tour object and sets up important properties required to setup the tour.
-     *
-     * @access public
-     * @param boolean $caf used to indicate if this tour is happening on caf install or not.
-     * @return void
-     */
-    public function __construct($caf = false)
-    {
-        $this->_is_caf = $caf;
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $this->_req_data = $request->requestParams();
-        $this->_set_tour_properties();
-        $this->_set_tour_stops();
-        $this->_set_tour_options();
-
-        // make sure the last tour stop has "end tour" for its button
-        $end = array_pop($this->_stops);
-        $end['button_text'] = esc_html__('End Tour', 'event_espresso');
-        // add back to stops
-        $this->_stops[] = $end;
-    }
-
-
-    /**
-     * required method that has the sole purpose of setting up the tour $_label and $_slug properties
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_tour_properties();
-
-
-    /**
-     * required method that's sole purpose is to setup the $_stops property
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_tour_stops();
-
-
-    /**
-     * The method can optionally be overridden by child classes to set the _options array if there are any default
-     * options the child wishes to override for a this tour. See property definition for more info
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_tour_options($options = array())
-    {
-        $defaults = array(
-            'tipLocation'           => 'bottom',
-            // 'top', 'bottom', 'right', 'left' in relation to parent
-            'nubPosition'           => 'auto',
-            // override on a per tooltip bases. can be "auto", "right", "top", "bottom", "left"
-            'tipAdjustmentY'        => 0,
-            // allow for adjustment of tip
-            'tipAdjustmentX'        => 0,
-            // allow for adjustment of tip
-            'scroll'                => true,
-            // whether to scrollTo the next step or not
-            'scrollSpeed'           => 300,
-            // Page scrolling speed in ms
-            'timer'                 => 0,
-            // 0 = off, all other numbers = time(ms)
-            'autoStart'             => true,
-            // true or false - false tour starts when restart called
-            'startTimerOnClick'     => true,
-            // true/false to start timer on first click
-            'nextButton'            => true,
-            // true/false for next button visibility
-            'button_text'           => esc_html__('Next', 'event_espresso'),
-            'tipAnimation'          => 'fade',
-            // 'pop' or 'fade' in each tip
-            'pauseAfter'            => array(),
-            // array of indexes where to pause the tour after
-            'tipAnimationFadeSpeed' => 300,
-            // if 'fade'- speed in ms of transition
-            'cookieMonster'         => true,
-            // true/false for whether cookies are used
-            'cookieName'            => $this->get_slug(),
-            // choose your own cookie name (setup will add the prefix for the specific page joyride)
-            // set to false or yoursite.com
-            'cookieDomain'          => false,
-            // Where the tip be attached if not inline
-            // 'tipContainer' => 'body',
-            'modal'                 => false,
-            // Whether to cover page with modal during the tour
-            'expose'                => false,
-            // Whether to expose the elements at each step in the tour (requires modal:true),
-            'postExposeCallback'    => 'EEHelpTour.postExposeCallback',
-            // A method to call after an element has been exposed
-            'preRideCallback'       => 'EEHelpTour_preRideCallback',
-            // A method to call before the tour starts (passed index, tip, and cloned exposed element)
-            'postRideCallback'      => 'EEHelpTour_postRideCallback',
-            // a method to call once the tour closes.  This will correspond to the name of a js method that will have to be defined in loaded js.
-            'preStepCallback'       => 'EEHelpTour_preStepCallback',
-            // A method to call before each step
-            'postStepCallback'      => 'EEHelpTour_postStepCallback',
-            // A method to call after each step (remember this will correspond with a js method that you will have to define in a js file BEFORE ee-help-tour.js loads, if the default methods do not exist, then ee-help-tour.js just substitues empty functions $.noop)/**/
-        );
-
-        $options = ! empty($options) && is_array($options) ? array_merge($defaults, $options) : $defaults;
-        $this->_options = $options;
-    }
-
-
-    /**
-     * getter functions to return all the properties for the tour.
-     */
-
-
-    /**
-     * get_slug
-     *
-     * @return string slug for the tour
-     */
-    public function get_slug()
-    {
-        if (empty($this->_slug)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'There is no slug set for the help tour class (%s). Make sure that the $_slug property is set in the class constructor',
-                        'event_espresso'
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $this->_slug;
-    }
-
-
-    /**
-     * get_label
-     *
-     * @return string
-     */
-    public function get_label()
-    {
-        if (empty($this->_label)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'There is no label set for the help tour class (%s). Make sure that the $_label property is set in the class constructor',
-                        'event_espresso'
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $this->_label;
-    }
-
-
-    /**
-     * get_stops
-     *
-     * @return array
-     */
-    public function get_stops()
-    {
-        foreach ($this->_stops as $ind => $stop) {
-            if (! isset($stop['button_text'])) {
-                $this->_stops[ $ind ]['button_text'] = $this->_options['button_text'];
-            }
-        }
-        return $this->_stops;
-    }
-
-
-    /**
-     * get options
-     *
-     * @return array
-     */
-    public function get_options()
-    {
-        // let's make sure there are not pauses set
-        foreach ($this->_stops as $ind => $stop) {
-            if (isset($stop['pause_after']) && $stop['pause_after']) {
-                $this->_options['pauseAfter'][] = $ind;
-            }
-        }
-        return apply_filters('FHEE__' . get_class($this) . '__get_options', $this->_options, $this);
-    }
+	/**
+	 * This is the label for the tour. It is used when regenerating restart buttons for the tour. Set this in the
+	 * constructor of the child class.
+	 *
+	 * @access protected
+	 * @var string
+	 */
+	protected $_label = '';
+
+
+	/**
+	 * This is the slug for the tour.  It should be unique from all tours and is used for starting a tour and setting
+	 * cookies for the tour. Set this in the constructor of the child class.
+	 *
+	 * @access protected
+	 * @var string
+	 */
+	protected $_slug = '';
+
+
+	/**
+	 * This will contain the formatted array for the stops that gets used by EE_Admin_Page->_add_help_tour() for
+	 * setting up a tour on a given page. format for array is: array(
+	 *        0 => array(
+	 *            'id' => 'id_element', //if attached to an css id for an element then use this param. id's will take
+	 *            precendence even if you also set class.
+	 *            'class' => 'class_element', //if attached to a css class for an element anchoring the stop then use
+	 *            this param. The first element for that class is the anchor. If the class or the id are empty then the
+	 *            stop will be a modal on the page anchored to the main body.
+	 *            'custom_class' => 'some_custom_class', //optional custom class to add for this stop.
+	 *            'button_text' => 'custom text for button', //optional
+	 *            'content' => 'The content for the stop', //required
+	 *            'pause_after' => false, //indicate if you want the tour to pause after this stop and it will get
+	 *            added to the pauseAfter global option array setup for the joyride instance. This is only applicable
+	 *            when this tour has been set to run on timer.
+	 *            'options' => array(
+	 *                //override any of the global options set via the help_tour "option_callback" for the joyride
+	 *                instance on this specific stop.
+	 *                )
+	 *            )
+	 *        );
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_stops = array();
+
+
+	/**
+	 * This contains any stop specific options for the tour.
+	 * defaults are set but child classes can override.
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_options = array();
+
+
+	/**
+	 * holds anything found in the request object (however we override any _gets with _post data).
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_req_data = array();
+
+
+	/**
+	 * a flag that is set on init for whether this help_tour is happening on a caf install or not.
+	 *
+	 * @var boolean
+	 */
+	protected $_is_caf = false;
+
+
+	/**
+	 * _constructor
+	 * initialized the tour object and sets up important properties required to setup the tour.
+	 *
+	 * @access public
+	 * @param boolean $caf used to indicate if this tour is happening on caf install or not.
+	 * @return void
+	 */
+	public function __construct($caf = false)
+	{
+		$this->_is_caf = $caf;
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$this->_req_data = $request->requestParams();
+		$this->_set_tour_properties();
+		$this->_set_tour_stops();
+		$this->_set_tour_options();
+
+		// make sure the last tour stop has "end tour" for its button
+		$end = array_pop($this->_stops);
+		$end['button_text'] = esc_html__('End Tour', 'event_espresso');
+		// add back to stops
+		$this->_stops[] = $end;
+	}
+
+
+	/**
+	 * required method that has the sole purpose of setting up the tour $_label and $_slug properties
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_tour_properties();
+
+
+	/**
+	 * required method that's sole purpose is to setup the $_stops property
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_tour_stops();
+
+
+	/**
+	 * The method can optionally be overridden by child classes to set the _options array if there are any default
+	 * options the child wishes to override for a this tour. See property definition for more info
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_tour_options($options = array())
+	{
+		$defaults = array(
+			'tipLocation'           => 'bottom',
+			// 'top', 'bottom', 'right', 'left' in relation to parent
+			'nubPosition'           => 'auto',
+			// override on a per tooltip bases. can be "auto", "right", "top", "bottom", "left"
+			'tipAdjustmentY'        => 0,
+			// allow for adjustment of tip
+			'tipAdjustmentX'        => 0,
+			// allow for adjustment of tip
+			'scroll'                => true,
+			// whether to scrollTo the next step or not
+			'scrollSpeed'           => 300,
+			// Page scrolling speed in ms
+			'timer'                 => 0,
+			// 0 = off, all other numbers = time(ms)
+			'autoStart'             => true,
+			// true or false - false tour starts when restart called
+			'startTimerOnClick'     => true,
+			// true/false to start timer on first click
+			'nextButton'            => true,
+			// true/false for next button visibility
+			'button_text'           => esc_html__('Next', 'event_espresso'),
+			'tipAnimation'          => 'fade',
+			// 'pop' or 'fade' in each tip
+			'pauseAfter'            => array(),
+			// array of indexes where to pause the tour after
+			'tipAnimationFadeSpeed' => 300,
+			// if 'fade'- speed in ms of transition
+			'cookieMonster'         => true,
+			// true/false for whether cookies are used
+			'cookieName'            => $this->get_slug(),
+			// choose your own cookie name (setup will add the prefix for the specific page joyride)
+			// set to false or yoursite.com
+			'cookieDomain'          => false,
+			// Where the tip be attached if not inline
+			// 'tipContainer' => 'body',
+			'modal'                 => false,
+			// Whether to cover page with modal during the tour
+			'expose'                => false,
+			// Whether to expose the elements at each step in the tour (requires modal:true),
+			'postExposeCallback'    => 'EEHelpTour.postExposeCallback',
+			// A method to call after an element has been exposed
+			'preRideCallback'       => 'EEHelpTour_preRideCallback',
+			// A method to call before the tour starts (passed index, tip, and cloned exposed element)
+			'postRideCallback'      => 'EEHelpTour_postRideCallback',
+			// a method to call once the tour closes.  This will correspond to the name of a js method that will have to be defined in loaded js.
+			'preStepCallback'       => 'EEHelpTour_preStepCallback',
+			// A method to call before each step
+			'postStepCallback'      => 'EEHelpTour_postStepCallback',
+			// A method to call after each step (remember this will correspond with a js method that you will have to define in a js file BEFORE ee-help-tour.js loads, if the default methods do not exist, then ee-help-tour.js just substitues empty functions $.noop)/**/
+		);
+
+		$options = ! empty($options) && is_array($options) ? array_merge($defaults, $options) : $defaults;
+		$this->_options = $options;
+	}
+
+
+	/**
+	 * getter functions to return all the properties for the tour.
+	 */
+
+
+	/**
+	 * get_slug
+	 *
+	 * @return string slug for the tour
+	 */
+	public function get_slug()
+	{
+		if (empty($this->_slug)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'There is no slug set for the help tour class (%s). Make sure that the $_slug property is set in the class constructor',
+						'event_espresso'
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $this->_slug;
+	}
+
+
+	/**
+	 * get_label
+	 *
+	 * @return string
+	 */
+	public function get_label()
+	{
+		if (empty($this->_label)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'There is no label set for the help tour class (%s). Make sure that the $_label property is set in the class constructor',
+						'event_espresso'
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $this->_label;
+	}
+
+
+	/**
+	 * get_stops
+	 *
+	 * @return array
+	 */
+	public function get_stops()
+	{
+		foreach ($this->_stops as $ind => $stop) {
+			if (! isset($stop['button_text'])) {
+				$this->_stops[ $ind ]['button_text'] = $this->_options['button_text'];
+			}
+		}
+		return $this->_stops;
+	}
+
+
+	/**
+	 * get options
+	 *
+	 * @return array
+	 */
+	public function get_options()
+	{
+		// let's make sure there are not pauses set
+		foreach ($this->_stops as $ind => $stop) {
+			if (isset($stop['pause_after']) && $stop['pause_after']) {
+				$this->_options['pauseAfter'][] = $ind;
+			}
+		}
+		return apply_filters('FHEE__' . get_class($this) . '__get_options', $this->_options, $this);
+	}
 }

core/libraries/messages/EE_Message_Factory.lib.php

Spacing +2 added lines, -2 removed lines

@@ -51,7 +51,7 @@ 
     public static function instance(EE_Message_Resource_Manager $Message_Resource_Manager)
     {
         // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Message_Factory) {
+        if ( ! self::$_instance instanceof EE_Message_Factory) {
             self::$_instance = new EE_Message_Factory($Message_Resource_Manager);
         }
         return self::$_instance;
@@ -127,7 +127,7 @@ 
     protected function _create($props_n_values = array())
     {
         $new_instance = false;
-        if (! empty($props_n_values['MSG_ID'])) {
+        if ( ! empty($props_n_values['MSG_ID'])) {
             $message = EE_Message::new_instance_from_db($props_n_values);
         } else {
             $message = EE_Message::new_instance($props_n_values);

Indentation +171 added lines, -171 removed lines

@@ -13,175 +13,175 @@
  */
 class EE_Message_Factory
 {
-    /**
-     * @type EE_Message_Factory $_instance
-     */
-    protected static $_instance = null;
-
-
-    /**
-     * @type EE_Message_Resource_Manager $_message_resource_manager
-     */
-    protected $_message_resource_manager;
-
-
-
-    /**
-     * EE_Message_Factory constructor.
-     *
-     * @access protected
-     * @param \EE_Message_Resource_Manager $Message_Resource_Manager
-     */
-    protected function __construct(
-        EE_Message_Resource_Manager $Message_Resource_Manager
-    ) {
-        $this->_message_resource_manager = $Message_Resource_Manager;
-    }
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @param \EE_Message_Resource_Manager $Message_Resource_Manager
-     * @return \EE_Message_Factory instance
-     */
-    public static function instance(EE_Message_Resource_Manager $Message_Resource_Manager)
-    {
-        // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Message_Factory) {
-            self::$_instance = new EE_Message_Factory($Message_Resource_Manager);
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     * @access public
-     * @param  array $props_n_values
-     * @return EE_Message
-     */
-    public static function create($props_n_values = array())
-    {
-        /** @type EE_Message_Factory $Message_Factory */
-        $Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
-        return $Message_Factory->_create($props_n_values);
-    }
-
-
-
-    /**
-     * @access public
-     * @param  \EE_Message $message
-     * @return \EE_Message
-     * @throws \EE_Error
-     */
-    public static function set_messenger_and_message_type(EE_Message $message)
-    {
-        /** @type EE_Message_Factory $Message_Factory */
-        $Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
-        return $Message_Factory->_set_messenger_and_message_type($message);
-    }
-
-
-
-    /**
-     * @access public
-     * @param  \EE_Message $message
-     * @return \EE_Message
-     * @throws \EE_Error
-     */
-    public static function set_messenger(EE_Message $message)
-    {
-        /** @type EE_Message_Factory $Message_Factory */
-        $Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
-        return $Message_Factory->_set_messenger($message);
-    }
-
-
-
-    /**
-     * @access public
-     * @param  \EE_Message $message
-     * @return \EE_Message
-     * @throws \EE_Error
-     */
-    public static function set_message_type(EE_Message $message)
-    {
-        /** @type EE_Message_Factory $Message_Factory */
-        $Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
-        return $Message_Factory->_set_message_type($message);
-    }
-
-
-
-    /**
-     * @access protected
-     * @param  array $props_n_values
-     * @return \EE_Message
-     * @throws \EE_Error
-     */
-    protected function _create($props_n_values = array())
-    {
-        $new_instance = false;
-        if (! empty($props_n_values['MSG_ID'])) {
-            $message = EE_Message::new_instance_from_db($props_n_values);
-        } else {
-            $message = EE_Message::new_instance($props_n_values);
-            $new_instance = true;
-        }
-        return $this->_set_messenger_and_message_type($message, $new_instance);
-    }
-
-
-
-    /**
-     * @access public
-     * @param  \EE_Message $message
-     * @param  bool        $new_instance Whether the message type was setup from the database (false) or not (true)
-     * @return \EE_Message
-     * @throws \EE_Error
-     */
-    protected function _set_messenger_and_message_type(EE_Message $message, $new_instance = false)
-    {
-        $message = $this->_set_messenger($message);
-        $message = $this->_set_message_type($message, $new_instance);
-        return $message;
-    }
-
-
-
-    /**
-     * @access protected
-     * @param  \EE_Message $message
-     * @return \EE_Message
-     * @throws \EE_Error
-     */
-    protected function _set_messenger(EE_Message $message)
-    {
-        $messenger = $this->_message_resource_manager->get_messenger($message->messenger());
-        if ($messenger instanceof EE_messenger) {
-            $message->set_messenger_object($messenger);
-        }
-        return $message;
-    }
-
-
-
-    /**
-     * @access protected
-     * @param  \EE_Message $message
-     * @param  bool        $new_instance Whether the message type was setup from the database (false) or not (true)
-     * @return \EE_Message
-     * @throws \EE_Error
-     */
-    protected function _set_message_type(EE_Message $message, $new_instance = false)
-    {
-        $message_type = $this->_message_resource_manager->get_message_type($message->message_type());
-        if ($message_type instanceof EE_message_type) {
-            $message->set_message_type_object($message_type, $new_instance);
-        }
-        return $message;
-    }
+	/**
+	 * @type EE_Message_Factory $_instance
+	 */
+	protected static $_instance = null;
+
+
+	/**
+	 * @type EE_Message_Resource_Manager $_message_resource_manager
+	 */
+	protected $_message_resource_manager;
+
+
+
+	/**
+	 * EE_Message_Factory constructor.
+	 *
+	 * @access protected
+	 * @param \EE_Message_Resource_Manager $Message_Resource_Manager
+	 */
+	protected function __construct(
+		EE_Message_Resource_Manager $Message_Resource_Manager
+	) {
+		$this->_message_resource_manager = $Message_Resource_Manager;
+	}
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @param \EE_Message_Resource_Manager $Message_Resource_Manager
+	 * @return \EE_Message_Factory instance
+	 */
+	public static function instance(EE_Message_Resource_Manager $Message_Resource_Manager)
+	{
+		// check if class object is instantiated, and instantiated properly
+		if (! self::$_instance instanceof EE_Message_Factory) {
+			self::$_instance = new EE_Message_Factory($Message_Resource_Manager);
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 * @access public
+	 * @param  array $props_n_values
+	 * @return EE_Message
+	 */
+	public static function create($props_n_values = array())
+	{
+		/** @type EE_Message_Factory $Message_Factory */
+		$Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
+		return $Message_Factory->_create($props_n_values);
+	}
+
+
+
+	/**
+	 * @access public
+	 * @param  \EE_Message $message
+	 * @return \EE_Message
+	 * @throws \EE_Error
+	 */
+	public static function set_messenger_and_message_type(EE_Message $message)
+	{
+		/** @type EE_Message_Factory $Message_Factory */
+		$Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
+		return $Message_Factory->_set_messenger_and_message_type($message);
+	}
+
+
+
+	/**
+	 * @access public
+	 * @param  \EE_Message $message
+	 * @return \EE_Message
+	 * @throws \EE_Error
+	 */
+	public static function set_messenger(EE_Message $message)
+	{
+		/** @type EE_Message_Factory $Message_Factory */
+		$Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
+		return $Message_Factory->_set_messenger($message);
+	}
+
+
+
+	/**
+	 * @access public
+	 * @param  \EE_Message $message
+	 * @return \EE_Message
+	 * @throws \EE_Error
+	 */
+	public static function set_message_type(EE_Message $message)
+	{
+		/** @type EE_Message_Factory $Message_Factory */
+		$Message_Factory = EE_Registry::instance()->load_lib('Message_Factory');
+		return $Message_Factory->_set_message_type($message);
+	}
+
+
+
+	/**
+	 * @access protected
+	 * @param  array $props_n_values
+	 * @return \EE_Message
+	 * @throws \EE_Error
+	 */
+	protected function _create($props_n_values = array())
+	{
+		$new_instance = false;
+		if (! empty($props_n_values['MSG_ID'])) {
+			$message = EE_Message::new_instance_from_db($props_n_values);
+		} else {
+			$message = EE_Message::new_instance($props_n_values);
+			$new_instance = true;
+		}
+		return $this->_set_messenger_and_message_type($message, $new_instance);
+	}
+
+
+
+	/**
+	 * @access public
+	 * @param  \EE_Message $message
+	 * @param  bool        $new_instance Whether the message type was setup from the database (false) or not (true)
+	 * @return \EE_Message
+	 * @throws \EE_Error
+	 */
+	protected function _set_messenger_and_message_type(EE_Message $message, $new_instance = false)
+	{
+		$message = $this->_set_messenger($message);
+		$message = $this->_set_message_type($message, $new_instance);
+		return $message;
+	}
+
+
+
+	/**
+	 * @access protected
+	 * @param  \EE_Message $message
+	 * @return \EE_Message
+	 * @throws \EE_Error
+	 */
+	protected function _set_messenger(EE_Message $message)
+	{
+		$messenger = $this->_message_resource_manager->get_messenger($message->messenger());
+		if ($messenger instanceof EE_messenger) {
+			$message->set_messenger_object($messenger);
+		}
+		return $message;
+	}
+
+
+
+	/**
+	 * @access protected
+	 * @param  \EE_Message $message
+	 * @param  bool        $new_instance Whether the message type was setup from the database (false) or not (true)
+	 * @return \EE_Message
+	 * @throws \EE_Error
+	 */
+	protected function _set_message_type(EE_Message $message, $new_instance = false)
+	{
+		$message_type = $this->_message_resource_manager->get_message_type($message->message_type());
+		if ($message_type instanceof EE_message_type) {
+			$message->set_message_type_object($message_type, $new_instance);
+		}
+		return $message;
+	}
 }