eventespresso / event-espresso-core

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

Spacing +13 added lines, -13 removed lines

@@ -63,7 +63,7 @@ 
      */
     protected function _extend_properties()
     {
-        define('EE_MSGS_EXTEND_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'messages/assets/');
+        define('EE_MSGS_EXTEND_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL.'messages/assets/');
         $this->_ajax_func = ['ee_msgs_create_new_custom' => 'create_new_custom'];
         $this->_metaboxes = [
             0 => [
@@ -78,11 +78,11 @@ 
         $this->_scripts_styles = [
             'registers' => [
                 'events_msg_admin'     => [
-                    'url'     => EE_MSGS_EXTEND_ASSETS_URL . 'events_messages_admin.js',
+                    'url'     => EE_MSGS_EXTEND_ASSETS_URL.'events_messages_admin.js',
                     'depends' => ['ee-dialog', 'ee-parse-uri', 'ee-serialize-full-array'],
                 ],
                 'events_msg_admin_css' => [
-                    'url'  => EE_MSGS_EXTEND_ASSETS_URL . 'ee_msg_events_admin.css',
+                    'url'  => EE_MSGS_EXTEND_ASSETS_URL.'ee_msg_events_admin.css',
                     'type' => 'css',
                 ],
             ],
@@ -154,18 +154,18 @@ 
                 ['action' => 'settings'],
                 EE_MSG_ADMIN_URL
             );
-            $error_msg        = sprintf(
+            $error_msg = sprintf(
                 esc_html__(
                     'There are no active messengers. So no notifications will go out for %1$sany%2$s events.  You will want to %3$sActivate a Messenger%4$s.',
                     'event_espresso'
                 ),
                 '<strong>',
                 '</strong>',
-                '<a href="' . $msg_activate_url . '">',
+                '<a href="'.$msg_activate_url.'">',
                 '</a>'
             );
-            $error_content    = '<div class="error"><p>' . $error_msg . '</p></div>';
-            $internal_content = '<div id="messages-error"><p>' . $error_msg . '</p></div>';
+            $error_content    = '<div class="error"><p>'.$error_msg.'</p></div>';
+            $internal_content = '<div id="messages-error"><p>'.$error_msg.'</p></div>';
 
             echo $error_content;
             echo $internal_content;
@@ -186,8 +186,8 @@ 
                 ['event' => $EVT_ID]
             );
 
-            if (! empty($tab_content)) {
-                $tabs[ $name ] = $tab_content;
+            if ( ! empty($tab_content)) {
+                $tabs[$name] = $tab_content;
             }
         }
 
@@ -201,7 +201,7 @@ 
         $notices = '
 	<div id="espresso-ajax-loading" class="ajax-loader-grey">
 		<span class="ee-spinner ee-spin"></span>
-		<span class="hidden">' . esc_html__('loading...', 'event_espresso') . '</span>
+		<span class="hidden">' . esc_html__('loading...', 'event_espresso').'</span>
 	</div>
 	<div class="ee-notices"></div>';
 
@@ -210,7 +210,7 @@ 
         }
 
         do_action('AHEE__espresso_events_Messages_Hooks_Extend__messages_metabox__before_content');
-        echo $notices . '<div class="messages-tabs-content">' . $tabbed_content . '</div>';
+        echo $notices.'<div class="messages-tabs-content">'.$tabbed_content.'</div>';
         do_action('AHEE__espresso_events_Messages_Hooks_Extend__messages_metabox__after_content');
         return '';
     }
@@ -227,7 +227,7 @@ 
      */
     public function create_new_custom()
     {
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_edit_messages', 'create_new_custom_ajax')) {
+        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_edit_messages', 'create_new_custom_ajax')) {
             wp_die(esc_html__('You don\'t have privileges to do this action', 'event_espresso'));
         }
 
@@ -270,7 +270,7 @@ 
     public function edit_admin_footer()
     {
         EEH_Template::display_template(
-            EE_CORE_CAF_ADMIN_EXTEND . 'messages/templates/create_custom_template_form.template.php'
+            EE_CORE_CAF_ADMIN_EXTEND.'messages/templates/create_custom_template_form.template.php'
         );
     }
 

Indentation +273 added lines, -273 removed lines

@@ -15,283 +15,283 @@
 class espresso_events_Messages_Hooks_Extend extends espresso_events_Messages_Hooks
 {
 
-    /**
-     * @var Messages_Admin_Page
-     */
-    protected $_page_object;
-
-
-    /**
-     * espresso_events_Messages_Hooks_Extend constructor.
-     *
-     * @param EE_Admin_Page $admin_page
-     * @throws EE_Error
-     */
-    public function __construct(EE_Admin_Page $admin_page)
-    {
-        /**
-         * Add cap restriction ... metaboxes should not show if user does not have the ability to edit_custom_messages
-         */
-        if (
-            ! EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_messages',
-                'messages_events_editor_metabox'
-            )
-        ) {
-            return;
-        }
-        add_filter(
-            'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
-            [$this, 'caf_updates'],
-            10
-        );
-        add_action(
-            'AHEE__Extend_Events_Admin_Page___duplicate_event__after',
-            [$this, 'duplicate_custom_message_settings'],
-            10,
-            2
-        );
-        parent::__construct($admin_page);
-    }
-
-
-    /**
-     * extending the properties set in espresso_events_Messages_Hooks
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _extend_properties()
-    {
-        define('EE_MSGS_EXTEND_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'messages/assets/');
-        $this->_ajax_func = ['ee_msgs_create_new_custom' => 'create_new_custom'];
-        $this->_metaboxes = [
-            0 => [
-                'page_route' => ['edit', 'create_new'],
-                'func'       => 'messages_metabox',
-                'label'      => esc_html__('Notifications', 'event_espresso'),
-                'priority'   => 'high',
-            ],
-        ];
-
-        // see explanation for layout in EE_Admin_Hooks
-        $this->_scripts_styles = [
-            'registers' => [
-                'events_msg_admin'     => [
-                    'url'     => EE_MSGS_EXTEND_ASSETS_URL . 'events_messages_admin.js',
-                    'depends' => ['ee-dialog', 'ee-parse-uri', 'ee-serialize-full-array'],
-                ],
-                'events_msg_admin_css' => [
-                    'url'  => EE_MSGS_EXTEND_ASSETS_URL . 'ee_msg_events_admin.css',
-                    'type' => 'css',
-                ],
-            ],
-            'enqueues'  => [
-                'events_msg_admin'     => ['edit', 'create_new'],
-                'events_msg_admin_css' => ['edit', 'create_new'],
-            ],
-        ];
-    }
-
-
-    public function caf_updates($update_callbacks)
-    {
-        $update_callbacks[] = [$this, 'attach_evt_message_templates'];
-        return $update_callbacks;
-    }
-
-
-    /**
-     * Handles attaching Message Templates to the Event on save.
-     *
-     * @param EE_Event $event EE event object
-     * @param array    $data  The request data from the form
-     * @return bool success or fail
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function attach_evt_message_templates($event, $data)
-    {
-        // first we remove all existing relations on the Event for message types.
-        $event->_remove_relations('Message_Template_Group');
-        // now let's just loop through the selected templates and add relations!
-        if (isset($data['event_message_templates_relation'])) {
-            foreach ($data['event_message_templates_relation'] as $grp_ID) {
-                $event->_add_relation_to($grp_ID, 'Message_Template_Group');
-            }
-        }
-        // now save
-        return $event->save();
-    }
-
-
-    /**
-     * @param $event
-     * @param $callback_args
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function messages_metabox($event, $callback_args)
-    {
-        // convert 'evt_id' to 'EVT_ID'
-        $EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
-        $EVT_ID = $this->request->getRequestParam('post', $EVT_ID, 'int');
-        $EVT_ID = $this->request->getRequestParam('evt_id', $EVT_ID, 'int');
-        $this->request->setRequestParam('EVT_ID', $EVT_ID);
-
-        // get the active messengers (b/c messenger objects have the active message templates)
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $active_messengers        = $message_resource_manager->active_messengers();
-        $tabs                     = [];
-
-        // empty messengers?
-        // Note message types will always have at least one available because every messenger has a default message type
-        // associated with it (payment) if no other message types are selected.
-        if (empty($active_messengers)) {
-            $msg_activate_url = EE_Admin_Page::add_query_args_and_nonce(
-                ['action' => 'settings'],
-                EE_MSG_ADMIN_URL
-            );
-            $error_msg        = sprintf(
-                esc_html__(
-                    'There are no active messengers. So no notifications will go out for %1$sany%2$s events.  You will want to %3$sActivate a Messenger%4$s.',
-                    'event_espresso'
-                ),
-                '<strong>',
-                '</strong>',
-                '<a href="' . $msg_activate_url . '">',
-                '</a>'
-            );
-            $error_content    = '<div class="error"><p>' . $error_msg . '</p></div>';
-            $internal_content = '<div id="messages-error"><p>' . $error_msg . '</p></div>';
-
-            echo $error_content;
-            echo $internal_content;
-            return '';
-        }
-
-        // get content for active messengers
-        foreach ($active_messengers as $name => $messenger) {
-            // first check if there are any active message types for this messenger.
-            $active_mts = $message_resource_manager->get_active_message_types_for_messenger($name);
-            if (empty($active_mts)) {
-                continue;
-            }
-
-            $tab_content = $messenger->get_messenger_admin_page_content(
-                'events',
-                'edit',
-                ['event' => $EVT_ID]
-            );
-
-            if (! empty($tab_content)) {
-                $tabs[ $name ] = $tab_content;
-            }
-        }
-
-
-        // we want this to be tabbed content so let's use the EEH_Tabbed_Content::display helper.
-        $tabbed_content = EEH_Tabbed_Content::display($tabs);
-        if ($tabbed_content instanceof WP_Error) {
-            $tabbed_content = $tabbed_content->get_error_message();
-        }
-
-        $notices = '
+	/**
+	 * @var Messages_Admin_Page
+	 */
+	protected $_page_object;
+
+
+	/**
+	 * espresso_events_Messages_Hooks_Extend constructor.
+	 *
+	 * @param EE_Admin_Page $admin_page
+	 * @throws EE_Error
+	 */
+	public function __construct(EE_Admin_Page $admin_page)
+	{
+		/**
+		 * Add cap restriction ... metaboxes should not show if user does not have the ability to edit_custom_messages
+		 */
+		if (
+			! EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_messages',
+				'messages_events_editor_metabox'
+			)
+		) {
+			return;
+		}
+		add_filter(
+			'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
+			[$this, 'caf_updates'],
+			10
+		);
+		add_action(
+			'AHEE__Extend_Events_Admin_Page___duplicate_event__after',
+			[$this, 'duplicate_custom_message_settings'],
+			10,
+			2
+		);
+		parent::__construct($admin_page);
+	}
+
+
+	/**
+	 * extending the properties set in espresso_events_Messages_Hooks
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _extend_properties()
+	{
+		define('EE_MSGS_EXTEND_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'messages/assets/');
+		$this->_ajax_func = ['ee_msgs_create_new_custom' => 'create_new_custom'];
+		$this->_metaboxes = [
+			0 => [
+				'page_route' => ['edit', 'create_new'],
+				'func'       => 'messages_metabox',
+				'label'      => esc_html__('Notifications', 'event_espresso'),
+				'priority'   => 'high',
+			],
+		];
+
+		// see explanation for layout in EE_Admin_Hooks
+		$this->_scripts_styles = [
+			'registers' => [
+				'events_msg_admin'     => [
+					'url'     => EE_MSGS_EXTEND_ASSETS_URL . 'events_messages_admin.js',
+					'depends' => ['ee-dialog', 'ee-parse-uri', 'ee-serialize-full-array'],
+				],
+				'events_msg_admin_css' => [
+					'url'  => EE_MSGS_EXTEND_ASSETS_URL . 'ee_msg_events_admin.css',
+					'type' => 'css',
+				],
+			],
+			'enqueues'  => [
+				'events_msg_admin'     => ['edit', 'create_new'],
+				'events_msg_admin_css' => ['edit', 'create_new'],
+			],
+		];
+	}
+
+
+	public function caf_updates($update_callbacks)
+	{
+		$update_callbacks[] = [$this, 'attach_evt_message_templates'];
+		return $update_callbacks;
+	}
+
+
+	/**
+	 * Handles attaching Message Templates to the Event on save.
+	 *
+	 * @param EE_Event $event EE event object
+	 * @param array    $data  The request data from the form
+	 * @return bool success or fail
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function attach_evt_message_templates($event, $data)
+	{
+		// first we remove all existing relations on the Event for message types.
+		$event->_remove_relations('Message_Template_Group');
+		// now let's just loop through the selected templates and add relations!
+		if (isset($data['event_message_templates_relation'])) {
+			foreach ($data['event_message_templates_relation'] as $grp_ID) {
+				$event->_add_relation_to($grp_ID, 'Message_Template_Group');
+			}
+		}
+		// now save
+		return $event->save();
+	}
+
+
+	/**
+	 * @param $event
+	 * @param $callback_args
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function messages_metabox($event, $callback_args)
+	{
+		// convert 'evt_id' to 'EVT_ID'
+		$EVT_ID = $this->request->getRequestParam('EVT_ID', 0, 'int');
+		$EVT_ID = $this->request->getRequestParam('post', $EVT_ID, 'int');
+		$EVT_ID = $this->request->getRequestParam('evt_id', $EVT_ID, 'int');
+		$this->request->setRequestParam('EVT_ID', $EVT_ID);
+
+		// get the active messengers (b/c messenger objects have the active message templates)
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$active_messengers        = $message_resource_manager->active_messengers();
+		$tabs                     = [];
+
+		// empty messengers?
+		// Note message types will always have at least one available because every messenger has a default message type
+		// associated with it (payment) if no other message types are selected.
+		if (empty($active_messengers)) {
+			$msg_activate_url = EE_Admin_Page::add_query_args_and_nonce(
+				['action' => 'settings'],
+				EE_MSG_ADMIN_URL
+			);
+			$error_msg        = sprintf(
+				esc_html__(
+					'There are no active messengers. So no notifications will go out for %1$sany%2$s events.  You will want to %3$sActivate a Messenger%4$s.',
+					'event_espresso'
+				),
+				'<strong>',
+				'</strong>',
+				'<a href="' . $msg_activate_url . '">',
+				'</a>'
+			);
+			$error_content    = '<div class="error"><p>' . $error_msg . '</p></div>';
+			$internal_content = '<div id="messages-error"><p>' . $error_msg . '</p></div>';
+
+			echo $error_content;
+			echo $internal_content;
+			return '';
+		}
+
+		// get content for active messengers
+		foreach ($active_messengers as $name => $messenger) {
+			// first check if there are any active message types for this messenger.
+			$active_mts = $message_resource_manager->get_active_message_types_for_messenger($name);
+			if (empty($active_mts)) {
+				continue;
+			}
+
+			$tab_content = $messenger->get_messenger_admin_page_content(
+				'events',
+				'edit',
+				['event' => $EVT_ID]
+			);
+
+			if (! empty($tab_content)) {
+				$tabs[ $name ] = $tab_content;
+			}
+		}
+
+
+		// we want this to be tabbed content so let's use the EEH_Tabbed_Content::display helper.
+		$tabbed_content = EEH_Tabbed_Content::display($tabs);
+		if ($tabbed_content instanceof WP_Error) {
+			$tabbed_content = $tabbed_content->get_error_message();
+		}
+
+		$notices = '
 	<div id="espresso-ajax-loading" class="ajax-loader-grey">
 		<span class="ee-spinner ee-spin"></span>
 		<span class="hidden">' . esc_html__('loading...', 'event_espresso') . '</span>
 	</div>
 	<div class="ee-notices"></div>';
 
-        if (defined('DOING_AJAX')) {
-            return $tabbed_content;
-        }
-
-        do_action('AHEE__espresso_events_Messages_Hooks_Extend__messages_metabox__before_content');
-        echo $notices . '<div class="messages-tabs-content">' . $tabbed_content . '</div>';
-        do_action('AHEE__espresso_events_Messages_Hooks_Extend__messages_metabox__after_content');
-        return '';
-    }
-
-
-    /**
-     * Ajax callback for ee_msgs_create_new_custom ajax request.
-     * Takes incoming GRP_ID and name and description values from ajax request
-     * to create a new custom template based off of the incoming GRP_ID.
-     *
-     * @access public
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function create_new_custom()
-    {
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_edit_messages', 'create_new_custom_ajax')) {
-            wp_die(esc_html__('You don\'t have privileges to do this action', 'event_espresso'));
-        }
-
-        /** @var RequestInterface $request */
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-
-        // let's clean up the request data a bit for downstream usage of name and description.
-        $templateName = $this->request->getRequestParam('custom_template_args[MTP_name]', '');
-        $request->setRequestParam('templateName', $templateName);
-        $templateDescription = $this->request->getRequestParam('custom_template_args[MTP_description]', '');
-        $request->setRequestParam('templateDescription', $templateDescription);
-
-        // set EE_Admin_Page object (see method details in EE_Admin_Hooks parent
-        $this->_set_page_object();
-
-        // is this a template switch if so EE_Admin_Page child needs this object
-        $this->_page_object->set_hook_object($this);
-
-        $this->_page_object->add_message_template(
-            $this->request->getRequestParam('messageType', ''),
-            $this->request->getRequestParam('messenger', ''),
-            $this->request->getRequestParam('group_ID', 0, 'int')
-        );
-    }
-
-
-    public function create_new_admin_footer()
-    {
-        $this->edit_admin_footer();
-    }
-
-
-    /**
-     * This is the dynamic method for this class
-     * that will end up hooking into the 'admin_footer' hook on the 'edit_event' route in the events page.
-     *
-     * @return void
-     * @throws DomainException
-     */
-    public function edit_admin_footer()
-    {
-        EEH_Template::display_template(
-            EE_CORE_CAF_ADMIN_EXTEND . 'messages/templates/create_custom_template_form.template.php'
-        );
-    }
-
-
-    /**
-     * Callback for AHEE__Extend_Events_Admin_Page___duplicate_event__after hook used to ensure new events duplicate
-     * the assigned custom message templates.
-     *
-     * @param EE_Event $new_event
-     * @param EE_Event $original_event
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function duplicate_custom_message_settings(EE_Event $new_event, EE_Event $original_event)
-    {
-        $message_template_groups = $original_event->get_many_related('Message_Template_Group');
-        foreach ($message_template_groups as $message_template_group) {
-            $new_event->_add_relation_to($message_template_group, 'Message_Template_Group');
-        }
-        // save new event
-        $new_event->save();
-    }
+		if (defined('DOING_AJAX')) {
+			return $tabbed_content;
+		}
+
+		do_action('AHEE__espresso_events_Messages_Hooks_Extend__messages_metabox__before_content');
+		echo $notices . '<div class="messages-tabs-content">' . $tabbed_content . '</div>';
+		do_action('AHEE__espresso_events_Messages_Hooks_Extend__messages_metabox__after_content');
+		return '';
+	}
+
+
+	/**
+	 * Ajax callback for ee_msgs_create_new_custom ajax request.
+	 * Takes incoming GRP_ID and name and description values from ajax request
+	 * to create a new custom template based off of the incoming GRP_ID.
+	 *
+	 * @access public
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function create_new_custom()
+	{
+		if (! EE_Registry::instance()->CAP->current_user_can('ee_edit_messages', 'create_new_custom_ajax')) {
+			wp_die(esc_html__('You don\'t have privileges to do this action', 'event_espresso'));
+		}
+
+		/** @var RequestInterface $request */
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+
+		// let's clean up the request data a bit for downstream usage of name and description.
+		$templateName = $this->request->getRequestParam('custom_template_args[MTP_name]', '');
+		$request->setRequestParam('templateName', $templateName);
+		$templateDescription = $this->request->getRequestParam('custom_template_args[MTP_description]', '');
+		$request->setRequestParam('templateDescription', $templateDescription);
+
+		// set EE_Admin_Page object (see method details in EE_Admin_Hooks parent
+		$this->_set_page_object();
+
+		// is this a template switch if so EE_Admin_Page child needs this object
+		$this->_page_object->set_hook_object($this);
+
+		$this->_page_object->add_message_template(
+			$this->request->getRequestParam('messageType', ''),
+			$this->request->getRequestParam('messenger', ''),
+			$this->request->getRequestParam('group_ID', 0, 'int')
+		);
+	}
+
+
+	public function create_new_admin_footer()
+	{
+		$this->edit_admin_footer();
+	}
+
+
+	/**
+	 * This is the dynamic method for this class
+	 * that will end up hooking into the 'admin_footer' hook on the 'edit_event' route in the events page.
+	 *
+	 * @return void
+	 * @throws DomainException
+	 */
+	public function edit_admin_footer()
+	{
+		EEH_Template::display_template(
+			EE_CORE_CAF_ADMIN_EXTEND . 'messages/templates/create_custom_template_form.template.php'
+		);
+	}
+
+
+	/**
+	 * Callback for AHEE__Extend_Events_Admin_Page___duplicate_event__after hook used to ensure new events duplicate
+	 * the assigned custom message templates.
+	 *
+	 * @param EE_Event $new_event
+	 * @param EE_Event $original_event
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function duplicate_custom_message_settings(EE_Event $new_event, EE_Event $original_event)
+	{
+		$message_template_groups = $original_event->get_many_related('Message_Template_Group');
+		foreach ($message_template_groups as $message_template_group) {
+			$new_event->_add_relation_to($message_template_group, 'Message_Template_Group');
+		}
+		// save new event
+		$new_event->save();
+	}
 }

core/services/request/sanitizers/RequestSanitizer.php

Indentation +61 added lines, -61 removed lines

@@ -6,67 +6,67 @@
 
 class RequestSanitizer
 {
-    /**
-     * Will sanitize the supplied request parameter based on the specified data type
-     *
-     * @param mixed  $param     the supplied request parameter
-     * @param string $type      the specified data type (default: "string")
-     *                          valid values: "bool", "float", "int", "key", "url", or "string"
-     * @param bool   $is_array  if true, then $param will be treated as an array of $type
-     * @param string $delimiter if $param is a CSV like value (ex: 1,2,3,4,5...) then this is the value separator
-     * @return array|bool|float|int|string
-     * @since 4.10.14.p
-     */
-    public function clean($param, $type = DataType::STRING, $is_array = false, $delimiter = '')
-    {
-        if ($delimiter !== '' && is_string($param)) {
-            $param = explode($delimiter, $param);
-            $is_array = is_array($param);
-            // unset the delimiter else this function will recurse forever when we loop over the array of results
-            $delimiter = '';
-        }
-        // check if we are getting an improperly typed array and correct
-        $is_array = $is_array && is_array($param);
-        if ($is_array) {
-            $values = [];
-            foreach ((array) $param as $key => $value) {
-                $values[ $key ] = $this->clean($value, $type, is_array($value), $delimiter);
-            }
-            return $values;
-        }
-        return $this->sanitizeParam($param, $type);
-    }
+	/**
+	 * Will sanitize the supplied request parameter based on the specified data type
+	 *
+	 * @param mixed  $param     the supplied request parameter
+	 * @param string $type      the specified data type (default: "string")
+	 *                          valid values: "bool", "float", "int", "key", "url", or "string"
+	 * @param bool   $is_array  if true, then $param will be treated as an array of $type
+	 * @param string $delimiter if $param is a CSV like value (ex: 1,2,3,4,5...) then this is the value separator
+	 * @return array|bool|float|int|string
+	 * @since 4.10.14.p
+	 */
+	public function clean($param, $type = DataType::STRING, $is_array = false, $delimiter = '')
+	{
+		if ($delimiter !== '' && is_string($param)) {
+			$param = explode($delimiter, $param);
+			$is_array = is_array($param);
+			// unset the delimiter else this function will recurse forever when we loop over the array of results
+			$delimiter = '';
+		}
+		// check if we are getting an improperly typed array and correct
+		$is_array = $is_array && is_array($param);
+		if ($is_array) {
+			$values = [];
+			foreach ((array) $param as $key => $value) {
+				$values[ $key ] = $this->clean($value, $type, is_array($value), $delimiter);
+			}
+			return $values;
+		}
+		return $this->sanitizeParam($param, $type);
+	}
 
 
-    /**
-     * @param mixed  $param
-     * @param string $type
-     * @return array|float|int|mixed|string|string[]|null
-     * @since   4.10.20.p
-     */
-    public function sanitizeParam($param, $type = DataType::STRING)
-    {
-        switch ($type) {
-            case DataType::BOOL:
-                return filter_var($param, FILTER_VALIDATE_BOOLEAN);
-            case DataType::FLOAT:
-                return (float) $param;
-            case DataType::FQCN:
-                return preg_replace('[^\\\w\d]', '', $param);
-            case DataType::HTML:
-                $allowed_tags = AllowedTags::getAllowedTags();
-                return wp_kses($param, $allowed_tags);
-            case DataType::INT:
-                return (int) $param;
-            case DataType::KEY:
-                return sanitize_key($param);
-            case DataType::TITLE:
-                return sanitize_title($param);
-            case DataType::URL:
-                return esc_url_raw($param);
-            case DataType::STRING:
-            default:
-                return sanitize_text_field($param);
-        }
-    }
+	/**
+	 * @param mixed  $param
+	 * @param string $type
+	 * @return array|float|int|mixed|string|string[]|null
+	 * @since   4.10.20.p
+	 */
+	public function sanitizeParam($param, $type = DataType::STRING)
+	{
+		switch ($type) {
+			case DataType::BOOL:
+				return filter_var($param, FILTER_VALIDATE_BOOLEAN);
+			case DataType::FLOAT:
+				return (float) $param;
+			case DataType::FQCN:
+				return preg_replace('[^\\\w\d]', '', $param);
+			case DataType::HTML:
+				$allowed_tags = AllowedTags::getAllowedTags();
+				return wp_kses($param, $allowed_tags);
+			case DataType::INT:
+				return (int) $param;
+			case DataType::KEY:
+				return sanitize_key($param);
+			case DataType::TITLE:
+				return sanitize_title($param);
+			case DataType::URL:
+				return esc_url_raw($param);
+			case DataType::STRING:
+			default:
+				return sanitize_text_field($param);
+		}
+	}
 }

core/services/request/sanitizers/AllowedTags.php

Indentation +91 added lines, -91 removed lines

@@ -13,102 +13,102 @@
 class AllowedTags
 {
 
-    /**
-     * @var array[]
-     */
-    private static $attributes = [
-        'action'     => [],
-        'align'      => [],
-        'alt'        => [],
-        'class'      => [],
-        'data'       => [],
-        'for'        => [],
-        'height'     => [],
-        'href'       => [],
-        'id'         => [],
-        'method'     => [],
-        'name'       => [],
-        'novalidate' => [],
-        'rel'        => [],
-        'src'        => [],
-        'style'      => [],
-        'tabindex'   => [],
-        'target'     => [],
-        'title'      => [],
-        'type'       => [],
-        'value'      => [],
-        'width'      => [],
-    ];
+	/**
+	 * @var array[]
+	 */
+	private static $attributes = [
+		'action'     => [],
+		'align'      => [],
+		'alt'        => [],
+		'class'      => [],
+		'data'       => [],
+		'for'        => [],
+		'height'     => [],
+		'href'       => [],
+		'id'         => [],
+		'method'     => [],
+		'name'       => [],
+		'novalidate' => [],
+		'rel'        => [],
+		'src'        => [],
+		'style'      => [],
+		'tabindex'   => [],
+		'target'     => [],
+		'title'      => [],
+		'type'       => [],
+		'value'      => [],
+		'width'      => [],
+	];
 
 
-    /**
-     * @var array
-     */
-    private static $tags = [
-        'a',
-        'abbr',
-        'b',
-        'br',
-        'code',
-        'div',
-        'em',
-        'form',
-        'h1',
-        'h2',
-        'h3',
-        'h4',
-        'h5',
-        'h6',
-        'hr',
-        'i',
-        'iframe',
-        'img',
-        'input',
-        'label',
-        'li',
-        'ol',
-        'p',
-        'pre',
-        'script',
-        'small',
-        'span',
-        'strong',
-        'style',
-        'table',
-        'td',
-        'textarea',
-        'tr',
-        'ul',
-    ];
+	/**
+	 * @var array
+	 */
+	private static $tags = [
+		'a',
+		'abbr',
+		'b',
+		'br',
+		'code',
+		'div',
+		'em',
+		'form',
+		'h1',
+		'h2',
+		'h3',
+		'h4',
+		'h5',
+		'h6',
+		'hr',
+		'i',
+		'iframe',
+		'img',
+		'input',
+		'label',
+		'li',
+		'ol',
+		'p',
+		'pre',
+		'script',
+		'small',
+		'span',
+		'strong',
+		'style',
+		'table',
+		'td',
+		'textarea',
+		'tr',
+		'ul',
+	];
 
-    /**
-     * @var array
-     */
-    private static $allowed_tags;
+	/**
+	 * @var array
+	 */
+	private static $allowed_tags;
 
 
-    /**
-     * merges additional tags and attributes into the WP global $allowedposttags
-     */
-    private static function initializeAllowedTags()
-    {
-        global $allowedposttags;
-        $allowed_tags = [];
-        foreach (AllowedTags::$tags as $tag) {
-            $allowed_tags[ $tag ] = AllowedTags::$attributes;
-        }
-        AllowedTags::$allowed_tags = array_merge_recursive($allowedposttags, $allowed_tags);
-    }
+	/**
+	 * merges additional tags and attributes into the WP global $allowedposttags
+	 */
+	private static function initializeAllowedTags()
+	{
+		global $allowedposttags;
+		$allowed_tags = [];
+		foreach (AllowedTags::$tags as $tag) {
+			$allowed_tags[ $tag ] = AllowedTags::$attributes;
+		}
+		AllowedTags::$allowed_tags = array_merge_recursive($allowedposttags, $allowed_tags);
+	}
 
 
-    /**
-     * @return array[]
-     */
-    public static function getAllowedTags()
-    {
-        if (empty(AllowedTags::$allowed_tags)) {
-            AllowedTags::initializeAllowedTags();
-        }
-        return AllowedTags::$allowed_tags;
-    }
+	/**
+	 * @return array[]
+	 */
+	public static function getAllowedTags()
+	{
+		if (empty(AllowedTags::$allowed_tags)) {
+			AllowedTags::initializeAllowedTags();
+		}
+		return AllowedTags::$allowed_tags;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -95,7 +95,7 @@
         global $allowedposttags;
         $allowed_tags = [];
         foreach (AllowedTags::$tags as $tag) {
-            $allowed_tags[ $tag ] = AllowedTags::$attributes;
+            $allowed_tags[$tag] = AllowedTags::$attributes;
         }
         AllowedTags::$allowed_tags = array_merge_recursive($allowedposttags, $allowed_tags);
     }

core/services/request/RequestInterface.php

Indentation +189 added lines, -189 removed lines

@@ -16,195 +16,195 @@
 interface RequestInterface extends RequestTypeContextCheckerInterface
 {
 
-    /**
-     * @param RequestTypeContextCheckerInterface $type
-     */
-    public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type);
+	/**
+	 * @param RequestTypeContextCheckerInterface $type
+	 */
+	public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type);
 
 
-    /**
-     * @return array
-     */
-    public function getParams();
-
-
-    /**
-     * @return array
-     */
-    public function postParams();
-
-
-    /**
-     * @return array
-     */
-    public function cookieParams();
-
-
-    /**
-     * @return array
-     */
-    public function serverParams();
-
-
-    /**
-     * @param string $key
-     * @param mixed|null $default
-     * @return array|int|float|string
-     */
-    public function getServerParam($key, $default = null);
-
-
-    /**
-     * @param string                 $key
-     * @param array|int|float|string $value
-     * @return void
-     */
-    public function setServerParam($key, $value);
-
-
-    /**
-     * @param string $key
-     * @return bool
-     */
-    public function serverParamIsSet($key);
-
-
-    /**
-     * @return array
-     */
-    public function filesParams();
-
-
-    /**
-     * returns sanitized contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function requestParams();
-
-
-    /**
-     * @param string $key
-     * @param string $value
-     * @param bool   $override_ee
-     * @return void
-     */
-    public function setRequestParam($key, $value, $override_ee = false);
-
-
-    /**
-     * returns   the value for a request param if the given key exists
-     *
-     * @param string     $key
-     * @param mixed|null $default
-     * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
-     * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
-     * @param string     $delimiter for CSV type strings that should be returned as an array
-     * @return array|bool|float|int|string
-     */
-    public function getRequestParam($key, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '');
-
-
-    /**
-     * check if param exists
-     *
-     * @param string $key
-     * @return bool
-     */
-    public function requestParamIsSet($key);
-
-
-    /**
-     * check if a request parameter exists whose key that matches the supplied wildcard pattern
-     * and return the value for the first match found
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     *
-     * @param string     $pattern
-     * @param mixed|null $default
-     * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
-     * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
-     * @param string     $delimiter for CSV type strings that should be returned as an array
-     * @return array|bool|float|int|string
-     */
-    public function getMatch($pattern, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '');
-
-
-    /**
-     * check if a request parameter exists whose key matches the supplied wildcard pattern
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     * returns true if a match is found or false if not
-     *
-     * @param string $pattern
-     * @return false|int
-     */
-    public function matches($pattern);
-
-
-    /**
-     * remove param
-     *
-     * @param string $key
-     * @param bool   $unset_from_global_too
-     */
-    public function unSetRequestParam($key, $unset_from_global_too = false);
-
-
-    /**
-     * remove params
-     *
-     * @param array $keys
-     * @param bool  $unset_from_global_too
-     */
-    public function unSetRequestParams(array $keys, $unset_from_global_too = false);
-
-
-    /**
-     * @return string
-     */
-    public function ipAddress();
-
-
-    /**
-     * @param boolean $relativeToWpRoot whether to return the uri relative to WordPress' home URL, or not.
-     * @return string
-     */
-    public function requestUri($relativeToWpRoot = false);
-
-
-    /**
-     * @return string
-     */
-    public function userAgent();
-
-
-    /**
-     * @param string $user_agent
-     */
-    public function setUserAgent($user_agent = '');
-
-
-    /**
-     * @return bool
-     */
-    public function isBot();
-
-
-    /**
-     * @param bool $is_bot
-     */
-    public function setIsBot($is_bot);
-
-
-    /**
-     * merges the incoming array of parameters into the existing request parameters
-     *
-     * @param array $request_params
-     * @return mixed
-     * @since   4.10.24.p
-     */
-    public function mergeRequestParams(array $request_params);
+	/**
+	 * @return array
+	 */
+	public function getParams();
+
+
+	/**
+	 * @return array
+	 */
+	public function postParams();
+
+
+	/**
+	 * @return array
+	 */
+	public function cookieParams();
+
+
+	/**
+	 * @return array
+	 */
+	public function serverParams();
+
+
+	/**
+	 * @param string $key
+	 * @param mixed|null $default
+	 * @return array|int|float|string
+	 */
+	public function getServerParam($key, $default = null);
+
+
+	/**
+	 * @param string                 $key
+	 * @param array|int|float|string $value
+	 * @return void
+	 */
+	public function setServerParam($key, $value);
+
+
+	/**
+	 * @param string $key
+	 * @return bool
+	 */
+	public function serverParamIsSet($key);
+
+
+	/**
+	 * @return array
+	 */
+	public function filesParams();
+
+
+	/**
+	 * returns sanitized contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function requestParams();
+
+
+	/**
+	 * @param string $key
+	 * @param string $value
+	 * @param bool   $override_ee
+	 * @return void
+	 */
+	public function setRequestParam($key, $value, $override_ee = false);
+
+
+	/**
+	 * returns   the value for a request param if the given key exists
+	 *
+	 * @param string     $key
+	 * @param mixed|null $default
+	 * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
+	 * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
+	 * @param string     $delimiter for CSV type strings that should be returned as an array
+	 * @return array|bool|float|int|string
+	 */
+	public function getRequestParam($key, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '');
+
+
+	/**
+	 * check if param exists
+	 *
+	 * @param string $key
+	 * @return bool
+	 */
+	public function requestParamIsSet($key);
+
+
+	/**
+	 * check if a request parameter exists whose key that matches the supplied wildcard pattern
+	 * and return the value for the first match found
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 *
+	 * @param string     $pattern
+	 * @param mixed|null $default
+	 * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
+	 * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
+	 * @param string     $delimiter for CSV type strings that should be returned as an array
+	 * @return array|bool|float|int|string
+	 */
+	public function getMatch($pattern, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '');
+
+
+	/**
+	 * check if a request parameter exists whose key matches the supplied wildcard pattern
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 * returns true if a match is found or false if not
+	 *
+	 * @param string $pattern
+	 * @return false|int
+	 */
+	public function matches($pattern);
+
+
+	/**
+	 * remove param
+	 *
+	 * @param string $key
+	 * @param bool   $unset_from_global_too
+	 */
+	public function unSetRequestParam($key, $unset_from_global_too = false);
+
+
+	/**
+	 * remove params
+	 *
+	 * @param array $keys
+	 * @param bool  $unset_from_global_too
+	 */
+	public function unSetRequestParams(array $keys, $unset_from_global_too = false);
+
+
+	/**
+	 * @return string
+	 */
+	public function ipAddress();
+
+
+	/**
+	 * @param boolean $relativeToWpRoot whether to return the uri relative to WordPress' home URL, or not.
+	 * @return string
+	 */
+	public function requestUri($relativeToWpRoot = false);
+
+
+	/**
+	 * @return string
+	 */
+	public function userAgent();
+
+
+	/**
+	 * @param string $user_agent
+	 */
+	public function setUserAgent($user_agent = '');
+
+
+	/**
+	 * @return bool
+	 */
+	public function isBot();
+
+
+	/**
+	 * @param bool $is_bot
+	 */
+	public function setIsBot($is_bot);
+
+
+	/**
+	 * merges the incoming array of parameters into the existing request parameters
+	 *
+	 * @param array $request_params
+	 * @return mixed
+	 * @since   4.10.24.p
+	 */
+	public function mergeRequestParams(array $request_params);
 }

core/services/request/Request.php

Indentation +491 added lines, -491 removed lines

@@ -17,495 +17,495 @@
 class Request implements InterminableInterface, RequestInterface, ReservedInstanceInterface
 {
 
-    /**
-     * $_COOKIE parameters
-     *
-     * @var array
-     */
-    protected $cookies;
-
-    /**
-     * $_FILES parameters
-     *
-     * @var array
-     */
-    protected $files;
-
-    /**
-     * true if current user appears to be some kind of bot
-     *
-     * @var bool
-     */
-    protected $is_bot;
-
-    /**
-     * @var RequestParams
-     */
-    protected $request_params;
-
-    /**
-     * @var RequestTypeContextCheckerInterface
-     */
-    protected $request_type;
-
-    /**
-     * @var ServerParams
-     */
-    protected $server_params;
-
-
-    public function __construct(
-        RequestParams $request_params,
-        ServerParams $server_params,
-        array $cookies = [],
-        array $files = []
-    ) {
-        $this->cookies = ! empty($cookies)
-            ? $cookies
-            : filter_input_array(INPUT_COOKIE, FILTER_SANITIZE_STRING);
-        $this->files          = ! empty($files) ? $files : $_FILES;
-        $this->request_params = $request_params;
-        $this->server_params  = $server_params;
-    }
-
-
-    /**
-     * @param RequestTypeContextCheckerInterface $type
-     */
-    public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type)
-    {
-        $this->request_type = $type;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getParams()
-    {
-        return $this->request_params->getParams();
-    }
-
-
-    /**
-     * @return array
-     */
-    public function postParams()
-    {
-        return $this->request_params->postParams();
-    }
-
-
-    /**
-     * @return array
-     */
-    public function cookieParams()
-    {
-        return $this->cookies;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function serverParams()
-    {
-        return $this->server_params->getAllServerParams();
-    }
-
-
-    /**
-     * @param string $key
-     * @param mixed|null $default
-     * @return array|int|float|string
-     */
-    public function getServerParam($key, $default = null)
-    {
-        return $this->server_params->getServerParam($key, $default);
-    }
-
-
-    /**
-     * @param string                 $key
-     * @param array|int|float|string $value
-     * @return void
-     */
-    public function setServerParam($key, $value)
-    {
-        $this->server_params->setServerParam($key, $value);
-    }
-
-
-    /**
-     * @param string $key
-     * @return bool
-     */
-    public function serverParamIsSet($key)
-    {
-        return $this->server_params->serverParamIsSet($key);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function filesParams()
-    {
-        return $this->files;
-    }
-
-
-    /**
-     * returns sanitized contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function requestParams()
-    {
-        return $this->request_params->requestParams();
-    }
-
-
-    /**
-     * @param string     $key
-     * @param mixed|null $value
-     * @param bool       $override_ee
-     * @return void
-     */
-    public function setRequestParam($key, $value, $override_ee = false)
-    {
-        $this->request_params->setRequestParam($key, $value, $override_ee);
-    }
-
-
-    /**
-     * merges the incoming array of parameters into the existing request parameters
-     *
-     * @param array $request_params
-     * @return void
-     * @since   4.10.24.p
-     */
-    public function mergeRequestParams(array $request_params)
-    {
-        $this->request_params->mergeRequestParams($request_params);
-    }
-
-
-    /**
-     * returns sanitized value for a request param if the given key exists
-     *
-     * @param string     $key
-     * @param mixed|null $default
-     * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
-     * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
-     * @param string     $delimiter for CSV type strings that should be returned as an array
-     * @return array|bool|float|int|string
-     */
-    public function getRequestParam($key, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '')
-    {
-        return $this->request_params->getRequestParam($key, $default, $type, $is_array, $delimiter);
-    }
-
-
-    /**
-     * check if param exists
-     *
-     * @param string $key
-     * @return bool
-     */
-    public function requestParamIsSet($key)
-    {
-        return $this->request_params->requestParamIsSet($key);
-    }
-
-
-    /**
-     * check if a request parameter exists whose key that matches the supplied wildcard pattern
-     * and return the sanitized value for the first match found
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     *
-     * @param string     $pattern
-     * @param mixed|null $default
-     * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
-     * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
-     * @param string     $delimiter for CSV type strings that should be returned as an array
-     * @return array|bool|float|int|string
-     */
-    public function getMatch($pattern, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '')
-    {
-        return $this->request_params->getMatch($pattern, $default, $type, $is_array, $delimiter);
-    }
-
-
-    /**
-     * check if a request parameter exists whose key matches the supplied wildcard pattern
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     * returns true if a match is found or false if not
-     *
-     * @param string $pattern
-     * @return bool
-     */
-    public function matches($pattern)
-    {
-        return $this->request_params->matches($pattern);
-    }
-
-
-    /**
-     * remove param
-     *
-     * @param      $key
-     * @param bool $unset_from_global_too
-     */
-    public function unSetRequestParam($key, $unset_from_global_too = false)
-    {
-        $this->request_params->unSetRequestParam($key, $unset_from_global_too);
-    }
-
-
-    /**
-     * remove params
-     *
-     * @param array $keys
-     * @param bool  $unset_from_global_too
-     */
-    public function unSetRequestParams(array $keys, $unset_from_global_too = false)
-    {
-        $this->request_params->unSetRequestParams($keys, $unset_from_global_too);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function ipAddress()
-    {
-        return $this->server_params->ipAddress();
-    }
-
-
-    /**
-     * Gets the request's literal URI. Related to `requestUriAfterSiteHomeUri`, see its description for a comparison.
-     *
-     * @param boolean $relativeToWpRoot If home_url() is "http://mysite.com/wp/", and a request comes to
-     *                                  "http://mysite.com/wp/wp-json", setting $relativeToWpRoot=true will return
-     *                                  "/wp-json", whereas $relativeToWpRoot=false will return "/wp/wp-json/".
-     * @return string
-     */
-    public function requestUri($relativeToWpRoot = false)
-    {
-        return $this->server_params->requestUri();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function userAgent()
-    {
-        return $this->server_params->userAgent();
-    }
-
-
-    /**
-     * @param string $user_agent
-     */
-    public function setUserAgent($user_agent = '')
-    {
-        $this->server_params->setUserAgent($user_agent);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isBot()
-    {
-        return $this->is_bot;
-    }
-
-
-    /**
-     * @param bool $is_bot
-     */
-    public function setIsBot($is_bot)
-    {
-        $this->is_bot = filter_var($is_bot, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isActivation()
-    {
-        return $this->request_type->isActivation();
-    }
-
-
-    /**
-     * @param $is_activation
-     * @return bool
-     */
-    public function setIsActivation($is_activation)
-    {
-        return $this->request_type->setIsActivation($is_activation);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAdmin()
-    {
-        return $this->request_type->isAdmin();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAdminAjax()
-    {
-        return $this->request_type->isAdminAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAjax()
-    {
-        return $this->request_type->isAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isEeAjax()
-    {
-        return $this->request_type->isEeAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isOtherAjax()
-    {
-        return $this->request_type->isOtherAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isApi()
-    {
-        return $this->request_type->isApi();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isCli()
-    {
-        return $this->request_type->isCli();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isCron()
-    {
-        return $this->request_type->isCron();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isFeed()
-    {
-        return $this->request_type->isFeed();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isFrontend()
-    {
-        return $this->request_type->isFrontend();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isFrontAjax()
-    {
-        return $this->request_type->isFrontAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isIframe()
-    {
-        return $this->request_type->isIframe();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isWordPressApi()
-    {
-        return $this->request_type->isWordPressApi();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isWordPressHeartbeat()
-    {
-        return $this->request_type->isWordPressHeartbeat();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isWordPressScrape()
-    {
-        return $this->request_type->isWordPressScrape();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->request_type->slug();
-    }
-
-
-    /**
-     * @return RequestTypeContextCheckerInterface
-     */
-    public function getRequestType()
-    {
-        return $this->request_type;
-    }
+	/**
+	 * $_COOKIE parameters
+	 *
+	 * @var array
+	 */
+	protected $cookies;
+
+	/**
+	 * $_FILES parameters
+	 *
+	 * @var array
+	 */
+	protected $files;
+
+	/**
+	 * true if current user appears to be some kind of bot
+	 *
+	 * @var bool
+	 */
+	protected $is_bot;
+
+	/**
+	 * @var RequestParams
+	 */
+	protected $request_params;
+
+	/**
+	 * @var RequestTypeContextCheckerInterface
+	 */
+	protected $request_type;
+
+	/**
+	 * @var ServerParams
+	 */
+	protected $server_params;
+
+
+	public function __construct(
+		RequestParams $request_params,
+		ServerParams $server_params,
+		array $cookies = [],
+		array $files = []
+	) {
+		$this->cookies = ! empty($cookies)
+			? $cookies
+			: filter_input_array(INPUT_COOKIE, FILTER_SANITIZE_STRING);
+		$this->files          = ! empty($files) ? $files : $_FILES;
+		$this->request_params = $request_params;
+		$this->server_params  = $server_params;
+	}
+
+
+	/**
+	 * @param RequestTypeContextCheckerInterface $type
+	 */
+	public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type)
+	{
+		$this->request_type = $type;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getParams()
+	{
+		return $this->request_params->getParams();
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function postParams()
+	{
+		return $this->request_params->postParams();
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function cookieParams()
+	{
+		return $this->cookies;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function serverParams()
+	{
+		return $this->server_params->getAllServerParams();
+	}
+
+
+	/**
+	 * @param string $key
+	 * @param mixed|null $default
+	 * @return array|int|float|string
+	 */
+	public function getServerParam($key, $default = null)
+	{
+		return $this->server_params->getServerParam($key, $default);
+	}
+
+
+	/**
+	 * @param string                 $key
+	 * @param array|int|float|string $value
+	 * @return void
+	 */
+	public function setServerParam($key, $value)
+	{
+		$this->server_params->setServerParam($key, $value);
+	}
+
+
+	/**
+	 * @param string $key
+	 * @return bool
+	 */
+	public function serverParamIsSet($key)
+	{
+		return $this->server_params->serverParamIsSet($key);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function filesParams()
+	{
+		return $this->files;
+	}
+
+
+	/**
+	 * returns sanitized contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function requestParams()
+	{
+		return $this->request_params->requestParams();
+	}
+
+
+	/**
+	 * @param string     $key
+	 * @param mixed|null $value
+	 * @param bool       $override_ee
+	 * @return void
+	 */
+	public function setRequestParam($key, $value, $override_ee = false)
+	{
+		$this->request_params->setRequestParam($key, $value, $override_ee);
+	}
+
+
+	/**
+	 * merges the incoming array of parameters into the existing request parameters
+	 *
+	 * @param array $request_params
+	 * @return void
+	 * @since   4.10.24.p
+	 */
+	public function mergeRequestParams(array $request_params)
+	{
+		$this->request_params->mergeRequestParams($request_params);
+	}
+
+
+	/**
+	 * returns sanitized value for a request param if the given key exists
+	 *
+	 * @param string     $key
+	 * @param mixed|null $default
+	 * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
+	 * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
+	 * @param string     $delimiter for CSV type strings that should be returned as an array
+	 * @return array|bool|float|int|string
+	 */
+	public function getRequestParam($key, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '')
+	{
+		return $this->request_params->getRequestParam($key, $default, $type, $is_array, $delimiter);
+	}
+
+
+	/**
+	 * check if param exists
+	 *
+	 * @param string $key
+	 * @return bool
+	 */
+	public function requestParamIsSet($key)
+	{
+		return $this->request_params->requestParamIsSet($key);
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key that matches the supplied wildcard pattern
+	 * and return the sanitized value for the first match found
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 *
+	 * @param string     $pattern
+	 * @param mixed|null $default
+	 * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
+	 * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
+	 * @param string     $delimiter for CSV type strings that should be returned as an array
+	 * @return array|bool|float|int|string
+	 */
+	public function getMatch($pattern, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '')
+	{
+		return $this->request_params->getMatch($pattern, $default, $type, $is_array, $delimiter);
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key matches the supplied wildcard pattern
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 * returns true if a match is found or false if not
+	 *
+	 * @param string $pattern
+	 * @return bool
+	 */
+	public function matches($pattern)
+	{
+		return $this->request_params->matches($pattern);
+	}
+
+
+	/**
+	 * remove param
+	 *
+	 * @param      $key
+	 * @param bool $unset_from_global_too
+	 */
+	public function unSetRequestParam($key, $unset_from_global_too = false)
+	{
+		$this->request_params->unSetRequestParam($key, $unset_from_global_too);
+	}
+
+
+	/**
+	 * remove params
+	 *
+	 * @param array $keys
+	 * @param bool  $unset_from_global_too
+	 */
+	public function unSetRequestParams(array $keys, $unset_from_global_too = false)
+	{
+		$this->request_params->unSetRequestParams($keys, $unset_from_global_too);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function ipAddress()
+	{
+		return $this->server_params->ipAddress();
+	}
+
+
+	/**
+	 * Gets the request's literal URI. Related to `requestUriAfterSiteHomeUri`, see its description for a comparison.
+	 *
+	 * @param boolean $relativeToWpRoot If home_url() is "http://mysite.com/wp/", and a request comes to
+	 *                                  "http://mysite.com/wp/wp-json", setting $relativeToWpRoot=true will return
+	 *                                  "/wp-json", whereas $relativeToWpRoot=false will return "/wp/wp-json/".
+	 * @return string
+	 */
+	public function requestUri($relativeToWpRoot = false)
+	{
+		return $this->server_params->requestUri();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function userAgent()
+	{
+		return $this->server_params->userAgent();
+	}
+
+
+	/**
+	 * @param string $user_agent
+	 */
+	public function setUserAgent($user_agent = '')
+	{
+		$this->server_params->setUserAgent($user_agent);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isBot()
+	{
+		return $this->is_bot;
+	}
+
+
+	/**
+	 * @param bool $is_bot
+	 */
+	public function setIsBot($is_bot)
+	{
+		$this->is_bot = filter_var($is_bot, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isActivation()
+	{
+		return $this->request_type->isActivation();
+	}
+
+
+	/**
+	 * @param $is_activation
+	 * @return bool
+	 */
+	public function setIsActivation($is_activation)
+	{
+		return $this->request_type->setIsActivation($is_activation);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAdmin()
+	{
+		return $this->request_type->isAdmin();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAdminAjax()
+	{
+		return $this->request_type->isAdminAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAjax()
+	{
+		return $this->request_type->isAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isEeAjax()
+	{
+		return $this->request_type->isEeAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isOtherAjax()
+	{
+		return $this->request_type->isOtherAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isApi()
+	{
+		return $this->request_type->isApi();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isCli()
+	{
+		return $this->request_type->isCli();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isCron()
+	{
+		return $this->request_type->isCron();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isFeed()
+	{
+		return $this->request_type->isFeed();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isFrontend()
+	{
+		return $this->request_type->isFrontend();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isFrontAjax()
+	{
+		return $this->request_type->isFrontAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isIframe()
+	{
+		return $this->request_type->isIframe();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isWordPressApi()
+	{
+		return $this->request_type->isWordPressApi();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isWordPressHeartbeat()
+	{
+		return $this->request_type->isWordPressHeartbeat();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isWordPressScrape()
+	{
+		return $this->request_type->isWordPressScrape();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->request_type->slug();
+	}
+
+
+	/**
+	 * @return RequestTypeContextCheckerInterface
+	 */
+	public function getRequestType()
+	{
+		return $this->request_type;
+	}
 }

core/services/request/DataType.php

Indentation +41 added lines, -41 removed lines

@@ -12,58 +12,58 @@
  */
 class DataType
 {
-    // can't use ARRAY as name until we switch to PHP 7+
-    // const ARRAY   = 'array';
+	// can't use ARRAY as name until we switch to PHP 7+
+	// const ARRAY   = 'array';
 
-    const BOOL    = 'bool';
-    const BOOLEAN = 'bool';
+	const BOOL    = 'bool';
+	const BOOLEAN = 'bool';
 
-    const DOUBLE  = 'float';
-    const FLOAT   = 'float';
+	const DOUBLE  = 'float';
+	const FLOAT   = 'float';
 
-    const FQCN    = 'fqcn';
+	const FQCN    = 'fqcn';
 
-    const HTML    = 'html';
+	const HTML    = 'html';
 
-    const INT     = 'int';
-    const INTEGER = 'int';
+	const INT     = 'int';
+	const INTEGER = 'int';
 
-    const KEY     = 'key';
+	const KEY     = 'key';
 
-    const OBJECT  = 'object';
+	const OBJECT  = 'object';
 
-    const NULL    = 'null';
+	const NULL    = 'null';
 
-    const TITLE   = 'title';
+	const TITLE   = 'title';
 
-    const URL     = 'url';
+	const URL     = 'url';
 
-    const STRING  = 'string';
+	const STRING  = 'string';
 
 
-    /**
-     * @param mixed  $param
-     * @param string $type
-     * @return mixed
-     */
-    public static function setDataType($param, $type)
-    {
-        switch ($type) {
-            case DataType::NULL:
-                return null;
-            case DataType::OBJECT:
-                return $param;
-            case DataType::FQCN:
-            case DataType::HTML:
-            case DataType::KEY:
-            case DataType::STRING:
-            case DataType::TITLE:
-            case DataType::URL:
-                settype($param, DataType::STRING);
-                break;
-            default:
-                settype($param, $type);
-        }
-        return $param;
-    }
+	/**
+	 * @param mixed  $param
+	 * @param string $type
+	 * @return mixed
+	 */
+	public static function setDataType($param, $type)
+	{
+		switch ($type) {
+			case DataType::NULL:
+				return null;
+			case DataType::OBJECT:
+				return $param;
+			case DataType::FQCN:
+			case DataType::HTML:
+			case DataType::KEY:
+			case DataType::STRING:
+			case DataType::TITLE:
+			case DataType::URL:
+				settype($param, DataType::STRING);
+				break;
+			default:
+				settype($param, $type);
+		}
+		return $param;
+	}
 }

core/services/request/RequestParams.php

Spacing +16 added lines, -16 removed lines

@@ -17,13 +17,13 @@ 
      * Used for matches() and parameterDrillDown()
      * 'bool' will return true or false if match is found or not
      */
-    const RETURN_BOOL  = 'bool';
+    const RETURN_BOOL = 'bool';
 
     /**
      * Used for matches() and parameterDrillDown()
      * 'key' will return the first key found that matches the supplied pattern
      */
-    const RETURN_KEY   = 'key';
+    const RETURN_KEY = 'key';
 
     /**
      * Used for matches() and parameterDrillDown()
@@ -113,7 +113,7 @@ 
     {
         // don't allow "ee" to be overwritten unless explicitly instructed to do so
         if ($override_ee || $key !== 'ee' || empty($this->request['ee'])) {
-            $this->request[ $key ] = $value;
+            $this->request[$key] = $value;
         }
     }
 
@@ -237,7 +237,7 @@ 
             preg_quote($pattern, '/')
         );
         foreach ($request_params as $key => $request_param) {
-            if (preg_match('/^' . $pattern . '$/is', $key)) {
+            if (preg_match('/^'.$pattern.'$/is', $key)) {
                 // return value for request param
                 if ($return === self::RETURN_VALUE) {
                     return $request_param;
@@ -299,30 +299,30 @@ 
                 $key      = $real_key ?: $key;
             }
             // check if top level key exists
-            if (isset($request_params[ $key ])) {
+            if (isset($request_params[$key])) {
                 // build a new key to pass along like: 'second[third]'
                 // or just 'second' depending on depth of keys
                 $key_string = array_shift($keys);
-                if (! empty($keys)) {
-                    $key_string .= '[' . implode('][', $keys) . ']';
+                if ( ! empty($keys)) {
+                    $key_string .= '['.implode('][', $keys).']';
                 }
                 return $this->parameterDrillDown(
                     $key_string,
                     $default,
                     $callback,
                     $return,
-                    $request_params[ $key ]
+                    $request_params[$key]
                 );
             }
         }
         if ($callback === 'is_set') {
-            return isset($request_params[ $key ]);
+            return isset($request_params[$key]);
         }
         if ($callback === 'match') {
             return $this->match($key, $request_params, $default, $return);
         }
-        return isset($request_params[ $key ])
-            ? $request_params[ $key ]
+        return isset($request_params[$key])
+            ? $request_params[$key]
             : $default;
     }
 
@@ -336,12 +336,12 @@ 
     public function unSetRequestParam($key, $unset_from_global_too = false)
     {
         // because unset may not actually remove var
-        $this->get[ $key ]     = null;
-        $this->post[ $key ]    = null;
-        $this->request[ $key ] = null;
-        unset($this->get[ $key ], $this->post[ $key ], $this->request[ $key ]);
+        $this->get[$key]     = null;
+        $this->post[$key]    = null;
+        $this->request[$key] = null;
+        unset($this->get[$key], $this->post[$key], $this->request[$key]);
         if ($unset_from_global_too) {
-            unset($_GET[ $key ], $_POST[ $key ], $_REQUEST[ $key ]);
+            unset($_GET[$key], $_POST[$key], $_REQUEST[$key]);
         }
     }
 

Indentation +345 added lines, -345 removed lines

@@ -13,349 +13,349 @@
  */
 class RequestParams
 {
-    /**
-     * Used for matches() and parameterDrillDown()
-     * 'bool' will return true or false if match is found or not
-     */
-    const RETURN_BOOL  = 'bool';
-
-    /**
-     * Used for matches() and parameterDrillDown()
-     * 'key' will return the first key found that matches the supplied pattern
-     */
-    const RETURN_KEY   = 'key';
-
-    /**
-     * Used for matches() and parameterDrillDown()
-     * 'value' will return the value for the first request parameter
-     */
-    const RETURN_VALUE = 'value';
-
-    /**
-     * $_GET parameters
-     *
-     * @var array
-     */
-    protected $get;
-
-    /**
-     * $_POST parameters
-     *
-     * @var array
-     */
-    protected $post;
-
-    /**
-     * $_REQUEST parameters
-     *
-     * @var array
-     */
-    protected $request;
-
-    /**
-     * @var RequestSanitizer
-     */
-    protected $sanitizer;
-
-
-    /**
-     * RequestParams constructor.
-     *
-     * @param RequestSanitizer $sanitizer
-     * @param array            $get
-     * @param array            $post
-     */
-    public function __construct(RequestSanitizer $sanitizer, array $get = [], array $post = [])
-    {
-        $this->sanitizer = $sanitizer;
-        $this->get       = ! empty($get) ? $get : $_GET;
-        $this->post      = ! empty($post) ? $post : $_POST;
-        $this->request   = array_merge($this->get, $this->post);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getParams()
-    {
-        return $this->get;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function postParams()
-    {
-        return $this->post;
-    }
-
-
-    /**
-     * returns contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function requestParams()
-    {
-        return $this->request;
-    }
-
-
-    /**
-     * @param string     $key
-     * @param mixed|null $value
-     * @param bool       $override_ee
-     * @return    void
-     */
-    public function setRequestParam($key, $value, $override_ee = false)
-    {
-        // don't allow "ee" to be overwritten unless explicitly instructed to do so
-        if ($override_ee || $key !== 'ee' || empty($this->request['ee'])) {
-            $this->request[ $key ] = $value;
-        }
-    }
-
-
-    /**
-     * merges the incoming array of parameters into the existing request parameters
-     *
-     * @param array $request_params
-     * @return void
-     * @since   4.10.24.p
-     */
-    public function mergeRequestParams(array $request_params)
-    {
-        $this->request = array_merge($this->request, $request_params);
-    }
-
-
-    /**
-     * returns   the value for a request param if the given key exists
-     *
-     * @param string     $key
-     * @param mixed|null $default
-     * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
-     * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
-     * @param string     $delimiter for CSV type strings that should be returned as an array
-     * @return array|bool|float|int|string
-     */
-    public function getRequestParam($key, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '')
-    {
-        $param = $this->sanitizer->clean(
-            $this->parameterDrillDown($key, $default, 'get'),
-            $type,
-            $is_array,
-            $delimiter
-        );
-        $type = $is_array ? 'array' : $type;
-        return DataType::setDataType($param, $type);
-    }
-
-
-    /**
-     * check if param exists
-     *
-     * @param string $key
-     * @return bool
-     */
-    public function requestParamIsSet($key)
-    {
-        return (bool) $this->parameterDrillDown($key);
-    }
-
-
-    /**
-     * check if a request parameter exists whose key that matches the supplied wildcard pattern
-     * and return the value for the first match found
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     *
-     * @param string     $pattern
-     * @param mixed|null $default
-     * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
-     * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
-     * @param string     $delimiter for CSV type strings that should be returned as an array
-     * @return array|bool|float|int|string
-     */
-    public function getMatch($pattern, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '')
-    {
-        $param = $this->sanitizer->clean(
-            $this->parameterDrillDown($pattern, $default, 'match'),
-            $type,
-            $is_array,
-            $delimiter
-        );
-        $type = $is_array ? 'array' : $type;
-        return DataType::setDataType($param, $type);
-    }
-
-
-    /**
-     * check if a request parameter exists whose key matches the supplied wildcard pattern
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     * returns true if a match is found or false if not
-     *
-     * @param string $pattern
-     * @return bool
-     */
-    public function matches($pattern)
-    {
-        return (bool) $this->parameterDrillDown($pattern, false, 'match', self::RETURN_BOOL);
-    }
-
-
-    /**
-     * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
-     * @param string $pattern               A string including wildcards to be converted to a regex pattern
-     *                                      and used to search through the current request's parameter keys
-     * @param array  $request_params        The array of request parameters to search through
-     * @param mixed  $default               [optional] The value to be returned if no match is found.
-     *                                      Default is null
-     * @param string $return                [optional] Controls what kind of value is returned.
-     *                                      Options are the RETURN_* constants:
-     *                                      RETURN_BOOL will return true or false if match is found or not
-     *                                      RETURN_KEY will return the first key found that matches the supplied pattern
-     *                                      RETURN_VALUE will return the value for the first request parameter
-     *                                      whose key matches the supplied pattern
-     *                                      Default is 'value'
-     * @return boolean|string
-     */
-    private function match($pattern, array $request_params, $default = null, $return = self::RETURN_VALUE)
-    {
-        $return = in_array($return, [self::RETURN_BOOL, self::RETURN_KEY, self::RETURN_VALUE], true)
-            ? $return
-            : 'is_set';
-        // replace wildcard chars with regex chars
-        $pattern = str_replace(
-            ['\*', '\?'],
-            ['.*', '.'],
-            preg_quote($pattern, '/')
-        );
-        foreach ($request_params as $key => $request_param) {
-            if (preg_match('/^' . $pattern . '$/is', $key)) {
-                // return value for request param
-                if ($return === self::RETURN_VALUE) {
-                    return $request_param;
-                }
-                // or actual key or true just to indicate it was found
-                return $return === self::RETURN_KEY ? $key : true;
-            }
-        }
-        // match not found so return default value or false
-        return $return === self::RETURN_VALUE ? $default : false;
-    }
-
-
-    /**
-     * the supplied key can be a simple string to represent a "top-level" request parameter
-     * or represent a key for a request parameter that is nested deeper within the request parameter array,
-     * by using square brackets to surround keys for deeper array elements.
-     * For example :
-     * if the supplied $key was: "first[second][third]"
-     * then this will attempt to drill down into the request parameter array to find a value.
-     * Given the following request parameters:
-     *  array(
-     *      'first' => array(
-     *          'second' => array(
-     *              'third' => 'has a value'
-     *          )
-     *      )
-     *  )
-     * would return true if default parameters were set
-     *
-     * @param string $callback
-     * @param        $key
-     * @param null   $default
-     * @param string $return
-     * @param mixed  $request_params
-     * @return bool|mixed|null
-     */
-    private function parameterDrillDown(
-        $key,
-        $default = null,
-        $callback = 'is_set',
-        $return = self::RETURN_VALUE,
-        $request_params = []
-    ) {
-        $callback       = in_array($callback, ['is_set', 'get', 'match'], true)
-            ? $callback
-            : 'is_set';
-        $request_params = ! empty($request_params)
-            ? $request_params
-            : $this->request;
-        // does incoming key represent an array like 'first[second][third]'  ?
-        if (strpos($key, '[') !== false) {
-            // turn it into an actual array
-            $key  = str_replace(']', '', $key);
-            $keys = explode('[', $key);
-            $key  = array_shift($keys);
-            if ($callback === 'match') {
-                $real_key = $this->match($key, $request_params, $default, self::RETURN_KEY);
-                $key      = $real_key ?: $key;
-            }
-            // check if top level key exists
-            if (isset($request_params[ $key ])) {
-                // build a new key to pass along like: 'second[third]'
-                // or just 'second' depending on depth of keys
-                $key_string = array_shift($keys);
-                if (! empty($keys)) {
-                    $key_string .= '[' . implode('][', $keys) . ']';
-                }
-                return $this->parameterDrillDown(
-                    $key_string,
-                    $default,
-                    $callback,
-                    $return,
-                    $request_params[ $key ]
-                );
-            }
-        }
-        if ($callback === 'is_set') {
-            return isset($request_params[ $key ]);
-        }
-        if ($callback === 'match') {
-            return $this->match($key, $request_params, $default, $return);
-        }
-        return isset($request_params[ $key ])
-            ? $request_params[ $key ]
-            : $default;
-    }
-
-
-    /**
-     * remove param
-     *
-     * @param      $key
-     * @param bool $unset_from_global_too
-     */
-    public function unSetRequestParam($key, $unset_from_global_too = false)
-    {
-        // because unset may not actually remove var
-        $this->get[ $key ]     = null;
-        $this->post[ $key ]    = null;
-        $this->request[ $key ] = null;
-        unset($this->get[ $key ], $this->post[ $key ], $this->request[ $key ]);
-        if ($unset_from_global_too) {
-            unset($_GET[ $key ], $_POST[ $key ], $_REQUEST[ $key ]);
-        }
-    }
-
-
-    /**
-     * remove params
-     *
-     * @param array $keys
-     * @param bool  $unset_from_global_too
-     */
-    public function unSetRequestParams(array $keys, $unset_from_global_too = false)
-    {
-        foreach ($keys as $key) {
-            $this->unSetRequestParam($key, $unset_from_global_too);
-        }
-    }
+	/**
+	 * Used for matches() and parameterDrillDown()
+	 * 'bool' will return true or false if match is found or not
+	 */
+	const RETURN_BOOL  = 'bool';
+
+	/**
+	 * Used for matches() and parameterDrillDown()
+	 * 'key' will return the first key found that matches the supplied pattern
+	 */
+	const RETURN_KEY   = 'key';
+
+	/**
+	 * Used for matches() and parameterDrillDown()
+	 * 'value' will return the value for the first request parameter
+	 */
+	const RETURN_VALUE = 'value';
+
+	/**
+	 * $_GET parameters
+	 *
+	 * @var array
+	 */
+	protected $get;
+
+	/**
+	 * $_POST parameters
+	 *
+	 * @var array
+	 */
+	protected $post;
+
+	/**
+	 * $_REQUEST parameters
+	 *
+	 * @var array
+	 */
+	protected $request;
+
+	/**
+	 * @var RequestSanitizer
+	 */
+	protected $sanitizer;
+
+
+	/**
+	 * RequestParams constructor.
+	 *
+	 * @param RequestSanitizer $sanitizer
+	 * @param array            $get
+	 * @param array            $post
+	 */
+	public function __construct(RequestSanitizer $sanitizer, array $get = [], array $post = [])
+	{
+		$this->sanitizer = $sanitizer;
+		$this->get       = ! empty($get) ? $get : $_GET;
+		$this->post      = ! empty($post) ? $post : $_POST;
+		$this->request   = array_merge($this->get, $this->post);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getParams()
+	{
+		return $this->get;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function postParams()
+	{
+		return $this->post;
+	}
+
+
+	/**
+	 * returns contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function requestParams()
+	{
+		return $this->request;
+	}
+
+
+	/**
+	 * @param string     $key
+	 * @param mixed|null $value
+	 * @param bool       $override_ee
+	 * @return    void
+	 */
+	public function setRequestParam($key, $value, $override_ee = false)
+	{
+		// don't allow "ee" to be overwritten unless explicitly instructed to do so
+		if ($override_ee || $key !== 'ee' || empty($this->request['ee'])) {
+			$this->request[ $key ] = $value;
+		}
+	}
+
+
+	/**
+	 * merges the incoming array of parameters into the existing request parameters
+	 *
+	 * @param array $request_params
+	 * @return void
+	 * @since   4.10.24.p
+	 */
+	public function mergeRequestParams(array $request_params)
+	{
+		$this->request = array_merge($this->request, $request_params);
+	}
+
+
+	/**
+	 * returns   the value for a request param if the given key exists
+	 *
+	 * @param string     $key
+	 * @param mixed|null $default
+	 * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
+	 * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
+	 * @param string     $delimiter for CSV type strings that should be returned as an array
+	 * @return array|bool|float|int|string
+	 */
+	public function getRequestParam($key, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '')
+	{
+		$param = $this->sanitizer->clean(
+			$this->parameterDrillDown($key, $default, 'get'),
+			$type,
+			$is_array,
+			$delimiter
+		);
+		$type = $is_array ? 'array' : $type;
+		return DataType::setDataType($param, $type);
+	}
+
+
+	/**
+	 * check if param exists
+	 *
+	 * @param string $key
+	 * @return bool
+	 */
+	public function requestParamIsSet($key)
+	{
+		return (bool) $this->parameterDrillDown($key);
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key that matches the supplied wildcard pattern
+	 * and return the value for the first match found
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 *
+	 * @param string     $pattern
+	 * @param mixed|null $default
+	 * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
+	 * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
+	 * @param string     $delimiter for CSV type strings that should be returned as an array
+	 * @return array|bool|float|int|string
+	 */
+	public function getMatch($pattern, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '')
+	{
+		$param = $this->sanitizer->clean(
+			$this->parameterDrillDown($pattern, $default, 'match'),
+			$type,
+			$is_array,
+			$delimiter
+		);
+		$type = $is_array ? 'array' : $type;
+		return DataType::setDataType($param, $type);
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key matches the supplied wildcard pattern
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 * returns true if a match is found or false if not
+	 *
+	 * @param string $pattern
+	 * @return bool
+	 */
+	public function matches($pattern)
+	{
+		return (bool) $this->parameterDrillDown($pattern, false, 'match', self::RETURN_BOOL);
+	}
+
+
+	/**
+	 * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
+	 * @param string $pattern               A string including wildcards to be converted to a regex pattern
+	 *                                      and used to search through the current request's parameter keys
+	 * @param array  $request_params        The array of request parameters to search through
+	 * @param mixed  $default               [optional] The value to be returned if no match is found.
+	 *                                      Default is null
+	 * @param string $return                [optional] Controls what kind of value is returned.
+	 *                                      Options are the RETURN_* constants:
+	 *                                      RETURN_BOOL will return true or false if match is found or not
+	 *                                      RETURN_KEY will return the first key found that matches the supplied pattern
+	 *                                      RETURN_VALUE will return the value for the first request parameter
+	 *                                      whose key matches the supplied pattern
+	 *                                      Default is 'value'
+	 * @return boolean|string
+	 */
+	private function match($pattern, array $request_params, $default = null, $return = self::RETURN_VALUE)
+	{
+		$return = in_array($return, [self::RETURN_BOOL, self::RETURN_KEY, self::RETURN_VALUE], true)
+			? $return
+			: 'is_set';
+		// replace wildcard chars with regex chars
+		$pattern = str_replace(
+			['\*', '\?'],
+			['.*', '.'],
+			preg_quote($pattern, '/')
+		);
+		foreach ($request_params as $key => $request_param) {
+			if (preg_match('/^' . $pattern . '$/is', $key)) {
+				// return value for request param
+				if ($return === self::RETURN_VALUE) {
+					return $request_param;
+				}
+				// or actual key or true just to indicate it was found
+				return $return === self::RETURN_KEY ? $key : true;
+			}
+		}
+		// match not found so return default value or false
+		return $return === self::RETURN_VALUE ? $default : false;
+	}
+
+
+	/**
+	 * the supplied key can be a simple string to represent a "top-level" request parameter
+	 * or represent a key for a request parameter that is nested deeper within the request parameter array,
+	 * by using square brackets to surround keys for deeper array elements.
+	 * For example :
+	 * if the supplied $key was: "first[second][third]"
+	 * then this will attempt to drill down into the request parameter array to find a value.
+	 * Given the following request parameters:
+	 *  array(
+	 *      'first' => array(
+	 *          'second' => array(
+	 *              'third' => 'has a value'
+	 *          )
+	 *      )
+	 *  )
+	 * would return true if default parameters were set
+	 *
+	 * @param string $callback
+	 * @param        $key
+	 * @param null   $default
+	 * @param string $return
+	 * @param mixed  $request_params
+	 * @return bool|mixed|null
+	 */
+	private function parameterDrillDown(
+		$key,
+		$default = null,
+		$callback = 'is_set',
+		$return = self::RETURN_VALUE,
+		$request_params = []
+	) {
+		$callback       = in_array($callback, ['is_set', 'get', 'match'], true)
+			? $callback
+			: 'is_set';
+		$request_params = ! empty($request_params)
+			? $request_params
+			: $this->request;
+		// does incoming key represent an array like 'first[second][third]'  ?
+		if (strpos($key, '[') !== false) {
+			// turn it into an actual array
+			$key  = str_replace(']', '', $key);
+			$keys = explode('[', $key);
+			$key  = array_shift($keys);
+			if ($callback === 'match') {
+				$real_key = $this->match($key, $request_params, $default, self::RETURN_KEY);
+				$key      = $real_key ?: $key;
+			}
+			// check if top level key exists
+			if (isset($request_params[ $key ])) {
+				// build a new key to pass along like: 'second[third]'
+				// or just 'second' depending on depth of keys
+				$key_string = array_shift($keys);
+				if (! empty($keys)) {
+					$key_string .= '[' . implode('][', $keys) . ']';
+				}
+				return $this->parameterDrillDown(
+					$key_string,
+					$default,
+					$callback,
+					$return,
+					$request_params[ $key ]
+				);
+			}
+		}
+		if ($callback === 'is_set') {
+			return isset($request_params[ $key ]);
+		}
+		if ($callback === 'match') {
+			return $this->match($key, $request_params, $default, $return);
+		}
+		return isset($request_params[ $key ])
+			? $request_params[ $key ]
+			: $default;
+	}
+
+
+	/**
+	 * remove param
+	 *
+	 * @param      $key
+	 * @param bool $unset_from_global_too
+	 */
+	public function unSetRequestParam($key, $unset_from_global_too = false)
+	{
+		// because unset may not actually remove var
+		$this->get[ $key ]     = null;
+		$this->post[ $key ]    = null;
+		$this->request[ $key ] = null;
+		unset($this->get[ $key ], $this->post[ $key ], $this->request[ $key ]);
+		if ($unset_from_global_too) {
+			unset($_GET[ $key ], $_POST[ $key ], $_REQUEST[ $key ]);
+		}
+	}
+
+
+	/**
+	 * remove params
+	 *
+	 * @param array $keys
+	 * @param bool  $unset_from_global_too
+	 */
+	public function unSetRequestParams(array $keys, $unset_from_global_too = false)
+	{
+		foreach ($keys as $key) {
+			$this->unSetRequestParam($key, $unset_from_global_too);
+		}
+	}
 }

core/services/request/CurrentPage.php

Indentation +317 added lines, -317 removed lines

@@ -23,321 +23,321 @@
  */
 class CurrentPage
 {
-    /**
-     * @var EE_CPT_Strategy
-     */
-    private $cpt_strategy;
-
-    /**
-     * @var bool
-     */
-    private $initialized;
-
-    /**
-     * @var bool
-     */
-    private $is_espresso_page;
-
-    /**
-     * @var int
-     */
-    private $post_id = 0;
-
-    /**
-     * @var string
-     */
-    private $post_name = '';
-
-    /**
-     * @var array
-     */
-    private $post_type = [];
-
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
-
-
-    /**
-     * CurrentPage constructor.
-     *
-     * @param EE_CPT_Strategy  $cpt_strategy
-     * @param RequestInterface $request
-     */
-    public function __construct(EE_CPT_Strategy $cpt_strategy, RequestInterface $request)
-    {
-        $this->cpt_strategy = $cpt_strategy;
-        $this->request      = $request;
-        $this->initialized  = is_admin();
-        // analyse the incoming WP request
-        add_action('parse_request', [$this, 'parseQueryVars'], 2, 1);
-    }
-
-
-    /**
-     * @param WP $WP
-     * @return void
-     */
-    public function parseQueryVars(WP $WP = null)
-    {
-        if ($this->initialized) {
-            return;
-        }
-        // if somebody forgot to provide us with WP, that's ok because its global
-        if (! $WP instanceof WP) {
-            global $WP;
-        }
-        $this->post_id   = $this->getPostId($WP);
-        $this->post_name = $this->getPostName($WP);
-        $this->post_type = $this->getPostType($WP);
-        // true or false ? is this page being used by EE ?
-        $this->setEspressoPage();
-        remove_action('parse_request', [$this, 'parseRequest'], 2);
-        $this->initialized = true;
-    }
-
-
-    /**
-     * Just a helper method for getting the url for the displayed page.
-     *
-     * @param WP|null $WP
-     * @return string
-     */
-    public function getPermalink(WP $WP = null)
-    {
-        $post_id = $this->post_id ?: $this->getPostId($WP);
-        if ($post_id) {
-            return get_permalink($post_id);
-        }
-        if (! $WP instanceof WP) {
-            global $WP;
-        }
-        if ($WP instanceof WP && $WP->request) {
-            return site_url($WP->request);
-        }
-        return esc_url_raw(site_url($_SERVER['REQUEST_URI']));
-    }
-
-
-    /**
-     * @return array
-     */
-    public function espressoPostType()
-    {
-        return array_filter(
-            $this->post_type,
-            function ($post_type) {
-                return strpos($post_type, 'espresso_') === 0;
-            }
-        );
-    }
-
-
-    /**
-     * pokes and prods the WP object query_vars in an attempt to shake out a page/post ID
-     *
-     * @param WP $WP
-     * @return int
-     */
-    private function getPostId(WP $WP = null)
-    {
-        $post_id = null;
-        if ($WP instanceof WP) {
-            // look for the post ID in the aptly named 'p' query var
-            if (isset($WP->query_vars['p'])) {
-                $post_id = $WP->query_vars['p'];
-            }
-            // not a post? what about a page?
-            if (! $post_id && isset($WP->query_vars['page_id'])) {
-                $post_id = $WP->query_vars['page_id'];
-            }
-            // ok... maybe pretty permalinks are off and the ID is set in the raw request...
-            // but hasn't been processed yet ie: this method is being called too early :\
-            if (! $post_id && $WP->request !== null && is_numeric(basename($WP->request))) {
-                $post_id = basename($WP->request);
-            }
-        }
-        // none of the above? ok what about an explicit "post_id" URL parameter?
-        if (! $post_id && $this->request->requestParamIsSet('post_id')) {
-            $post_id = $this->request->getRequestParam('post_id');
-        }
-        return $post_id;
-    }
-
-
-    /**
-     * similar to getPostId() above but attempts to obtain the "name" for the current page/post
-     *
-     * @param WP $WP
-     * @return string
-     */
-    private function getPostName(WP $WP = null)
-    {
-        global $wpdb;
-        $post_name = null;
-        if ($WP instanceof WP) {
-            // if this is a post, then is the post name set?
-            if (isset($WP->query_vars['name']) && ! empty($WP->query_vars['name'])) {
-                $post_name = $WP->query_vars['name'];
-            }
-            // what about the page name?
-            if (! $post_name && isset($WP->query_vars['pagename']) && ! empty($WP->query_vars['pagename'])) {
-                $post_name = $WP->query_vars['pagename'];
-            }
-            // this stinks but let's run a query to try and get the post name from the URL
-            // (assuming pretty permalinks are on)
-            if (! $post_name && ! empty($WP->request)) {
-                $possible_post_name = basename($WP->request);
-                if (! is_numeric($possible_post_name)) {
-                    $SQL                = "SELECT ID from {$wpdb->posts}";
-                    $SQL                .= " WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash')";
-                    $SQL                .= ' AND post_name=%s';
-                    $possible_post_name = $wpdb->get_var($wpdb->prepare($SQL, $possible_post_name));
-                    if ($possible_post_name) {
-                        $post_name = $possible_post_name;
-                    }
-                }
-            }
-        }
-        // ug... ok... nothing yet... but do we have a post ID?
-        // if so then... sigh... run a query to get the post name :\
-        if (! $post_name && $this->post_id) {
-            $SQL                = "SELECT post_name from {$wpdb->posts}";
-            $SQL                .= " WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash')";
-            $SQL                .= ' AND ID=%d';
-            $possible_post_name = $wpdb->get_var($wpdb->prepare($SQL, $this->post_id));
-            if ($possible_post_name) {
-                $post_name = $possible_post_name;
-            }
-        }
-        // still nothing? ok what about an explicit 'post_name' URL parameter?
-        if (! $post_name && $this->request->requestParamIsSet('post_name')) {
-            $post_name = $this->request->getRequestParam('post_name');
-        }
-        return $post_name;
-    }
-
-
-    /**
-     * also similar to getPostId() and getPostName() above but not as insane
-     *
-     * @param WP $WP
-     * @return array
-     */
-    private function getPostType(WP $WP = null)
-    {
-        $post_types = [];
-        if ($WP instanceof WP) {
-            $post_types = isset($WP->query_vars['post_type'])
-                ? (array) $WP->query_vars['post_type']
-                : [];
-        }
-        if (empty($post_types) && $this->request->requestParamIsSet('post_type')) {
-            $post_types = $this->request->getRequestParam('post_type', [], DataType::STRING, true);
-        }
-        return (array) $post_types;
-    }
-
-
-    /**
-     * if TRUE, then the current page is somehow utilizing EE logic
-     *
-     * @return bool
-     */
-    public function isEspressoPage()
-    {
-        if ($this->is_espresso_page === null) {
-            $this->setEspressoPage();
-        }
-        return $this->is_espresso_page;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function postId()
-    {
-        return $this->post_id;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function postName()
-    {
-        return $this->post_name;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function postType()
-    {
-        return $this->post_type;
-    }
-
-
-    /**
-     * for manually indicating the current page will utilize EE logic
-     *
-     * @param null|bool $value
-     * @return void
-     */
-    public function setEspressoPage($value = null)
-    {
-        $this->is_espresso_page = $value !== null
-            ? filter_var($value, FILTER_VALIDATE_BOOLEAN)
-            : $this->testForEspressoPage();
-    }
-
-
-    /**
-     * attempts to determine if the current page/post is an EE related page/post
-     * because it utilizes one of our CPT taxonomies, endpoints, or post types
-     *
-     * @return bool
-     */
-    private function testForEspressoPage()
-    {
-        // in case it has already been set
-        if ($this->is_espresso_page) {
-            return true;
-        }
-        global $WP;
-        $espresso_CPT_taxonomies = $this->cpt_strategy->get_CPT_taxonomies();
-        if (is_array($espresso_CPT_taxonomies)) {
-            foreach ($espresso_CPT_taxonomies as $espresso_CPT_taxonomy => $details) {
-                if (isset($WP->query_vars, $WP->query_vars[ $espresso_CPT_taxonomy ])) {
-                    return true;
-                }
-            }
-        }
-        // load espresso CPT endpoints
-        $espresso_CPT_endpoints  = $this->cpt_strategy->get_CPT_endpoints();
-        $post_type_CPT_endpoints = array_flip($espresso_CPT_endpoints);
-        foreach ($this->post_type as $post_type) {
-            // was a post name passed ?
-            if (isset($post_type_CPT_endpoints[ $post_type ])) {
-                // kk we know this is an espresso page, but is it a specific post ?
-                if (! $this->post_name) {
-                    $espresso_post_type = $this->request->getRequestParam('post_type');
-                    // there's no specific post name set, so maybe it's one of our endpoints like www.domain.com/events
-                    // this essentially sets the post_name to "events" (or whatever EE CPT)
-                    $post_name = isset($post_type_CPT_endpoints[ $espresso_post_type ])
-                        ? $post_type_CPT_endpoints[ $espresso_post_type ]
-                        : '';
-                    // if the post type matches one of ours then set the post name to the endpoint
-                    if ($post_name) {
-                        $this->post_name = $post_name;
-                    }
-                }
-                return true;
-            }
-        }
-        return false;
-    }
+	/**
+	 * @var EE_CPT_Strategy
+	 */
+	private $cpt_strategy;
+
+	/**
+	 * @var bool
+	 */
+	private $initialized;
+
+	/**
+	 * @var bool
+	 */
+	private $is_espresso_page;
+
+	/**
+	 * @var int
+	 */
+	private $post_id = 0;
+
+	/**
+	 * @var string
+	 */
+	private $post_name = '';
+
+	/**
+	 * @var array
+	 */
+	private $post_type = [];
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
+
+
+	/**
+	 * CurrentPage constructor.
+	 *
+	 * @param EE_CPT_Strategy  $cpt_strategy
+	 * @param RequestInterface $request
+	 */
+	public function __construct(EE_CPT_Strategy $cpt_strategy, RequestInterface $request)
+	{
+		$this->cpt_strategy = $cpt_strategy;
+		$this->request      = $request;
+		$this->initialized  = is_admin();
+		// analyse the incoming WP request
+		add_action('parse_request', [$this, 'parseQueryVars'], 2, 1);
+	}
+
+
+	/**
+	 * @param WP $WP
+	 * @return void
+	 */
+	public function parseQueryVars(WP $WP = null)
+	{
+		if ($this->initialized) {
+			return;
+		}
+		// if somebody forgot to provide us with WP, that's ok because its global
+		if (! $WP instanceof WP) {
+			global $WP;
+		}
+		$this->post_id   = $this->getPostId($WP);
+		$this->post_name = $this->getPostName($WP);
+		$this->post_type = $this->getPostType($WP);
+		// true or false ? is this page being used by EE ?
+		$this->setEspressoPage();
+		remove_action('parse_request', [$this, 'parseRequest'], 2);
+		$this->initialized = true;
+	}
+
+
+	/**
+	 * Just a helper method for getting the url for the displayed page.
+	 *
+	 * @param WP|null $WP
+	 * @return string
+	 */
+	public function getPermalink(WP $WP = null)
+	{
+		$post_id = $this->post_id ?: $this->getPostId($WP);
+		if ($post_id) {
+			return get_permalink($post_id);
+		}
+		if (! $WP instanceof WP) {
+			global $WP;
+		}
+		if ($WP instanceof WP && $WP->request) {
+			return site_url($WP->request);
+		}
+		return esc_url_raw(site_url($_SERVER['REQUEST_URI']));
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function espressoPostType()
+	{
+		return array_filter(
+			$this->post_type,
+			function ($post_type) {
+				return strpos($post_type, 'espresso_') === 0;
+			}
+		);
+	}
+
+
+	/**
+	 * pokes and prods the WP object query_vars in an attempt to shake out a page/post ID
+	 *
+	 * @param WP $WP
+	 * @return int
+	 */
+	private function getPostId(WP $WP = null)
+	{
+		$post_id = null;
+		if ($WP instanceof WP) {
+			// look for the post ID in the aptly named 'p' query var
+			if (isset($WP->query_vars['p'])) {
+				$post_id = $WP->query_vars['p'];
+			}
+			// not a post? what about a page?
+			if (! $post_id && isset($WP->query_vars['page_id'])) {
+				$post_id = $WP->query_vars['page_id'];
+			}
+			// ok... maybe pretty permalinks are off and the ID is set in the raw request...
+			// but hasn't been processed yet ie: this method is being called too early :\
+			if (! $post_id && $WP->request !== null && is_numeric(basename($WP->request))) {
+				$post_id = basename($WP->request);
+			}
+		}
+		// none of the above? ok what about an explicit "post_id" URL parameter?
+		if (! $post_id && $this->request->requestParamIsSet('post_id')) {
+			$post_id = $this->request->getRequestParam('post_id');
+		}
+		return $post_id;
+	}
+
+
+	/**
+	 * similar to getPostId() above but attempts to obtain the "name" for the current page/post
+	 *
+	 * @param WP $WP
+	 * @return string
+	 */
+	private function getPostName(WP $WP = null)
+	{
+		global $wpdb;
+		$post_name = null;
+		if ($WP instanceof WP) {
+			// if this is a post, then is the post name set?
+			if (isset($WP->query_vars['name']) && ! empty($WP->query_vars['name'])) {
+				$post_name = $WP->query_vars['name'];
+			}
+			// what about the page name?
+			if (! $post_name && isset($WP->query_vars['pagename']) && ! empty($WP->query_vars['pagename'])) {
+				$post_name = $WP->query_vars['pagename'];
+			}
+			// this stinks but let's run a query to try and get the post name from the URL
+			// (assuming pretty permalinks are on)
+			if (! $post_name && ! empty($WP->request)) {
+				$possible_post_name = basename($WP->request);
+				if (! is_numeric($possible_post_name)) {
+					$SQL                = "SELECT ID from {$wpdb->posts}";
+					$SQL                .= " WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash')";
+					$SQL                .= ' AND post_name=%s';
+					$possible_post_name = $wpdb->get_var($wpdb->prepare($SQL, $possible_post_name));
+					if ($possible_post_name) {
+						$post_name = $possible_post_name;
+					}
+				}
+			}
+		}
+		// ug... ok... nothing yet... but do we have a post ID?
+		// if so then... sigh... run a query to get the post name :\
+		if (! $post_name && $this->post_id) {
+			$SQL                = "SELECT post_name from {$wpdb->posts}";
+			$SQL                .= " WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash')";
+			$SQL                .= ' AND ID=%d';
+			$possible_post_name = $wpdb->get_var($wpdb->prepare($SQL, $this->post_id));
+			if ($possible_post_name) {
+				$post_name = $possible_post_name;
+			}
+		}
+		// still nothing? ok what about an explicit 'post_name' URL parameter?
+		if (! $post_name && $this->request->requestParamIsSet('post_name')) {
+			$post_name = $this->request->getRequestParam('post_name');
+		}
+		return $post_name;
+	}
+
+
+	/**
+	 * also similar to getPostId() and getPostName() above but not as insane
+	 *
+	 * @param WP $WP
+	 * @return array
+	 */
+	private function getPostType(WP $WP = null)
+	{
+		$post_types = [];
+		if ($WP instanceof WP) {
+			$post_types = isset($WP->query_vars['post_type'])
+				? (array) $WP->query_vars['post_type']
+				: [];
+		}
+		if (empty($post_types) && $this->request->requestParamIsSet('post_type')) {
+			$post_types = $this->request->getRequestParam('post_type', [], DataType::STRING, true);
+		}
+		return (array) $post_types;
+	}
+
+
+	/**
+	 * if TRUE, then the current page is somehow utilizing EE logic
+	 *
+	 * @return bool
+	 */
+	public function isEspressoPage()
+	{
+		if ($this->is_espresso_page === null) {
+			$this->setEspressoPage();
+		}
+		return $this->is_espresso_page;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function postId()
+	{
+		return $this->post_id;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function postName()
+	{
+		return $this->post_name;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function postType()
+	{
+		return $this->post_type;
+	}
+
+
+	/**
+	 * for manually indicating the current page will utilize EE logic
+	 *
+	 * @param null|bool $value
+	 * @return void
+	 */
+	public function setEspressoPage($value = null)
+	{
+		$this->is_espresso_page = $value !== null
+			? filter_var($value, FILTER_VALIDATE_BOOLEAN)
+			: $this->testForEspressoPage();
+	}
+
+
+	/**
+	 * attempts to determine if the current page/post is an EE related page/post
+	 * because it utilizes one of our CPT taxonomies, endpoints, or post types
+	 *
+	 * @return bool
+	 */
+	private function testForEspressoPage()
+	{
+		// in case it has already been set
+		if ($this->is_espresso_page) {
+			return true;
+		}
+		global $WP;
+		$espresso_CPT_taxonomies = $this->cpt_strategy->get_CPT_taxonomies();
+		if (is_array($espresso_CPT_taxonomies)) {
+			foreach ($espresso_CPT_taxonomies as $espresso_CPT_taxonomy => $details) {
+				if (isset($WP->query_vars, $WP->query_vars[ $espresso_CPT_taxonomy ])) {
+					return true;
+				}
+			}
+		}
+		// load espresso CPT endpoints
+		$espresso_CPT_endpoints  = $this->cpt_strategy->get_CPT_endpoints();
+		$post_type_CPT_endpoints = array_flip($espresso_CPT_endpoints);
+		foreach ($this->post_type as $post_type) {
+			// was a post name passed ?
+			if (isset($post_type_CPT_endpoints[ $post_type ])) {
+				// kk we know this is an espresso page, but is it a specific post ?
+				if (! $this->post_name) {
+					$espresso_post_type = $this->request->getRequestParam('post_type');
+					// there's no specific post name set, so maybe it's one of our endpoints like www.domain.com/events
+					// this essentially sets the post_name to "events" (or whatever EE CPT)
+					$post_name = isset($post_type_CPT_endpoints[ $espresso_post_type ])
+						? $post_type_CPT_endpoints[ $espresso_post_type ]
+						: '';
+					// if the post type matches one of ours then set the post name to the endpoint
+					if ($post_name) {
+						$this->post_name = $post_name;
+					}
+				}
+				return true;
+			}
+		}
+		return false;
+	}
 }

core/helpers/EEH_Array.helper.php

Indentation +217 added lines, -217 removed lines

@@ -13,221 +13,221 @@
 {
 
 
-    /**
-     * This method basically works the same as the PHP core function array_diff except it allows you to compare arrays
-     * of EE_Base_Class objects NOTE: This will ONLY work on an array of EE_Base_Class objects
-     *
-     * @uses array_udiff core php function for setting up our own array comparison
-     * @uses self::_compare_objects as the custom method for array_udiff
-     * @param  array $array1 an array of objects
-     * @param  array $array2 an array of objects
-     * @return array         an array of objects found in array 1 that aren't found in array 2.
-     */
-    public static function object_array_diff($array1, $array2)
-    {
-        return array_udiff($array1, $array2, array('self', '_compare_objects'));
-    }
-
-    /**
-     * Given that $arr is an array, determines if it's associative or numerically AND sequentially indexed
-     *
-     * @param array $array
-     * @return boolean
-     */
-    public static function is_associative_array(array $array)
-    {
-        return array_keys($array) !== range(0, count($array) - 1);
-    }
-
-    /**
-     * Gets an item from the array and leave the array intact. Use in place of end()
-     * when you don't want to change the array
-     *
-     * @param array $arr
-     * @return mixed what ever is in the array
-     */
-    public static function get_one_item_from_array($arr)
-    {
-        $item = end($arr);
-        reset($arr);
-        return $item;
-    }
-
-    /**
-     * Detects if this is a multi-dimensional array
-     * meaning that at least one top-level value is an array. Eg [ [], ...]
-     *
-     * @param mixed $arr
-     * @return boolean
-     */
-    public static function is_multi_dimensional_array($arr)
-    {
-        if (is_array($arr)) {
-            foreach ($arr as $item) {
-                if (is_array($item)) {
-                    return true; // yep, there's at least 2 levels to this array
-                }
-            }
-        }
-        return false; // there's only 1 level, or it's not an array at all!
-    }
-
-    /**
-     * Shorthand for isset( $arr[ $index ] ) ? $arr[ $index ] : $default
-     *
-     * @param array $arr
-     * @param mixed $index
-     * @param mixed $default
-     * @return mixed
-     */
-    public static function is_set($arr, $index, $default)
-    {
-        return isset($arr[ $index ]) ? $arr[ $index ] : $default;
-    }
-
-    /**
-     * Exactly like `maybe_unserialize`, but also accounts for a WP bug: http://core.trac.wordpress.org/ticket/26118
-     *
-     * @param mixed $value usually a string, but could be an array or object
-     * @return mixed the UN-serialized data
-     */
-    public static function maybe_unserialize($value)
-    {
-        $data = maybe_unserialize($value);
-        // it's possible that this still has serialized data if it's the session.
-        //  WP has a bug, http://core.trac.wordpress.org/ticket/26118 that doesn't unserialize this automatically.
-        $token = 'C';
-        $data = is_string($data) ? trim($data) : $data;
-        if (is_string($data) && strlen($data) > 1 && $data[0] == $token && preg_match("/^{$token}:[0-9]+:/s", $data)) {
-            return unserialize($data);
-        } else {
-            return $data;
-        }
-    }
-
-
-    /**
-     * insert_into_array
-     *
-     * @param array        $target_array the array to insert new data into
-     * @param array        $array_to_insert the new data to be inserted
-     * @param int | string $offset a known key within $target_array where new data will be inserted
-     * @param bool         $add_before whether to add new data before or after the offset key
-     * @param bool         $preserve_keys whether or not to reset numerically indexed arrays
-     * @return array
-     */
-    public static function insert_into_array(
-        $target_array = array(),
-        $array_to_insert = array(),
-        $offset = null,
-        $add_before = true,
-        $preserve_keys = true
-    ) {
-        // ensure incoming arrays are actually arrays
-        $target_array = (array) $target_array;
-        $array_to_insert = (array) $array_to_insert;
-        // if no offset key was supplied
-        if (empty($offset)) {
-            // use start or end of $target_array based on whether we are adding before or not
-            $offset = $add_before ? 0 : count($target_array);
-        }
-        // if offset key is a string, then find the corresponding numeric location for that element
-        $offset = is_int($offset) ? $offset : array_search($offset, array_keys($target_array));
-        // add one to the offset if adding after
-        $offset = $add_before ? $offset : $offset + 1;
-        // but ensure offset does not exceed the length of the array
-        $offset = $offset > count($target_array) ? count($target_array) : $offset;
-        // reindex array ???
-        if ($preserve_keys) {
-            // take a slice of the target array from the beginning till the offset,
-            // then add the new data
-            // then add another slice that starts at the offset and goes till the end
-            return array_slice($target_array, 0, $offset, true) + $array_to_insert + array_slice(
-                $target_array,
-                $offset,
-                null,
-                true
-            );
-        } else {
-            // since we don't want to preserve keys, we can use array_splice
-            array_splice($target_array, $offset, 0, $array_to_insert);
-            return $target_array;
-        }
-    }
-
-
-    /**
-     * array_merge() is slow and should never be used while looping over data
-     * if you don't need to preserve keys from all arrays, then using a foreach loop is much faster
-     * so really this acts more like array_replace( $array1, $array2 )
-     * or a union with the arrays flipped ( $array2 + $array1 )
-     * this saves a few lines of code and improves readability
-     *
-     * @param array $array1
-     * @param array $array2
-     * @return array
-     */
-    public static function merge_arrays_and_overwrite_keys(array $array1, array $array2)
-    {
-        foreach ($array2 as $key => $value) {
-            $array1[ $key ] = $value;
-        }
-        return $array1;
-    }
-
-
-    /**
-     * given a flat array like $array = array('A', 'B', 'C')
-     * will convert into a multidimensional array like $array[A][B][C]
-     * if $final_value is provided and is anything other than null,
-     * then that will be set as the value for the innermost array key
-     * like so: $array[A][B][C] = $final_value
-     *
-     * @param array $flat_array
-     * @param mixed $final_value
-     * @return array
-     */
-    public static function convert_array_values_to_keys(array $flat_array, $final_value = null)
-    {
-        $multidimensional = array();
-        $reference = &$multidimensional;
-        foreach ($flat_array as $key) {
-            $reference[ $key ] = array();
-            $reference = &$reference[ $key ];
-        }
-        if ($final_value !== null) {
-            $reference = $final_value;
-        }
-        return $multidimensional;
-    }
-
-
-    /**
-     * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
-     * @param array $array
-     * @return bool
-     */
-    public static function is_array_numerically_and_sequentially_indexed(array $array)
-    {
-        return empty($array) || array_keys($array) === range(0, count($array) - 1);
-    }
-
-
-    /**
-     * recursively walks through an array and adds slashes to all no array elements
-     *
-     * @param mixed $element
-     * @return array|string
-     * @since   $VID:$
-     */
-    public static function addSlashesRecursively($element)
-    {
-        if (is_array($element)) {
-            foreach ($element as $key => $value) {
-                $element[ $key ] = EEH_Array::addSlashesRecursively($value);
-            }
-            return $element;
-        }
-        return is_string($element) ? addslashes($element) : $element;
-    }
+	/**
+	 * This method basically works the same as the PHP core function array_diff except it allows you to compare arrays
+	 * of EE_Base_Class objects NOTE: This will ONLY work on an array of EE_Base_Class objects
+	 *
+	 * @uses array_udiff core php function for setting up our own array comparison
+	 * @uses self::_compare_objects as the custom method for array_udiff
+	 * @param  array $array1 an array of objects
+	 * @param  array $array2 an array of objects
+	 * @return array         an array of objects found in array 1 that aren't found in array 2.
+	 */
+	public static function object_array_diff($array1, $array2)
+	{
+		return array_udiff($array1, $array2, array('self', '_compare_objects'));
+	}
+
+	/**
+	 * Given that $arr is an array, determines if it's associative or numerically AND sequentially indexed
+	 *
+	 * @param array $array
+	 * @return boolean
+	 */
+	public static function is_associative_array(array $array)
+	{
+		return array_keys($array) !== range(0, count($array) - 1);
+	}
+
+	/**
+	 * Gets an item from the array and leave the array intact. Use in place of end()
+	 * when you don't want to change the array
+	 *
+	 * @param array $arr
+	 * @return mixed what ever is in the array
+	 */
+	public static function get_one_item_from_array($arr)
+	{
+		$item = end($arr);
+		reset($arr);
+		return $item;
+	}
+
+	/**
+	 * Detects if this is a multi-dimensional array
+	 * meaning that at least one top-level value is an array. Eg [ [], ...]
+	 *
+	 * @param mixed $arr
+	 * @return boolean
+	 */
+	public static function is_multi_dimensional_array($arr)
+	{
+		if (is_array($arr)) {
+			foreach ($arr as $item) {
+				if (is_array($item)) {
+					return true; // yep, there's at least 2 levels to this array
+				}
+			}
+		}
+		return false; // there's only 1 level, or it's not an array at all!
+	}
+
+	/**
+	 * Shorthand for isset( $arr[ $index ] ) ? $arr[ $index ] : $default
+	 *
+	 * @param array $arr
+	 * @param mixed $index
+	 * @param mixed $default
+	 * @return mixed
+	 */
+	public static function is_set($arr, $index, $default)
+	{
+		return isset($arr[ $index ]) ? $arr[ $index ] : $default;
+	}
+
+	/**
+	 * Exactly like `maybe_unserialize`, but also accounts for a WP bug: http://core.trac.wordpress.org/ticket/26118
+	 *
+	 * @param mixed $value usually a string, but could be an array or object
+	 * @return mixed the UN-serialized data
+	 */
+	public static function maybe_unserialize($value)
+	{
+		$data = maybe_unserialize($value);
+		// it's possible that this still has serialized data if it's the session.
+		//  WP has a bug, http://core.trac.wordpress.org/ticket/26118 that doesn't unserialize this automatically.
+		$token = 'C';
+		$data = is_string($data) ? trim($data) : $data;
+		if (is_string($data) && strlen($data) > 1 && $data[0] == $token && preg_match("/^{$token}:[0-9]+:/s", $data)) {
+			return unserialize($data);
+		} else {
+			return $data;
+		}
+	}
+
+
+	/**
+	 * insert_into_array
+	 *
+	 * @param array        $target_array the array to insert new data into
+	 * @param array        $array_to_insert the new data to be inserted
+	 * @param int | string $offset a known key within $target_array where new data will be inserted
+	 * @param bool         $add_before whether to add new data before or after the offset key
+	 * @param bool         $preserve_keys whether or not to reset numerically indexed arrays
+	 * @return array
+	 */
+	public static function insert_into_array(
+		$target_array = array(),
+		$array_to_insert = array(),
+		$offset = null,
+		$add_before = true,
+		$preserve_keys = true
+	) {
+		// ensure incoming arrays are actually arrays
+		$target_array = (array) $target_array;
+		$array_to_insert = (array) $array_to_insert;
+		// if no offset key was supplied
+		if (empty($offset)) {
+			// use start or end of $target_array based on whether we are adding before or not
+			$offset = $add_before ? 0 : count($target_array);
+		}
+		// if offset key is a string, then find the corresponding numeric location for that element
+		$offset = is_int($offset) ? $offset : array_search($offset, array_keys($target_array));
+		// add one to the offset if adding after
+		$offset = $add_before ? $offset : $offset + 1;
+		// but ensure offset does not exceed the length of the array
+		$offset = $offset > count($target_array) ? count($target_array) : $offset;
+		// reindex array ???
+		if ($preserve_keys) {
+			// take a slice of the target array from the beginning till the offset,
+			// then add the new data
+			// then add another slice that starts at the offset and goes till the end
+			return array_slice($target_array, 0, $offset, true) + $array_to_insert + array_slice(
+				$target_array,
+				$offset,
+				null,
+				true
+			);
+		} else {
+			// since we don't want to preserve keys, we can use array_splice
+			array_splice($target_array, $offset, 0, $array_to_insert);
+			return $target_array;
+		}
+	}
+
+
+	/**
+	 * array_merge() is slow and should never be used while looping over data
+	 * if you don't need to preserve keys from all arrays, then using a foreach loop is much faster
+	 * so really this acts more like array_replace( $array1, $array2 )
+	 * or a union with the arrays flipped ( $array2 + $array1 )
+	 * this saves a few lines of code and improves readability
+	 *
+	 * @param array $array1
+	 * @param array $array2
+	 * @return array
+	 */
+	public static function merge_arrays_and_overwrite_keys(array $array1, array $array2)
+	{
+		foreach ($array2 as $key => $value) {
+			$array1[ $key ] = $value;
+		}
+		return $array1;
+	}
+
+
+	/**
+	 * given a flat array like $array = array('A', 'B', 'C')
+	 * will convert into a multidimensional array like $array[A][B][C]
+	 * if $final_value is provided and is anything other than null,
+	 * then that will be set as the value for the innermost array key
+	 * like so: $array[A][B][C] = $final_value
+	 *
+	 * @param array $flat_array
+	 * @param mixed $final_value
+	 * @return array
+	 */
+	public static function convert_array_values_to_keys(array $flat_array, $final_value = null)
+	{
+		$multidimensional = array();
+		$reference = &$multidimensional;
+		foreach ($flat_array as $key) {
+			$reference[ $key ] = array();
+			$reference = &$reference[ $key ];
+		}
+		if ($final_value !== null) {
+			$reference = $final_value;
+		}
+		return $multidimensional;
+	}
+
+
+	/**
+	 * @see http://stackoverflow.com/questions/173400/how-to-check-if-php-array-is-associative-or-sequential
+	 * @param array $array
+	 * @return bool
+	 */
+	public static function is_array_numerically_and_sequentially_indexed(array $array)
+	{
+		return empty($array) || array_keys($array) === range(0, count($array) - 1);
+	}
+
+
+	/**
+	 * recursively walks through an array and adds slashes to all no array elements
+	 *
+	 * @param mixed $element
+	 * @return array|string
+	 * @since   $VID:$
+	 */
+	public static function addSlashesRecursively($element)
+	{
+		if (is_array($element)) {
+			foreach ($element as $key => $value) {
+				$element[ $key ] = EEH_Array::addSlashesRecursively($value);
+			}
+			return $element;
+		}
+		return is_string($element) ? addslashes($element) : $element;
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -82,7 +82,7 @@ 
      */
     public static function is_set($arr, $index, $default)
     {
-        return isset($arr[ $index ]) ? $arr[ $index ] : $default;
+        return isset($arr[$index]) ? $arr[$index] : $default;
     }
 
     /**
@@ -170,7 +170,7 @@ 
     public static function merge_arrays_and_overwrite_keys(array $array1, array $array2)
     {
         foreach ($array2 as $key => $value) {
-            $array1[ $key ] = $value;
+            $array1[$key] = $value;
         }
         return $array1;
     }
@@ -192,8 +192,8 @@ 
         $multidimensional = array();
         $reference = &$multidimensional;
         foreach ($flat_array as $key) {
-            $reference[ $key ] = array();
-            $reference = &$reference[ $key ];
+            $reference[$key] = array();
+            $reference = &$reference[$key];
         }
         if ($final_value !== null) {
             $reference = $final_value;
@@ -224,7 +224,7 @@ 
     {
         if (is_array($element)) {
             foreach ($element as $key => $value) {
-                $element[ $key ] = EEH_Array::addSlashesRecursively($value);
+                $element[$key] = EEH_Array::addSlashesRecursively($value);
             }
             return $element;
         }