eventespresso / event-espresso-core

core/db_models/strategies/EE_Restriction_Generator_Event_Related_Public.strategy.php

Indentation +67 added lines, -67 removed lines

@@ -17,72 +17,72 @@
 class EE_Restriction_Generator_Event_Related_Public extends EE_Restriction_Generator_Base
 {
 
-    /**
-     * Path to the event model from the model this restriction generator will be applied to;
-     * including the event model itself. Eg "Ticket.Datetime.Event"
-     * @var string
-     */
-    protected $_path_to_event_model;
-    /**
-     *
-     * @param string $path_to_event_model
-     */
-    public function __construct($path_to_event_model)
-    {
-        if (substr($path_to_event_model, -1, 1) != '.') {
-            $path_to_event_model .= '.';
-        }
-        $this->_path_to_event_model = $path_to_event_model;
-    }
-    /**
-     *
-     * @return \EE_Default_Where_Conditions
-     */
-    protected function _generate_restrictions()
-    {
-        // if there are no standard caps for this model, then for now all we know
-        // if they need the default cap to access this
-        if (! $this->model()->cap_slug()) {
-            return array(
-                self::get_default_restrictions_cap() => new EE_Return_None_Where_Conditions()
-            );
-        }
+	/**
+	 * Path to the event model from the model this restriction generator will be applied to;
+	 * including the event model itself. Eg "Ticket.Datetime.Event"
+	 * @var string
+	 */
+	protected $_path_to_event_model;
+	/**
+	 *
+	 * @param string $path_to_event_model
+	 */
+	public function __construct($path_to_event_model)
+	{
+		if (substr($path_to_event_model, -1, 1) != '.') {
+			$path_to_event_model .= '.';
+		}
+		$this->_path_to_event_model = $path_to_event_model;
+	}
+	/**
+	 *
+	 * @return \EE_Default_Where_Conditions
+	 */
+	protected function _generate_restrictions()
+	{
+		// if there are no standard caps for this model, then for now all we know
+		// if they need the default cap to access this
+		if (! $this->model()->cap_slug()) {
+			return array(
+				self::get_default_restrictions_cap() => new EE_Return_None_Where_Conditions()
+			);
+		}
 
-        $event_model = EEM_Event::instance();
-        return array(
-            // first: basically access to non-defaults is essentially controlled by which events are accessible
-            // if they don't have the basic event cap, they can only read things for published events
-            EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action()) => new EE_Default_Where_Conditions(
-                $this->addPublishedPostConditions(
-                    array(),
-                    true,
-                    $this->_path_to_event_model
-                )
-            ),
-            // if they don't have the others event cap, they can't access others' non-default items
-            EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_others') => new EE_Default_Where_Conditions(
-                array(
-                    'OR*' . EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_others') => $this->addPublishedPostConditions(
-                        array(
-                            $this->_path_to_event_model . 'EVT_wp_user' => EE_Default_Where_Conditions::current_user_placeholder,
-                        ),
-                        true,
-                        $this->_path_to_event_model
-                    )
-                )
-            ),
-            // if they have basic and others, but not private, they can't access others' private non-default items
-            EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_private') => new EE_Default_Where_Conditions(
-                array(
-                    'OR*no_' . EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_private') => $this->addPublishedPostConditions(
-                        array(
-                            $this->_path_to_event_model . 'EVT_wp_user' => EE_Default_Where_Conditions::current_user_placeholder,
-                        ),
-                        false,
-                        $this->_path_to_event_model
-                    )
-                )
-            ),
-        );
-    }
+		$event_model = EEM_Event::instance();
+		return array(
+			// first: basically access to non-defaults is essentially controlled by which events are accessible
+			// if they don't have the basic event cap, they can only read things for published events
+			EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action()) => new EE_Default_Where_Conditions(
+				$this->addPublishedPostConditions(
+					array(),
+					true,
+					$this->_path_to_event_model
+				)
+			),
+			// if they don't have the others event cap, they can't access others' non-default items
+			EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_others') => new EE_Default_Where_Conditions(
+				array(
+					'OR*' . EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_others') => $this->addPublishedPostConditions(
+						array(
+							$this->_path_to_event_model . 'EVT_wp_user' => EE_Default_Where_Conditions::current_user_placeholder,
+						),
+						true,
+						$this->_path_to_event_model
+					)
+				)
+			),
+			// if they have basic and others, but not private, they can't access others' private non-default items
+			EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_private') => new EE_Default_Where_Conditions(
+				array(
+					'OR*no_' . EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_private') => $this->addPublishedPostConditions(
+						array(
+							$this->_path_to_event_model . 'EVT_wp_user' => EE_Default_Where_Conditions::current_user_placeholder,
+						),
+						false,
+						$this->_path_to_event_model
+					)
+				)
+			),
+		);
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -42,7 +42,7 @@ 
     {
         // if there are no standard caps for this model, then for now all we know
         // if they need the default cap to access this
-        if (! $this->model()->cap_slug()) {
+        if ( ! $this->model()->cap_slug()) {
             return array(
                 self::get_default_restrictions_cap() => new EE_Return_None_Where_Conditions()
             );
@@ -60,11 +60,11 @@ 
                 )
             ),
             // if they don't have the others event cap, they can't access others' non-default items
-            EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_others') => new EE_Default_Where_Conditions(
+            EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action().'_others') => new EE_Default_Where_Conditions(
                 array(
-                    'OR*' . EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_others') => $this->addPublishedPostConditions(
+                    'OR*'.EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action().'_others') => $this->addPublishedPostConditions(
                         array(
-                            $this->_path_to_event_model . 'EVT_wp_user' => EE_Default_Where_Conditions::current_user_placeholder,
+                            $this->_path_to_event_model.'EVT_wp_user' => EE_Default_Where_Conditions::current_user_placeholder,
                         ),
                         true,
                         $this->_path_to_event_model
@@ -72,11 +72,11 @@ 
                 )
             ),
             // if they have basic and others, but not private, they can't access others' private non-default items
-            EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_private') => new EE_Default_Where_Conditions(
+            EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action().'_private') => new EE_Default_Where_Conditions(
                 array(
-                    'OR*no_' . EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_private') => $this->addPublishedPostConditions(
+                    'OR*no_'.EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action().'_private') => $this->addPublishedPostConditions(
                         array(
-                            $this->_path_to_event_model . 'EVT_wp_user' => EE_Default_Where_Conditions::current_user_placeholder,
+                            $this->_path_to_event_model.'EVT_wp_user' => EE_Default_Where_Conditions::current_user_placeholder,
                         ),
                         false,
                         $this->_path_to_event_model

core/db_models/strategies/EE_Restriction_Generator_Public.strategy.php

Indentation +69 added lines, -69 removed lines

@@ -12,74 +12,74 @@
  */
 class EE_Restriction_Generator_Public extends EE_Restriction_Generator_Base
 {
-    protected function _generate_restrictions()
-    {
-        // if there are no standard caps for this model, then for allow full access
-        if (! $this->model()->cap_slug()) {
-            return array(
-            );
-        }
+	protected function _generate_restrictions()
+	{
+		// if there are no standard caps for this model, then for allow full access
+		if (! $this->model()->cap_slug()) {
+			return array(
+			);
+		}
 
-        $restrictions = array();
-        // does the basic cap exist? (eg 'ee_read_registrations')
-        if (EE_Restriction_Generator_Base::is_cap($this->model(), $this->action())) {
-            if ($this->model() instanceof EEM_CPT_Base) {
-                $restrictions[ EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action()) ] = new EE_Default_Where_Conditions(
-                    $this->addPublishedPostConditions()
-                );
-            } elseif ($this->model() instanceof EEM_Soft_Delete_Base) {
-                $restrictions[ EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action()) ] = new EE_Default_Where_Conditions(
-                    array( $this->model()->deleted_field_name() => false )
-                );
-            } else {
-                // don't impose any restrictions if they don't have the basic reading cap
-            }
-            // does the others cap exist? (eg 'ee_read_others_registrations')
-            if (EE_Restriction_Generator_Base::is_cap($this->model(), $this->action() . '_others')) {// both caps exist
-                if ($this->model() instanceof EEM_CPT_Base) {
-                    // then if they don't have the others cap, AT MOST show them their own and other published ones
-                    $restrictions[ EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_others') ] = new EE_Default_Where_Conditions(
-                        array(
-                            'OR*' . EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_others') => $this->addPublishedPostConditions(
-                                array(
-                                    EE_Default_Where_Conditions::user_field_name_placeholder => EE_Default_Where_Conditions::current_user_placeholder,
-                                )
-                            )
-                        )
-                    );
-                } elseif ($this->model() instanceof EEM_Soft_Delete_Base) {
-                    // then if they don't have the other cap, AT MOST show them their own or non deleted ones
-                    $restrictions[ EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_others') ] = new EE_Default_Where_Conditions(
-                        array(
-                            'OR*' . EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_others') => array(
-                                EE_Default_Where_Conditions::user_field_name_placeholder => EE_Default_Where_Conditions::current_user_placeholder,
-                                $this->model()->deleted_field_name() => false
-                            )
-                        )
-                    );
-                } else {
-                    // again, if they don't have the others cap, continue showing all because there are no inherently hidden ones
-                }
-                // does the private cap exist (eg 'ee_read_others_private_events')
-                if (EE_Restriction_Generator_Base::is_cap($this->model(), $this->action() . '_private') && $this->model() instanceof EEM_CPT_Base) {
-                    // if they have basic and others, but not private, restrict them to see theirs and others' that aren't private
-                    $restrictions[ EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_private') ] = new EE_Default_Where_Conditions(
-                        array(
-                            'OR*' . EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_private') => $this->addPublishedPostConditions(
-                                array(
-                                    EE_Default_Where_Conditions::user_field_name_placeholder => EE_Default_Where_Conditions::current_user_placeholder,
-                                ),
-                                false,
-                                ''
-                            )
-                        )
-                    );
-                }
-            }
-        } else {
-            // there is no basic cap. So allow full access
-            $restrictions = array();
-        }
-        return $restrictions;
-    }
+		$restrictions = array();
+		// does the basic cap exist? (eg 'ee_read_registrations')
+		if (EE_Restriction_Generator_Base::is_cap($this->model(), $this->action())) {
+			if ($this->model() instanceof EEM_CPT_Base) {
+				$restrictions[ EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action()) ] = new EE_Default_Where_Conditions(
+					$this->addPublishedPostConditions()
+				);
+			} elseif ($this->model() instanceof EEM_Soft_Delete_Base) {
+				$restrictions[ EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action()) ] = new EE_Default_Where_Conditions(
+					array( $this->model()->deleted_field_name() => false )
+				);
+			} else {
+				// don't impose any restrictions if they don't have the basic reading cap
+			}
+			// does the others cap exist? (eg 'ee_read_others_registrations')
+			if (EE_Restriction_Generator_Base::is_cap($this->model(), $this->action() . '_others')) {// both caps exist
+				if ($this->model() instanceof EEM_CPT_Base) {
+					// then if they don't have the others cap, AT MOST show them their own and other published ones
+					$restrictions[ EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_others') ] = new EE_Default_Where_Conditions(
+						array(
+							'OR*' . EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_others') => $this->addPublishedPostConditions(
+								array(
+									EE_Default_Where_Conditions::user_field_name_placeholder => EE_Default_Where_Conditions::current_user_placeholder,
+								)
+							)
+						)
+					);
+				} elseif ($this->model() instanceof EEM_Soft_Delete_Base) {
+					// then if they don't have the other cap, AT MOST show them their own or non deleted ones
+					$restrictions[ EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_others') ] = new EE_Default_Where_Conditions(
+						array(
+							'OR*' . EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_others') => array(
+								EE_Default_Where_Conditions::user_field_name_placeholder => EE_Default_Where_Conditions::current_user_placeholder,
+								$this->model()->deleted_field_name() => false
+							)
+						)
+					);
+				} else {
+					// again, if they don't have the others cap, continue showing all because there are no inherently hidden ones
+				}
+				// does the private cap exist (eg 'ee_read_others_private_events')
+				if (EE_Restriction_Generator_Base::is_cap($this->model(), $this->action() . '_private') && $this->model() instanceof EEM_CPT_Base) {
+					// if they have basic and others, but not private, restrict them to see theirs and others' that aren't private
+					$restrictions[ EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_private') ] = new EE_Default_Where_Conditions(
+						array(
+							'OR*' . EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_private') => $this->addPublishedPostConditions(
+								array(
+									EE_Default_Where_Conditions::user_field_name_placeholder => EE_Default_Where_Conditions::current_user_placeholder,
+								),
+								false,
+								''
+							)
+						)
+					);
+				}
+			}
+		} else {
+			// there is no basic cap. So allow full access
+			$restrictions = array();
+		}
+		return $restrictions;
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -15,7 +15,7 @@ 
     protected function _generate_restrictions()
     {
         // if there are no standard caps for this model, then for allow full access
-        if (! $this->model()->cap_slug()) {
+        if ( ! $this->model()->cap_slug()) {
             return array(
             );
         }
@@ -24,23 +24,23 @@ 
         // does the basic cap exist? (eg 'ee_read_registrations')
         if (EE_Restriction_Generator_Base::is_cap($this->model(), $this->action())) {
             if ($this->model() instanceof EEM_CPT_Base) {
-                $restrictions[ EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action()) ] = new EE_Default_Where_Conditions(
+                $restrictions[EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action())] = new EE_Default_Where_Conditions(
                     $this->addPublishedPostConditions()
                 );
             } elseif ($this->model() instanceof EEM_Soft_Delete_Base) {
-                $restrictions[ EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action()) ] = new EE_Default_Where_Conditions(
-                    array( $this->model()->deleted_field_name() => false )
+                $restrictions[EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action())] = new EE_Default_Where_Conditions(
+                    array($this->model()->deleted_field_name() => false)
                 );
             } else {
                 // don't impose any restrictions if they don't have the basic reading cap
             }
             // does the others cap exist? (eg 'ee_read_others_registrations')
-            if (EE_Restriction_Generator_Base::is_cap($this->model(), $this->action() . '_others')) {// both caps exist
+            if (EE_Restriction_Generator_Base::is_cap($this->model(), $this->action().'_others')) {// both caps exist
                 if ($this->model() instanceof EEM_CPT_Base) {
                     // then if they don't have the others cap, AT MOST show them their own and other published ones
-                    $restrictions[ EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_others') ] = new EE_Default_Where_Conditions(
+                    $restrictions[EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action().'_others')] = new EE_Default_Where_Conditions(
                         array(
-                            'OR*' . EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_others') => $this->addPublishedPostConditions(
+                            'OR*'.EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action().'_others') => $this->addPublishedPostConditions(
                                 array(
                                     EE_Default_Where_Conditions::user_field_name_placeholder => EE_Default_Where_Conditions::current_user_placeholder,
                                 )
@@ -49,9 +49,9 @@ 
                     );
                 } elseif ($this->model() instanceof EEM_Soft_Delete_Base) {
                     // then if they don't have the other cap, AT MOST show them their own or non deleted ones
-                    $restrictions[ EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_others') ] = new EE_Default_Where_Conditions(
+                    $restrictions[EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action().'_others')] = new EE_Default_Where_Conditions(
                         array(
-                            'OR*' . EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_others') => array(
+                            'OR*'.EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action().'_others') => array(
                                 EE_Default_Where_Conditions::user_field_name_placeholder => EE_Default_Where_Conditions::current_user_placeholder,
                                 $this->model()->deleted_field_name() => false
                             )
@@ -61,11 +61,11 @@ 
                     // again, if they don't have the others cap, continue showing all because there are no inherently hidden ones
                 }
                 // does the private cap exist (eg 'ee_read_others_private_events')
-                if (EE_Restriction_Generator_Base::is_cap($this->model(), $this->action() . '_private') && $this->model() instanceof EEM_CPT_Base) {
+                if (EE_Restriction_Generator_Base::is_cap($this->model(), $this->action().'_private') && $this->model() instanceof EEM_CPT_Base) {
                     // if they have basic and others, but not private, restrict them to see theirs and others' that aren't private
-                    $restrictions[ EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_private') ] = new EE_Default_Where_Conditions(
+                    $restrictions[EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action().'_private')] = new EE_Default_Where_Conditions(
                         array(
-                            'OR*' . EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_private') => $this->addPublishedPostConditions(
+                            'OR*'.EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action().'_private') => $this->addPublishedPostConditions(
                                 array(
                                     EE_Default_Where_Conditions::user_field_name_placeholder => EE_Default_Where_Conditions::current_user_placeholder,
                                 ),

core/db_models/strategies/EE_Restriction_Generator_Default_Public.strategy.php

Indentation +102 added lines, -102 removed lines

@@ -18,110 +18,110 @@
 class EE_Restriction_Generator_Default_Public extends EE_Restriction_Generator_Base
 {
 /**
-     * Name of the field on this model (or a related model, including the model chain to it)
-     * that is a boolean indicating whether or not a model object is considered "Default" or not
-     * @var string
-     */
-    protected $_default_field_name;
+ * Name of the field on this model (or a related model, including the model chain to it)
+ * that is a boolean indicating whether or not a model object is considered "Default" or not
+ * @var string
+ */
+	protected $_default_field_name;
 
-    /**
-     * The model chain to follow to get to the event model, including the event model itself.
-     * Eg 'Ticket.Datetime.Event'
-     * @var string
-     */
-    protected $_path_to_event_model;
-    /**
-     *
-     * @param string $default_field_name the name of the field Name of the field on this model (or a related model, including the model chain to it)
-     * that is a boolean indicating whether or not a model object is considered "Default" or not
-     * @param string $path_to_event_model The model chain to follow to get to the event model, including the event model itself.
-     * Eg 'Ticket.Datetime.Event'
-     */
-    public function __construct($default_field_name, $path_to_event_model)
-    {
-        $this->_default_field_name = $default_field_name;
-        if (substr($path_to_event_model, -1, 1) != '.') {
-            $path_to_event_model .= '.';
-        }
-        $this->_path_to_event_model = $path_to_event_model;
-    }
+	/**
+	 * The model chain to follow to get to the event model, including the event model itself.
+	 * Eg 'Ticket.Datetime.Event'
+	 * @var string
+	 */
+	protected $_path_to_event_model;
+	/**
+	 *
+	 * @param string $default_field_name the name of the field Name of the field on this model (or a related model, including the model chain to it)
+	 * that is a boolean indicating whether or not a model object is considered "Default" or not
+	 * @param string $path_to_event_model The model chain to follow to get to the event model, including the event model itself.
+	 * Eg 'Ticket.Datetime.Event'
+	 */
+	public function __construct($default_field_name, $path_to_event_model)
+	{
+		$this->_default_field_name = $default_field_name;
+		if (substr($path_to_event_model, -1, 1) != '.') {
+			$path_to_event_model .= '.';
+		}
+		$this->_path_to_event_model = $path_to_event_model;
+	}
 
-    /**
-     * @return EE_Default_Where_Conditions
-     * @throws EE_Error
-     */
-    protected function _generate_restrictions()
-    {
-        // if there are no standard caps for this model, then for now all we know
-        // if they need the default cap to access this
-        if (!$this->model()->cap_slug()) {
-            return array(
-                self::get_default_restrictions_cap() => new EE_Return_None_Where_Conditions()
-            );
-        }
+	/**
+	 * @return EE_Default_Where_Conditions
+	 * @throws EE_Error
+	 */
+	protected function _generate_restrictions()
+	{
+		// if there are no standard caps for this model, then for now all we know
+		// if they need the default cap to access this
+		if (!$this->model()->cap_slug()) {
+			return array(
+				self::get_default_restrictions_cap() => new EE_Return_None_Where_Conditions()
+			);
+		}
 
-        $event_model = EEM_Event::instance();
+		$event_model = EEM_Event::instance();
 
-        $restrictions = array(
-            // first: basically access to non-defaults is essentially controlled by which events are accessible
-            // if they don't have the basic event cap, they can't access ANY non-default items
-            EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action()) => new EE_Default_Where_Conditions(array(
-                'OR*no_' . EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action()) => $this->addPublishedPostConditions(
-                    array(
-                        $this->_default_field_name             => true,
-                    ),
-                    true,
-                    $this->_path_to_event_model
-                )
-            )),
-            // if they don't have the others event cap, they can only access their own, others' that are for published events, or defaults
-            EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_others') => new EE_Default_Where_Conditions(
-                array(
-                    'OR*no_' . EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_others') => $this->addPublishedPostConditions(
-                        array(
-                            $this->_path_to_event_model . 'EVT_wp_user' => EE_Default_Where_Conditions::current_user_placeholder,
-                            $this->_default_field_name => true,
-                        ),
-                        true,
-                        $this->_path_to_event_model
-                    )
-                )
-            ),
-            // if they have basic and others, but not private, they can access default, their own, and others' that aren't private
-            EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_private')   => new EE_Default_Where_Conditions(
-                array(
-                    'OR*no_' . EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_private') => $this->addPublishedPostConditions(
-                        array(
-                            $this->_path_to_event_model . 'EVT_wp_user' => EE_Default_Where_Conditions::current_user_placeholder,
-                            $this->_default_field_name => true
-                        ),
-                        false,
-                        $this->_path_to_event_model
-                    )
-                )
-            ),
-            // second: access to defaults is controlled by the default capabilities
-            // if they don't have the basic default capability, restrict access to only non-default items
-            EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_default') => new EE_Default_Where_Conditions(
-                array( $this->_default_field_name => false )
-            ),
-        );
-        if (EE_Restriction_Generator_Base::is_cap($this->model(), $this->action() . '_others_default')) {
-            // if they don't have the "others" default capability, restrict access to only their default ones, and non-default ones
-            $restrictions[ EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_others_default') ] = new EE_Default_Where_Conditions(
-                array(
-                    // if they don't have the others default cap, they can't access others default items (but they can access
-                    // their own default items, and non-default items)
-                    'OR*no_' . EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_others_default') => array(
-                        'AND' => array(
-                            EE_Default_Where_Conditions::user_field_name_placeholder => EE_Default_Where_Conditions::current_user_placeholder,
-                            $this->_default_field_name => true
-                        ),
-                        $this->_default_field_name => false
-                    )
-                )
-            );
-        }
-        return $restrictions;
-    }
+		$restrictions = array(
+			// first: basically access to non-defaults is essentially controlled by which events are accessible
+			// if they don't have the basic event cap, they can't access ANY non-default items
+			EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action()) => new EE_Default_Where_Conditions(array(
+				'OR*no_' . EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action()) => $this->addPublishedPostConditions(
+					array(
+						$this->_default_field_name             => true,
+					),
+					true,
+					$this->_path_to_event_model
+				)
+			)),
+			// if they don't have the others event cap, they can only access their own, others' that are for published events, or defaults
+			EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_others') => new EE_Default_Where_Conditions(
+				array(
+					'OR*no_' . EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_others') => $this->addPublishedPostConditions(
+						array(
+							$this->_path_to_event_model . 'EVT_wp_user' => EE_Default_Where_Conditions::current_user_placeholder,
+							$this->_default_field_name => true,
+						),
+						true,
+						$this->_path_to_event_model
+					)
+				)
+			),
+			// if they have basic and others, but not private, they can access default, their own, and others' that aren't private
+			EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_private')   => new EE_Default_Where_Conditions(
+				array(
+					'OR*no_' . EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_private') => $this->addPublishedPostConditions(
+						array(
+							$this->_path_to_event_model . 'EVT_wp_user' => EE_Default_Where_Conditions::current_user_placeholder,
+							$this->_default_field_name => true
+						),
+						false,
+						$this->_path_to_event_model
+					)
+				)
+			),
+			// second: access to defaults is controlled by the default capabilities
+			// if they don't have the basic default capability, restrict access to only non-default items
+			EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_default') => new EE_Default_Where_Conditions(
+				array( $this->_default_field_name => false )
+			),
+		);
+		if (EE_Restriction_Generator_Base::is_cap($this->model(), $this->action() . '_others_default')) {
+			// if they don't have the "others" default capability, restrict access to only their default ones, and non-default ones
+			$restrictions[ EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_others_default') ] = new EE_Default_Where_Conditions(
+				array(
+					// if they don't have the others default cap, they can't access others default items (but they can access
+					// their own default items, and non-default items)
+					'OR*no_' . EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_others_default') => array(
+						'AND' => array(
+							EE_Default_Where_Conditions::user_field_name_placeholder => EE_Default_Where_Conditions::current_user_placeholder,
+							$this->_default_field_name => true
+						),
+						$this->_default_field_name => false
+					)
+				)
+			);
+		}
+		return $restrictions;
+	}
 }

Spacing +13 added lines, -13 removed lines

@@ -54,7 +54,7 @@ 
     {
         // if there are no standard caps for this model, then for now all we know
         // if they need the default cap to access this
-        if (!$this->model()->cap_slug()) {
+        if ( ! $this->model()->cap_slug()) {
             return array(
                 self::get_default_restrictions_cap() => new EE_Return_None_Where_Conditions()
             );
@@ -66,7 +66,7 @@ 
             // first: basically access to non-defaults is essentially controlled by which events are accessible
             // if they don't have the basic event cap, they can't access ANY non-default items
             EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action()) => new EE_Default_Where_Conditions(array(
-                'OR*no_' . EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action()) => $this->addPublishedPostConditions(
+                'OR*no_'.EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action()) => $this->addPublishedPostConditions(
                     array(
                         $this->_default_field_name             => true,
                     ),
@@ -75,11 +75,11 @@ 
                 )
             )),
             // if they don't have the others event cap, they can only access their own, others' that are for published events, or defaults
-            EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_others') => new EE_Default_Where_Conditions(
+            EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action().'_others') => new EE_Default_Where_Conditions(
                 array(
-                    'OR*no_' . EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_others') => $this->addPublishedPostConditions(
+                    'OR*no_'.EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action().'_others') => $this->addPublishedPostConditions(
                         array(
-                            $this->_path_to_event_model . 'EVT_wp_user' => EE_Default_Where_Conditions::current_user_placeholder,
+                            $this->_path_to_event_model.'EVT_wp_user' => EE_Default_Where_Conditions::current_user_placeholder,
                             $this->_default_field_name => true,
                         ),
                         true,
@@ -88,11 +88,11 @@ 
                 )
             ),
             // if they have basic and others, but not private, they can access default, their own, and others' that aren't private
-            EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_private')   => new EE_Default_Where_Conditions(
+            EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action().'_private')   => new EE_Default_Where_Conditions(
                 array(
-                    'OR*no_' . EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action() . '_private') => $this->addPublishedPostConditions(
+                    'OR*no_'.EE_Restriction_Generator_Base::get_cap_name($event_model, $this->action().'_private') => $this->addPublishedPostConditions(
                         array(
-                            $this->_path_to_event_model . 'EVT_wp_user' => EE_Default_Where_Conditions::current_user_placeholder,
+                            $this->_path_to_event_model.'EVT_wp_user' => EE_Default_Where_Conditions::current_user_placeholder,
                             $this->_default_field_name => true
                         ),
                         false,
@@ -102,17 +102,17 @@ 
             ),
             // second: access to defaults is controlled by the default capabilities
             // if they don't have the basic default capability, restrict access to only non-default items
-            EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_default') => new EE_Default_Where_Conditions(
-                array( $this->_default_field_name => false )
+            EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action().'_default') => new EE_Default_Where_Conditions(
+                array($this->_default_field_name => false)
             ),
         );
-        if (EE_Restriction_Generator_Base::is_cap($this->model(), $this->action() . '_others_default')) {
+        if (EE_Restriction_Generator_Base::is_cap($this->model(), $this->action().'_others_default')) {
             // if they don't have the "others" default capability, restrict access to only their default ones, and non-default ones
-            $restrictions[ EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_others_default') ] = new EE_Default_Where_Conditions(
+            $restrictions[EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action().'_others_default')] = new EE_Default_Where_Conditions(
                 array(
                     // if they don't have the others default cap, they can't access others default items (but they can access
                     // their own default items, and non-default items)
-                    'OR*no_' . EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action() . '_others_default') => array(
+                    'OR*no_'.EE_Restriction_Generator_Base::get_cap_name($this->model(), $this->action().'_others_default') => array(
                         'AND' => array(
                             EE_Default_Where_Conditions::user_field_name_placeholder => EE_Default_Where_Conditions::current_user_placeholder,
                             $this->_default_field_name => true

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/domain/entities/route_match/RouteMatchSpecification.php

Indentation +12 added lines, -12 removed lines

@@ -24,17 +24,17 @@
 abstract class RouteMatchSpecification implements RouteMatchSpecificationInterface
 {
 
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
 
-    /**
-     * RouteMatch constructor.
-     * @param RequestInterface $request
-     */
-    public function __construct(RequestInterface $request)
-    {
-        $this->request = $request;
-    }
+	/**
+	 * RouteMatch constructor.
+	 * @param RequestInterface $request
+	 */
+	public function __construct(RequestInterface $request)
+	{
+		$this->request = $request;
+	}
 }

core/domain/entities/route_match/RouteMatchSpecificationDecorator.php

Indentation +13 added lines, -13 removed lines

@@ -13,18 +13,18 @@
 abstract class RouteMatchSpecificationDecorator implements RouteMatchSpecificationInterface
 {
 
-    /**
-     * @var RouteMatchSpecificationInterface $specification
-     */
-    protected $specification;
+	/**
+	 * @var RouteMatchSpecificationInterface $specification
+	 */
+	protected $specification;
 
-    /**
-     * RouteMatchSpecificationDecorator constructor.
-     *
-     * @param RouteMatchSpecificationInterface $specification
-     */
-    public function __construct(RouteMatchSpecificationInterface $specification)
-    {
-        $this->specification = $specification;
-    }
+	/**
+	 * RouteMatchSpecificationDecorator constructor.
+	 *
+	 * @param RouteMatchSpecificationInterface $specification
+	 */
+	public function __construct(RouteMatchSpecificationInterface $specification)
+	{
+		$this->specification = $specification;
+	}
 }

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/route_match/RouteMatchSpecificationCollection.php

Indentation +32 added lines, -32 removed lines

@@ -16,36 +16,36 @@
 class RouteMatchSpecificationCollection extends Collection
 {
 
-    const COLLECTION_NAME = 'route_match_specifications';
-
-
-    /**
-     * RouteMatchSpecificationCollection constructor
-     *
-     * @throws InvalidInterfaceException
-     */
-    public function __construct()
-    {
-        parent::__construct(
-            'EventEspresso\core\domain\entities\route_match\RouteMatchSpecificationInterface',
-            RouteMatchSpecificationCollection::COLLECTION_NAME
-        );
-    }
-
-
-    /**
-     * getIdentifier
-     * Overrides EventEspresso\core\services\collections\Collection::getIdentifier()
-     * If no $identifier is supplied, then the  fully qualified class name is used
-     *
-     * @param        $object
-     * @param  mixed $identifier
-     * @return bool
-     */
-    public function getIdentifier($object, $identifier = null)
-    {
-        return ! empty($identifier)
-            ? $identifier
-            : get_class($object);
-    }
+	const COLLECTION_NAME = 'route_match_specifications';
+
+
+	/**
+	 * RouteMatchSpecificationCollection constructor
+	 *
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct()
+	{
+		parent::__construct(
+			'EventEspresso\core\domain\entities\route_match\RouteMatchSpecificationInterface',
+			RouteMatchSpecificationCollection::COLLECTION_NAME
+		);
+	}
+
+
+	/**
+	 * getIdentifier
+	 * Overrides EventEspresso\core\services\collections\Collection::getIdentifier()
+	 * If no $identifier is supplied, then the  fully qualified class name is used
+	 *
+	 * @param        $object
+	 * @param  mixed $identifier
+	 * @return bool
+	 */
+	public function getIdentifier($object, $identifier = null)
+	{
+		return ! empty($identifier)
+			? $identifier
+			: get_class($object);
+	}
 }

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);
+		}
+	}
 }