eventespresso / event-espresso-core

modules/core_rest_api/EED_Core_Rest_Api.module.php

Spacing +108 added lines, -108 removed lines

@@ -1,8 +1,8 @@ 
 <?php
 use EventEspresso\core\libraries\rest_api\Calculated_Model_Fields;
 
-if ( !defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 /**
@@ -35,7 +35,7 @@ 
 	 */
 	public static function instance() {
 		self::$_field_calculator = new Calculated_Model_Fields();
-		return parent::get_instance( __CLASS__ );
+		return parent::get_instance(__CLASS__);
 	}
 
 
@@ -65,10 +65,10 @@ 
 
 
 	public static function set_hooks_both() {
-		add_action( 'rest_api_init', array( 'EED_Core_Rest_Api', 'register_routes' ), 10 );
-		add_action( 'rest_api_init', array( 'EED_Core_Rest_Api', 'set_hooks_rest_api' ), 5 );
-		add_filter( 'rest_route_data', array( 'EED_Core_Rest_Api', 'hide_old_endpoints' ), 10, 2 );
-		add_filter( 'rest_index', array( 'EventEspresso\core\libraries\rest_api\controllers\model\Meta', 'filter_ee_metadata_into_index' ) );
+		add_action('rest_api_init', array('EED_Core_Rest_Api', 'register_routes'), 10);
+		add_action('rest_api_init', array('EED_Core_Rest_Api', 'set_hooks_rest_api'), 5);
+		add_filter('rest_route_data', array('EED_Core_Rest_Api', 'hide_old_endpoints'), 10, 2);
+		add_filter('rest_index', array('EventEspresso\core\libraries\rest_api\controllers\model\Meta', 'filter_ee_metadata_into_index'));
 		EED_Core_Rest_Api::invalidate_cached_route_data_on_version_change();
 	}
 
@@ -87,7 +87,7 @@ 
 	 * Loads all the hooks which make requests to old versions of the API
 	 * appear the same as they always did
 	 */
-	public static function set_hooks_for_changes(){
+	public static function set_hooks_for_changes() {
 		self::_set_hooks_for_changes();
 	}
 
@@ -97,11 +97,11 @@ 
 	 * replace it with application passwords.
 	 */
 	public static function maybe_notify_of_basic_auth_removal() {
-		if( 
+		if ( 
 			apply_filters( 
 				'FHEE__EED_Core_Rest_Api__maybe_notify_of_basic_auth_removal__override',
-				! isset( $_SERVER['PHP_AUTH_USER'] )
-			&& ! isset( $_SERVER['HTTP_AUTHORIZATION'] ) 
+				! isset($_SERVER['PHP_AUTH_USER'])
+			&& ! isset($_SERVER['HTTP_AUTHORIZATION']) 
 			) 
 		) {
 			//sure it's a WP API request, but they aren't using basic auth, so don't bother them
@@ -109,20 +109,20 @@ 
 		}
 		//ok they're using the WP API with Basic Auth
 		$message = sprintf(
-			__( 'We noticed you\'re using the WP API, which is used by the Event Espresso 4 mobile apps. Because of security and compatibility concerns, we will soon be removing our default authentication mechanism, WP API Basic Auth, from Event Espresso. It is recommended you instead install the %1$sWP Application Passwords plugin%2$s and use it with the EE4 Mobile apps. See %3$sour mobile app documentation%2$s for more information. %4$sIf you have installed the WP API Basic Auth plugin separately, or are not using the Event Espresso 4 mobile apps, you can disregard this message.%4$sThe Event Espresso Team', 'event_espresso' ),
+			__('We noticed you\'re using the WP API, which is used by the Event Espresso 4 mobile apps. Because of security and compatibility concerns, we will soon be removing our default authentication mechanism, WP API Basic Auth, from Event Espresso. It is recommended you instead install the %1$sWP Application Passwords plugin%2$s and use it with the EE4 Mobile apps. See %3$sour mobile app documentation%2$s for more information. %4$sIf you have installed the WP API Basic Auth plugin separately, or are not using the Event Espresso 4 mobile apps, you can disregard this message.%4$sThe Event Espresso Team', 'event_espresso'),
 			'<a href="https://wordpress.org/plugins/application-passwords/">',
 			'</a>',
 			'<a href="https://eventespresso.com/wiki/ee4-event-apps/#authentication">',
 			'<br/>'
 		);
-		EE_Error::add_persistent_admin_notice( 'using_basic_auth', $message );
-		if( ! get_option( 'ee_notified_admin_on_basic_auth_removal', false ) ) {
-			add_option( 'ee_notified_admin_on_basic_auth_removal', true );
+		EE_Error::add_persistent_admin_notice('using_basic_auth', $message);
+		if ( ! get_option('ee_notified_admin_on_basic_auth_removal', false)) {
+			add_option('ee_notified_admin_on_basic_auth_removal', true);
 			//piggy back off EE_Error::set_content_type, which sets the content type to HTML
-			add_filter( 'wp_mail_content_type', array( 'EE_Error', 'set_content_type' ));
+			add_filter('wp_mail_content_type', array('EE_Error', 'set_content_type'));
 			//and send the message to the site admin too
-			wp_mail( get_option( 'admin_email' ), __( 'Notice of Removal of WP API Basic Auth From Event Espresso 4', 'event_espresso' ), $message );
-			remove_filter( 'wp_mail_content_type', array( 'EE_Error', 'set_content_type' ));
+			wp_mail(get_option('admin_email'), __('Notice of Removal of WP API Basic Auth From Event Espresso 4', 'event_espresso'), $message);
+			remove_filter('wp_mail_content_type', array('EE_Error', 'set_content_type'));
 		}
 	}
 	/**
@@ -130,16 +130,16 @@ 
 	 * appear the same as they always did
 	 */
 	protected static function _set_hooks_for_changes() {
-		$folder_contents = EEH_File::get_contents_of_folders( array( EE_LIBRARIES . 'rest_api' . DS . 'changes' ), false );
-		foreach( $folder_contents as $classname_in_namespace => $filepath ) {
+		$folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES.'rest_api'.DS.'changes'), false);
+		foreach ($folder_contents as $classname_in_namespace => $filepath) {
 			//ignore the base parent class
-			if( $classname_in_namespace === 'Changes_In_Base' ) {
+			if ($classname_in_namespace === 'Changes_In_Base') {
 				continue;
 			}
-			$full_classname = 'EventEspresso\core\libraries\rest_api\changes\\' . $classname_in_namespace;
-			if ( class_exists( $full_classname )) {
+			$full_classname = 'EventEspresso\core\libraries\rest_api\changes\\'.$classname_in_namespace;
+			if (class_exists($full_classname)) {
 				$instance_of_class = new $full_classname;
-				if ( $instance_of_class instanceof EventEspresso\core\libraries\rest_api\changes\Changes_In_Base ) {
+				if ($instance_of_class instanceof EventEspresso\core\libraries\rest_api\changes\Changes_In_Base) {
 					$instance_of_class->set_hooks();
 				}
 			}
@@ -152,16 +152,16 @@ 
 	 * so we actually prefer to only do it when an EE plugin is activated or upgraded
 	 */
 	public static function register_routes() {
-		foreach( EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls ) {
-			foreach( $relative_urls as $endpoint => $routes ) {
-				foreach( $routes as $route ) {
+		foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls) {
+			foreach ($relative_urls as $endpoint => $routes) {
+				foreach ($routes as $route) {
 					register_rest_route(
 						$namespace,
 						$endpoint,
 						array(
-							'callback' => $route[ 'callback' ],
-							'methods' => $route[ 'methods' ],
-							'args' => isset( $route[ 'args' ] ) ? $route[ 'args' ] : array(),
+							'callback' => $route['callback'],
+							'methods' => $route['methods'],
+							'args' => isset($route['args']) ? $route['args'] : array(),
 						)
 					);
 				}
@@ -175,11 +175,11 @@ 
 	 * next time the WP API is used
 	 */
 	public static function invalidate_cached_route_data_on_version_change() {
-		if( EE_System::instance()->detect_req_type() != EE_System::req_type_normal ) {
+		if (EE_System::instance()->detect_req_type() != EE_System::req_type_normal) {
 			EED_Core_Rest_Api::invalidate_cached_route_data();
 		}
-		foreach( EE_Registry::instance()->addons as $addon ){
-			if( $addon instanceof EE_Addon && $addon->detect_req_type() != EE_System::req_type_normal ) {
+		foreach (EE_Registry::instance()->addons as $addon) {
+			if ($addon instanceof EE_Addon && $addon->detect_req_type() != EE_System::req_type_normal) {
 				EED_Core_Rest_Api::invalidate_cached_route_data();
 			}
 		}
@@ -190,8 +190,8 @@ 
 	 */
 	public static function invalidate_cached_route_data() {
 		//delete the saved EE REST API routes
-		foreach( EED_Core_Rest_Api::versions_served() as $version => $hidden ){
-			delete_option( EED_Core_Rest_Api::saved_routes_option_names . $version );
+		foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden) {
+			delete_option(EED_Core_Rest_Api::saved_routes_option_names.$version);
 		}
 	}
 
@@ -205,8 +205,8 @@ 
 	 */
 	public static function get_ee_route_data() {
 		$ee_routes = array();
-		foreach( self::versions_served() as $version => $hidden_endpoints ) {
-			$ee_routes[  self::ee_api_namespace . $version ] = self::_get_ee_route_data_for_version( $version, $hidden_endpoints );
+		foreach (self::versions_served() as $version => $hidden_endpoints) {
+			$ee_routes[self::ee_api_namespace.$version] = self::_get_ee_route_data_for_version($version, $hidden_endpoints);
 		}
 		return $ee_routes;
 	}
@@ -218,10 +218,10 @@ 
 	 * @param boolean $hidden_endpoints
 	 * @return array
 	 */
-	protected static function _get_ee_route_data_for_version( $version, $hidden_endpoints = false ) {
-		$ee_routes = get_option( self::saved_routes_option_names . $version , null );
-		if( ! $ee_routes || ( defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE )){
-			$ee_routes = self::_save_ee_route_data_for_version( $version, $hidden_endpoints );
+	protected static function _get_ee_route_data_for_version($version, $hidden_endpoints = false) {
+		$ee_routes = get_option(self::saved_routes_option_names.$version, null);
+		if ( ! $ee_routes || (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE)) {
+			$ee_routes = self::_save_ee_route_data_for_version($version, $hidden_endpoints);
 		}
 		return $ee_routes;
 	}
@@ -235,18 +235,18 @@ 
 	 * @param boolean $hidden_endpoints
 	 * @return mixed|null|void
 	 */
-	protected static function _save_ee_route_data_for_version( $version, $hidden_endpoints = false ) {
+	protected static function _save_ee_route_data_for_version($version, $hidden_endpoints = false) {
 		$instance = self::instance();
 		$routes = apply_filters(
 			'EED_Core_Rest_Api__save_ee_route_data_for_version__routes',
 			array_replace_recursive(
-				$instance->_get_config_route_data_for_version( $version, $hidden_endpoints ),
-				$instance->_get_meta_route_data_for_version( $version, $hidden_endpoints ),
-				$instance->_get_model_route_data_for_version( $version, $hidden_endpoints ),
-				$instance->_get_rpc_route_data_for_version( $version, $hidden_endpoints )
+				$instance->_get_config_route_data_for_version($version, $hidden_endpoints),
+				$instance->_get_meta_route_data_for_version($version, $hidden_endpoints),
+				$instance->_get_model_route_data_for_version($version, $hidden_endpoints),
+				$instance->_get_rpc_route_data_for_version($version, $hidden_endpoints)
 			)
 		);
-		update_option( self::saved_routes_option_names . $version, $routes, true );
+		update_option(self::saved_routes_option_names.$version, $routes, true);
 		return $routes;
 	}
 
@@ -257,7 +257,7 @@ 
 	 * @return void
 	 */
 	public static function save_ee_routes() {
-		if( EE_Maintenance_Mode::instance()->models_can_query() ){
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
 			$instance = self::instance();
 			$routes = apply_filters(
 				'EED_Core_Rest_Api__save_ee_routes__routes',
@@ -268,7 +268,7 @@ 
 					$instance->_register_rpc_routes()
 				)
 			);
-			update_option( self::saved_routes_option_names, $routes, true );
+			update_option(self::saved_routes_option_names, $routes, true);
 		}
 	}
 
@@ -279,8 +279,8 @@ 
 	 */
 	protected function _register_model_routes() {
 		$model_routes = array( );
-		foreach( self::versions_served() as $version => $hidden_endpoint ) {
-			$model_routes[ EED_Core_Rest_Api::ee_api_namespace . $version ] = $this->_get_config_route_data_for_version( $version, $hidden_endpoint );
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$model_routes[EED_Core_Rest_Api::ee_api_namespace.$version] = $this->_get_config_route_data_for_version($version, $hidden_endpoint);
 		}
 		return $model_routes;
 	}
@@ -291,8 +291,8 @@ 
 	 * @param boolean $hidden_endpoint
 	 * @return array
 	 */
-	protected function _get_model_route_data_for_version( $version, $hidden_endpoint = false ) {
-		$model_version_info = new \EventEspresso\core\libraries\rest_api\Model_Version_Info( $version );
+	protected function _get_model_route_data_for_version($version, $hidden_endpoint = false) {
+		$model_version_info = new \EventEspresso\core\libraries\rest_api\Model_Version_Info($version);
 		$models_to_register = apply_filters(
 			'FHEE__EED_Core_REST_API___register_model_routes',
 			$model_version_info->models_for_requested_version()
@@ -301,21 +301,21 @@ 
 		unset($models_to_register['Extra_Meta']);
 		unset($models_to_register['Extra_Join']);
 		$model_routes = array();
-		foreach ( $models_to_register as $model_name => $model_classname ) {
-			$model = \EE_Registry::instance()->load_model( $model_name );
+		foreach ($models_to_register as $model_name => $model_classname) {
+			$model = \EE_Registry::instance()->load_model($model_name);
 			//yes we could just register one route for ALL models, but then they wouldn't show up in the index
-			$plural_model_route = EEH_Inflector::pluralize_and_lower( $model_name );
-			$singular_model_route = $plural_model_route . '/(?P<id>\d+)' ;
-			$model_routes[ $plural_model_route ] = array(
+			$plural_model_route = EEH_Inflector::pluralize_and_lower($model_name);
+			$singular_model_route = $plural_model_route.'/(?P<id>\d+)';
+			$model_routes[$plural_model_route] = array(
 					array(
 						'callback' => array(
 							'EventEspresso\core\libraries\rest_api\controllers\model\Read',
 							'handle_request_get_all' ),
 						'methods' => WP_REST_Server::READABLE,
 						'hidden_endpoint' => $hidden_endpoint,
-						'args' => $this->_get_read_query_params( $model, $version ),
+						'args' => $this->_get_read_query_params($model, $version),
 						'_links' => array(
-							'self' => rest_url( EED_Core_Rest_Api::ee_api_namespace . $version . $singular_model_route ),
+							'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace.$version.$singular_model_route),
 						)
 					),
 //						array(
@@ -326,14 +326,14 @@ 
 //							'hidden_endpoint' => $hidden_endpoint
 //						)
 				);
-			$model_routes[ $singular_model_route ] = array(
+			$model_routes[$singular_model_route] = array(
 					array(
 						'callback' => array(
 							'EventEspresso\core\libraries\rest_api\controllers\model\Read',
 							'handle_request_get_one' ),
 						'methods' => WP_REST_Server::READABLE,
 						'hidden_endpoint' => $hidden_endpoint,
-						'args' => $this->_get_response_selection_query_params( $model, $version)
+						'args' => $this->_get_response_selection_query_params($model, $version)
 					),
 //						array(
 //							'callback' => array(
@@ -344,19 +344,19 @@ 
 //							),
 			);
 			//@todo: also handle  DELETE for a single item
-			foreach ( $model_version_info->relation_settings( $model ) as $relation_name => $relation_obj ) {
+			foreach ($model_version_info->relation_settings($model) as $relation_name => $relation_obj) {
 				$related_model_name_endpoint_part = EventEspresso\core\libraries\rest_api\controllers\model\Read::get_related_entity_name(
 					$relation_name,
 					$relation_obj
 				);
-				$model_routes[ $singular_model_route . '/' . $related_model_name_endpoint_part ] = array(
+				$model_routes[$singular_model_route.'/'.$related_model_name_endpoint_part] = array(
 						array(
 							'callback' => array(
 								'EventEspresso\core\libraries\rest_api\controllers\model\Read',
 								'handle_request_get_related' ),
 							'methods' => WP_REST_Server::READABLE,
 							'hidden_endpoint' => $hidden_endpoint,
-							'args' => $this->_get_read_query_params( $relation_obj->get_other_model(), $version ),
+							'args' => $this->_get_read_query_params($relation_obj->get_other_model(), $version),
 						),
 //							array(
 //								'callback' => array(
@@ -379,8 +379,8 @@ 
 	 */
 	protected function _register_rpc_routes() {
 		$routes = array();
-		foreach( self::versions_served() as $version => $hidden_endpoint ) {
-			$routes[ self::ee_api_namespace . $version ] = $this->_get_rpc_route_data_for_version( $version, $hidden_endpoint );
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$routes[self::ee_api_namespace.$version] = $this->_get_rpc_route_data_for_version($version, $hidden_endpoint);
 		}
 		return $routes;
 	}
@@ -391,10 +391,10 @@ 
 	 * @param boolean $hidden_endpoint
 	 * @return array
 	 */
-	protected function _get_rpc_route_data_for_version( $version, $hidden_endpoint = false ) {
+	protected function _get_rpc_route_data_for_version($version, $hidden_endpoint = false) {
 		$this_versions_routes = array();
 			//checkin endpoint
-			$this_versions_routes[ 'registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)' ] = array(
+			$this_versions_routes['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)'] = array(
 				array(
 					'callback' => array(
 						'EventEspresso\core\libraries\rest_api\controllers\rpc\Checkin',
@@ -405,7 +405,7 @@ 
 						'force' => array(
 							'required' => false,
 							'default' => false,
-							'description' => __( 'Whether to force toggle checkin, or to verify the registration status and allowed ticket uses', 'event_espresso' )
+							'description' => __('Whether to force toggle checkin, or to verify the registration status and allowed ticket uses', 'event_espresso')
 						)
 					)
 				)
@@ -424,7 +424,7 @@ 
 	 * @param string $version
 	 * @return array
 	 */
-	protected function _get_response_selection_query_params( \EEM_Base $model, $version ) {
+	protected function _get_response_selection_query_params(\EEM_Base $model, $version) {
 		return apply_filters(
 			'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
 			array(
@@ -435,7 +435,7 @@ 
 				'calculate' => array(
 					'required' => false,
 					'default' => '',
-					'enum' => self::$_field_calculator->retrieve_calculated_fields_for_model( $model )
+					'enum' => self::$_field_calculator->retrieve_calculated_fields_for_model($model)
 				)
 			),
 			$model,
@@ -453,13 +453,13 @@ 
 	 * @return array    describing the args acceptable when querying this model
 	 * @throws \EE_Error
 	 */
-	protected function _get_read_query_params( \EEM_Base $model, $version ) {
+	protected function _get_read_query_params(\EEM_Base $model, $version) {
 		$default_orderby = array();
-		foreach( $model->get_combined_primary_key_fields() as $key_field ) {
-			$default_orderby[ $key_field->get_name() ] = 'ASC';
+		foreach ($model->get_combined_primary_key_fields() as $key_field) {
+			$default_orderby[$key_field->get_name()] = 'ASC';
 		}
 		return array_merge(
-			$this->_get_response_selection_query_params( $model, $version ),
+			$this->_get_response_selection_query_params($model, $version),
 			array(
 				'where' => array(
 					'required' => false,
@@ -496,8 +496,8 @@ 
 	 */
 	protected function _register_config_routes() {
 		$config_routes = array();
-		foreach( self::versions_served() as $version => $hidden_endpoint ) {
-			$config_routes[ self::ee_api_namespace . $version ] = $this->_get_config_route_data_for_version( $version,	$hidden_endpoint );
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$config_routes[self::ee_api_namespace.$version] = $this->_get_config_route_data_for_version($version, $hidden_endpoint);
 		}
 		return $config_routes;
 	}
@@ -508,7 +508,7 @@ 
 	 * @param boolean $hidden_endpoint
 	 * @return array
 	 */
-	protected function _get_config_route_data_for_version( $version, $hidden_endpoint ) {
+	protected function _get_config_route_data_for_version($version, $hidden_endpoint) {
 		return array(
 			'config' => array(
 				array(
@@ -538,8 +538,8 @@ 
 	 */
 	protected function _register_meta_routes() {
 		$meta_routes = array();
-		foreach( self::versions_served() as $version => $hidden_endpoint ) {
-			$meta_routes[ self::ee_api_namespace . $version ] = $this->_get_meta_route_data_for_version( $version, $hidden_endpoint );
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$meta_routes[self::ee_api_namespace.$version] = $this->_get_meta_route_data_for_version($version, $hidden_endpoint);
 		}
 		return $meta_routes;
 	}
@@ -550,7 +550,7 @@ 
 	 * @param boolean $hidden_endpoint
 	 * @return array
 	 */
-	protected function _get_meta_route_data_for_version( $version, $hidden_endpoint = false ) {
+	protected function _get_meta_route_data_for_version($version, $hidden_endpoint = false) {
 		return array(
 			'resources'  => array(
 				array(
@@ -572,25 +572,25 @@ 
 	 * @param array $route_data
 	 * @return array
 	 */
-	public static function hide_old_endpoints( $route_data ) {
+	public static function hide_old_endpoints($route_data) {
 		//allow API clients to override which endpoints get hidden, in case
 		//they want to discover particular endpoints
 		//also, we don't have access to the request so we have to just grab it from the superglobal
 		$force_show_ee_namespace = ltrim(
-			EEH_Array::is_set( $_REQUEST, 'force_show_ee_namespace', '' ),
+			EEH_Array::is_set($_REQUEST, 'force_show_ee_namespace', ''),
 			'/'
 		);
 		
-		foreach( EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls ) {
-			foreach( $relative_urls as $endpoint => $routes ) {
-				foreach( $routes as $route ) {
+		foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls) {
+			foreach ($relative_urls as $endpoint => $routes) {
+				foreach ($routes as $route) {
 					//by default, hide "hidden_endpoint"s, unless the request indicates
 					//to $force_show_ee_namespace, in which case only show that one
 					//namespace's endpoints (and hide all others)
-					if( ( $route[ 'hidden_endpoint' ] && $force_show_ee_namespace === '' )
-						|| ( $force_show_ee_namespace !== '' && $force_show_ee_namespace !== $namespace ) ) {
-						$full_route = '/' . ltrim( $namespace, '/' ) . '/' . ltrim( $endpoint, '/' );
-						unset( $route_data[ $full_route ] );
+					if (($route['hidden_endpoint'] && $force_show_ee_namespace === '')
+						|| ($force_show_ee_namespace !== '' && $force_show_ee_namespace !== $namespace)) {
+						$full_route = '/'.ltrim($namespace, '/').'/'.ltrim($endpoint, '/');
+						unset($route_data[$full_route]);
 					}
 				}
 			}
@@ -629,8 +629,8 @@ 
 	 */
 	public static function latest_rest_api_version() {
 		$versions_served = \EED_Core_Rest_Api::versions_served();
-		$versions_served_keys = array_keys( $versions_served );
-		return end( $versions_served_keys );
+		$versions_served_keys = array_keys($versions_served);
+		return end($versions_served_keys);
 	}
 
 	/**
@@ -644,32 +644,32 @@ 
 	public static function versions_served() {
 		$versions_served = array();
 		$possibly_served_versions = EED_Core_Rest_Api::version_compatibilities();
-		$lowest_compatible_version = end( $possibly_served_versions);
-		reset( $possibly_served_versions );
-		$versions_served_historically = array_keys( $possibly_served_versions );
-		$latest_version = end( $versions_served_historically );
-		reset( $versions_served_historically );
+		$lowest_compatible_version = end($possibly_served_versions);
+		reset($possibly_served_versions);
+		$versions_served_historically = array_keys($possibly_served_versions);
+		$latest_version = end($versions_served_historically);
+		reset($versions_served_historically);
 		//for each version of core we have ever served:
-		foreach ( $versions_served_historically as $key_versioned_endpoint ) {
+		foreach ($versions_served_historically as $key_versioned_endpoint) {
 			//if it's not above the current core version, and it's compatible with the current version of core
-			if( $key_versioned_endpoint == $latest_version ) {
+			if ($key_versioned_endpoint == $latest_version) {
 				//don't hide the latest version in the index
-				$versions_served[ $key_versioned_endpoint ] = false;
-			} else if(
+				$versions_served[$key_versioned_endpoint] = false;
+			} else if (
 				$key_versioned_endpoint < EED_Core_Rest_Api::core_version()
 				&& $key_versioned_endpoint >= $lowest_compatible_version
 			) {
 				//include, but hide, previous versions which are still supported
-				$versions_served[ $key_versioned_endpoint ] = true;
-			} elseif(
+				$versions_served[$key_versioned_endpoint] = true;
+			} elseif (
 				apply_filters(
 					'FHEE__EED_Core_Rest_Api__versions_served__include_incompatible_versions',
 					false,
 					$possibly_served_versions
 				)
-			){
+			) {
 				//if a version is no longer supported, don't include it in index or list of versions served
-				$versions_served[ $key_versioned_endpoint ] = true;
+				$versions_served[$key_versioned_endpoint] = true;
 			}
 		}
 		return $versions_served;
@@ -682,7 +682,7 @@ 
 	 * @return string
 	 */
 	public static function core_version() {
-		return apply_filters( 'FHEE__EED_Core_REST_API__core_version', implode('.', array_slice( explode( '.', espresso_version() ), 0, 3 ) ) );
+		return apply_filters('FHEE__EED_Core_REST_API__core_version', implode('.', array_slice(explode('.', espresso_version()), 0, 3)));
 	}
 
 	/**
@@ -707,7 +707,7 @@ 
 	 * @param  WP $WP
 	 * @return    void
 	 */
-	public function run( $WP ) {
+	public function run($WP) {
 
 	}
 

espresso.php

Spacing +92 added lines, -92 removed lines

@@ -1,5 +1,5 @@ 
-<?php if ( ! defined( 'ABSPATH' ) ) {
-	exit( 'No direct script access allowed' );
+<?php if ( ! defined('ABSPATH')) {
+	exit('No direct script access allowed');
 }
 /*
   Plugin Name:		Event Espresso
@@ -42,7 +42,7 @@ 
  *
  */
 
-if ( function_exists( 'espresso_version' ) ) {
+if (function_exists('espresso_version')) {
 
 	/**
 	 *    espresso_duplicate_plugin_error
@@ -51,12 +51,12 @@ 
 	function espresso_duplicate_plugin_error() {
 		?>
 		<div class="error">
-			<p><?php _e( 'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.', 'event_espresso' ); ?></p>
+			<p><?php _e('Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.', 'event_espresso'); ?></p>
 		</div>
 		<?php
-		espresso_deactivate_plugin( plugin_basename( __FILE__ ) );
+		espresso_deactivate_plugin(plugin_basename(__FILE__));
 	}
-	add_action( 'admin_notices', 'espresso_duplicate_plugin_error', 1 );
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 
 } else {
 
@@ -67,102 +67,102 @@ 
 	 * @return string
 	 */
 	function espresso_version() {
-		return apply_filters( 'FHEE__espresso__espresso_version', '4.9.17.rc.005' );
+		return apply_filters('FHEE__espresso__espresso_version', '4.9.17.rc.005');
 	}
 
 	// define versions
-	define( 'EVENT_ESPRESSO_VERSION', espresso_version() );
-	define( 'EE_MIN_WP_VER_REQUIRED', '4.1' );
-	define( 'EE_MIN_WP_VER_RECOMMENDED', '4.4.2' );
-	define( 'EE_MIN_PHP_VER_REQUIRED', '5.3.0' );
-	define( 'EE_MIN_PHP_VER_RECOMMENDED', '5.4.44' );
-	define( 'EVENT_ESPRESSO_MAIN_FILE', __FILE__ );
+	define('EVENT_ESPRESSO_VERSION', espresso_version());
+	define('EE_MIN_WP_VER_REQUIRED', '4.1');
+	define('EE_MIN_WP_VER_RECOMMENDED', '4.4.2');
+	define('EE_MIN_PHP_VER_REQUIRED', '5.3.0');
+	define('EE_MIN_PHP_VER_RECOMMENDED', '5.4.44');
+	define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
 	//used to be DIRECTORY_SEPARATOR, but that caused issues on windows
-	if ( ! defined( 'DS' ) ) {
-		define( 'DS', '/' );
+	if ( ! defined('DS')) {
+		define('DS', '/');
 	}
-	if ( ! defined( 'PS' ) ) {
-		define( 'PS', PATH_SEPARATOR );
+	if ( ! defined('PS')) {
+		define('PS', PATH_SEPARATOR);
 	}
-	if ( ! defined( 'SP' ) ) {
-		define( 'SP', ' ' );
+	if ( ! defined('SP')) {
+		define('SP', ' ');
 	}
-	if ( ! defined( 'EENL' ) ) {
-		define( 'EENL', "\n" );
+	if ( ! defined('EENL')) {
+		define('EENL', "\n");
 	}
-	define( 'EE_SUPPORT_EMAIL', 'support@eventespresso.com' );
+	define('EE_SUPPORT_EMAIL', 'support@eventespresso.com');
 	// define the plugin directory and URL
-	define( 'EE_PLUGIN_BASENAME', plugin_basename( EVENT_ESPRESSO_MAIN_FILE ) );
-	define( 'EE_PLUGIN_DIR_PATH', plugin_dir_path( EVENT_ESPRESSO_MAIN_FILE ) );
-	define( 'EE_PLUGIN_DIR_URL', plugin_dir_url( EVENT_ESPRESSO_MAIN_FILE ) );
+	define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE));
+	define('EE_PLUGIN_DIR_PATH', plugin_dir_path(EVENT_ESPRESSO_MAIN_FILE));
+	define('EE_PLUGIN_DIR_URL', plugin_dir_url(EVENT_ESPRESSO_MAIN_FILE));
 	// main root folder paths
-	define( 'EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH . 'admin_pages' . DS );
-	define( 'EE_CORE', EE_PLUGIN_DIR_PATH . 'core' . DS );
-	define( 'EE_MODULES', EE_PLUGIN_DIR_PATH . 'modules' . DS );
-	define( 'EE_PUBLIC', EE_PLUGIN_DIR_PATH . 'public' . DS );
-	define( 'EE_SHORTCODES', EE_PLUGIN_DIR_PATH . 'shortcodes' . DS );
-	define( 'EE_WIDGETS', EE_PLUGIN_DIR_PATH . 'widgets' . DS );
-	define( 'EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH . 'payment_methods' . DS );
-	define( 'EE_CAFF_PATH', EE_PLUGIN_DIR_PATH . 'caffeinated' . DS );
+	define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH.'admin_pages'.DS);
+	define('EE_CORE', EE_PLUGIN_DIR_PATH.'core'.DS);
+	define('EE_MODULES', EE_PLUGIN_DIR_PATH.'modules'.DS);
+	define('EE_PUBLIC', EE_PLUGIN_DIR_PATH.'public'.DS);
+	define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH.'shortcodes'.DS);
+	define('EE_WIDGETS', EE_PLUGIN_DIR_PATH.'widgets'.DS);
+	define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH.'payment_methods'.DS);
+	define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH.'caffeinated'.DS);
 	// core system paths
-	define( 'EE_ADMIN', EE_CORE . 'admin' . DS );
-	define( 'EE_CPTS', EE_CORE . 'CPTs' . DS );
-	define( 'EE_CLASSES', EE_CORE . 'db_classes' . DS );
-	define( 'EE_INTERFACES', EE_CORE . 'interfaces' . DS );
-	define( 'EE_BUSINESS', EE_CORE . 'business' . DS );
-	define( 'EE_MODELS', EE_CORE . 'db_models' . DS );
-	define( 'EE_HELPERS', EE_CORE . 'helpers' . DS );
-	define( 'EE_LIBRARIES', EE_CORE . 'libraries' . DS );
-	define( 'EE_TEMPLATES', EE_CORE . 'templates' . DS );
-	define( 'EE_THIRD_PARTY', EE_CORE . 'third_party_libs' . DS );
-	define( 'EE_GLOBAL_ASSETS', EE_TEMPLATES . 'global_assets' . DS );
-	define( 'EE_FORM_SECTIONS', EE_LIBRARIES . 'form_sections' . DS );
+	define('EE_ADMIN', EE_CORE.'admin'.DS);
+	define('EE_CPTS', EE_CORE.'CPTs'.DS);
+	define('EE_CLASSES', EE_CORE.'db_classes'.DS);
+	define('EE_INTERFACES', EE_CORE.'interfaces'.DS);
+	define('EE_BUSINESS', EE_CORE.'business'.DS);
+	define('EE_MODELS', EE_CORE.'db_models'.DS);
+	define('EE_HELPERS', EE_CORE.'helpers'.DS);
+	define('EE_LIBRARIES', EE_CORE.'libraries'.DS);
+	define('EE_TEMPLATES', EE_CORE.'templates'.DS);
+	define('EE_THIRD_PARTY', EE_CORE.'third_party_libs'.DS);
+	define('EE_GLOBAL_ASSETS', EE_TEMPLATES.'global_assets'.DS);
+	define('EE_FORM_SECTIONS', EE_LIBRARIES.'form_sections'.DS);
 	// gateways
-	define( 'EE_GATEWAYS', EE_MODULES . 'gateways' . DS );
-	define( 'EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL . 'modules' . DS . 'gateways' . DS );
+	define('EE_GATEWAYS', EE_MODULES.'gateways'.DS);
+	define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL.'modules'.DS.'gateways'.DS);
 	// asset URL paths
-	define( 'EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'templates' . DS );
-	define( 'EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL . 'global_assets' . DS );
-	define( 'EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL . 'images' . DS );
-	define( 'EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'third_party_libs' . DS );
-	define( 'EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL . 'core/helpers/assets/' );
-	define( 'EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL . 'core/libraries/' );
+	define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL.'core'.DS.'templates'.DS);
+	define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL.'global_assets'.DS);
+	define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL.'images'.DS);
+	define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL.'core'.DS.'third_party_libs'.DS);
+	define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL.'core/helpers/assets/');
+	define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL.'core/libraries/');
 	// define upload paths
 	$uploads = wp_upload_dir();
 	// define the uploads directory and URL
-	define( 'EVENT_ESPRESSO_UPLOAD_DIR', $uploads[ 'basedir' ] . DS . 'espresso' . DS );
-	define( 'EVENT_ESPRESSO_UPLOAD_URL', $uploads[ 'baseurl' ] . DS . 'espresso' . DS );
+	define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'].DS.'espresso'.DS);
+	define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'].DS.'espresso'.DS);
 	// define the templates directory and URL
-	define( 'EVENT_ESPRESSO_TEMPLATE_DIR', $uploads[ 'basedir' ] . DS . 'espresso' . DS . 'templates' . DS );
-	define( 'EVENT_ESPRESSO_TEMPLATE_URL', $uploads[ 'baseurl' ] . DS . 'espresso' . DS . 'templates' . DS );
+	define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'].DS.'espresso'.DS.'templates'.DS);
+	define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'].DS.'espresso'.DS.'templates'.DS);
 	// define the gateway directory and URL
-	define( 'EVENT_ESPRESSO_GATEWAY_DIR', $uploads[ 'basedir' ] . DS . 'espresso' . DS . 'gateways' . DS );
-	define( 'EVENT_ESPRESSO_GATEWAY_URL', $uploads[ 'baseurl' ] . DS . 'espresso' . DS . 'gateways' . DS );
+	define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'].DS.'espresso'.DS.'gateways'.DS);
+	define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'].DS.'espresso'.DS.'gateways'.DS);
 	// languages folder/path
-	define( 'EE_LANGUAGES_SAFE_LOC', '..' . DS . 'uploads' . DS . 'espresso' . DS . 'languages' . DS );
-	define( 'EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages' . DS );
+	define('EE_LANGUAGES_SAFE_LOC', '..'.DS.'uploads'.DS.'espresso'.DS.'languages'.DS);
+	define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR.'languages'.DS);
 	//check for dompdf fonts in uploads
-	if ( file_exists( EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS ) ) {
-		define( 'DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS );
+	if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR.'fonts'.DS)) {
+		define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR.'fonts'.DS);
 	}
 	//ajax constants
-	define( 'EE_FRONT_AJAX', isset( $_REQUEST[ 'ee_front_ajax' ] ) || isset( $_REQUEST[ 'data' ][ 'ee_front_ajax' ] ) ? true : false );
-	define( 'EE_ADMIN_AJAX', isset( $_REQUEST[ 'ee_admin_ajax' ] ) || isset( $_REQUEST[ 'data' ][ 'ee_admin_ajax' ] ) ? true : false );
+	define('EE_FRONT_AJAX', isset($_REQUEST['ee_front_ajax']) || isset($_REQUEST['data']['ee_front_ajax']) ? true : false);
+	define('EE_ADMIN_AJAX', isset($_REQUEST['ee_admin_ajax']) || isset($_REQUEST['data']['ee_admin_ajax']) ? true : false);
 	//just a handy constant occasionally needed for finding values representing infinity in the DB
 	//you're better to use this than its straight value (currently -1) in case you ever
 	//want to change its default value! or find when -1 means infinity
-	define( 'EE_INF_IN_DB', -1 );
-	define( 'EE_INF', INF > (float)PHP_INT_MAX ? INF : PHP_INT_MAX );
-	define( 'EE_DEBUG', false );
+	define('EE_INF_IN_DB', -1);
+	define('EE_INF', INF > (float) PHP_INT_MAX ? INF : PHP_INT_MAX);
+	define('EE_DEBUG', false);
 
 	/**
 	 *    espresso_plugin_activation
 	 *    adds a wp-option to indicate that EE has been activated via the WP admin plugins page
 	 */
 	function espresso_plugin_activation() {
-		update_option( 'ee_espresso_activation', true );
+		update_option('ee_espresso_activation', true);
 	}
-	register_activation_hook( EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation' );
+	register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
 
 
 
@@ -176,7 +176,7 @@ 
 		//	}
 		//
 	}
-	register_deactivation_hook( EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_deactivation' );
+	register_deactivation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_deactivation');
 
 
 
@@ -186,15 +186,15 @@ 
 	 */
 	function espresso_load_error_handling() {
 		// load debugging tools
-		if ( WP_DEBUG === true && is_readable( EE_HELPERS . 'EEH_Debug_Tools.helper.php' ) ) {
-			require_once( EE_HELPERS . 'EEH_Debug_Tools.helper.php' );
+		if (WP_DEBUG === true && is_readable(EE_HELPERS.'EEH_Debug_Tools.helper.php')) {
+			require_once(EE_HELPERS.'EEH_Debug_Tools.helper.php');
 			EEH_Debug_Tools::instance();
 		}
 		// load error handling
-		if ( is_readable( EE_CORE . 'EE_Error.core.php' ) ) {
-			require_once( EE_CORE . 'EE_Error.core.php' );
+		if (is_readable(EE_CORE.'EE_Error.core.php')) {
+			require_once(EE_CORE.'EE_Error.core.php');
 		} else {
-			wp_die( __( 'The EE_Error core class could not be loaded.', 'event_espresso' ) );
+			wp_die(__('The EE_Error core class could not be loaded.', 'event_espresso'));
 		}
 	}
 
@@ -208,25 +208,25 @@ 
 	 * @param    string $full_path_to_file
 	 * @throws    EE_Error
 	 */
-	function espresso_load_required( $classname, $full_path_to_file ) {
+	function espresso_load_required($classname, $full_path_to_file) {
 		static $error_handling_loaded = false;
-		if ( ! $error_handling_loaded ) {
+		if ( ! $error_handling_loaded) {
 			espresso_load_error_handling();
 			$error_handling_loaded = true;
 		}
-		if ( is_readable( $full_path_to_file ) ) {
-			require_once( $full_path_to_file );
+		if (is_readable($full_path_to_file)) {
+			require_once($full_path_to_file);
 		} else {
-			throw new EE_Error ( sprintf(
-				__( 'The %s class file could not be located or is not readable due to file permissions.', 'event_espresso' ),
+			throw new EE_Error(sprintf(
+				__('The %s class file could not be located or is not readable due to file permissions.', 'event_espresso'),
 				$classname
-			) );
+			));
 		}
 	}
 
-	espresso_load_required( 'EEH_Base', EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php' );
-	espresso_load_required( 'EEH_File', EE_CORE . 'helpers' . DS . 'EEH_File.helper.php' );
-	espresso_load_required( 'EE_Bootstrap', EE_CORE . 'EE_Bootstrap.core.php' );
+	espresso_load_required('EEH_Base', EE_CORE.'helpers'.DS.'EEH_Base.helper.php');
+	espresso_load_required('EEH_File', EE_CORE.'helpers'.DS.'EEH_File.helper.php');
+	espresso_load_required('EE_Bootstrap', EE_CORE.'EE_Bootstrap.core.php');
 	new EE_Bootstrap();
 
 
@@ -235,7 +235,7 @@ 
 
 
 
-if ( ! function_exists( 'espresso_deactivate_plugin' ) ) {
+if ( ! function_exists('espresso_deactivate_plugin')) {
 	/**
 	*    deactivate_plugin
 	* usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
@@ -244,11 +244,11 @@ 
 	* @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
 	* @return    void
 	*/
-	function espresso_deactivate_plugin( $plugin_basename = '' ) {
-		if ( ! function_exists( 'deactivate_plugins' ) ) {
-			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
+	function espresso_deactivate_plugin($plugin_basename = '') {
+		if ( ! function_exists('deactivate_plugins')) {
+			require_once(ABSPATH.'wp-admin/includes/plugin.php');
 		}
-		unset( $_GET[ 'activate' ], $_REQUEST[ 'activate' ] );
-		deactivate_plugins( $plugin_basename );
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
 	}
 }