eventespresso / event-espresso-core

core/exceptions/InvalidStatusException.php

Indentation +22 added lines, -22 removed lines

@@ -8,26 +8,26 @@
 
 class InvalidStatusException extends InvalidArgumentException
 {
-    /**
-     * InvalidStatusException constructor.
-     * @param string $status the invalid status id that was supplied
-     * @param string $domain the name of the domain, model, or class that the status belongs to
-     * @param string $message custom message
-     * @param int $code
-     * @param Exception|null $previous
-     */
-    public function __construct($status, $domain, $message = '', $code = 0, Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                __(
-                    '"%1$s" is not a valid %2$s status',
-                    'event_espresso'
-                ),
-                $status,
-                $domain
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * InvalidStatusException constructor.
+	 * @param string $status the invalid status id that was supplied
+	 * @param string $domain the name of the domain, model, or class that the status belongs to
+	 * @param string $message custom message
+	 * @param int $code
+	 * @param Exception|null $previous
+	 */
+	public function __construct($status, $domain, $message = '', $code = 0, Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				__(
+					'"%1$s" is not a valid %2$s status',
+					'event_espresso'
+				),
+				$status,
+				$domain
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 }

caffeinated/admin/extend/messages/Custom_Messages_Template_List_Table.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -151,7 +151,7 @@
      * This provides a count of events using this custom template
      *
      * @param  EE_Message_Template_Group $item message_template group data
-     * @return string column output
+     * @return integer column output
      */
     public function column_events($item)
     {

Indentation +225 added lines, -225 removed lines

@@ -12,252 +12,252 @@
 class Custom_Messages_Template_List_Table extends Messages_Template_List_Table
 {
 
-    /**
-     * Setup initial data.
-     */
-    protected function _setup_data()
-    {
-        $this->_data = $this->get_admin_page()->get_message_templates(
-            $this->_per_page,
-            $this->_view,
-            false,
-            false,
-            false
-        );
-        $this->_all_data_count = $this->get_admin_page()->get_message_templates(
-            $this->_per_page,
-            $this->_view,
-            true,
-            true,
-            false
-        );
-    }
+	/**
+	 * Setup initial data.
+	 */
+	protected function _setup_data()
+	{
+		$this->_data = $this->get_admin_page()->get_message_templates(
+			$this->_per_page,
+			$this->_view,
+			false,
+			false,
+			false
+		);
+		$this->_all_data_count = $this->get_admin_page()->get_message_templates(
+			$this->_per_page,
+			$this->_view,
+			true,
+			true,
+			false
+		);
+	}
 
 
-    /**
-     * Set initial properties
-     */
-    protected function _set_properties()
-    {
-        parent::_set_properties();
-        $this->_wp_list_args = array(
-            'singular' => esc_html__('Message Template Group', 'event_espresso'),
-            'plural'   => esc_html__('Message Template', 'event_espresso'),
-            'ajax'     => true, // for now,
-            'screen'   => $this->get_admin_page()->get_current_screen()->id,
-        );
+	/**
+	 * Set initial properties
+	 */
+	protected function _set_properties()
+	{
+		parent::_set_properties();
+		$this->_wp_list_args = array(
+			'singular' => esc_html__('Message Template Group', 'event_espresso'),
+			'plural'   => esc_html__('Message Template', 'event_espresso'),
+			'ajax'     => true, // for now,
+			'screen'   => $this->get_admin_page()->get_current_screen()->id,
+		);
 
-        $this->_columns = array_merge(
-            array(
-                'cb'   => '<input type="checkbox" />',
-                'name' => esc_html__('Template Name', 'event_espresso'),
-            ),
-            $this->_columns,
-            array(
-                'events'  => esc_html__('Events', 'event_espresso'),
-                'actions' => '',
-            )
-        );
-    }
+		$this->_columns = array_merge(
+			array(
+				'cb'   => '<input type="checkbox" />',
+				'name' => esc_html__('Template Name', 'event_espresso'),
+			),
+			$this->_columns,
+			array(
+				'events'  => esc_html__('Events', 'event_espresso'),
+				'actions' => '',
+			)
+		);
+	}
 
 
-    /**
-     * Custom message for when there are no items found.
-     *
-     * @since 4.3.0
-     */
-    public function no_items()
-    {
-        if ($this->_view !== 'trashed') {
-            printf(
-                esc_html__(
-                    '%sNo Custom Templates found.%s To create your first custom message template, go to the "Default Message Templates" tab and click the "Create Custom" button next to the template you want to use as a base for the new one.',
-                    'event_espresso'
-                ),
-                '<strong>',
-                '</strong>'
-            );
-        } else {
-            parent::no_items();
-        }
-    }
+	/**
+	 * Custom message for when there are no items found.
+	 *
+	 * @since 4.3.0
+	 */
+	public function no_items()
+	{
+		if ($this->_view !== 'trashed') {
+			printf(
+				esc_html__(
+					'%sNo Custom Templates found.%s To create your first custom message template, go to the "Default Message Templates" tab and click the "Create Custom" button next to the template you want to use as a base for the new one.',
+					'event_espresso'
+				),
+				'<strong>',
+				'</strong>'
+			);
+		} else {
+			parent::no_items();
+		}
+	}
 
 
-    /**
-     * @param EE_Message_Template_Group $item
-     * @return string
-     */
-    public function column_cb($item)
-    {
-        return sprintf('<input type="checkbox" name="checkbox[%s]" value="1" />', $item->GRP_ID());
-    }
+	/**
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 */
+	public function column_cb($item)
+	{
+		return sprintf('<input type="checkbox" name="checkbox[%s]" value="1" />', $item->GRP_ID());
+	}
 
 
-    /**
-     * @param EE_Message_Template_Group $item
-     * @return string
-     */
-    public function column_name($item)
-    {
-        return '<p>' . $item->name() . '</p>';
-    }
+	/**
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 */
+	public function column_name($item)
+	{
+		return '<p>' . $item->name() . '</p>';
+	}
 
 
-    /**
-     * @param EE_Message_Template_Group $item
-     * @return string
-     */
-    public function column_actions($item)
-    {
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_messages',
-            'espresso_messages_add_new_message_template'
-        )) {
-            $create_args = array(
-                'GRP_ID'       => $item->ID(),
-                'messenger'    => $item->messenger(),
-                'message_type' => $item->message_type(),
-                'action'       => 'add_new_message_template',
-            );
-            $create_link = EE_Admin_Page::add_query_args_and_nonce($create_args, EE_MSG_ADMIN_URL);
-            return sprintf(
-                '<p><a href="%s" class="button button-small">%s</a></p>',
-                $create_link,
-                esc_html__('Create Custom', 'event_espresso')
-            );
-        }
-        return '';
-    }
+	/**
+	 * @param EE_Message_Template_Group $item
+	 * @return string
+	 */
+	public function column_actions($item)
+	{
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_messages',
+			'espresso_messages_add_new_message_template'
+		)) {
+			$create_args = array(
+				'GRP_ID'       => $item->ID(),
+				'messenger'    => $item->messenger(),
+				'message_type' => $item->message_type(),
+				'action'       => 'add_new_message_template',
+			);
+			$create_link = EE_Admin_Page::add_query_args_and_nonce($create_args, EE_MSG_ADMIN_URL);
+			return sprintf(
+				'<p><a href="%s" class="button button-small">%s</a></p>',
+				$create_link,
+				esc_html__('Create Custom', 'event_espresso')
+			);
+		}
+		return '';
+	}
 
-    /**
-     * Set the view counts on the _views property
-     */
-    protected function _add_view_counts()
-    {
-        foreach ($this->_views as $view => $args) {
-            $this->_views[ $view ]['count'] = $this->get_admin_page()->get_message_templates(
-                $this->_per_page,
-                $view,
-                true,
-                true,
-                false
-            );
-        }
-    }
+	/**
+	 * Set the view counts on the _views property
+	 */
+	protected function _add_view_counts()
+	{
+		foreach ($this->_views as $view => $args) {
+			$this->_views[ $view ]['count'] = $this->get_admin_page()->get_message_templates(
+				$this->_per_page,
+				$view,
+				true,
+				true,
+				false
+			);
+		}
+	}
 
 
-    /**
-     * column_events
-     * This provides a count of events using this custom template
-     *
-     * @param  EE_Message_Template_Group $item message_template group data
-     * @return string column output
-     */
-    public function column_events($item)
-    {
-        return $item->count_events();
-    }
+	/**
+	 * column_events
+	 * This provides a count of events using this custom template
+	 *
+	 * @param  EE_Message_Template_Group $item message_template group data
+	 * @return string column output
+	 */
+	public function column_events($item)
+	{
+		return $item->count_events();
+	}
 
 
-    /**
-     * Add additional actions for custom message template list view.
-     *
-     * @param EE_Message_Template_Group $item
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _get_actions_for_messenger_column(EE_Message_Template_Group $item)
-    {
-        $actions = parent::_get_actions_for_messenger_column($item);
+	/**
+	 * Add additional actions for custom message template list view.
+	 *
+	 * @param EE_Message_Template_Group $item
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _get_actions_for_messenger_column(EE_Message_Template_Group $item)
+	{
+		$actions = parent::_get_actions_for_messenger_column($item);
 
-        // add additional actions for trash/restore etc.
-        $trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-            'action'   => 'trash_message_template',
-            'id'       => $item->GRP_ID(),
-            'noheader' => true,
-        ), EE_MSG_ADMIN_URL);
-        // restore link
-        $restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-            'action'   => 'restore_message_template',
-            'id'       => $item->GRP_ID(),
-            'noheader' => true,
-        ), EE_MSG_ADMIN_URL);
-        // delete price link
-        $delete_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-            'action'   => 'delete_message_template',
-            'id'       => $item->GRP_ID(),
-            'noheader' => true,
-        ), EE_MSG_ADMIN_URL);
+		// add additional actions for trash/restore etc.
+		$trash_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+			'action'   => 'trash_message_template',
+			'id'       => $item->GRP_ID(),
+			'noheader' => true,
+		), EE_MSG_ADMIN_URL);
+		// restore link
+		$restore_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+			'action'   => 'restore_message_template',
+			'id'       => $item->GRP_ID(),
+			'noheader' => true,
+		), EE_MSG_ADMIN_URL);
+		// delete price link
+		$delete_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+			'action'   => 'delete_message_template',
+			'id'       => $item->GRP_ID(),
+			'noheader' => true,
+		), EE_MSG_ADMIN_URL);
 
-        if (! $item->get('MTP_deleted')
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_message',
-                'espresso_messages_trash_message_template',
-                $item->ID()
-            )
-        ) {
-            $actions['trash'] = '<a href="'
-                                . $trash_lnk_url
-                                . '" title="'
-                                . esc_attr__('Move Template Group to Trash', 'event_espresso')
-                                . '">'
-                                . esc_html__('Move to Trash', 'event_espresso')
-                                . '</a>';
-        } else {
-            if (EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_message',
-                'espresso_messages_restore_message_template',
-                $item->ID()
-            )) {
-                $actions['restore'] = '<a href="'
-                                      . $restore_lnk_url
-                                      . '" title="'
-                                      . esc_attr__('Restore Message Template', 'event_espresso')
-                                      . '">'
-                                      . esc_html__('Restore', 'event_espresso') . '</a>';
-            }
+		if (! $item->get('MTP_deleted')
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_message',
+				'espresso_messages_trash_message_template',
+				$item->ID()
+			)
+		) {
+			$actions['trash'] = '<a href="'
+								. $trash_lnk_url
+								. '" title="'
+								. esc_attr__('Move Template Group to Trash', 'event_espresso')
+								. '">'
+								. esc_html__('Move to Trash', 'event_espresso')
+								. '</a>';
+		} else {
+			if (EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_message',
+				'espresso_messages_restore_message_template',
+				$item->ID()
+			)) {
+				$actions['restore'] = '<a href="'
+									  . $restore_lnk_url
+									  . '" title="'
+									  . esc_attr__('Restore Message Template', 'event_espresso')
+									  . '">'
+									  . esc_html__('Restore', 'event_espresso') . '</a>';
+			}
 
-            if ($this->_view === 'trashed'
-                && EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_message',
-                    'espresso_messages_delete_message_template',
-                    $item->ID()
-                )) {
-                $actions['delete'] = '<a href="'
-                                     . $delete_lnk_url
-                                     . '" title="'
-                                     . esc_attr__('Delete Template Group Permanently', 'event_espresso')
-                                     . '">'
-                                     . esc_html__('Delete Permanently', 'event_espresso')
-                                     . '</a>';
-            }
-        }
-        return $actions;
-    }
+			if ($this->_view === 'trashed'
+				&& EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_message',
+					'espresso_messages_delete_message_template',
+					$item->ID()
+				)) {
+				$actions['delete'] = '<a href="'
+									 . $delete_lnk_url
+									 . '" title="'
+									 . esc_attr__('Delete Template Group Permanently', 'event_espresso')
+									 . '">'
+									 . esc_html__('Delete Permanently', 'event_espresso')
+									 . '</a>';
+			}
+		}
+		return $actions;
+	}
 
 
-    /**
-     * Generate dropdown filter select input for messengers
-     *
-     * @param bool $global
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_messengers_dropdown_filter($global = true)
-    {
-        return parent::_get_messengers_dropdown_filter(false);
-    }
+	/**
+	 * Generate dropdown filter select input for messengers
+	 *
+	 * @param bool $global
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_messengers_dropdown_filter($global = true)
+	{
+		return parent::_get_messengers_dropdown_filter(false);
+	}
 
 
-    /**
-     * Generate dropdown filter select input for message types
-     *
-     * @param bool $global
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_message_types_dropdown_filter($global = true)
-    {
-        return parent::_get_message_types_dropdown_filter(false);
-    }
+	/**
+	 * Generate dropdown filter select input for message types
+	 *
+	 * @param bool $global
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_message_types_dropdown_filter($global = true)
+	{
+		return parent::_get_message_types_dropdown_filter(false);
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -99,7 +99,7 @@ 
      */
     public function column_name($item)
     {
-        return '<p>' . $item->name() . '</p>';
+        return '<p>'.$item->name().'</p>';
     }
 
 
@@ -135,7 +135,7 @@ 
     protected function _add_view_counts()
     {
         foreach ($this->_views as $view => $args) {
-            $this->_views[ $view ]['count'] = $this->get_admin_page()->get_message_templates(
+            $this->_views[$view]['count'] = $this->get_admin_page()->get_message_templates(
                 $this->_per_page,
                 $view,
                 true,
@@ -189,7 +189,7 @@ 
             'noheader' => true,
         ), EE_MSG_ADMIN_URL);
 
-        if (! $item->get('MTP_deleted')
+        if ( ! $item->get('MTP_deleted')
             && EE_Registry::instance()->CAP->current_user_can(
                 'ee_delete_message',
                 'espresso_messages_trash_message_template',
@@ -214,7 +214,7 @@ 
                                       . '" title="'
                                       . esc_attr__('Restore Message Template', 'event_espresso')
                                       . '">'
-                                      . esc_html__('Restore', 'event_espresso') . '</a>';
+                                      . esc_html__('Restore', 'event_espresso').'</a>';
             }
 
             if ($this->_view === 'trashed'

core/libraries/messages/EE_Message_Template_Group_Collection.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -47,7 +47,7 @@
     /**
      * This retrieves any EE_Message_Template_Group in the repo by its ID.
      *
-     * @param $GRP_ID
+     * @param integer $GRP_ID
      * @return EE_Message_Template_Group | null
      */
     public function get_by_ID($GRP_ID)

Indentation +100 added lines, -100 removed lines

@@ -14,115 +14,115 @@
 {
 
 
-    /**
-     * EE_Message_Template_Group_Collection constructor.
-     */
-    public function __construct()
-    {
-        $this->interface = 'EE_Message_Template_Group';
-    }
+	/**
+	 * EE_Message_Template_Group_Collection constructor.
+	 */
+	public function __construct()
+	{
+		$this->interface = 'EE_Message_Template_Group';
+	}
 
 
-    /**
-     * Adds the Message Template Group object to the repository.
-     *
-     * @param           $message_template_group
-     * @param array|int $EVT_ID    Some templates are specific to EVT, so this is provided as a way of
-     *                         indexing the template by key.  If this template is shared among multiple events then
-     *                         include the events as an array.
-     * @return bool
-     */
-    public function add($message_template_group, $EVT_ID = array())
-    {
-        $EVT_ID = is_array($EVT_ID) ? $EVT_ID : (array) $EVT_ID;
-        if ($message_template_group instanceof $this->interface) {
-            $data['key'] = $this->getKey(
-                $message_template_group->messenger(),
-                $message_template_group->message_type(),
-                $EVT_ID
-            );
-            return parent::add($message_template_group, $data);
-        }
-        return false;
-    }
+	/**
+	 * Adds the Message Template Group object to the repository.
+	 *
+	 * @param           $message_template_group
+	 * @param array|int $EVT_ID    Some templates are specific to EVT, so this is provided as a way of
+	 *                         indexing the template by key.  If this template is shared among multiple events then
+	 *                         include the events as an array.
+	 * @return bool
+	 */
+	public function add($message_template_group, $EVT_ID = array())
+	{
+		$EVT_ID = is_array($EVT_ID) ? $EVT_ID : (array) $EVT_ID;
+		if ($message_template_group instanceof $this->interface) {
+			$data['key'] = $this->getKey(
+				$message_template_group->messenger(),
+				$message_template_group->message_type(),
+				$EVT_ID
+			);
+			return parent::add($message_template_group, $data);
+		}
+		return false;
+	}
 
 
-    /**
-     * This retrieves any EE_Message_Template_Group in the repo by its ID.
-     *
-     * @param $GRP_ID
-     * @return EE_Message_Template_Group | null
-     */
-    public function get_by_ID($GRP_ID)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($this->current()->ID() === $GRP_ID) {
-                /** @var EE_Message_Template_Group $message_template_group */
-                $message_template_group = $this->current();
-                $this->rewind();
-                return $message_template_group;
-            }
-            $this->next();
-        }
-        return null;
-    }
+	/**
+	 * This retrieves any EE_Message_Template_Group in the repo by its ID.
+	 *
+	 * @param $GRP_ID
+	 * @return EE_Message_Template_Group | null
+	 */
+	public function get_by_ID($GRP_ID)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($this->current()->ID() === $GRP_ID) {
+				/** @var EE_Message_Template_Group $message_template_group */
+				$message_template_group = $this->current();
+				$this->rewind();
+				return $message_template_group;
+			}
+			$this->next();
+		}
+		return null;
+	}
 
 
-    /**
-     * Generates a hash used to identify a given Message Template Group.
-     *
-     * @param string $messenger    The EE_messenger->name
-     * @param string $message_type The EE_message_type->name
-     * @param int    $EVT_ID       Optional.  If the template is for a specific EVT then that should be included.
-     * @deprecated 4.9.40.rc.017  Use getKey instead.
-     * @return string
-     */
-    public function get_key($messenger, $message_type, $EVT_ID = 0)
-    {
-        $EVT_ID = (array) $EVT_ID;
-        return $this->getKey($messenger, $message_type, $EVT_ID);
-    }
+	/**
+	 * Generates a hash used to identify a given Message Template Group.
+	 *
+	 * @param string $messenger    The EE_messenger->name
+	 * @param string $message_type The EE_message_type->name
+	 * @param int    $EVT_ID       Optional.  If the template is for a specific EVT then that should be included.
+	 * @deprecated 4.9.40.rc.017  Use getKey instead.
+	 * @return string
+	 */
+	public function get_key($messenger, $message_type, $EVT_ID = 0)
+	{
+		$EVT_ID = (array) $EVT_ID;
+		return $this->getKey($messenger, $message_type, $EVT_ID);
+	}
 
 
-    /**
-     * Generates a hash used to identify a given Message Template Group
-     * @param string    $messenger      The EE_messenger->name
-     * @param string    $message_type   The EE_message_type->name
-     * @param array     $EVT_ID         Optional.  If the template is for a specific EVT_ID (or events) then that should
-     *                                  be included.
-     * @since 4.9.40.rc.017
-     * @return string
-     */
-    public function getKey($messenger, $message_type, array $EVT_ID = array())
-    {
-        sort($EVT_ID);
-        $EVT_ID = implode(',', array_unique($EVT_ID));
-        return md5($messenger . $message_type . $EVT_ID);
-    }
+	/**
+	 * Generates a hash used to identify a given Message Template Group
+	 * @param string    $messenger      The EE_messenger->name
+	 * @param string    $message_type   The EE_message_type->name
+	 * @param array     $EVT_ID         Optional.  If the template is for a specific EVT_ID (or events) then that should
+	 *                                  be included.
+	 * @since 4.9.40.rc.017
+	 * @return string
+	 */
+	public function getKey($messenger, $message_type, array $EVT_ID = array())
+	{
+		sort($EVT_ID);
+		$EVT_ID = implode(',', array_unique($EVT_ID));
+		return md5($messenger . $message_type . $EVT_ID);
+	}
 
 
-    /**
-     * This returns a saved EE_Message_Template_Group object if there is one in the repository indexed by a key matching
-     * the given string.
-     *
-     * @param string $key @see EE_Message_Template_Group::get_key() to setup a key formatted for searching.
-     * @return null|EE_Message_Template_Group
-     */
-    public function get_by_key($key)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            $data = $this->getInfo();
-            if (isset($data['key']) && $data['key'] === $key) {
-                /** @var EE_Message_Template_Group $message_template_group */
-                $message_template_group = $this->current();
-                $this->rewind();
-                return $message_template_group;
-            }
-            $this->next();
-        }
-        return null;
-    }
+	/**
+	 * This returns a saved EE_Message_Template_Group object if there is one in the repository indexed by a key matching
+	 * the given string.
+	 *
+	 * @param string $key @see EE_Message_Template_Group::get_key() to setup a key formatted for searching.
+	 * @return null|EE_Message_Template_Group
+	 */
+	public function get_by_key($key)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			$data = $this->getInfo();
+			if (isset($data['key']) && $data['key'] === $key) {
+				/** @var EE_Message_Template_Group $message_template_group */
+				$message_template_group = $this->current();
+				$this->rewind();
+				return $message_template_group;
+			}
+			$this->next();
+		}
+		return null;
+	}
 
 }

Spacing +1 added lines, -1 removed lines

@@ -98,7 +98,7 @@
     {
         sort($EVT_ID);
         $EVT_ID = implode(',', array_unique($EVT_ID));
-        return md5($messenger . $message_type . $EVT_ID);
+        return md5($messenger.$message_type.$EVT_ID);
     }
 
 

public/template_tags.php

Doc Comments +5 added lines, -5 removed lines

@@ -130,7 +130,7 @@ 
  * can_use_espresso_conditionals
  * tests whether the Espresso Conditional tags like is_espresso_event_single() can be called
  *
- * @param $conditional_tag
+ * @param string $conditional_tag
  * @return bool
  */
 function can_use_espresso_conditionals( $conditional_tag ) {
@@ -201,7 +201,7 @@ 
 if ( ! function_exists( 'espresso_ticket_selector' )) {
 	/**
 	 * espresso_ticket_selector
-	 * @param null $event
+	 * @param EE_Event $event
 	 */
 	function espresso_ticket_selector( $event = NULL ) {
 		if (  ! apply_filters( 'FHEE_disable_espresso_ticket_selector', FALSE ) ) {
@@ -842,7 +842,7 @@ 
 	/**
 	 * espresso_event_venues
 	 *
-	 * @return array  all venues related to an event
+	 * @return EE_Venue[]  all venues related to an event
 	 */
 	function espresso_event_venues() {
 		return EEH_Venue_View::get_event_venues();
@@ -875,7 +875,7 @@ 
 	 *
 	 * @param int     $VNU_ID optional, the venue id to check.
 	 *
-	 * @return bool | null
+	 * @return null|boolean | null
 	 */
 	function espresso_is_venue_private( $VNU_ID = 0 ) {
 		return EEH_Venue_View::is_venue_private( $VNU_ID );
@@ -889,7 +889,7 @@ 
 	 * returns true or false if a venue is password protected or not
 	 *
 	 * @param int     $VNU_ID optional, the venue id to check.
-	 * @return string
+	 * @return boolean
 	 */
 	function espresso_venue_is_password_protected( $VNU_ID = 0 ) {
 		EE_Registry::instance()->load_helper( 'Venue_View' );

core/services/cache/BasicCacheManager.php

Spacing +4 added lines, -4 removed lines

@@ -140,7 +140,7 @@ 
         // with these parameters
         $cache_id .= filter_input(INPUT_SERVER, 'QUERY_STRING', FILTER_SANITIZE_URL);
         // then md5 the above to control it's length, add all of our prefixes, and truncate
-        return substr($this->cachePrefix() . $id_prefix . '-' . md5($cache_id), 0, 182);
+        return substr($this->cachePrefix().$id_prefix.'-'.md5($cache_id), 0, 182);
     }
 
 
@@ -170,9 +170,9 @@ 
         return '
 <div class="ee-cached-content-notice" style="position:fixed; bottom:0; left: 0;">
     <p style="font-size:9px;font-weight:normal;color:#666;line-height: 12px;margin:0 0 3px 5px">
-        <b>' . $type . '</b><span style="color:#999"> : </span>
-        <span>' . $cache_id . '</span>
-        <span style="margin-left:2em;">' . __FILE__ . '</span>
+        <b>' . $type.'</b><span style="color:#999"> : </span>
+        <span>' . $cache_id.'</span>
+        <span style="margin-left:2em;">' . __FILE__.'</span>
     </p>
 </div>';
     }

Indentation +130 added lines, -130 removed lines

@@ -16,135 +16,135 @@ 
 class BasicCacheManager implements CacheManagerInterface
 {
 
-    /**
-     * @type string
-     */
-    const CACHE_PREFIX = 'ee_cache_';
-
-
-    /**
-     * @var CacheStorageInterface $cache_storage
-     */
-    private $cache_storage;
-
-
-    /**
-     * BasicCacheManager constructor.
-     *
-     * @param CacheStorageInterface $cache_storage [required]
-     */
-    public function __construct(CacheStorageInterface $cache_storage)
-    {
-        $this->cache_storage = $cache_storage;
-    }
-
-
-    /**
-     * returns a string that will be prepended to all cache identifiers
-     *
-     * @return string
-     */
-    public function cachePrefix()
-    {
-        return BasicCacheManager::CACHE_PREFIX;
-    }
-
-
-    /**
-     * @param string  $id_prefix [required] Prepended to all cache IDs. Can be helpful in finding specific cache types.
-     *                           May also be helpful to include an additional specific identifier,
-     *                           such as a post ID as part of the $id_prefix so that individual caches
-     *                           can be found and/or cleared. ex: "venue-28", or "shortcode-156".
-     *                           BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id.
-     * @param string  $cache_id  [required] Additional identifying details that make this cache unique.
-     *                           It is advisable to use some of the actual data
-     *                           that is used to generate the content being cached,
-     *                           in order to guarantee that the cache id is unique for that content.
-     *                           The cache id will be md5'd before usage to make it more db friendly,
-     *                           and the entire cache id string will be truncated to 190 characters.
-     * @param Closure $callback  [required] since the point of caching is to avoid generating content when not
-     *                           necessary,
-     *                           we wrap our content creation in a Closure so that it is not executed until needed.
-     * @param int     $expiration
-     * @return Closure|mixed
-     */
-    public function get($id_prefix, $cache_id, Closure $callback, $expiration = HOUR_IN_SECONDS)
-    {
-        $content = '';
-        $expiration = absint(
-            apply_filters(
-                'FHEE__CacheManager__get__cache_expiration',
-                $expiration,
-                $id_prefix,
-                $cache_id
-            )
-        );
-        $cache_id = $this->generateCacheIdentifier($id_prefix, $cache_id);
-        // is caching enabled for this content ?
-        if ($expiration) {
-            $content = $this->cache_storage->get($cache_id);
-        }
-        // any existing content ?
-        if (empty($content)) {
-            // nope! let's generate some new stuff
-            $content = $callback();
-            // save the new content if caching is enabled
-            if ($expiration) {
-                $this->cache_storage->add($cache_id, $content, $expiration);
-                if (EE_DEBUG) {
-                    $content .= $this->displayCacheNotice($cache_id, 'REFRESH CACHE');
-                }
-            }
-        } else {
-            if (EE_DEBUG) {
-                $content .= $this->displayCacheNotice($cache_id, 'CACHED CONTENT');
-            }
-        }
-        return $content;
-    }
-
-
-    /**
-     * Generates a unique identifier string for the cache
-     *
-     * @param string $id_prefix [required] see BasicCacheManager::get()
-     * @param string $cache_id  [required] see BasicCacheManager::get()
-     * @return string
-     */
-    private function generateCacheIdentifier($id_prefix, $cache_id)
-    {
-        // let's make the cached content unique for this "page"
-        $cache_id .= filter_input(INPUT_SERVER, 'REQUEST_URI', FILTER_SANITIZE_URL);
-        // with these parameters
-        $cache_id .= filter_input(INPUT_SERVER, 'QUERY_STRING', FILTER_SANITIZE_URL);
-        // then md5 the above to control it's length, add all of our prefixes, and truncate
-        return substr($this->cachePrefix() . $id_prefix . '-' . md5($cache_id), 0, 182);
-    }
-
-
-    /**
-     * @param array|string $cache_id [required] Could be an ID prefix affecting many caches
-     *                               or a specific ID targeting a single cache item
-     * @return void
-     */
-    public function clear($cache_id)
-    {
-        // ensure incoming arg is in an array
-        $cache_id = is_array($cache_id) ? $cache_id : array($cache_id);
-        // delete corresponding transients for the supplied id prefix
-        $this->cache_storage->deleteMany($cache_id);
-    }
-
-
-    /**
-     * @param array|string $cache_id [required] Could be an ID prefix affecting many caches
-     *                               or a specific ID targeting a single cache item
-     * @param string       $type
-     * @return string
-     */
-    private function displayCacheNotice($cache_id, $type)
-    {
-        return '
+	/**
+	 * @type string
+	 */
+	const CACHE_PREFIX = 'ee_cache_';
+
+
+	/**
+	 * @var CacheStorageInterface $cache_storage
+	 */
+	private $cache_storage;
+
+
+	/**
+	 * BasicCacheManager constructor.
+	 *
+	 * @param CacheStorageInterface $cache_storage [required]
+	 */
+	public function __construct(CacheStorageInterface $cache_storage)
+	{
+		$this->cache_storage = $cache_storage;
+	}
+
+
+	/**
+	 * returns a string that will be prepended to all cache identifiers
+	 *
+	 * @return string
+	 */
+	public function cachePrefix()
+	{
+		return BasicCacheManager::CACHE_PREFIX;
+	}
+
+
+	/**
+	 * @param string  $id_prefix [required] Prepended to all cache IDs. Can be helpful in finding specific cache types.
+	 *                           May also be helpful to include an additional specific identifier,
+	 *                           such as a post ID as part of the $id_prefix so that individual caches
+	 *                           can be found and/or cleared. ex: "venue-28", or "shortcode-156".
+	 *                           BasicCacheManager::CACHE_PREFIX will also be prepended to the cache id.
+	 * @param string  $cache_id  [required] Additional identifying details that make this cache unique.
+	 *                           It is advisable to use some of the actual data
+	 *                           that is used to generate the content being cached,
+	 *                           in order to guarantee that the cache id is unique for that content.
+	 *                           The cache id will be md5'd before usage to make it more db friendly,
+	 *                           and the entire cache id string will be truncated to 190 characters.
+	 * @param Closure $callback  [required] since the point of caching is to avoid generating content when not
+	 *                           necessary,
+	 *                           we wrap our content creation in a Closure so that it is not executed until needed.
+	 * @param int     $expiration
+	 * @return Closure|mixed
+	 */
+	public function get($id_prefix, $cache_id, Closure $callback, $expiration = HOUR_IN_SECONDS)
+	{
+		$content = '';
+		$expiration = absint(
+			apply_filters(
+				'FHEE__CacheManager__get__cache_expiration',
+				$expiration,
+				$id_prefix,
+				$cache_id
+			)
+		);
+		$cache_id = $this->generateCacheIdentifier($id_prefix, $cache_id);
+		// is caching enabled for this content ?
+		if ($expiration) {
+			$content = $this->cache_storage->get($cache_id);
+		}
+		// any existing content ?
+		if (empty($content)) {
+			// nope! let's generate some new stuff
+			$content = $callback();
+			// save the new content if caching is enabled
+			if ($expiration) {
+				$this->cache_storage->add($cache_id, $content, $expiration);
+				if (EE_DEBUG) {
+					$content .= $this->displayCacheNotice($cache_id, 'REFRESH CACHE');
+				}
+			}
+		} else {
+			if (EE_DEBUG) {
+				$content .= $this->displayCacheNotice($cache_id, 'CACHED CONTENT');
+			}
+		}
+		return $content;
+	}
+
+
+	/**
+	 * Generates a unique identifier string for the cache
+	 *
+	 * @param string $id_prefix [required] see BasicCacheManager::get()
+	 * @param string $cache_id  [required] see BasicCacheManager::get()
+	 * @return string
+	 */
+	private function generateCacheIdentifier($id_prefix, $cache_id)
+	{
+		// let's make the cached content unique for this "page"
+		$cache_id .= filter_input(INPUT_SERVER, 'REQUEST_URI', FILTER_SANITIZE_URL);
+		// with these parameters
+		$cache_id .= filter_input(INPUT_SERVER, 'QUERY_STRING', FILTER_SANITIZE_URL);
+		// then md5 the above to control it's length, add all of our prefixes, and truncate
+		return substr($this->cachePrefix() . $id_prefix . '-' . md5($cache_id), 0, 182);
+	}
+
+
+	/**
+	 * @param array|string $cache_id [required] Could be an ID prefix affecting many caches
+	 *                               or a specific ID targeting a single cache item
+	 * @return void
+	 */
+	public function clear($cache_id)
+	{
+		// ensure incoming arg is in an array
+		$cache_id = is_array($cache_id) ? $cache_id : array($cache_id);
+		// delete corresponding transients for the supplied id prefix
+		$this->cache_storage->deleteMany($cache_id);
+	}
+
+
+	/**
+	 * @param array|string $cache_id [required] Could be an ID prefix affecting many caches
+	 *                               or a specific ID targeting a single cache item
+	 * @param string       $type
+	 * @return string
+	 */
+	private function displayCacheNotice($cache_id, $type)
+	{
+		return '
 <div class="ee-cached-content-notice" style="position:fixed; bottom:0; left: 0;">
     <p style="font-size:9px;font-weight:normal;color:#666;line-height: 12px;margin:0 0 3px 5px">
         <b>' . $type . '</b><span style="color:#999"> : </span>
@@ -152,5 +152,5 @@ 
         <span style="margin-left:2em;">' . __FILE__ . '</span>
     </p>
 </div>';
-    }
+	}
 }

acceptance_tests/Page/EventsAdmin.php

Doc Comments +1 added lines, -1 removed lines

@@ -120,7 +120,7 @@
 
     /**
      * Wrapper for getting the selector for a given field and given display row of a ticket in the event editor.
-     * @param     $field_name
+     * @param     string $field_name
      * @param int $row_number
      * @return string
      */

admin_pages/transactions/EE_Admin_Transactions_List_Table.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -102,7 +102,7 @@ 
      *
      * @abstract
      * @access protected
-     * @return array
+     * @return string[]
      */
     protected function _get_table_filters()
     {
@@ -265,7 +265,7 @@ 
      *    column_TXN_paid
      *
      * @param \EE_Transaction $transaction
-     * @return mixed|string
+     * @return string
      * @throws \EE_Error
      */
     public function column_TXN_paid(EE_Transaction $transaction)

acceptance_tests/Helpers/CountrySettingsAdmin.php

Unused Use Statements -1 removed lines

@@ -1,7 +1,6 @@
 <?php
 namespace EventEspresso\Codeception\helpers;
 
-use Page\CoreAdmin;
 use Page\CountrySettingsAdmin as CountrySettings;
 
 trait CountrySettingsAdmin

core/domain/services/validation/email/strategies/InternationalDNS.php

Spacing +2 added lines, -2 removed lines

@@ -34,7 +34,7 @@ 
             $email_address,
             $this->getAtIndex($email_address)
         );
-        if (! checkdnsrr($domain, 'MX')) {
+        if ( ! checkdnsrr($domain, 'MX')) {
             // domain not found in MX records
             throw new EmailValidationException(
                 __(
@@ -45,7 +45,7 @@ 
                 )
             );
         }
-        if (! checkdnsrr($domain, 'A')) {
+        if ( ! checkdnsrr($domain, 'A')) {
             // domain not found in A records
             throw new EmailValidationException(
                 __(

Indentation +39 added lines, -39 removed lines

@@ -15,43 +15,43 @@
 class InternationalDNS extends International
 {
 
-    /**
-     * Validates the email in teh same way as the parent, but also
-     * verifies the domain exists.
-     *
-     * @param string $email_address
-     * @return bool
-     * @throws EmailValidationException
-     */
-    public function validate($email_address)
-    {
-        parent::validate($email_address);
-        $domain = $this->getDomainPartOfEmail(
-            $email_address,
-            $this->getAtIndex($email_address)
-        );
-        if (! checkdnsrr($domain, 'MX')) {
-            // domain not found in MX records
-            throw new EmailValidationException(
-                __(
-                // @codingStandardsIgnoreStart
-                    'Although the email address provided is formatted correctly, a valid "MX record" could not be located for that address and domain. Please enter a valid email address.',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                )
-            );
-        }
-        if (! checkdnsrr($domain, 'A')) {
-            // domain not found in A records
-            throw new EmailValidationException(
-                __(
-                // @codingStandardsIgnoreStart
-                    'Although the email address provided is formatted correctly, a valid "A record" could not be located for that address and domain. Please enter a valid email address.',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                )
-            );
-        }
-        return true;
-    }
+	/**
+	 * Validates the email in teh same way as the parent, but also
+	 * verifies the domain exists.
+	 *
+	 * @param string $email_address
+	 * @return bool
+	 * @throws EmailValidationException
+	 */
+	public function validate($email_address)
+	{
+		parent::validate($email_address);
+		$domain = $this->getDomainPartOfEmail(
+			$email_address,
+			$this->getAtIndex($email_address)
+		);
+		if (! checkdnsrr($domain, 'MX')) {
+			// domain not found in MX records
+			throw new EmailValidationException(
+				__(
+				// @codingStandardsIgnoreStart
+					'Although the email address provided is formatted correctly, a valid "MX record" could not be located for that address and domain. Please enter a valid email address.',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				)
+			);
+		}
+		if (! checkdnsrr($domain, 'A')) {
+			// domain not found in A records
+			throw new EmailValidationException(
+				__(
+				// @codingStandardsIgnoreStart
+					'Although the email address provided is formatted correctly, a valid "A record" could not be located for that address and domain. Please enter a valid email address.',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				)
+			);
+		}
+		return true;
+	}
 }