eventespresso / event-espresso-core

core/middleware/EE_Detect_File_Editor_Request.core.php

Indentation +23 added lines, -23 removed lines

@@ -14,28 +14,28 @@
 class EE_Detect_File_Editor_Request extends EE_Middleware
 {
 
-    /**
-     * @deprecated
-     * @param EE_Request  $request
-     * @param EE_Response $response
-     * @return EE_Response
-     */
-    public function handle_request(EE_Request $request, EE_Response $response)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace',
-                    'event_espresso'
-                ),
-                'EventEspresso\core\services\request\middleware\DetectFileEditorRequest',
-                '\core\services\request',
-                'EventEspresso\core\services\request'
-            ),
-            '4.9.52'
-        );
-        return $response;
-    }
+	/**
+	 * @deprecated
+	 * @param EE_Request  $request
+	 * @param EE_Response $response
+	 * @return EE_Response
+	 */
+	public function handle_request(EE_Request $request, EE_Response $response)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'This class is deprecated. Please use %1$s instead. All Event Espresso request stack classes have been moved to %2$s and are now under the %3$s namespace',
+					'event_espresso'
+				),
+				'EventEspresso\core\services\request\middleware\DetectFileEditorRequest',
+				'\core\services\request',
+				'EventEspresso\core\services\request'
+			),
+			'4.9.52'
+		);
+		return $response;
+	}
 
 }

core/services/activation/ActivationHistory.php

Indentation +276 added lines, -276 removed lines

@@ -20,282 +20,282 @@
 class ActivationHistory
 {
 
-    /**
-     * option name for recording the activation history for core
-     */
-    const EE_ACTIVATION_HISTORY_OPTION_NAME = 'espresso_db_update';
-
-    /**
-     * option name for indicating that the current request is for activating core
-     */
-    const EE_ACTIVATION_INDICATOR_OPTION_NAME = 'ee_espresso_activation';
-
-    /**
-     * stores the values for the activation history option name for core or an addon
-     *
-     * @var string $activation_history_option_name
-     */
-    protected $activation_history_option_name;
-
-    /**
-     * stores the values for the activation indicator option name for core or an addon
-     *
-     * @var string $activation_indicator_option_name
-     */
-    protected $activation_indicator_option_name;
-
-    /**
-     * the current version for core or an addon, like "1.2.3.p"
-     *
-     * @var string $current_version
-     */
-    protected $current_version;
-
-    /**
-     * array of activated versions and activation dates for core or an addon
-     *
-     * @var array $version_history
-     */
-    protected $version_history;
-
-
-
-    /**
-     * ActivationHistory constructor.
-     *
-     * @param string $activation_history_option_name
-     * @param string $activation_indicator_option_name
-     * @param string $current_version
-     * @throws InvalidDataTypeException
-     */
-    public function __construct(
-        $activation_history_option_name = '',
-        $activation_indicator_option_name = '',
-        $current_version = ''
-    ) {
-        $this->setActivationHistoryOptionName($activation_history_option_name);
-        $this->setActivationIndicatorOptionName($activation_indicator_option_name);
-        $this->setCurrentVersion($current_version);
-        $this->version_history = (array) get_option($this->activation_history_option_name, array());
-    }
-
-
-
-    /**
-     * @param string $activation_history_option_name
-     * @throws InvalidDataTypeException
-     */
-    protected function setActivationHistoryOptionName($activation_history_option_name)
-    {
-        if(! is_string($activation_history_option_name)) {
-            throw new InvalidDataTypeException(
-                '$activation_history_option_name',
-                $activation_history_option_name,
-                'string'
-            );
-        }
-        $this->activation_history_option_name = $activation_history_option_name !== ''
-            ? $activation_history_option_name
-            : ActivationHistory::EE_ACTIVATION_HISTORY_OPTION_NAME;
-    }
-
-
-
-    /**
-     * @param string $activation_indicator_option_name
-     * @throws InvalidDataTypeException
-     */
-    protected function setActivationIndicatorOptionName($activation_indicator_option_name)
-    {
-        if (! is_string($activation_indicator_option_name)) {
-            throw new InvalidDataTypeException(
-                '$activation_indicator_option_name',
-                $activation_indicator_option_name,
-                'string'
-            );
-        }
-        $this->activation_indicator_option_name = $activation_indicator_option_name !== ''
-            ? $activation_indicator_option_name
-            : ActivationHistory::EE_ACTIVATION_INDICATOR_OPTION_NAME;
-    }
-
-
-
-    /**
-     * @param string $current_version
-     * @throws InvalidDataTypeException
-     */
-    protected function setCurrentVersion($current_version)
-    {
-        if (! is_string($current_version)) {
-            throw new InvalidDataTypeException(
-                '$current_version',
-                $current_version,
-                'string'
-            );
-        }
-        $this->current_version = $current_version !== ''
-            ? $current_version
-            : espresso_version();
-    }
-
-
-
-
-    /**
-     * Gets the wp option which stores the activation history for this addon
-     *
-     * @return array|bool
-     */
-    public function getVersionHistory()
-    {
-        return $this->version_history;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function getCurrentVersion()
-    {
-        return $this->current_version;
-    }
-
-
-
-    /**
-     * Gets the most recently active version listed in the activation history,
-     * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
-     *
-     * @return string
-     */
-    public function getMostRecentActiveVersion()
-    {
-        $most_recently_active_version_activation = '1970-01-01 00:00:00';
-        $most_recently_active_version = '0.0.0.dev.000';
-        if (is_array($this->version_history) && count($this->version_history)) {
-            foreach ($this->version_history as $version => $times_activated) {
-                // check there is a record of when this version was activated.
-                // Otherwise, mark it as unknown
-                if (! $times_activated) {
-                    $times_activated = array('unknown-date');
-                }
-                if (is_string($times_activated)) {
-                    $times_activated = array($times_activated);
-                }
-                foreach ($times_activated as $an_activation) {
-                    if (
-                        $an_activation !== 'unknown-date'
-                        && $an_activation > $most_recently_active_version_activation
-                    ) {
-                        $most_recently_active_version = $version;
-                        $most_recently_active_version_activation = $an_activation === 'unknown-date'
-                            ? '1970-01-01 00:00:00'
-                            : $an_activation;
-                    }
-                }
-            }
-        }
-        return $most_recently_active_version;
-    }
-
-
-
-    /**
-     * Updates the version history for this addon
-     *
-     * @param array|null $version_history
-     * @param string     $current_version
-     * @param bool       $add_current
-     * @return bool success
-     */
-    public function updateActivationHistory($version_history = null, $current_version = '', $add_current  = true)
-    {
-        if ($version_history !== null) {
-            $this->version_history = $version_history;
-        }
-        if ($current_version !== '') {
-            $this->current_version = $current_version;
-        }
-        if(! isset($this->version_history[$this->current_version])) {
-            $this->version_history[$this->current_version] =   array();
-        }
-        if($add_current) {
-            $this->version_history[$this->current_version][] = date('Y-m-d H:i:s');
-        }
-        return update_option(
-            $this->activation_history_option_name,
-            $this->version_history
-        );
-    }
-
-
-
-    /**
-     * Updates the version history for this addon
-     *
-     * @param array|null $version_history
-     * @param string     $current_version
-     * @return boolean success
-     */
-    public function addActivationHistory($version_history = null, $current_version = '')
-    {
-        if ($version_history !== null) {
-            $this->version_history = $version_history;
-        }
-        if ($current_version !== '') {
-            $this->current_version = $current_version;
-        }
-        return add_option(
-            $this->activation_history_option_name,
-            $this->version_history,
-            '',
-            'no'
-        );
-    }
-
-
-
-    /**
-     * @return bool
-     */
-    public function getActivationIndicator()
-    {
-        return get_option($this->activation_indicator_option_name, false);
-    }
-
-
-
-    /**
-     * @return bool
-     */
-    public function setActivationIndicator()
-    {
-        return update_option($this->activation_indicator_option_name, true);
-    }
-
-
-
-    /**
-     * @return bool
-     */
-    public function deleteActivationIndicator()
-    {
-        return delete_option($this->activation_indicator_option_name);
-    }
-
-
-
-    /**
-     * DANGER!!! HOPE YOU KNOW WHAT YOU ARE DOING !!!
-     *
-     * @return bool
-     */
-    public function deleteActivationHistory()
-    {
-        return delete_option($this->activation_history_option_name);
-    }
+	/**
+	 * option name for recording the activation history for core
+	 */
+	const EE_ACTIVATION_HISTORY_OPTION_NAME = 'espresso_db_update';
+
+	/**
+	 * option name for indicating that the current request is for activating core
+	 */
+	const EE_ACTIVATION_INDICATOR_OPTION_NAME = 'ee_espresso_activation';
+
+	/**
+	 * stores the values for the activation history option name for core or an addon
+	 *
+	 * @var string $activation_history_option_name
+	 */
+	protected $activation_history_option_name;
+
+	/**
+	 * stores the values for the activation indicator option name for core or an addon
+	 *
+	 * @var string $activation_indicator_option_name
+	 */
+	protected $activation_indicator_option_name;
+
+	/**
+	 * the current version for core or an addon, like "1.2.3.p"
+	 *
+	 * @var string $current_version
+	 */
+	protected $current_version;
+
+	/**
+	 * array of activated versions and activation dates for core or an addon
+	 *
+	 * @var array $version_history
+	 */
+	protected $version_history;
+
+
+
+	/**
+	 * ActivationHistory constructor.
+	 *
+	 * @param string $activation_history_option_name
+	 * @param string $activation_indicator_option_name
+	 * @param string $current_version
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct(
+		$activation_history_option_name = '',
+		$activation_indicator_option_name = '',
+		$current_version = ''
+	) {
+		$this->setActivationHistoryOptionName($activation_history_option_name);
+		$this->setActivationIndicatorOptionName($activation_indicator_option_name);
+		$this->setCurrentVersion($current_version);
+		$this->version_history = (array) get_option($this->activation_history_option_name, array());
+	}
+
+
+
+	/**
+	 * @param string $activation_history_option_name
+	 * @throws InvalidDataTypeException
+	 */
+	protected function setActivationHistoryOptionName($activation_history_option_name)
+	{
+		if(! is_string($activation_history_option_name)) {
+			throw new InvalidDataTypeException(
+				'$activation_history_option_name',
+				$activation_history_option_name,
+				'string'
+			);
+		}
+		$this->activation_history_option_name = $activation_history_option_name !== ''
+			? $activation_history_option_name
+			: ActivationHistory::EE_ACTIVATION_HISTORY_OPTION_NAME;
+	}
+
+
+
+	/**
+	 * @param string $activation_indicator_option_name
+	 * @throws InvalidDataTypeException
+	 */
+	protected function setActivationIndicatorOptionName($activation_indicator_option_name)
+	{
+		if (! is_string($activation_indicator_option_name)) {
+			throw new InvalidDataTypeException(
+				'$activation_indicator_option_name',
+				$activation_indicator_option_name,
+				'string'
+			);
+		}
+		$this->activation_indicator_option_name = $activation_indicator_option_name !== ''
+			? $activation_indicator_option_name
+			: ActivationHistory::EE_ACTIVATION_INDICATOR_OPTION_NAME;
+	}
+
+
+
+	/**
+	 * @param string $current_version
+	 * @throws InvalidDataTypeException
+	 */
+	protected function setCurrentVersion($current_version)
+	{
+		if (! is_string($current_version)) {
+			throw new InvalidDataTypeException(
+				'$current_version',
+				$current_version,
+				'string'
+			);
+		}
+		$this->current_version = $current_version !== ''
+			? $current_version
+			: espresso_version();
+	}
+
+
+
+
+	/**
+	 * Gets the wp option which stores the activation history for this addon
+	 *
+	 * @return array|bool
+	 */
+	public function getVersionHistory()
+	{
+		return $this->version_history;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function getCurrentVersion()
+	{
+		return $this->current_version;
+	}
+
+
+
+	/**
+	 * Gets the most recently active version listed in the activation history,
+	 * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
+	 *
+	 * @return string
+	 */
+	public function getMostRecentActiveVersion()
+	{
+		$most_recently_active_version_activation = '1970-01-01 00:00:00';
+		$most_recently_active_version = '0.0.0.dev.000';
+		if (is_array($this->version_history) && count($this->version_history)) {
+			foreach ($this->version_history as $version => $times_activated) {
+				// check there is a record of when this version was activated.
+				// Otherwise, mark it as unknown
+				if (! $times_activated) {
+					$times_activated = array('unknown-date');
+				}
+				if (is_string($times_activated)) {
+					$times_activated = array($times_activated);
+				}
+				foreach ($times_activated as $an_activation) {
+					if (
+						$an_activation !== 'unknown-date'
+						&& $an_activation > $most_recently_active_version_activation
+					) {
+						$most_recently_active_version = $version;
+						$most_recently_active_version_activation = $an_activation === 'unknown-date'
+							? '1970-01-01 00:00:00'
+							: $an_activation;
+					}
+				}
+			}
+		}
+		return $most_recently_active_version;
+	}
+
+
+
+	/**
+	 * Updates the version history for this addon
+	 *
+	 * @param array|null $version_history
+	 * @param string     $current_version
+	 * @param bool       $add_current
+	 * @return bool success
+	 */
+	public function updateActivationHistory($version_history = null, $current_version = '', $add_current  = true)
+	{
+		if ($version_history !== null) {
+			$this->version_history = $version_history;
+		}
+		if ($current_version !== '') {
+			$this->current_version = $current_version;
+		}
+		if(! isset($this->version_history[$this->current_version])) {
+			$this->version_history[$this->current_version] =   array();
+		}
+		if($add_current) {
+			$this->version_history[$this->current_version][] = date('Y-m-d H:i:s');
+		}
+		return update_option(
+			$this->activation_history_option_name,
+			$this->version_history
+		);
+	}
+
+
+
+	/**
+	 * Updates the version history for this addon
+	 *
+	 * @param array|null $version_history
+	 * @param string     $current_version
+	 * @return boolean success
+	 */
+	public function addActivationHistory($version_history = null, $current_version = '')
+	{
+		if ($version_history !== null) {
+			$this->version_history = $version_history;
+		}
+		if ($current_version !== '') {
+			$this->current_version = $current_version;
+		}
+		return add_option(
+			$this->activation_history_option_name,
+			$this->version_history,
+			'',
+			'no'
+		);
+	}
+
+
+
+	/**
+	 * @return bool
+	 */
+	public function getActivationIndicator()
+	{
+		return get_option($this->activation_indicator_option_name, false);
+	}
+
+
+
+	/**
+	 * @return bool
+	 */
+	public function setActivationIndicator()
+	{
+		return update_option($this->activation_indicator_option_name, true);
+	}
+
+
+
+	/**
+	 * @return bool
+	 */
+	public function deleteActivationIndicator()
+	{
+		return delete_option($this->activation_indicator_option_name);
+	}
+
+
+
+	/**
+	 * DANGER!!! HOPE YOU KNOW WHAT YOU ARE DOING !!!
+	 *
+	 * @return bool
+	 */
+	public function deleteActivationHistory()
+	{
+		return delete_option($this->activation_history_option_name);
+	}
 
 
 

Spacing +8 added lines, -8 removed lines

@@ -87,7 +87,7 @@ 
      */
     protected function setActivationHistoryOptionName($activation_history_option_name)
     {
-        if(! is_string($activation_history_option_name)) {
+        if ( ! is_string($activation_history_option_name)) {
             throw new InvalidDataTypeException(
                 '$activation_history_option_name',
                 $activation_history_option_name,
@@ -107,7 +107,7 @@ 
      */
     protected function setActivationIndicatorOptionName($activation_indicator_option_name)
     {
-        if (! is_string($activation_indicator_option_name)) {
+        if ( ! is_string($activation_indicator_option_name)) {
             throw new InvalidDataTypeException(
                 '$activation_indicator_option_name',
                 $activation_indicator_option_name,
@@ -127,7 +127,7 @@ 
      */
     protected function setCurrentVersion($current_version)
     {
-        if (! is_string($current_version)) {
+        if ( ! is_string($current_version)) {
             throw new InvalidDataTypeException(
                 '$current_version',
                 $current_version,
@@ -178,7 +178,7 @@ 
             foreach ($this->version_history as $version => $times_activated) {
                 // check there is a record of when this version was activated.
                 // Otherwise, mark it as unknown
-                if (! $times_activated) {
+                if ( ! $times_activated) {
                     $times_activated = array('unknown-date');
                 }
                 if (is_string($times_activated)) {
@@ -210,7 +210,7 @@ 
      * @param bool       $add_current
      * @return bool success
      */
-    public function updateActivationHistory($version_history = null, $current_version = '', $add_current  = true)
+    public function updateActivationHistory($version_history = null, $current_version = '', $add_current = true)
     {
         if ($version_history !== null) {
             $this->version_history = $version_history;
@@ -218,10 +218,10 @@ 
         if ($current_version !== '') {
             $this->current_version = $current_version;
         }
-        if(! isset($this->version_history[$this->current_version])) {
-            $this->version_history[$this->current_version] =   array();
+        if ( ! isset($this->version_history[$this->current_version])) {
+            $this->version_history[$this->current_version] = array();
         }
-        if($add_current) {
+        if ($add_current) {
             $this->version_history[$this->current_version][] = date('Y-m-d H:i:s');
         }
         return update_option(

core/services/activation/InitializeAddon.php

Indentation +138 added lines, -138 removed lines

@@ -24,144 +24,144 @@
 class InitializeAddon implements InitializeInterface
 {
 
-    /**
-     * @var EE_Addon $addon
-     */
-    private $addon;
-
-    /**
-     * @var EE_Data_Migration_Manager $data_migration_manager
-     */
-    private $data_migration_manager;
-
-    /**
-     * @var EE_Maintenance_Mode $maintenance_mode
-     */
-    private $maintenance_mode;
-
-    /**
-     * @var EE_Registry $registry
-     */
-    private $registry;
-
-
-
-    /**
-     * InitializeDatabase constructor.
-     *
-     * @param EE_Addon $addon
-     * @param EE_Data_Migration_Manager $data_migration_manager
-     * @param EE_Maintenance_Mode       $maintenance_mode
-     * @param EE_Registry $registry
-     */
-    public function __construct(
-        EE_Addon $addon,
-        EE_Data_Migration_Manager $data_migration_manager,
-        EE_Maintenance_Mode $maintenance_mode,
-        EE_Registry $registry
-    ) {
-        $this->addon = $addon;
-        $this->data_migration_manager = $data_migration_manager;
-        $this->maintenance_mode = $maintenance_mode;
-        $this->registry = $registry;
-    }
-
-
-    /**
-     * Takes care of double-checking that we're not in maintenance mode, and then
-     * initializing this addon's necessary initial data. This is called by default on new activations
-     * and reactivations
-     *
-     * @param boolean $verify_schema whether to verify the database's schema for this addon, or just its data.
-     *                               This is a resource-intensive job so we prefer to only do it when necessary
-     * @return void
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    public function initialize($verify_schema = true)
-    {
-        if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
-            if ($verify_schema) {
-                $this->initializeDatabase();
-            }
-            $this->initializeDefaultData();
-            //@todo: this will probably need to be adjusted in 4.4 as the array changed formats I believe
-            $this->data_migration_manager->update_current_database_state_to(
-                array(
-                    'slug'    => $this->addon->name(),
-                    'version' => $this->addon->version()
-                )
-            );
-            //in case there are lots of addons being activated at once, let's force garbage collection
-            //to help avoid memory limit errors
-            //EEH_Debug_Tools::instance()->measure_memory( 'db content initialized for ' . get_class( $this), true );
-            gc_collect_cycles();
-        } else {
-            //ask the data migration manager to init this addon's data
-            //when migrations are finished because we can't do it now
-            $this->data_migration_manager->enqueue_db_initialization_for($this->addon->name());
-        }
-    }
-
-
-    /**
-     * Used to setup this addon's database tables, but not necessarily any default
-     * data in them. The default is to actually use the most up-to-date data migration script
-     * for this addon, and just use its schema_changes_before_migration() and schema_changes_after_migration()
-     * methods to setup the db.
-     *
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    public function initializeDatabase()
-    {
-        //find the migration script that sets the database to be compatible with the code
-        $current_dms_name = $this->data_migration_manager->get_most_up_to_date_dms($this->addon->name());
-        if ($current_dms_name) {
-            $current_data_migration_script = $this->registry->load_dms($current_dms_name);
-            $current_data_migration_script->set_migrating(false);
-            $current_data_migration_script->schema_changes_before_migration();
-            $current_data_migration_script->schema_changes_after_migration();
-            if ($current_data_migration_script->get_errors()) {
-                foreach ($current_data_migration_script->get_errors() as $error) {
-                    EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
-                }
-            }
-        }
-        //if not DMS was found that should be ok. This addon just doesn't require any database changes
-        $this->data_migration_manager->update_current_database_state_to(
-            array(
-                'slug'    => $this->addon->name(),
-                'version' => $this->addon->version()
-            )
-        );
-    }
-
-
-
-    /**
-     * If you want to setup default data for the addon, override this method, and call
-     * parent::initialize_default_data() from within it. This is normally called
-     * from EE_Addon::initialize_db_if_no_migrations_required(), just after EE_Addon::initialize_db()
-     * and should verify default data is present (but this is also called
-     * on reactivations and just after migrations, so please verify you actually want
-     * to ADD default data, because it may already be present).
-     * However, please call this parent (currently it just fires a hook which other
-     * addons may be depending on)
-     */
-    public function initializeDefaultData()
-    {
-        /**
-         * Called when an addon is ensuring its default data is set (possibly called
-         * on a reactivation, so first check for the absence of other data before setting
-         * default data)
-         *
-         * @param EE_Addon $addon the addon that called this
-         */
-        do_action('AHEE__EE_Addon__initialize_default_data__begin', $this);
-        //override to insert default data. It is safe to use the models here
-        //because the site should not be in maintenance mode
-    }
+	/**
+	 * @var EE_Addon $addon
+	 */
+	private $addon;
+
+	/**
+	 * @var EE_Data_Migration_Manager $data_migration_manager
+	 */
+	private $data_migration_manager;
+
+	/**
+	 * @var EE_Maintenance_Mode $maintenance_mode
+	 */
+	private $maintenance_mode;
+
+	/**
+	 * @var EE_Registry $registry
+	 */
+	private $registry;
+
+
+
+	/**
+	 * InitializeDatabase constructor.
+	 *
+	 * @param EE_Addon $addon
+	 * @param EE_Data_Migration_Manager $data_migration_manager
+	 * @param EE_Maintenance_Mode       $maintenance_mode
+	 * @param EE_Registry $registry
+	 */
+	public function __construct(
+		EE_Addon $addon,
+		EE_Data_Migration_Manager $data_migration_manager,
+		EE_Maintenance_Mode $maintenance_mode,
+		EE_Registry $registry
+	) {
+		$this->addon = $addon;
+		$this->data_migration_manager = $data_migration_manager;
+		$this->maintenance_mode = $maintenance_mode;
+		$this->registry = $registry;
+	}
+
+
+	/**
+	 * Takes care of double-checking that we're not in maintenance mode, and then
+	 * initializing this addon's necessary initial data. This is called by default on new activations
+	 * and reactivations
+	 *
+	 * @param boolean $verify_schema whether to verify the database's schema for this addon, or just its data.
+	 *                               This is a resource-intensive job so we prefer to only do it when necessary
+	 * @return void
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	public function initialize($verify_schema = true)
+	{
+		if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
+			if ($verify_schema) {
+				$this->initializeDatabase();
+			}
+			$this->initializeDefaultData();
+			//@todo: this will probably need to be adjusted in 4.4 as the array changed formats I believe
+			$this->data_migration_manager->update_current_database_state_to(
+				array(
+					'slug'    => $this->addon->name(),
+					'version' => $this->addon->version()
+				)
+			);
+			//in case there are lots of addons being activated at once, let's force garbage collection
+			//to help avoid memory limit errors
+			//EEH_Debug_Tools::instance()->measure_memory( 'db content initialized for ' . get_class( $this), true );
+			gc_collect_cycles();
+		} else {
+			//ask the data migration manager to init this addon's data
+			//when migrations are finished because we can't do it now
+			$this->data_migration_manager->enqueue_db_initialization_for($this->addon->name());
+		}
+	}
+
+
+	/**
+	 * Used to setup this addon's database tables, but not necessarily any default
+	 * data in them. The default is to actually use the most up-to-date data migration script
+	 * for this addon, and just use its schema_changes_before_migration() and schema_changes_after_migration()
+	 * methods to setup the db.
+	 *
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	public function initializeDatabase()
+	{
+		//find the migration script that sets the database to be compatible with the code
+		$current_dms_name = $this->data_migration_manager->get_most_up_to_date_dms($this->addon->name());
+		if ($current_dms_name) {
+			$current_data_migration_script = $this->registry->load_dms($current_dms_name);
+			$current_data_migration_script->set_migrating(false);
+			$current_data_migration_script->schema_changes_before_migration();
+			$current_data_migration_script->schema_changes_after_migration();
+			if ($current_data_migration_script->get_errors()) {
+				foreach ($current_data_migration_script->get_errors() as $error) {
+					EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
+				}
+			}
+		}
+		//if not DMS was found that should be ok. This addon just doesn't require any database changes
+		$this->data_migration_manager->update_current_database_state_to(
+			array(
+				'slug'    => $this->addon->name(),
+				'version' => $this->addon->version()
+			)
+		);
+	}
+
+
+
+	/**
+	 * If you want to setup default data for the addon, override this method, and call
+	 * parent::initialize_default_data() from within it. This is normally called
+	 * from EE_Addon::initialize_db_if_no_migrations_required(), just after EE_Addon::initialize_db()
+	 * and should verify default data is present (but this is also called
+	 * on reactivations and just after migrations, so please verify you actually want
+	 * to ADD default data, because it may already be present).
+	 * However, please call this parent (currently it just fires a hook which other
+	 * addons may be depending on)
+	 */
+	public function initializeDefaultData()
+	{
+		/**
+		 * Called when an addon is ensuring its default data is set (possibly called
+		 * on a reactivation, so first check for the absence of other data before setting
+		 * default data)
+		 *
+		 * @param EE_Addon $addon the addon that called this
+		 */
+		do_action('AHEE__EE_Addon__initialize_default_data__begin', $this);
+		//override to insert default data. It is safe to use the models here
+		//because the site should not be in maintenance mode
+	}
 
 
 

core/services/bootstrap/BootstrapDependencyInjectionContainer.php

Spacing +2 added lines, -2 removed lines

@@ -78,13 +78,13 @@
         // EE_Dependency_Map: info about how to load classes required by other classes
         espresso_load_required(
             'EE_Dependency_Map',
-            EE_CORE . 'EE_Dependency_Map.core.php'
+            EE_CORE.'EE_Dependency_Map.core.php'
         );
         $this->dependency_map = EE_Dependency_Map::instance($this->class_cache);
         // EE_Registry: central repository for classes (legacy)
         espresso_load_required(
             'EE_Registry',
-            EE_CORE . 'EE_Registry.core.php'
+            EE_CORE.'EE_Registry.core.php'
         );
         $this->registry = EE_Registry::instance(
             $this->dependency_map,

Indentation +119 added lines, -119 removed lines

@@ -25,123 +25,123 @@
 class BootstrapDependencyInjectionContainer
 {
 
-    /**
-     * @var EE_Dependency_Map $dependency_map
-     */
-    protected $dependency_map;
-
-    /**
-     * @type LoaderInterface $loader
-     */
-    protected $loader;
-
-    /**
-     * @var EE_Registry $registry
-     */
-    protected $registry;
-
-    /**
-     * @var ClassInterfaceCache $class_cache
-     */
-    private $class_cache;
-
-    /**
-     * @var Mirror
-     */
-    private $mirror;
-
-    /**
-     * @var ObjectIdentifier
-     */
-    private $object_identifier;
-
-
-    /**
-     * Can't use this just yet until we exorcise some more of our singleton usage from core
-     */
-    public function buildDependencyInjectionContainer()
-    {
-        // build DI container
-        // $OpenCoffeeShop = new EventEspresso\core\services\container\OpenCoffeeShop();
-        // $OpenCoffeeShop->addRecipes();
-        // $CoffeeShop = $OpenCoffeeShop->CoffeeShop();
-    }
-
-
-    /**
-     * Setups  EE_Registry and EE_Dependency_Map
-     *
-     * @throws EE_Error
-     */
-    public function buildLegacyDependencyInjectionContainer()
-    {
-        $this->class_cache = new ClassInterfaceCache();
-        $this->object_identifier = new ObjectIdentifier($this->class_cache);
-        $this->mirror = new Mirror();
-        // EE_Dependency_Map: info about how to load classes required by other classes
-        espresso_load_required(
-            'EE_Dependency_Map',
-            EE_CORE . 'EE_Dependency_Map.core.php'
-        );
-        $this->dependency_map = EE_Dependency_Map::instance($this->class_cache);
-        // EE_Registry: central repository for classes (legacy)
-        espresso_load_required(
-            'EE_Registry',
-            EE_CORE . 'EE_Registry.core.php'
-        );
-        $this->registry = EE_Registry::instance(
-            $this->dependency_map,
-            $this->mirror,
-            $this->class_cache,
-            $this->object_identifier
-        );
-    }
-
-
-    /**
-     * Performs initial setup for the generic Loader
-     *
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function buildLoader()
-    {
-        $this->loader = LoaderFactory::getLoader(
-            $this->registry,
-            $this->class_cache,
-            $this->object_identifier
-        );
-        $this->loader->share('EventEspresso\core\services\loaders\ClassInterfaceCache', $this->class_cache);
-        $this->loader->share('EventEspresso\core\services\loaders\ObjectIdentifier', $this->object_identifier);
-        $this->loader->share('EventEspresso\core\services\container\Mirror', $this->mirror);
-        $this->dependency_map->setLoader($this->loader);
-    }
-
-
-    /**
-     * @return EE_Dependency_Map
-     */
-    public function getDependencyMap()
-    {
-        return $this->dependency_map;
-    }
-
-
-    /**
-     * @return EE_Registry
-     */
-    public function getRegistry()
-    {
-        return $this->registry;
-    }
-
-
-    /**
-     * @return LoaderInterface
-     */
-    public function getLoader()
-    {
-        return $this->loader;
-    }
+	/**
+	 * @var EE_Dependency_Map $dependency_map
+	 */
+	protected $dependency_map;
+
+	/**
+	 * @type LoaderInterface $loader
+	 */
+	protected $loader;
+
+	/**
+	 * @var EE_Registry $registry
+	 */
+	protected $registry;
+
+	/**
+	 * @var ClassInterfaceCache $class_cache
+	 */
+	private $class_cache;
+
+	/**
+	 * @var Mirror
+	 */
+	private $mirror;
+
+	/**
+	 * @var ObjectIdentifier
+	 */
+	private $object_identifier;
+
+
+	/**
+	 * Can't use this just yet until we exorcise some more of our singleton usage from core
+	 */
+	public function buildDependencyInjectionContainer()
+	{
+		// build DI container
+		// $OpenCoffeeShop = new EventEspresso\core\services\container\OpenCoffeeShop();
+		// $OpenCoffeeShop->addRecipes();
+		// $CoffeeShop = $OpenCoffeeShop->CoffeeShop();
+	}
+
+
+	/**
+	 * Setups  EE_Registry and EE_Dependency_Map
+	 *
+	 * @throws EE_Error
+	 */
+	public function buildLegacyDependencyInjectionContainer()
+	{
+		$this->class_cache = new ClassInterfaceCache();
+		$this->object_identifier = new ObjectIdentifier($this->class_cache);
+		$this->mirror = new Mirror();
+		// EE_Dependency_Map: info about how to load classes required by other classes
+		espresso_load_required(
+			'EE_Dependency_Map',
+			EE_CORE . 'EE_Dependency_Map.core.php'
+		);
+		$this->dependency_map = EE_Dependency_Map::instance($this->class_cache);
+		// EE_Registry: central repository for classes (legacy)
+		espresso_load_required(
+			'EE_Registry',
+			EE_CORE . 'EE_Registry.core.php'
+		);
+		$this->registry = EE_Registry::instance(
+			$this->dependency_map,
+			$this->mirror,
+			$this->class_cache,
+			$this->object_identifier
+		);
+	}
+
+
+	/**
+	 * Performs initial setup for the generic Loader
+	 *
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function buildLoader()
+	{
+		$this->loader = LoaderFactory::getLoader(
+			$this->registry,
+			$this->class_cache,
+			$this->object_identifier
+		);
+		$this->loader->share('EventEspresso\core\services\loaders\ClassInterfaceCache', $this->class_cache);
+		$this->loader->share('EventEspresso\core\services\loaders\ObjectIdentifier', $this->object_identifier);
+		$this->loader->share('EventEspresso\core\services\container\Mirror', $this->mirror);
+		$this->dependency_map->setLoader($this->loader);
+	}
+
+
+	/**
+	 * @return EE_Dependency_Map
+	 */
+	public function getDependencyMap()
+	{
+		return $this->dependency_map;
+	}
+
+
+	/**
+	 * @return EE_Registry
+	 */
+	public function getRegistry()
+	{
+		return $this->registry;
+	}
+
+
+	/**
+	 * @return LoaderInterface
+	 */
+	public function getLoader()
+	{
+		return $this->loader;
+	}
 }

core/domain/services/custom_post_types/RegisterCustomTaxonomyTerms.php

Spacing +1 added lines, -1 removed lines

@@ -65,7 +65,7 @@
      */
     public function registerCustomTaxonomyTerm($taxonomy, $term_slug, array $cpt_slugs = array())
     {
-        $this->custom_taxonomy_terms[][ $term_slug ] = new CustomTaxonomyTerm(
+        $this->custom_taxonomy_terms[][$term_slug] = new CustomTaxonomyTerm(
             $taxonomy,
             $term_slug,
             $cpt_slugs

Indentation +177 added lines, -177 removed lines

@@ -16,181 +16,181 @@
 class RegisterCustomTaxonomyTerms
 {
 
-    /**
-     * @var array[] $custom_taxonomy_terms
-     */
-    public $custom_taxonomy_terms = array();
-
-
-    /**
-     * RegisterCustomTaxonomyTerms constructor.
-     */
-    public function __construct()
-    {
-        // hook into save_post so that we can make sure that the default terms get saved on publish of registered cpts
-        // IF they don't have a term for that taxonomy set.
-        add_action('save_post', array($this, 'saveDefaultTerm'), 100, 2);
-        do_action(
-            'AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end',
-            $this
-        );
-    }
-
-
-    public function registerCustomTaxonomyTerms()
-    {
-        // setup default terms in any of our taxonomies (but only if we're in admin).
-        // Why not added via register_activation_hook?
-        // Because it's possible that in future iterations of EE we may add new defaults for specialized taxonomies
-        // (think event_types) and register_activation_hook only reliably runs when a user manually activates the plugin.
-        // Keep in mind that this will READ these terms if they are deleted by the user.  Hence MUST use terms.
-        // if ( is_admin() ) {
-        // $this->set_must_use_event_types();
-        // }
-        // set default terms
-        $this->registerCustomTaxonomyTerm(
-            'espresso_event_type',
-            'single-event',
-            array('espresso_events')
-        );
-    }
-
-
-    /**
-     * Allows us to set what the default will be for terms when a cpt is PUBLISHED.
-     *
-     * @param string $taxonomy  The taxonomy we're using for the default term
-     * @param string $term_slug The slug of the term that will be the default.
-     * @param array  $cpt_slugs An array of custom post types we want the default assigned to
-     */
-    public function registerCustomTaxonomyTerm($taxonomy, $term_slug, array $cpt_slugs = array())
-    {
-        $this->custom_taxonomy_terms[][ $term_slug ] = new CustomTaxonomyTerm(
-            $taxonomy,
-            $term_slug,
-            $cpt_slugs
-        );
-    }
-
-
-    /**
-     * hooked into the wp 'save_post' action hook for setting our default terms found in the $_default_terms property
-     *
-     * @param  int     $post_id ID of CPT being saved
-     * @param  WP_Post $post    Post object
-     * @return void
-     */
-    public function saveDefaultTerm($post_id, WP_Post $post)
-    {
-        if (empty($this->custom_taxonomy_terms)) {
-            return;
-        }
-        // no default terms set so lets just exit.
-        foreach ($this->custom_taxonomy_terms as $custom_taxonomy_terms) {
-            foreach ($custom_taxonomy_terms as $custom_taxonomy_term) {
-                if (
-                    $post->post_status === 'publish'
-                    && $custom_taxonomy_term instanceof CustomTaxonomyTerm
-                    && in_array($post->post_type, $custom_taxonomy_term->customPostTypeSlugs(), true)
-                ) {
-                    // note some error proofing going on here to save unnecessary db queries
-                    $taxonomies = get_object_taxonomies($post->post_type);
-                    foreach ($taxonomies as $taxonomy) {
-                        $terms = wp_get_post_terms($post_id, $taxonomy);
-                        if (empty($terms) && $taxonomy === $custom_taxonomy_term->taxonomySlug()) {
-                            wp_set_object_terms(
-                                $post_id,
-                                array($custom_taxonomy_term->termSlug()),
-                                $taxonomy
-                            );
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    public function setMustUseEventTypes()
-    {
-        $term_details = array(
-            // Attendee's register for the first date-time only
-            'single-event'    => array(
-                'term' => esc_html__('Single Event', 'event_espresso'),
-                'desc' => esc_html__(
-                    'A single event that spans one or more consecutive days.',
-                    'event_espresso'
-                ),
-            ),
-            // example: a party or two-day long workshop
-            // Attendee's can register for any of the date-times
-            'multi-event'     => array(
-                'term' => esc_html__('Multi Event', 'event_espresso'),
-                'desc' => esc_html__(
-                    'Multiple, separate, but related events that occur on consecutive days.',
-                    'event_espresso'
-                ),
-            ),
-            // example: a three day music festival or week long conference
-            // Attendee's register for the first date-time only
-            'event-series'    => array(
-                'term' => esc_html__('Event Series', 'event_espresso'),
-                'desc' => esc_html__(
-                    ' Multiple events that occur over multiple non-consecutive days.',
-                    'event_espresso'
-                ),
-            ),
-            // example: an 8 week introduction to basket weaving course
-            // Attendee's can register for any of the date-times.
-            'recurring-event' => array(
-                'term' => esc_html__('Recurring Event', 'event_espresso'),
-                'desc' => esc_html__(
-                    'Multiple events that occur over multiple non-consecutive days.',
-                    'event_espresso'
-                ),
-            ),
-            // example: a yoga class
-            'ongoing'         => array(
-                'term' => esc_html__('Ongoing Event', 'event_espresso'),
-                'desc' => esc_html__(
-                    'An "event" that people can purchase tickets to gain access for anytime for this event regardless of date times on the event',
-                    'event_espresso'
-                ),
-            )
-            // example: access to a museum
-            // 'walk-in' => array( esc_html__('Walk In', 'event_espresso'), esc_html__('Single datetime and single entry recurring events. Attendees register for one or multiple datetimes individually.', 'event_espresso') ),
-            // 'reservation' => array( esc_html__('Reservation', 'event_espresso'), esc_html__('Reservations are created by specifying available datetimes and quantities. Attendees choose from the available datetimes and specify the quantity available (if the maximum is greater than 1)') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1
-            // 'multiple-session' => array( esc_html__('Multiple Session', 'event_espresso'), esc_html__('Multiple event, multiple datetime, hierarchically organized, custom entry events. Attendees may be required to register for a parent event before being allowed to register for child events. Attendees can register for any combination of child events as long as the datetimes do not conflict. Parent and child events may have additional fees or registration questions.') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1
-            // 'appointment' => array( esc_html__('Appointments', 'event_espresso'), esc_html__('Time slotted events where datetimes are generally in hours or minutes. For example, attendees can register for a single 15 minute or 1 hour time slot and this type of availability frequently reoccurs.', 'event_espresso') )
-        );
-        $this->setMustUseTerms('espresso_event_type', $term_details);
-    }
-
-
-    /**
-     * wrapper method for handling the setting up of initial terms in the db (if they don't already exist).
-     * Note this should ONLY be used for terms that always must be present.  Be aware that if an initial term is
-     * deleted then it WILL be recreated.
-     *
-     * @param string $taxonomy     The name of the taxonomy
-     * @param array  $term_details An array of term details indexed by slug and containing Name of term, and
-     *                             description as the elements in the array
-     * @return void
-     */
-    public function setMustUseTerms($taxonomy, $term_details)
-    {
-        $term_details = (array) $term_details;
-        foreach ($term_details as $slug => $details) {
-            if (isset($details['term'], $details['desc']) && ! term_exists($slug, $taxonomy)) {
-                $insert_arr = array(
-                    'slug'        => $slug,
-                    'description' => $details['desc'],
-                );
-                wp_insert_term($details['term'], $taxonomy, $insert_arr);
-            }
-        }
-    }
+	/**
+	 * @var array[] $custom_taxonomy_terms
+	 */
+	public $custom_taxonomy_terms = array();
+
+
+	/**
+	 * RegisterCustomTaxonomyTerms constructor.
+	 */
+	public function __construct()
+	{
+		// hook into save_post so that we can make sure that the default terms get saved on publish of registered cpts
+		// IF they don't have a term for that taxonomy set.
+		add_action('save_post', array($this, 'saveDefaultTerm'), 100, 2);
+		do_action(
+			'AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end',
+			$this
+		);
+	}
+
+
+	public function registerCustomTaxonomyTerms()
+	{
+		// setup default terms in any of our taxonomies (but only if we're in admin).
+		// Why not added via register_activation_hook?
+		// Because it's possible that in future iterations of EE we may add new defaults for specialized taxonomies
+		// (think event_types) and register_activation_hook only reliably runs when a user manually activates the plugin.
+		// Keep in mind that this will READ these terms if they are deleted by the user.  Hence MUST use terms.
+		// if ( is_admin() ) {
+		// $this->set_must_use_event_types();
+		// }
+		// set default terms
+		$this->registerCustomTaxonomyTerm(
+			'espresso_event_type',
+			'single-event',
+			array('espresso_events')
+		);
+	}
+
+
+	/**
+	 * Allows us to set what the default will be for terms when a cpt is PUBLISHED.
+	 *
+	 * @param string $taxonomy  The taxonomy we're using for the default term
+	 * @param string $term_slug The slug of the term that will be the default.
+	 * @param array  $cpt_slugs An array of custom post types we want the default assigned to
+	 */
+	public function registerCustomTaxonomyTerm($taxonomy, $term_slug, array $cpt_slugs = array())
+	{
+		$this->custom_taxonomy_terms[][ $term_slug ] = new CustomTaxonomyTerm(
+			$taxonomy,
+			$term_slug,
+			$cpt_slugs
+		);
+	}
+
+
+	/**
+	 * hooked into the wp 'save_post' action hook for setting our default terms found in the $_default_terms property
+	 *
+	 * @param  int     $post_id ID of CPT being saved
+	 * @param  WP_Post $post    Post object
+	 * @return void
+	 */
+	public function saveDefaultTerm($post_id, WP_Post $post)
+	{
+		if (empty($this->custom_taxonomy_terms)) {
+			return;
+		}
+		// no default terms set so lets just exit.
+		foreach ($this->custom_taxonomy_terms as $custom_taxonomy_terms) {
+			foreach ($custom_taxonomy_terms as $custom_taxonomy_term) {
+				if (
+					$post->post_status === 'publish'
+					&& $custom_taxonomy_term instanceof CustomTaxonomyTerm
+					&& in_array($post->post_type, $custom_taxonomy_term->customPostTypeSlugs(), true)
+				) {
+					// note some error proofing going on here to save unnecessary db queries
+					$taxonomies = get_object_taxonomies($post->post_type);
+					foreach ($taxonomies as $taxonomy) {
+						$terms = wp_get_post_terms($post_id, $taxonomy);
+						if (empty($terms) && $taxonomy === $custom_taxonomy_term->taxonomySlug()) {
+							wp_set_object_terms(
+								$post_id,
+								array($custom_taxonomy_term->termSlug()),
+								$taxonomy
+							);
+						}
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function setMustUseEventTypes()
+	{
+		$term_details = array(
+			// Attendee's register for the first date-time only
+			'single-event'    => array(
+				'term' => esc_html__('Single Event', 'event_espresso'),
+				'desc' => esc_html__(
+					'A single event that spans one or more consecutive days.',
+					'event_espresso'
+				),
+			),
+			// example: a party or two-day long workshop
+			// Attendee's can register for any of the date-times
+			'multi-event'     => array(
+				'term' => esc_html__('Multi Event', 'event_espresso'),
+				'desc' => esc_html__(
+					'Multiple, separate, but related events that occur on consecutive days.',
+					'event_espresso'
+				),
+			),
+			// example: a three day music festival or week long conference
+			// Attendee's register for the first date-time only
+			'event-series'    => array(
+				'term' => esc_html__('Event Series', 'event_espresso'),
+				'desc' => esc_html__(
+					' Multiple events that occur over multiple non-consecutive days.',
+					'event_espresso'
+				),
+			),
+			// example: an 8 week introduction to basket weaving course
+			// Attendee's can register for any of the date-times.
+			'recurring-event' => array(
+				'term' => esc_html__('Recurring Event', 'event_espresso'),
+				'desc' => esc_html__(
+					'Multiple events that occur over multiple non-consecutive days.',
+					'event_espresso'
+				),
+			),
+			// example: a yoga class
+			'ongoing'         => array(
+				'term' => esc_html__('Ongoing Event', 'event_espresso'),
+				'desc' => esc_html__(
+					'An "event" that people can purchase tickets to gain access for anytime for this event regardless of date times on the event',
+					'event_espresso'
+				),
+			)
+			// example: access to a museum
+			// 'walk-in' => array( esc_html__('Walk In', 'event_espresso'), esc_html__('Single datetime and single entry recurring events. Attendees register for one or multiple datetimes individually.', 'event_espresso') ),
+			// 'reservation' => array( esc_html__('Reservation', 'event_espresso'), esc_html__('Reservations are created by specifying available datetimes and quantities. Attendees choose from the available datetimes and specify the quantity available (if the maximum is greater than 1)') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1
+			// 'multiple-session' => array( esc_html__('Multiple Session', 'event_espresso'), esc_html__('Multiple event, multiple datetime, hierarchically organized, custom entry events. Attendees may be required to register for a parent event before being allowed to register for child events. Attendees can register for any combination of child events as long as the datetimes do not conflict. Parent and child events may have additional fees or registration questions.') ), //@TODO to avoid confusion we'll implement this in a later iteration > EE4.1
+			// 'appointment' => array( esc_html__('Appointments', 'event_espresso'), esc_html__('Time slotted events where datetimes are generally in hours or minutes. For example, attendees can register for a single 15 minute or 1 hour time slot and this type of availability frequently reoccurs.', 'event_espresso') )
+		);
+		$this->setMustUseTerms('espresso_event_type', $term_details);
+	}
+
+
+	/**
+	 * wrapper method for handling the setting up of initial terms in the db (if they don't already exist).
+	 * Note this should ONLY be used for terms that always must be present.  Be aware that if an initial term is
+	 * deleted then it WILL be recreated.
+	 *
+	 * @param string $taxonomy     The name of the taxonomy
+	 * @param array  $term_details An array of term details indexed by slug and containing Name of term, and
+	 *                             description as the elements in the array
+	 * @return void
+	 */
+	public function setMustUseTerms($taxonomy, $term_details)
+	{
+		$term_details = (array) $term_details;
+		foreach ($term_details as $slug => $details) {
+			if (isset($details['term'], $details['desc']) && ! term_exists($slug, $taxonomy)) {
+				$insert_arr = array(
+					'slug'        => $slug,
+					'description' => $details['desc'],
+				);
+				wp_insert_term($details['term'], $taxonomy, $insert_arr);
+			}
+		}
+	}
 }

core/services/loaders/CoreLoader.php

Spacing +1 added lines, -1 removed lines

@@ -47,7 +47,7 @@
      */
     public function __construct($generator)
     {
-        if (! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
+        if ( ! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
             throw new InvalidArgumentException(
                 esc_html__(
                     'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.',

Indentation +101 added lines, -101 removed lines

@@ -29,111 +29,111 @@
 class CoreLoader implements LoaderDecoratorInterface
 {
 
-    /**
-     * @var EE_Registry|CoffeeShop $generator
-     */
-    private $generator;
+	/**
+	 * @var EE_Registry|CoffeeShop $generator
+	 */
+	private $generator;
 
 
-    /**
-     * CoreLoader constructor.
-     *
-     * @param EE_Registry|CoffeeShop $generator
-     * @throws InvalidArgumentException
-     */
-    public function __construct($generator)
-    {
-        if (! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
-            throw new InvalidArgumentException(
-                esc_html__(
-                    'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->generator = $generator;
-    }
+	/**
+	 * CoreLoader constructor.
+	 *
+	 * @param EE_Registry|CoffeeShop $generator
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct($generator)
+	{
+		if (! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
+			throw new InvalidArgumentException(
+				esc_html__(
+					'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.',
+					'event_espresso'
+				)
+			);
+		}
+		$this->generator = $generator;
+	}
 
 
-    /**
-     * Calls the appropriate loading method from the installed generator;
-     * If EE_Registry is being used, then the additional parameters for the EE_Registry::create() method
-     * can be added to the $arguments array and they will be extracted and passed to EE_Registry::create(),
-     * but NOT to the class being instantiated.
-     * This is done by adding the parameters to the $arguments array as follows:
-     *  array(
-     *      'EE_Registry::create(from_db)'   => true, // boolean value, default = false
-     *      'EE_Registry::create(load_only)' => true, // boolean value, default = false
-     *      'EE_Registry::create(addon)'     => true, // boolean value, default = false
-     *  )
-     *
-     * @param string $fqcn
-     * @param array  $arguments
-     * @param bool   $shared
-     * @return mixed
-     * @throws OutOfBoundsException
-     * @throws ServiceExistsException
-     * @throws InstantiationException
-     * @throws InvalidIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     * @throws EE_Error
-     * @throws ServiceNotFoundException
-     * @throws ReflectionException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function load($fqcn, $arguments = array(), $shared = true)
-    {
-        $shared = filter_var($shared, FILTER_VALIDATE_BOOLEAN);
-        if ($this->generator instanceof EE_Registry) {
-            // check if additional EE_Registry::create() arguments have been passed
-            // from_db
-            $from_db = isset($arguments['EE_Registry::create(from_db)'])
-                ? filter_var($arguments['EE_Registry::create(from_db)'], FILTER_VALIDATE_BOOLEAN)
-                : false;
-            // load_only
-            $load_only = isset($arguments['EE_Registry::create(load_only)'])
-                ? filter_var($arguments['EE_Registry::create(load_only)'], FILTER_VALIDATE_BOOLEAN)
-                : false;
-            // addon
-            $addon = isset($arguments['EE_Registry::create(addon)'])
-                ? filter_var($arguments['EE_Registry::create(addon)'], FILTER_VALIDATE_BOOLEAN)
-                : false;
-            unset(
-                $arguments['EE_Registry::create(from_db)'],
-                $arguments['EE_Registry::create(load_only)'],
-                $arguments['EE_Registry::create(addon)']
-            );
-            // addons need to be cached on EE_Registry
-            $shared = $addon ? true : $shared;
-            return $this->generator->create(
-                $fqcn,
-                $arguments,
-                $shared,
-                $from_db,
-                $load_only,
-                $addon
-            );
-        }
-        return $this->generator->brew(
-            $fqcn,
-            $arguments,
-            $shared ? CoffeeMaker::BREW_SHARED : CoffeeMaker::BREW_NEW
-        );
-    }
+	/**
+	 * Calls the appropriate loading method from the installed generator;
+	 * If EE_Registry is being used, then the additional parameters for the EE_Registry::create() method
+	 * can be added to the $arguments array and they will be extracted and passed to EE_Registry::create(),
+	 * but NOT to the class being instantiated.
+	 * This is done by adding the parameters to the $arguments array as follows:
+	 *  array(
+	 *      'EE_Registry::create(from_db)'   => true, // boolean value, default = false
+	 *      'EE_Registry::create(load_only)' => true, // boolean value, default = false
+	 *      'EE_Registry::create(addon)'     => true, // boolean value, default = false
+	 *  )
+	 *
+	 * @param string $fqcn
+	 * @param array  $arguments
+	 * @param bool   $shared
+	 * @return mixed
+	 * @throws OutOfBoundsException
+	 * @throws ServiceExistsException
+	 * @throws InstantiationException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 * @throws EE_Error
+	 * @throws ServiceNotFoundException
+	 * @throws ReflectionException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function load($fqcn, $arguments = array(), $shared = true)
+	{
+		$shared = filter_var($shared, FILTER_VALIDATE_BOOLEAN);
+		if ($this->generator instanceof EE_Registry) {
+			// check if additional EE_Registry::create() arguments have been passed
+			// from_db
+			$from_db = isset($arguments['EE_Registry::create(from_db)'])
+				? filter_var($arguments['EE_Registry::create(from_db)'], FILTER_VALIDATE_BOOLEAN)
+				: false;
+			// load_only
+			$load_only = isset($arguments['EE_Registry::create(load_only)'])
+				? filter_var($arguments['EE_Registry::create(load_only)'], FILTER_VALIDATE_BOOLEAN)
+				: false;
+			// addon
+			$addon = isset($arguments['EE_Registry::create(addon)'])
+				? filter_var($arguments['EE_Registry::create(addon)'], FILTER_VALIDATE_BOOLEAN)
+				: false;
+			unset(
+				$arguments['EE_Registry::create(from_db)'],
+				$arguments['EE_Registry::create(load_only)'],
+				$arguments['EE_Registry::create(addon)']
+			);
+			// addons need to be cached on EE_Registry
+			$shared = $addon ? true : $shared;
+			return $this->generator->create(
+				$fqcn,
+				$arguments,
+				$shared,
+				$from_db,
+				$load_only,
+				$addon
+			);
+		}
+		return $this->generator->brew(
+			$fqcn,
+			$arguments,
+			$shared ? CoffeeMaker::BREW_SHARED : CoffeeMaker::BREW_NEW
+		);
+	}
 
 
-    /**
-     * calls reset() on generator if method exists
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function reset()
-    {
-        if ($this->generator instanceof ResettableInterface) {
-            $this->generator->reset();
-        }
-    }
+	/**
+	 * calls reset() on generator if method exists
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function reset()
+	{
+		if ($this->generator instanceof ResettableInterface) {
+			$this->generator->reset();
+		}
+	}
 }

core/services/loaders/CachingLoader.php

Spacing +2 added lines, -2 removed lines

@@ -53,7 +53,7 @@ 
         $identifier = ''
     ) {
         parent::__construct($loader);
-        $this->cache       = $cache;
+        $this->cache = $cache;
         $this->object_identifier = $object_identifier;
         $this->setIdentifier($identifier);
         if ($this->identifier !== '') {
@@ -89,7 +89,7 @@ 
      */
     private function setIdentifier($identifier)
     {
-        if (! is_string($identifier)) {
+        if ( ! is_string($identifier)) {
             throw new InvalidDataTypeException('$identifier', $identifier, 'string');
         }
         $this->identifier = $identifier;

Indentation +182 added lines, -182 removed lines

@@ -17,186 +17,186 @@
 class CachingLoader extends CachingLoaderDecorator
 {
 
-    /**
-     * @var bool
-     */
-    protected $bypass;
-
-    /**
-     * @var CollectionInterface
-     */
-    protected $cache;
-
-    /**
-     * @var string
-     */
-    protected $identifier;
-
-    /**
-     * @var ObjectIdentifier
-     */
-    private $object_identifier;
-
-
-    /**
-     * CachingLoader constructor.
-     *
-     * @param LoaderDecoratorInterface $loader
-     * @param CollectionInterface      $cache
-     * @param ObjectIdentifier         $object_identifier
-     * @param string                   $identifier
-     * @throws InvalidDataTypeException
-     */
-    public function __construct(
-        LoaderDecoratorInterface $loader,
-        CollectionInterface $cache,
-        ObjectIdentifier $object_identifier,
-        $identifier = ''
-    ) {
-        parent::__construct($loader);
-        $this->cache       = $cache;
-        $this->object_identifier = $object_identifier;
-        $this->setIdentifier($identifier);
-        if ($this->identifier !== '') {
-            // to only clear this cache, and assuming an identifier has been set, simply do the following:
-            // do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__IDENTIFIER');
-            // where "IDENTIFIER" = the string that was set during construction
-            add_action(
-                "AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__{$identifier}",
-                array($this, 'reset')
-            );
-        }
-        // to clear ALL caches, simply do the following:
-        // do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache');
-        add_action(
-            'AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache',
-            array($this, 'reset')
-        );
-        // caching can be turned off via the following code:
-        // add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true');
-        $this->bypass = filter_var(
-            apply_filters(
-                'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache',
-                false,
-                $this
-            ),
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
-
-
-    /**
-     * @return string
-     */
-    public function identifier()
-    {
-        return $this->identifier;
-    }
-
-
-    /**
-     * @param string $identifier
-     * @throws InvalidDataTypeException
-     */
-    private function setIdentifier($identifier)
-    {
-        if (! is_string($identifier)) {
-            throw new InvalidDataTypeException('$identifier', $identifier, 'string');
-        }
-        $this->identifier = $identifier;
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param mixed                     $object
-     * @param array                     $arguments
-     * @return bool
-     * @throws InvalidArgumentException
-     */
-    public function share($fqcn, $object, array $arguments = array())
-    {
-        if ($object instanceof $fqcn) {
-            return $this->cache->add(
-                $object,
-                $this->object_identifier->getIdentifier($fqcn, $arguments)
-            );
-        }
-        throw new InvalidArgumentException(
-            sprintf(
-                esc_html__(
-                    'The supplied class name "%1$s" must match the class of the supplied object.',
-                    'event_espresso'
-                ),
-                $fqcn
-            )
-        );
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @param bool                      $shared
-     * @param array                     $interfaces
-     * @return mixed
-     */
-    public function load($fqcn, $arguments = array(), $shared = true, array $interfaces = array())
-    {
-        $fqcn = ltrim($fqcn, '\\');
-        // caching can be turned off via the following code:
-        // add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true');
-        if ($this->bypass) {
-            // even though $shared might be true, caching could be bypassed for whatever reason,
-            // so we don't want the core loader to cache anything, therefore caching is turned off
-            return $this->loader->load($fqcn, $arguments, false);
-        }
-        $object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments);
-        if ($this->cache->has($object_identifier)) {
-            return $this->cache->get($object_identifier);
-        }
-        $object = $this->loader->load($fqcn, $arguments, $shared);
-        if ($object instanceof $fqcn) {
-            $this->cache->add($object, $object_identifier);
-        }
-        return $object;
-    }
-
-
-    /**
-     * empties cache and calls reset() on loader if method exists
-     */
-    public function reset()
-    {
-        $this->clearCache();
-        $this->loader->reset();
-    }
-
-
-    /**
-     * unsets and detaches ALL objects from the cache
-     *
-     * @since 4.9.62.p
-     */
-    public function clearCache()
-    {
-        $this->cache->trashAndDetachAll();
-    }
-
-
-    /**
-     * @param string $fqcn
-     * @param array  $arguments
-     * @return bool
-     * @throws InvalidArgumentException
-     */
-    public function remove($fqcn, array $arguments = [])
-    {
-        $fqcn = ltrim($fqcn, '\\');
-        $object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments);
-        $object = $this->cache->has($object_identifier)
-            ? $this->cache->get($object_identifier)
-            : $this->loader->load($fqcn, $arguments);
-        return $this->cache->remove($object);
-    }
+	/**
+	 * @var bool
+	 */
+	protected $bypass;
+
+	/**
+	 * @var CollectionInterface
+	 */
+	protected $cache;
+
+	/**
+	 * @var string
+	 */
+	protected $identifier;
+
+	/**
+	 * @var ObjectIdentifier
+	 */
+	private $object_identifier;
+
+
+	/**
+	 * CachingLoader constructor.
+	 *
+	 * @param LoaderDecoratorInterface $loader
+	 * @param CollectionInterface      $cache
+	 * @param ObjectIdentifier         $object_identifier
+	 * @param string                   $identifier
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct(
+		LoaderDecoratorInterface $loader,
+		CollectionInterface $cache,
+		ObjectIdentifier $object_identifier,
+		$identifier = ''
+	) {
+		parent::__construct($loader);
+		$this->cache       = $cache;
+		$this->object_identifier = $object_identifier;
+		$this->setIdentifier($identifier);
+		if ($this->identifier !== '') {
+			// to only clear this cache, and assuming an identifier has been set, simply do the following:
+			// do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__IDENTIFIER');
+			// where "IDENTIFIER" = the string that was set during construction
+			add_action(
+				"AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__{$identifier}",
+				array($this, 'reset')
+			);
+		}
+		// to clear ALL caches, simply do the following:
+		// do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache');
+		add_action(
+			'AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache',
+			array($this, 'reset')
+		);
+		// caching can be turned off via the following code:
+		// add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true');
+		$this->bypass = filter_var(
+			apply_filters(
+				'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache',
+				false,
+				$this
+			),
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function identifier()
+	{
+		return $this->identifier;
+	}
+
+
+	/**
+	 * @param string $identifier
+	 * @throws InvalidDataTypeException
+	 */
+	private function setIdentifier($identifier)
+	{
+		if (! is_string($identifier)) {
+			throw new InvalidDataTypeException('$identifier', $identifier, 'string');
+		}
+		$this->identifier = $identifier;
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param mixed                     $object
+	 * @param array                     $arguments
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 */
+	public function share($fqcn, $object, array $arguments = array())
+	{
+		if ($object instanceof $fqcn) {
+			return $this->cache->add(
+				$object,
+				$this->object_identifier->getIdentifier($fqcn, $arguments)
+			);
+		}
+		throw new InvalidArgumentException(
+			sprintf(
+				esc_html__(
+					'The supplied class name "%1$s" must match the class of the supplied object.',
+					'event_espresso'
+				),
+				$fqcn
+			)
+		);
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @param bool                      $shared
+	 * @param array                     $interfaces
+	 * @return mixed
+	 */
+	public function load($fqcn, $arguments = array(), $shared = true, array $interfaces = array())
+	{
+		$fqcn = ltrim($fqcn, '\\');
+		// caching can be turned off via the following code:
+		// add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true');
+		if ($this->bypass) {
+			// even though $shared might be true, caching could be bypassed for whatever reason,
+			// so we don't want the core loader to cache anything, therefore caching is turned off
+			return $this->loader->load($fqcn, $arguments, false);
+		}
+		$object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments);
+		if ($this->cache->has($object_identifier)) {
+			return $this->cache->get($object_identifier);
+		}
+		$object = $this->loader->load($fqcn, $arguments, $shared);
+		if ($object instanceof $fqcn) {
+			$this->cache->add($object, $object_identifier);
+		}
+		return $object;
+	}
+
+
+	/**
+	 * empties cache and calls reset() on loader if method exists
+	 */
+	public function reset()
+	{
+		$this->clearCache();
+		$this->loader->reset();
+	}
+
+
+	/**
+	 * unsets and detaches ALL objects from the cache
+	 *
+	 * @since 4.9.62.p
+	 */
+	public function clearCache()
+	{
+		$this->cache->trashAndDetachAll();
+	}
+
+
+	/**
+	 * @param string $fqcn
+	 * @param array  $arguments
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 */
+	public function remove($fqcn, array $arguments = [])
+	{
+		$fqcn = ltrim($fqcn, '\\');
+		$object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments);
+		$object = $this->cache->has($object_identifier)
+			? $this->cache->get($object_identifier)
+			: $this->loader->load($fqcn, $arguments);
+		return $this->cache->remove($object);
+	}
 }

core/services/loaders/LoaderFactory.php

Indentation +39 added lines, -39 removed lines

@@ -80,47 +80,47 @@
 class LoaderFactory
 {
 
-    /**
-     * @var LoaderInterface $loader ;
-     */
-    private static $loader;
+	/**
+	 * @var LoaderInterface $loader ;
+	 */
+	private static $loader;
 
 
-    /**
-     * @param EE_Registry|CoffeeShop   $generator   provided during very first instantiation in
-     *                                              BootstrapDependencyInjectionContainer::buildLoader()
-     *                                              otherwise can be left null
-     * @param ClassInterfaceCache|null $class_cache also provided during first instantiation
-     * @param ObjectIdentifier|null    $object_identifier
-     * @return LoaderInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function getLoader(
-        $generator = null,
-        ClassInterfaceCache $class_cache = null,
-        ObjectIdentifier $object_identifier = null
-    ) {
-        if (
-            ! LoaderFactory::$loader instanceof LoaderInterface
-            && ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)
-            && $class_cache instanceof ClassInterfaceCache
-            && $object_identifier instanceof ObjectIdentifier
-        ) {
-            $core_loader = new CoreLoader($generator);
-            LoaderFactory::$loader = new Loader(
-                $core_loader,
-                new CachingLoader(
-                    $core_loader,
-                    new LooseCollection(''),
-                    $object_identifier
-                ),
-                $class_cache
-            );
-        }
-        return LoaderFactory::$loader;
-    }
+	/**
+	 * @param EE_Registry|CoffeeShop   $generator   provided during very first instantiation in
+	 *                                              BootstrapDependencyInjectionContainer::buildLoader()
+	 *                                              otherwise can be left null
+	 * @param ClassInterfaceCache|null $class_cache also provided during first instantiation
+	 * @param ObjectIdentifier|null    $object_identifier
+	 * @return LoaderInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function getLoader(
+		$generator = null,
+		ClassInterfaceCache $class_cache = null,
+		ObjectIdentifier $object_identifier = null
+	) {
+		if (
+			! LoaderFactory::$loader instanceof LoaderInterface
+			&& ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)
+			&& $class_cache instanceof ClassInterfaceCache
+			&& $object_identifier instanceof ObjectIdentifier
+		) {
+			$core_loader = new CoreLoader($generator);
+			LoaderFactory::$loader = new Loader(
+				$core_loader,
+				new CachingLoader(
+					$core_loader,
+					new LooseCollection(''),
+					$object_identifier
+				),
+				$class_cache
+			);
+		}
+		return LoaderFactory::$loader;
+	}
 
 
 }

core/domain/DomainInterface.php

Indentation +36 added lines, -36 removed lines

@@ -16,55 +16,55 @@
 interface DomainInterface extends InterminableInterface
 {
 
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public function pluginFile();
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function pluginFile();
 
 
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public function pluginBasename();
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function pluginBasename();
 
 
-    /**
-     * @return string
-     */
-    public function pluginPath();
+	/**
+	 * @return string
+	 */
+	public function pluginPath();
 
 
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public function pluginUrl();
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function pluginUrl();
 
 
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public function version();
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function version();
 
 
-    /**
-     * @return string
-     */
-    public function distributionAssetsPath();
+	/**
+	 * @return string
+	 */
+	public function distributionAssetsPath();
 
 
-    /**
-     * @return string
-     */
-    public function distributionAssetsUrl();
+	/**
+	 * @return string
+	 */
+	public function distributionAssetsUrl();
 
 
-    /**
-     * @return string
-     */
-    public function assetNamespace();
+	/**
+	 * @return string
+	 */
+	public function assetNamespace();
 
 }