eventespresso / event-espresso-core

core/libraries/messages/EE_messenger.lib.php

Spacing +91 added lines, -91 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('NO direct script access allowed');
 
 /**
@@ -289,7 +289,7 @@ 
 	 * @return void
 	 */
 	public function enqueue_scripts_styles() {
-		do_action( 'AHEE__EE_messenger__enqueue_scripts_styles');
+		do_action('AHEE__EE_messenger__enqueue_scripts_styles');
 	}
 
 
@@ -325,7 +325,7 @@ 
 
 		$this->_supports_labels->template_variation_description = __('These are different styles to choose from for the selected template structure.  Usually these affect things like font style, color, borders etc.  In some cases the styles will also make minor layout changes.');
 
-		$this->_supports_labels = apply_filters( 'FHEE__EE_messenger___set_supports_labels_defaults___supports_labels', $this->_supports_labels, $this );
+		$this->_supports_labels = apply_filters('FHEE__EE_messenger___set_supports_labels_defaults___supports_labels', $this->_supports_labels, $this);
 	}
 
 
@@ -340,10 +340,10 @@ 
 	 * @return stdClass
 	 */
 	public function get_supports_labels() {
-		if ( empty( $this->_supports_labels->template_pack ) || empty( $this->_supports_labels->template_variation) ) {
+		if (empty($this->_supports_labels->template_pack) || empty($this->_supports_labels->template_variation)) {
 			$this->_set_supports_labels_defaults();
 		}
-		return apply_filters( 'FHEE__EE_messenger__get_supports_labels', $this->_supports_labels, $this );
+		return apply_filters('FHEE__EE_messenger__get_supports_labels', $this->_supports_labels, $this);
 	}
 
 
@@ -363,10 +363,10 @@ 
 	 *
 	 * @return string                    path or url for the requested variation.
 	 */
-	public function get_variation( EE_Messages_Template_Pack $pack, $message_type_name, $url = FALSE, $type = 'main', $variation = 'default', $skip_filters = FALSE ) {
+	public function get_variation(EE_Messages_Template_Pack $pack, $message_type_name, $url = FALSE, $type = 'main', $variation = 'default', $skip_filters = FALSE) {
 		$this->_tmp_pack = $pack;
-		$variation_path = apply_filters( 'EE_messenger__get_variation__variation', false, $pack, $this->name, $message_type_name, $url, $type, $variation, $skip_filters );
-		$variation_path = empty( $variation_path ) ? $this->_tmp_pack->get_variation( $this->name, $message_type_name, $type, $variation, $url, '.css', $skip_filters ) : $variation_path;
+		$variation_path = apply_filters('EE_messenger__get_variation__variation', false, $pack, $this->name, $message_type_name, $url, $type, $variation, $skip_filters);
+		$variation_path = empty($variation_path) ? $this->_tmp_pack->get_variation($this->name, $message_type_name, $type, $variation, $url, '.css', $skip_filters) : $variation_path;
 		return $variation_path;
 
 	}
@@ -384,13 +384,13 @@ 
 	 * @return array
 	 */
 	public function get_default_message_types() {
-		$class = get_class( $this );
+		$class = get_class($this);
 
 		//messenger specific filter
-		$default_types = apply_filters( 'FHEE__' . $class . '__get_default_message_types__default_types', $this->_default_message_types, $this );
+		$default_types = apply_filters('FHEE__'.$class.'__get_default_message_types__default_types', $this->_default_message_types, $this);
 
 		//all messengers filter
-		$default_types = apply_filters( 'FHEE__EE_messenger__get_default_message_types__default_types', $default_types, $this );
+		$default_types = apply_filters('FHEE__EE_messenger__get_default_message_types__default_types', $default_types, $this);
 		return $default_types;
 	}
 
@@ -405,14 +405,14 @@ 
 	 * @return array
 	 */
 	public function get_valid_message_types() {
-		$class = get_class( $this );
+		$class = get_class($this);
 
 		//messenger specific filter
 		//messenger specific filter
-		$valid_types = apply_filters( 'FHEE__' . $class . '__get_valid_message_types__valid_types', $this->_valid_message_types, $this );
+		$valid_types = apply_filters('FHEE__'.$class.'__get_valid_message_types__valid_types', $this->_valid_message_types, $this);
 
 		//all messengers filter
-		$valid_types = apply_filters( 'FHEE__EE_messenger__get_valid_message_types__valid_types', $valid_types, $this );
+		$valid_types = apply_filters('FHEE__EE_messenger__get_valid_message_types__valid_types', $valid_types, $this);
 		return $valid_types;
 	}
 
@@ -426,7 +426,7 @@ 
 	 * @access public
 	 * @param array $new_config Whatever is put in here will reset the _validator_config property
 	 */
-	public function set_validator_config( $new_config ) {
+	public function set_validator_config($new_config) {
 		$this->_validator_config = $new_config;
 	}
 
@@ -442,8 +442,8 @@ 
 	public function get_validator_config() {
 		$class = get_class($this);
 
-		$config = apply_filters( 'FHEE__' . $class . '__get_validator_config', $this->_validator_config, $this );
-		$config = apply_filters( 'FHEE__EE_messenger__get_validator_config', $config, $this );
+		$config = apply_filters('FHEE__'.$class.'__get_validator_config', $this->_validator_config, $this);
+		$config = apply_filters('FHEE__EE_messenger__get_validator_config', $config, $this);
 		return $config;
 	}
 
@@ -460,8 +460,8 @@ 
 	 * @access public
 	 * @return string content for page
 	 */
-	public function get_messenger_admin_page_content( $page, $action = null, $extra = array(), $message_types = array() ) {
-		return $this->_get_admin_page_content( $page, $action, $extra, $message_types );
+	public function get_messenger_admin_page_content($page, $action = null, $extra = array(), $message_types = array()) {
+		return $this->_get_admin_page_content($page, $action, $extra, $message_types);
 	}
 
 
@@ -470,76 +470,76 @@ 
 
 
 
-	protected function _get_admin_content_events_edit( $message_types, $extra ) {
+	protected function _get_admin_content_events_edit($message_types, $extra) {
 		//defaults
 		$template_args = array();
 		$custom_templates = array();
 		$selector_rows = '';
 
 		//we don't need message types here so we're just going to ignore. we do, however, expect the event id here. The event id is needed to provide a link to setup a custom template for this event.
-		$event_id = isset( $extra['event'] ) ? $extra['event'] : NULL;
+		$event_id = isset($extra['event']) ? $extra['event'] : NULL;
 
-		$template_wrapper_path = EE_LIBRARIES . 'messages/messenger/admin_templates/event_switcher_wrapper.template.php';
-		$template_row_path = EE_LIBRARIES . 'messages/messenger/admin_templates/event_switcher_row.template.php';
+		$template_wrapper_path = EE_LIBRARIES.'messages/messenger/admin_templates/event_switcher_wrapper.template.php';
+		$template_row_path = EE_LIBRARIES.'messages/messenger/admin_templates/event_switcher_row.template.php';
 
 		//array of template objects for global and custom (non-trashed) (but remember just for this messenger!)
-		$global_templates = EEM_Message_Template_Group::instance()->get_all( array( array('MTP_messenger' => $this->name, 'MTP_is_global' => TRUE, 'MTP_is_active' => TRUE ) ) );
-		$templates_for_event = EEM_Message_Template_Group::instance()->get_all_custom_templates_by_event( $event_id, array( 'MTP_messenger' => $this->name, 'MTP_is_active' => TRUE ) );
-		$templates_for_event = !empty( $templates_for_event ) ? $templates_for_event : array();
+		$global_templates = EEM_Message_Template_Group::instance()->get_all(array(array('MTP_messenger' => $this->name, 'MTP_is_global' => TRUE, 'MTP_is_active' => TRUE)));
+		$templates_for_event = EEM_Message_Template_Group::instance()->get_all_custom_templates_by_event($event_id, array('MTP_messenger' => $this->name, 'MTP_is_active' => TRUE));
+		$templates_for_event = ! empty($templates_for_event) ? $templates_for_event : array();
 
 		//so we need to setup the rows for the selectors and we use the global mtpgs (cause those will the active message template groups)
-		foreach ( $global_templates as $mtpgID => $mtpg ) {
+		foreach ($global_templates as $mtpgID => $mtpg) {
 			//verify this message type is supposed to show on this page
 			$mtp_obj = $mtpg->message_type_obj();
-			if ( ! $mtp_obj instanceof EE_message_type ) {
+			if ( ! $mtp_obj instanceof EE_message_type) {
 				continue;
 			}
 			$mtp_obj->admin_registered_pages = (array) $mtp_obj->admin_registered_pages;
-			if ( ! in_array( 'events_edit', $mtp_obj->admin_registered_pages ) )
+			if ( ! in_array('events_edit', $mtp_obj->admin_registered_pages))
 				continue;
 			$stargs = array();
 			$default_value = '';
 			$select_values = array();
 			$select_values[$mtpgID] = __('Global', 'event_espresso');
-			$default_value = array_key_exists( $mtpgID, $templates_for_event ) && ! $mtpg->get('MTP_is_override' ) ? $mtpgID : NULL;
+			$default_value = array_key_exists($mtpgID, $templates_for_event) && ! $mtpg->get('MTP_is_override') ? $mtpgID : NULL;
 
 			//if the override has been set for the global template, then that means even if there are custom templates already created we ignore them because of the set override.
 
-			if ( ! $mtpg->get('MTP_is_override' ) ) {
+			if ( ! $mtpg->get('MTP_is_override')) {
 				//any custom templates for this message type?
-				$custom_templates = EEM_Message_Template_Group::instance()->get_custom_message_template_by_m_and_mt( $this->name, $mtpg->message_type() );
+				$custom_templates = EEM_Message_Template_Group::instance()->get_custom_message_template_by_m_and_mt($this->name, $mtpg->message_type());
 
-				foreach( $custom_templates as $cmtpgID => $cmtpg ) {
+				foreach ($custom_templates as $cmtpgID => $cmtpg) {
 					$select_values[$cmtpgID] = $cmtpg->name();
-					$default_value = array_key_exists( $cmtpgID, $templates_for_event ) ? $cmtpgID : $default_value;
+					$default_value = array_key_exists($cmtpgID, $templates_for_event) ? $cmtpgID : $default_value;
 				}
 			}
 
 			//if there is no $default_value then we set it as the global
-			$default_value = empty( $default_value ) ? $mtpgID : $default_value;
+			$default_value = empty($default_value) ? $mtpgID : $default_value;
 
-			$edit_url = EEH_URL::add_query_args_and_nonce( array('page' => 'espresso_messages', 'action' => 'edit_message_template', 'id' => $default_value), admin_url('admin.php') );
-			$create_url = EEH_URL::add_query_args_and_nonce( array('page' => 'espresso_messages', 'action' => 'add_new_message_template', 'GRP_ID' => $default_value ), admin_url( 'admin.php' ) );
+			$edit_url = EEH_URL::add_query_args_and_nonce(array('page' => 'espresso_messages', 'action' => 'edit_message_template', 'id' => $default_value), admin_url('admin.php'));
+			$create_url = EEH_URL::add_query_args_and_nonce(array('page' => 'espresso_messages', 'action' => 'add_new_message_template', 'GRP_ID' => $default_value), admin_url('admin.php'));
 
-			$st_args['mt_name'] = ucwords( $mtp_obj->label['singular'] );
+			$st_args['mt_name'] = ucwords($mtp_obj->label['singular']);
 			$st_args['mt_slug'] = $mtpg->message_type();
 			$st_args['messenger_slug'] = $this->name;
-			$st_args['selector'] = EEH_Form_Fields::select_input( 'event_message_templates_relation[' . $mtpgID . ']', $select_values, $default_value, 'data-messenger="' . $this->name . '" data-messagetype="' . $mtpg->message_type() . '"', 'message-template-selector' );
+			$st_args['selector'] = EEH_Form_Fields::select_input('event_message_templates_relation['.$mtpgID.']', $select_values, $default_value, 'data-messenger="'.$this->name.'" data-messagetype="'.$mtpg->message_type().'"', 'message-template-selector');
 
 			//note that  message template group that has override_all_custom set will remove the ability to set a custom message template based off of the global (and that also in turn overrides any other custom templates).
-			$st_args['create_button'] =  $mtpg->get('MTP_is_override') ? '' : '<a data-messenger="' . $this->name . '" data-messagetype="' . $mtpg->message_type() . '" data-grpid="' . $default_value . '" target="_blank" href="' . $create_url . '" class="button button-small create-mtpg-button">' . __('Create New Custom', 'event_espresso') . '</a>';
-			$st_args['create_button'] = EE_Registry::instance()->CAP->current_user_can( 'ee_edit_messages', 'espresso_messsages_add_new_message_template' ) ? $st_args['create_button'] : '';
-			$st_args['edit_button'] = EE_Registry::instance()->CAP->current_user_can( 'ee_edit_message', 'espresso_messages_edit_message_template', $mtpgID ) ?  '<a data-messagetype="' . $mtpg->message_type() . '" data-grpid="' . $default_value . '" target="_blank" href="' . $edit_url . '" class="button button-small edit-mtpg-button">' . __('Edit', 'event_espresso') . '</a>' : '';
-			$selector_rows .= EEH_Template::display_template( $template_row_path, $st_args, TRUE );
+			$st_args['create_button'] = $mtpg->get('MTP_is_override') ? '' : '<a data-messenger="'.$this->name.'" data-messagetype="'.$mtpg->message_type().'" data-grpid="'.$default_value.'" target="_blank" href="'.$create_url.'" class="button button-small create-mtpg-button">'.__('Create New Custom', 'event_espresso').'</a>';
+			$st_args['create_button'] = EE_Registry::instance()->CAP->current_user_can('ee_edit_messages', 'espresso_messsages_add_new_message_template') ? $st_args['create_button'] : '';
+			$st_args['edit_button'] = EE_Registry::instance()->CAP->current_user_can('ee_edit_message', 'espresso_messages_edit_message_template', $mtpgID) ? '<a data-messagetype="'.$mtpg->message_type().'" data-grpid="'.$default_value.'" target="_blank" href="'.$edit_url.'" class="button button-small edit-mtpg-button">'.__('Edit', 'event_espresso').'</a>' : '';
+			$selector_rows .= EEH_Template::display_template($template_row_path, $st_args, TRUE);
 		}
 
 		//if no selectors present then get out.
-		if ( empty( $selector_rows ) ) {
+		if (empty($selector_rows)) {
 			return '';
 		}
 
 		$template_args['selector_rows'] = $selector_rows;
-		return EEH_Template::display_template( $template_wrapper_path, $template_args, TRUE );
+		return EEH_Template::display_template($template_wrapper_path, $template_args, TRUE);
 	}
 
 
@@ -554,8 +554,8 @@ 
 	 * @return array $this->_template_fields
 	 */
 	public function get_template_fields() {
-		$template_fields = apply_filters( 'FHEE__' . get_class($this) . '__get_template_fields', $this->_template_fields, $this );
-		$template_fields = apply_filters( 'FHEE__EE_messenger__get_template_fields', $template_fields, $this );
+		$template_fields = apply_filters('FHEE__'.get_class($this).'__get_template_fields', $this->_template_fields, $this);
+		$template_fields = apply_filters('FHEE__EE_messenger__get_template_fields', $template_fields, $this);
 		return $template_fields;
 	}
 
@@ -568,9 +568,9 @@ 
 	 * The following method doesn't NEED to be used by child classes but might be modified by the specific messenger
 	 */
 	protected function _set_template_value($item, $value) {
-		if ( array_key_exists($item, $this->_template_fields) ) {
-			$prop = '_' . $item;
-			$this->{$prop}= $value;
+		if (array_key_exists($item, $this->_template_fields)) {
+			$prop = '_'.$item;
+			$this->{$prop} = $value;
 		}
 	}
 
@@ -580,8 +580,8 @@ 
 	 * @param EE_message_type $message_type The message type object used in combination with this messenger to generate the provided message.
 	 * @return bool | WP_Error
 	 */
-	public function send_message( $message, EE_message_type $message_type ) {
-		$this->_validate_and_setup( $message );
+	public function send_message($message, EE_message_type $message_type) {
+		$this->_validate_and_setup($message);
 		$this->_incoming_message_type = $message_type;
 		return $this->_send_message();
 	}
@@ -595,28 +595,28 @@ 
 	 * @param  bool   $send    true we will actually use the _send method (for test sends). FALSE we just return preview
 	 * @return string          return the message html content
 	 */
-	public function get_preview( $message, EE_message_type $message_type, $send = FALSE ) {
-		$this->_validate_and_setup( $message );
+	public function get_preview($message, EE_message_type $message_type, $send = FALSE) {
+		$this->_validate_and_setup($message);
 
 		$this->_incoming_message_type = $message_type;
 
-		if ( $send ) {
+		if ($send) {
 			//are we overriding any existing template fields?
 			$settings = $this->get_existing_test_settings();
-			if ( !empty( $settings ) ) {
-				foreach( $settings as $field => $value ) {
-					$this->_set_template_value( $field, $value );
+			if ( ! empty($settings)) {
+				foreach ($settings as $field => $value) {
+					$this->_set_template_value($field, $value);
 				}
 			}
 		}
 
 		//enqueue preview js so that any links/buttons on the page are disabled.
-		if ( ! $send ) {
+		if ( ! $send) {
 			// the below may seem like duplication.  However, typically if a messenger enqueues scripts/styles,
 			// it deregisters all existing wp scripts and styles first.  So the second hook ensures our previewer still gets setup.
-			add_action( 'admin_enqueue_scripts', array( $this, 'add_preview_script' ), 10 );
-			add_action( 'wp_enqueue_scripts', array( $this, 'add_preview_script' ), 10 );
-			add_action( 'AHEE__EE_messenger__enqueue_scripts_styles', array( $this, 'add_preview_script' ), 10 );
+			add_action('admin_enqueue_scripts', array($this, 'add_preview_script'), 10);
+			add_action('wp_enqueue_scripts', array($this, 'add_preview_script'), 10);
+			add_action('AHEE__EE_messenger__enqueue_scripts_styles', array($this, 'add_preview_script'), 10);
 		}
 
 		return $send ? $this->_send_message() : $this->_preview();
@@ -634,10 +634,10 @@ 
 	 */
 	public function add_preview_script() {
 		//error message
-		EE_Registry::$i18n_js_strings[ 'links_disabled' ] = __( 'All the links on this page have been disabled because this is a generated preview message for the purpose of ensuring layout, style, and content setup.  To test generated links, you must trigger an actual message notification.', 'event_espresso' );
-		wp_register_script( 'ee-messages-preview-js', EE_LIBRARIES_URL . 'messages/messenger/assets/js/ee-messages-preview.js', array( 'jquery' ), EVENT_ESPRESSO_VERSION, true );
-		wp_localize_script( 'ee-messages-preview-js', 'eei18n', EE_Registry::$i18n_js_strings );
-		wp_enqueue_script( 'ee-messages-preview-js' );
+		EE_Registry::$i18n_js_strings['links_disabled'] = __('All the links on this page have been disabled because this is a generated preview message for the purpose of ensuring layout, style, and content setup.  To test generated links, you must trigger an actual message notification.', 'event_espresso');
+		wp_register_script('ee-messages-preview-js', EE_LIBRARIES_URL.'messages/messenger/assets/js/ee-messages-preview.js', array('jquery'), EVENT_ESPRESSO_VERSION, true);
+		wp_localize_script('ee-messages-preview-js', 'eei18n', EE_Registry::$i18n_js_strings);
+		wp_enqueue_script('ee-messages-preview-js');
 	}
 
 
@@ -647,23 +647,23 @@ 
 	 * @param  object $message message object
 	 * @throws \EE_Error
 	 */
-	protected function _validate_and_setup( $message ) {
-		if ( !is_object( $message ) )
-			throw new EE_Error( __('Incoming "$message" must be an object', 'event_espresso' ) );
+	protected function _validate_and_setup($message) {
+		if ( ! is_object($message))
+			throw new EE_Error(__('Incoming "$message" must be an object', 'event_espresso'));
 
 		//verify we have the required template pack value on the $message object.
-		if ( empty( $message->template_pack ) || ! $message->template_pack instanceof EE_Messages_Template_Pack ) {
-			throw new EE_Error( __('Incoming $message object must have a EE_Messages_Template_Pack object assigned to the template_pack property', 'event_espresso' ) );
+		if (empty($message->template_pack) || ! $message->template_pack instanceof EE_Messages_Template_Pack) {
+			throw new EE_Error(__('Incoming $message object must have a EE_Messages_Template_Pack object assigned to the template_pack property', 'event_espresso'));
 		}
 
 		$this->_tmp_pack = $message->template_pack;
 
-		$this->_variation = !empty ( $message->variation ) ? $message->variation : 'default';
+		$this->_variation = ! empty ($message->variation) ? $message->variation : 'default';
 
 		$template_fields = $this->get_template_fields();
 
-		foreach ( $template_fields as $template => $value ) {
-			if ( $template !== 'extra' )
+		foreach ($template_fields as $template => $value) {
+			if ($template !== 'extra')
 				$this->_set_template_value($template, $message->{$template});
 		}
 	}
@@ -678,21 +678,21 @@ 
 	 * @return string
 	 * @throws \EE_Error
 	 */
-	protected function _get_main_template( $preview = FALSE ) {
+	protected function _get_main_template($preview = FALSE) {
 		$type = $preview ? 'preview' : 'main';
 
-		$wrapper_template = $this->_tmp_pack->get_wrapper( $this->name, $type );
+		$wrapper_template = $this->_tmp_pack->get_wrapper($this->name, $type);
 
 		//check file exists and is readable
-		if ( !is_readable( $wrapper_template ) )
-			throw new EE_Error( sprintf( __('Unable to access the template file for the %s messenger main content wrapper.  The location being attempted is %s.', 'event_espresso' ), ucwords($this->label['singular']) , $wrapper_template ) );
+		if ( ! is_readable($wrapper_template))
+			throw new EE_Error(sprintf(__('Unable to access the template file for the %s messenger main content wrapper.  The location being attempted is %s.', 'event_espresso'), ucwords($this->label['singular']), $wrapper_template));
 
 		//add message type to template args
 		$this->_template_args['message_type'] = $this->_incoming_message_type;
 
 		//require template helper
-		EE_Registry::instance()->load_helper( 'Template' );
-		return EEH_Template::display_template( $wrapper_template, $this->_template_args, TRUE );
+		EE_Registry::instance()->load_helper('Template');
+		return EEH_Template::display_template($wrapper_template, $this->_template_args, TRUE);
 	}
 
 
@@ -728,7 +728,7 @@ 
 	 */
 	public function get_existing_test_settings() {
 		$settings = EEH_MSG_Template::get_active_messengers_in_db();
-		return isset( $settings[$this->name]['test_settings'] ) ? $settings[$this->name]['test_settings'] : array();
+		return isset($settings[$this->name]['test_settings']) ? $settings[$this->name]['test_settings'] : array();
 	}
 
 
@@ -739,10 +739,10 @@ 
 	 * @access public
 	 * @return bool 	success/fail
 	 */
-	public function set_existing_test_settings( $settings ) {
+	public function set_existing_test_settings($settings) {
 		$existing = EEH_MSG_Template::get_active_messengers_in_db();
 		$existing[$this->name]['test_settings'] = $settings;
-		return EEH_MSG_Template::update_active_messengers_in_db( $existing );
+		return EEH_MSG_Template::update_active_messengers_in_db($existing);
 	}
 
 
@@ -755,21 +755,21 @@ 
 	 * @param string $field The field to retrieve the label for
 	 * @return string        	  The label
 	 */
-	public function get_field_label( $field ) {
+	public function get_field_label($field) {
 		//first let's see if the field requests is in the top level array.
-		if ( isset( $this->_template_fields[$field] ) && !empty( $this->_template_fields[$field]['label'] ) )
+		if (isset($this->_template_fields[$field]) && ! empty($this->_template_fields[$field]['label']))
 			return $this->_template[$field]['label'];
 
 		//nope so let's look in the extra array to see if it's there HOWEVER if the field exists as a top level index in the extra array then we know the label is in the 'main' index.
-		if ( isset( $this->_template_fields['extra'] ) && !empty( $this->_template_fields['extra'][$field] ) && !empty( $this->_template_fields['extra'][$field]['main']['label'] )  )
+		if (isset($this->_template_fields['extra']) && ! empty($this->_template_fields['extra'][$field]) && ! empty($this->_template_fields['extra'][$field]['main']['label']))
 			return $this->_template_fields['extra'][$field]['main']['label'];
 
 		//now it's possible this field may just be existing in any of the extra array items.
-		if ( !empty( $this->_template_fields['extra'] ) && is_array( $this->_template_fields['extra'] ) ) {
-			foreach ( $this->_template_fields['extra'] as $main_field => $subfields ) {
-				if ( !is_array( $subfields ) )
+		if ( ! empty($this->_template_fields['extra']) && is_array($this->_template_fields['extra'])) {
+			foreach ($this->_template_fields['extra'] as $main_field => $subfields) {
+				if ( ! is_array($subfields))
 					continue;
-				if ( isset( $subfields[$field] ) && !empty( $subfields[$field]['label'] ) )
+				if (isset($subfields[$field]) && ! empty($subfields[$field]['label']))
 					return $subfields[$field]['label'];
 			}
 		}
@@ -790,7 +790,7 @@ 
 	 *
 	 * @return void
 	 */
-	public function do_secondary_messenger_hooks( $sending_messenger_name ) {
+	public function do_secondary_messenger_hooks($sending_messenger_name) {
 		return;
 	}
 

Braces +26 added lines, -17 removed lines

@@ -1,6 +1,7 @@ 
 <?php
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if (!defined('EVENT_ESPRESSO_VERSION') ) {
 	exit('NO direct script access allowed');
+}
 
 /**
  * Event Espresso
@@ -495,8 +496,9 @@ 
 				continue;
 			}
 			$mtp_obj->admin_registered_pages = (array) $mtp_obj->admin_registered_pages;
-			if ( ! in_array( 'events_edit', $mtp_obj->admin_registered_pages ) )
-				continue;
+			if ( ! in_array( 'events_edit', $mtp_obj->admin_registered_pages ) ) {
+							continue;
+			}
 			$stargs = array();
 			$default_value = '';
 			$select_values = array();
@@ -648,8 +650,9 @@ 
 	 * @throws \EE_Error
 	 */
 	protected function _validate_and_setup( $message ) {
-		if ( !is_object( $message ) )
-			throw new EE_Error( __('Incoming "$message" must be an object', 'event_espresso' ) );
+		if ( !is_object( $message ) ) {
+					throw new EE_Error( __('Incoming "$message" must be an object', 'event_espresso' ) );
+		}
 
 		//verify we have the required template pack value on the $message object.
 		if ( empty( $message->template_pack ) || ! $message->template_pack instanceof EE_Messages_Template_Pack ) {
@@ -663,8 +666,9 @@ 
 		$template_fields = $this->get_template_fields();
 
 		foreach ( $template_fields as $template => $value ) {
-			if ( $template !== 'extra' )
-				$this->_set_template_value($template, $message->{$template});
+			if ( $template !== 'extra' ) {
+							$this->_set_template_value($template, $message->{$template});
+			}
 		}
 	}
 
@@ -684,8 +688,9 @@ 
 		$wrapper_template = $this->_tmp_pack->get_wrapper( $this->name, $type );
 
 		//check file exists and is readable
-		if ( !is_readable( $wrapper_template ) )
-			throw new EE_Error( sprintf( __('Unable to access the template file for the %s messenger main content wrapper.  The location being attempted is %s.', 'event_espresso' ), ucwords($this->label['singular']) , $wrapper_template ) );
+		if ( !is_readable( $wrapper_template ) ) {
+					throw new EE_Error( sprintf( __('Unable to access the template file for the %s messenger main content wrapper.  The location being attempted is %s.', 'event_espresso' ), ucwords($this->label['singular']) , $wrapper_template ) );
+		}
 
 		//add message type to template args
 		$this->_template_args['message_type'] = $this->_incoming_message_type;
@@ -757,20 +762,24 @@ 
 	 */
 	public function get_field_label( $field ) {
 		//first let's see if the field requests is in the top level array.
-		if ( isset( $this->_template_fields[$field] ) && !empty( $this->_template_fields[$field]['label'] ) )
-			return $this->_template[$field]['label'];
+		if ( isset( $this->_template_fields[$field] ) && !empty( $this->_template_fields[$field]['label'] ) ) {
+					return $this->_template[$field]['label'];
+		}
 
 		//nope so let's look in the extra array to see if it's there HOWEVER if the field exists as a top level index in the extra array then we know the label is in the 'main' index.
-		if ( isset( $this->_template_fields['extra'] ) && !empty( $this->_template_fields['extra'][$field] ) && !empty( $this->_template_fields['extra'][$field]['main']['label'] )  )
-			return $this->_template_fields['extra'][$field]['main']['label'];
+		if ( isset( $this->_template_fields['extra'] ) && !empty( $this->_template_fields['extra'][$field] ) && !empty( $this->_template_fields['extra'][$field]['main']['label'] )  ) {
+					return $this->_template_fields['extra'][$field]['main']['label'];
+		}
 
 		//now it's possible this field may just be existing in any of the extra array items.
 		if ( !empty( $this->_template_fields['extra'] ) && is_array( $this->_template_fields['extra'] ) ) {
 			foreach ( $this->_template_fields['extra'] as $main_field => $subfields ) {
-				if ( !is_array( $subfields ) )
-					continue;
-				if ( isset( $subfields[$field] ) && !empty( $subfields[$field]['label'] ) )
-					return $subfields[$field]['label'];
+				if ( !is_array( $subfields ) ) {
+									continue;
+				}
+				if ( isset( $subfields[$field] ) && !empty( $subfields[$field]['label'] ) ) {
+									return $subfields[$field]['label'];
+				}
 			}
 		}
 

core/libraries/rest_api/changes/Changes_In_4_8_33.php

Spacing +7 added lines, -7 removed lines

@@ -13,13 +13,13 @@ 
 		//is for lower than 4.8.33
 		add_filter( 
 			'FHEE__EED_Core_Rest_Api___register_rpc_routes__this_versions_routes',
-			array( $this, 'remove_checkin_routes_earlier_than_4_8_33' ),
+			array($this, 'remove_checkin_routes_earlier_than_4_8_33'),
 			10,
 			2
 		);
 		add_filter( 
 			'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_headers_from_ee_notices__return',
-			array( $this, 'dont_add_headers_from_ee_notices' ),
+			array($this, 'dont_add_headers_from_ee_notices'),
 			10,
 			2
 		);
@@ -32,9 +32,9 @@ 
 	 * @param string $version
 	 * @return array like $routes_on_this_version
 	 */
-	public function remove_checkin_routes_earlier_than_4_8_33( $routes_on_this_version, $version ) {
-		if( $this->applies_to_version(  $version ) ) {
-			unset( $routes_on_this_version[ 'registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)' ] );
+	public function remove_checkin_routes_earlier_than_4_8_33($routes_on_this_version, $version) {
+		if ($this->applies_to_version($version)) {
+			unset($routes_on_this_version['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)']);
 		}
 		return $routes_on_this_version;
 	}
@@ -45,8 +45,8 @@ 
 	 * @param string $requested_version
 	 * @return array
 	 */
-	public function dont_add_headers_from_ee_notices( $headers_from_ee_notices, $requested_version ) {
-		if( $this->applies_to_version(  $requested_version ) ) {
+	public function dont_add_headers_from_ee_notices($headers_from_ee_notices, $requested_version) {
+		if ($this->applies_to_version($requested_version)) {
 			return array();
 		}
 		return $headers_from_ee_notices;

core/libraries/rest_api/changes/Changes_In_Base.php

Spacing +8 added lines, -8 removed lines

@@ -56,8 +56,8 @@ 
 	 * @return boolean true: this class' name indicates its filters and actions
 	 * should take effect. False: this class' name indicates it shouldn't do anything
 	 */
-	public function applies_to_version( $requested_version ) {
-		if( $this->version() > $requested_version ) {
+	public function applies_to_version($requested_version) {
+		if ($this->version() > $requested_version) {
 			return true;
 		}
 		return false;
@@ -71,24 +71,24 @@ 
 	 * @throws \EE_Error
 	 */
 	public function version() {
-		if( $this->_version === null ) {
+		if ($this->_version === null) {
 			$matches = array();
 			$regex = '~Changes_In_(.*)_(.*)_(.*)$~';
 			$success = preg_match(
 				$regex,
-				get_class( $this ),
+				get_class($this),
 				$matches
 			);
-			if( ! $success ) {
+			if ( ! $success) {
 				throw new \EE_Error(
 					sprintf(
-						__( 'The class %1$s was misnamed. It name should match the regex "%2$s"', 'event_espresso' ),
-						get_class( $this ),
+						__('The class %1$s was misnamed. It name should match the regex "%2$s"', 'event_espresso'),
+						get_class($this),
 						$regex
 					)
 				);
 			}
-			$this->_version = $matches[1] . '.' . $matches[2] . '.' . $matches[3];
+			$this->_version = $matches[1].'.'.$matches[2].'.'.$matches[3];
 		}
 		return $this->_version;
 	}

core/libraries/rest_api/controllers/rpc/Checkin.php

Spacing +24 added lines, -24 removed lines

@@ -2,8 +2,8 @@ 
 use EventEspresso\core\libraries\rest_api\controllers\Base as Base;
 use EventEspresso\core\libraries\rest_api\controllers\model\Read;
 
-if ( !defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 /**
@@ -24,9 +24,9 @@ 
 	 * @param \WP_REST_Request $request
 	 * @return \WP_Error|\WP_REST_Response
 	 */
-	public static function handle_request_toggle_checkin( \WP_REST_Request $request ) {
+	public static function handle_request_toggle_checkin(\WP_REST_Request $request) {
 		$controller = new Checkin();
-		return $controller->_create_checkin_checkout_object( $request );
+		return $controller->_create_checkin_checkout_object($request);
 	}
 
 
@@ -37,47 +37,47 @@ 
 	 * @param \WP_REST_Request $request
 	 * @return \WP_Error|\WP_REST_Response
 	 */
-	protected function _create_checkin_checkout_object( \WP_REST_Request $request ) {
-		$reg_id = $request->get_param( 'REG_ID' );
-		$dtt_id = $request->get_param( 'DTT_ID' );
-		$force = $request->get_param( 'force' );
-		if( $force == 'true' ) {
+	protected function _create_checkin_checkout_object(\WP_REST_Request $request) {
+		$reg_id = $request->get_param('REG_ID');
+		$dtt_id = $request->get_param('DTT_ID');
+		$force = $request->get_param('force');
+		if ($force == 'true') {
 			$force = true;
 		} else {
 			$force = false;
 		}
-		$reg = \EEM_Registration::instance()->get_one_by_ID( $reg_id );
-		if( ! $reg instanceof \EE_Registration ) {
+		$reg = \EEM_Registration::instance()->get_one_by_ID($reg_id);
+		if ( ! $reg instanceof \EE_Registration) {
 			return $this->send_response(
 				new \WP_Error(
 					'rest_registration_toggle_checkin_invalid_id',
 					sprintf(
-						__( 'You cannot checkin registration with ID %1$s because it doesn\'t exist.', 'event_espresso' ),
+						__('You cannot checkin registration with ID %1$s because it doesn\'t exist.', 'event_espresso'),
 						$reg_id
 					),
-					array( 'status' => 422 )
+					array('status' => 422)
 				)
 			);
 		}
-		if( ! \EE_Capabilities::instance()->current_user_can( 'ee_edit_checkin', 'rest_api_checkin_endpoint', $reg_id ) ) {
+		if ( ! \EE_Capabilities::instance()->current_user_can('ee_edit_checkin', 'rest_api_checkin_endpoint', $reg_id)) {
 			return $this->send_response(
 				new \WP_Error(
 					'rest_user_cannot_toggle_checkin',
 					sprintf(
-						__( 'You are not allowed to checkin registration with ID %1$s.', 'event_espresso' ),
+						__('You are not allowed to checkin registration with ID %1$s.', 'event_espresso'),
 						$reg_id
 					),
-					array( 'status' => 403 )
+					array('status' => 403)
 				)
 			);
 		}
-		$success = $reg->toggle_checkin_status( $dtt_id, ! $force );
-		if( $success === false ) {
+		$success = $reg->toggle_checkin_status($dtt_id, ! $force);
+		if ($success === false) {
 			//rely on EE_Error::add_error messages to have been added to give more data about hwy it failed
 			return $this->send_response(
 				new \WP_Error(
 					'rest_toggle_checkin_failed',
-					__( 'Registration checkin failed. Please see additional error data.', 'event_espresso' )
+					__('Registration checkin failed. Please see additional error data.', 'event_espresso')
 				)
 			);
 		}
@@ -92,28 +92,28 @@ 
 				)
 			)
 		);
-		if( ! $checkin instanceof \EE_Checkin ) {
+		if ( ! $checkin instanceof \EE_Checkin) {
 			return $this->send_response(
 				new \WP_Error(
 					'rest_toggle_checkin_error',
 					sprintf(
-						__( 'Supposedly we created a new checkin object for registration %1$s at datetime %2$s, but we can\'t find it.', 'event_espresso' ),
+						__('Supposedly we created a new checkin object for registration %1$s at datetime %2$s, but we can\'t find it.', 'event_espresso'),
 						$reg_id,
 						$dtt_id
 					)
 				)
 			);
 		}
-		$requested_version = $this->get_requested_version( $request->get_route() );
+		$requested_version = $this->get_requested_version($request->get_route());
 		$get_request = new \WP_REST_Request(
 			'GET',
-			\EED_Core_Rest_Api::ee_api_namespace . $requested_version . '/checkins/' . $checkin->ID()
+			\EED_Core_Rest_Api::ee_api_namespace.$requested_version.'/checkins/'.$checkin->ID()
 		);
 		$get_request->set_url_params(
 			array(
 				'id' => $checkin->ID()
 			)
 		);
-		return Read::handle_request_get_one( $get_request );
+		return Read::handle_request_get_one($get_request);
 	}
 }
\ No newline at end of file

core/middleware/EE_Recommended_Versions.core.php

Spacing +27 added lines, -27 removed lines

@@ -22,35 +22,35 @@ 
 	 * @param 	EE_Response $response
 	 * @return 	EE_Response
 	 */
-	public function handle_request( EE_Request $request, EE_Response $response ) {
+	public function handle_request(EE_Request $request, EE_Response $response) {
 		$this->_request = $request;
 		$this->_response = $response;
 		//$this->_response->add_output( "\n\t IN >>  " . __CLASS__ );
 		//$this->_response->set_notice( 1, 'hey look at this' );
 		// check required WP version
-		if ( ! $this->_minimum_wp_version_required() ) {
-			$this->_request->un_set( 'activate', true );
-			add_action( 'admin_notices', array( $this, 'minimum_wp_version_error' ), 1 );
+		if ( ! $this->_minimum_wp_version_required()) {
+			$this->_request->un_set('activate', true);
+			add_action('admin_notices', array($this, 'minimum_wp_version_error'), 1);
 			//$this->_response->add_output( "\n<br />" . 'minimum_wp_version_error' );
 			$this->_response->terminate_request();
 		}
 		// check required PHP version
-		if ( ! $this->_minimum_php_version_required() ) {
-			$this->_request->un_set( 'activate', true );
-			add_action( 'admin_notices', array( $this, 'minimum_php_version_error' ), 1 );
+		if ( ! $this->_minimum_php_version_required()) {
+			$this->_request->un_set('activate', true);
+			add_action('admin_notices', array($this, 'minimum_php_version_error'), 1);
 			//$this->_response->add_output( "\n<br />" . 'minimum_php_version_error' );
 			$this->_response->terminate_request();
 		}
 		// check recommended WP version
-		if ( ! $this->_minimum_wp_version_recommended() ) {
+		if ( ! $this->_minimum_wp_version_recommended()) {
 			$this->_display_minimum_recommended_wp_version_notice();
 		}
 		// check recommended PHP version
-		if ( ! $this->_minimum_php_version_recommended() ) {
+		if ( ! $this->_minimum_php_version_recommended()) {
 			$this->_display_minimum_recommended_php_version_notice();
 		}
 		$this->_test_for_php_version_7();
-		$this->_response = $this->process_request_stack( $this->_request, $this->_response );
+		$this->_response = $this->process_request_stack($this->_request, $this->_response);
 		//$this->_response->add_output( "\n\t OUT << " . __CLASS__ );
 		return $this->_response;
 	}
@@ -64,9 +64,9 @@ 
 	 * @param string $min_version
 	 * @return boolean
 	 */
-	private function _check_wp_version( $min_version = EE_MIN_WP_VER_REQUIRED ) {
+	private function _check_wp_version($min_version = EE_MIN_WP_VER_REQUIRED) {
 		global $wp_version;
-		return version_compare( $wp_version, $min_version, '>=' ) ? true : false;
+		return version_compare($wp_version, $min_version, '>=') ? true : false;
 	}
 
 
@@ -78,7 +78,7 @@ 
 	 * @return boolean
 	 */
 	private function _minimum_wp_version_required() {
-		return $this->_check_wp_version( EE_MIN_WP_VER_REQUIRED );
+		return $this->_check_wp_version(EE_MIN_WP_VER_REQUIRED);
 	}
 
 
@@ -90,7 +90,7 @@ 
 	 * @return boolean
 	 */
 	private function _minimum_wp_version_recommended() {
-		return $this->_check_wp_version( EE_MIN_WP_VER_RECOMMENDED );
+		return $this->_check_wp_version(EE_MIN_WP_VER_RECOMMENDED);
 	}
 
 
@@ -102,8 +102,8 @@ 
 	 * @param string $min_version
 	 * @return boolean
 	 */
-	private function _check_php_version( $min_version = EE_MIN_PHP_VER_RECOMMENDED ) {
-		return version_compare( PHP_VERSION, $min_version, '>=' ) ? true : false;
+	private function _check_php_version($min_version = EE_MIN_PHP_VER_RECOMMENDED) {
+		return version_compare(PHP_VERSION, $min_version, '>=') ? true : false;
 	}
 
 
@@ -115,7 +115,7 @@ 
 	 * @return boolean
 	 */
 	private function _minimum_php_version_required() {
-		return $this->_check_php_version( EE_MIN_PHP_VER_REQUIRED );
+		return $this->_check_php_version(EE_MIN_PHP_VER_REQUIRED);
 	}
 
 
@@ -127,7 +127,7 @@ 
 	 * @return boolean
 	 */
 	private function _minimum_php_version_recommended() {
-		return $this->_check_php_version( EE_MIN_PHP_VER_RECOMMENDED );
+		return $this->_check_php_version(EE_MIN_PHP_VER_RECOMMENDED);
 	}
 
 
@@ -144,7 +144,7 @@ 
 			<p>
 				<?php
 				printf(
-					__( 'We\'re sorry, but Event Espresso requires WordPress version %1$s or greater in order to operate. You are currently running version %2$s.%3$sFor information on how to update your version of WordPress, please go to %4$s.', 'event_espresso' ),
+					__('We\'re sorry, but Event Espresso requires WordPress version %1$s or greater in order to operate. You are currently running version %2$s.%3$sFor information on how to update your version of WordPress, please go to %4$s.', 'event_espresso'),
 					EE_MIN_WP_VER_REQUIRED,
 					$wp_version,
 					'<br/>',
@@ -169,7 +169,7 @@ 
 			<p>
 				<?php
 				printf(
-					__( 'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.', 'event_espresso' ),
+					__('We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.', 'event_espresso'),
 					EE_MIN_PHP_VER_REQUIRED,
 					PHP_VERSION,
 					'<br/>',
@@ -192,9 +192,9 @@ 
 	private function _display_minimum_recommended_wp_version_notice() {
 		global $wp_version;
 		EE_Error::add_persistent_admin_notice(
-			'wp_version_' . str_replace( '.', '-', EE_MIN_WP_VER_RECOMMENDED ) . '_recommended',
+			'wp_version_'.str_replace('.', '-', EE_MIN_WP_VER_RECOMMENDED).'_recommended',
 			sprintf(
-				__( 'Event Espresso recommends WordPress version %1$s or greater in order for everything to operate properly. You are currently running version %2$s.%3$sFor information on how to update your version of WordPress, please go to %4$s.', 'event_espresso' ),
+				__('Event Espresso recommends WordPress version %1$s or greater in order for everything to operate properly. You are currently running version %2$s.%3$sFor information on how to update your version of WordPress, please go to %4$s.', 'event_espresso'),
 				EE_MIN_WP_VER_RECOMMENDED,
 				$wp_version,
 				'<br/>',
@@ -213,9 +213,9 @@ 
 	 */
 	private function _display_minimum_recommended_php_version_notice() {
 		EE_Error::add_persistent_admin_notice(
-			'php_version_' . str_replace( '.', '-', EE_MIN_PHP_VER_RECOMMENDED ) . '_recommended',
+			'php_version_'.str_replace('.', '-', EE_MIN_PHP_VER_RECOMMENDED).'_recommended',
 			sprintf(
-				__( 'Event Espresso recommends PHP version %1$s or greater for optimal performance. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.', 'event_espresso' ),
+				__('Event Espresso recommends PHP version %1$s or greater for optimal performance. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.', 'event_espresso'),
 				EE_MIN_PHP_VER_RECOMMENDED,
 				PHP_VERSION,
 				'<br/>',
@@ -232,10 +232,10 @@ 
 	 * @access private
 	 */
 	private function _test_for_php_version_7() {
-		if ( $this->_check_php_version( '7' ) ) {
-			define( 'EE_PHP_7', true );
+		if ($this->_check_php_version('7')) {
+			define('EE_PHP_7', true);
 		} else {
-			define( 'EE_PHP_7', false );
+			define('EE_PHP_7', false);
 		}
 	}
 

modules/core_rest_api/EED_Core_Rest_Api.module.php

Spacing +82 added lines, -82 removed lines

@@ -1,6 +1,6 @@ 
 <?php
-if ( !defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 /**
@@ -27,7 +27,7 @@ 
 	 * @return EED_Core_Rest_Api
 	 */
 	public static function instance() {
-		return parent::get_instance( __CLASS__ );
+		return parent::get_instance(__CLASS__);
 	}
 
 
@@ -57,10 +57,10 @@ 
 
 
 	public static function set_hooks_both() {
-		add_action( 'rest_api_init', array( 'EED_Core_Rest_Api', 'register_routes' ), 10 );
-		add_action( 'rest_api_init', array( 'EED_Core_Rest_Api', 'set_hooks_rest_api' ), 5 );
-		add_filter( 'rest_route_data', array( 'EED_Core_Rest_Api', 'hide_old_endpoints' ), 10, 2 );
-		add_filter( 'rest_index', array( 'EventEspresso\core\libraries\rest_api\controllers\model\Meta', 'filter_ee_metadata_into_index' ) );
+		add_action('rest_api_init', array('EED_Core_Rest_Api', 'register_routes'), 10);
+		add_action('rest_api_init', array('EED_Core_Rest_Api', 'set_hooks_rest_api'), 5);
+		add_filter('rest_route_data', array('EED_Core_Rest_Api', 'hide_old_endpoints'), 10, 2);
+		add_filter('rest_index', array('EventEspresso\core\libraries\rest_api\controllers\model\Meta', 'filter_ee_metadata_into_index'));
 	}
 
 	/**
@@ -73,16 +73,16 @@ 
 	}
 
 	protected static function _set_hooks_for_changes() {
-		$folder_contents = EEH_File::get_contents_of_folders( array( EE_LIBRARIES . 'rest_api' . DS . 'changes' ), false );
-		foreach( $folder_contents as $classname_in_namespace => $filepath ) {
+		$folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES.'rest_api'.DS.'changes'), false);
+		foreach ($folder_contents as $classname_in_namespace => $filepath) {
 			//ignore the base parent class
-			if( $classname_in_namespace === 'Changes_In_Base' ) {
+			if ($classname_in_namespace === 'Changes_In_Base') {
 				continue;
 			}
-			$full_classname = 'EventEspresso\core\libraries\rest_api\changes\\' . $classname_in_namespace;
-			if ( class_exists( $full_classname )) {
+			$full_classname = 'EventEspresso\core\libraries\rest_api\changes\\'.$classname_in_namespace;
+			if (class_exists($full_classname)) {
 				$instance_of_class = new $full_classname;
-				if ( $instance_of_class instanceof EventEspresso\core\libraries\rest_api\changes\Changes_In_Base ) {
+				if ($instance_of_class instanceof EventEspresso\core\libraries\rest_api\changes\Changes_In_Base) {
 					$instance_of_class->set_hooks();
 				}
 			}
@@ -95,16 +95,16 @@ 
 	 * so we actually prefer to only do it when an EE plugin is activated or upgraded
 	 */
 	public static function register_routes() {
-		foreach( EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls ) {
-			foreach( $relative_urls as $endpoint => $routes ) {
-				foreach( $routes as $route ) {
+		foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls) {
+			foreach ($relative_urls as $endpoint => $routes) {
+				foreach ($routes as $route) {
 					register_rest_route(
 						$namespace,
 						$endpoint,
 						array(
-							'callback' => $route[ 'callback' ],
-							'methods' => $route[ 'methods' ],
-							'args' => isset( $route[ 'args' ] ) ? $route[ 'args' ] : array(),
+							'callback' => $route['callback'],
+							'methods' => $route['methods'],
+							'args' => isset($route['args']) ? $route['args'] : array(),
 						)
 					);
 				}
@@ -121,10 +121,10 @@ 
 	 * }
 	 */
 	public static function get_ee_route_data() {
-		$ee_routes = get_option( self::saved_routes_option_names, null );
-		if( ! $ee_routes || ( defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE )){
+		$ee_routes = get_option(self::saved_routes_option_names, null);
+		if ( ! $ee_routes || (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE)) {
 			self::save_ee_routes();
-			$ee_routes = get_option( self::saved_routes_option_names, array() );
+			$ee_routes = get_option(self::saved_routes_option_names, array());
 		}
 		return $ee_routes;
 	}
@@ -135,7 +135,7 @@ 
 	 * @return void
 	 */
 	public static function save_ee_routes() {
-		if( EE_Maintenance_Mode::instance()->models_can_query() ){
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
 			$instance = self::instance();
 			$routes = apply_filters(
 				'EED_Core_Rest_Api__save_ee_routes__routes',
@@ -146,7 +146,7 @@ 
 					$instance->_register_rpc_routes()
 				)
 			);
-			update_option( self::saved_routes_option_names, $routes, true );
+			update_option(self::saved_routes_option_names, $routes, true);
 		}
 	}
 
@@ -155,7 +155,7 @@ 
 	 * @return array @see get_ee_route_data
 	 */
 	protected function _register_model_routes() {
-		EE_Registry::instance()->load_helper( 'Inflector' );
+		EE_Registry::instance()->load_helper('Inflector');
 		$models_to_register = apply_filters(
 			'FHEE__EED_Core_REST_API___register_model_routes',
 			EE_Registry::instance()->non_abstract_db_models
@@ -164,23 +164,23 @@ 
 		unset($models_to_register['Extra_Meta']);
 		unset($models_to_register['Extra_Join']);
 		$model_routes = array( );
-		foreach( self::versions_served() as $version => $hidden_endpoint ) {
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
 
-			foreach ( $models_to_register as $model_name => $model_classname ) {
+			foreach ($models_to_register as $model_name => $model_classname) {
 				//yes we could just register one route for ALL models, but then they wouldn't show up in the index
-				$ee_namespace = self::ee_api_namespace . $version;
-				$plural_model_route = EEH_Inflector::pluralize_and_lower( $model_name );
-				$singular_model_route = $plural_model_route . '/(?P<id>\d+)' ;
-				$model_routes[ $ee_namespace ][ $plural_model_route ] = array(
+				$ee_namespace = self::ee_api_namespace.$version;
+				$plural_model_route = EEH_Inflector::pluralize_and_lower($model_name);
+				$singular_model_route = $plural_model_route.'/(?P<id>\d+)';
+				$model_routes[$ee_namespace][$plural_model_route] = array(
 						array(
 							'callback' => array(
 								'EventEspresso\core\libraries\rest_api\controllers\model\Read',
 								'handle_request_get_all' ),
 							'methods' => WP_REST_Server::READABLE,
 							'hidden_endpoint' => $hidden_endpoint,
-							'args' => $this->_get_read_query_params( $model_name ),
+							'args' => $this->_get_read_query_params($model_name),
 							'_links' => array(
-								'self' => rest_url( $ee_namespace . $singular_model_route ),
+								'self' => rest_url($ee_namespace.$singular_model_route),
 							)
 						),
 //						array(
@@ -191,7 +191,7 @@ 
 //							'hidden_endpoint' => $hidden_endpoint
 //						)
 					);
-				$model_routes[ $ee_namespace ][ $singular_model_route ] = array(
+				$model_routes[$ee_namespace][$singular_model_route] = array(
 						array(
 							'callback' => array(
 								'EventEspresso\core\libraries\rest_api\controllers\model\Read',
@@ -202,7 +202,7 @@ 
 								'include' => array(
 									'required' => false,
 									'default' => '*',
-									'description' => __( 'See http://developer.eventespresso.com/docs/ee4-rest-api-reading/#Including_Specific_Fields_and_Related_Entities_in_Results for documentation', 'event_espresso' ),
+									'description' => __('See http://developer.eventespresso.com/docs/ee4-rest-api-reading/#Including_Specific_Fields_and_Related_Entities_in_Results for documentation', 'event_espresso'),
 								),
 							)
 						),
@@ -215,20 +215,20 @@ 
 //							),
 				);
 				//@todo: also handle  DELETE for a single item
-				$model = EE_Registry::instance()->load_model( $model_classname );
-				foreach ( $model->relation_settings() as $relation_name => $relation_obj ) {
+				$model = EE_Registry::instance()->load_model($model_classname);
+				foreach ($model->relation_settings() as $relation_name => $relation_obj) {
 					$related_model_name_endpoint_part = EventEspresso\core\libraries\rest_api\controllers\model\Read::get_related_entity_name(
 						$relation_name,
 						$relation_obj
 					);
-					$model_routes[ $ee_namespace ][ $singular_model_route . '/' . $related_model_name_endpoint_part ] = array(
+					$model_routes[$ee_namespace][$singular_model_route.'/'.$related_model_name_endpoint_part] = array(
 							array(
 								'callback' => array(
 									'EventEspresso\core\libraries\rest_api\controllers\model\Read',
 									'handle_request_get_related' ),
 								'methods' => WP_REST_Server::READABLE,
 								'hidden_endpoint' => $hidden_endpoint,
-								'args' => $this->_get_read_query_params( $relation_name ),
+								'args' => $this->_get_read_query_params($relation_name),
 							),
 //							array(
 //								'callback' => array(
@@ -252,11 +252,11 @@ 
 	 */
 	protected function _register_rpc_routes() {
 		$routes = array();
-		foreach( self::versions_served() as $version => $hidden_endpoint ) {
-			$ee_namespace = self::ee_api_namespace . $version;
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$ee_namespace = self::ee_api_namespace.$version;
 			$this_versions_routes = array();
 			//checkin endpoint
-			$this_versions_routes[ 'registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)' ] = array(
+			$this_versions_routes['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)'] = array(
 				array(
 					'callback' => array(
 						'EventEspresso\core\libraries\rest_api\controllers\rpc\Checkin',
@@ -267,12 +267,12 @@ 
 						'force' => array(
 							'required' => false,
 							'default' => false,
-							'description' => __( 'Whether to force toggle checkin, or to verify the registration status and allowed ticket uses', 'event_espresso' )
+							'description' => __('Whether to force toggle checkin, or to verify the registration status and allowed ticket uses', 'event_espresso')
 						)
 					)
 				)
 			);
-			$routes[ $ee_namespace ] = apply_filters(
+			$routes[$ee_namespace] = apply_filters(
 				'FHEE__EED_Core_Rest_Api___register_rpc_routes__this_versions_routes',
 				$this_versions_routes,
 				$version,
@@ -287,47 +287,47 @@ 
 	 * @param string $model_name eg 'Event' or 'Venue'
 	 * @return array describing the args acceptable when querying this model
 	 */
-	protected function _get_read_query_params( $model_name ) {
-		$model = EE_Registry::instance()->load_model( $model_name );
+	protected function _get_read_query_params($model_name) {
+		$model = EE_Registry::instance()->load_model($model_name);
 		$default_orderby = array();
-		foreach( $model->get_combined_primary_key_fields() as $key_field ) {
-			$default_orderby[ $key_field->get_name() ] = 'ASC';
+		foreach ($model->get_combined_primary_key_fields() as $key_field) {
+			$default_orderby[$key_field->get_name()] = 'ASC';
 		}
 		return array(
 			'where' => array(
 				'required' => false,
 				'default' => array(),
-				'description' => __( 'See http://developer.eventespresso.com/docs/ee4-rest-api-reading/#where for documentation', 'event_espresso' ),
+				'description' => __('See http://developer.eventespresso.com/docs/ee4-rest-api-reading/#where for documentation', 'event_espresso'),
 				),
 			'limit' => array(
 				'required' => false,
 				'default' => 50,
-				'description' => __( 'See http://developer.eventespresso.com/docs/ee4-rest-api-reading/#limit for documentation', 'event_espresso' )
+				'description' => __('See http://developer.eventespresso.com/docs/ee4-rest-api-reading/#limit for documentation', 'event_espresso')
 			),
 			'order_by' => array(
 				'required' => false,
 				'default' => $default_orderby,
-				'description' => __( 'See http://developer.eventespresso.com/docs/ee4-rest-api-reading/#order_by for documentation', 'event_espresso' )
+				'description' => __('See http://developer.eventespresso.com/docs/ee4-rest-api-reading/#order_by for documentation', 'event_espresso')
 			),
 			'group_by' => array(
 				'required' => false,
 				'default' => null,
-				'description' => __( 'See http://developer.eventespresso.com/docs/ee4-rest-api-reading/#group_by for documentation', 'event_espresso' )
+				'description' => __('See http://developer.eventespresso.com/docs/ee4-rest-api-reading/#group_by for documentation', 'event_espresso')
 			),
 			'having' => array(
 				'required' => false,
 				'default' => null,
-				'description' => __( 'See http://developer.eventespresso.com/docs/ee4-rest-api-reading/#having for documentation', 'event_espresso' )
+				'description' => __('See http://developer.eventespresso.com/docs/ee4-rest-api-reading/#having for documentation', 'event_espresso')
 			),
 			'caps' => array(
 				'required' => false,
 				'default' => EEM_Base::caps_read,
-				'description' => __( 'See http://developer.eventespresso.com/docs/ee4-rest-api-reading/#caps for documentation', 'event_espresso' )
+				'description' => __('See http://developer.eventespresso.com/docs/ee4-rest-api-reading/#caps for documentation', 'event_espresso')
 			),
 			'include' => array(
 				'required' => false,
 				'default' => '*',
-				'description' => __( 'See http://developer.eventespresso.com/docs/ee4-rest-api-reading/#Including_Specific_Fields_and_Related_Entities_in_Results for documentation', 'event_espresso' ),
+				'description' => __('See http://developer.eventespresso.com/docs/ee4-rest-api-reading/#Including_Specific_Fields_and_Related_Entities_in_Results for documentation', 'event_espresso'),
 			),
 		);
 	}
@@ -338,8 +338,8 @@ 
 	 */
 	protected function _register_config_routes() {
 		$config_routes = array();
-		foreach( self::versions_served() as $version => $hidden_endpoint ) {
-			$config_routes[ self::ee_api_namespace . $version ][ 'config' ] = array(
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$config_routes[self::ee_api_namespace.$version]['config'] = array(
 					array(
 						'callback' => array(
 							'EventEspresso\core\libraries\rest_api\controllers\config\Read',
@@ -358,8 +358,8 @@ 
 	 */
 	protected function _register_meta_routes() {
 		$meta_routes = array();
-		foreach( self::versions_served() as $version => $hidden_endpoint ) {
-			$meta_routes[ self::ee_api_namespace . $version ][ '/resources' ] = array(
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$meta_routes[self::ee_api_namespace.$version]['/resources'] = array(
 				array(
 					'callback' => array(
 						'EventEspresso\core\libraries\rest_api\controllers\model\Meta',
@@ -380,13 +380,13 @@ 
 	 * @param array $route_data
 	 * @return array
 	 */
-	public static function hide_old_endpoints( $route_data ) {
-		foreach( EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls ) {
-			foreach( $relative_urls as $endpoint => $routes ) {
-				foreach( $routes as $route ) {
-					if( $route[ 'hidden_endpoint' ] ) {
-						$full_route = '/' . ltrim( $namespace, '/' ) . '/' . ltrim( $endpoint, '/' );
-						unset( $route_data[ $full_route ] );
+	public static function hide_old_endpoints($route_data) {
+		foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls) {
+			foreach ($relative_urls as $endpoint => $routes) {
+				foreach ($routes as $route) {
+					if ($route['hidden_endpoint']) {
+						$full_route = '/'.ltrim($namespace, '/').'/'.ltrim($endpoint, '/');
+						unset($route_data[$full_route]);
 					}
 				}
 			}
@@ -423,7 +423,7 @@ 
 	 */
 	public static function latest_rest_api_version() {
 		$versions_served = \EED_Core_Rest_Api::versions_served();
-		return end( array_keys( $versions_served ) );
+		return end(array_keys($versions_served));
 	}
 
 	/**
@@ -437,32 +437,32 @@ 
 	public static function versions_served() {
 		$versions_served = array();
 		$possibly_served_versions = EED_Core_Rest_Api::version_compatibilities();
-		$lowest_compatible_version = end( $possibly_served_versions);
-		reset( $possibly_served_versions );
-		$versions_served_historically = array_keys( $possibly_served_versions );
-		$latest_version = end( $versions_served_historically );
-		reset( $versions_served_historically );
+		$lowest_compatible_version = end($possibly_served_versions);
+		reset($possibly_served_versions);
+		$versions_served_historically = array_keys($possibly_served_versions);
+		$latest_version = end($versions_served_historically);
+		reset($versions_served_historically);
 		//for each version of core we have ever served:
-		foreach ( $versions_served_historically as $key_versioned_endpoint ) {
+		foreach ($versions_served_historically as $key_versioned_endpoint) {
 			//if it's not above the current core version, and it's compatible with the current version of core
-			if( $key_versioned_endpoint == $latest_version ) {
+			if ($key_versioned_endpoint == $latest_version) {
 				//don't hide the latest version in the index
-				$versions_served[ $key_versioned_endpoint ] = false;
-			} else if(
+				$versions_served[$key_versioned_endpoint] = false;
+			} else if (
 				$key_versioned_endpoint < EED_Core_Rest_Api::core_version()
 				&& $key_versioned_endpoint >= $lowest_compatible_version
 			) {
 				//include, but hide, previous versions which are still supported
-				$versions_served[ $key_versioned_endpoint ] = true;
-			} elseif(
+				$versions_served[$key_versioned_endpoint] = true;
+			} elseif (
 				apply_filters(
 					'FHEE__EED_Core_Rest_Api__versions_served__include_incompatible_versions',
 					false,
 					$possibly_served_versions
 				)
-			){
+			) {
 				//if a version is no longer supported, don't include it in index or list of versions served
-				$versions_served[ $key_versioned_endpoint ] = true;
+				$versions_served[$key_versioned_endpoint] = true;
 			}
 		}
 		return $versions_served;
@@ -475,7 +475,7 @@ 
 	 * @return string
 	 */
 	public static function core_version() {
-		return apply_filters( 'FHEE__EED_Core_REST_API__core_version', implode('.', array_slice( explode( '.', espresso_version() ), 0, 3 ) ) );
+		return apply_filters('FHEE__EED_Core_REST_API__core_version', implode('.', array_slice(explode('.', espresso_version()), 0, 3)));
 	}
 
 
@@ -487,7 +487,7 @@ 
 	 * @param  WP $WP
 	 * @return    void
 	 */
-	public function run( $WP ) {
+	public function run($WP) {
 
 	}
 

modules/purchasing_agent/EE_Purchasing_Agent.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -46,7 +46,7 @@
 	 *
 	 * @param EE_Form_Section_Proper $attendee_info_reg_form
 	 * @param EE_Checkout            $checkout
-	 * @return string content
+	 * @return EE_Form_Section_Proper content
 	 */
 	public function generate_purchasing_agent_form( EE_Form_Section_Proper $attendee_info_reg_form, EE_Checkout $checkout  ) {
 		static $sync_info_displayed = false;

Indentation +10 added lines, -10 removed lines

@@ -3,16 +3,16 @@
 	exit( 'No direct script access allowed' );
 }
 /**
- * Class EE_Purchasing_Agent
- *
- * Description
- *
- * @package               Event Espresso
- * @subpackage            core
- * @author                Brent Christensen
- * @since                 $VID:$
- *
- */
+	 * Class EE_Purchasing_Agent
+	 *
+	 * Description
+	 *
+	 * @package               Event Espresso
+	 * @subpackage            core
+	 * @author                Brent Christensen
+	 * @since                 $VID:$
+	 *
+	 */
 class EE_Purchasing_Agent {
 
 

Spacing +21 added lines, -21 removed lines

@@ -1,6 +1,6 @@ 
 <?php
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 /**
  * Class EE_Purchasing_Agent
@@ -30,7 +30,7 @@ 
 	 * EE_Purchasing_Agent constructor.
 	 * @param \EE_Attendee $attendee
 	 */
-	public function __construct( EE_Attendee $attendee = null ) {
+	public function __construct(EE_Attendee $attendee = null) {
 		$this->_purchasing_agent = $attendee;
 	}
 
@@ -48,13 +48,13 @@ 
 	 * @param EE_Checkout            $checkout
 	 * @return string content
 	 */
-	public function generate_purchasing_agent_form( EE_Form_Section_Proper $attendee_info_reg_form, EE_Checkout $checkout  ) {
+	public function generate_purchasing_agent_form(EE_Form_Section_Proper $attendee_info_reg_form, EE_Checkout $checkout) {
 		static $sync_info_displayed = false;
-		if ( $sync_info_displayed || $checkout->revisit || $checkout->admin_request ) {
+		if ($sync_info_displayed || $checkout->revisit || $checkout->admin_request) {
 			return $attendee_info_reg_form;
 		}
 		$sync_info_displayed = true;
-		EE_Registry::instance()->load_helper( 'HTML' );
+		EE_Registry::instance()->load_helper('HTML');
 		$attendee_info_reg_form->add_subsections(
 			array(
 				'purchasing_agent' => new EE_Form_Section_Proper(
@@ -64,7 +64,7 @@ 
 						'layout_strategy' => new EE_Div_Per_Section_Layout(),
 						'subsections'     => array(
 							'purchasing_agent_h4'       => new EE_Form_Section_HTML(
-								EEH_HTML::h4( __( 'Purchasing Details.', 'event_espresso' ), '', 'ee-reg-form-qstn-grp-title section-title' )
+								EEH_HTML::h4(__('Purchasing Details.', 'event_espresso'), '', 'ee-reg-form-qstn-grp-title section-title')
 							),
 							'select_input'              => $this->_purchasing_agent_input(),
 							'attendee_sync_info_notice' => $this->_attendee_sync_info_notice(),
@@ -88,8 +88,8 @@ 
 	protected function _purchasing_agent_input() {
 		return new EE_Select_Input(
 			array(
-				'attendee' => __( 'Myself and maybe others: All information entered in the Attendee 1 box below will be mine.', 'event_espresso' ),
-				'separate' => __( 'People other than myself: All information entered in the Attendee boxes below is for others.', 'event_espresso' ),
+				'attendee' => __('Myself and maybe others: All information entered in the Attendee 1 box below will be mine.', 'event_espresso'),
+				'separate' => __('People other than myself: All information entered in the Attendee boxes below is for others.', 'event_espresso'),
 			),
 			array(
 				'html_name'        => 'ee_reg_qstn[purchasing_agent]',
@@ -98,7 +98,7 @@ 
 				'required'         => true,
 				'html_label_id'    => 'ee_reg_qstn-purchasing_agent-lbl',
 				'html_label_class' => 'ee-reg-qstn',
-				'html_label_text'  => __( 'I am purchasing tickets for...', 'event_espresso' ),
+				'html_label_text'  => __('I am purchasing tickets for...', 'event_espresso'),
 				'default'          => 'attendee'
 			)
 		);
@@ -117,7 +117,7 @@ 
 		return new EE_Form_Section_HTML(
 			EEH_HTML::div(
 				sprintf(
-					__( '%1$sNote%2$s: If purchasing tickets for yourself, then any changes made to the %1$sPersonal Information%2$s details for Attendee 1 will be synced with your user profile for this site.', 'event_espresso' ),
+					__('%1$sNote%2$s: If purchasing tickets for yourself, then any changes made to the %1$sPersonal Information%2$s details for Attendee 1 will be synced with your user profile for this site.', 'event_espresso'),
 					'<strong>', '</strong>'
 				),
 				'ee-attendee-sync-info-notice-dv',
@@ -136,17 +136,17 @@ 
 	 */
 	public function _purchasing_agent_billing_form() {
 		$billing_form = new EE_Billing_Attendee_Info_Form();
-		if ( $this->_purchasing_agent instanceof EE_Attendee ) {
-			$billing_form->populate_from_attendee( $this->_purchasing_agent );
+		if ($this->_purchasing_agent instanceof EE_Attendee) {
+			$billing_form->populate_from_attendee($this->_purchasing_agent);
 		}
 		return new EE_Form_Section_Proper(
 			array(
 				'layout_strategy' => new EE_Div_Per_Section_Layout(),
 				'subsections'     => array(
 					'frame_open'   => new EE_Form_Section_HTML(
-						EEH_HTML::div( '', '', 'ee-reg-form-qstn-grp-dv' )
+						EEH_HTML::div('', '', 'ee-reg-form-qstn-grp-dv')
 						. EEH_HTML::p(
-							__( 'Please provide and/or confirm the following required information if you are purchasing tickets for others. This information will be synced with your user profile for this site', 'event_espresso' ),
+							__('Please provide and/or confirm the following required information if you are purchasing tickets for others. This information will be synced with your user profile for this site', 'event_espresso'),
 							'',
 							'highlight-bg important-notice'
 						)
@@ -167,13 +167,13 @@ 
 	 * @param array $defined_vars
 	 * @return string
 	 */
-	public function display_purchasing_agent_form( $defined_vars ) {
+	public function display_purchasing_agent_form($defined_vars) {
 		$html = '';
-		if ( isset( $defined_vars[ 'purchasing_agent' ] ) ) {
-			EE_Registry::instance()->load_helper( 'HTML' );
+		if (isset($defined_vars['purchasing_agent'])) {
+			EE_Registry::instance()->load_helper('HTML');
 			$html .= '<fieldset id="ee-purchaser" class="ee-reg-form-attendee-dv" >';
-			$html .= '<legend class="spco-attendee-lgnd smaller-text lt-grey-text">' . __( 'Purchasing Agent', 'event_espresso' ) . '</legend>';
-			$html .= $defined_vars[ 'purchasing_agent' ];
+			$html .= '<legend class="spco-attendee-lgnd smaller-text lt-grey-text">'.__('Purchasing Agent', 'event_espresso').'</legend>';
+			$html .= $defined_vars['purchasing_agent'];
 			$html .= '</fieldset>';
 		}
 		return $html;
@@ -186,7 +186,7 @@ 
 	 * @param array        $valid_data
 	 * @param \EE_Checkout $checkout
 	 */
-	public function process_attendee_information( $valid_data, EE_Checkout $checkout ) {
+	public function process_attendee_information($valid_data, EE_Checkout $checkout) {
 		// to get info / do stuff, we may need/want to hook into other SPCO actions/filters like:
 		// FHEE__EE_SPCO_Reg_Step_Attendee_Information___save_registration_form_input
 		// FHEE__EE_SPCO_Reg_Step_Attendee_Information___associate_attendee_with_registration__attendee  (new filter)

modules/purchasing_agent/EED_Purchasing_Agent.module.php

Doc Comments +1 added lines, -1 removed lines

@@ -168,7 +168,7 @@
 	 *
 	 * @param EE_Form_Section_Proper $attendee_info_reg_form
 	 * @param EE_Checkout            $checkout
-	 * @return string                                content
+	 * @return EE_Form_Section_Proper                                content
 	 */
 	public static function generate_purchasing_agent_form(
 		EE_Form_Section_Proper $attendee_info_reg_form,

Spacing +31 added lines, -31 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 
@@ -35,17 +35,17 @@ 
 		//hook into spco for styles and scripts.
 		add_action(
 			'AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__attendee_information',
-			array( 'EED_Purchasing_Agent', 'enqueue_scripts_styles' )
+			array('EED_Purchasing_Agent', 'enqueue_scripts_styles')
 		);
 		add_filter(
 			'FHEE__EE_SPCO_Reg_Step_Attendee_Information__generate_reg_form__reg_form',
-			array( 'EED_Purchasing_Agent', 'generate_purchasing_agent_form' ),
+			array('EED_Purchasing_Agent', 'generate_purchasing_agent_form'),
 			10,
 			2
 		);
 		add_action(
 			'FHEE__registration_page_attendee_information__before_attendee_panels',
-			array( 'EED_Purchasing_Agent', 'display_purchasing_agent_form' ),
+			array('EED_Purchasing_Agent', 'display_purchasing_agent_form'),
 			10,
 			1
 		);
@@ -58,22 +58,22 @@ 
 	 */
 	public static function set_hooks_admin() {
 		EED_Purchasing_Agent::set_definitions();
-		if ( EE_FRONT_AJAX ) {
+		if (EE_FRONT_AJAX) {
 			add_filter(
 				'FHEE__EE_SPCO_Reg_Step_Attendee_Information__generate_reg_form__reg_form',
-				array( 'EED_Purchasing_Agent', 'generate_purchasing_agent_form' ),
+				array('EED_Purchasing_Agent', 'generate_purchasing_agent_form'),
 				10,
 				2
 			);
 			add_action(
 				'FHEE__registration_page_attendee_information__before_attendee_panels',
-				array( 'EED_Purchasing_Agent', 'display_purchasing_agent_form' ),
+				array('EED_Purchasing_Agent', 'display_purchasing_agent_form'),
 				10,
 				1
 			);
 			add_filter(
 				'FHEE__Single_Page_Checkout___check_form_submission__request_params',
-				array( 'EED_Purchasing_Agent', 'process_attendee_information' ),
+				array('EED_Purchasing_Agent', 'process_attendee_information'),
 				1,
 				2
 			);
@@ -86,15 +86,15 @@ 
 	 * set_definitions
 	 */
 	public static function set_definitions() {
-		define( 'EE_PURCHASING_AGENT_PATH', plugin_dir_path( __FILE__ ) );
-		define( 'EE_PURCHASING_AGENT_URL', plugin_dir_url( __FILE__ ) );
+		define('EE_PURCHASING_AGENT_PATH', plugin_dir_path(__FILE__));
+		define('EE_PURCHASING_AGENT_URL', plugin_dir_url(__FILE__));
 	}
 
 
 	/**
 	 * @param WP $WP
 	 */
-	public function run( $WP ) {
+	public function run($WP) {
 	}
 
 
@@ -107,20 +107,20 @@ 
 		// add some style
 		wp_register_style(
 			'ee_purchasing_agent',
-			EE_PURCHASING_AGENT_URL . 'ee-purchasing-agent.css',
+			EE_PURCHASING_AGENT_URL.'ee-purchasing-agent.css',
 			array(),
 			EVENT_ESPRESSO_VERSION
 		);
-		wp_enqueue_style( 'ee_purchasing_agent' );
+		wp_enqueue_style('ee_purchasing_agent');
 		// and make it dance
 		wp_register_script(
 			'ee_purchasing_agent',
-			EE_PURCHASING_AGENT_URL . 'ee-purchasing-agent.js',
-			array( 'single_page_checkout' ),
+			EE_PURCHASING_AGENT_URL.'ee-purchasing-agent.js',
+			array('single_page_checkout'),
 			EVENT_ESPRESSO_VERSION,
 			true
 		);
-		wp_enqueue_script( 'ee_purchasing_agent' );
+		wp_enqueue_script('ee_purchasing_agent');
 	}
 
 
@@ -129,10 +129,10 @@ 
 	 * @return EventEspresso\modules\purchasing_agent\PurchasingAgentForm
 	 */
 	protected static function _get_purchasing_agent() {
-		if ( ! EED_Purchasing_Agent::$_purchasing_agent instanceof EventEspresso\modules\purchasing_agent\PurchasingAgentForm ) {
-			require( EE_PURCHASING_AGENT_PATH . 'EE_Purchasing_Agent.class.php' );
-			$attendee = EED_Purchasing_Agent::get_attendee_for_user( get_current_user_id() );
-			EED_Purchasing_Agent::$_purchasing_agent = new EventEspresso\modules\purchasing_agent\PurchasingAgentForm( $attendee );
+		if ( ! EED_Purchasing_Agent::$_purchasing_agent instanceof EventEspresso\modules\purchasing_agent\PurchasingAgentForm) {
+			require(EE_PURCHASING_AGENT_PATH.'EE_Purchasing_Agent.class.php');
+			$attendee = EED_Purchasing_Agent::get_attendee_for_user(get_current_user_id());
+			EED_Purchasing_Agent::$_purchasing_agent = new EventEspresso\modules\purchasing_agent\PurchasingAgentForm($attendee);
 		}
 		return EED_Purchasing_Agent::$_purchasing_agent;
 	}
@@ -145,12 +145,12 @@ 
 	 * @param $user_or_id int|\WP_User $mixed $user_or_id can be WP_User or the user_id.
 	 * @return \EE_Attendee
 	 */
-	public static function get_attendee_for_user( $user_or_id ) {
-		$user_id = $user_or_id instanceof WP_User ? $user_or_id->ID : (int)$user_or_id;
-		$attID = get_user_option( 'EE_Attendee_ID', $user_id );
+	public static function get_attendee_for_user($user_or_id) {
+		$user_id = $user_or_id instanceof WP_User ? $user_or_id->ID : (int) $user_or_id;
+		$attID = get_user_option('EE_Attendee_ID', $user_id);
 		$attendee = null;
-		if ( $attID ) {
-			$attendee = EEM_Attendee::instance()->get_one_by_ID( $attID );
+		if ($attID) {
+			$attendee = EEM_Attendee::instance()->get_one_by_ID($attID);
 			$attendee = $attendee instanceof EE_Attendee ? $attendee : null;
 		}
 		return $attendee;
@@ -187,11 +187,11 @@ 
 	 *
 	 * @param array $defined_vars
 	 */
-	public static function display_purchasing_agent_form( $defined_vars ) {
-		if ( ! is_user_logged_in() ) {
+	public static function display_purchasing_agent_form($defined_vars) {
+		if ( ! is_user_logged_in()) {
 			// todo: prompt for login ?
 		}
-		echo EED_Purchasing_Agent::_get_purchasing_agent()->display_purchasing_agent_form( $defined_vars );
+		echo EED_Purchasing_Agent::_get_purchasing_agent()->display_purchasing_agent_form($defined_vars);
 	}
 
 
@@ -202,10 +202,10 @@ 
 	 * @param array $valid_data
 	 * @param \EE_Checkout $checkout
 	 */
-	public static function process_attendee_information( $valid_data, EE_Checkout $checkout ) {
+	public static function process_attendee_information($valid_data, EE_Checkout $checkout) {
 		// collect any other required data from methods in this class,
 		// and pass along to EE_Purchasing_Agent::process_attendee_information() for processing
-		EED_Purchasing_Agent::_get_purchasing_agent()->process_attendee_information( $valid_data, $checkout );
+		EED_Purchasing_Agent::_get_purchasing_agent()->process_attendee_information($valid_data, $checkout);
 	}
 
 

modules/purchasing_agent/PurchasingAgentForm.php

Doc Comments +2 added lines, -2 removed lines

@@ -54,7 +54,7 @@ 
 	 *
 	 * @param \EE_Form_Section_Proper $attendee_info_reg_form
 	 * @param \EE_Checkout            $checkout
-	 * @return string content
+	 * @return \EE_Form_Section_Proper content
 	 */
 	public function generate_purchasing_agent_form(
 		\EE_Form_Section_Proper $attendee_info_reg_form,
@@ -100,7 +100,7 @@ 
 	 *
 	 * displays a dropdown input for selecting the purchasing agent for the TXN
 	 *
-	 * @return \EE_Select_Input
+	 * @return \EE_Radio_Button_Input
 	 */
 	protected function _purchasing_agent_input() {
 		return new \EE_Radio_Button_Input(

Spacing +24 added lines, -24 removed lines

@@ -1,8 +1,8 @@ 
 <?php
 namespace EventEspresso\modules\purchasing_agent;
 
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 
@@ -38,7 +38,7 @@ 
 	 *
 	 * @param \EE_Attendee $attendee
 	 */
-	public function __construct( \EE_Attendee $attendee = null ) {
+	public function __construct(\EE_Attendee $attendee = null) {
 		$this->_purchasing_agent = $attendee;
 	}
 
@@ -61,12 +61,12 @@ 
 		\EE_Checkout $checkout
 	) {
 		static $sync_info_displayed = false;
-		if ( $sync_info_displayed || $checkout->revisit || $checkout->admin_request ) {
+		if ($sync_info_displayed || $checkout->revisit || $checkout->admin_request) {
 			return $attendee_info_reg_form;
 		}
 		//\EEH_Debug_Tools::printr( $attendee_info_reg_form->name(), '$attendee_info_reg_form->name()', __FILE__, __LINE__ );
 		$sync_info_displayed = true;
-		\EE_Registry::instance()->load_helper( 'HTML' );
+		\EE_Registry::instance()->load_helper('HTML');
 		$attendee_info_reg_form->add_subsections(
 			array(
 				'purchasing_agent_form' => new \EE_Form_Section_Proper(
@@ -77,7 +77,7 @@ 
 						'subsections'     => array(
 							'purchasing_agent_h4'       => new \EE_Form_Section_HTML(
 								\EEH_HTML::h4(
-									__( 'Purchasing Details.', 'event_espresso' ),
+									__('Purchasing Details.', 'event_espresso'),
 									'',
 									'ee-reg-form-qstn-grp-title section-title'
 								)
@@ -105,8 +105,8 @@ 
 	protected function _purchasing_agent_input() {
 		return new \EE_Radio_Button_Input(
 			array(
-				'attendee' => __( 'Myself', 'event_espresso' ),
-				'separate' =>  __( 'Others', 'event_espresso' ),
+				'attendee' => __('Myself', 'event_espresso'),
+				'separate' =>  __('Others', 'event_espresso'),
 			),
 			array(
 				'html_name'        => 'ee_purchasing_agent',
@@ -115,7 +115,7 @@ 
 				'required'         => false,
 				'html_label_id'    => 'ee_reg_qstn-purchasing_agent-lbl',
 				'html_label_class' => 'ee-reg-qstn',
-				'html_label_text'  =>  __( 'I am registering for...', 'event_espresso' ),
+				'html_label_text'  =>  __('I am registering for...', 'event_espresso'),
 				'default'          => 'attendee',
 				'label_position'   => \EE_Form_Input_With_Options_Base::label_after_input
 			)
@@ -141,7 +141,7 @@ 
 				),
 				'ee-additional-attendee-info-notice-dv',
 				'ee-additional-info'
-			) .
+			).
 			\EEH_HTML::div(
 				__(
 					'If you are NOT registering for yourself and will not be attending, then ALL information entered in the Attendee boxes further below is for others. But we still require some billing related information from you first.',
@@ -165,15 +165,15 @@ 
 	 */
 	public function _purchasing_agent_billing_form() {
 		$billing_form = new \EE_Billing_Attendee_Info_Form();
-		if ( $this->_purchasing_agent instanceof \EE_Attendee ) {
-			$billing_form->populate_from_attendee( $this->_purchasing_agent );
+		if ($this->_purchasing_agent instanceof \EE_Attendee) {
+			$billing_form->populate_from_attendee($this->_purchasing_agent);
 		}
 		return new \EE_Form_Section_Proper(
 			array(
 				'layout_strategy' => new \EE_Div_Per_Section_Layout(),
 				'subsections'     => array(
 					'frame_open'   => new \EE_Form_Section_HTML(
-						\EEH_HTML::div( '', '', 'ee-reg-form-qstn-grp-dv' )
+						\EEH_HTML::div('', '', 'ee-reg-form-qstn-grp-dv')
 						. \EEH_HTML::p(
 							__(
 								'Please provide the following required information if you are purchasing tickets for others.',
@@ -200,14 +200,14 @@ 
 	 * @param array $defined_vars
 	 * @return string
 	 */
-	public function display_purchasing_agent_form( $defined_vars ) {
+	public function display_purchasing_agent_form($defined_vars) {
 		$html = '';
-		if ( isset( $defined_vars[ 'purchasing_agent_form' ] ) ) {
-			\EE_Registry::instance()->load_helper( 'HTML' );
+		if (isset($defined_vars['purchasing_agent_form'])) {
+			\EE_Registry::instance()->load_helper('HTML');
 			$html .= '<fieldset id="ee-purchaser" class="ee-reg-form-attendee-dv" >';
 			$html .= '<legend class="spco-attendee-lgnd smaller-text lt-grey-text">';
-			$html .= __( 'Purchasing Agent', 'event_espresso' ) . '</legend>';
-			$html .= $defined_vars[ 'purchasing_agent_form' ];
+			$html .= __('Purchasing Agent', 'event_espresso').'</legend>';
+			$html .= $defined_vars['purchasing_agent_form'];
 			$html .= '</fieldset>';
 		}
 		return $html;
@@ -221,7 +221,7 @@ 
 	 * @param array        $valid_data
 	 * @param \EE_Checkout $checkout
 	 */
-	public function process_attendee_information( $valid_data, \EE_Checkout $checkout ) {
+	public function process_attendee_information($valid_data, \EE_Checkout $checkout) {
 		//\EEH_Debug_Tools::printr( __FUNCTION__, __CLASS__, __FILE__, __LINE__ );
 		// to get info / do stuff, we may need/want to hook into other SPCO actions/filters like:
 		// FHEE__EE_SPCO_Reg_Step_Attendee_Information___save_registration_form_input
@@ -233,16 +233,16 @@ 
 		/** @var \EE_Form_Section_Proper $purchasing_agent_form */
 		//$purchasing_agent_form = $checkout->current_step->reg_form->get_subsection( 'purchasing_agent_form' );
 		/** @var \EE_Radio_Button_Input $purchasing_agent_input */
-		$purchasing_agent_input = $checkout->current_step->reg_form->find_subsection( 'purchasing_agent_input' );
+		$purchasing_agent_input = $checkout->current_step->reg_form->find_subsection('purchasing_agent_input');
 		//\EEH_Debug_Tools::printr( $purchasing_agent_input, '$purchasing_agent_input', __FILE__, __LINE__ );
 		$agent = $purchasing_agent_input instanceof \EE_Form_Input_Base
 			? $purchasing_agent_input->raw_value()
 			: '';
 		//\EEH_Debug_Tools::printr( $agent, '$agent', __FILE__, __LINE__ );
-		if ( $agent == 'attendee' ) {
-			$billing_form = $checkout->current_step->reg_form->find_subsection( 'billing_form' );
-			if ( $billing_form instanceof \EE_Form_Section_Proper ) {
-				$billing_form->parent_section()->exclude( array( 'billing_form' ) );
+		if ($agent == 'attendee') {
+			$billing_form = $checkout->current_step->reg_form->find_subsection('billing_form');
+			if ($billing_form instanceof \EE_Form_Section_Proper) {
+				$billing_form->parent_section()->exclude(array('billing_form'));
 				//\EEH_Debug_Tools::printr( $billing_form, '$billing_form', __FILE__, __LINE__ );
 			}
 		}