eventespresso / event-espresso-core

core/EE_Capabilities.core.php

Doc Comments +3 added lines, -3 removed lines

@@ -557,7 +557,7 @@ 
 	 * @since    4.5.0
 	 *
 	 * @param string $meta_cap     What meta capability is this mapping.
-	 * @param array  $map_values   array {
+	 * @param string[]  $map_values   array {
 	 * 		//array of values that MUST match a count of 4.  It's okay to send an empty string for capabilities that don't get mapped to.
 	 * 		@type $map_values[0] string A string representing the model name. Required.  String's
 	 * 		      	    	       should always be used when Menu Maps are registered via the
@@ -625,8 +625,8 @@ 
 	 * @see EE_Meta_Capability_Map::_map_meta_caps() for docs on params.
 	 * @since 4.6.x
 	 * @param $caps
-	 * @param $cap
-	 * @param $user_id
+	 * @param string $cap
+	 * @param integer $user_id
 	 * @param $args
 	 *
 	 * @return array

Indentation +1 added lines, -2 removed lines

@@ -111,7 +111,6 @@ 
 
 	/**
 	 * This sets the meta caps property.
-
 	 * @since 4.5.0
 	 *
 	 * @return void
@@ -209,7 +208,7 @@ 
 			 * capability mapping which will be used for accessing payment methods owned by
 			 * other users.  This is not fully implemented yet in the payment method ui.
 			 * Currently only the "plural" caps are in active use. (Specific payment method caps are in use as well).
-			**/
+			 **/
 				'ee_manage_gateways',
 				'ee_read_payment_method',
 				'ee_read_payment_methods',

Spacing +127 added lines, -127 removed lines

@@ -7,8 +7,8 @@ 
  * @package Event Espresso
  * @subpackage core, capabilities
  */
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 
@@ -69,7 +69,7 @@ 
 	 */
 	public static function instance() {
 		//check if instantiated, and if not do so.
-		if ( ! self::$_instance instanceof EE_Capabilities ) {
+		if ( ! self::$_instance instanceof EE_Capabilities) {
 			self::$_instance = new self();
 		}
 		return self::$_instance;
@@ -98,10 +98,10 @@ 
 	 * @since 4.5.0
 	 * @return void
 	 */
-	public function init_caps( $reset = false ) {
-		if ( EE_Maintenance_Mode::instance()->models_can_query() ){
+	public function init_caps($reset = false) {
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
 			$this->_caps_map = $this->_init_caps_map();
-			$this->init_role_caps( $reset );
+			$this->init_role_caps($reset);
 			$this->_set_meta_caps();
 		}
 	}
@@ -120,11 +120,11 @@ 
 		//make sure we're only ever initializing the default _meta_caps array once if it's empty.
 		$this->_meta_caps = $this->_get_default_meta_caps_array();
 
-		$this->_meta_caps = apply_filters( 'FHEE__EE_Capabilities___set_meta_caps__meta_caps', $this->_meta_caps );
+		$this->_meta_caps = apply_filters('FHEE__EE_Capabilities___set_meta_caps__meta_caps', $this->_meta_caps);
 
 		//add filter for map_meta_caps but only if models can query.
-		if ( EE_Maintenance_Mode::instance()->models_can_query() && ! has_filter( 'map_meta_cap', array( $this, 'map_meta_caps' ) ) ) {
-			add_filter( 'map_meta_cap', array( $this, 'map_meta_caps' ), 10, 4 );
+		if (EE_Maintenance_Mode::instance()->models_can_query() && ! has_filter('map_meta_cap', array($this, 'map_meta_caps'))) {
+			add_filter('map_meta_cap', array($this, 'map_meta_caps'), 10, 4);
 		}
 	}
 
@@ -137,37 +137,37 @@ 
 	 */
 	private function _get_default_meta_caps_array() {
 		static $default_meta_caps = array();
-		if ( empty( $default_meta_caps ) ) {
+		if (empty($default_meta_caps)) {
 			$default_meta_caps = array(
 				//edits
-				new EE_Meta_Capability_Map_Edit( 'ee_edit_event', array( 'Event', 'ee_edit_published_events', 'ee_edit_others_events', 'ee_edit_private_events' ) ),
-				new EE_Meta_Capability_Map_Edit( 'ee_edit_venue', array( 'Venue', 'ee_edit_published_venues', 'ee_edit_others_venues', 'ee_edit_private_venues' ) ),
-				new EE_Meta_Capability_Map_Edit( 'ee_edit_registration', array( 'Registration', '', 'ee_edit_others_registrations', '' ) ),
-				new EE_Meta_Capability_Map_Edit( 'ee_edit_checkin', array( 'Registration', '', 'ee_edit_others_checkins', '' ) ),
-				new EE_Meta_Capability_Map_Messages_Cap( 'ee_edit_message', array( 'Message_Template_Group', '', 'ee_edit_others_messages', 'ee_edit_global_messages' ) ),
-				new EE_Meta_Capability_Map_Edit( 'ee_edit_default_ticket', array( 'Ticket', '', 'ee_edit_others_default_tickets', '' ) ),
-				new EE_Meta_Capability_Map_Registration_Form_Cap( 'ee_edit_question', array( 'Question', '', '', 'ee_edit_system_questions' ) ),
-				new EE_Meta_Capability_Map_Registration_Form_Cap( 'ee_edit_question_group', array( 'Question_Group', '', '', 'ee_edit_system_question_groups' ) ),
-				new EE_Meta_Capability_Map_Edit( 'ee_edit_payment_method', array( 'Payment_Method', '', 'ee_edit_others_payment_methods', '' ) ),
+				new EE_Meta_Capability_Map_Edit('ee_edit_event', array('Event', 'ee_edit_published_events', 'ee_edit_others_events', 'ee_edit_private_events')),
+				new EE_Meta_Capability_Map_Edit('ee_edit_venue', array('Venue', 'ee_edit_published_venues', 'ee_edit_others_venues', 'ee_edit_private_venues')),
+				new EE_Meta_Capability_Map_Edit('ee_edit_registration', array('Registration', '', 'ee_edit_others_registrations', '')),
+				new EE_Meta_Capability_Map_Edit('ee_edit_checkin', array('Registration', '', 'ee_edit_others_checkins', '')),
+				new EE_Meta_Capability_Map_Messages_Cap('ee_edit_message', array('Message_Template_Group', '', 'ee_edit_others_messages', 'ee_edit_global_messages')),
+				new EE_Meta_Capability_Map_Edit('ee_edit_default_ticket', array('Ticket', '', 'ee_edit_others_default_tickets', '')),
+				new EE_Meta_Capability_Map_Registration_Form_Cap('ee_edit_question', array('Question', '', '', 'ee_edit_system_questions')),
+				new EE_Meta_Capability_Map_Registration_Form_Cap('ee_edit_question_group', array('Question_Group', '', '', 'ee_edit_system_question_groups')),
+				new EE_Meta_Capability_Map_Edit('ee_edit_payment_method', array('Payment_Method', '', 'ee_edit_others_payment_methods', '')),
 				//reads
-				new EE_Meta_Capability_Map_Read( 'ee_read_event', array( 'Event', '', 'ee_read_others_events', 'ee_read_private_events' ) ),
-				new EE_Meta_Capability_Map_Read( 'ee_read_venue', array( 'Venue', '', 'ee_read_others_venues', 'ee_read_private_venues' ) ),
-				new EE_Meta_Capability_Map_Read( 'ee_read_registration', array( 'Registration', '', '', 'ee_edit_others_registrations' ) ),
-				new EE_Meta_Capability_Map_Read( 'ee_read_checkin', array( 'Registration', '', '', 'ee_read_others_checkins' ) ),
-				new EE_Meta_Capability_Map_Messages_Cap( 'ee_read_message', array( 'Message_Template_Group', '', 'ee_read_others_messages', 'ee_read_global_messages' ) ),
-				new EE_Meta_Capability_Map_Read( 'ee_read_default_ticket', array( 'Ticket', '', '', 'ee_read_others_default_tickets' ) ),
-				new EE_Meta_Capability_Map_Read( 'ee_read_payment_method', array( 'Payment_Method', '', '', 'ee_read_others_payment_methods' ) ),
+				new EE_Meta_Capability_Map_Read('ee_read_event', array('Event', '', 'ee_read_others_events', 'ee_read_private_events')),
+				new EE_Meta_Capability_Map_Read('ee_read_venue', array('Venue', '', 'ee_read_others_venues', 'ee_read_private_venues')),
+				new EE_Meta_Capability_Map_Read('ee_read_registration', array('Registration', '', '', 'ee_edit_others_registrations')),
+				new EE_Meta_Capability_Map_Read('ee_read_checkin', array('Registration', '', '', 'ee_read_others_checkins')),
+				new EE_Meta_Capability_Map_Messages_Cap('ee_read_message', array('Message_Template_Group', '', 'ee_read_others_messages', 'ee_read_global_messages')),
+				new EE_Meta_Capability_Map_Read('ee_read_default_ticket', array('Ticket', '', '', 'ee_read_others_default_tickets')),
+				new EE_Meta_Capability_Map_Read('ee_read_payment_method', array('Payment_Method', '', '', 'ee_read_others_payment_methods')),
 
 				//deletes
-				new EE_Meta_Capability_Map_Delete( 'ee_delete_event', array( 'Event', 'ee_delete_published_events', 'ee_delete_others_events', 'ee_delete_private_events' ) ),
-				new EE_Meta_Capability_Map_Delete( 'ee_delete_venue', array( 'Venue', 'ee_delete_published_venues', 'ee_delete_others_venues', 'ee_delete_private_venues' ) ),
-				new EE_Meta_Capability_Map_Delete( 'ee_delete_registration', array( 'Registration', '', 'ee_delete_others_registrations', '' ) ),
-				new EE_Meta_Capability_Map_Delete( 'ee_delete_checkin', array( 'Registration', '', 'ee_delete_others_checkins', '' ) ),
-				new EE_Meta_Capability_Map_Messages_Cap( 'ee_delete_message', array( 'Message_Template_Group', '', 'ee_delete_others_messages', 'ee_delete_global_messages' ) ),
-				new EE_Meta_Capability_Map_Delete( 'ee_delete_default_ticket', array( 'Ticket', '', 'ee_delete_others_default_tickets', '' ) ),
-				new EE_Meta_Capability_Map_Registration_Form_Cap( 'ee_delete_question', array( 'Question', '', '', 'delete_system_questions' ) ),
-				new EE_Meta_Capability_Map_Registration_Form_Cap( 'ee_delete_question_group', array( 'Question_Group', '', '', 'delete_system_question_groups' ) ),
-				new EE_Meta_Capability_Map_Delete( 'ee_delete_payment_method', array( 'Payment_Method', '', 'ee_delete_others_payment_methods', '' ) ),
+				new EE_Meta_Capability_Map_Delete('ee_delete_event', array('Event', 'ee_delete_published_events', 'ee_delete_others_events', 'ee_delete_private_events')),
+				new EE_Meta_Capability_Map_Delete('ee_delete_venue', array('Venue', 'ee_delete_published_venues', 'ee_delete_others_venues', 'ee_delete_private_venues')),
+				new EE_Meta_Capability_Map_Delete('ee_delete_registration', array('Registration', '', 'ee_delete_others_registrations', '')),
+				new EE_Meta_Capability_Map_Delete('ee_delete_checkin', array('Registration', '', 'ee_delete_others_checkins', '')),
+				new EE_Meta_Capability_Map_Messages_Cap('ee_delete_message', array('Message_Template_Group', '', 'ee_delete_others_messages', 'ee_delete_global_messages')),
+				new EE_Meta_Capability_Map_Delete('ee_delete_default_ticket', array('Ticket', '', 'ee_delete_others_default_tickets', '')),
+				new EE_Meta_Capability_Map_Registration_Form_Cap('ee_delete_question', array('Question', '', '', 'delete_system_questions')),
+				new EE_Meta_Capability_Map_Registration_Form_Cap('ee_delete_question_group', array('Question_Group', '', '', 'delete_system_question_groups')),
+				new EE_Meta_Capability_Map_Delete('ee_delete_payment_method', array('Payment_Method', '', 'ee_delete_others_payment_methods', '')),
 			);
 		}
 		return $default_meta_caps;
@@ -191,15 +191,15 @@ 
 	 *
 	 * @return array   actual users capabilities
 	 */
-	public function map_meta_caps( $caps, $cap, $user_id, $args ) {
+	public function map_meta_caps($caps, $cap, $user_id, $args) {
 		//loop through our _meta_caps array
-		foreach ( $this->_meta_caps as $meta_map ) {
-			if ( ! $meta_map instanceof EE_Meta_Capability_Map ) {
+		foreach ($this->_meta_caps as $meta_map) {
+			if ( ! $meta_map instanceof EE_Meta_Capability_Map) {
 				continue;
 			}
 			$meta_map->ensure_is_model();
 
-			$caps = $meta_map->map_meta_caps( $caps, $cap, $user_id, $args );
+			$caps = $meta_map->map_meta_caps($caps, $cap, $user_id, $args);
 		}
 		return $caps;
 	}
@@ -364,7 +364,7 @@ 
 				)
 			);
 
-		$caps = apply_filters( 'FHEE__EE_Capabilities__init_caps_map__caps', $caps );
+		$caps = apply_filters('FHEE__EE_Capabilities__init_caps_map__caps', $caps);
 		return $caps;
 	}
 
@@ -381,26 +381,26 @@ 
 	 *
 	 * @return void
 	 */
-	public function init_role_caps( $reset = false, $custom_map = array() ) {
+	public function init_role_caps($reset = false, $custom_map = array()) {
 
-		$caps_map = empty( $custom_map ) ? $this->_caps_map : $custom_map;
+		$caps_map = empty($custom_map) ? $this->_caps_map : $custom_map;
 
 		//first let's determine if these caps have already been set.
-		$caps_set_before = get_option( self::option_name, array() );
+		$caps_set_before = get_option(self::option_name, array());
 		//if not reset, see what caps are new for each role. if they're new, add them.
-		foreach ( $caps_map as $role => $caps_for_role ) {
-			foreach ( $caps_for_role as $cap ) {
+		foreach ($caps_map as $role => $caps_for_role) {
+			foreach ($caps_for_role as $cap) {
 				//first check we haven't already added this cap before, or it's a reset
-				if ( $reset || ! isset( $caps_set_before[ $role ] ) || ! in_array( $cap, $caps_set_before[ $role ] ) ) {
-					$this->add_cap_to_role( $role, $cap );
-					$caps_set_before[ $role ][] = $cap;
+				if ($reset || ! isset($caps_set_before[$role]) || ! in_array($cap, $caps_set_before[$role])) {
+					$this->add_cap_to_role($role, $cap);
+					$caps_set_before[$role][] = $cap;
 				}
 			}
 		}
 
 		//now let's just save the cap that has been set.
-		update_option( self::option_name, $caps_set_before );
-		do_action( 'AHEE__EE_Capabilities__init_role_caps__complete', $caps_set_before );
+		update_option(self::option_name, $caps_set_before);
+		do_action('AHEE__EE_Capabilities__init_role_caps__complete', $caps_set_before);
 	}
 
 
@@ -419,10 +419,10 @@ 
 	 * @param bool $grant  Whether to grant access to this cap on this role.
 	 * @return void
 	 */
-	public function add_cap_to_role( $role, $cap, $grant = true ) {
-		$role = get_role( $role );
-		if ( $role instanceof WP_Role ) {
-			$role->add_cap( $cap, $grant );
+	public function add_cap_to_role($role, $cap, $grant = true) {
+		$role = get_role($role);
+		if ($role instanceof WP_Role) {
+			$role->add_cap($cap, $grant);
 		}
 	}
 
@@ -442,10 +442,10 @@ 
 	 *
 	 * @return void
 	 */
-	public function remove_cap_from_role( $role, $cap ) {
-		$role = get_role( $role );
-		if ( $role instanceof WP_Role ) {
-			$role->remove_cap( $cap );
+	public function remove_cap_from_role($role, $cap) {
+		$role = get_role($role);
+		if ($role instanceof WP_Role) {
+			$role->remove_cap($cap);
 		}
 	}
 
@@ -466,11 +466,11 @@ 
 	 *
 	 * @return bool  Whether user can or not.
 	 */
-	public function current_user_can( $cap, $context, $id = 0 ) {
+	public function current_user_can($cap, $context, $id = 0) {
 		//apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-		$filtered_cap = apply_filters( 'FHEE__EE_Capabilities__current_user_can__cap__' . $context,  $cap, $id );
-		$filtered_cap = apply_filters( 'FHEE__EE_Capabilities__current_user_can__cap', $filtered_cap, $context, $cap, $id );
-		return ! empty( $id ) ? current_user_can( $filtered_cap, $id ) : current_user_can( $filtered_cap );
+		$filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap__'.$context, $cap, $id);
+		$filtered_cap = apply_filters('FHEE__EE_Capabilities__current_user_can__cap', $filtered_cap, $context, $cap, $id);
+		return ! empty($id) ? current_user_can($filtered_cap, $id) : current_user_can($filtered_cap);
 	}
 
 
@@ -487,11 +487,11 @@ 
 	 *
 	 * @return bool Whether user can or not.
 	 */
-	public function user_can( $user, $cap, $context, $id = 0 ) {
+	public function user_can($user, $cap, $context, $id = 0) {
 		//apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-		$filtered_cap = apply_filters( 'FHEE__EE_Capabilities__user_can__cap__' . $context, $cap, $user, $id );
-		$filtered_cap = apply_filters( 'FHEE__EE_Capabilities__user_can__cap', $filtered_cap, $context, $cap, $user,  $id );
-		return ! empty( $id ) ? user_can( $user, $filtered_cap, $id ) : user_can( $user, $filtered_cap );
+		$filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap__'.$context, $cap, $user, $id);
+		$filtered_cap = apply_filters('FHEE__EE_Capabilities__user_can__cap', $filtered_cap, $context, $cap, $user, $id);
+		return ! empty($id) ? user_can($user, $filtered_cap, $id) : user_can($user, $filtered_cap);
 	}
 
 
@@ -511,12 +511,12 @@ 
 	 *
 	 * @return bool  Whether user can or not.
 	 */
-	public function current_user_can_for_blog( $blog_id, $cap, $context, $id = 0 ) {
-		$user_can = ! empty( $id ) ? current_user_can_for_blog( $blog_id, $cap, $id ) : current_user_can( $blog_id, $cap );
+	public function current_user_can_for_blog($blog_id, $cap, $context, $id = 0) {
+		$user_can = ! empty($id) ? current_user_can_for_blog($blog_id, $cap, $id) : current_user_can($blog_id, $cap);
 
 		//apply filters (both a global on just the cap, and context specific.  Global overrides context specific)
-		$user_can = apply_filters( 'FHEE__EE_Capabilities__current_user_can_for_blog__user_can__' . $context, $user_can, $blog_id, $cap, $id );
-		$user_can = apply_filters( 'FHEE__EE_Capabilities__current_user_can_for_blog__user_can', $user_can, $context, $blog_id, $cap, $id );
+		$user_can = apply_filters('FHEE__EE_Capabilities__current_user_can_for_blog__user_can__'.$context, $user_can, $blog_id, $cap, $id);
+		$user_can = apply_filters('FHEE__EE_Capabilities__current_user_can_for_blog__user_can', $user_can, $context, $blog_id, $cap, $id);
 		return $user_can;
 	}
 
@@ -532,12 +532,12 @@ 
 	 *
 	 * @return array
 	 */
-	public function get_ee_capabilities( $role = 'administrator' ) {
+	public function get_ee_capabilities($role = 'administrator') {
 		$capabilities = $this->_init_caps_map();
-		if ( empty( $role ) ) {
+		if (empty($role)) {
 			return $capabilities;
 		}
-		return isset( $capabilities[ $role ] ) ? $capabilities[ $role ] : array();
+		return isset($capabilities[$role]) ? $capabilities[$role] : array();
 	}
 }
 
@@ -585,11 +585,11 @@ 
 	 * 	}
 	 * @throws EE_Error
 	 */
-	public function __construct( $meta_cap, $map_values ) {
+	public function __construct($meta_cap, $map_values) {
 		$this->meta_cap = $meta_cap;
 		//verify there are four args in the $map_values array;
-		if ( count( $map_values ) !== 4 ) {
-			throw new EE_Error( sprintf( __( 'Incoming $map_values array should have a count of four values in it.  This is what was given: %s', 'event_espresso' ), '<br>' . print_r( $map_values, true ) ) );
+		if (count($map_values) !== 4) {
+			throw new EE_Error(sprintf(__('Incoming $map_values array should have a count of four values in it.  This is what was given: %s', 'event_espresso'), '<br>'.print_r($map_values, true)));
 		}
 
 		//set properties
@@ -603,8 +603,8 @@ 
 	/**
 	 * Makes it so this object stops filtering caps
 	 */
-	public function remove_filters(){
-		remove_filter( 'map_meta_cap', array( $this, 'map_meta_caps' ), 10 );
+	public function remove_filters() {
+		remove_filter('map_meta_cap', array($this, 'map_meta_caps'), 10);
 	}
 
 
@@ -619,19 +619,19 @@ 
 	 */
 	public function ensure_is_model() {
 		//is it already instantiated?
-		if ( $this->_model instanceof EEM_Base ) {
+		if ($this->_model instanceof EEM_Base) {
 			return;
 		}
 
 		//ensure model name is string
 		$this->_model_name = (string) $this->_model_name;
 		//error proof if the name has EEM in it
-		$this->_model_name = str_replace( 'EEM', '', $this->_model_name );
+		$this->_model_name = str_replace('EEM', '', $this->_model_name);
 
-		$this->_model = EE_Registry::instance()->load_model( $this->_model_name );
+		$this->_model = EE_Registry::instance()->load_model($this->_model_name);
 
-		if ( ! $this->_model instanceof EEM_Base ) {
-			throw new EE_Error( sprintf( __( 'This string passed in to %s to represent a EEM_Base model class was not able to be used to instantiate the class.   Please ensure that the string is a match for the EEM_Base model name (not including the EEM_ part). This was given: %s', 'event_espresso' ), get_class( $this ), $this->_model ) );
+		if ( ! $this->_model instanceof EEM_Base) {
+			throw new EE_Error(sprintf(__('This string passed in to %s to represent a EEM_Base model class was not able to be used to instantiate the class.   Please ensure that the string is a match for the EEM_Base model name (not including the EEM_ part). This was given: %s', 'event_espresso'), get_class($this), $this->_model));
 		}
 	}
 
@@ -647,8 +647,8 @@ 
 	 *
 	 * @return array
 	 */
-	public function map_meta_caps( $caps, $cap, $user_id, $args ) {
-		return $this->_map_meta_caps( $caps, $cap, $user_id, $args );
+	public function map_meta_caps($caps, $cap, $user_id, $args) {
+		return $this->_map_meta_caps($caps, $cap, $user_id, $args);
 	}
 
 
@@ -666,7 +666,7 @@ 
 	 *
 	 * @return array   actual users capabilities
 	 */
-	abstract protected function _map_meta_caps( $caps, $cap, $user_id, $args );
+	abstract protected function _map_meta_caps($caps, $cap, $user_id, $args);
 }
 
 
@@ -698,28 +698,28 @@ 
 	 *
 	 * @return array   actual users capabilities
 	 */
-	protected function _map_meta_caps( $caps, $cap, $user_id, $args ) {
+	protected function _map_meta_caps($caps, $cap, $user_id, $args) {
 		//only process if we're checking our mapped_cap
-		if ( $cap !== $this->meta_cap ) {
+		if ($cap !== $this->meta_cap) {
 			return $caps;
 		}
 
-		$obj = ! empty( $args[0] ) ? $this->_model->get_one_by_ID( $args[0] ) : null;
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
 
 		//if no obj then let's just do cap
-		if ( ! $obj instanceof EE_Base_Class ) {
+		if ( ! $obj instanceof EE_Base_Class) {
 			$caps[] = $cap;
 			return $caps;
 		}
 
-		if ( $obj instanceof EE_CPT_Base ) {
+		if ($obj instanceof EE_CPT_Base) {
 			//if the item author is set and the user is the author...
-			if ( $obj->wp_user() && $user_id == $obj->wp_user() ) {
-				if ( empty( $this->published_cap ) ) {
+			if ($obj->wp_user() && $user_id == $obj->wp_user()) {
+				if (empty($this->published_cap)) {
 					$caps[] = $cap;
 				} else {
 					//if obj is published...
-					if ( $obj->status() == 'publish' ) {
+					if ($obj->status() == 'publish') {
 						$caps[] = $this->published_cap;
 					} else {
 						$caps[] = $cap;
@@ -727,21 +727,21 @@ 
 				}
 			} else {
 				//the user is trying to edit someone else's obj
-				if ( ! empty( $this->others_cap ) ) {
+				if ( ! empty($this->others_cap)) {
 					$caps[] = $this->others_cap;
 				}
-				if ( ! empty( $this->published_cap ) && $obj->status() == 'publish' ) {
+				if ( ! empty($this->published_cap) && $obj->status() == 'publish') {
 					$caps[] = $this->published_cap;
-				} elseif ( ! empty( $this->private_cap ) && $obj->status() == 'private' ) {
+				} elseif ( ! empty($this->private_cap) && $obj->status() == 'private') {
 					$caps[] = $this->private_cap;
 				}
 			}
 		} else {
 			//not a cpt object so handled differently
-			if ( method_exists( $obj, 'wp_user' ) && $obj->wp_user() && $user_id == $obj->wp_user() ) {
+			if (method_exists($obj, 'wp_user') && $obj->wp_user() && $user_id == $obj->wp_user()) {
 				$caps[] = $cap;
 			} else {
-				if ( ! empty( $this->others_cap ) ) {
+				if ( ! empty($this->others_cap)) {
 					$caps[] = $this->others_cap;
 				}
 			}
@@ -778,8 +778,8 @@ 
 	 *
 	 * @return array   actual users capabilities
 	 */
-	protected function _map_meta_caps( $caps, $cap, $user_id, $args ) {
-		return parent::_map_meta_caps( $caps, $cap, $user_id, $args );
+	protected function _map_meta_caps($caps, $cap, $user_id, $args) {
+		return parent::_map_meta_caps($caps, $cap, $user_id, $args);
 	}
 }
 
@@ -811,45 +811,45 @@ 
 	 *
 	 * @return array   actual users capabilities
 	 */
-	protected function _map_meta_caps( $caps, $cap, $user_id, $args ) {
+	protected function _map_meta_caps($caps, $cap, $user_id, $args) {
 		//only process if we're checking our mapped cap;
-		if ( $cap !== $this->meta_cap ) {
+		if ($cap !== $this->meta_cap) {
 			return $caps;
 		}
 
-		$obj = ! empty( $args[0] ) ? $this->_model->get_one_by_ID( $args[0] ) : null;
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
 
 		//if no obj then let's just do cap
-		if ( ! $obj instanceof EE_Base_Class ) {
+		if ( ! $obj instanceof EE_Base_Class) {
 			$caps[] = $cap;
 			return $caps;
 		}
 
-		if ( $obj instanceof EE_CPT_Base ) {
-			$status_obj = get_post_status_object( $obj->status() );
-			if ( $status_obj->public ) {
+		if ($obj instanceof EE_CPT_Base) {
+			$status_obj = get_post_status_object($obj->status());
+			if ($status_obj->public) {
 				$caps[] = $cap;
 				return $caps;
 			}
 
 			//if the item author is set and the user is the author...
-			if ( $obj->wp_user() && $user_id == $obj->wp_user() ) {
+			if ($obj->wp_user() && $user_id == $obj->wp_user()) {
 				$caps[] = $cap;
-			} elseif ( $status_obj->private && ! empty( $this->private_cap ) ) {
+			} elseif ($status_obj->private && ! empty($this->private_cap)) {
 				//the user is trying to view someone else's obj
 				$caps[] = $this->private_cap;
-			} elseif ( ! empty( $this->others_cap ) ) {
+			} elseif ( ! empty($this->others_cap)) {
 				$caps[] = $this->others_cap;
 			} else {
 				$caps[] = $cap;
 			}
 		} else {
 			//not a cpt object so handled differently
-			if ( method_exists( $obj, 'wp_user' ) && $obj->wp_user() && $user_id == $obj->wp_user() ) {
+			if (method_exists($obj, 'wp_user') && $obj->wp_user() && $user_id == $obj->wp_user()) {
 				$caps[] = $cap;
-			} elseif ( ! empty( $this->private_cap ) ) {
+			} elseif ( ! empty($this->private_cap)) {
 				$caps[] = $this->private_cap;
-			} elseif ( ! empty( $this->others_cap ) ) {
+			} elseif ( ! empty($this->others_cap)) {
 				$caps[] = $this->others_cap;
 			} else {
 				$caps[] = $cap;
@@ -886,30 +886,30 @@ 
 	 *
 	 * @return array   actual users capabilities
 	 */
-	protected function _map_meta_caps( $caps, $cap, $user_id, $args ) {
+	protected function _map_meta_caps($caps, $cap, $user_id, $args) {
 		//only process if we're checking our mapped_cap
-		if ( $cap !== $this->meta_cap ) {
+		if ($cap !== $this->meta_cap) {
 			return $caps;
 		}
 
-		$obj = ! empty( $args[0] ) ? $this->_model->get_one_by_ID( $args[0] ) : null;
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
 
 		//if no obj then let's just do cap
-		if ( ! $obj instanceof EE_Message_Template_Group ) {
+		if ( ! $obj instanceof EE_Message_Template_Group) {
 			$caps[] = $cap;
 			return $caps;
 		}
 
 		$is_global = $obj->is_global();
 
-		if ( $obj->wp_user() && $user_id == $obj->wp_user() ) {
-			if ( $is_global ) {
-				$caps[]  = $this->private_cap;
+		if ($obj->wp_user() && $user_id == $obj->wp_user()) {
+			if ($is_global) {
+				$caps[] = $this->private_cap;
 			} else {
 				$caps[] = $cap;
 			}
 		} else {
-			if ( $is_global ) {
+			if ($is_global) {
 				$caps[] = $this->private_cap;
 			} else {
 				$caps[] = $this->others_cap;
@@ -947,16 +947,16 @@ 
 	 *
 	 * @return array   actual users capabilities
 	 */
-	protected function _map_meta_caps( $caps, $cap, $user_id, $args ) {
+	protected function _map_meta_caps($caps, $cap, $user_id, $args) {
 		//only process if we're checking our mapped_cap
-		if ( $cap !== $this->meta_cap ) {
+		if ($cap !== $this->meta_cap) {
 			return $caps;
 		}
 
-		$obj = ! empty( $args[0] ) ? $this->_model->get_one_by_ID( $args[0] ) : null;
+		$obj = ! empty($args[0]) ? $this->_model->get_one_by_ID($args[0]) : null;
 
 		//if no obj then let's just do cap
-		if ( ! $obj instanceof EE_Base_Class ) {
+		if ( ! $obj instanceof EE_Base_Class) {
 			$caps[] = $cap;
 			return $caps;
 		}
@@ -964,7 +964,7 @@ 
 		$is_system = $obj instanceof EE_Question_Group ? $obj->system_group() : false;
 		$is_system = $obj instanceof EE_Question ? $obj->is_system_question() : $is_system;
 
-		if ( $is_system ) {
+		if ($is_system) {
 			$caps[] = $this->private_cap;
 		} else {
 			$caps[] = $cap;

core/helpers/EEH_Event_Query.helper.php

Doc Comments +1 added lines, -1 removed lines

@@ -204,7 +204,7 @@
 	 *
 	 * @access    private
 	 * @param string $sort
-	 * @return    array
+	 * @return    string
 	 */
 	private static function _sort( $sort = 'ASC' ) {
 		$sort = EE_Registry::instance()->REQ->is_set( 'event_query_sort' ) ? sanitize_text_field( EE_Registry::instance()->REQ->get( 'event_query_sort' ) ) : $sort;

Spacing +118 added lines, -118 removed lines

@@ -1,5 +1,5 @@ 
-<?php if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 /**
  * Event Espresso
@@ -85,7 +85,7 @@ 
 	 */
 	public static function add_query_filters() {
 		//add query filters
-		add_action( 'pre_get_posts', array( 'EEH_Event_Query', 'filter_query_parts' ), 10, 1 );
+		add_action('pre_get_posts', array('EEH_Event_Query', 'filter_query_parts'), 10, 1);
 	}
 
 
@@ -97,8 +97,8 @@ 
 	 * @param \WP_Query $WP_Query
 	 * @return bool
 	 */
-	public static function apply_query_filters( WP_Query $WP_Query ) {
-		return ( isset( $WP_Query->query, $WP_Query->query['post_type'] ) && $WP_Query->query['post_type'] == 'espresso_events' ) ||  apply_filters( 'FHEE__EEH_Event_Query__apply_query_filters', false ) ? true : false;
+	public static function apply_query_filters(WP_Query $WP_Query) {
+		return (isset($WP_Query->query, $WP_Query->query['post_type']) && $WP_Query->query['post_type'] == 'espresso_events') || apply_filters('FHEE__EEH_Event_Query__apply_query_filters', false) ? true : false;
 	}
 
 
@@ -108,15 +108,15 @@ 
 	 * @access    public
 	 * @param \WP_Query $WP_Query
 	 */
-	public static function filter_query_parts( WP_Query $WP_Query ) {
+	public static function filter_query_parts(WP_Query $WP_Query) {
 		//ONLY add our filters if this isn't the main wp_query, because if this is the main wp_query we already have our cpt strategies take care of adding things in.
-		if ( $WP_Query instanceof WP_Query && ! $WP_Query->is_main_query() ) {
+		if ($WP_Query instanceof WP_Query && ! $WP_Query->is_main_query()) {
 			// build event list query
-			add_filter( 'posts_fields', array( 'EEH_Event_Query', 'posts_fields' ), 10, 2 );
-			add_filter( 'posts_join', array( 'EEH_Event_Query', 'posts_join' ), 10, 2 );
-			add_filter( 'posts_where', array( 'EEH_Event_Query', 'posts_where' ), 10, 2 );
-			add_filter( 'posts_orderby', array( 'EEH_Event_Query', 'posts_orderby' ), 10, 2 );
-			add_filter( 'posts_clauses_request', array( 'EEH_Event_Query', 'posts_clauses' ), 10, 2 );
+			add_filter('posts_fields', array('EEH_Event_Query', 'posts_fields'), 10, 2);
+			add_filter('posts_join', array('EEH_Event_Query', 'posts_join'), 10, 2);
+			add_filter('posts_where', array('EEH_Event_Query', 'posts_where'), 10, 2);
+			add_filter('posts_orderby', array('EEH_Event_Query', 'posts_orderby'), 10, 2);
+			add_filter('posts_clauses_request', array('EEH_Event_Query', 'posts_clauses'), 10, 2);
 		}
 	}
 
@@ -131,13 +131,13 @@ 
 	 * @param string $orderby
 	 * @param string $sort
 	 */
-	public static function set_query_params( $month = '', $category = '', $show_expired = FALSE, $orderby = 'start_date', $sort = 'ASC' ) {
+	public static function set_query_params($month = '', $category = '', $show_expired = FALSE, $orderby = 'start_date', $sort = 'ASC') {
 		self::$_query_params = array();
-		EEH_Event_Query::$_event_query_month = EEH_Event_Query::_display_month( $month );
-		EEH_Event_Query::$_event_query_category = EEH_Event_Query::_event_category_slug( $category );
-		EEH_Event_Query::$_event_query_show_expired = EEH_Event_Query::_show_expired( $show_expired );
-		EEH_Event_Query::$_event_query_orderby = EEH_Event_Query::_orderby( $orderby );
-		EEH_Event_Query::$_event_query_sort = EEH_Event_Query::_sort( $sort );
+		EEH_Event_Query::$_event_query_month = EEH_Event_Query::_display_month($month);
+		EEH_Event_Query::$_event_query_category = EEH_Event_Query::_event_category_slug($category);
+		EEH_Event_Query::$_event_query_show_expired = EEH_Event_Query::_show_expired($show_expired);
+		EEH_Event_Query::$_event_query_orderby = EEH_Event_Query::_orderby($orderby);
+		EEH_Event_Query::$_event_query_sort = EEH_Event_Query::_sort($sort);
 	}
 
 
@@ -149,8 +149,8 @@ 
 	 * @param string $month
 	 * @return    string
 	 */
-	private static function _display_month( $month = '' ) {
-		return EE_Registry::instance()->REQ->is_set( 'event_query_month' ) ? sanitize_text_field( EE_Registry::instance()->REQ->get( 'event_query_month' ) ) : $month;
+	private static function _display_month($month = '') {
+		return EE_Registry::instance()->REQ->is_set('event_query_month') ? sanitize_text_field(EE_Registry::instance()->REQ->get('event_query_month')) : $month;
 	}
 
 
@@ -162,8 +162,8 @@ 
 	 * @param string $category
 	 * @return    string
 	 */
-	private static function _event_category_slug( $category = '' ) {
-		return EE_Registry::instance()->REQ->is_set( 'event_query_category' ) ? sanitize_text_field( EE_Registry::instance()->REQ->get( 'event_query_category' ) ) : $category;
+	private static function _event_category_slug($category = '') {
+		return EE_Registry::instance()->REQ->is_set('event_query_category') ? sanitize_text_field(EE_Registry::instance()->REQ->get('event_query_category')) : $category;
 	}
 
 
@@ -175,10 +175,10 @@ 
 	 * @param bool $show_expired
 	 * @return    boolean
 	 */
-	private static function _show_expired( $show_expired = FALSE ) {
+	private static function _show_expired($show_expired = FALSE) {
 		// override default expired option if set via filter
-		$_event_query_show_expired =EE_Registry::instance()->REQ->is_set( 'event_query_show_expired' ) ? EE_Registry::instance()->REQ->get( 'event_query_show_expired' ) : $show_expired;
-		return filter_var( $_event_query_show_expired, FILTER_VALIDATE_BOOLEAN );
+		$_event_query_show_expired = EE_Registry::instance()->REQ->is_set('event_query_show_expired') ? EE_Registry::instance()->REQ->get('event_query_show_expired') : $show_expired;
+		return filter_var($_event_query_show_expired, FILTER_VALIDATE_BOOLEAN);
 	}
 
 
@@ -190,10 +190,10 @@ 
 	 * @param    string $orderby
 	 * @return    array
 	 */
-	private static function _orderby( $orderby = 'start_date' ) {
-		$event_query_orderby = EE_Registry::instance()->REQ->is_set( 'event_query_orderby' ) ? sanitize_text_field( EE_Registry::instance()->REQ->get( 'event_query_orderby' ) ) : $orderby;
-		$event_query_orderby = is_array( $event_query_orderby ) ? $event_query_orderby : explode( ',', $event_query_orderby );
-		$event_query_orderby = array_map( 'trim', $event_query_orderby );
+	private static function _orderby($orderby = 'start_date') {
+		$event_query_orderby = EE_Registry::instance()->REQ->is_set('event_query_orderby') ? sanitize_text_field(EE_Registry::instance()->REQ->get('event_query_orderby')) : $orderby;
+		$event_query_orderby = is_array($event_query_orderby) ? $event_query_orderby : explode(',', $event_query_orderby);
+		$event_query_orderby = array_map('trim', $event_query_orderby);
 		return $event_query_orderby;
 	}
 
@@ -206,9 +206,9 @@ 
 	 * @param string $sort
 	 * @return    array
 	 */
-	private static function _sort( $sort = 'ASC' ) {
-		$sort = EE_Registry::instance()->REQ->is_set( 'event_query_sort' ) ? sanitize_text_field( EE_Registry::instance()->REQ->get( 'event_query_sort' ) ) : $sort;
-		return in_array( $sort, array( 'ASC', 'asc', 'DESC', 'desc' )) ? strtoupper( $sort ) : 'ASC';
+	private static function _sort($sort = 'ASC') {
+		$sort = EE_Registry::instance()->REQ->is_set('event_query_sort') ? sanitize_text_field(EE_Registry::instance()->REQ->get('event_query_sort')) : $sort;
+		return in_array($sort, array('ASC', 'asc', 'DESC', 'desc')) ? strtoupper($sort) : 'ASC';
 	}
 
 
@@ -221,10 +221,10 @@ 
 	 *
 	 * @return array   array of clauses
 	 */
-	public static function posts_clauses( $clauses, WP_Query $wp_query ) {
-		if ( EEH_Event_Query::apply_query_filters( $wp_query ) ) {
+	public static function posts_clauses($clauses, WP_Query $wp_query) {
+		if (EEH_Event_Query::apply_query_filters($wp_query)) {
 			global $wpdb;
-			$clauses['groupby'] = $wpdb->posts . '.ID ';
+			$clauses['groupby'] = $wpdb->posts.'.ID ';
 		}
 		return $clauses;
 	}
@@ -239,10 +239,10 @@ 
 	 * @param WP_Query $wp_query
 	 * @return    string
 	 */
-	public static function posts_fields( $SQL, WP_Query $wp_query ) {
-		if ( EEH_Event_Query::apply_query_filters( $wp_query ) ) {
+	public static function posts_fields($SQL, WP_Query $wp_query) {
+		if (EEH_Event_Query::apply_query_filters($wp_query)) {
 			// adds something like ", wp_esp_datetime.* " to WP Query SELECT statement
-			$SQL .= EEH_Event_Query::posts_fields_sql_for_orderby( EEH_Event_Query::$_event_query_orderby );
+			$SQL .= EEH_Event_Query::posts_fields_sql_for_orderby(EEH_Event_Query::$_event_query_orderby);
 		}
 		return $SQL;
 	}
@@ -257,29 +257,29 @@ 
 	 * @internal  param bool|string $mixed $join_terms pass TRUE or term string, doesn't really matter since this value doesn't really get used for anything yet
 	 * @return    string
 	 */
-	public static function posts_fields_sql_for_orderby( $orderby_params = array() ) {
-		$SQL = ', MIN( ' . EEM_Datetime::instance()->table() . '.DTT_EVT_start ) as event_start_date ' ;
-		foreach( (array)$orderby_params as $orderby ) {
-			switch ( $orderby ) {
+	public static function posts_fields_sql_for_orderby($orderby_params = array()) {
+		$SQL = ', MIN( '.EEM_Datetime::instance()->table().'.DTT_EVT_start ) as event_start_date ';
+		foreach ((array) $orderby_params as $orderby) {
+			switch ($orderby) {
 
 				case 'ticket_start' :
-					$SQL .= ', ' . EEM_Ticket::instance()->table() . '.TKT_start_date' ;
+					$SQL .= ', '.EEM_Ticket::instance()->table().'.TKT_start_date';
 					break;
 
 				case 'ticket_end' :
-					$SQL .= ', ' . EEM_Ticket::instance()->table() . '.TKT_end_date' ;
+					$SQL .= ', '.EEM_Ticket::instance()->table().'.TKT_end_date';
 					break;
 
 				case 'venue_title' :
-					$SQL .= ', Venue.post_title AS venue_title' ;
+					$SQL .= ', Venue.post_title AS venue_title';
 					break;
 
 				case 'city' :
-					$SQL .= ', ' . EEM_Venue::instance()->second_table() . '.VNU_city' ;
+					$SQL .= ', '.EEM_Venue::instance()->second_table().'.VNU_city';
 					break;
 
 				case 'state' :
-					$SQL .= ', ' . EEM_State::instance()->table() . '.STA_name' ;
+					$SQL .= ', '.EEM_State::instance()->table().'.STA_name';
 					break;
 
 			}
@@ -297,12 +297,12 @@ 
 	 * @param WP_Query $wp_query
 	 * @return    string
 	 */
-	public static function posts_join( $SQL = '', WP_Query $wp_query ) {
-		if ( EEH_Event_Query::apply_query_filters( $wp_query ) ) {
+	public static function posts_join($SQL = '', WP_Query $wp_query) {
+		if (EEH_Event_Query::apply_query_filters($wp_query)) {
 			// Category
-			$SQL = EEH_Event_Query::posts_join_sql_for_show_expired( $SQL, EEH_Event_Query::$_event_query_show_expired );
-			$SQL = EEH_Event_Query::posts_join_sql_for_terms( $SQL, EEH_Event_Query::$_event_query_category );
-			$SQL = EEH_Event_Query::posts_join_for_orderby( $SQL, EEH_Event_Query::$_event_query_orderby );
+			$SQL = EEH_Event_Query::posts_join_sql_for_show_expired($SQL, EEH_Event_Query::$_event_query_show_expired);
+			$SQL = EEH_Event_Query::posts_join_sql_for_terms($SQL, EEH_Event_Query::$_event_query_category);
+			$SQL = EEH_Event_Query::posts_join_for_orderby($SQL, EEH_Event_Query::$_event_query_orderby);
 		}
 		return $SQL;
 	}
@@ -317,11 +317,11 @@ 
 	 * @param    boolean $show_expired if TRUE, then displayed past events
 	 * @return string
 	 */
-	public static function posts_join_sql_for_show_expired( $SQL = '', $show_expired = FALSE ) {
-		if ( ! $show_expired ) {
-			$join = EEM_Event::instance()->table() . '.ID = ' . EEM_Datetime::instance()->table() . '.' . EEM_Event::instance()->primary_key_name();
-			if ( strpos( $SQL, $join ) === FALSE ) {
-				$SQL .= ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . $join . ' ) ';
+	public static function posts_join_sql_for_show_expired($SQL = '', $show_expired = FALSE) {
+		if ( ! $show_expired) {
+			$join = EEM_Event::instance()->table().'.ID = '.EEM_Datetime::instance()->table().'.'.EEM_Event::instance()->primary_key_name();
+			if (strpos($SQL, $join) === FALSE) {
+				$SQL .= ' INNER JOIN '.EEM_Datetime::instance()->table().' ON ( '.$join.' ) ';
 			}
 		}
 		return $SQL;
@@ -337,8 +337,8 @@ 
 	 * @param 	string $join_terms pass TRUE or term string, doesn't really matter since this value doesn't really get used for anything yet
 	 * @return 	string
 	 */
-	public static function posts_join_sql_for_terms( $SQL = '', $join_terms = '' ) {
-		if ( ! empty( $join_terms ) ) {
+	public static function posts_join_sql_for_terms($SQL = '', $join_terms = '') {
+		if ( ! empty($join_terms)) {
 			global $wpdb;
 			$SQL .= " LEFT JOIN $wpdb->term_relationships ON ($wpdb->posts.ID = $wpdb->term_relationships.object_id)";
 			$SQL .= " LEFT JOIN $wpdb->term_taxonomy ON ($wpdb->term_relationships.term_taxonomy_id = $wpdb->term_taxonomy.term_taxonomy_id)";
@@ -358,25 +358,25 @@ 
 	 * @param 	array $orderby_params
 	 * @return 	string
 	 */
-	public static function posts_join_for_orderby( $SQL = '', $orderby_params = array() ) {
-		foreach ( (array)$orderby_params as $orderby ) {
-			switch ( $orderby ) {
+	public static function posts_join_for_orderby($SQL = '', $orderby_params = array()) {
+		foreach ((array) $orderby_params as $orderby) {
+			switch ($orderby) {
 				case 'ticket_start' :
 				case 'ticket_end' :
-					$SQL .= EEH_Event_Query::_posts_join_for_datetime( $SQL, EEM_Datetime_Ticket::instance()->table() . '.' . EEM_Datetime::instance()->primary_key_name() );
-					$SQL .= ' LEFT JOIN ' . EEM_Ticket::instance()->table() . ' ON (' . EEM_Datetime_Ticket::instance()->table() . '.' . EEM_Ticket::instance()->primary_key_name() . ' = ' . EEM_Ticket::instance()->table() . '.' . EEM_Ticket::instance()->primary_key_name() . ' )';
+					$SQL .= EEH_Event_Query::_posts_join_for_datetime($SQL, EEM_Datetime_Ticket::instance()->table().'.'.EEM_Datetime::instance()->primary_key_name());
+					$SQL .= ' LEFT JOIN '.EEM_Ticket::instance()->table().' ON ('.EEM_Datetime_Ticket::instance()->table().'.'.EEM_Ticket::instance()->primary_key_name().' = '.EEM_Ticket::instance()->table().'.'.EEM_Ticket::instance()->primary_key_name().' )';
 					break;
 				case 'venue_title' :
 				case 'city' :
-					$SQL .= EEH_Event_Query::_posts_join_for_event_venue( $SQL );
+					$SQL .= EEH_Event_Query::_posts_join_for_event_venue($SQL);
 					break;
 				case 'state' :
-					$SQL .= EEH_Event_Query::_posts_join_for_event_venue( $SQL );
-					$SQL .= EEH_Event_Query::_posts_join_for_venue_state( $SQL );
+					$SQL .= EEH_Event_Query::_posts_join_for_event_venue($SQL);
+					$SQL .= EEH_Event_Query::_posts_join_for_venue_state($SQL);
 					break;
 				case 'start_date' :
 				default :
-					$SQL .= EEH_Event_Query::_posts_join_for_datetime( $SQL, EEM_Event::instance()->table() . '.ID' );
+					$SQL .= EEH_Event_Query::_posts_join_for_datetime($SQL, EEM_Event::instance()->table().'.ID');
 					break;
 
 			}
@@ -394,11 +394,11 @@ 
 	 * @param string $join
 	 * @return string
 	 */
-	protected static function _posts_join_for_datetime( $SQL = '', $join = '' ) {
-		if ( ! empty( $join )) {
-			$join .= ' = ' . EEM_Datetime::instance()->table() . '.' . EEM_Event::instance()->primary_key_name();
-			if ( strpos( $SQL, $join ) === FALSE ) {
-				return ' INNER JOIN ' . EEM_Datetime::instance()->table() . ' ON ( ' . $join . ' )';
+	protected static function _posts_join_for_datetime($SQL = '', $join = '') {
+		if ( ! empty($join)) {
+			$join .= ' = '.EEM_Datetime::instance()->table().'.'.EEM_Event::instance()->primary_key_name();
+			if (strpos($SQL, $join) === FALSE) {
+				return ' INNER JOIN '.EEM_Datetime::instance()->table().' ON ( '.$join.' )';
 			}
 		}
 		return '';
@@ -413,13 +413,13 @@ 
 	 * @param string $SQL
 	 * @return string
 	 */
-	protected static function _posts_join_for_event_venue( $SQL = '' ) {
+	protected static function _posts_join_for_event_venue($SQL = '') {
 		// Event Venue table name
 		$event_venue_table = EEM_Event_Venue::instance()->table();
 		// generate conditions for:  Event <=> Event Venue  JOIN clause
-		$event_to_event_venue_join = EEM_Event::instance()->table() . '.ID = ' . $event_venue_table . '.' . EEM_Event::instance()->primary_key_name();
+		$event_to_event_venue_join = EEM_Event::instance()->table().'.ID = '.$event_venue_table.'.'.EEM_Event::instance()->primary_key_name();
 		// don't add joins if they have already been added
-		if ( strpos( $SQL, $event_to_event_venue_join ) === FALSE ) {
+		if (strpos($SQL, $event_to_event_venue_join) === FALSE) {
 			// Venue table name
 			$venue_table = EEM_Venue::instance()->table();
 			// Venue table pk
@@ -432,10 +432,10 @@ 
 			$venue_SQL .= " LEFT JOIN $venue_table as Venue ON ( $event_venue_table.$venue_table_pk = Venue.ID )";
 			// generate JOIN clause for: Venue <=> Venue Meta
 			$venue_SQL .= " LEFT JOIN $venue_meta_table ON ( Venue.ID = $venue_meta_table.$venue_table_pk )";
-			unset( $event_venue_table, $event_to_event_venue_join, $venue_table, $venue_table_pk, $venue_meta_table );
+			unset($event_venue_table, $event_to_event_venue_join, $venue_table, $venue_table_pk, $venue_meta_table);
 			return $venue_SQL;
 		}
-		unset( $event_venue_table, $event_to_event_venue_join );
+		unset($event_venue_table, $event_to_event_venue_join);
 		return '';
 	}
 
@@ -448,7 +448,7 @@ 
 	 * @param string $SQL
 	 * @return string
 	 */
-	protected static function _posts_join_for_venue_state( $SQL = '' ) {
+	protected static function _posts_join_for_venue_state($SQL = '') {
 		// Venue Meta table name
 		$venue_meta_table = EEM_Venue::instance()->second_table();
 		// State table name
@@ -456,16 +456,16 @@ 
 		// State table pk
 		$state_table_pk = EEM_State::instance()->primary_key_name();
 		// verify vars
-		if ( $venue_meta_table && $state_table && $state_table_pk ) {
+		if ($venue_meta_table && $state_table && $state_table_pk) {
 			// like: wp_esp_venue_meta.STA_ID = wp_esp_state.STA_ID
 			$join = "$venue_meta_table.$state_table_pk = $state_table.$state_table_pk";
 			// don't add join if it has already been added
-			if ( strpos( $SQL, $join ) === FALSE ) {
-				unset( $state_table_pk, $venue_meta_table, $venue_table_pk );
+			if (strpos($SQL, $join) === FALSE) {
+				unset($state_table_pk, $venue_meta_table, $venue_table_pk);
 				return " LEFT JOIN $state_table ON ( $join )";
 			}
 		}
-		unset( $join, $state_table, $state_table_pk, $venue_meta_table, $venue_table_pk );
+		unset($join, $state_table, $state_table_pk, $venue_meta_table, $venue_table_pk);
 		return '';
 	}
 
@@ -479,14 +479,14 @@ 
 	 * @param WP_Query $wp_query
 	 * @return    string
 	 */
-	public static function posts_where( $SQL = '', WP_Query $wp_query ) {
-		if ( EEH_Event_Query::apply_query_filters( $wp_query ) ) {
+	public static function posts_where($SQL = '', WP_Query $wp_query) {
+		if (EEH_Event_Query::apply_query_filters($wp_query)) {
 			// Show Expired ?
-			$SQL .= EEH_Event_Query::posts_where_sql_for_show_expired( EEH_Event_Query::$_event_query_show_expired  );
+			$SQL .= EEH_Event_Query::posts_where_sql_for_show_expired(EEH_Event_Query::$_event_query_show_expired);
 			// Category
-			$SQL .= EEH_Event_Query::posts_where_sql_for_event_category_slug( EEH_Event_Query::$_event_query_category  );
+			$SQL .= EEH_Event_Query::posts_where_sql_for_event_category_slug(EEH_Event_Query::$_event_query_category);
 			// Start Date
-			$SQL .= EEH_Event_Query::posts_where_sql_for_event_list_month( EEH_Event_Query::$_event_query_month );
+			$SQL .= EEH_Event_Query::posts_where_sql_for_event_list_month(EEH_Event_Query::$_event_query_month);
 		}
 		return $SQL;
 	}
@@ -500,8 +500,8 @@ 
 	 * @param    boolean $show_expired if TRUE, then displayed past events
 	 * @return    string
 	 */
-	public static function posts_where_sql_for_show_expired( $show_expired = FALSE ) {
-		return ! $show_expired ? ' AND ' . EEM_Datetime::instance()->table() . '.DTT_EVT_end > "' . current_time( 'mysql', TRUE ) . '" ' : '';
+	public static function posts_where_sql_for_show_expired($show_expired = FALSE) {
+		return ! $show_expired ? ' AND '.EEM_Datetime::instance()->table().'.DTT_EVT_end > "'.current_time('mysql', TRUE).'" ' : '';
 	}
 
 
@@ -513,9 +513,9 @@ 
 	 * @param    boolean $event_category_slug
 	 * @return    string
 	 */
-	public static function posts_where_sql_for_event_category_slug( $event_category_slug = NULL ) {
+	public static function posts_where_sql_for_event_category_slug($event_category_slug = NULL) {
 		global $wpdb;
-		return ! empty( $event_category_slug ) ? ' AND ' . $wpdb->terms . '.slug = "' . $event_category_slug . '" ' : '';
+		return ! empty($event_category_slug) ? ' AND '.$wpdb->terms.'.slug = "'.$event_category_slug.'" ' : '';
 	}
 
 
@@ -527,13 +527,13 @@ 
 	 * @param    boolean $month
 	 * @return    string
 	 */
-	public static function posts_where_sql_for_event_list_month( $month = NULL ) {
+	public static function posts_where_sql_for_event_list_month($month = NULL) {
 		$SQL = '';
-		if ( ! empty( $month ) ) {
+		if ( ! empty($month)) {
 			// event start date is LESS than the end of the month ( so nothing that doesn't start until next month )
-			$SQL = ' AND ' . EEM_Datetime::instance()->table() . '.DTT_EVT_start <= "' . gmdate( 'Y-m-t 23:59:59', strtotime( $month ) ) . '"';
+			$SQL = ' AND '.EEM_Datetime::instance()->table().'.DTT_EVT_start <= "'.gmdate('Y-m-t 23:59:59', strtotime($month)).'"';
 			// event end date is GREATER than the start of the month ( so nothing that ended before this month )
-			$SQL .= ' AND ' . EEM_Datetime::instance()->table() . '.DTT_EVT_end >= "' . gmdate( 'Y-m-01 0:0:00', strtotime( $month ) ) . '" ';
+			$SQL .= ' AND '.EEM_Datetime::instance()->table().'.DTT_EVT_end >= "'.gmdate('Y-m-01 0:0:00', strtotime($month)).'" ';
 		}
 		return $SQL;
 	}
@@ -548,9 +548,9 @@ 
 	 * @param WP_Query $wp_query
 	 * @return    string
 	 */
-	public static function posts_orderby( $SQL = '', WP_Query $wp_query ) {
-		if ( EEH_Event_Query::apply_query_filters( $wp_query ) ) {
-			$SQL = EEH_Event_Query::posts_orderby_sql( EEH_Event_Query::$_event_query_orderby, EEH_Event_Query::$_event_query_sort );
+	public static function posts_orderby($SQL = '', WP_Query $wp_query) {
+		if (EEH_Event_Query::apply_query_filters($wp_query)) {
+			$SQL = EEH_Event_Query::posts_orderby_sql(EEH_Event_Query::$_event_query_orderby, EEH_Event_Query::$_event_query_sort);
 		}
 		return $SQL;
 	}
@@ -581,63 +581,63 @@ 
 	 * @param string     $sort
 	 * @return string
 	 */
-	public static function posts_orderby_sql( $orderby_params = array(), $sort = 'ASC' ) {
+	public static function posts_orderby_sql($orderby_params = array(), $sort = 'ASC') {
 		global $wpdb;
 		$SQL = '';
 		$counter = 0;
 		//make sure 'orderby' is set in query params
-		if ( ! isset( self::$_query_params['orderby'] )) {
+		if ( ! isset(self::$_query_params['orderby'])) {
 			self::$_query_params['orderby'] = array();
 		}
 		// loop thru $orderby_params (type cast as array)
-		foreach ( (array)$orderby_params as $orderby ) {
+		foreach ((array) $orderby_params as $orderby) {
 			// check if we have already added this param
-			if ( isset( self::$_query_params['orderby'][ $orderby ] )) {
+			if (isset(self::$_query_params['orderby'][$orderby])) {
 				// if so then remove from the $orderby_params so that the count() method below is accurate
-				unset( $orderby_params[ $orderby ] );
+				unset($orderby_params[$orderby]);
 				// then bump ahead to the next param
 				continue;
 			}
 			// this will ad a comma depending on whether this is the first or last param
-			$glue = $counter == 0 || $counter == count( $orderby_params ) ? ' ' : ', ';
+			$glue = $counter == 0 || $counter == count($orderby_params) ? ' ' : ', ';
 			// ok what's we dealing with?
-			switch ( $orderby ) {
+			switch ($orderby) {
 				case 'id' :
 				case 'ID' :
-					$SQL .= $glue . $wpdb->posts . '.ID ' . $sort;
+					$SQL .= $glue.$wpdb->posts.'.ID '.$sort;
 					break;
 				case 'end_date' :
-					$SQL .= $glue . EEM_Datetime::instance()->table() . '.DTT_EVT_end ' . $sort;
+					$SQL .= $glue.EEM_Datetime::instance()->table().'.DTT_EVT_end '.$sort;
 					break;
 				case 'event_name' :
-					$SQL .= $glue . $wpdb->posts . '.post_title ' . $sort;
+					$SQL .= $glue.$wpdb->posts.'.post_title '.$sort;
 					break;
 				case 'category_slug' :
-					$SQL .= $glue . $wpdb->terms . '.slug ' . $sort;
+					$SQL .= $glue.$wpdb->terms.'.slug '.$sort;
 					break;
 				case 'ticket_start' :
-					$SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_start_date ' . $sort;
+					$SQL .= $glue.EEM_Ticket::instance()->table().'.TKT_start_date '.$sort;
 					break;
 				case 'ticket_end' :
-					$SQL .= $glue . EEM_Ticket::instance()->table() . '.TKT_end_date ' . $sort;
+					$SQL .= $glue.EEM_Ticket::instance()->table().'.TKT_end_date '.$sort;
 					break;
 				case 'venue_title' :
-					$SQL .= $glue . 'venue_title ' . $sort;
+					$SQL .= $glue.'venue_title '.$sort;
 					break;
 				case 'city' :
-					$SQL .= $glue . EEM_Venue::instance()->second_table() . '.VNU_city ' . $sort;
+					$SQL .= $glue.EEM_Venue::instance()->second_table().'.VNU_city '.$sort;
 					break;
 				case 'state' :
-					$SQL .= $glue . EEM_State::instance()->table() . '.STA_name ' . $sort;
+					$SQL .= $glue.EEM_State::instance()->table().'.STA_name '.$sort;
 					break;
 				case 'start_date' :
 				default :
-					$SQL .= $glue . ' event_start_date ' . $sort;
+					$SQL .= $glue.' event_start_date '.$sort;
 					break;
 			}
 			// add to array of orderby params that have been added
-			self::$_query_params['orderby'][ $orderby ] = TRUE;
-			$counter ++;
+			self::$_query_params['orderby'][$orderby] = TRUE;
+			$counter++;
 		}
 		return $SQL;
 	}

core/helpers/EEH_Maps.helper.php

Doc Comments -2 removed lines

@@ -31,7 +31,6 @@ 
 
 	/**
 	 * google_map - creates a Google Map Link
-	 * @param  array $atts aray of attributes required for the map link generation
 	 * @return string (link to map!)
 	 */
 	public static function google_map( $ee_gmaps_opts ){
@@ -116,7 +115,6 @@ 
 
 	/**
 	 * creates a Google Map Link
-	 * @param  array $atts aray of attributes required for the map link generation
 	 * @return string (link to map!)
 	 */
 	public static function espresso_google_map_js() {

Spacing +27 added lines, -27 removed lines

@@ -34,20 +34,20 @@ 
 	 * @param  array $atts aray of attributes required for the map link generation
 	 * @return string (link to map!)
 	 */
-	public static function google_map( $ee_gmaps_opts ){
+	public static function google_map($ee_gmaps_opts) {
 
 		//d( $ee_gmaps_opts );
 
-		$ee_map_width = isset( $ee_gmaps_opts['ee_map_width'] ) && ! empty( $ee_gmaps_opts['ee_map_width'] ) ? $ee_gmaps_opts['ee_map_width'] : '300';
-		$ee_map_height = isset( $ee_gmaps_opts['ee_map_height'] ) && ! empty( $ee_gmaps_opts['ee_map_height'] ) ? $ee_gmaps_opts['ee_map_height'] : '185';
-		$ee_map_zoom = isset( $ee_gmaps_opts['ee_map_zoom'] ) && ! empty( $ee_gmaps_opts['ee_map_zoom'] ) ? $ee_gmaps_opts['ee_map_zoom'] : '12';
-		$ee_map_nav_display = isset( $ee_gmaps_opts['ee_map_nav_display'] ) && ! empty( $ee_gmaps_opts['ee_map_nav_display'] ) ? 'true' : 'false';
-		$ee_map_nav_size =  isset( $ee_gmaps_opts['ee_map_nav_size'] ) && ! empty( $ee_gmaps_opts['ee_map_nav_size'] )? $ee_gmaps_opts['ee_map_nav_size'] : 'default';
-		$ee_map_type_control =  isset( $ee_gmaps_opts['ee_map_type_control'] ) && ! empty( $ee_gmaps_opts['ee_map_type_control'] )? $ee_gmaps_opts['ee_map_type_control'] : 'default';
-		$static_url =  isset( $ee_gmaps_opts['ee_static_url'] ) && ! empty( $ee_gmaps_opts['ee_static_url'] )? $ee_gmaps_opts['ee_static_url'] : FALSE;
+		$ee_map_width = isset($ee_gmaps_opts['ee_map_width']) && ! empty($ee_gmaps_opts['ee_map_width']) ? $ee_gmaps_opts['ee_map_width'] : '300';
+		$ee_map_height = isset($ee_gmaps_opts['ee_map_height']) && ! empty($ee_gmaps_opts['ee_map_height']) ? $ee_gmaps_opts['ee_map_height'] : '185';
+		$ee_map_zoom = isset($ee_gmaps_opts['ee_map_zoom']) && ! empty($ee_gmaps_opts['ee_map_zoom']) ? $ee_gmaps_opts['ee_map_zoom'] : '12';
+		$ee_map_nav_display = isset($ee_gmaps_opts['ee_map_nav_display']) && ! empty($ee_gmaps_opts['ee_map_nav_display']) ? 'true' : 'false';
+		$ee_map_nav_size = isset($ee_gmaps_opts['ee_map_nav_size']) && ! empty($ee_gmaps_opts['ee_map_nav_size']) ? $ee_gmaps_opts['ee_map_nav_size'] : 'default';
+		$ee_map_type_control = isset($ee_gmaps_opts['ee_map_type_control']) && ! empty($ee_gmaps_opts['ee_map_type_control']) ? $ee_gmaps_opts['ee_map_type_control'] : 'default';
+		$static_url = isset($ee_gmaps_opts['ee_static_url']) && ! empty($ee_gmaps_opts['ee_static_url']) ? $ee_gmaps_opts['ee_static_url'] : FALSE;
 
-		if( isset( $ee_gmaps_opts['ee_map_align'] ) && ! empty( $ee_gmaps_opts['ee_map_align'] )){
-			switch( $ee_gmaps_opts['ee_map_align'] ){
+		if (isset($ee_gmaps_opts['ee_map_align']) && ! empty($ee_gmaps_opts['ee_map_align'])) {
+			switch ($ee_gmaps_opts['ee_map_align']) {
 				case "left":
 					$map_align = 'ee-gmap-align-left left';
 					break;
@@ -68,18 +68,18 @@ 
 
 		// Determine whether user has set a hardoded url to use and
 		// if so display a Google static iframe map else run V3 api
-		if( $static_url ) {
+		if ($static_url) {
 
-			$html = '<div class="ee-gmap-iframewrap ee-gmap-wrapper ' . $map_align . '">';
-			$html .= '<iframe src="' . $static_url . '&output=embed" style="width: ' . $ee_map_width  .'px; height: ' . $ee_map_height . 'px;" frameborder="0" scrolling="no">';
+			$html = '<div class="ee-gmap-iframewrap ee-gmap-wrapper '.$map_align.'">';
+			$html .= '<iframe src="'.$static_url.'&output=embed" style="width: '.$ee_map_width.'px; height: '.$ee_map_height.'px;" frameborder="0" scrolling="no">';
 			$html .= '</iframe>';
-			$html .= '<a href="' . $static_url . '">View Large map</a>';
+			$html .= '<a href="'.$static_url.'">View Large map</a>';
 			$html .= '</div>';
 			return $html;
 
 		 } else {
 
-			EEH_Maps::$gmap_vars[ $ee_gmaps_opts['map_ID'] ] = array(
+			EEH_Maps::$gmap_vars[$ee_gmaps_opts['map_ID']] = array(
 				'map_ID' => $ee_gmaps_opts['map_ID'],
 				'ee_map_zoom' => $ee_map_zoom,
 				'ee_map_nav_display' => $ee_map_nav_display,
@@ -89,12 +89,12 @@ 
 			);
 
 			$html = '<div class="ee-gmap-wrapper '.$map_align.';">';
-			$html .= '<div class="ee-gmap" id="map_canvas_' . $ee_gmaps_opts['map_ID'] .'" style="width: '.$ee_map_width.'px; height: '.$ee_map_height.'px;"></div>';  //
+			$html .= '<div class="ee-gmap" id="map_canvas_'.$ee_gmaps_opts['map_ID'].'" style="width: '.$ee_map_width.'px; height: '.$ee_map_height.'px;"></div>'; //
 			$html .= '</div>';
 
-			wp_enqueue_script( 'gmap_api' );
-			wp_enqueue_script( 'ee_gmap' );
-			add_action( 'wp_footer', array( 'EEH_Maps', 'footer_enqueue_script' ));
+			wp_enqueue_script('gmap_api');
+			wp_enqueue_script('ee_gmap');
+			add_action('wp_footer', array('EEH_Maps', 'footer_enqueue_script'));
 
 			return $html;
 
@@ -109,7 +109,7 @@ 
 	 * @return void
 	 */
 	public static function footer_enqueue_script() {
-		wp_localize_script( 'ee_gmap', 'ee_gmap_vars', EEH_Maps::$gmap_vars );
+		wp_localize_script('ee_gmap', 'ee_gmap_vars', EEH_Maps::$gmap_vars);
 	}
 
 
@@ -121,8 +121,8 @@ 
 	 */
 	public static function espresso_google_map_js() {
 		$scheme = is_ssl() ? 'https://' : 'http://';
-		wp_register_script( 'gmap_api', $scheme . 'maps.google.com/maps/api/js?sensor=false', array('jquery'), NULL, TRUE );
-		wp_register_script( 'ee_gmap', plugin_dir_url(__FILE__) . 'assets/ee_gmap.js', array('gmap_api'), '1.0', TRUE );
+		wp_register_script('gmap_api', $scheme.'maps.google.com/maps/api/js?sensor=false', array('jquery'), NULL, TRUE);
+		wp_register_script('ee_gmap', plugin_dir_url(__FILE__).'assets/ee_gmap.js', array('gmap_api'), '1.0', TRUE);
 	}
 
 	/**
@@ -131,7 +131,7 @@ 
 	 * @return string (link to map!)
 	 */
 	public static function google_map_link($atts) {
-		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
 		extract($atts);
 
 		$address = "{$address}";
@@ -146,9 +146,9 @@ 
 		$id = isset($id) ? $id : 'not_set';
 		$map_image_class = isset($map_image_class) ? $map_image_class : 'ee_google_map_view';
 
-		$address_string = ($address != '' ? $address : '') . ($city != '' ? ',' . $city : '') . ($state != '' ? ',' . $state : '') . ($zip != '' ? ',' . $zip : '') . ($country != '' ? ',' . $country : '');
+		$address_string = ($address != '' ? $address : '').($city != '' ? ','.$city : '').($state != '' ? ','.$state : '').($zip != '' ? ','.$zip : '').($country != '' ? ','.$country : '');
 
-		$google_map = htmlentities2('http://maps.google.com/maps?q=' . urlencode( $address_string ));
+		$google_map = htmlentities2('http://maps.google.com/maps?q='.urlencode($address_string));
 
 		switch ($type) {
 			case 'text':
@@ -162,10 +162,10 @@ 
 
 			case 'map':
 				$scheme = is_ssl() ? 'https://' : 'http://';
-				return '<a class="a_map_image_link" href="' . $google_map . '" target="_blank">' . '<img class="map_image_link" id="venue_map_' . $id . '" ' . $map_image_class . ' src="' . htmlentities2( $scheme . 'maps.googleapis.com/maps/api/staticmap?center=' . urlencode( $address_string ) . '&amp;zoom=14&amp;size=' . $map_w . 'x' . $map_h . '&amp;markers=color:green|label:|' . urlencode( $address_string ) . '&amp;sensor=false' ) . '" /></a>';
+				return '<a class="a_map_image_link" href="'.$google_map.'" target="_blank">'.'<img class="map_image_link" id="venue_map_'.$id.'" '.$map_image_class.' src="'.htmlentities2($scheme.'maps.googleapis.com/maps/api/staticmap?center='.urlencode($address_string).'&amp;zoom=14&amp;size='.$map_w.'x'.$map_h.'&amp;markers=color:green|label:|'.urlencode($address_string).'&amp;sensor=false').'" /></a>';
 		}
 
-		return '<a href="' . $google_map . '" target="_blank">' . $text . '</a>';
+		return '<a href="'.$google_map.'" target="_blank">'.$text.'</a>';
 	}
 
 

core/helpers/EEH_Qtip_Loader.helper.php

Doc Comments +1 added lines, -1 removed lines

@@ -109,7 +109,7 @@
 	 * - registers and enqueues the qtip scripts and styles.
 	 *
 	 * @access public
-	 * @param  array  $paths      Array of paths to check for the EE_Qtip class. If present we check these path(s) first.  If not present (empty array), then it's assumed it's either in core/libraries/qtips OR the file is already loaded.
+	 * @param  string[]  $paths      Array of paths to check for the EE_Qtip class. If present we check these path(s) first.  If not present (empty array), then it's assumed it's either in core/libraries/qtips OR the file is already loaded.
 	 * @param  string|array $configname name of the Qtip class (full class name is expected and will be used for looking for file, Qtip config classes must extend EE_Qtip_Config) [if this is an array, then we loop through the array to instantiate and setup the qtips]
 	 * @return void
 	 */

Spacing +44 added lines, -44 removed lines

@@ -32,7 +32,7 @@ 
 	 */
 	public static function instance() {
 		// check if class object is instantiated
-		if ( self::$_instance === NULL  or ! is_object( self::$_instance ) or ! ( self::$_instance instanceof EEH_Qtip_Loader )) {
+		if (self::$_instance === NULL or ! is_object(self::$_instance) or ! (self::$_instance instanceof EEH_Qtip_Loader)) {
 			self::$_instance = new self();
 		}
 		return self::$_instance;
@@ -48,8 +48,8 @@ 
 	 */
 	private function __construct() {
 		//let's just make sure this is instantiated in the right place.
-		if ( did_action( 'wp_print_styles' ) || did_action( 'admin_head' )) {
-			EE_Error::doing_it_wrong( 'EEH_Qtip_Loader', __('This helper must be instantiated before or within a callback for the WordPress wp_enqueue_scripts hook action hook.', 'event_espresso' ), '4.1' );
+		if (did_action('wp_print_styles') || did_action('admin_head')) {
+			EE_Error::doing_it_wrong('EEH_Qtip_Loader', __('This helper must be instantiated before or within a callback for the WordPress wp_enqueue_scripts hook action hook.', 'event_espresso'), '4.1');
 		}
 	}
 
@@ -61,27 +61,27 @@ 
 	 * @return void
 	 */
 	public function register_and_enqueue() {
-		$qtips_js = !defined('SCRIPT_DEBUG') ? EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.js' : EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.js';
-		$qtip_images_loaded = EE_THIRD_PARTY_URL . 'qtip/imagesloaded.pkg.min.js';
-		$qtip_map = EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.map';
-		$qtipcss = !defined('SCRIPT_DEBUG') ? EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.css' : EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.css';
+		$qtips_js = ! defined('SCRIPT_DEBUG') ? EE_THIRD_PARTY_URL.'qtip/jquery.qtip.min.js' : EE_THIRD_PARTY_URL.'qtip/jquery.qtip.js';
+		$qtip_images_loaded = EE_THIRD_PARTY_URL.'qtip/imagesloaded.pkg.min.js';
+		$qtip_map = EE_THIRD_PARTY_URL.'qtip/jquery.qtip.min.map';
+		$qtipcss = ! defined('SCRIPT_DEBUG') ? EE_THIRD_PARTY_URL.'qtip/jquery.qtip.min.css' : EE_THIRD_PARTY_URL.'qtip/jquery.qtip.css';
 
-		wp_register_script('qtip-map', $qtip_map, array(), '3', TRUE );
-		wp_register_script('qtip-images-loaded', $qtip_images_loaded, array(), '2.2.0', TRUE );
-		wp_register_script('qtip', $qtips_js, array('jquery'), '2.2.0', TRUE );
-		wp_register_script('ee-qtip-helper', EE_HELPERS_ASSETS . 'ee-qtip-helper.js', array('qtip', 'jquery-cookie'), EVENT_ESPRESSO_VERSION, TRUE );
+		wp_register_script('qtip-map', $qtip_map, array(), '3', TRUE);
+		wp_register_script('qtip-images-loaded', $qtip_images_loaded, array(), '2.2.0', TRUE);
+		wp_register_script('qtip', $qtips_js, array('jquery'), '2.2.0', TRUE);
+		wp_register_script('ee-qtip-helper', EE_HELPERS_ASSETS.'ee-qtip-helper.js', array('qtip', 'jquery-cookie'), EVENT_ESPRESSO_VERSION, TRUE);
 
-		wp_register_style('qtip-css', $qtipcss, array(), '2.2' );
+		wp_register_style('qtip-css', $qtipcss, array(), '2.2');
 
 		//k now let's see if there are any registered qtips.  If there are, then we need to setup the localized script for ee-qtip-helper.js (and enqueue ee-qtip-helper.js of course!)
-		if ( !empty( $this->_qtips ) ) {
+		if ( ! empty($this->_qtips)) {
 			wp_enqueue_script('ee-qtip-helper');
 			wp_enqueue_style('qtip-css');
 			$qtips = array();
-			foreach ( $this->_qtips as $qtip ) {
+			foreach ($this->_qtips as $qtip) {
 				$qts = $qtip->get_tips();
-				foreach ( $qts as $qt ) {
-					if ( ! $qt instanceof EE_Qtip )
+				foreach ($qts as $qt) {
+					if ( ! $qt instanceof EE_Qtip)
 						continue;
 					$qtips[] = array(
 						'content_id' => $qt->content_id,
@@ -90,8 +90,8 @@ 
 						);
 				}
 			}
-			if ( !empty($qtips) )
-				wp_localize_script('ee-qtip-helper', 'EE_QTIP_HELPER', array( 'qtips' => $qtips ) );
+			if ( ! empty($qtips))
+				wp_localize_script('ee-qtip-helper', 'EE_QTIP_HELPER', array('qtips' => $qtips));
 
 		} else {
 			//qtips has been requested without any registration (so assuming its just directly used in the admin).
@@ -113,24 +113,24 @@ 
 	 * @param  string|array $configname name of the Qtip class (full class name is expected and will be used for looking for file, Qtip config classes must extend EE_Qtip_Config) [if this is an array, then we loop through the array to instantiate and setup the qtips]
 	 * @return void
 	 */
-	public function register( $configname, $paths = array() ) {
+	public function register($configname, $paths = array()) {
 
 		//let's just make sure this is instantiated in the right place.
-		if ( did_action('wp_enqueue_scripts') || did_action('admin_enqueue_scripts') ) {
-			EE_Error::doing_it_wrong( 'EEH_Qtip_Loader->register()', __('EE_Qtip_Config objects must be registered before wp_enqueue_scripts is called.', 'event_espresso' ), '4.1' );
+		if (did_action('wp_enqueue_scripts') || did_action('admin_enqueue_scripts')) {
+			EE_Error::doing_it_wrong('EEH_Qtip_Loader->register()', __('EE_Qtip_Config objects must be registered before wp_enqueue_scripts is called.', 'event_espresso'), '4.1');
 		}
 
 		$configname = (array) $configname; //typecast to array
-		foreach ( $configname as $config ) {
-			$this->_register( $config, $paths );
+		foreach ($configname as $config) {
+			$this->_register($config, $paths);
 		}
 
 		//hook into appropriate footer
 		$footer_action = is_admin() ? 'admin_footer' : 'wp_footer';
-		add_action($footer_action, array($this, 'setup_qtip'), 10 );
+		add_action($footer_action, array($this, 'setup_qtip'), 10);
 
 		//make sure we "turn on" qtip js.
-		add_filter('FHEE_load_qtip', '__return_true' );
+		add_filter('FHEE_load_qtip', '__return_true');
 	}
 
 
@@ -144,15 +144,15 @@ 
 	 * @throws EE_Error
 	 * @return void
 	 */
-	private function _register( $config, $paths ) {
+	private function _register($config, $paths) {
 		//before doing anything we have to make sure that EE_Qtip_Config parent is required.
-		EE_Registry::instance()->load_lib( 'Qtip_Config', array(), TRUE );
+		EE_Registry::instance()->load_lib('Qtip_Config', array(), TRUE);
 
-		if ( !empty( $paths ) ) {
+		if ( ! empty($paths)) {
 			$paths = (array) $paths;
-			foreach ( $paths as $path ) {
-				$path = $path . $config . '.lib.php';
-				if ( !is_readable($path ) ) {
+			foreach ($paths as $path) {
+				$path = $path.$config.'.lib.php';
+				if ( ! is_readable($path)) {
 					continue;
 				} else {
 					require_once $path;
@@ -161,26 +161,26 @@ 
 		}
 
 		//does class exist at this point?  If it does then let's instantiate.  If it doesn't then let's continue with other paths.
-		if ( !class_exists($config) ) {
-			$path = EE_LIBRARIES . 'qtips/' . $config . '.lib.php';
-			if ( !is_readable($path ) ) {
-				throw new EE_Error( sprintf( __('Unable to load the Qtip Config registered for this page (%s) because none of the file paths attempted are readable.  Please check the spelling of the paths you\'ve used in the registration', 'event_espresso'), $config ) );
+		if ( ! class_exists($config)) {
+			$path = EE_LIBRARIES.'qtips/'.$config.'.lib.php';
+			if ( ! is_readable($path)) {
+				throw new EE_Error(sprintf(__('Unable to load the Qtip Config registered for this page (%s) because none of the file paths attempted are readable.  Please check the spelling of the paths you\'ve used in the registration', 'event_espresso'), $config));
 			} else {
 				require_once $path;
 			}
 		}
 
 		//now we attempt a class_exists one more time.
-		if ( !class_exists( $config ) )
-			throw new EE_Error( sprintf( __('The Qtip_Config class being registered (%s) does not exist, please check the spelling.', 'event_espresso'), $config ) );
+		if ( ! class_exists($config))
+			throw new EE_Error(sprintf(__('The Qtip_Config class being registered (%s) does not exist, please check the spelling.', 'event_espresso'), $config));
 
 		//made it HERE?  FINALLY, let's get things setup.
 		$a = new ReflectionClass($config);
 		$qtip = $a->newInstance();
 
 		//verify that $qtip is a valid object
-		if ( ! $qtip instanceof EE_Qtip_Config )
-			throw new EE_Error( sprintf( __( 'The class given for the Qtip loader (%s) is not a child of the <strong>EE_Qtip_Config</strong> class. Please make sure you are extending EE_Qtip_Config.', 'event_espresso'), $config ) );
+		if ( ! $qtip instanceof EE_Qtip_Config)
+			throw new EE_Error(sprintf(__('The class given for the Qtip loader (%s) is not a child of the <strong>EE_Qtip_Config</strong> class. Please make sure you are extending EE_Qtip_Config.', 'event_espresso'), $config));
 
 		$this->_qtips[] = $a->newInstance();
 
@@ -196,12 +196,12 @@ 
 	 * @return void
 	 */
 	public function setup_qtip() {
-		if ( empty( $this->_qtips ) )
+		if (empty($this->_qtips))
 			return; //no qtips!
 
 		$content = array();
 
-		foreach ( $this->_qtips as $qtip ) {
+		foreach ($this->_qtips as $qtip) {
 			$content[] = $this->_generate_content_container($qtip);
 		}
 
@@ -218,10 +218,10 @@ 
 	private function _generate_content_container($qtip) {
 		$qts = $qtip->get_tips();
 		$content = array();
-		foreach ( $qts as $qt ) {
-			if ( ! $qt instanceof EE_Qtip )
+		foreach ($qts as $qt) {
+			if ( ! $qt instanceof EE_Qtip)
 				continue;
-			$content[] = '<div class="ee-qtip-helper-content hidden" id="' . $qt->content_id . '">' . $qt->content . '</div>';
+			$content[] = '<div class="ee-qtip-helper-content hidden" id="'.$qt->content_id.'">'.$qt->content.'</div>';
 		}
 
 		return implode('<br />', $content);

Braces +19 added lines, -12 removed lines

@@ -81,8 +81,9 @@ 
 			foreach ( $this->_qtips as $qtip ) {
 				$qts = $qtip->get_tips();
 				foreach ( $qts as $qt ) {
-					if ( ! $qt instanceof EE_Qtip )
-						continue;
+					if ( ! $qt instanceof EE_Qtip ) {
+											continue;
+					}
 					$qtips[] = array(
 						'content_id' => $qt->content_id,
 						'options' => $qt->options,
@@ -90,8 +91,9 @@ 
 						);
 				}
 			}
-			if ( !empty($qtips) )
-				wp_localize_script('ee-qtip-helper', 'EE_QTIP_HELPER', array( 'qtips' => $qtips ) );
+			if ( !empty($qtips) ) {
+							wp_localize_script('ee-qtip-helper', 'EE_QTIP_HELPER', array( 'qtips' => $qtips ) );
+			}
 
 		} else {
 			//qtips has been requested without any registration (so assuming its just directly used in the admin).
@@ -171,16 +173,18 @@ 
 		}
 
 		//now we attempt a class_exists one more time.
-		if ( !class_exists( $config ) )
-			throw new EE_Error( sprintf( __('The Qtip_Config class being registered (%s) does not exist, please check the spelling.', 'event_espresso'), $config ) );
+		if ( !class_exists( $config ) ) {
+					throw new EE_Error( sprintf( __('The Qtip_Config class being registered (%s) does not exist, please check the spelling.', 'event_espresso'), $config ) );
+		}
 
 		//made it HERE?  FINALLY, let's get things setup.
 		$a = new ReflectionClass($config);
 		$qtip = $a->newInstance();
 
 		//verify that $qtip is a valid object
-		if ( ! $qtip instanceof EE_Qtip_Config )
-			throw new EE_Error( sprintf( __( 'The class given for the Qtip loader (%s) is not a child of the <strong>EE_Qtip_Config</strong> class. Please make sure you are extending EE_Qtip_Config.', 'event_espresso'), $config ) );
+		if ( ! $qtip instanceof EE_Qtip_Config ) {
+					throw new EE_Error( sprintf( __( 'The class given for the Qtip loader (%s) is not a child of the <strong>EE_Qtip_Config</strong> class. Please make sure you are extending EE_Qtip_Config.', 'event_espresso'), $config ) );
+		}
 
 		$this->_qtips[] = $a->newInstance();
 
@@ -196,8 +200,10 @@ 
 	 * @return void
 	 */
 	public function setup_qtip() {
-		if ( empty( $this->_qtips ) )
-			return; //no qtips!
+		if ( empty( $this->_qtips ) ) {
+					return;
+		}
+		//no qtips!
 
 		$content = array();
 
@@ -219,8 +225,9 @@ 
 		$qts = $qtip->get_tips();
 		$content = array();
 		foreach ( $qts as $qt ) {
-			if ( ! $qt instanceof EE_Qtip )
-				continue;
+			if ( ! $qt instanceof EE_Qtip ) {
+							continue;
+			}
 			$content[] = '<div class="ee-qtip-helper-content hidden" id="' . $qt->content_id . '">' . $qt->content . '</div>';
 		}
 

core/helpers/EEH_Template_Validator.helper.php

Doc Comments +2 added lines, -2 removed lines

@@ -131,7 +131,7 @@ 
 	/**
 	 * For verifying that a variable is indeed an array, else throw an EE_Error
 	 * @param type $variable_to_test
-	 * @param type $variable_name
+	 * @param string $variable_name
 	 * @param type $allow_empty one of 'allow_empty' or 'do_not_allow_empty'
 	 * @return void
 	 * @throws EE_Error
@@ -159,7 +159,7 @@ 
 	 * for verifying that a variable is one of the string optiosn supplied
 	 * @param mixed $variable_to_test
 	 * @param mixed $variable_name the name you've given the variable. Eg, '$foo'. THis helps in producing better error messages
-	 * @param array $string_options an array of acceptable values
+	 * @param string[] $string_options an array of acceptable values
 	 * @return void
 	 * @throws EE_Error
 	 */

Spacing +39 added lines, -39 removed lines

@@ -50,14 +50,14 @@ 
 	 * @return void
 	 * @throws EE_Error (indirectly)
 	 */
-	static function verify_is_array_of($variable_to_test,$name_of_variable,$class_name,$allow_null='allow_null'){
-		if(!WP_DEBUG)return;
-		self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
-		if('allow_null' == $allow_null && is_null($variable_to_test)){
+	static function verify_is_array_of($variable_to_test, $name_of_variable, $class_name, $allow_null = 'allow_null') {
+		if ( ! WP_DEBUG)return;
+		self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null', 'do_not_allow_null'));
+		if ('allow_null' == $allow_null && is_null($variable_to_test)) {
 			return;
 		}
 		self::verify_is_array($variable_to_test, $name_of_variable);
-		foreach($variable_to_test as $key=>$array_element){
+		foreach ($variable_to_test as $key=>$array_element) {
 			self::verify_instanceof($array_element, $key, $class_name);
 		}
 	}
@@ -73,12 +73,12 @@ 
 	 * @return void
 	 * @throws EE_Error
 	 */
-	static function verify_isnt_null($variable_to_test,$name_of_variable){
-		if(!WP_DEBUG)return;
-		if($variable_to_test==null && $variable_to_test!=0 && $variable_to_test!=FALSE){
-			$error[]=__('Variable named %s is null.','event_espresso');
-			$error[]=__("Consider looking at the stack trace to see why it wasn't set.",'event_espresso');
-			throw new EE_Error(sprintf(implode(",",$error),$name_of_variable,$name_of_variable));
+	static function verify_isnt_null($variable_to_test, $name_of_variable) {
+		if ( ! WP_DEBUG)return;
+		if ($variable_to_test == null && $variable_to_test != 0 && $variable_to_test != FALSE) {
+			$error[] = __('Variable named %s is null.', 'event_espresso');
+			$error[] = __("Consider looking at the stack trace to see why it wasn't set.", 'event_espresso');
+			throw new EE_Error(sprintf(implode(",", $error), $name_of_variable, $name_of_variable));
 		}
 	}
 	
@@ -90,12 +90,12 @@ 
 	 * @return void
 	 * @throws EE_Error
 	 */
-	static function verify_is_true($expression_to_test,$expression_string_representation){
-		if(!WP_DEBUG)return;
-		if(!$expression_to_test){
-			$error[]=__('Template error.','event_espresso');
-			$error[]=__("%s evaluated to false, but it must be true!",'event_espresso');
-			throw new EE_Error(sprintf(implode(",",$error),$expression_string_representation));
+	static function verify_is_true($expression_to_test, $expression_string_representation) {
+		if ( ! WP_DEBUG)return;
+		if ( ! $expression_to_test) {
+			$error[] = __('Template error.', 'event_espresso');
+			$error[] = __("%s evaluated to false, but it must be true!", 'event_espresso');
+			throw new EE_Error(sprintf(implode(",", $error), $expression_string_representation));
 		}
 	}
 	
@@ -111,16 +111,16 @@ 
 	 * @return void
 	 * @throws EE_Error
 	 */
-	static function verify_instanceof($variable_to_test,$name_of_variable,$class_name, $allow_null = 'do_not_allow_null'){
-		if(!WP_DEBUG)return;
-		self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
-		if($allow_null == 'allow_null' && is_null($variable_to_test)){
+	static function verify_instanceof($variable_to_test, $name_of_variable, $class_name, $allow_null = 'do_not_allow_null') {
+		if ( ! WP_DEBUG)return;
+		self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null', 'do_not_allow_null'));
+		if ($allow_null == 'allow_null' && is_null($variable_to_test)) {
 			return;
 		}
-		if( $variable_to_test == NULL ||  ! ( $variable_to_test instanceof $class_name )){
-			$msg[]=__('Variable %s is not of the correct type.','event_espresso');
-			$msg[]=__("It should be of type %s",'event_espresso');
-			throw new EE_Error(sprintf(implode(",",$msg),$name_of_variable,$name_of_variable,$class_name));
+		if ($variable_to_test == NULL || ! ($variable_to_test instanceof $class_name)) {
+			$msg[] = __('Variable %s is not of the correct type.', 'event_espresso');
+			$msg[] = __("It should be of type %s", 'event_espresso');
+			throw new EE_Error(sprintf(implode(",", $msg), $name_of_variable, $name_of_variable, $class_name));
 		}
 	}
 	
@@ -136,16 +136,16 @@ 
 	 * @return void
 	 * @throws EE_Error
 	 */
-	static function verify_is_array($variable_to_test,$variable_name,$allow_empty='allow_empty'){
-		if(!WP_DEBUG)return;
-		self::verify_argument_is_one_of($allow_empty, $variable_name, array('allow_empty','do_not_allow_empty'));
-		if(empty($variable_to_test) && 'allow_empty'==$allow_empty){
+	static function verify_is_array($variable_to_test, $variable_name, $allow_empty = 'allow_empty') {
+		if ( ! WP_DEBUG)return;
+		self::verify_argument_is_one_of($allow_empty, $variable_name, array('allow_empty', 'do_not_allow_empty'));
+		if (empty($variable_to_test) && 'allow_empty' == $allow_empty) {
 			return;
 		}
-		if(!is_array($variable_to_test)){
-			$error[]=__('Variable %s should be an array, but it is not.');
-			$error[]=__("Its value is, instead '%s'",'event_espresso');
-			throw new EE_Error(sprintf(implode(",",$error),$variable_name,$variable_name,$variable_to_test));
+		if ( ! is_array($variable_to_test)) {
+			$error[] = __('Variable %s should be an array, but it is not.');
+			$error[] = __("Its value is, instead '%s'", 'event_espresso');
+			throw new EE_Error(sprintf(implode(",", $error), $variable_name, $variable_name, $variable_to_test));
 		}
 	}
 	
@@ -163,12 +163,12 @@ 
 	 * @return void
 	 * @throws EE_Error
 	 */
-	static function verify_argument_is_one_of($variable_to_test,$variable_name,$string_options){
-		if(!WP_DEBUG)return;
-		if(!in_array($variable_to_test,$string_options)){
-			$msg[0]=__('Malconfigured template.','event_espresso');
-			$msg[1]=__("Variable named '%s' was set to '%s'. It can only be one of '%s'",'event_espresso');
-			throw new EE_Error(sprintf(implode("||",$msg),$variable_name,$variable_to_test, implode("', '",$string_options)));
+	static function verify_argument_is_one_of($variable_to_test, $variable_name, $string_options) {
+		if ( ! WP_DEBUG)return;
+		if ( ! in_array($variable_to_test, $string_options)) {
+			$msg[0] = __('Malconfigured template.', 'event_espresso');
+			$msg[1] = __("Variable named '%s' was set to '%s'. It can only be one of '%s'", 'event_espresso');
+			throw new EE_Error(sprintf(implode("||", $msg), $variable_name, $variable_to_test, implode("', '", $string_options)));
 		}
 	}
 

Braces +21 added lines, -7 removed lines

@@ -1,4 +1,6 @@ 
-<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
+}
 
 /**
  * Event Espresso
@@ -51,7 +53,9 @@ 
 	 * @throws EE_Error (indirectly)
 	 */
 	static function verify_is_array_of($variable_to_test,$name_of_variable,$class_name,$allow_null='allow_null'){
-		if(!WP_DEBUG)return;
+		if(!WP_DEBUG) {
+			return;
+		}
 		self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
 		if('allow_null' == $allow_null && is_null($variable_to_test)){
 			return;
@@ -74,7 +78,9 @@ 
 	 * @throws EE_Error
 	 */
 	static function verify_isnt_null($variable_to_test,$name_of_variable){
-		if(!WP_DEBUG)return;
+		if(!WP_DEBUG) {
+			return;
+		}
 		if($variable_to_test==null && $variable_to_test!=0 && $variable_to_test!=FALSE){
 			$error[]=__('Variable named %s is null.','event_espresso');
 			$error[]=__("Consider looking at the stack trace to see why it wasn't set.",'event_espresso');
@@ -91,7 +97,9 @@ 
 	 * @throws EE_Error
 	 */
 	static function verify_is_true($expression_to_test,$expression_string_representation){
-		if(!WP_DEBUG)return;
+		if(!WP_DEBUG) {
+			return;
+		}
 		if(!$expression_to_test){
 			$error[]=__('Template error.','event_espresso');
 			$error[]=__("%s evaluated to false, but it must be true!",'event_espresso');
@@ -112,7 +120,9 @@ 
 	 * @throws EE_Error
 	 */
 	static function verify_instanceof($variable_to_test,$name_of_variable,$class_name, $allow_null = 'do_not_allow_null'){
-		if(!WP_DEBUG)return;
+		if(!WP_DEBUG) {
+			return;
+		}
 		self::verify_argument_is_one_of($allow_null, 'allow_null', array('allow_null','do_not_allow_null'));
 		if($allow_null == 'allow_null' && is_null($variable_to_test)){
 			return;
@@ -137,7 +147,9 @@ 
 	 * @throws EE_Error
 	 */
 	static function verify_is_array($variable_to_test,$variable_name,$allow_empty='allow_empty'){
-		if(!WP_DEBUG)return;
+		if(!WP_DEBUG) {
+			return;
+		}
 		self::verify_argument_is_one_of($allow_empty, $variable_name, array('allow_empty','do_not_allow_empty'));
 		if(empty($variable_to_test) && 'allow_empty'==$allow_empty){
 			return;
@@ -164,7 +176,9 @@ 
 	 * @throws EE_Error
 	 */
 	static function verify_argument_is_one_of($variable_to_test,$variable_name,$string_options){
-		if(!WP_DEBUG)return;
+		if(!WP_DEBUG) {
+			return;
+		}
 		if(!in_array($variable_to_test,$string_options)){
 			$msg[0]=__('Malconfigured template.','event_espresso');
 			$msg[1]=__("Variable named '%s' was set to '%s'. It can only be one of '%s'",'event_espresso');

core/helpers/EEH_URL.helper.php

Doc Comments -1 removed lines

@@ -49,7 +49,6 @@
 	 * Returns whether not the remote file exists.
 	 * Checking via GET because HEAD requests are blocked on some server configurations.
 	 * @param string $url
-	 * @param boolean $sslverify whether we care if the SSL certificate for the requested site is setup properly
 	 * @return boolean
 	 */
 	public static function remote_file_exists( $url, $args = array() ){

Braces +4 added lines, -2 removed lines

@@ -1,4 +1,6 @@ 
-<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
+}
 /**
  * EEH_URL helper
  * Helper class for URL-related PHP functions
@@ -62,7 +64,7 @@ 
 				isset($results['response']['code']) &&
 				$results['response']['code'] == '200'){
 			return true;
-		}else{
+		} else{
 			return false;
 		}
 	}

Spacing +56 added lines, -56 removed lines

@@ -9,7 +9,7 @@ 
  *
  * ------------------------------------------------------------------------
  */
-class EEH_URL{
+class EEH_URL {
 
 	/**
 	 * _add_query_arg
@@ -21,30 +21,30 @@ 
 	 * @param bool  $exclude_nonce  If true then the nonce will be excluded from the generated url.
 	 * @return string
 	 */
-	public static function add_query_args_and_nonce( $args = array(), $url = '', $exclude_nonce = false ) {
-		if ( empty( $url ) ) {
-			$user_msg = __('An error occurred. A URL is a required parameter for the add_query_args_and_nonce method.', 'event_espresso' );
-			$dev_msg = $user_msg . "\n" . sprintf(
-					__('In order to dynamically generate nonces for your actions, you need to supply a valid URL as a second parameter for the %s::add_query_args_and_nonce method.', 'event_espresso' ),
+	public static function add_query_args_and_nonce($args = array(), $url = '', $exclude_nonce = false) {
+		if (empty($url)) {
+			$user_msg = __('An error occurred. A URL is a required parameter for the add_query_args_and_nonce method.', 'event_espresso');
+			$dev_msg = $user_msg."\n".sprintf(
+					__('In order to dynamically generate nonces for your actions, you need to supply a valid URL as a second parameter for the %s::add_query_args_and_nonce method.', 'event_espresso'),
 					__CLASS__
 				);
-			EE_Error::add_error( $user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__ );
+			EE_Error::add_error($user_msg.'||'.$dev_msg, __FILE__, __FUNCTION__, __LINE__);
 		}
 		// check that an action exists and add nonce
-		if ( ! $exclude_nonce ) {
-			if ( isset( $args['action'] ) && ! empty( $args['action'] ) ) {
-				$args = array_merge( $args, array( $args['action'] . '_nonce' => wp_create_nonce( $args['action'] . '_nonce' ) ) );
+		if ( ! $exclude_nonce) {
+			if (isset($args['action']) && ! empty($args['action'])) {
+				$args = array_merge($args, array($args['action'].'_nonce' => wp_create_nonce($args['action'].'_nonce')));
 			} else {
-				$args = array_merge( $args, array( 'action' => 'default', 'default_nonce' => wp_create_nonce( 'default_nonce' ) ) );
+				$args = array_merge($args, array('action' => 'default', 'default_nonce' => wp_create_nonce('default_nonce')));
 			}
 		}
 
 		//finally, let's always add a return address (if present) :)
-		$args = ! empty( $_REQUEST['action'] ) && ! isset( $_REQUEST[ 'return' ] )
-			? array_merge( $args, array( 'return' => $_REQUEST['action'] ) )
+		$args = ! empty($_REQUEST['action']) && ! isset($_REQUEST['return'])
+			? array_merge($args, array('return' => $_REQUEST['action']))
 			: $args;
 
-		return add_query_arg( $args, $url );
+		return add_query_arg($args, $url);
 
 	}
 
@@ -57,17 +57,17 @@ 
 	 * @param boolean $sslverify whether we care if the SSL certificate for the requested site is setup properly
 	 * @return boolean
 	 */
-	public static function remote_file_exists( $url, $args = array() ){
-		$results = wp_remote_request($url,array_merge( array(
+	public static function remote_file_exists($url, $args = array()) {
+		$results = wp_remote_request($url, array_merge(array(
 			'method'=>'GET',
 			'redirection'=>1
-		), $args ) );
-		if( ! $results instanceof WP_Error &&
+		), $args));
+		if ( ! $results instanceof WP_Error &&
 				isset($results['response']) &&
 				isset($results['response']['code']) &&
-				$results['response']['code'] == '200'){
+				$results['response']['code'] == '200') {
 			return true;
-		}else{
+		} else {
 			return false;
 		}
 	}
@@ -83,29 +83,29 @@ 
 	 * @param bool   $base_url_only - TRUE will only return the scheme and host with no other parameters
 	 * @return string
 	 */
-	public static function refactor_url( $url = '', $remove_query = TRUE, $base_url_only = FALSE ) {
+	public static function refactor_url($url = '', $remove_query = TRUE, $base_url_only = FALSE) {
 		// break apart incoming URL
-		$url_bits = parse_url( $url );
+		$url_bits = parse_url($url);
 		// HTTP or HTTPS ?
-		$scheme = isset( $url_bits[ 'scheme' ] ) ? $url_bits[ 'scheme' ] . '://' : 'http://';
+		$scheme = isset($url_bits['scheme']) ? $url_bits['scheme'].'://' : 'http://';
 		// domain
-		$host = isset( $url_bits[ 'host' ] ) ? $url_bits[ 'host' ] : '';
+		$host = isset($url_bits['host']) ? $url_bits['host'] : '';
 		// if only the base URL is requested, then return that now
-		if ( $base_url_only ) {
-			return $scheme . $host;
+		if ($base_url_only) {
+			return $scheme.$host;
 		}
-		$port = isset( $url_bits[ 'port' ] ) ? ':' . $url_bits[ 'port' ] : '';
-		$user = isset( $url_bits[ 'user' ] ) ? $url_bits[ 'user' ] : '';
-		$pass = isset( $url_bits[ 'pass' ] ) ? ':' . $url_bits[ 'pass' ] : '';
-		$pass = ( $user || $pass ) ? $pass . '@' : '';
-		$path = isset( $url_bits[ 'path' ] ) ? $url_bits[ 'path' ] : '';
+		$port = isset($url_bits['port']) ? ':'.$url_bits['port'] : '';
+		$user = isset($url_bits['user']) ? $url_bits['user'] : '';
+		$pass = isset($url_bits['pass']) ? ':'.$url_bits['pass'] : '';
+		$pass = ($user || $pass) ? $pass.'@' : '';
+		$path = isset($url_bits['path']) ? $url_bits['path'] : '';
 		// if the query string is not required, then return what we have so far
-		if ( $remove_query ) {
-			return $scheme . $user . $pass . $host . $port . $path;
+		if ($remove_query) {
+			return $scheme.$user.$pass.$host.$port.$path;
 		}
-		$query = isset( $url_bits[ 'query' ] ) ? '?' . $url_bits[ 'query' ] : '';
-		$fragment = isset( $url_bits[ 'fragment' ] ) ? '#' . $url_bits[ 'fragment' ] : '';
-		return $scheme . $user . $pass . $host . $port . $path . $query . $fragment;
+		$query = isset($url_bits['query']) ? '?'.$url_bits['query'] : '';
+		$fragment = isset($url_bits['fragment']) ? '#'.$url_bits['fragment'] : '';
+		return $scheme.$user.$pass.$host.$port.$path.$query.$fragment;
 	}
 
 
@@ -118,29 +118,29 @@ 
 	 * @param bool   $as_array TRUE (default) will return query params as an array of key value pairs, FALSE will simply return the query string
 	 * @return string|array
 	 */
-	public static function get_query_string( $url = '', $as_array = TRUE ) {
+	public static function get_query_string($url = '', $as_array = TRUE) {
 		// break apart incoming URL
-		$url_bits = parse_url( $url );
+		$url_bits = parse_url($url);
 		// grab query string from URL
-		$query = isset( $url_bits[ 'query' ] ) ? $url_bits[ 'query' ] : '';
+		$query = isset($url_bits['query']) ? $url_bits['query'] : '';
 		// if we don't want the query string formatted into an array of key => value pairs, then just return it as is
-		if ( ! $as_array ) {
+		if ( ! $as_array) {
 			return $query;
 		}
 		// if no query string exists then just return an empty array now
-		if ( empty( $query )) {
+		if (empty($query)) {
 			return array();
 		}
 		// empty array to hold results
 		$query_params = array();
 		// now break apart the query string into separate params
-		$query = explode( '&', $query );
+		$query = explode('&', $query);
 		// loop thru our query params
-		foreach ( $query as $query_args ) {
+		foreach ($query as $query_args) {
 			// break apart the key value pairs
-			$query_args = explode( '=', $query_args );
+			$query_args = explode('=', $query_args);
 			// and add to our results array
-			$query_params[ $query_args[0] ] = $query_args[1];
+			$query_params[$query_args[0]] = $query_args[1];
 		}
 		return $query_params;
 	}
@@ -151,7 +151,7 @@ 
 	 * prevent_prefetching
 	 * @return void
 	 */
-	public static function prevent_prefetching(){
+	public static function prevent_prefetching() {
 		// prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
 		remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
 	}
@@ -166,9 +166,9 @@ 
 	 * @param   string $prefix Use this to prefix the string with something.
 	 * @return string
 	 */
-	public static function generate_unique_token( $prefix = '' ) {
-		$token =  md5( uniqid() . mt_rand() );
-		return $prefix ? $prefix . '_' . $token : $token;
+	public static function generate_unique_token($prefix = '') {
+		$token = md5(uniqid().mt_rand());
+		return $prefix ? $prefix.'_'.$token : $token;
 	}
 
 
@@ -177,7 +177,7 @@ 
 	 * add_nocache_headers
 	 * @return void
 	 */
-	public static function add_nocache_headers(){
+	public static function add_nocache_headers() {
 		// add no cache headers
 //		add_action( 'wp_head' , array( 'EED_Single_Page_Checkout', 'nocache_headers' ), 10 );
 		// plus a little extra for nginx
@@ -194,19 +194,19 @@ 
 	 * @param string $server_variable
 	 * @return string
 	 */
-	public static function filter_input_server_url( $server_variable = 'REQUEST_URI' ){
+	public static function filter_input_server_url($server_variable = 'REQUEST_URI') {
 		$URL = '';
 		$server_variables = array(
 			'REQUEST_URI' => 1,
 			'HTTP_HOST' => 1,
 			'PHP_SELF' => 1,
 		);
-		$server_variable = strtoupper( $server_variable );
+		$server_variable = strtoupper($server_variable);
 		// whitelist INPUT_SERVER var
-		if ( isset( $server_variables[ $server_variable ] ) ) {
-			$URL = filter_input( INPUT_SERVER, $server_variable, FILTER_SANITIZE_URL, FILTER_NULL_ON_FAILURE );
-			if ( empty( $URL ) ) {
-				$URL = esc_url( $_SERVER[ $server_variable ] );
+		if (isset($server_variables[$server_variable])) {
+			$URL = filter_input(INPUT_SERVER, $server_variable, FILTER_SANITIZE_URL, FILTER_NULL_ON_FAILURE);
+			if (empty($URL)) {
+				$URL = esc_url($_SERVER[$server_variable]);
 			}
 		}
 		return $URL;

core/libraries/form_sections/base/EE_Model_Form_Section.form.php

Doc Comments +1 added lines

@@ -348,6 +348,7 @@
 	 * Automatically finds the related model info from the form, if present, and
 	 * save the relations indicated
 	 * @type string $relation_name
+	 * @param integer $relation_name
 	 * @return bool
 	 * @throws EE_Error
 	 */

Spacing +74 added lines, -74 removed lines

@@ -11,7 +11,7 @@ 
  * @since                4.5.0
  *
  */
-class EE_Model_Form_Section extends EE_Form_Section_Proper{
+class EE_Model_Form_Section extends EE_Form_Section_Proper {
 
 	/**
 	 *
@@ -36,36 +36,36 @@ 
 	 * }
 	 * @throws EE_Error
 	 */
-	public function __construct($options_array = array()){
-		if(isset($options_array['model']) && $options_array['model'] instanceof EEM_Base){
+	public function __construct($options_array = array()) {
+		if (isset($options_array['model']) && $options_array['model'] instanceof EEM_Base) {
 			$this->_model = $options_array['model'];
 		}
-		if( ! $this->_model || ! $this->_model instanceof EEM_Base ){
+		if ( ! $this->_model || ! $this->_model instanceof EEM_Base) {
 			throw new EE_Error(sprintf(__("Model Form Sections must first specify the _model property to be a subclass of EEM_Base", "event_espresso")));
 		}
 
-		if(isset($options_array['subsection_args'])){
+		if (isset($options_array['subsection_args'])) {
 			$subsection_args = $options_array['subsection_args'];
-		}else{
+		} else {
 			$subsection_args = array();
 		}
 
 		//gather fields and relations to convert to inputs
 		//but if they're just going to exclude a field anyways, don't bother converting it to an input
 		$exclude = $this->_subsections;
-		if(isset($options_array['exclude'])){
-			$exclude = array_merge($exclude,array_flip($options_array['exclude']));
+		if (isset($options_array['exclude'])) {
+			$exclude = array_merge($exclude, array_flip($options_array['exclude']));
 		}
 		$model_fields = array_diff_key($this->_model->field_settings(), $exclude);
 		$model_relations = array_diff_key($this->_model->relation_settings(), $exclude);
 		//convert fields and relations to inputs
 		$this->_subsections = array_merge(
 			$this->_convert_model_fields_to_inputs($model_fields),
-			$this->_convert_model_relations_to_inputs($model_relations,$subsection_args),
+			$this->_convert_model_relations_to_inputs($model_relations, $subsection_args),
 			$this->_subsections
 		);
 		parent::__construct($options_array);
-		if(isset($options_array['model_object']) && $options_array['model_object'] instanceof EE_Base_Class){
+		if (isset($options_array['model_object']) && $options_array['model_object'] instanceof EE_Base_Class) {
 			$this->populate_model_obj($options_array['model_object']);
 		}
 
@@ -83,9 +83,9 @@ 
 	 * 	}
 	 * @return array
 	 */
-	protected function _convert_model_relations_to_inputs($relations,$subsection_args = array()){
+	protected function _convert_model_relations_to_inputs($relations, $subsection_args = array()) {
 		$inputs = array();
-		foreach( $relations as $relation_name => $relation_obj ) {
+		foreach ($relations as $relation_name => $relation_obj) {
 			$input_constructor_args = array(
 				array_merge(
 					array(
@@ -96,19 +96,19 @@ 
 				)
 			);
 			$input = NULL;
-			switch(get_class($relation_obj)){
+			switch (get_class($relation_obj)) {
 				case 'EE_HABTM_Relation':
-					if(isset($subsection_args[$relation_name]) &&
-							isset($subsection_args[$relation_name]['model_objects'])){
+					if (isset($subsection_args[$relation_name]) &&
+							isset($subsection_args[$relation_name]['model_objects'])) {
 						$model_objects = $subsection_args[$relation_name]['model_objects'];
-					}else{
+					} else {
 						$model_objects = $relation_obj->get_other_model()->get_all();
 					}
-					$input = new EE_Select_Multi_Model_Input($model_objects,$input_constructor_args);
+					$input = new EE_Select_Multi_Model_Input($model_objects, $input_constructor_args);
 					break;
 				default:
 			}
-			if($input){
+			if ($input) {
 				$inputs[$relation_name] = $input;
 			}
 		}
@@ -123,10 +123,10 @@ 
 	 * @throws EE_Error
 	 * @return EE_Form_Input_Base[]
 	 */
-	protected function _convert_model_fields_to_inputs( $model_fields = array() ){
+	protected function _convert_model_fields_to_inputs($model_fields = array()) {
 		$inputs = array();
-		foreach( $model_fields as $field_name=>$model_field ){
-			if ( $model_field instanceof EE_Model_Field_Base ) {
+		foreach ($model_fields as $field_name=>$model_field) {
+			if ($model_field instanceof EE_Model_Field_Base) {
 				$input_constructor_args = array(
 					array(
 						'required'=> ! $model_field->is_nullable() && $model_field->get_default_value() === NULL,
@@ -134,7 +134,7 @@ 
 						'default'=>$model_field->get_default_value(),
 					)
 				);
-				switch(get_class($model_field)){
+				switch (get_class($model_field)) {
 					case 'EE_All_Caps_Text_Field':
 					case 'EE_Any_Foreign_Model_Name_Field':
 						$input_class = 'EE_Text_Input';
@@ -143,16 +143,16 @@ 
 						$input_class = 'EE_Yes_No_Input';
 						break;
 					case 'EE_Datetime_Field':
-						throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input", "event_espresso"),get_class($model_field)));
+						throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input", "event_espresso"), get_class($model_field)));
 						break;
 					case 'EE_Email_Field':
 						$input_class = 'EE_Email_Input';
 						break;
 					case 'EE_Enum_Integer_Field':
-						throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input", "event_espresso"),get_class($model_field)));
+						throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input", "event_espresso"), get_class($model_field)));
 						break;
 					case 'EE_Enum_Text_Field':
-						throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input", "event_espresso"),get_class($model_field)));
+						throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input", "event_espresso"), get_class($model_field)));
 						break;
 					case 'EE_Float_Field':
 						$input_class = 'EE_Float_Input';
@@ -161,15 +161,15 @@ 
 					case 'EE_Foreign_Key_String_Field':
 					case 'EE_WP_User_Field':
 						$models_pointed_to = $model_field instanceof EE_Field_With_Model_Name ? $model_field->get_model_class_names_pointed_to() : array();
-						if(true || is_array($models_pointed_to) && count($models_pointed_to) > 1){
+						if (true || is_array($models_pointed_to) && count($models_pointed_to) > 1) {
 							$input_class = 'EE_Text_Input';
-						}else{
+						} else {
 							//so its just one model
 							$model_name = is_array($models_pointed_to) ? reset($models_pointed_to) : $models_pointed_to;
 							$model = EE_Registry::instance()->load_model($model_name);
 							$model_names = $model->get_all_names(array('limit'=>10));
-							if($model_field->is_nullable()){
-								array_unshift( $model_names, __( "Please Select", 'event_espresso' ));
+							if ($model_field->is_nullable()) {
+								array_unshift($model_names, __("Please Select", 'event_espresso'));
 							}
 							$input_constructor_args[1] = $input_constructor_args[0];
 							$input_constructor_args[0] = $model_names;
@@ -178,10 +178,10 @@ 
 						break;
 					case 'EE_Full_HTML_Field':
 						$input_class = 'EE_Text_Area_Input';
-						$input_constructor_args[ 0 ]['validation_strategies'] = array( new EE_Full_HTML_Validation_Strategy() );
+						$input_constructor_args[0]['validation_strategies'] = array(new EE_Full_HTML_Validation_Strategy());
 						break;
 					case 'EE_Infinite_Integer':
-						throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input", "event_espresso"),get_class($model_field)));
+						throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input", "event_espresso"), get_class($model_field)));
 						break;
 					case 'EE_Integer_Field':
 						$input_class = 'EE_Text_Input';
@@ -190,11 +190,11 @@ 
 						$input_class = 'EE_Text_Area_Input';
 						break;
 					case 'EE_Money_Field':
-						throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input", "event_espresso"),get_class($model_field)));
+						throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input", "event_espresso"), get_class($model_field)));
 						break;
 					case 'EE_Post_Content_Field':
 						$input_class = 'EE_Text_Area_Input';
-						$input_constructor_args[ 0 ][ 'validation_strategies' ] = array( new EE_Full_HTML_Validation_Strategy() );
+						$input_constructor_args[0]['validation_strategies'] = array(new EE_Full_HTML_Validation_Strategy());
 						break;
 					case 'EE_Plain_Text_Field':
 						$input_class = 'EE_Text_Input';
@@ -211,7 +211,7 @@ 
 						break;
 					case 'EE_Simple_HTML_Field':
 						$input_class = 'EE_Text_Area_Input';
-						$input_constructor_args[ 0 ][ 'validation_strategies' ] = array( new EE_Simple_HTML_Validation_Strategy() );
+						$input_constructor_args[0]['validation_strategies'] = array(new EE_Simple_HTML_Validation_Strategy());
 						break;
 					case 'EE_Slug_Field':
 						$input_class = 'EE_Text_Input';
@@ -220,13 +220,13 @@ 
 						$input_class = 'EE_Yes_No_Input';
 						break;
 					case 'EE_WP_Post_Status_Field':
-						throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input", "event_espresso"),get_class($model_field)));
+						throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input", "event_espresso"), get_class($model_field)));
 						break;
 					case 'EE_WP_Post_Type_Field':
-						throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input", "event_espresso"),get_class($model_field)));
+						throw new EE_Error(sprintf(__("Model field '%s' does not yet have a known conversion to form input", "event_espresso"), get_class($model_field)));
 						break;
 					default:
-						throw new EE_Error(sprintf(__("Model field of type '%s' does not convert to any known Form Input. Please add a case to EE_Model_Form_section's _convert_model_fields_to_inputs switch statement", "event_espresso"),get_class($model_field)));
+						throw new EE_Error(sprintf(__("Model field of type '%s' does not convert to any known Form Input. Please add a case to EE_Model_Form_section's _convert_model_fields_to_inputs switch statement", "event_espresso"), get_class($model_field)));
 				}
 				$reflection = new ReflectionClass($input_class);
 				$input = $reflection->newInstanceArgs($input_constructor_args);
@@ -244,21 +244,21 @@ 
 	 * @param EE_Base_Class $model_obj
 	 * @return void
 	 */
-	public function populate_model_obj($model_obj){
+	public function populate_model_obj($model_obj) {
 		$model_obj = $this->_model->ensure_is_obj($model_obj);
 		$this->_model_object = $model_obj;
 		$defaults = $model_obj->model_field_array();
-		foreach($this->_model->relation_settings() as $relation_name => $relation_obj){
+		foreach ($this->_model->relation_settings() as $relation_name => $relation_obj) {
 			$form_inputs = $this->inputs();
-			if(isset($form_inputs[$relation_name])){
-				if($relation_obj instanceof EE_Belongs_To_Relation){
+			if (isset($form_inputs[$relation_name])) {
+				if ($relation_obj instanceof EE_Belongs_To_Relation) {
 					//then we only expect there to be one
 					$related_item = $this->_model_object->get_first_related($relation_name);
 					$defaults[$relation_name] = $related_item->ID();
-				}else{
+				} else {
 					$related_items = $this->_model_object->get_many_related($relation_name);
 					$ids = array();
-					foreach($related_items as $related_item){
+					foreach ($related_items as $related_item) {
 						$ids[] = $related_item->ID();
 					}
 					$defaults[$relation_name] = $ids;
@@ -275,8 +275,8 @@ 
 	 * values are their normalized values
 	 * @return array
 	 */
-	public function inputs_values_corresponding_to_model_fields(){
-		return array_intersect_key($this->input_values(),$this->_model->field_settings());
+	public function inputs_values_corresponding_to_model_fields() {
+		return array_intersect_key($this->input_values(), $this->_model->field_settings());
 	}
 
 
@@ -299,21 +299,21 @@ 
 	public function receive_form_submission($req_data = NULL, $validate = TRUE) {
 		parent::receive_form_submission($req_data, $validate);
 		//create or set the model object, if it isn't already
-		if( ! $this->_model_object ){
+		if ( ! $this->_model_object) {
 			//check to see if the form indicates a PK, in which case we want to only retrieve it and update it
 			$pk_name = $this->_model->primary_key_name();
 			$model_obj = $this->_model->get_one_by_ID($this->get_input_value($pk_name));
-			if($model_obj){
+			if ($model_obj) {
 				$this->_model_object = $model_obj;
-			}else{
-				$this->_model_object = EE_Registry::instance()->load_class($this->_model->get_this_model_name() );
+			} else {
+				$this->_model_object = EE_Registry::instance()->load_class($this->_model->get_this_model_name());
 			}
 		}
 		//ok so the model object is set. Just set it with the submitted form data (don't save yet though)
-		foreach($this->inputs_values_corresponding_to_model_fields() as $field_name=>$field_value){
+		foreach ($this->inputs_values_corresponding_to_model_fields() as $field_name=>$field_value) {
 			//only set the non-primary key
-			if($field_name != $this->_model->primary_key_name()){
-				$this->_model_object->set($field_name,$field_value);
+			if ($field_name != $this->_model->primary_key_name()) {
+				$this->_model_object->set($field_name, $field_value);
 			}
 		}
 
@@ -329,13 +329,13 @@ 
 	 * @return int, 1 on a successful update, the ID of
 	 *                    the new entry on insert; 0 on failure
 	 */
-	public function save(){
-		if( ! $this->_model_object){
-			throw new EE_Error(sprintf(__("Cannot save the model form's model object (model is '%s') because there is no model object set. You must either set it, or call receive_form_submission where it is set automatically", "event_espresso"),get_class($this->_model)));
+	public function save() {
+		if ( ! $this->_model_object) {
+			throw new EE_Error(sprintf(__("Cannot save the model form's model object (model is '%s') because there is no model object set. You must either set it, or call receive_form_submission where it is set automatically", "event_espresso"), get_class($this->_model)));
 		}
-		$success =  $this->_model_object->save();
-		foreach($this->_model->relation_settings() as $relation_name => $relation_obj){
-			if(isset($this->_subsections[$relation_name])){
+		$success = $this->_model_object->save();
+		foreach ($this->_model->relation_settings() as $relation_name => $relation_obj) {
+			if (isset($this->_subsections[$relation_name])) {
 				$success = $this->_save_related_info($relation_name);
 			}
 		}
@@ -351,29 +351,29 @@ 
 	 * @return bool
 	 * @throws EE_Error
 	 */
-	protected function _save_related_info($relation_name){
+	protected function _save_related_info($relation_name) {
 		$relation_obj = $this->_model->related_settings_for($relation_name);
-		if($relation_obj instanceof EE_Belongs_To_Relation){
+		if ($relation_obj instanceof EE_Belongs_To_Relation) {
 			//there is just a foreign key on this model pointing to that one
 			$this->_model_object->_add_relation_to($this->get_input_value($relation_name), $relation_name);
-		}elseif($relation_obj instanceof EE_Has_Many_Relation){
+		}elseif ($relation_obj instanceof EE_Has_Many_Relation) {
 			//then we want to consider all of its currently-related things.
 			//if they're in this list, keep them
 			//if they're not in this list, remove them
 			//and lastly add all the new items
 			throw new EE_Error(sprintf(__('Automatic saving of related info across a "has many" relation is not yet supported', "event_espresso")));
-		}elseif($relation_obj instanceof EE_HABTM_Relation){
+		}elseif ($relation_obj instanceof EE_HABTM_Relation) {
 			//delete everything NOT in this list
 			$normalized_input_value = $this->get_input_value($relation_name);
-			if($normalized_input_value && is_array($normalized_input_value)){
+			if ($normalized_input_value && is_array($normalized_input_value)) {
 				$where_query_params = array(
-					$relation_obj->get_other_model()->primary_key_name() => array('NOT_IN',$normalized_input_value));
-			}else{
+					$relation_obj->get_other_model()->primary_key_name() => array('NOT_IN', $normalized_input_value));
+			} else {
 				$where_query_params = array();
 			}
-			$this->_model_object->_remove_relations( $relation_name, $where_query_params );
-			foreach($normalized_input_value as $id){
-				$this->_model_object->_add_relation_to( $id, $relation_name );
+			$this->_model_object->_remove_relations($relation_name, $where_query_params);
+			foreach ($normalized_input_value as $id) {
+				$this->_model_object->_add_relation_to($id, $relation_name);
 			}
 		}
 		return TRUE;
@@ -385,7 +385,7 @@ 
 	 * Gets the model of this model form
 	 * @return EEM_Base
 	 */
-	public function get_model(){
+	public function get_model() {
 		return $this->_model;
 	}
 
@@ -398,7 +398,7 @@ 
 	 * when receive_form_submission($req_data) was called.
 	 * @return EE_Base_Class
 	 */
-	public function get_model_object(){
+	public function get_model_object() {
 		return $this->_model_object;
 	}
 
@@ -408,10 +408,10 @@ 
 	 * gets teh default name of this form section if none is specified
 	 * @return string
 	 */
-	protected function _set_default_name_if_empty(){
-		if( ! $this->_name ){
-			$default_name = str_replace("EEM_", "", get_class($this->_model)) . "_Model_Form";
-			$this->_name =  $default_name;
+	protected function _set_default_name_if_empty() {
+		if ( ! $this->_name) {
+			$default_name = str_replace("EEM_", "", get_class($this->_model))."_Model_Form";
+			$this->_name = $default_name;
 		}
 	}
 

Braces +8 added lines, -8 removed lines

@@ -46,7 +46,7 @@ 
 
 		if(isset($options_array['subsection_args'])){
 			$subsection_args = $options_array['subsection_args'];
-		}else{
+		} else{
 			$subsection_args = array();
 		}
 
@@ -101,7 +101,7 @@ 
 					if(isset($subsection_args[$relation_name]) &&
 							isset($subsection_args[$relation_name]['model_objects'])){
 						$model_objects = $subsection_args[$relation_name]['model_objects'];
-					}else{
+					} else{
 						$model_objects = $relation_obj->get_other_model()->get_all();
 					}
 					$input = new EE_Select_Multi_Model_Input($model_objects,$input_constructor_args);
@@ -163,7 +163,7 @@ 
 						$models_pointed_to = $model_field instanceof EE_Field_With_Model_Name ? $model_field->get_model_class_names_pointed_to() : array();
 						if(true || is_array($models_pointed_to) && count($models_pointed_to) > 1){
 							$input_class = 'EE_Text_Input';
-						}else{
+						} else{
 							//so its just one model
 							$model_name = is_array($models_pointed_to) ? reset($models_pointed_to) : $models_pointed_to;
 							$model = EE_Registry::instance()->load_model($model_name);
@@ -255,7 +255,7 @@ 
 					//then we only expect there to be one
 					$related_item = $this->_model_object->get_first_related($relation_name);
 					$defaults[$relation_name] = $related_item->ID();
-				}else{
+				} else{
 					$related_items = $this->_model_object->get_many_related($relation_name);
 					$ids = array();
 					foreach($related_items as $related_item){
@@ -305,7 +305,7 @@ 
 			$model_obj = $this->_model->get_one_by_ID($this->get_input_value($pk_name));
 			if($model_obj){
 				$this->_model_object = $model_obj;
-			}else{
+			} else{
 				$this->_model_object = EE_Registry::instance()->load_class($this->_model->get_this_model_name() );
 			}
 		}
@@ -356,19 +356,19 @@ 
 		if($relation_obj instanceof EE_Belongs_To_Relation){
 			//there is just a foreign key on this model pointing to that one
 			$this->_model_object->_add_relation_to($this->get_input_value($relation_name), $relation_name);
-		}elseif($relation_obj instanceof EE_Has_Many_Relation){
+		} elseif($relation_obj instanceof EE_Has_Many_Relation){
 			//then we want to consider all of its currently-related things.
 			//if they're in this list, keep them
 			//if they're not in this list, remove them
 			//and lastly add all the new items
 			throw new EE_Error(sprintf(__('Automatic saving of related info across a "has many" relation is not yet supported', "event_espresso")));
-		}elseif($relation_obj instanceof EE_HABTM_Relation){
+		} elseif($relation_obj instanceof EE_HABTM_Relation){
 			//delete everything NOT in this list
 			$normalized_input_value = $this->get_input_value($relation_name);
 			if($normalized_input_value && is_array($normalized_input_value)){
 				$where_query_params = array(
 					$relation_obj->get_other_model()->primary_key_name() => array('NOT_IN',$normalized_input_value));
-			}else{
+			} else{
 				$where_query_params = array();
 			}
 			$this->_model_object->_remove_relations( $relation_name, $where_query_params );

core/libraries/form_sections/payment_methods/EE_Payment_Method_Form.form.php

Doc Comments +1 added lines, -1 removed lines

@@ -101,7 +101,7 @@
 
 
 	/**
-	 * @param $payment_method_type
+	 * @param EE_PMT_Base $payment_method_type
 	 * @throws EE_Error
 	 */
 	public function set_payment_method_type( $payment_method_type ){

Spacing +32 added lines, -32 removed lines

@@ -4,7 +4,7 @@ 
  * Specialized form for payment methods, allowing for easy setting and retrieving of meta fields.
  * Uses EEM_Payment_Method as the model
  */
-class EE_Payment_Method_Form extends EE_Model_Form_Section{
+class EE_Payment_Method_Form extends EE_Model_Form_Section {
 
 	/**
 	 * All the subsection inputs that correspond ot extra meta rows
@@ -39,37 +39,37 @@ 
 	 *	@see EE_Model_Form_Section::__construct() for more
 	 * }
 	 */
-	public function __construct($options_array = array()){
+	public function __construct($options_array = array()) {
 		$this->_model = EEM_Payment_Method::instance();
 		$this->_options_array = $options_array;
-		if(isset($options_array['payment_method_type'])){
+		if (isset($options_array['payment_method_type'])) {
 			$this->_payment_method_type = $options_array['payment_method_type'];
 		}
 		$options_array = $this->_options_array;
-		if(isset($options_array['extra_meta_inputs'])){
-			$this->_extra_meta_inputs = array_merge($this->_extra_meta_inputs,$options_array['extra_meta_inputs']);
+		if (isset($options_array['extra_meta_inputs'])) {
+			$this->_extra_meta_inputs = array_merge($this->_extra_meta_inputs, $options_array['extra_meta_inputs']);
 		}
-		if($this->_extra_meta_inputs){
-			$this->_subsections = array_merge($this->_subsections,$this->_extra_meta_inputs);
+		if ($this->_extra_meta_inputs) {
+			$this->_subsections = array_merge($this->_subsections, $this->_extra_meta_inputs);
 		}
 		$this->_subsections['PMD_button_url'] = new EE_Admin_File_Uploader_Input(
-			array( 'html_label_text'=>  __( 'Button URL', 'event_espresso' ))
+			array('html_label_text'=>  __('Button URL', 'event_espresso'))
 		);
 		$this->_subsections['PMD_scope'] = new EE_Checkbox_Multi_Input(
 			EEM_Payment_Method::instance()->scopes(),
-			array( 'html_label_text' => $this->_model->field_settings_for('PMD_scope')->get_nicename() . EEH_Template::get_help_tab_link( 'payment_methods_overview' ))
+			array('html_label_text' => $this->_model->field_settings_for('PMD_scope')->get_nicename().EEH_Template::get_help_tab_link('payment_methods_overview'))
 		);
 		//setup the currency options
 		$this->_subsections['Currency'] = new EE_Select_Multi_Model_Input(
-			EEM_Currency::instance()->get_all_currencies_usable_by( $this->_payment_method_type ),
+			EEM_Currency::instance()->get_all_currencies_usable_by($this->_payment_method_type),
 			array(
-				'html_label_text'=>  __( 'Currencies Supported', 'event_espresso' ),
+				'html_label_text'=>  __('Currencies Supported', 'event_espresso'),
 				'required'=>TRUE
 			)
 		);
-		$this->_subsections['PMD_order'] = new EE_Text_Input( array(
-			'html_label_text' => __( 'Order', 'event_espresso' ),
-			'html_help_text' => __( 'Lowest numbers will be shown first', 'event_espresso' ),
+		$this->_subsections['PMD_order'] = new EE_Text_Input(array(
+			'html_label_text' => __('Order', 'event_espresso'),
+			'html_help_text' => __('Lowest numbers will be shown first', 'event_espresso'),
 			'normalization_strategy' => new EE_Int_Normalization(),
 			'validation_strategies' => array(
 				new EE_Int_Validation_Strategy()
@@ -88,15 +88,15 @@ 
 	 * @param string 	$name
 	 * @throws EE_Error
 	 */
-	public function _construct_finalize( $parent_form_section, $name ) {
-		if( ! $this->_payment_method_type instanceof EE_PMT_Base ){
-			throw new EE_Error( sprintf( __( 'Payment Method forms must have set their payment method type BEFORE calling _construct_finalize', 'event_espresso' )));
+	public function _construct_finalize($parent_form_section, $name) {
+		if ( ! $this->_payment_method_type instanceof EE_PMT_Base) {
+			throw new EE_Error(sprintf(__('Payment Method forms must have set their payment method type BEFORE calling _construct_finalize', 'event_espresso')));
 		}
 		//set the name of this form based on the payment method type
-		if( ! $this->_name && ! $name ){
-			$name = str_replace(" ","_",ucwords(str_replace("_"," ",($this->_payment_method_type->system_name()))))."_Settings_Form";
+		if ( ! $this->_name && ! $name) {
+			$name = str_replace(" ", "_", ucwords(str_replace("_", " ", ($this->_payment_method_type->system_name()))))."_Settings_Form";
 		}
-		parent::_construct_finalize( $parent_form_section, $name );
+		parent::_construct_finalize($parent_form_section, $name);
 	}
 
 
@@ -105,8 +105,8 @@ 
 	 * @param $payment_method_type
 	 * @throws EE_Error
 	 */
-	public function set_payment_method_type( $payment_method_type ){
-		if( ! $payment_method_type instanceof EE_PMT_Base){
+	public function set_payment_method_type($payment_method_type) {
+		if ( ! $payment_method_type instanceof EE_PMT_Base) {
 			throw new EE_Error(sprintf(__("Payment Method forms MUST set a payment method type by using _set_payment_method_type", "event_espresso")));
 		}
 		$this->_payment_method_type = $payment_method_type;
@@ -118,10 +118,10 @@ 
 	 * extends the model form section's save method to also save the extra meta field values
 	 * @return int ID of the payment method inserted, or true on update
 	 */
-	public function save(){
+	public function save() {
 		$parent_save_val = parent::save();
-		if( $this->_model_object && $this->_model_object->ID()){
-			foreach($this->_extra_meta_inputs as $input_name => $input){
+		if ($this->_model_object && $this->_model_object->ID()) {
+			foreach ($this->_extra_meta_inputs as $input_name => $input) {
 				$this->_model_object->update_extra_meta($input_name, $input->normalized_value());
 			}
 		}
@@ -138,8 +138,8 @@ 
 		$model_obj = $this->_model->ensure_is_obj($model_obj);
 		parent::populate_model_obj($model_obj);
 		$extra_meta = $model_obj->all_extra_meta_array();
-		foreach($this->_extra_meta_inputs as $input_name => $extra_meta_input){
-			if(isset($extra_meta[$input_name])){
+		foreach ($this->_extra_meta_inputs as $input_name => $extra_meta_input) {
+			if (isset($extra_meta[$input_name])) {
 				$extra_meta_input->set_default($extra_meta[$input_name]);
 			}
 		}
@@ -151,10 +151,10 @@ 
 	 * gets the default name of this form section if none is specified
 	 * @return string
 	 */
-	protected function _set_default_name_if_empty(){
-		if( ! $this->_name ){
-			$default_name = str_replace("EEM_", "", get_class($this->_model)) . "_Model_Form";
-			$this->_name =  $default_name;
+	protected function _set_default_name_if_empty() {
+		if ( ! $this->_name) {
+			$default_name = str_replace("EEM_", "", get_class($this->_model))."_Model_Form";
+			$this->_name = $default_name;
 		}
 	}
 
@@ -164,7 +164,7 @@ 
 	 * Gets all the extra meta inputs in this form
 	 * @return EE_Form_Input_Base[]
 	 */
-	public function extra_meta_inputs(){
+	public function extra_meta_inputs() {
 		return $this->_extra_meta_inputs;
 	}
 }

core/libraries/form_sections/strategies/display/EE_Select_Display_Strategy.strategy.php

Doc Comments +1 added lines, -1 removed lines

@@ -80,7 +80,7 @@
 	/**
 	 * Checks if that value is the one selected
 	 * @param string|int $value unnormalized value option (string)
-	 * @return string
+	 * @return boolean
 	 */
 	protected function _check_if_option_selected( $value ){
 		return $this->_input->raw_value() == $value ? TRUE : FALSE;

Spacing +26 added lines, -26 removed lines

@@ -11,46 +11,46 @@ 
  * @since 				$VID:$
  *
  */
-class EE_Select_Display_Strategy extends EE_Display_Strategy_Base{
+class EE_Select_Display_Strategy extends EE_Display_Strategy_Base {
 
 	/**
 	 *
 	 * @throws EE_Error
 	 * @return string of html to display the field
 	 */
-	function display(){
-		if( ! $this->_input instanceof EE_Form_Input_With_Options_Base){
-			throw new EE_Error( sprintf( __( 'Cannot use Select Display Strategy with an input that doesn\'t have options', 'event_espresso' )));
+	function display() {
+		if ( ! $this->_input instanceof EE_Form_Input_With_Options_Base) {
+			throw new EE_Error(sprintf(__('Cannot use Select Display Strategy with an input that doesn\'t have options', 'event_espresso')));
 		}
 
-		$html = EEH_HTML::nl( 0, 'select' );
+		$html = EEH_HTML::nl(0, 'select');
 		$html .= '<select';
-		$html .= ' id="' . $this->_input->html_id() . '"';
-		$html .= ' name="' . $this->_input->html_name() . '"';
-		$class = $this->_input->required() ? $this->_input->required_css_class() . ' ' . $this->_input->html_class() : $this->_input->html_class();
-		$html .= ' class="' . $class . '"';
+		$html .= ' id="'.$this->_input->html_id().'"';
+		$html .= ' name="'.$this->_input->html_name().'"';
+		$class = $this->_input->required() ? $this->_input->required_css_class().' '.$this->_input->html_class() : $this->_input->html_class();
+		$html .= ' class="'.$class.'"';
 		// add html5 required
 
 		$html .= $this->_input->required() ? ' required' : '';
-		$html .= ' style="' . $this->_input->html_style() . '"';
+		$html .= ' style="'.$this->_input->html_style().'"';
 		$html .= '>';
 
 //		EEH_HTML::indent( 1, 'select' );
-		if ( EEH_Array::is_multi_dimensional_array( $this->_input->options() )) {
-			EEH_HTML::indent( 1, 'optgroup' );
-			foreach( $this->_input->options() as $opt_group_label => $opt_group ){
-				$html .= EEH_HTML::nl( 0, 'optgroup' ) . '<optgroup label="' . esc_attr( $opt_group_label ) . '">';
-				EEH_HTML::indent( 1, 'option' );
-				$html .= $this->_display_options( $opt_group );
+		if (EEH_Array::is_multi_dimensional_array($this->_input->options())) {
+			EEH_HTML::indent(1, 'optgroup');
+			foreach ($this->_input->options() as $opt_group_label => $opt_group) {
+				$html .= EEH_HTML::nl(0, 'optgroup').'<optgroup label="'.esc_attr($opt_group_label).'">';
+				EEH_HTML::indent(1, 'option');
+				$html .= $this->_display_options($opt_group);
 				$html .= EEH_HTML::indent( -1, 'option' );
-				$html .= EEH_HTML::nl( 0, 'optgroup' ) . '</optgroup>';
+				$html .= EEH_HTML::nl(0, 'optgroup').'</optgroup>';
 			}
 			EEH_HTML::indent( -1, 'optgroup' );
 		} else {
-			$html.=$this->_display_options( $this->_input->options() );
+			$html .= $this->_display_options($this->_input->options());
 		}
 
-		$html.= EEH_HTML::nl( 0, 'select' ) . '</select>';
+		$html .= EEH_HTML::nl(0, 'select').'</select>';
 //		$html.= EEH_HTML::nl( -1, 'select' ) . '</select>';
 		return $html;
 	}
@@ -62,13 +62,13 @@ 
 	 * @param array $options
 	 * @return string
 	 */
-	protected function _display_options($options){
+	protected function _display_options($options) {
 		$html = '';
-		EEH_HTML::indent( 1, 'option' );
-		foreach( $options as $value => $display_text ){
-			$unnormalized_value = $this->_input->get_normalization_strategy()->unnormalize_one( $value );
-			$selected = $this->_check_if_option_selected( $unnormalized_value ) ? ' selected="selected"' : '';
-			$html.= EEH_HTML::nl( 0, 'option' ) . '<option value="' . esc_attr( $unnormalized_value ) . '"' . $selected . '>' . $display_text . '</option>';
+		EEH_HTML::indent(1, 'option');
+		foreach ($options as $value => $display_text) {
+			$unnormalized_value = $this->_input->get_normalization_strategy()->unnormalize_one($value);
+			$selected = $this->_check_if_option_selected($unnormalized_value) ? ' selected="selected"' : '';
+			$html .= EEH_HTML::nl(0, 'option').'<option value="'.esc_attr($unnormalized_value).'"'.$selected.'>'.$display_text.'</option>';
 		}
 		EEH_HTML::indent( -1, 'option' );
 		return $html;
@@ -81,7 +81,7 @@ 
 	 * @param string|int $value unnormalized value option (string)
 	 * @return string
 	 */
-	protected function _check_if_option_selected( $value ){
+	protected function _check_if_option_selected($value) {
 		return $this->_input->raw_value() == $value ? TRUE : FALSE;
 	}