eventespresso / event-espresso-core

core/domain/services/admin/privacy/erasure/EraseAttendeeData.php

Indentation +61 added lines, -61 removed lines

@@ -16,74 +16,74 @@
 class EraseAttendeeData implements PersonalDataEraserInterface
 {
 
-    /**
-     * @var EEM_Attendee
-     */
-    protected $attendee_model;
+	/**
+	 * @var EEM_Attendee
+	 */
+	protected $attendee_model;
 
 
-    /**
-     * EraseAttendeeData constructor.
-     *
-     * @param EEM_Attendee $attendee_model
-     */
-    public function __construct(EEM_Attendee $attendee_model)
-    {
-        $this->attendee_model = $attendee_model;
-    }
+	/**
+	 * EraseAttendeeData constructor.
+	 *
+	 * @param EEM_Attendee $attendee_model
+	 */
+	public function __construct(EEM_Attendee $attendee_model)
+	{
+		$this->attendee_model = $attendee_model;
+	}
 
 
-    /**
-     * Gets a translated string name for the data eraser
-     *
-     * @return string
-     */
-    public function name()
-    {
-        return esc_html__('Event Espresso Attendee Data', 'event_espresso');
-    }
+	/**
+	 * Gets a translated string name for the data eraser
+	 *
+	 * @return string
+	 */
+	public function name()
+	{
+		return esc_html__('Event Espresso Attendee Data', 'event_espresso');
+	}
 
 
-    /**
-     * Erases a "page" of personal user data
-     *
-     * @return array {
-     * @type boolean $items_removed  whether items were removed successfully or not
-     * @type boolean $items_retained whether any items were skipped or not
-     * @type array   $messages       values are messages to show
-     * @type boolean $done           whether this eraser is done or has more pages
-     *               }
-     * @throws \EE_Error
-     */
-    public function erase($email_address, $page = 1)
-    {
-        $rows_updated = $this->attendee_model->update(
-            array(
-                'ATT_fname'    => esc_html__('Anonymous', 'event_espresso'),
-                'ATT_lname'    => '',
-                'ATT_email'    => '',
-                'ATT_address'  => '',
-                'ATT_address2' => '',
-                'ATT_city'     => '',
-                'STA_ID'       => 0,
-                'CNT_ISO'      => '',
-                'ATT_zip'      => '',
-                'ATT_phone'    => '',
-            ),
-            array(
-                array(
-                    'ATT_email' => $email_address,
-                ),
-            )
-        );
+	/**
+	 * Erases a "page" of personal user data
+	 *
+	 * @return array {
+	 * @type boolean $items_removed  whether items were removed successfully or not
+	 * @type boolean $items_retained whether any items were skipped or not
+	 * @type array   $messages       values are messages to show
+	 * @type boolean $done           whether this eraser is done or has more pages
+	 *               }
+	 * @throws \EE_Error
+	 */
+	public function erase($email_address, $page = 1)
+	{
+		$rows_updated = $this->attendee_model->update(
+			array(
+				'ATT_fname'    => esc_html__('Anonymous', 'event_espresso'),
+				'ATT_lname'    => '',
+				'ATT_email'    => '',
+				'ATT_address'  => '',
+				'ATT_address2' => '',
+				'ATT_city'     => '',
+				'STA_ID'       => 0,
+				'CNT_ISO'      => '',
+				'ATT_zip'      => '',
+				'ATT_phone'    => '',
+			),
+			array(
+				array(
+					'ATT_email' => $email_address,
+				),
+			)
+		);
 
-        return array(
-            'items_removed'  => (bool) $rows_updated,
-            'items_retained' => false, // always false in this example
-            'messages'       => array(),
-            'done'           => true,
-        );
-    }
+		return array(
+			'items_removed'  => (bool) $rows_updated,
+			'items_retained' => false, // always false in this example
+			'messages'       => array(),
+			'done'           => true,
+		);
+	}
 }
 // End of file EraseAttendeeData.php
 // Location: EventEspresso\core\domain\services\privacy\erasure/EraseAttendeeData.php

admin_pages/registrations/templates/reg_admin_details_main_meta_box_reg_questions.template.php

Braces +5 added lines, -2 removed lines

@@ -23,12 +23,15 @@
             <input id="reg-admin-attendee-questions-submit" class="button-primary" value="Update Registration Questions"
                    type="submit"/>
             <?php endif; ?>
-        <?php else : ?>
+        <?php else {
+	: ?>
             <p class="ee-attention">
                 <?php _e(
                     'There were no custom questions asked for this registration.',
                     'event_espresso'
-                ); ?></p>
+                );
+}
+?></p>
         <?php endif; ?>
 
     </form>

Indentation +11 added lines, -11 removed lines

@@ -1,9 +1,9 @@ 
 <div id="admin-primary-mbox-questions-dv" class="admin-primary-mbox-dv">
     <p>
         <?php _e(
-            'This displays the custom questions and answers for this registrant.  Please note that any answers to system questions have been saved with the contact record.  You can edit those answers via the "View/Edit this Contact" link in the Contact Details metabox in the sidebar.',
-            'event_espresso'
-        ); ?></p>
+			'This displays the custom questions and answers for this registrant.  Please note that any answers to system questions have been saved with the contact record.  You can edit those answers via the "View/Edit this Contact" link in the Contact Details metabox in the sidebar.',
+			'event_espresso'
+		); ?></p>
 
     <form name="reg-admin-attendee-questions-frm" id="reg-admin-attendee-questions-frm"
           action="<?php echo REG_ADMIN_URL; ?>" method="post">
@@ -16,11 +16,11 @@ 
         <?php echo $att_questions; ?>
         <?php if (! empty($att_questions)) : ?>
             <?php if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_registration',
-                'edit-reg-questions-mbox',
-                $REG_ID
-            )
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_registration',
+				'edit-reg-questions-mbox',
+				$REG_ID
+			)
 ) : ?>
             <input id="reg-admin-attendee-questions-submit" class="button-primary" value="Update Registration Questions"
                    type="submit"/>
@@ -28,9 +28,9 @@ 
         <?php else : ?>
             <p class="ee-attention">
                 <?php _e(
-                    'There were no custom questions asked for this registration.',
-                    'event_espresso'
-                ); ?></p>
+					'There were no custom questions asked for this registration.',
+					'event_espresso'
+				); ?></p>
         <?php endif; ?>
 
     </form>

Spacing +2 added lines, -2 removed lines

@@ -7,14 +7,14 @@
 
     <form name="reg-admin-attendee-questions-frm" id="reg-admin-attendee-questions-frm"
           action="<?php echo REG_ADMIN_URL; ?>" method="post">
-        <?php wp_nonce_field($reg_questions_form_action . '_nonce', $reg_questions_form_action . '_nonce'); ?>
+        <?php wp_nonce_field($reg_questions_form_action.'_nonce', $reg_questions_form_action.'_nonce'); ?>
         <input type="hidden" name="page" value="<?php echo REG_PG_SLUG; ?>"/>
         <input type="hidden" name="action" value="<?php echo $reg_questions_form_action; ?>"/>
         <input type="hidden" name="_REG_ID" value="<?php echo $REG_ID; ?>"/>
         <input type="hidden" name="espresso_ajax" id="espresso-ajax" value="0"/>
         <input type="hidden" name="noheader" id="reg-admin-noheader-inp" value="true"/>
         <?php echo $att_questions; ?>
-        <?php if (! empty($att_questions)) : ?>
+        <?php if ( ! empty($att_questions)) : ?>
             <?php if (
             EE_Registry::instance()->CAP->current_user_can(
                 'ee_edit_registration',

core/domain/entities/editor/BlockInterface.php

Indentation +66 added lines, -66 removed lines

@@ -22,70 +22,70 @@
 interface BlockInterface
 {
 
-    const NAME_SPACE = 'eventespresso';
-
-    /**
-     * Perform any early setup required by the block
-     * including setting the block type and supported post types
-     *
-     * @return void
-     */
-    public function initialize();
-
-
-    /**
-     * @return string
-     */
-    public function blockType();
-
-
-    /**
-     * AssetRegister that this editor block uses for asset registration
-     *
-     * @return BlockAssetManagerInterface
-     */
-    public function assetManager();
-
-
-    /**
-     * Registers the Editor Block with WP core;
-     * Returns the registered block type on success, or false on failure.
-     *
-     * @return WP_Block_Type|false
-     */
-    public function registerBlock();
-
-
-    /**
-     * Un-registers the Editor Block with WP core;
-     * Returns the registered block type on success, or false on failure.
-     *
-     * @return WP_Block_Type|false
-     */
-    public function unRegisterBlock();
-
-
-    /**
-     * returns an array of fully qualified class names
-     * for RouteMatchSpecificationInterface objects
-     * that specify routes that the block should be loaded for.
-     *
-     * @return array
-     */
-    public function supportedRoutes();
-
-
-    /**
-     * @return array
-     */
-    public function getEditorContainer();
-
-
-    /**
-     * returns the rendered HTML for the block
-     *
-     * @param array $attributes
-     * @return string
-     */
-    public function renderBlock(array $attributes = array());
+	const NAME_SPACE = 'eventespresso';
+
+	/**
+	 * Perform any early setup required by the block
+	 * including setting the block type and supported post types
+	 *
+	 * @return void
+	 */
+	public function initialize();
+
+
+	/**
+	 * @return string
+	 */
+	public function blockType();
+
+
+	/**
+	 * AssetRegister that this editor block uses for asset registration
+	 *
+	 * @return BlockAssetManagerInterface
+	 */
+	public function assetManager();
+
+
+	/**
+	 * Registers the Editor Block with WP core;
+	 * Returns the registered block type on success, or false on failure.
+	 *
+	 * @return WP_Block_Type|false
+	 */
+	public function registerBlock();
+
+
+	/**
+	 * Un-registers the Editor Block with WP core;
+	 * Returns the registered block type on success, or false on failure.
+	 *
+	 * @return WP_Block_Type|false
+	 */
+	public function unRegisterBlock();
+
+
+	/**
+	 * returns an array of fully qualified class names
+	 * for RouteMatchSpecificationInterface objects
+	 * that specify routes that the block should be loaded for.
+	 *
+	 * @return array
+	 */
+	public function supportedRoutes();
+
+
+	/**
+	 * @return array
+	 */
+	public function getEditorContainer();
+
+
+	/**
+	 * returns the rendered HTML for the block
+	 *
+	 * @param array $attributes
+	 * @return string
+	 */
+	public function renderBlock(array $attributes = array());
 }

core/services/editor/BlockManager.php

Indentation +42 added lines, -42 removed lines

@@ -18,46 +18,46 @@
 abstract class BlockManager
 {
 
-    /**
-     * @var CollectionInterface|BlockInterface[] $blocks
-     */
-    protected $blocks;
-
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
-
-
-
-    /**
-     * BlockManager constructor.
-     *
-     * @param BlockCollection   $blocks
-     * @param RequestInterface  $request
-     */
-    public function __construct(
-        BlockCollection $blocks,
-        RequestInterface $request
-    ) {
-        $this->blocks            = $blocks;
-        $this->request           = $request;
-        add_action($this->initHook(), array($this, 'initialize'));
-    }
-
-
-    /**
-     *  Returns the name of a hookpoint to be used to call initialize()
-     *
-     * @return string
-     */
-    abstract public function initHook();
-
-
-    /**
-     * Perform any early setup required for block editors to functions
-     *
-     * @return void
-     */
-    abstract public function initialize();
+	/**
+	 * @var CollectionInterface|BlockInterface[] $blocks
+	 */
+	protected $blocks;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
+
+
+
+	/**
+	 * BlockManager constructor.
+	 *
+	 * @param BlockCollection   $blocks
+	 * @param RequestInterface  $request
+	 */
+	public function __construct(
+		BlockCollection $blocks,
+		RequestInterface $request
+	) {
+		$this->blocks            = $blocks;
+		$this->request           = $request;
+		add_action($this->initHook(), array($this, 'initialize'));
+	}
+
+
+	/**
+	 *  Returns the name of a hookpoint to be used to call initialize()
+	 *
+	 * @return string
+	 */
+	abstract public function initHook();
+
+
+	/**
+	 * Perform any early setup required for block editors to functions
+	 *
+	 * @return void
+	 */
+	abstract public function initialize();
 }

core/services/collections/Collection.php

Spacing +10 added lines, -10 removed lines

@@ -66,7 +66,7 @@ 
      */
     protected function setCollectionInterface($collection_interface)
     {
-        if (! (interface_exists($collection_interface) || class_exists($collection_interface))) {
+        if ( ! (interface_exists($collection_interface) || class_exists($collection_interface))) {
             throw new InvalidInterfaceException($collection_interface);
         }
         $this->collection_interface = $collection_interface;
@@ -111,13 +111,13 @@ 
     protected function setCollectionIdentifier()
     {
         // hash a few collection details
-        $identifier = md5(spl_object_hash($this) . $this->collection_interface . time());
+        $identifier = md5(spl_object_hash($this).$this->collection_interface.time());
         // grab a few characters from the start, middle, and end of the hash
         $id = array();
         for ($x = 0; $x < 19; $x += 9) {
             $id[] = substr($identifier, $x, 3);
         }
-        $this->collection_identifier = $this->collection_name . '-' . strtoupper(implode('-', $id));
+        $this->collection_identifier = $this->collection_name.'-'.strtoupper(implode('-', $id));
     }
 
 
@@ -135,7 +135,7 @@ 
      */
     public function add($object, $identifier = null)
     {
-        if (! $object instanceof $this->collection_interface) {
+        if ( ! $object instanceof $this->collection_interface) {
             throw new InvalidEntityException($object, $this->collection_interface);
         }
         if ($this->contains($object)) {
@@ -351,7 +351,7 @@ 
      */
     public function indexOf($object)
     {
-        if (! $this->contains($object)) {
+        if ( ! $this->contains($object)) {
             return false;
         }
         foreach ($this as $index => $obj) {
@@ -420,9 +420,9 @@ 
             $remaining_objects = $this->slice($index, $this->count() - $index);
             foreach ($remaining_objects as $key => $remaining_object) {
                 // we need to grab the identifiers for each object and use them as keys
-                $remaining_objects[ $remaining_object->getInfo() ] = $remaining_object;
+                $remaining_objects[$remaining_object->getInfo()] = $remaining_object;
                 // and then remove the object from the current tracking array
-                unset($remaining_objects[ $key ]);
+                unset($remaining_objects[$key]);
                 // and then remove it from the Collection
                 $this->detach($remaining_object);
             }
@@ -446,17 +446,17 @@ 
      */
     public function insertAt($objects, $index)
     {
-        if (! is_array($objects)) {
+        if ( ! is_array($objects)) {
             $objects = array($objects);
         }
         // check to ensure that objects don't already exist in the collection
         foreach ($objects as $key => $object) {
             if ($this->contains($object)) {
-                unset($objects[ $key ]);
+                unset($objects[$key]);
             }
         }
         // do we have any objects left?
-        if (! $objects) {
+        if ( ! $objects) {
             return;
         }
         // detach any objects at or past this index

Indentation +500 added lines, -500 removed lines

@@ -19,504 +19,504 @@
 class Collection extends SplObjectStorage implements CollectionInterface
 {
 
-    /**
-     * a unique string for identifying this collection
-     *
-     * @type string $collection_identifier
-     */
-    protected $collection_identifier;
-
-
-    /**
-     * an interface (or class) name to be used for restricting the type of objects added to the storage
-     * this should be set from within the child class constructor
-     *
-     * @type string $interface
-     */
-    protected $collection_interface;
-
-    /**
-     * a short dash separated string describing the contents of this collection
-     * used as the base for the $collection_identifier
-     * defaults to the class short name if not set
-     *
-     * @type string $collection_identifier
-     */
-    protected $collection_name;
-
-
-    /**
-     * Collection constructor
-     *
-     * @param string $collection_interface
-     * @param string $collection_name
-     * @throws InvalidInterfaceException
-     */
-    public function __construct($collection_interface, $collection_name = '')
-    {
-        $this->setCollectionInterface($collection_interface);
-        $this->setCollectionName($collection_name);
-        $this->setCollectionIdentifier();
-    }
-
-
-    /**
-     * setCollectionInterface
-     *
-     * @param  string $collection_interface
-     * @throws InvalidInterfaceException
-     */
-    protected function setCollectionInterface($collection_interface)
-    {
-        if (! (interface_exists($collection_interface) || class_exists($collection_interface))) {
-            throw new InvalidInterfaceException($collection_interface);
-        }
-        $this->collection_interface = $collection_interface;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function collectionName()
-    {
-        return $this->collection_name;
-    }
-
-
-    /**
-     * @param string $collection_name
-     */
-    protected function setCollectionName($collection_name)
-    {
-        $this->collection_name = ! empty($collection_name)
-            ? sanitize_key($collection_name)
-            : basename(str_replace('\\', '/', get_class($this)));
-    }
-
-
-    /**
-     * @return string
-     */
-    public function collectionIdentifier()
-    {
-        return $this->collection_identifier;
-    }
-
-
-    /**
-     * creates a very readable unique 9 character identifier like:  CF2-532-DAC
-     * and appends it to the non-qualified class name, ex: ThingCollection-CF2-532-DAC
-     *
-     * @return void
-     */
-    protected function setCollectionIdentifier()
-    {
-        // hash a few collection details
-        $identifier = md5(spl_object_hash($this) . $this->collection_interface . time());
-        // grab a few characters from the start, middle, and end of the hash
-        $id = array();
-        for ($x = 0; $x < 19; $x += 9) {
-            $id[] = substr($identifier, $x, 3);
-        }
-        $this->collection_identifier = $this->collection_name . '-' . strtoupper(implode('-', $id));
-    }
-
-
-    /**
-     * add
-     * attaches an object to the Collection
-     * and sets any supplied data associated with the current iterator entry
-     * by calling EE_Object_Collection::set_identifier()
-     *
-     * @param        $object
-     * @param  mixed $identifier
-     * @return bool
-     * @throws InvalidEntityException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    public function add($object, $identifier = null)
-    {
-        if (! $object instanceof $this->collection_interface) {
-            throw new InvalidEntityException($object, $this->collection_interface);
-        }
-        if ($this->contains($object)) {
-            throw new DuplicateCollectionIdentifierException($identifier);
-        }
-        $this->attach($object);
-        $this->setIdentifier($object, $identifier);
-        return $this->contains($object);
-    }
-
-
-    /**
-     * getIdentifier
-     * if no $identifier is supplied, then the spl_object_hash() is used
-     *
-     * @param        $object
-     * @param  mixed $identifier
-     * @return bool
-     */
-    public function getIdentifier($object, $identifier = null)
-    {
-        return ! empty($identifier)
-            ? $identifier
-            : spl_object_hash($object);
-    }
-
-
-    /**
-     * setIdentifier
-     * Sets the data associated with an object in the Collection
-     * if no $identifier is supplied, then the spl_object_hash() is used
-     *
-     * @param        $object
-     * @param  mixed $identifier
-     * @return bool
-     */
-    public function setIdentifier($object, $identifier = null)
-    {
-        $identifier = $this->getIdentifier($object, $identifier);
-        $this->rewind();
-        while ($this->valid()) {
-            if ($object === $this->current()) {
-                $this->setInfo($identifier);
-                $this->rewind();
-                return true;
-            }
-            $this->next();
-        }
-        return false;
-    }
-
-
-    /**
-     * get
-     * finds and returns an object in the Collection based on the identifier that was set using addObject()
-     * PLZ NOTE: the pointer is reset to the beginning of the collection before returning
-     *
-     * @param mixed $identifier
-     * @return mixed
-     */
-    public function get($identifier)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($identifier === $this->getInfo()) {
-                $object = $this->current();
-                $this->rewind();
-                return $object;
-            }
-            $this->next();
-        }
-        return null;
-    }
-
-
-    /**
-     * has
-     * returns TRUE or FALSE
-     * depending on whether the object is within the Collection
-     * based on the supplied $identifier
-     *
-     * @param  mixed $identifier
-     * @return bool
-     */
-    public function has($identifier)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($identifier === $this->getInfo()) {
-                $this->rewind();
-                return true;
-            }
-            $this->next();
-        }
-        return false;
-    }
-
-
-    /**
-     * hasObject
-     * returns TRUE or FALSE depending on whether the supplied object is within the Collection
-     *
-     * @param $object
-     * @return bool
-     */
-    public function hasObject($object)
-    {
-        return $this->contains($object);
-    }
-
-
-    /**
-     * hasObjects
-     * returns true if there are objects within the Collection, and false if it is empty
-     *
-     * @return bool
-     */
-    public function hasObjects()
-    {
-        return $this->count() !== 0;
-    }
-
-
-    /**
-     * isEmpty
-     * returns true if there are no objects within the Collection, and false if there are
-     *
-     * @return bool
-     */
-    public function isEmpty()
-    {
-        return $this->count() === 0;
-    }
-
-
-    /**
-     * remove
-     * detaches an object from the Collection
-     *
-     * @param $object
-     * @return bool
-     */
-    public function remove($object)
-    {
-        $this->detach($object);
-        return true;
-    }
-
-
-    /**
-     * setCurrent
-     * advances pointer to the object whose identifier matches that which was provided
-     *
-     * @param mixed $identifier
-     * @return boolean
-     */
-    public function setCurrent($identifier)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($identifier === $this->getInfo()) {
-                return true;
-            }
-            $this->next();
-        }
-        return false;
-    }
-
-
-    /**
-     * setCurrentUsingObject
-     * advances pointer to the provided object
-     *
-     * @param $object
-     * @return boolean
-     */
-    public function setCurrentUsingObject($object)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($this->current() === $object) {
-                return true;
-            }
-            $this->next();
-        }
-        return false;
-    }
-
-
-    /**
-     * Returns the object occupying the index before the current object,
-     * unless this is already the first object, in which case it just returns the first object
-     *
-     * @return mixed
-     */
-    public function previous()
-    {
-        $index = $this->indexOf($this->current());
-        if ($index === 0) {
-            return $this->current();
-        }
-        $index--;
-        return $this->objectAtIndex($index);
-    }
-
-
-    /**
-     * Returns the index of a given object, or false if not found
-     *
-     * @see http://stackoverflow.com/a/8736013
-     * @param $object
-     * @return boolean|int|string
-     */
-    public function indexOf($object)
-    {
-        if (! $this->contains($object)) {
-            return false;
-        }
-        foreach ($this as $index => $obj) {
-            if ($obj === $object) {
-                return $index;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Returns the object at the given index
-     *
-     * @see http://stackoverflow.com/a/8736013
-     * @param int $index
-     * @return mixed
-     */
-    public function objectAtIndex($index)
-    {
-        $iterator = new LimitIterator($this, $index, 1);
-        $iterator->rewind();
-        return $iterator->current();
-    }
-
-
-    /**
-     * Returns the sequence of objects as specified by the offset and length
-     *
-     * @see http://stackoverflow.com/a/8736013
-     * @param int $offset
-     * @param int $length
-     * @return array
-     */
-    public function slice($offset, $length)
-    {
-        $slice = array();
-        $iterator = new LimitIterator($this, $offset, $length);
-        foreach ($iterator as $object) {
-            $slice[] = $object;
-        }
-        return $slice;
-    }
-
-
-    /**
-     * Inserts an object at a certain point
-     *
-     * @see http://stackoverflow.com/a/8736013
-     * @param mixed $object A single object
-     * @param int   $index
-     * @param mixed $identifier
-     * @return bool
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidEntityException
-     */
-    public function insertObjectAt($object, $index, $identifier = null)
-    {
-        // check to ensure that objects don't already exist in the collection
-        if ($this->has($identifier)) {
-            throw new DuplicateCollectionIdentifierException($identifier);
-        }
-        // detach any objects at or past this index
-        $remaining_objects = array();
-        if ($index < $this->count()) {
-            $remaining_objects = $this->slice($index, $this->count() - $index);
-            foreach ($remaining_objects as $key => $remaining_object) {
-                // we need to grab the identifiers for each object and use them as keys
-                $remaining_objects[ $remaining_object->getInfo() ] = $remaining_object;
-                // and then remove the object from the current tracking array
-                unset($remaining_objects[ $key ]);
-                // and then remove it from the Collection
-                $this->detach($remaining_object);
-            }
-        }
-        // add the new object we're splicing in
-        $this->add($object, $identifier);
-        // attach the objects we previously detached
-        foreach ($remaining_objects as $key => $remaining_object) {
-            $this->add($remaining_object, $key);
-        }
-        return $this->contains($object);
-    }
-
-
-    /**
-     * Inserts an object (or an array of objects) at a certain point
-     *
-     * @see http://stackoverflow.com/a/8736013
-     * @param mixed $objects A single object or an array of objects
-     * @param int   $index
-     */
-    public function insertAt($objects, $index)
-    {
-        if (! is_array($objects)) {
-            $objects = array($objects);
-        }
-        // check to ensure that objects don't already exist in the collection
-        foreach ($objects as $key => $object) {
-            if ($this->contains($object)) {
-                unset($objects[ $key ]);
-            }
-        }
-        // do we have any objects left?
-        if (! $objects) {
-            return;
-        }
-        // detach any objects at or past this index
-        $remaining = array();
-        if ($index < $this->count()) {
-            $remaining = $this->slice($index, $this->count() - $index);
-            foreach ($remaining as $object) {
-                $this->detach($object);
-            }
-        }
-        // add the new objects we're splicing in
-        foreach ($objects as $object) {
-            $this->attach($object);
-        }
-        // attach the objects we previously detached
-        foreach ($remaining as $object) {
-            $this->attach($object);
-        }
-    }
-
-
-    /**
-     * Removes the object at the given index
-     *
-     * @see http://stackoverflow.com/a/8736013
-     * @param int $index
-     */
-    public function removeAt($index)
-    {
-        $this->detach($this->objectAtIndex($index));
-    }
-
-
-    /**
-     * detaches ALL objects from the Collection
-     */
-    public function detachAll()
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            $object = $this->current();
-            $this->next();
-            $this->detach($object);
-        }
-    }
-
-
-    /**
-     * unsets and detaches ALL objects from the Collection
-     */
-    public function trashAndDetachAll()
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            $object = $this->current();
-            $this->next();
-            $this->detach($object);
-            unset($object);
-        }
-    }
+	/**
+	 * a unique string for identifying this collection
+	 *
+	 * @type string $collection_identifier
+	 */
+	protected $collection_identifier;
+
+
+	/**
+	 * an interface (or class) name to be used for restricting the type of objects added to the storage
+	 * this should be set from within the child class constructor
+	 *
+	 * @type string $interface
+	 */
+	protected $collection_interface;
+
+	/**
+	 * a short dash separated string describing the contents of this collection
+	 * used as the base for the $collection_identifier
+	 * defaults to the class short name if not set
+	 *
+	 * @type string $collection_identifier
+	 */
+	protected $collection_name;
+
+
+	/**
+	 * Collection constructor
+	 *
+	 * @param string $collection_interface
+	 * @param string $collection_name
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct($collection_interface, $collection_name = '')
+	{
+		$this->setCollectionInterface($collection_interface);
+		$this->setCollectionName($collection_name);
+		$this->setCollectionIdentifier();
+	}
+
+
+	/**
+	 * setCollectionInterface
+	 *
+	 * @param  string $collection_interface
+	 * @throws InvalidInterfaceException
+	 */
+	protected function setCollectionInterface($collection_interface)
+	{
+		if (! (interface_exists($collection_interface) || class_exists($collection_interface))) {
+			throw new InvalidInterfaceException($collection_interface);
+		}
+		$this->collection_interface = $collection_interface;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function collectionName()
+	{
+		return $this->collection_name;
+	}
+
+
+	/**
+	 * @param string $collection_name
+	 */
+	protected function setCollectionName($collection_name)
+	{
+		$this->collection_name = ! empty($collection_name)
+			? sanitize_key($collection_name)
+			: basename(str_replace('\\', '/', get_class($this)));
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function collectionIdentifier()
+	{
+		return $this->collection_identifier;
+	}
+
+
+	/**
+	 * creates a very readable unique 9 character identifier like:  CF2-532-DAC
+	 * and appends it to the non-qualified class name, ex: ThingCollection-CF2-532-DAC
+	 *
+	 * @return void
+	 */
+	protected function setCollectionIdentifier()
+	{
+		// hash a few collection details
+		$identifier = md5(spl_object_hash($this) . $this->collection_interface . time());
+		// grab a few characters from the start, middle, and end of the hash
+		$id = array();
+		for ($x = 0; $x < 19; $x += 9) {
+			$id[] = substr($identifier, $x, 3);
+		}
+		$this->collection_identifier = $this->collection_name . '-' . strtoupper(implode('-', $id));
+	}
+
+
+	/**
+	 * add
+	 * attaches an object to the Collection
+	 * and sets any supplied data associated with the current iterator entry
+	 * by calling EE_Object_Collection::set_identifier()
+	 *
+	 * @param        $object
+	 * @param  mixed $identifier
+	 * @return bool
+	 * @throws InvalidEntityException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	public function add($object, $identifier = null)
+	{
+		if (! $object instanceof $this->collection_interface) {
+			throw new InvalidEntityException($object, $this->collection_interface);
+		}
+		if ($this->contains($object)) {
+			throw new DuplicateCollectionIdentifierException($identifier);
+		}
+		$this->attach($object);
+		$this->setIdentifier($object, $identifier);
+		return $this->contains($object);
+	}
+
+
+	/**
+	 * getIdentifier
+	 * if no $identifier is supplied, then the spl_object_hash() is used
+	 *
+	 * @param        $object
+	 * @param  mixed $identifier
+	 * @return bool
+	 */
+	public function getIdentifier($object, $identifier = null)
+	{
+		return ! empty($identifier)
+			? $identifier
+			: spl_object_hash($object);
+	}
+
+
+	/**
+	 * setIdentifier
+	 * Sets the data associated with an object in the Collection
+	 * if no $identifier is supplied, then the spl_object_hash() is used
+	 *
+	 * @param        $object
+	 * @param  mixed $identifier
+	 * @return bool
+	 */
+	public function setIdentifier($object, $identifier = null)
+	{
+		$identifier = $this->getIdentifier($object, $identifier);
+		$this->rewind();
+		while ($this->valid()) {
+			if ($object === $this->current()) {
+				$this->setInfo($identifier);
+				$this->rewind();
+				return true;
+			}
+			$this->next();
+		}
+		return false;
+	}
+
+
+	/**
+	 * get
+	 * finds and returns an object in the Collection based on the identifier that was set using addObject()
+	 * PLZ NOTE: the pointer is reset to the beginning of the collection before returning
+	 *
+	 * @param mixed $identifier
+	 * @return mixed
+	 */
+	public function get($identifier)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($identifier === $this->getInfo()) {
+				$object = $this->current();
+				$this->rewind();
+				return $object;
+			}
+			$this->next();
+		}
+		return null;
+	}
+
+
+	/**
+	 * has
+	 * returns TRUE or FALSE
+	 * depending on whether the object is within the Collection
+	 * based on the supplied $identifier
+	 *
+	 * @param  mixed $identifier
+	 * @return bool
+	 */
+	public function has($identifier)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($identifier === $this->getInfo()) {
+				$this->rewind();
+				return true;
+			}
+			$this->next();
+		}
+		return false;
+	}
+
+
+	/**
+	 * hasObject
+	 * returns TRUE or FALSE depending on whether the supplied object is within the Collection
+	 *
+	 * @param $object
+	 * @return bool
+	 */
+	public function hasObject($object)
+	{
+		return $this->contains($object);
+	}
+
+
+	/**
+	 * hasObjects
+	 * returns true if there are objects within the Collection, and false if it is empty
+	 *
+	 * @return bool
+	 */
+	public function hasObjects()
+	{
+		return $this->count() !== 0;
+	}
+
+
+	/**
+	 * isEmpty
+	 * returns true if there are no objects within the Collection, and false if there are
+	 *
+	 * @return bool
+	 */
+	public function isEmpty()
+	{
+		return $this->count() === 0;
+	}
+
+
+	/**
+	 * remove
+	 * detaches an object from the Collection
+	 *
+	 * @param $object
+	 * @return bool
+	 */
+	public function remove($object)
+	{
+		$this->detach($object);
+		return true;
+	}
+
+
+	/**
+	 * setCurrent
+	 * advances pointer to the object whose identifier matches that which was provided
+	 *
+	 * @param mixed $identifier
+	 * @return boolean
+	 */
+	public function setCurrent($identifier)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($identifier === $this->getInfo()) {
+				return true;
+			}
+			$this->next();
+		}
+		return false;
+	}
+
+
+	/**
+	 * setCurrentUsingObject
+	 * advances pointer to the provided object
+	 *
+	 * @param $object
+	 * @return boolean
+	 */
+	public function setCurrentUsingObject($object)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($this->current() === $object) {
+				return true;
+			}
+			$this->next();
+		}
+		return false;
+	}
+
+
+	/**
+	 * Returns the object occupying the index before the current object,
+	 * unless this is already the first object, in which case it just returns the first object
+	 *
+	 * @return mixed
+	 */
+	public function previous()
+	{
+		$index = $this->indexOf($this->current());
+		if ($index === 0) {
+			return $this->current();
+		}
+		$index--;
+		return $this->objectAtIndex($index);
+	}
+
+
+	/**
+	 * Returns the index of a given object, or false if not found
+	 *
+	 * @see http://stackoverflow.com/a/8736013
+	 * @param $object
+	 * @return boolean|int|string
+	 */
+	public function indexOf($object)
+	{
+		if (! $this->contains($object)) {
+			return false;
+		}
+		foreach ($this as $index => $obj) {
+			if ($obj === $object) {
+				return $index;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Returns the object at the given index
+	 *
+	 * @see http://stackoverflow.com/a/8736013
+	 * @param int $index
+	 * @return mixed
+	 */
+	public function objectAtIndex($index)
+	{
+		$iterator = new LimitIterator($this, $index, 1);
+		$iterator->rewind();
+		return $iterator->current();
+	}
+
+
+	/**
+	 * Returns the sequence of objects as specified by the offset and length
+	 *
+	 * @see http://stackoverflow.com/a/8736013
+	 * @param int $offset
+	 * @param int $length
+	 * @return array
+	 */
+	public function slice($offset, $length)
+	{
+		$slice = array();
+		$iterator = new LimitIterator($this, $offset, $length);
+		foreach ($iterator as $object) {
+			$slice[] = $object;
+		}
+		return $slice;
+	}
+
+
+	/**
+	 * Inserts an object at a certain point
+	 *
+	 * @see http://stackoverflow.com/a/8736013
+	 * @param mixed $object A single object
+	 * @param int   $index
+	 * @param mixed $identifier
+	 * @return bool
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidEntityException
+	 */
+	public function insertObjectAt($object, $index, $identifier = null)
+	{
+		// check to ensure that objects don't already exist in the collection
+		if ($this->has($identifier)) {
+			throw new DuplicateCollectionIdentifierException($identifier);
+		}
+		// detach any objects at or past this index
+		$remaining_objects = array();
+		if ($index < $this->count()) {
+			$remaining_objects = $this->slice($index, $this->count() - $index);
+			foreach ($remaining_objects as $key => $remaining_object) {
+				// we need to grab the identifiers for each object and use them as keys
+				$remaining_objects[ $remaining_object->getInfo() ] = $remaining_object;
+				// and then remove the object from the current tracking array
+				unset($remaining_objects[ $key ]);
+				// and then remove it from the Collection
+				$this->detach($remaining_object);
+			}
+		}
+		// add the new object we're splicing in
+		$this->add($object, $identifier);
+		// attach the objects we previously detached
+		foreach ($remaining_objects as $key => $remaining_object) {
+			$this->add($remaining_object, $key);
+		}
+		return $this->contains($object);
+	}
+
+
+	/**
+	 * Inserts an object (or an array of objects) at a certain point
+	 *
+	 * @see http://stackoverflow.com/a/8736013
+	 * @param mixed $objects A single object or an array of objects
+	 * @param int   $index
+	 */
+	public function insertAt($objects, $index)
+	{
+		if (! is_array($objects)) {
+			$objects = array($objects);
+		}
+		// check to ensure that objects don't already exist in the collection
+		foreach ($objects as $key => $object) {
+			if ($this->contains($object)) {
+				unset($objects[ $key ]);
+			}
+		}
+		// do we have any objects left?
+		if (! $objects) {
+			return;
+		}
+		// detach any objects at or past this index
+		$remaining = array();
+		if ($index < $this->count()) {
+			$remaining = $this->slice($index, $this->count() - $index);
+			foreach ($remaining as $object) {
+				$this->detach($object);
+			}
+		}
+		// add the new objects we're splicing in
+		foreach ($objects as $object) {
+			$this->attach($object);
+		}
+		// attach the objects we previously detached
+		foreach ($remaining as $object) {
+			$this->attach($object);
+		}
+	}
+
+
+	/**
+	 * Removes the object at the given index
+	 *
+	 * @see http://stackoverflow.com/a/8736013
+	 * @param int $index
+	 */
+	public function removeAt($index)
+	{
+		$this->detach($this->objectAtIndex($index));
+	}
+
+
+	/**
+	 * detaches ALL objects from the Collection
+	 */
+	public function detachAll()
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			$object = $this->current();
+			$this->next();
+			$this->detach($object);
+		}
+	}
+
+
+	/**
+	 * unsets and detaches ALL objects from the Collection
+	 */
+	public function trashAndDetachAll()
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			$object = $this->current();
+			$this->next();
+			$this->detach($object);
+			unset($object);
+		}
+	}
 }

core/services/collections/CollectionLoader.php

Indentation +267 added lines, -267 removed lines

@@ -29,295 +29,295 @@
 class CollectionLoader
 {
 
-    /**
-     * possible return value when adding entities to a collection.
-     * denotes that the entity was NOT ADDED to the collection
-     */
-    const ENTITY_NOT_ADDED = 'entity-not-added-to-collection';
+	/**
+	 * possible return value when adding entities to a collection.
+	 * denotes that the entity was NOT ADDED to the collection
+	 */
+	const ENTITY_NOT_ADDED = 'entity-not-added-to-collection';
 
-    /**
-     * possible return value when adding entities to a collection.
-     * denotes that the entity was SUCCESSFULLY ADDED to the collection
-     */
-    const ENTITY_ADDED = 'entity-added-to-collection';
+	/**
+	 * possible return value when adding entities to a collection.
+	 * denotes that the entity was SUCCESSFULLY ADDED to the collection
+	 */
+	const ENTITY_ADDED = 'entity-added-to-collection';
 
-    /**
-     * possible return value when adding entities to a collection.
-     * denotes that the entity was ALREADY ADDED to the collection,
-     * and therefore could not be added again.
-     */
-    const ENTITY_EXISTS = 'entity-already-in-collection';
+	/**
+	 * possible return value when adding entities to a collection.
+	 * denotes that the entity was ALREADY ADDED to the collection,
+	 * and therefore could not be added again.
+	 */
+	const ENTITY_EXISTS = 'entity-already-in-collection';
 
 
-    /**
-     * @var CollectionDetailsInterface $collection_details
-     */
-    protected $collection_details;
+	/**
+	 * @var CollectionDetailsInterface $collection_details
+	 */
+	protected $collection_details;
 
-    /**
-     * @var CollectionInterface $collection
-     */
-    protected $collection;
+	/**
+	 * @var CollectionInterface $collection
+	 */
+	protected $collection;
 
-    /**
-     * @var FactoryInterface $entity_factory
-     */
-    protected $entity_factory;
+	/**
+	 * @var FactoryInterface $entity_factory
+	 */
+	protected $entity_factory;
 
-    /**
-     * @var FileLocator $file_locator
-     */
-    protected $file_locator;
+	/**
+	 * @var FileLocator $file_locator
+	 */
+	protected $file_locator;
 
 
-    /**
-     * CollectionLoader constructor.
-     *
-     * @param CollectionDetailsInterface $collection_details
-     * @param CollectionInterface        $collection
-     * @param LocatorInterface           $file_locator
-     * @param FactoryInterface|null      $entity_factory
-     * @throws CollectionLoaderException
-     */
-    public function __construct(
-        CollectionDetailsInterface $collection_details,
-        CollectionInterface $collection = null,
-        LocatorInterface $file_locator = null,
-        FactoryInterface $entity_factory = null
-    ) {
-        try {
-            $this->collection_details = $collection_details;
-            if (! $collection instanceof CollectionInterface) {
-                $collection = new Collection($this->collection_details->getCollectionInterface());
-            }
-            $this->collection = $collection;
-            $this->file_locator = $file_locator;
-            $this->entity_factory = $entity_factory;
-            $this->loadAllFromFilepaths();
-            $this->loadFromFQCNs();
-        } catch (Exception $exception) {
-            throw new CollectionLoaderException($exception);
-        }
-    }
+	/**
+	 * CollectionLoader constructor.
+	 *
+	 * @param CollectionDetailsInterface $collection_details
+	 * @param CollectionInterface        $collection
+	 * @param LocatorInterface           $file_locator
+	 * @param FactoryInterface|null      $entity_factory
+	 * @throws CollectionLoaderException
+	 */
+	public function __construct(
+		CollectionDetailsInterface $collection_details,
+		CollectionInterface $collection = null,
+		LocatorInterface $file_locator = null,
+		FactoryInterface $entity_factory = null
+	) {
+		try {
+			$this->collection_details = $collection_details;
+			if (! $collection instanceof CollectionInterface) {
+				$collection = new Collection($this->collection_details->getCollectionInterface());
+			}
+			$this->collection = $collection;
+			$this->file_locator = $file_locator;
+			$this->entity_factory = $entity_factory;
+			$this->loadAllFromFilepaths();
+			$this->loadFromFQCNs();
+		} catch (Exception $exception) {
+			throw new CollectionLoaderException($exception);
+		}
+	}
 
 
-    /**
-     * @return CollectionInterface
-     */
-    public function getCollection()
-    {
-        return $this->collection;
-    }
+	/**
+	 * @return CollectionInterface
+	 */
+	public function getCollection()
+	{
+		return $this->collection;
+	}
 
 
-    /**
-     * @throws InvalidClassException
-     * @throws InvalidFilePathException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    protected function loadAllFromFilepaths()
-    {
-        if (! $this->file_locator instanceof FileLocator) {
-            $this->file_locator = new FileLocator();
-        }
-        $this->file_locator->setFileMask($this->collection_details->getFileMask());
-        // find all of the files that match the file mask in the specified folder
-        $this->file_locator->locate($this->collection_details->getCollectionPaths());
-        // filter the results
-        $filepaths = (array) apply_filters(
-            'FHEE__CollectionLoader__loadAllFromFilepath__filepaths',
-            $this->file_locator->getFilePaths(),
-            $this->collection_details->collectionName(),
-            $this->collection_details
-        );
-        if (empty($filepaths)) {
-            return;
-        }
-        foreach ($filepaths as $filepath) {
-            $this->loadClassFromFilepath($filepath);
-        }
-    }
+	/**
+	 * @throws InvalidClassException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	protected function loadAllFromFilepaths()
+	{
+		if (! $this->file_locator instanceof FileLocator) {
+			$this->file_locator = new FileLocator();
+		}
+		$this->file_locator->setFileMask($this->collection_details->getFileMask());
+		// find all of the files that match the file mask in the specified folder
+		$this->file_locator->locate($this->collection_details->getCollectionPaths());
+		// filter the results
+		$filepaths = (array) apply_filters(
+			'FHEE__CollectionLoader__loadAllFromFilepath__filepaths',
+			$this->file_locator->getFilePaths(),
+			$this->collection_details->collectionName(),
+			$this->collection_details
+		);
+		if (empty($filepaths)) {
+			return;
+		}
+		foreach ($filepaths as $filepath) {
+			$this->loadClassFromFilepath($filepath);
+		}
+	}
 
 
-    /**
-     * @param  string $filepath
-     * @return string
-     * @throws InvalidEntityException
-     * @throws InvalidDataTypeException
-     * @throws InvalidFilePathException
-     * @throws InvalidClassException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    protected function loadClassFromFilepath($filepath)
-    {
-        if (! is_string($filepath)) {
-            throw new InvalidDataTypeException('$filepath', $filepath, 'string');
-        }
-        if (! is_readable($filepath)) {
-            throw new InvalidFilePathException($filepath);
-        }
-        require_once $filepath;
-        // extract filename from path
-        $file_name = basename($filepath);
-        // now remove any file extensions
-        $class_name = EEH_File::get_classname_from_filepath_with_standard_filename($file_name);
-        if (! class_exists($class_name)) {
-            throw new InvalidClassException($class_name);
-        }
-        $entity = $this->entity_factory instanceof FactoryInterface
-            ? call_user_func(array($this->entity_factory, 'create'), $class_name)
-            : new $class_name();
-        return $this->addEntityToCollection($entity, $file_name);
-    }
+	/**
+	 * @param  string $filepath
+	 * @return string
+	 * @throws InvalidEntityException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidClassException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	protected function loadClassFromFilepath($filepath)
+	{
+		if (! is_string($filepath)) {
+			throw new InvalidDataTypeException('$filepath', $filepath, 'string');
+		}
+		if (! is_readable($filepath)) {
+			throw new InvalidFilePathException($filepath);
+		}
+		require_once $filepath;
+		// extract filename from path
+		$file_name = basename($filepath);
+		// now remove any file extensions
+		$class_name = EEH_File::get_classname_from_filepath_with_standard_filename($file_name);
+		if (! class_exists($class_name)) {
+			throw new InvalidClassException($class_name);
+		}
+		$entity = $this->entity_factory instanceof FactoryInterface
+			? call_user_func(array($this->entity_factory, 'create'), $class_name)
+			: new $class_name();
+		return $this->addEntityToCollection($entity, $file_name);
+	}
 
 
-    /**
-     * @param        $entity
-     * @param  mixed $identifier
-     * @return string
-     * @throws InvalidEntityException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    protected function addEntityToCollection($entity, $identifier)
-    {
-        do_action(
-            'FHEE__CollectionLoader__addEntityToCollection__entity',
-            $entity,
-            $this->collection_details->collectionName(),
-            $this->collection_details
-        );
-        $identifier = $this->setIdentifier($entity, $identifier);
-        if ($this->collection->has($identifier)) {
-            do_action(
-                'FHEE__CollectionLoader__addEntityToCollection__entity_already_added',
-                $this,
-                $this->collection_details->collectionName(),
-                $this->collection_details
-            );
-            return CollectionLoader::ENTITY_EXISTS;
-        }
-        if ($this->collection->add($entity, $identifier)) {
-            do_action(
-                'FHEE__CollectionLoader__addEntityToCollection__entity_added',
-                $this,
-                $this->collection_details->collectionName(),
-                $this->collection_details
-            );
-            return CollectionLoader::ENTITY_ADDED;
-        }
-        do_action(
-            'FHEE__CollectionLoader__addEntityToCollection__entity_not_added',
-            $this,
-            $this->collection_details->collectionName(),
-            $this->collection_details
-        );
-        return CollectionLoader::ENTITY_NOT_ADDED;
-    }
+	/**
+	 * @param        $entity
+	 * @param  mixed $identifier
+	 * @return string
+	 * @throws InvalidEntityException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	protected function addEntityToCollection($entity, $identifier)
+	{
+		do_action(
+			'FHEE__CollectionLoader__addEntityToCollection__entity',
+			$entity,
+			$this->collection_details->collectionName(),
+			$this->collection_details
+		);
+		$identifier = $this->setIdentifier($entity, $identifier);
+		if ($this->collection->has($identifier)) {
+			do_action(
+				'FHEE__CollectionLoader__addEntityToCollection__entity_already_added',
+				$this,
+				$this->collection_details->collectionName(),
+				$this->collection_details
+			);
+			return CollectionLoader::ENTITY_EXISTS;
+		}
+		if ($this->collection->add($entity, $identifier)) {
+			do_action(
+				'FHEE__CollectionLoader__addEntityToCollection__entity_added',
+				$this,
+				$this->collection_details->collectionName(),
+				$this->collection_details
+			);
+			return CollectionLoader::ENTITY_ADDED;
+		}
+		do_action(
+			'FHEE__CollectionLoader__addEntityToCollection__entity_not_added',
+			$this,
+			$this->collection_details->collectionName(),
+			$this->collection_details
+		);
+		return CollectionLoader::ENTITY_NOT_ADDED;
+	}
 
 
-    /**
-     * @param        $entity
-     * @param  mixed $identifier
-     * @return string
-     * @throws InvalidEntityException
-     */
-    protected function setIdentifier($entity, $identifier)
-    {
-        switch ($this->collection_details->identifierType()) {
-            // every unique object gets added to the collection, but not duplicates of the exact same object
-            case CollectionDetails::ID_OBJECT_HASH:
-                $identifier = spl_object_hash($entity);
-                break;
-            // only one entity per class can be added to collection, like a singleton
-            case CollectionDetails::ID_CLASS_NAME:
-                $identifier = get_class($entity);
-                break;
-            // objects added to the collection based on entity callback, so the entity itself decides
-            case CollectionDetails::ID_CALLBACK_METHOD:
-                $identifier_callback = $this->collection_details->identifierCallback();
-                if (! method_exists($entity, $identifier_callback)) {
-                    throw new InvalidEntityException(
-                        $entity,
-                        $this->collection_details->getCollectionInterface(),
-                        sprintf(
-                            __(
-                                'The current collection is configured to use a method named "%1$s" when setting or retrieving objects. The supplied entity is an instance
+	/**
+	 * @param        $entity
+	 * @param  mixed $identifier
+	 * @return string
+	 * @throws InvalidEntityException
+	 */
+	protected function setIdentifier($entity, $identifier)
+	{
+		switch ($this->collection_details->identifierType()) {
+			// every unique object gets added to the collection, but not duplicates of the exact same object
+			case CollectionDetails::ID_OBJECT_HASH:
+				$identifier = spl_object_hash($entity);
+				break;
+			// only one entity per class can be added to collection, like a singleton
+			case CollectionDetails::ID_CLASS_NAME:
+				$identifier = get_class($entity);
+				break;
+			// objects added to the collection based on entity callback, so the entity itself decides
+			case CollectionDetails::ID_CALLBACK_METHOD:
+				$identifier_callback = $this->collection_details->identifierCallback();
+				if (! method_exists($entity, $identifier_callback)) {
+					throw new InvalidEntityException(
+						$entity,
+						$this->collection_details->getCollectionInterface(),
+						sprintf(
+							__(
+								'The current collection is configured to use a method named "%1$s" when setting or retrieving objects. The supplied entity is an instance
                                 of "%2$s", but does not contain this method.',
-                                'event_espresso'
-                            ),
-                            $identifier_callback,
-                            get_class($entity)
-                        )
-                    );
-                }
-                $identifier = $entity->{$identifier_callback}();
-                break;
-        }
-        return apply_filters(
-            'FHEE__CollectionLoader__addEntityToCollection__identifier',
-            $identifier,
-            $this->collection_details->collectionName(),
-            $this->collection_details
-        );
-    }
+								'event_espresso'
+							),
+							$identifier_callback,
+							get_class($entity)
+						)
+					);
+				}
+				$identifier = $entity->{$identifier_callback}();
+				break;
+		}
+		return apply_filters(
+			'FHEE__CollectionLoader__addEntityToCollection__identifier',
+			$identifier,
+			$this->collection_details->collectionName(),
+			$this->collection_details
+		);
+	}
 
 
-    /**
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws EE_Error
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    protected function loadFromFQCNs()
-    {
-        $FQCNs = $this->collection_details->getCollectionFQCNs();
-        $FQCNs = (array) apply_filters(
-            'FHEE__CollectionLoader__loadAllFromFQCNs__FQCNs',
-            $FQCNs,
-            $this->collection_details->collectionName(),
-            $this->collection_details
-        );
-        foreach ($FQCNs as $FQCN) {
-            $this->loadClassFromFQCN($FQCN);
-        }
-    }
+	/**
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws EE_Error
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	protected function loadFromFQCNs()
+	{
+		$FQCNs = $this->collection_details->getCollectionFQCNs();
+		$FQCNs = (array) apply_filters(
+			'FHEE__CollectionLoader__loadAllFromFQCNs__FQCNs',
+			$FQCNs,
+			$this->collection_details->collectionName(),
+			$this->collection_details
+		);
+		foreach ($FQCNs as $FQCN) {
+			$this->loadClassFromFQCN($FQCN);
+		}
+	}
 
 
-    /**
-     * @param  string $FQCN Fully Qualified Class Name
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws EE_Error
-     * @throws InvalidEntityException
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     * @throws DuplicateCollectionIdentifierException
-     */
-    protected function loadClassFromFQCN($FQCN)
-    {
-        if (! is_string($FQCN)) {
-            throw new InvalidDataTypeException('$FQCN', $FQCN, 'string');
-        }
-        if (! class_exists($FQCN)) {
-            throw new InvalidClassException($FQCN);
-        }
-        do_action(
-            'FHEE__CollectionLoader__loadClassFromFQCN__beforeLoading',
-            $FQCN,
-            $this->collection_details->collectionName(),
-            $this->collection_details
-        );
-        $entity = $this->entity_factory instanceof FactoryInterface
-            ? call_user_func(array($this->entity_factory, 'create'), $FQCN)
-            : EE_Registry::instance()->create($FQCN);
-        return $this->addEntityToCollection($entity, $FQCN);
-    }
+	/**
+	 * @param  string $FQCN Fully Qualified Class Name
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 * @throws InvalidEntityException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 * @throws DuplicateCollectionIdentifierException
+	 */
+	protected function loadClassFromFQCN($FQCN)
+	{
+		if (! is_string($FQCN)) {
+			throw new InvalidDataTypeException('$FQCN', $FQCN, 'string');
+		}
+		if (! class_exists($FQCN)) {
+			throw new InvalidClassException($FQCN);
+		}
+		do_action(
+			'FHEE__CollectionLoader__loadClassFromFQCN__beforeLoading',
+			$FQCN,
+			$this->collection_details->collectionName(),
+			$this->collection_details
+		);
+		$entity = $this->entity_factory instanceof FactoryInterface
+			? call_user_func(array($this->entity_factory, 'create'), $FQCN)
+			: EE_Registry::instance()->create($FQCN);
+		return $this->addEntityToCollection($entity, $FQCN);
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -87,7 +87,7 @@ 
     ) {
         try {
             $this->collection_details = $collection_details;
-            if (! $collection instanceof CollectionInterface) {
+            if ( ! $collection instanceof CollectionInterface) {
                 $collection = new Collection($this->collection_details->getCollectionInterface());
             }
             $this->collection = $collection;
@@ -119,7 +119,7 @@ 
      */
     protected function loadAllFromFilepaths()
     {
-        if (! $this->file_locator instanceof FileLocator) {
+        if ( ! $this->file_locator instanceof FileLocator) {
             $this->file_locator = new FileLocator();
         }
         $this->file_locator->setFileMask($this->collection_details->getFileMask());
@@ -152,10 +152,10 @@ 
      */
     protected function loadClassFromFilepath($filepath)
     {
-        if (! is_string($filepath)) {
+        if ( ! is_string($filepath)) {
             throw new InvalidDataTypeException('$filepath', $filepath, 'string');
         }
-        if (! is_readable($filepath)) {
+        if ( ! is_readable($filepath)) {
             throw new InvalidFilePathException($filepath);
         }
         require_once $filepath;
@@ -163,7 +163,7 @@ 
         $file_name = basename($filepath);
         // now remove any file extensions
         $class_name = EEH_File::get_classname_from_filepath_with_standard_filename($file_name);
-        if (! class_exists($class_name)) {
+        if ( ! class_exists($class_name)) {
             throw new InvalidClassException($class_name);
         }
         $entity = $this->entity_factory instanceof FactoryInterface
@@ -237,7 +237,7 @@ 
             // objects added to the collection based on entity callback, so the entity itself decides
             case CollectionDetails::ID_CALLBACK_METHOD:
                 $identifier_callback = $this->collection_details->identifierCallback();
-                if (! method_exists($entity, $identifier_callback)) {
+                if ( ! method_exists($entity, $identifier_callback)) {
                     throw new InvalidEntityException(
                         $entity,
                         $this->collection_details->getCollectionInterface(),
@@ -303,10 +303,10 @@ 
      */
     protected function loadClassFromFQCN($FQCN)
     {
-        if (! is_string($FQCN)) {
+        if ( ! is_string($FQCN)) {
             throw new InvalidDataTypeException('$FQCN', $FQCN, 'string');
         }
-        if (! class_exists($FQCN)) {
+        if ( ! class_exists($FQCN)) {
             throw new InvalidClassException($FQCN);
         }
         do_action(

core/services/collections/CollectionLoaderException.php

Indentation +21 added lines, -21 removed lines

@@ -16,25 +16,25 @@
 class CollectionLoaderException extends RuntimeException
 {
 
-    /**
-     * DuplicateCollectionIdentifierException constructor.
-     *
-     * @param Exception $previous
-     * @param string    $message
-     * @param int       $code
-     */
-    public function __construct(Exception $previous, $message = '', $code = 0)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                __(
-                    'The following error occurred during the creation and/or loading of this collection: %1$s %2$s',
-                    'event_espresso'
-                ),
-                '<br />',
-                $previous->getMessage()
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * DuplicateCollectionIdentifierException constructor.
+	 *
+	 * @param Exception $previous
+	 * @param string    $message
+	 * @param int       $code
+	 */
+	public function __construct(Exception $previous, $message = '', $code = 0)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				__(
+					'The following error occurred during the creation and/or loading of this collection: %1$s %2$s',
+					'event_espresso'
+				),
+				'<br />',
+				$previous->getMessage()
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }

core/services/collections/CollectionDetailsException.php

Indentation +21 added lines, -21 removed lines

@@ -16,25 +16,25 @@
 class CollectionDetailsException extends RuntimeException
 {
 
-    /**
-     * DuplicateCollectionIdentifierException constructor.
-     *
-     * @param Exception $previous
-     * @param string    $message
-     * @param int       $code
-     */
-    public function __construct(Exception $previous, $message = '', $code = 0)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                __(
-                    'The following error occurred during the collection details generation: %1$s %2$s',
-                    'event_espresso'
-                ),
-                '<br />',
-                $previous->getMessage()
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * DuplicateCollectionIdentifierException constructor.
+	 *
+	 * @param Exception $previous
+	 * @param string    $message
+	 * @param int       $code
+	 */
+	public function __construct(Exception $previous, $message = '', $code = 0)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				__(
+					'The following error occurred during the collection details generation: %1$s %2$s',
+					'event_espresso'
+				),
+				'<br />',
+				$previous->getMessage()
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }

core/services/session/SessionStartHandler.php

Spacing +2 added lines, -2 removed lines

@@ -99,7 +99,7 @@ 
         }
         // If not, then attempt to deal with any errors,
         // otherwise, try to hobble along without the session
-        if (! $this->handleSessionSaveHandlerErrors()) {
+        if ( ! $this->handleSessionSaveHandlerErrors()) {
             return;
         }
         // there is no record of a fatal error while trying to start the session
@@ -249,7 +249,7 @@ 
                     ),
                     '<a href="https://wordpress.org/plugins/wp-native-php-sessions/">',
                     '</a>',
-                    '<a href="' . $retry_session_url . '">'
+                    '<a href="'.$retry_session_url.'">'
                 ),
                 __FILE__,
                 __FUNCTION__,

Indentation +219 added lines, -219 removed lines

@@ -27,237 +27,237 @@
  */
 class SessionStartHandler
 {
-    const OPTION_NAME_SESSION_SAVE_HANDLER_STATUS = 'ee_session_save_handler_status';
-    const REQUEST_PARAM_RETRY_SESSION = 'ee_retry_session';
-    const SESSION_SAVE_HANDLER_STATUS_FAILED = 'session_save_handler_failed';
-    const SESSION_SAVE_HANDLER_STATUS_SUCCESS = 'session_save_handler_success';
-    const SESSION_SAVE_HANDLER_STATUS_UNKNOWN = 'session_save_handler_untested';
+	const OPTION_NAME_SESSION_SAVE_HANDLER_STATUS = 'ee_session_save_handler_status';
+	const REQUEST_PARAM_RETRY_SESSION = 'ee_retry_session';
+	const SESSION_SAVE_HANDLER_STATUS_FAILED = 'session_save_handler_failed';
+	const SESSION_SAVE_HANDLER_STATUS_SUCCESS = 'session_save_handler_success';
+	const SESSION_SAVE_HANDLER_STATUS_UNKNOWN = 'session_save_handler_untested';
 
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
 
-    /**
-     * StartSession constructor.
-     *
-     * @param RequestInterface $request
-     */
-    public function __construct(RequestInterface $request)
-    {
-        $this->request = $request;
-    }
+	/**
+	 * StartSession constructor.
+	 *
+	 * @param RequestInterface $request
+	 */
+	public function __construct(RequestInterface $request)
+	{
+		$this->request = $request;
+	}
 
-    /**
-     * Check if a custom session save handler is in play
-     * and attempt to start the PHP session
-     *
-     * @since 4.9.68.p
-     */
-    public function startSession()
-    {
-        // check that session has started
-        if (session_id() === '') {
-            // starts a new session if one doesn't already exist, or re-initiates an existing one
-            if ($this->hasKnownCustomSessionSaveHandler()) {
-                $this->checkCustomSessionSaveHandler();
-            } else {
-                session_start();
-                session_write_close();
-            }
-        }
-    }
+	/**
+	 * Check if a custom session save handler is in play
+	 * and attempt to start the PHP session
+	 *
+	 * @since 4.9.68.p
+	 */
+	public function startSession()
+	{
+		// check that session has started
+		if (session_id() === '') {
+			// starts a new session if one doesn't already exist, or re-initiates an existing one
+			if ($this->hasKnownCustomSessionSaveHandler()) {
+				$this->checkCustomSessionSaveHandler();
+			} else {
+				session_start();
+				session_write_close();
+			}
+		}
+	}
 
-    /**
-     * Returns `true` if the 'session.save_handler' ini setting matches a known custom handler
-     *
-     * @since 4.9.68.p
-     * @return bool
-     */
-    private function hasKnownCustomSessionSaveHandler()
-    {
-        return in_array(
-            ini_get('session.save_handler'),
-            array(
-                'user',
-            ),
-            true
-        );
-    }
+	/**
+	 * Returns `true` if the 'session.save_handler' ini setting matches a known custom handler
+	 *
+	 * @since 4.9.68.p
+	 * @return bool
+	 */
+	private function hasKnownCustomSessionSaveHandler()
+	{
+		return in_array(
+			ini_get('session.save_handler'),
+			array(
+				'user',
+			),
+			true
+		);
+	}
 
-    /**
-     * Attempt to start the PHP session when a custom Session Save Handler is known to be set.
-     *
-     * @since 4.9.68.p
-     */
-    private function checkCustomSessionSaveHandler()
-    {
-        // If we've already successfully tested the session save handler
-        // on a previous request then just start the session
-        if ($this->sessionSaveHandlerIsValid()) {
-            session_start();
-            session_write_close();
-            return;
-        }
-        // If not, then attempt to deal with any errors,
-        // otherwise, try to hobble along without the session
-        if (! $this->handleSessionSaveHandlerErrors()) {
-            return;
-        }
-        // there is no record of a fatal error while trying to start the session
-        // so let's see if there's a custom session save handler. Proceed with caution
-        $this->initializeSessionSaveHandlerStatus();
-        // hold your breath, the custom session save handler might cause a fatal here...
-        session_start();
-        session_write_close();
-        // phew! we made it! the custom session handler is a-ok
-        $this->setSessionSaveHandlerStatusToValid();
-    }
+	/**
+	 * Attempt to start the PHP session when a custom Session Save Handler is known to be set.
+	 *
+	 * @since 4.9.68.p
+	 */
+	private function checkCustomSessionSaveHandler()
+	{
+		// If we've already successfully tested the session save handler
+		// on a previous request then just start the session
+		if ($this->sessionSaveHandlerIsValid()) {
+			session_start();
+			session_write_close();
+			return;
+		}
+		// If not, then attempt to deal with any errors,
+		// otherwise, try to hobble along without the session
+		if (! $this->handleSessionSaveHandlerErrors()) {
+			return;
+		}
+		// there is no record of a fatal error while trying to start the session
+		// so let's see if there's a custom session save handler. Proceed with caution
+		$this->initializeSessionSaveHandlerStatus();
+		// hold your breath, the custom session save handler might cause a fatal here...
+		session_start();
+		session_write_close();
+		// phew! we made it! the custom session handler is a-ok
+		$this->setSessionSaveHandlerStatusToValid();
+	}
 
 
-    /**
-     * retrieves the value for the 'ee_session_save_handler_status' WP option.
-     * default value = 'session_save_handler_untested'
-     *
-     * @since 4.9.68.p
-     * @return string
-     */
-    private function getSessionSaveHandlerStatus()
-    {
-        return get_option(
-            SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
-            SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_UNKNOWN
-        );
-    }
+	/**
+	 * retrieves the value for the 'ee_session_save_handler_status' WP option.
+	 * default value = 'session_save_handler_untested'
+	 *
+	 * @since 4.9.68.p
+	 * @return string
+	 */
+	private function getSessionSaveHandlerStatus()
+	{
+		return get_option(
+			SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
+			SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_UNKNOWN
+		);
+	}
 
-    /**
-     * Sets the 'ee_session_save_handler_status' WP option value to 'session_save_handler_failed'
-     * which can then be upgraded is everything works correctly
-     *
-     * @since 4.9.68.p
-     * @return bool
-     */
-    private function initializeSessionSaveHandlerStatus()
-    {
-        return update_option(
-            SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
-            SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_FAILED
-        );
-    }
+	/**
+	 * Sets the 'ee_session_save_handler_status' WP option value to 'session_save_handler_failed'
+	 * which can then be upgraded is everything works correctly
+	 *
+	 * @since 4.9.68.p
+	 * @return bool
+	 */
+	private function initializeSessionSaveHandlerStatus()
+	{
+		return update_option(
+			SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
+			SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_FAILED
+		);
+	}
 
-    /**
-     * Sets the 'ee_session_save_handler_status' WP option value to 'session_save_handler_success'
-     *
-     * @since 4.9.68.p
-     * @return bool
-     */
-    private function setSessionSaveHandlerStatusToValid()
-    {
-        return update_option(
-            SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
-            SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_SUCCESS
-        );
-    }
+	/**
+	 * Sets the 'ee_session_save_handler_status' WP option value to 'session_save_handler_success'
+	 *
+	 * @since 4.9.68.p
+	 * @return bool
+	 */
+	private function setSessionSaveHandlerStatusToValid()
+	{
+		return update_option(
+			SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
+			SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_SUCCESS
+		);
+	}
 
-    /**
-     * Sets the 'ee_session_save_handler_status' WP option value to 'session_save_handler_untested'
-     *
-     * @since 4.9.68.p
-     * @return bool
-     */
-    private function resetSessionSaveHandlerStatus()
-    {
-        return update_option(
-            SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
-            SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_UNKNOWN
-        );
-    }
+	/**
+	 * Sets the 'ee_session_save_handler_status' WP option value to 'session_save_handler_untested'
+	 *
+	 * @since 4.9.68.p
+	 * @return bool
+	 */
+	private function resetSessionSaveHandlerStatus()
+	{
+		return update_option(
+			SessionStartHandler::OPTION_NAME_SESSION_SAVE_HANDLER_STATUS,
+			SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_UNKNOWN
+		);
+	}
 
-    /**
-     * Returns `true` if the 'ee_session_save_handler_status' WP option value
-     * is equal to 'session_save_handler_success'
-     *
-     * @since 4.9.68.p
-     * @return bool
-     */
-    private function sessionSaveHandlerIsValid()
-    {
-        return $this->getSessionSaveHandlerStatus() === SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_SUCCESS;
-    }
+	/**
+	 * Returns `true` if the 'ee_session_save_handler_status' WP option value
+	 * is equal to 'session_save_handler_success'
+	 *
+	 * @since 4.9.68.p
+	 * @return bool
+	 */
+	private function sessionSaveHandlerIsValid()
+	{
+		return $this->getSessionSaveHandlerStatus() === SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_SUCCESS;
+	}
 
-    /**
-     * Returns `true` if the 'ee_session_save_handler_status' WP option value
-     * is equal to 'session_save_handler_failed'
-     *
-     * @since 4.9.68.p
-     * @return bool
-     */
-    private function sessionSaveHandlerFailed()
-    {
-        return $this->getSessionSaveHandlerStatus() === SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_FAILED;
-    }
+	/**
+	 * Returns `true` if the 'ee_session_save_handler_status' WP option value
+	 * is equal to 'session_save_handler_failed'
+	 *
+	 * @since 4.9.68.p
+	 * @return bool
+	 */
+	private function sessionSaveHandlerFailed()
+	{
+		return $this->getSessionSaveHandlerStatus() === SessionStartHandler::SESSION_SAVE_HANDLER_STATUS_FAILED;
+	}
 
-    /**
-     * Returns `true` if no errors were detected with the session save handler,
-     * otherwise attempts to work notify the appropriate authorities
-     * with a suggestion for how to fix the issue, and returns `false`.
-     *
-     *
-     * @since 4.9.68.p
-     * @return bool
-     */
-    private function handleSessionSaveHandlerErrors()
-    {
-        // Check if we had a fatal error last time while trying to start the session
-        if ($this->sessionSaveHandlerFailed()) {
-            // apparently, last time we tried using the custom session save handler there was a fatal
-            if ($this->request->requestParamIsSet(SessionStartHandler::REQUEST_PARAM_RETRY_SESSION)) {
-                $this->resetSessionSaveHandlerStatus();
-                // remove "ee_retry_session", otherwise if the problem still isn't fixed,
-                // we'll just keep getting the fatal error over and over.
-                // Better to remove it and redirect, and try on the next request
-                EEH_URL::safeRedirectAndExit(
-                    remove_query_arg(
-                        array(SessionStartHandler::REQUEST_PARAM_RETRY_SESSION),
-                        EEH_URL::current_url()
-                    )
-                );
-            }
-            // so the session is broken, don't try it again,
-            // just show a message to users that can fix it
-            $this->displaySessionSaveHandlerErrorNotice();
-            return false;
-        }
-        return true;
-    }
+	/**
+	 * Returns `true` if no errors were detected with the session save handler,
+	 * otherwise attempts to work notify the appropriate authorities
+	 * with a suggestion for how to fix the issue, and returns `false`.
+	 *
+	 *
+	 * @since 4.9.68.p
+	 * @return bool
+	 */
+	private function handleSessionSaveHandlerErrors()
+	{
+		// Check if we had a fatal error last time while trying to start the session
+		if ($this->sessionSaveHandlerFailed()) {
+			// apparently, last time we tried using the custom session save handler there was a fatal
+			if ($this->request->requestParamIsSet(SessionStartHandler::REQUEST_PARAM_RETRY_SESSION)) {
+				$this->resetSessionSaveHandlerStatus();
+				// remove "ee_retry_session", otherwise if the problem still isn't fixed,
+				// we'll just keep getting the fatal error over and over.
+				// Better to remove it and redirect, and try on the next request
+				EEH_URL::safeRedirectAndExit(
+					remove_query_arg(
+						array(SessionStartHandler::REQUEST_PARAM_RETRY_SESSION),
+						EEH_URL::current_url()
+					)
+				);
+			}
+			// so the session is broken, don't try it again,
+			// just show a message to users that can fix it
+			$this->displaySessionSaveHandlerErrorNotice();
+			return false;
+		}
+		return true;
+	}
 
-    /**
-     * Generates an EE_Error notice regarding the current session woes
-     * but only if the current user is an admin with permission to 'install_plugins'.
-     *
-     * @since 4.9.68.p
-     */
-    private function displaySessionSaveHandlerErrorNotice()
-    {
-        if (current_user_can('install_plugins')) {
-            $retry_session_url = add_query_arg(
-                array(SessionStartHandler::REQUEST_PARAM_RETRY_SESSION => true),
-                EEH_URL::current_url()
-            );
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'It appears there was a fatal error while starting the session, so Event Espresso is not able to process registrations normally. Some hosting companies, like Pantheon, require an extra plugin for Event Espresso to work. Please install the %1$sWordPress Native PHP Sessions plugin%2$s, then %3$sclick here to check if the problem is resolved.%2$s',
-                        'event_espresso'
-                    ),
-                    '<a href="https://wordpress.org/plugins/wp-native-php-sessions/">',
-                    '</a>',
-                    '<a href="' . $retry_session_url . '">'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
+	/**
+	 * Generates an EE_Error notice regarding the current session woes
+	 * but only if the current user is an admin with permission to 'install_plugins'.
+	 *
+	 * @since 4.9.68.p
+	 */
+	private function displaySessionSaveHandlerErrorNotice()
+	{
+		if (current_user_can('install_plugins')) {
+			$retry_session_url = add_query_arg(
+				array(SessionStartHandler::REQUEST_PARAM_RETRY_SESSION => true),
+				EEH_URL::current_url()
+			);
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'It appears there was a fatal error while starting the session, so Event Espresso is not able to process registrations normally. Some hosting companies, like Pantheon, require an extra plugin for Event Espresso to work. Please install the %1$sWordPress Native PHP Sessions plugin%2$s, then %3$sclick here to check if the problem is resolved.%2$s',
+						'event_espresso'
+					),
+					'<a href="https://wordpress.org/plugins/wp-native-php-sessions/">',
+					'</a>',
+					'<a href="' . $retry_session_url . '">'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
 }