eventespresso / event-espresso-core

core/db_models/EEM_State.model.php

Indentation +10 added lines, -10 removed lines

@@ -64,11 +64,11 @@ 
 
 
 	/**
-	*	reset_cached_states
-	*
-	* 	@access		private
-	*	@return 		void
-	*/
+	 *	reset_cached_states
+	 *
+	 * 	@access		private
+	 *	@return 		void
+	 */
 	public function reset_cached_states() {
 		EEM_State::$_active_states = array();
 		EEM_State::$_all_states = array();
@@ -78,11 +78,11 @@ 
 
 
 	/**
-	*		_get_states
-	*
-	* 		@access		private
-	*		@return 		array
-	*/
+	 *		_get_states
+	 *
+	 * 		@access		private
+	 *		@return 		array
+	 */
 	public function get_all_states() {
 		if ( ! self::$_all_states ) {
 			self::$_all_states = $this->get_all( array( 'order_by'=>array( 'STA_name'=>'ASC' ), 'limit'=> array( 0, 99999 )));

Spacing +37 added lines, -37 removed lines

@@ -21,8 +21,8 @@ 
  *
  * ------------------------------------------------------------------------
  */
-require_once ( EE_MODELS . 'EEM_Base.model.php' );
-require_once ( EE_CLASSES . 'EE_State.class.php' );
+require_once (EE_MODELS.'EEM_Base.model.php');
+require_once (EE_CLASSES.'EE_State.class.php');
 
 class EEM_State extends EEM_Base {
 
@@ -33,9 +33,9 @@ 
   	// array of all active states
 	private static $_active_states = FALSE;
 
-	protected function __construct( $timezone = NULL ) {
-		$this->singular_item = __('State/Province','event_espresso');
-		$this->plural_item = __('States/Provinces','event_espresso');
+	protected function __construct($timezone = NULL) {
+		$this->singular_item = __('State/Province', 'event_espresso');
+		$this->plural_item = __('States/Provinces', 'event_espresso');
 
 		$this->_tables = array(
 			'State'=> new EE_Primary_Table('esp_state', 'STA_ID')
@@ -43,10 +43,10 @@ 
 
 		$this->_fields = array(
 			'State'=>array(
-				'STA_ID'=> new EE_Primary_Key_Int_Field('STA_ID', __('State ID','event_espresso')),
-				'CNT_ISO'=> new EE_Foreign_Key_String_Field('CNT_ISO', __('Country ISO Code','event_espresso'), false, NULL, 'Country'),
-				'STA_abbrev' => new EE_Plain_Text_Field('STA_abbrev', __('State Abbreviation','event_espresso'), false, ''),
-				'STA_name' => new EE_Plain_Text_Field('STA_name', __('State Name','event_espresso'), false, ''),
+				'STA_ID'=> new EE_Primary_Key_Int_Field('STA_ID', __('State ID', 'event_espresso')),
+				'CNT_ISO'=> new EE_Foreign_Key_String_Field('CNT_ISO', __('Country ISO Code', 'event_espresso'), false, NULL, 'Country'),
+				'STA_abbrev' => new EE_Plain_Text_Field('STA_abbrev', __('State Abbreviation', 'event_espresso'), false, ''),
+				'STA_name' => new EE_Plain_Text_Field('STA_name', __('State Name', 'event_espresso'), false, ''),
 				'STA_active'=> new EE_Boolean_Field('STA_active', __('State Active Flag', 'event_espresso'), false, false)
 				));
 		$this->_model_relations = array(
@@ -55,9 +55,9 @@ 
 			'Venue'=>new EE_Has_Many_Relation(),
 		);
 		//this model is generally available for reading
-		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+		$this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
 		//@todo: only show STA_active 
-		parent::__construct( $timezone );
+		parent::__construct($timezone);
 	}
 
 
@@ -84,8 +84,8 @@ 
 	*		@return 		array
 	*/
 	public function get_all_states() {
-		if ( ! self::$_all_states ) {
-			self::$_all_states = $this->get_all( array( 'order_by'=>array( 'STA_name'=>'ASC' ), 'limit'=> array( 0, 99999 )));
+		if ( ! self::$_all_states) {
+			self::$_all_states = $this->get_all(array('order_by'=>array('STA_name'=>'ASC'), 'limit'=> array(0, 99999)));
 		}
 		return self::$_all_states;
 	}
@@ -100,14 +100,14 @@ 
 	 * @param bool  $flush_cache
 	 * @return        array
 	 */
-	public function get_all_active_states( $countries = array(), $flush_cache = FALSE ) {
-		if ( ! self::$_active_states || $flush_cache ) {
-			$countries = is_array( $countries ) && ! empty( $countries ) ? $countries : EEM_Country::instance()->get_all_active_countries();
-			self::$_active_states =  $this->get_all( array(
-				array( 'STA_active' => TRUE, 'CNT_ISO' => array( 'IN', array_keys( $countries ))),
-				'order_by' => array( 'STA_name'=>'ASC' ),
-				'limit' => array( 0, 99999 ),
-				'force_join' => array( 'Country' )
+	public function get_all_active_states($countries = array(), $flush_cache = FALSE) {
+		if ( ! self::$_active_states || $flush_cache) {
+			$countries = is_array($countries) && ! empty($countries) ? $countries : EEM_Country::instance()->get_all_active_countries();
+			self::$_active_states = $this->get_all(array(
+				array('STA_active' => TRUE, 'CNT_ISO' => array('IN', array_keys($countries))),
+				'order_by' => array('STA_name'=>'ASC'),
+				'limit' => array(0, 99999),
+				'force_join' => array('Country')
 			));
 		}
 		return self::$_active_states;
@@ -119,8 +119,8 @@ 
 	 * 	get_all_states_of_active_countries
 	 * @return array
 	 */
-	public function get_all_states_of_active_countries(){
-		if ( $states = $this->get_all( array( array( 'Country.CNT_active' => TRUE, 'STA_active' => TRUE ),  'order_by' => array( 'Country.CNT_name' => 'ASC', 'STA_name' => 'ASC' )))) {
+	public function get_all_states_of_active_countries() {
+		if ($states = $this->get_all(array(array('Country.CNT_active' => TRUE, 'STA_active' => TRUE), 'order_by' => array('Country.CNT_name' => 'ASC', 'STA_name' => 'ASC')))) {
 			return $states;
 		}
 		return FALSE;
@@ -132,11 +132,11 @@ 
 	 * 	get_all_states_of_active_countries
 	 * @return array
 	 */
-	public function get_all_active_states_for_these_countries( $countries ){
-		if ( ! $countries ) {
+	public function get_all_active_states_for_these_countries($countries) {
+		if ( ! $countries) {
 			return FALSE;
 		}
-		if ( $states = $this->get_all( array(  array( 'Country.CNT_ISO' => array( 'IN', array_keys( $countries )), 'STA_active' => TRUE ),  'order_by' => array( 'Country.CNT_name' => 'ASC', 'STA_name' => 'ASC' )))) {
+		if ($states = $this->get_all(array(array('Country.CNT_ISO' => array('IN', array_keys($countries)), 'STA_active' => TRUE), 'order_by' => array('Country.CNT_name' => 'ASC', 'STA_name' => 'ASC')))) {
 			return $states;
 		}
 		return FALSE;
@@ -148,11 +148,11 @@ 
 	 * 	get_all_states_of_active_countries
 	 * @return array
 	 */
-	public function get_all_states_for_these_countries( $countries ){
-		if ( ! $countries ) {
+	public function get_all_states_for_these_countries($countries) {
+		if ( ! $countries) {
 			return FALSE;
 		}
-		if ( $states = $this->get_all( array( array( 'Country.CNT_ISO' => array( 'IN', array_keys( $countries ))),  'order_by' => array( 'Country.CNT_name' => 'ASC', 'STA_name' => 'ASC' )))) {
+		if ($states = $this->get_all(array(array('Country.CNT_ISO' => array('IN', array_keys($countries))), 'order_by' => array('Country.CNT_name' => 'ASC', 'STA_name' => 'ASC')))) {
 			return $states;
 		}
 		return FALSE;
@@ -163,15 +163,15 @@ 
 	 * @param string $state_ID
 	 * @return string
 	 */
-	public function get_state_name_by_ID( $state_ID ){
-		if( isset( self::$_all_states[ $state_ID ] ) &&
-				self::$_all_states[ $state_ID ] instanceof EE_State ){
-			return self::$_all_states[ $state_ID ]->name();
+	public function get_state_name_by_ID($state_ID) {
+		if (isset(self::$_all_states[$state_ID]) &&
+				self::$_all_states[$state_ID] instanceof EE_State) {
+			return self::$_all_states[$state_ID]->name();
 		}
-		$names = $this->get_col( array( array( 'STA_ID' => $state_ID ), 'limit' => 1), 'STA_name' );
-		if( is_array( $names ) && ! empty( $names ) ){
-			return reset( $names );
-		}else{
+		$names = $this->get_col(array(array('STA_ID' => $state_ID), 'limit' => 1), 'STA_name');
+		if (is_array($names) && ! empty($names)) {
+			return reset($names);
+		} else {
 			return '';
 		}
 	}

core/helpers/EEH_Inflector.helper.php

Doc Comments +3 added lines, -3 removed lines

@@ -52,7 +52,7 @@ 
 
     /**
      * @param string $word
-     * @return mixed
+     * @return string
      */
     public static function singularize_and_upper( $word ) {
 		return str_replace( ' ', '_', self::humanize( self::singularize( $word ), 'all' ) );
@@ -242,7 +242,7 @@ 
     /**
      * Camelizes all but the first word. This is handy converting a method which followed EE4 legacy naming convention
      * with the new PSR-based naming conventions
-     * @param $word
+     * @param string $word
      * @return string
      */
     public static function camelize_all_but_first($word){
@@ -390,7 +390,7 @@ 
 
 
     /**
-     * @param $string
+     * @param string $string
      * @return string
      */
     public static function add_indefinite_article($string) {

Indentation +345 added lines, -345 removed lines

@@ -35,368 +35,368 @@
  * @version $Revision 0.1 $
  */
 class EEH_Inflector{
-    // ------ CLASS METHODS ------ //
-    // ---- Public methods ---- //
-    // {{{ pluralize()
+	// ------ CLASS METHODS ------ //
+	// ---- Public methods ---- //
+	// {{{ pluralize()
 
 	/**
 	 * Just calls self::pluralize and strtolower on $word and returns it
 	 * @param string $word
 	 * @return string
 	 */
-    public static function pluralize_and_lower( $word ){
+	public static function pluralize_and_lower( $word ){
 		return strtolower( self::pluralize( $word ) );
 	}
 
 
 
-    /**
-     * @param string $word
-     * @return mixed
-     */
-    public static function singularize_and_upper( $word ) {
+	/**
+	 * @param string $word
+	 * @return mixed
+	 */
+	public static function singularize_and_upper( $word ) {
 		return str_replace( ' ', '_', self::humanize( self::singularize( $word ), 'all' ) );
 	}
 
 
 
-    /**
-     * Pluralizes English nouns.
-     *
-     * @access public
-     * @static
-     * @param    string    $word    English noun to pluralize
-     * @return string Plural noun
-     */
-    public static function pluralize($word){
-        $plural = array(
-            '/(quiz)$/i'               => '\1zes',
-            '/^(ox)$/i'                => '\1en',
-            '/([m|l])ouse$/i'          => '\1ice',
-            '/(matr|vert|ind)ix|ex$/i' => '\1ices',
-            '/(x|ch|ss|sh)$/i'         => '\1es',
-            '/([^aeiouy]|qu)ies$/i'    => '\1y',
-            '/([^aeiouy]|qu)y$/i'      => '\1ies',
-            '/(hive)$/i'               => '\1s',
-            '/(?:([^f])fe|([lr])f)$/i' => '\1\2ves',
-            '/sis$/i'                  => 'ses',
-            '/([ti])um$/i'             => '\1a',
-            '/(buffal|tomat)o$/i'      => '\1oes',
-            '/(bu)s$/i'                => '\1ses',
-            '/(alias|status)/i'        => '\1es',
-            '/(octop|vir)us$/i'        => '\1i',
-            '/(ax|test)is$/i'          => '\1es',
-            '/s$/i'                    => 's',
-            '/$/'                      => 's');
-
-        $uncountable = array('equipment', 'information', 'rice', 'money', 'species', 'series', 'fish', 'sheep');
-
-        $irregular = array(
-            'person' => 'people',
-            'man'    => 'men',
-            'child'  => 'children',
-            'sex'    => 'sexes',
-            'move'   => 'moves');
-
-        $lowercased_word = strtolower($word);
-
-        foreach($uncountable as $_uncountable){
-            if(substr($lowercased_word, (-1 * strlen($_uncountable))) == $_uncountable && //even though the word "price" ends in "rice", it can be pluralized, so check the previous character isnt a letter
+	/**
+	 * Pluralizes English nouns.
+	 *
+	 * @access public
+	 * @static
+	 * @param    string    $word    English noun to pluralize
+	 * @return string Plural noun
+	 */
+	public static function pluralize($word){
+		$plural = array(
+			'/(quiz)$/i'               => '\1zes',
+			'/^(ox)$/i'                => '\1en',
+			'/([m|l])ouse$/i'          => '\1ice',
+			'/(matr|vert|ind)ix|ex$/i' => '\1ices',
+			'/(x|ch|ss|sh)$/i'         => '\1es',
+			'/([^aeiouy]|qu)ies$/i'    => '\1y',
+			'/([^aeiouy]|qu)y$/i'      => '\1ies',
+			'/(hive)$/i'               => '\1s',
+			'/(?:([^f])fe|([lr])f)$/i' => '\1\2ves',
+			'/sis$/i'                  => 'ses',
+			'/([ti])um$/i'             => '\1a',
+			'/(buffal|tomat)o$/i'      => '\1oes',
+			'/(bu)s$/i'                => '\1ses',
+			'/(alias|status)/i'        => '\1es',
+			'/(octop|vir)us$/i'        => '\1i',
+			'/(ax|test)is$/i'          => '\1es',
+			'/s$/i'                    => 's',
+			'/$/'                      => 's');
+
+		$uncountable = array('equipment', 'information', 'rice', 'money', 'species', 'series', 'fish', 'sheep');
+
+		$irregular = array(
+			'person' => 'people',
+			'man'    => 'men',
+			'child'  => 'children',
+			'sex'    => 'sexes',
+			'move'   => 'moves');
+
+		$lowercased_word = strtolower($word);
+
+		foreach($uncountable as $_uncountable){
+			if(substr($lowercased_word, (-1 * strlen($_uncountable))) == $_uncountable && //even though the word "price" ends in "rice", it can be pluralized, so check the previous character isnt a letter
 					! ctype_alpha( $lowercased_word[ strlen( $lowercased_word ) - strlen($_uncountable) ] ) ){
-                return $word;
-            }
-        }
-
-        foreach($irregular as $_plural => $_singular){
-            if(preg_match('/(' . $_plural . ')$/i', $word, $arr)){
-                return preg_replace('/(' . $_plural . ')$/i', substr($arr[0], 0, 1) . substr($_singular, 1), $word);
-            }
-        }
-
-        foreach($plural as $rule => $replacement){
-            if(preg_match($rule, $word)){
-                return preg_replace($rule, $replacement, $word);
-            }
-        }
-        return false;
-    }
-
-    // }}}
-    // {{{ singularize()
-
-    /**
-     * Singularizes English nouns.
-     *
-     * @access public
-     * @static
-     * @param    string    $word    English noun to singularize
-     * @return string Singular noun.
-     */
-    public static function singularize($word){
-        $singular = array(
-            '/(quiz)zes$/i'                                                    => '\1',
-            '/(matr)ices$/i'                                                   => '\1ix',
-            '/(vert|ind)ices$/i'                                               => '\1ex',
-            '/^(ox)en/i'                                                       => '\1',
-            '/(alias|status)es$/i'                                             => '\1',
-            '/([octop|vir])i$/i'                                               => '\1us',
-            '/(cris|ax|test)es$/i'                                             => '\1is',
-            '/(shoe)s$/i'                                                      => '\1',
-            '/(o)es$/i'                                                        => '\1',
-            '/(bus)es$/i'                                                      => '\1',
-            '/([m|l])ice$/i'                                                   => '\1ouse',
-            '/(x|ch|ss|sh)es$/i'                                               => '\1',
-            '/(m)ovies$/i'                                                     => '\1ovie',
-            '/(s)eries$/i'                                                     => '\1eries',
-            '/([^aeiouy]|qu)ies$/i'                                            => '\1y',
-            '/([lr])ves$/i'                                                    => '\1f',
-            '/(tive)s$/i'                                                      => '\1',
-            '/(hive)s$/i'                                                      => '\1',
-            '/([^f])ves$/i'                                                    => '\1fe',
-            '/(^analy)ses$/i'                                                  => '\1sis',
-            '/((a)naly|(b)a|(d)iagno|(p)arenthe|(p)rogno|(s)ynop|(t)he)ses$/i' => '\1\2sis',
-            '/([ti])a$/i'                                                      => '\1um',
-            '/(n)ews$/i'                                                       => '\1ews',
-            '/s$/i'                                                            => '',
-        );
-
-        $uncountable = array('equipment', 'information', 'rice', 'money', 'species', 'series', 'fish', 'sheep');
-
-        $irregular = array(
-            'person' => 'people',
-            'man'    => 'men',
-            'child'  => 'children',
-            'sex'    => 'sexes',
-            'move'   => 'moves');
-
-        $lowercased_word = strtolower($word);
-        foreach($uncountable as $_uncountable){
-            if(substr($lowercased_word, (-1 * strlen($_uncountable))) == $_uncountable){
-                return $word;
-            }
-        }
-
-        foreach($irregular as $_plural => $_singular){
-            if(preg_match('/(' . $_singular . ')$/i', $word, $arr)){
-                return preg_replace('/(' . $_singular . ')$/i', substr($arr[0], 0, 1) . substr($_plural, 1), $word);
-            }
-        }
-
-        foreach($singular as $rule => $replacement){
-            if(preg_match($rule, $word)){
-                return preg_replace($rule, $replacement, $word);
-            }
-        }
-
-        return $word;
-    }
-
-    // }}}
-    // {{{ titleize()
-
-    /**
-     * Converts an underscored or CamelCase word into a English
-     * sentence.
-     *
-     * The titleize static function converts text like "WelcomePage",
-     * "welcome_page" or  "welcome page" to this "Welcome
-     * Page".
-     * If second parameter is set to 'first' it will only
-     * capitalize the first character of the title.
-     *
-     * @access public
-     * @static
-     * @param    string    $word    Word to format as tile
-     * @param    string    $uppercase    If set to 'first' it will only uppercase the
-     * first character. Otherwise it will uppercase all
-     * the words in the title.
-     * @return string Text formatted as title
-     */
-    public static function titleize($word, $uppercase = ''){
-        $uppercase = $uppercase === 'first' ? 'ucfirst' : 'ucwords';
-        return $uppercase(EEH_Inflector::humanize(EEH_Inflector::underscore($word)));
-    }
-
-    // }}}
-    // {{{ camelize()
-
-    /**
-     * Returns given word as CamelCased
-     *
-     * Converts a word like "send_email" to "SendEmail". It
-     * will remove non alphanumeric character from the word, so
-     * "who's online" will be converted to "WhoSOnline"
-     *
-     * @access public
-     * @static
-     * @see variablize
-     * @param    string    $word    Word to convert to camel case
-     * @return string UpperCamelCasedWord
-     */
-    public static function camelize($word){
-        return str_replace(' ', '', ucwords(preg_replace('/[^A-Z^a-z^0-9]+/', ' ', $word)));
-    }
-
-
-
-    /**
-     * Camelizes all but the first word. This is handy converting a method which followed EE4 legacy naming convention
-     * with the new PSR-based naming conventions
-     * @param $word
-     * @return string
-     */
-    public static function camelize_all_but_first($word){
-        return lcfirst(EEH_Inflector::camelize($word));
-    }
-    // }}}
-    // {{{ underscore()
-
-    /**
-     * Converts a word "into_it_s_underscored_version"
-     *
-     * Convert any "CamelCased" or "ordinary Word" into an
-     * "underscored_word".
-     *
-     * This can be really useful for creating friendly URLs.
-     *
-     * @access public
-     * @static
-     * @param    string    $word    Word to underscore
-     * @return string Underscored word
-     */
-    public static function underscore($word){
-        return strtolower(preg_replace('/[^A-Z^a-z^0-9]+/', '_', preg_replace('/([a-zd])([A-Z])/', '1_2', preg_replace('/([A-Z]+)([A-Z][a-z])/', '1_2', $word))));
-    }
-
-    // }}}
-    // {{{ humanize()
-
-    /**
-     * Returns a human-readable string from $word
-     *
-     * Returns a human-readable string from $word, by replacing
-     * underscores with a space, and by upper-casing the initial
-     * character by default.
-     *
-     * If you need to uppercase all the words you just have to
-     * pass 'all' as a second parameter.
-     *
-     * @access public
-     * @static
-     * @param    string    $word    String to "humanize"
-     * @param    string    $uppercase    If set to 'all' it will uppercase all the words
-     * instead of just the first one.
-     * @return string Human-readable word
-     */
-    public static function humanize($word, $uppercase = ''){
+				return $word;
+			}
+		}
+
+		foreach($irregular as $_plural => $_singular){
+			if(preg_match('/(' . $_plural . ')$/i', $word, $arr)){
+				return preg_replace('/(' . $_plural . ')$/i', substr($arr[0], 0, 1) . substr($_singular, 1), $word);
+			}
+		}
+
+		foreach($plural as $rule => $replacement){
+			if(preg_match($rule, $word)){
+				return preg_replace($rule, $replacement, $word);
+			}
+		}
+		return false;
+	}
+
+	// }}}
+	// {{{ singularize()
+
+	/**
+	 * Singularizes English nouns.
+	 *
+	 * @access public
+	 * @static
+	 * @param    string    $word    English noun to singularize
+	 * @return string Singular noun.
+	 */
+	public static function singularize($word){
+		$singular = array(
+			'/(quiz)zes$/i'                                                    => '\1',
+			'/(matr)ices$/i'                                                   => '\1ix',
+			'/(vert|ind)ices$/i'                                               => '\1ex',
+			'/^(ox)en/i'                                                       => '\1',
+			'/(alias|status)es$/i'                                             => '\1',
+			'/([octop|vir])i$/i'                                               => '\1us',
+			'/(cris|ax|test)es$/i'                                             => '\1is',
+			'/(shoe)s$/i'                                                      => '\1',
+			'/(o)es$/i'                                                        => '\1',
+			'/(bus)es$/i'                                                      => '\1',
+			'/([m|l])ice$/i'                                                   => '\1ouse',
+			'/(x|ch|ss|sh)es$/i'                                               => '\1',
+			'/(m)ovies$/i'                                                     => '\1ovie',
+			'/(s)eries$/i'                                                     => '\1eries',
+			'/([^aeiouy]|qu)ies$/i'                                            => '\1y',
+			'/([lr])ves$/i'                                                    => '\1f',
+			'/(tive)s$/i'                                                      => '\1',
+			'/(hive)s$/i'                                                      => '\1',
+			'/([^f])ves$/i'                                                    => '\1fe',
+			'/(^analy)ses$/i'                                                  => '\1sis',
+			'/((a)naly|(b)a|(d)iagno|(p)arenthe|(p)rogno|(s)ynop|(t)he)ses$/i' => '\1\2sis',
+			'/([ti])a$/i'                                                      => '\1um',
+			'/(n)ews$/i'                                                       => '\1ews',
+			'/s$/i'                                                            => '',
+		);
+
+		$uncountable = array('equipment', 'information', 'rice', 'money', 'species', 'series', 'fish', 'sheep');
+
+		$irregular = array(
+			'person' => 'people',
+			'man'    => 'men',
+			'child'  => 'children',
+			'sex'    => 'sexes',
+			'move'   => 'moves');
+
+		$lowercased_word = strtolower($word);
+		foreach($uncountable as $_uncountable){
+			if(substr($lowercased_word, (-1 * strlen($_uncountable))) == $_uncountable){
+				return $word;
+			}
+		}
+
+		foreach($irregular as $_plural => $_singular){
+			if(preg_match('/(' . $_singular . ')$/i', $word, $arr)){
+				return preg_replace('/(' . $_singular . ')$/i', substr($arr[0], 0, 1) . substr($_plural, 1), $word);
+			}
+		}
+
+		foreach($singular as $rule => $replacement){
+			if(preg_match($rule, $word)){
+				return preg_replace($rule, $replacement, $word);
+			}
+		}
+
+		return $word;
+	}
+
+	// }}}
+	// {{{ titleize()
+
+	/**
+	 * Converts an underscored or CamelCase word into a English
+	 * sentence.
+	 *
+	 * The titleize static function converts text like "WelcomePage",
+	 * "welcome_page" or  "welcome page" to this "Welcome
+	 * Page".
+	 * If second parameter is set to 'first' it will only
+	 * capitalize the first character of the title.
+	 *
+	 * @access public
+	 * @static
+	 * @param    string    $word    Word to format as tile
+	 * @param    string    $uppercase    If set to 'first' it will only uppercase the
+	 * first character. Otherwise it will uppercase all
+	 * the words in the title.
+	 * @return string Text formatted as title
+	 */
+	public static function titleize($word, $uppercase = ''){
+		$uppercase = $uppercase === 'first' ? 'ucfirst' : 'ucwords';
+		return $uppercase(EEH_Inflector::humanize(EEH_Inflector::underscore($word)));
+	}
+
+	// }}}
+	// {{{ camelize()
+
+	/**
+	 * Returns given word as CamelCased
+	 *
+	 * Converts a word like "send_email" to "SendEmail". It
+	 * will remove non alphanumeric character from the word, so
+	 * "who's online" will be converted to "WhoSOnline"
+	 *
+	 * @access public
+	 * @static
+	 * @see variablize
+	 * @param    string    $word    Word to convert to camel case
+	 * @return string UpperCamelCasedWord
+	 */
+	public static function camelize($word){
+		return str_replace(' ', '', ucwords(preg_replace('/[^A-Z^a-z^0-9]+/', ' ', $word)));
+	}
+
+
+
+	/**
+	 * Camelizes all but the first word. This is handy converting a method which followed EE4 legacy naming convention
+	 * with the new PSR-based naming conventions
+	 * @param $word
+	 * @return string
+	 */
+	public static function camelize_all_but_first($word){
+		return lcfirst(EEH_Inflector::camelize($word));
+	}
+	// }}}
+	// {{{ underscore()
+
+	/**
+	 * Converts a word "into_it_s_underscored_version"
+	 *
+	 * Convert any "CamelCased" or "ordinary Word" into an
+	 * "underscored_word".
+	 *
+	 * This can be really useful for creating friendly URLs.
+	 *
+	 * @access public
+	 * @static
+	 * @param    string    $word    Word to underscore
+	 * @return string Underscored word
+	 */
+	public static function underscore($word){
+		return strtolower(preg_replace('/[^A-Z^a-z^0-9]+/', '_', preg_replace('/([a-zd])([A-Z])/', '1_2', preg_replace('/([A-Z]+)([A-Z][a-z])/', '1_2', $word))));
+	}
+
+	// }}}
+	// {{{ humanize()
+
+	/**
+	 * Returns a human-readable string from $word
+	 *
+	 * Returns a human-readable string from $word, by replacing
+	 * underscores with a space, and by upper-casing the initial
+	 * character by default.
+	 *
+	 * If you need to uppercase all the words you just have to
+	 * pass 'all' as a second parameter.
+	 *
+	 * @access public
+	 * @static
+	 * @param    string    $word    String to "humanize"
+	 * @param    string    $uppercase    If set to 'all' it will uppercase all the words
+	 * instead of just the first one.
+	 * @return string Human-readable word
+	 */
+	public static function humanize($word, $uppercase = ''){
 		//make special exceptions for acronyms
 		$word = str_replace('wp_', 'WP_', $word );
-        $uppercase = $uppercase === 'all' ? 'ucwords' : 'ucfirst';
-        return $uppercase(str_replace('_', ' ', preg_replace('/_id$/', '', $word)));
-    }
-
-    // }}}
-    // {{{ variablize()
-
-    /**
-     * Same as camelize but first char is underscored
-     *
-     * Converts a word like "send_email" to "sendEmail". It
-     * will remove non alphanumeric character from the word, so
-     * "who's online" will be converted to "whoSOnline"
-     *
-     * @access public
-     * @static
-     * @see camelize
-     * @param    string    $word    Word to lowerCamelCase
-     * @return string Returns a lowerCamelCasedWord
-     */
-    public static function variablize($word){
-        $word = EEH_Inflector::camelize($word);
-        return strtolower($word[0]) . substr($word, 1);
-    }
-
-    // }}}
-    // {{{ tableize()
-
-    /**
-     * Converts a class name to its table name according to rails
-     * naming conventions.
-     *
-     * Converts "Person" to "people"
-     *
-     * @access public
-     * @static
-     * @see classify
-     * @param    string    $class_name    Class name for getting related table_name.
-     * @return string plural_table_name
-     */
-    public static function tableize($class_name){
-        return EEH_Inflector::pluralize(EEH_Inflector::underscore($class_name));
-    }
-
-    // }}}
-    // {{{ classify()
-
-    /**
-     * Converts a table name to its class name according to rails
-     * naming conventions.
-     *
-     * Converts "people" to "Person"
-     *
-     * @access public
-     * @static
-     * @see tableize
-     * @param    string    $table_name    Table name for getting related ClassName.
-     * @return string SingularClassName
-     */
-    public static function classify($table_name){
-        return EEH_Inflector::camelize(EEH_Inflector::singularize($table_name));
-    }
-
-    // }}}
-    // {{{ ordinalize()
-
-    /**
-     * Converts number to its ordinal English form.
-     *
-     * This method converts 13 to 13th, 2 to 2nd ...
-     *
-     * @access public
-     * @static
-     * @param    integer    $number    Number to get its ordinal value
-     * @return string Ordinal representation of given string.
-     */
-    public static function ordinalize($number){
-        if(in_array(($number % 100), range(11, 13))){
-            return $number . 'th';
-        }else{
-            switch(($number % 10)){
-                case 1:
-                    return $number . 'st';
-                    break;
-                case 2:
-                    return $number . 'nd';
-                    break;
-                case 3:
-                    return $number . 'rd';
-                default:
-                    return $number . 'th';
-                    break;
-            }
-        }
-    }
-
-
-
-    /**
-     * @param $string
-     * @return string
-     */
-    public static function add_indefinite_article($string) {
-        if (strtolower($string) === 'null') {
-            return $string;
-        }
-        return (stripos('aeiou', $string[0]) !== false ? 'an ' : 'a ') . $string;
-    }
+		$uppercase = $uppercase === 'all' ? 'ucwords' : 'ucfirst';
+		return $uppercase(str_replace('_', ' ', preg_replace('/_id$/', '', $word)));
+	}
+
+	// }}}
+	// {{{ variablize()
+
+	/**
+	 * Same as camelize but first char is underscored
+	 *
+	 * Converts a word like "send_email" to "sendEmail". It
+	 * will remove non alphanumeric character from the word, so
+	 * "who's online" will be converted to "whoSOnline"
+	 *
+	 * @access public
+	 * @static
+	 * @see camelize
+	 * @param    string    $word    Word to lowerCamelCase
+	 * @return string Returns a lowerCamelCasedWord
+	 */
+	public static function variablize($word){
+		$word = EEH_Inflector::camelize($word);
+		return strtolower($word[0]) . substr($word, 1);
+	}
+
+	// }}}
+	// {{{ tableize()
+
+	/**
+	 * Converts a class name to its table name according to rails
+	 * naming conventions.
+	 *
+	 * Converts "Person" to "people"
+	 *
+	 * @access public
+	 * @static
+	 * @see classify
+	 * @param    string    $class_name    Class name for getting related table_name.
+	 * @return string plural_table_name
+	 */
+	public static function tableize($class_name){
+		return EEH_Inflector::pluralize(EEH_Inflector::underscore($class_name));
+	}
+
+	// }}}
+	// {{{ classify()
+
+	/**
+	 * Converts a table name to its class name according to rails
+	 * naming conventions.
+	 *
+	 * Converts "people" to "Person"
+	 *
+	 * @access public
+	 * @static
+	 * @see tableize
+	 * @param    string    $table_name    Table name for getting related ClassName.
+	 * @return string SingularClassName
+	 */
+	public static function classify($table_name){
+		return EEH_Inflector::camelize(EEH_Inflector::singularize($table_name));
+	}
+
+	// }}}
+	// {{{ ordinalize()
+
+	/**
+	 * Converts number to its ordinal English form.
+	 *
+	 * This method converts 13 to 13th, 2 to 2nd ...
+	 *
+	 * @access public
+	 * @static
+	 * @param    integer    $number    Number to get its ordinal value
+	 * @return string Ordinal representation of given string.
+	 */
+	public static function ordinalize($number){
+		if(in_array(($number % 100), range(11, 13))){
+			return $number . 'th';
+		}else{
+			switch(($number % 10)){
+				case 1:
+					return $number . 'st';
+					break;
+				case 2:
+					return $number . 'nd';
+					break;
+				case 3:
+					return $number . 'rd';
+				default:
+					return $number . 'th';
+					break;
+			}
+		}
+	}
+
+
+
+	/**
+	 * @param $string
+	 * @return string
+	 */
+	public static function add_indefinite_article($string) {
+		if (strtolower($string) === 'null') {
+			return $string;
+		}
+		return (stripos('aeiou', $string[0]) !== false ? 'an ' : 'a ') . $string;
+	}
 }
\ No newline at end of file

Spacing +44 added lines, -44 removed lines

@@ -1,6 +1,6 @@ 
 <?php
-if ( !defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 // +----------------------------------------------------------------------+
@@ -34,7 +34,7 @@ 
  * @since 0.1
  * @version $Revision 0.1 $
  */
-class EEH_Inflector{
+class EEH_Inflector {
     // ------ CLASS METHODS ------ //
     // ---- Public methods ---- //
     // {{{ pluralize()
@@ -44,8 +44,8 @@ 
 	 * @param string $word
 	 * @return string
 	 */
-    public static function pluralize_and_lower( $word ){
-		return strtolower( self::pluralize( $word ) );
+    public static function pluralize_and_lower($word) {
+		return strtolower(self::pluralize($word));
 	}
 
 
@@ -54,8 +54,8 @@ 
      * @param string $word
      * @return mixed
      */
-    public static function singularize_and_upper( $word ) {
-		return str_replace( ' ', '_', self::humanize( self::singularize( $word ), 'all' ) );
+    public static function singularize_and_upper($word) {
+		return str_replace(' ', '_', self::humanize(self::singularize($word), 'all'));
 	}
 
 
@@ -68,7 +68,7 @@ 
      * @param    string    $word    English noun to pluralize
      * @return string Plural noun
      */
-    public static function pluralize($word){
+    public static function pluralize($word) {
         $plural = array(
             '/(quiz)$/i'               => '\1zes',
             '/^(ox)$/i'                => '\1en',
@@ -100,21 +100,21 @@ 
 
         $lowercased_word = strtolower($word);
 
-        foreach($uncountable as $_uncountable){
-            if(substr($lowercased_word, (-1 * strlen($_uncountable))) == $_uncountable && //even though the word "price" ends in "rice", it can be pluralized, so check the previous character isnt a letter
-					! ctype_alpha( $lowercased_word[ strlen( $lowercased_word ) - strlen($_uncountable) ] ) ){
+        foreach ($uncountable as $_uncountable) {
+            if (substr($lowercased_word, (-1 * strlen($_uncountable))) == $_uncountable && //even though the word "price" ends in "rice", it can be pluralized, so check the previous character isnt a letter
+					! ctype_alpha($lowercased_word[strlen($lowercased_word) - strlen($_uncountable)])) {
                 return $word;
             }
         }
 
-        foreach($irregular as $_plural => $_singular){
-            if(preg_match('/(' . $_plural . ')$/i', $word, $arr)){
-                return preg_replace('/(' . $_plural . ')$/i', substr($arr[0], 0, 1) . substr($_singular, 1), $word);
+        foreach ($irregular as $_plural => $_singular) {
+            if (preg_match('/('.$_plural.')$/i', $word, $arr)) {
+                return preg_replace('/('.$_plural.')$/i', substr($arr[0], 0, 1).substr($_singular, 1), $word);
             }
         }
 
-        foreach($plural as $rule => $replacement){
-            if(preg_match($rule, $word)){
+        foreach ($plural as $rule => $replacement) {
+            if (preg_match($rule, $word)) {
                 return preg_replace($rule, $replacement, $word);
             }
         }
@@ -132,7 +132,7 @@ 
      * @param    string    $word    English noun to singularize
      * @return string Singular noun.
      */
-    public static function singularize($word){
+    public static function singularize($word) {
         $singular = array(
             '/(quiz)zes$/i'                                                    => '\1',
             '/(matr)ices$/i'                                                   => '\1ix',
@@ -170,20 +170,20 @@ 
             'move'   => 'moves');
 
         $lowercased_word = strtolower($word);
-        foreach($uncountable as $_uncountable){
-            if(substr($lowercased_word, (-1 * strlen($_uncountable))) == $_uncountable){
+        foreach ($uncountable as $_uncountable) {
+            if (substr($lowercased_word, (-1 * strlen($_uncountable))) == $_uncountable) {
                 return $word;
             }
         }
 
-        foreach($irregular as $_plural => $_singular){
-            if(preg_match('/(' . $_singular . ')$/i', $word, $arr)){
-                return preg_replace('/(' . $_singular . ')$/i', substr($arr[0], 0, 1) . substr($_plural, 1), $word);
+        foreach ($irregular as $_plural => $_singular) {
+            if (preg_match('/('.$_singular.')$/i', $word, $arr)) {
+                return preg_replace('/('.$_singular.')$/i', substr($arr[0], 0, 1).substr($_plural, 1), $word);
             }
         }
 
-        foreach($singular as $rule => $replacement){
-            if(preg_match($rule, $word)){
+        foreach ($singular as $rule => $replacement) {
+            if (preg_match($rule, $word)) {
                 return preg_replace($rule, $replacement, $word);
             }
         }
@@ -212,7 +212,7 @@ 
      * the words in the title.
      * @return string Text formatted as title
      */
-    public static function titleize($word, $uppercase = ''){
+    public static function titleize($word, $uppercase = '') {
         $uppercase = $uppercase === 'first' ? 'ucfirst' : 'ucwords';
         return $uppercase(EEH_Inflector::humanize(EEH_Inflector::underscore($word)));
     }
@@ -233,7 +233,7 @@ 
      * @param    string    $word    Word to convert to camel case
      * @return string UpperCamelCasedWord
      */
-    public static function camelize($word){
+    public static function camelize($word) {
         return str_replace(' ', '', ucwords(preg_replace('/[^A-Z^a-z^0-9]+/', ' ', $word)));
     }
 
@@ -245,7 +245,7 @@ 
      * @param $word
      * @return string
      */
-    public static function camelize_all_but_first($word){
+    public static function camelize_all_but_first($word) {
         return lcfirst(EEH_Inflector::camelize($word));
     }
     // }}}
@@ -264,7 +264,7 @@ 
      * @param    string    $word    Word to underscore
      * @return string Underscored word
      */
-    public static function underscore($word){
+    public static function underscore($word) {
         return strtolower(preg_replace('/[^A-Z^a-z^0-9]+/', '_', preg_replace('/([a-zd])([A-Z])/', '1_2', preg_replace('/([A-Z]+)([A-Z][a-z])/', '1_2', $word))));
     }
 
@@ -288,9 +288,9 @@ 
      * instead of just the first one.
      * @return string Human-readable word
      */
-    public static function humanize($word, $uppercase = ''){
+    public static function humanize($word, $uppercase = '') {
 		//make special exceptions for acronyms
-		$word = str_replace('wp_', 'WP_', $word );
+		$word = str_replace('wp_', 'WP_', $word);
         $uppercase = $uppercase === 'all' ? 'ucwords' : 'ucfirst';
         return $uppercase(str_replace('_', ' ', preg_replace('/_id$/', '', $word)));
     }
@@ -311,9 +311,9 @@ 
      * @param    string    $word    Word to lowerCamelCase
      * @return string Returns a lowerCamelCasedWord
      */
-    public static function variablize($word){
+    public static function variablize($word) {
         $word = EEH_Inflector::camelize($word);
-        return strtolower($word[0]) . substr($word, 1);
+        return strtolower($word[0]).substr($word, 1);
     }
 
     // }}}
@@ -331,7 +331,7 @@ 
      * @param    string    $class_name    Class name for getting related table_name.
      * @return string plural_table_name
      */
-    public static function tableize($class_name){
+    public static function tableize($class_name) {
         return EEH_Inflector::pluralize(EEH_Inflector::underscore($class_name));
     }
 
@@ -350,7 +350,7 @@ 
      * @param    string    $table_name    Table name for getting related ClassName.
      * @return string SingularClassName
      */
-    public static function classify($table_name){
+    public static function classify($table_name) {
         return EEH_Inflector::camelize(EEH_Inflector::singularize($table_name));
     }
 
@@ -367,21 +367,21 @@ 
      * @param    integer    $number    Number to get its ordinal value
      * @return string Ordinal representation of given string.
      */
-    public static function ordinalize($number){
-        if(in_array(($number % 100), range(11, 13))){
-            return $number . 'th';
-        }else{
-            switch(($number % 10)){
+    public static function ordinalize($number) {
+        if (in_array(($number % 100), range(11, 13))) {
+            return $number.'th';
+        } else {
+            switch (($number % 10)) {
                 case 1:
-                    return $number . 'st';
+                    return $number.'st';
                     break;
                 case 2:
-                    return $number . 'nd';
+                    return $number.'nd';
                     break;
                 case 3:
-                    return $number . 'rd';
+                    return $number.'rd';
                 default:
-                    return $number . 'th';
+                    return $number.'th';
                     break;
             }
         }
@@ -397,6 +397,6 @@ 
         if (strtolower($string) === 'null') {
             return $string;
         }
-        return (stripos('aeiou', $string[0]) !== false ? 'an ' : 'a ') . $string;
+        return (stripos('aeiou', $string[0]) !== false ? 'an ' : 'a ').$string;
     }
 }
\ No newline at end of file

core/libraries/rest_api/controllers/Base.php

Unused Use Statements -1 removed lines

@@ -5,7 +5,6 @@
 use WP_Error;
 use WP_REST_Response;
 use EventEspresso\core\libraries\rest_api\RestException;
-
 use EE_Error;
 use EED_Core_Rest_Api;
 use EEH_Inflector;

Spacing +13 added lines, -13 removed lines

@@ -10,7 +10,7 @@ 
 use EED_Core_Rest_Api;
 use EEH_Inflector;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -120,11 +120,11 @@ 
     {
         if (is_array($value)) {
             foreach ($value as $value_key => $value_value) {
-                $this->setResponseHeader($header_key . '[' . $value_key . ']', $value_value);
+                $this->setResponseHeader($header_key.'['.$value_key.']', $value_value);
             }
         } else {
             $prefix = $use_ee_prefix ? Base::HEADER_PREFIX_FOR_EE : Base::HEADER_PREFIX_FOR_WP;
-            $this->response_headers[$prefix . $header_key] = $value;
+            $this->response_headers[$prefix.$header_key] = $value;
         }
     }
 
@@ -156,7 +156,7 @@ 
     protected function addEeErrorsToResponse(WP_Error $wp_error_response)
     {
         $notices_during_checkin = EE_Error::get_raw_notices();
-        if (! empty($notices_during_checkin['errors'])) {
+        if ( ! empty($notices_during_checkin['errors'])) {
             foreach ($notices_during_checkin['errors'] as $error_code => $error_message) {
                 $wp_error_response->add(
                     sanitize_key($error_code),
@@ -200,7 +200,7 @@ 
                 if (is_array($debug_info)) {
                     $debug_info = wp_json_encode($debug_info);
                 }
-                $headers['X-EE4-Debug-' . ucwords($debug_key)] = $debug_info;
+                $headers['X-EE4-Debug-'.ucwords($debug_key)] = $debug_info;
             }
         }
         $headers = array_merge(
@@ -231,8 +231,8 @@ 
             $status = 500;
         }
         $errors = array();
-        foreach ((array)$wp_error->errors as $code => $messages) {
-            foreach ((array)$messages as $message) {
+        foreach ((array) $wp_error->errors as $code => $messages) {
+            foreach ((array) $messages as $message) {
                 $errors[] = array(
                     'code'    => $code,
                     'message' => $message,
@@ -261,7 +261,7 @@ 
         $headers = array();
         $notices = EE_Error::get_raw_notices();
         foreach ($notices as $notice_type => $sub_notices) {
-            if (! is_array($sub_notices)) {
+            if ( ! is_array($sub_notices)) {
                 continue;
             }
             foreach ($sub_notices as $notice_code => $sub_notice) {
@@ -299,7 +299,7 @@ 
         }
         $matches = $this->parseRoute(
             $route,
-            '~' . EED_Core_Rest_Api::ee_api_namespace_for_regex . '~',
+            '~'.EED_Core_Rest_Api::ee_api_namespace_for_regex.'~',
             array('version')
         );
         if (isset($matches['version'])) {
@@ -334,14 +334,14 @@ 
         if (is_array($matches)) {
             //skip the overall regex match. Who cares
             for ($i = 1; $i <= count($match_keys); $i++) {
-                if (! isset($matches[$i])) {
+                if ( ! isset($matches[$i])) {
                     $success = false;
                 } else {
                     $indexed_matches[$match_keys[$i - 1]] = $matches[$i];
                 }
             }
         }
-        if (! $success) {
+        if ( ! $success) {
             throw new EE_Error(
                 __('We could not parse the URL. Please contact Event Espresso Support', 'event_espresso'),
                 'endpoint_parsing_error'
@@ -362,8 +362,8 @@ 
     {
         //$request->get_params();
         return array_merge(
-            (array)$request->get_body_params(),
-            (array)$request->get_json_params()
+            (array) $request->get_body_params(),
+            (array) $request->get_json_params()
         );
         // return array_diff_key(
         //    $request->get_params(),

Indentation +347 added lines, -347 removed lines

@@ -11,7 +11,7 @@ 
 use EEH_Inflector;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -27,352 +27,352 @@ 
 class Base
 {
 
-    /**
-     * @deprecated use all-caps version
-     */
-    // @codingStandardsIgnoreStart
-    const header_prefix_for_ee = 'X-EE-';
-    // @codingStandardsIgnoreEnd
-
-    const HEADER_PREFIX_FOR_EE = 'X-EE-';
-
-    /**
-     * @deprecated use all-caps version instead
-     */
-    // @codingStandardsIgnoreStart
-    const header_prefix_for_wp = 'X-WP-';
-    // @codingStandardsIgnoreEnd
-
-    const HEADER_PREFIX_FOR_WP = 'X-WP-';
-
-    /**
-     * Contains debug info we'll send back in the response headers
-     *
-     * @var array
-     */
-    protected $debug_info = array();
-
-    /**
-     * Indicates whether or not the API is in debug mode
-     *
-     * @var boolean
-     */
-    protected $debug_mode = false;
-
-    /**
-     * Indicates the version that was requested
-     *
-     * @var string
-     */
-    protected $requested_version;
-
-    /**
-     * flat array of headers to send in the response
-     *
-     * @var array
-     */
-    protected $response_headers = array();
-
-
-
-    public function __construct()
-    {
-        $this->debug_mode = defined('EE_REST_API_DEBUG_MODE') ? EE_REST_API_DEBUG_MODE : false;
-        //we are handling a REST request. Don't show a fancy HTML error message is any error comes up
-        add_filter('FHEE__EE_Error__get_error__show_normal_exceptions', '__return_true');
-    }
-
-
-
-    /**
-     * Sets the version the user requested
-     *
-     * @param string $version eg '4.8'
-     */
-    public function setRequestedVersion($version)
-    {
-        $this->requested_version = $version;
-    }
-
-
-
-    /**
-     * Sets some debug info that we'll send back in headers
-     *
-     * @param string       $key
-     * @param string|array $info
-     */
-    protected function setDebugInfo($key, $info)
-    {
-        $this->debug_info[$key] = $info;
-    }
-
-
-
-    /**
-     * Sets headers for the response
-     *
-     * @param string       $header_key    , excluding the "X-EE-" part
-     * @param array|string $value         if an array, multiple headers will be added, one
-     *                                    for each key in the array
-     * @param boolean      $use_ee_prefix whether to use the EE prefix on the header, or fallback to
-     *                                    the standard WP one
-     */
-    protected function setResponseHeader($header_key, $value, $use_ee_prefix = true)
-    {
-        if (is_array($value)) {
-            foreach ($value as $value_key => $value_value) {
-                $this->setResponseHeader($header_key . '[' . $value_key . ']', $value_value);
-            }
-        } else {
-            $prefix = $use_ee_prefix ? Base::HEADER_PREFIX_FOR_EE : Base::HEADER_PREFIX_FOR_WP;
-            $this->response_headers[$prefix . $header_key] = $value;
-        }
-    }
-
-
-
-    /**
-     * Returns a flat array of headers to be added to the response
-     *
-     * @return array
-     */
-    protected function getResponseHeaders()
-    {
-        return apply_filters(
-            'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
-            $this->response_headers,
-            $this,
-            $this->requested_version
-        );
-    }
-
-
-
-    /**
-     * Adds error notices from EE_Error onto the provided \WP_Error
-     *
-     * @param WP_Error $wp_error_response
-     * @return WP_Error
-     */
-    protected function addEeErrorsToResponse(WP_Error $wp_error_response)
-    {
-        $notices_during_checkin = EE_Error::get_raw_notices();
-        if (! empty($notices_during_checkin['errors'])) {
-            foreach ($notices_during_checkin['errors'] as $error_code => $error_message) {
-                $wp_error_response->add(
-                    sanitize_key($error_code),
-                    strip_tags($error_message)
-                );
-            }
-        }
-        return $wp_error_response;
-    }
-
-
-
-    /**
-     * Sends a response, but also makes sure to attach headers that
-     * are handy for debugging.
-     * Specifically, we assume folks will want to know what exactly was the DB query that got run,
-     * what exactly was the Models query that got run, what capabilities came into play, what fields were omitted from
-     * the response, others?
-     *
-     * @param array|WP_Error|Exception|RestException $response
-     * @return WP_REST_Response
-     */
-    public function sendResponse($response)
-    {
-        if ($response instanceof RestException) {
-            $response = new WP_Error($response->getStringCode(), $response->getMessage(), $response->getData());
-        }
-        if ($response instanceof Exception) {
-            $code = $response->getCode() ? $response->getCode() : 'error_occurred';
-            $response = new WP_Error($code, $response->getMessage());
-        }
-        if ($response instanceof WP_Error) {
-            $response = $this->addEeErrorsToResponse($response);
-            $rest_response = $this->createRestResponseFromWpError($response);
-        } else {
-            $rest_response = new WP_REST_Response($response, 200);
-        }
-        $headers = array();
-        if ($this->debug_mode && is_array($this->debug_info)) {
-            foreach ($this->debug_info as $debug_key => $debug_info) {
-                if (is_array($debug_info)) {
-                    $debug_info = wp_json_encode($debug_info);
-                }
-                $headers['X-EE4-Debug-' . ucwords($debug_key)] = $debug_info;
-            }
-        }
-        $headers = array_merge(
-            $headers,
-            $this->getResponseHeaders(),
-            $this->getHeadersFromEeNotices()
-        );
-        $rest_response->set_headers($headers);
-        return $rest_response;
-    }
-
-
-
-    /**
-     * Converts the \WP_Error into `WP_REST_Response.
-     * Mostly this is just a copy-and-paste from \WP_REST_Server::error_to_response
-     * (which is protected)
-     *
-     * @param WP_Error $wp_error
-     * @return WP_REST_Response
-     */
-    protected function createRestResponseFromWpError(WP_Error $wp_error)
-    {
-        $error_data = $wp_error->get_error_data();
-        if (is_array($error_data) && isset($error_data['status'])) {
-            $status = $error_data['status'];
-        } else {
-            $status = 500;
-        }
-        $errors = array();
-        foreach ((array)$wp_error->errors as $code => $messages) {
-            foreach ((array)$messages as $message) {
-                $errors[] = array(
-                    'code'    => $code,
-                    'message' => $message,
-                    'data'    => $wp_error->get_error_data($code),
-                );
-            }
-        }
-        $data = isset($errors[0]) ? $errors[0] : array();
-        if (count($errors) > 1) {
-            // Remove the primary error.
-            array_shift($errors);
-            $data['additional_errors'] = $errors;
-        }
-        return new WP_REST_Response($data, $status);
-    }
-
-
-
-    /**
-     * Array of headers derived from EE success, attention, and error messages
-     *
-     * @return array
-     */
-    protected function getHeadersFromEeNotices()
-    {
-        $headers = array();
-        $notices = EE_Error::get_raw_notices();
-        foreach ($notices as $notice_type => $sub_notices) {
-            if (! is_array($sub_notices)) {
-                continue;
-            }
-            foreach ($sub_notices as $notice_code => $sub_notice) {
-                $headers['X-EE4-Notices-'
-                         . EEH_Inflector::humanize($notice_type)
-                         . '['
-                         . $notice_code
-                         . ']'] = strip_tags($sub_notice);
-            }
-        }
-        return apply_filters(
-            'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_headers_from_ee_notices__return',
-            $headers,
-            $this->requested_version,
-            $notices
-        );
-    }
-
-
-
-    /**
-     * Finds which version of the API was requested given the route, and returns it.
-     * eg in a request to "mysite.com/wp-json/ee/v4.8.29/events/123" this would return
-     * "4.8.29".
-     * We should know hte requested version in this model though, so if no route is
-     * provided just use what we set earlier
-     *
-     * @param string $route
-     * @return string
-     */
-    public function getRequestedVersion($route = null)
-    {
-        if ($route === null) {
-            return $this->requested_version;
-        }
-        $matches = $this->parseRoute(
-            $route,
-            '~' . EED_Core_Rest_Api::ee_api_namespace_for_regex . '~',
-            array('version')
-        );
-        if (isset($matches['version'])) {
-            return $matches['version'];
-        } else {
-            return EED_Core_Rest_Api::latest_rest_api_version();
-        }
-    }
-
-
-
-    /**
-     * Applies the regex to the route, then creates an array using the values of
-     * $match_keys as keys (but ignores the full pattern match). Returns the array of matches.
-     * For example, if you call
-     * parse_route( '/ee/v4.8/events', '~\/ee\/v([^/]*)\/(.*)~', array( 'version', 'model' ) )
-     * it will return array( 'version' => '4.8', 'model' => 'events' )
-     *
-     * @param string $route
-     * @param string $regex
-     * @param array  $match_keys EXCLUDING matching the entire regex
-     * @return array where  $match_keys are the keys (the first value of $match_keys
-     *                           becomes the first key of the return value, etc. Eg passing in $match_keys of
-     *                           array( 'model', 'id' ), will, if the regex is successful, will return
-     *                           array( 'model' => 'foo', 'id' => 'bar' )
-     * @throws EE_Error if it couldn't be parsed
-     */
-    public function parseRoute($route, $regex, $match_keys)
-    {
-        $indexed_matches = array();
-        $success = preg_match($regex, $route, $matches);
-        if (is_array($matches)) {
-            //skip the overall regex match. Who cares
-            for ($i = 1; $i <= count($match_keys); $i++) {
-                if (! isset($matches[$i])) {
-                    $success = false;
-                } else {
-                    $indexed_matches[$match_keys[$i - 1]] = $matches[$i];
-                }
-            }
-        }
-        if (! $success) {
-            throw new EE_Error(
-                __('We could not parse the URL. Please contact Event Espresso Support', 'event_espresso'),
-                'endpoint_parsing_error'
-            );
-        }
-        return $indexed_matches;
-    }
-
-
-
-    /**
-     * Gets the body's params (either from JSON or parsed body), which EXCLUDES the GET params and URL params
-     *
-     * @param \WP_REST_Request $request
-     * @return array
-     */
-    protected function getBodyParams(\WP_REST_Request $request)
-    {
-        //$request->get_params();
-        return array_merge(
-            (array)$request->get_body_params(),
-            (array)$request->get_json_params()
-        );
-        // return array_diff_key(
-        //    $request->get_params(),
-        //     $request->get_url_params(),
-        //     $request->get_query_params()
-        // );
-    }
+	/**
+	 * @deprecated use all-caps version
+	 */
+	// @codingStandardsIgnoreStart
+	const header_prefix_for_ee = 'X-EE-';
+	// @codingStandardsIgnoreEnd
+
+	const HEADER_PREFIX_FOR_EE = 'X-EE-';
+
+	/**
+	 * @deprecated use all-caps version instead
+	 */
+	// @codingStandardsIgnoreStart
+	const header_prefix_for_wp = 'X-WP-';
+	// @codingStandardsIgnoreEnd
+
+	const HEADER_PREFIX_FOR_WP = 'X-WP-';
+
+	/**
+	 * Contains debug info we'll send back in the response headers
+	 *
+	 * @var array
+	 */
+	protected $debug_info = array();
+
+	/**
+	 * Indicates whether or not the API is in debug mode
+	 *
+	 * @var boolean
+	 */
+	protected $debug_mode = false;
+
+	/**
+	 * Indicates the version that was requested
+	 *
+	 * @var string
+	 */
+	protected $requested_version;
+
+	/**
+	 * flat array of headers to send in the response
+	 *
+	 * @var array
+	 */
+	protected $response_headers = array();
+
+
+
+	public function __construct()
+	{
+		$this->debug_mode = defined('EE_REST_API_DEBUG_MODE') ? EE_REST_API_DEBUG_MODE : false;
+		//we are handling a REST request. Don't show a fancy HTML error message is any error comes up
+		add_filter('FHEE__EE_Error__get_error__show_normal_exceptions', '__return_true');
+	}
+
+
+
+	/**
+	 * Sets the version the user requested
+	 *
+	 * @param string $version eg '4.8'
+	 */
+	public function setRequestedVersion($version)
+	{
+		$this->requested_version = $version;
+	}
+
+
+
+	/**
+	 * Sets some debug info that we'll send back in headers
+	 *
+	 * @param string       $key
+	 * @param string|array $info
+	 */
+	protected function setDebugInfo($key, $info)
+	{
+		$this->debug_info[$key] = $info;
+	}
+
+
+
+	/**
+	 * Sets headers for the response
+	 *
+	 * @param string       $header_key    , excluding the "X-EE-" part
+	 * @param array|string $value         if an array, multiple headers will be added, one
+	 *                                    for each key in the array
+	 * @param boolean      $use_ee_prefix whether to use the EE prefix on the header, or fallback to
+	 *                                    the standard WP one
+	 */
+	protected function setResponseHeader($header_key, $value, $use_ee_prefix = true)
+	{
+		if (is_array($value)) {
+			foreach ($value as $value_key => $value_value) {
+				$this->setResponseHeader($header_key . '[' . $value_key . ']', $value_value);
+			}
+		} else {
+			$prefix = $use_ee_prefix ? Base::HEADER_PREFIX_FOR_EE : Base::HEADER_PREFIX_FOR_WP;
+			$this->response_headers[$prefix . $header_key] = $value;
+		}
+	}
+
+
+
+	/**
+	 * Returns a flat array of headers to be added to the response
+	 *
+	 * @return array
+	 */
+	protected function getResponseHeaders()
+	{
+		return apply_filters(
+			'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
+			$this->response_headers,
+			$this,
+			$this->requested_version
+		);
+	}
+
+
+
+	/**
+	 * Adds error notices from EE_Error onto the provided \WP_Error
+	 *
+	 * @param WP_Error $wp_error_response
+	 * @return WP_Error
+	 */
+	protected function addEeErrorsToResponse(WP_Error $wp_error_response)
+	{
+		$notices_during_checkin = EE_Error::get_raw_notices();
+		if (! empty($notices_during_checkin['errors'])) {
+			foreach ($notices_during_checkin['errors'] as $error_code => $error_message) {
+				$wp_error_response->add(
+					sanitize_key($error_code),
+					strip_tags($error_message)
+				);
+			}
+		}
+		return $wp_error_response;
+	}
+
+
+
+	/**
+	 * Sends a response, but also makes sure to attach headers that
+	 * are handy for debugging.
+	 * Specifically, we assume folks will want to know what exactly was the DB query that got run,
+	 * what exactly was the Models query that got run, what capabilities came into play, what fields were omitted from
+	 * the response, others?
+	 *
+	 * @param array|WP_Error|Exception|RestException $response
+	 * @return WP_REST_Response
+	 */
+	public function sendResponse($response)
+	{
+		if ($response instanceof RestException) {
+			$response = new WP_Error($response->getStringCode(), $response->getMessage(), $response->getData());
+		}
+		if ($response instanceof Exception) {
+			$code = $response->getCode() ? $response->getCode() : 'error_occurred';
+			$response = new WP_Error($code, $response->getMessage());
+		}
+		if ($response instanceof WP_Error) {
+			$response = $this->addEeErrorsToResponse($response);
+			$rest_response = $this->createRestResponseFromWpError($response);
+		} else {
+			$rest_response = new WP_REST_Response($response, 200);
+		}
+		$headers = array();
+		if ($this->debug_mode && is_array($this->debug_info)) {
+			foreach ($this->debug_info as $debug_key => $debug_info) {
+				if (is_array($debug_info)) {
+					$debug_info = wp_json_encode($debug_info);
+				}
+				$headers['X-EE4-Debug-' . ucwords($debug_key)] = $debug_info;
+			}
+		}
+		$headers = array_merge(
+			$headers,
+			$this->getResponseHeaders(),
+			$this->getHeadersFromEeNotices()
+		);
+		$rest_response->set_headers($headers);
+		return $rest_response;
+	}
+
+
+
+	/**
+	 * Converts the \WP_Error into `WP_REST_Response.
+	 * Mostly this is just a copy-and-paste from \WP_REST_Server::error_to_response
+	 * (which is protected)
+	 *
+	 * @param WP_Error $wp_error
+	 * @return WP_REST_Response
+	 */
+	protected function createRestResponseFromWpError(WP_Error $wp_error)
+	{
+		$error_data = $wp_error->get_error_data();
+		if (is_array($error_data) && isset($error_data['status'])) {
+			$status = $error_data['status'];
+		} else {
+			$status = 500;
+		}
+		$errors = array();
+		foreach ((array)$wp_error->errors as $code => $messages) {
+			foreach ((array)$messages as $message) {
+				$errors[] = array(
+					'code'    => $code,
+					'message' => $message,
+					'data'    => $wp_error->get_error_data($code),
+				);
+			}
+		}
+		$data = isset($errors[0]) ? $errors[0] : array();
+		if (count($errors) > 1) {
+			// Remove the primary error.
+			array_shift($errors);
+			$data['additional_errors'] = $errors;
+		}
+		return new WP_REST_Response($data, $status);
+	}
+
+
+
+	/**
+	 * Array of headers derived from EE success, attention, and error messages
+	 *
+	 * @return array
+	 */
+	protected function getHeadersFromEeNotices()
+	{
+		$headers = array();
+		$notices = EE_Error::get_raw_notices();
+		foreach ($notices as $notice_type => $sub_notices) {
+			if (! is_array($sub_notices)) {
+				continue;
+			}
+			foreach ($sub_notices as $notice_code => $sub_notice) {
+				$headers['X-EE4-Notices-'
+						 . EEH_Inflector::humanize($notice_type)
+						 . '['
+						 . $notice_code
+						 . ']'] = strip_tags($sub_notice);
+			}
+		}
+		return apply_filters(
+			'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_headers_from_ee_notices__return',
+			$headers,
+			$this->requested_version,
+			$notices
+		);
+	}
+
+
+
+	/**
+	 * Finds which version of the API was requested given the route, and returns it.
+	 * eg in a request to "mysite.com/wp-json/ee/v4.8.29/events/123" this would return
+	 * "4.8.29".
+	 * We should know hte requested version in this model though, so if no route is
+	 * provided just use what we set earlier
+	 *
+	 * @param string $route
+	 * @return string
+	 */
+	public function getRequestedVersion($route = null)
+	{
+		if ($route === null) {
+			return $this->requested_version;
+		}
+		$matches = $this->parseRoute(
+			$route,
+			'~' . EED_Core_Rest_Api::ee_api_namespace_for_regex . '~',
+			array('version')
+		);
+		if (isset($matches['version'])) {
+			return $matches['version'];
+		} else {
+			return EED_Core_Rest_Api::latest_rest_api_version();
+		}
+	}
+
+
+
+	/**
+	 * Applies the regex to the route, then creates an array using the values of
+	 * $match_keys as keys (but ignores the full pattern match). Returns the array of matches.
+	 * For example, if you call
+	 * parse_route( '/ee/v4.8/events', '~\/ee\/v([^/]*)\/(.*)~', array( 'version', 'model' ) )
+	 * it will return array( 'version' => '4.8', 'model' => 'events' )
+	 *
+	 * @param string $route
+	 * @param string $regex
+	 * @param array  $match_keys EXCLUDING matching the entire regex
+	 * @return array where  $match_keys are the keys (the first value of $match_keys
+	 *                           becomes the first key of the return value, etc. Eg passing in $match_keys of
+	 *                           array( 'model', 'id' ), will, if the regex is successful, will return
+	 *                           array( 'model' => 'foo', 'id' => 'bar' )
+	 * @throws EE_Error if it couldn't be parsed
+	 */
+	public function parseRoute($route, $regex, $match_keys)
+	{
+		$indexed_matches = array();
+		$success = preg_match($regex, $route, $matches);
+		if (is_array($matches)) {
+			//skip the overall regex match. Who cares
+			for ($i = 1; $i <= count($match_keys); $i++) {
+				if (! isset($matches[$i])) {
+					$success = false;
+				} else {
+					$indexed_matches[$match_keys[$i - 1]] = $matches[$i];
+				}
+			}
+		}
+		if (! $success) {
+			throw new EE_Error(
+				__('We could not parse the URL. Please contact Event Espresso Support', 'event_espresso'),
+				'endpoint_parsing_error'
+			);
+		}
+		return $indexed_matches;
+	}
+
+
+
+	/**
+	 * Gets the body's params (either from JSON or parsed body), which EXCLUDES the GET params and URL params
+	 *
+	 * @param \WP_REST_Request $request
+	 * @return array
+	 */
+	protected function getBodyParams(\WP_REST_Request $request)
+	{
+		//$request->get_params();
+		return array_merge(
+			(array)$request->get_body_params(),
+			(array)$request->get_json_params()
+		);
+		// return array_diff_key(
+		//    $request->get_params(),
+		//     $request->get_url_params(),
+		//     $request->get_query_params()
+		// );
+	}
 }
 
 // End of file Base.php

core/libraries/form_sections/inputs/EE_Select_Ajax_Model_Rest_Input.input.php

Spacing +29 added lines, -29 removed lines

@@ -11,7 +11,7 @@ 
  * @subpackage
  * @author				Mike Nelson
  */
-class EE_Select_Ajax_Model_Rest_Input extends EE_Form_Input_With_Options_Base{
+class EE_Select_Ajax_Model_Rest_Input extends EE_Form_Input_With_Options_Base {
 
 	/**
 	 * @var string $_model_name
@@ -50,7 +50,7 @@ 
 	 *                                  And the arguments accepted by EE_Form_Input_With_Options_Base
 	 * @throws \EE_Error
 	 */
-	public function __construct( $input_settings = array() ) {
+	public function __construct($input_settings = array()) {
 		//needed input settings:
 		//select2_args
 		$this->_model_name = EEH_Array::is_set(
@@ -66,7 +66,7 @@ 
 		);
 		// make sure limit and caps are always set
 		$query_params = array_merge(
-			array( 'limit' => 10, 'caps' => EEM_Base::caps_read_admin ),
+			array('limit' => 10, 'caps' => EEM_Base::caps_read_admin),
 			$query_params
 		);
 		$this->_value_field_name = EEH_Array::is_set(
@@ -77,7 +77,7 @@ 
 		$this->_display_field_name = EEH_Array::is_set(
 			$input_settings,
 			'display_field_name',
-			$model->get_a_field_of_type( 'EE_Text_Field_Base' )->get_name()
+			$model->get_a_field_of_type('EE_Text_Field_Base')->get_name()
 		);
 		$this->_extra_select_columns = EEH_Array::is_set(
 			$input_settings,
@@ -94,24 +94,24 @@ 
 		);
 		//get resource endpoint
 		$rest_controller = new EventEspresso\core\libraries\rest_api\controllers\model\Read();
-		$rest_controller->setRequestedVersion( EED_Core_Rest_Api::latest_rest_api_version() );
+		$rest_controller->setRequestedVersion(EED_Core_Rest_Api::latest_rest_api_version());
 		$default_select2_args = array(
 			'ajax' => array(
 				'url' => $rest_controller->getVersionedLinkTo(
-					EEH_Inflector::pluralize_and_lower( $this->_model_name )
+					EEH_Inflector::pluralize_and_lower($this->_model_name)
 				),
 				'dataType' => 'json',
 				'delay' => '250',
 				'data_interface' => 'EE_Select2_REST_API_Interface',
 				'data_interface_args' => array(
-					'default_query_params' => (object)ModelDataTranslator::prepareQueryParamsForRestApi(
+					'default_query_params' => (object) ModelDataTranslator::prepareQueryParamsForRestApi(
 						$query_params,
 						$model
 					),
 					'display_field' => $this->_display_field_name,
 					'value_field' => $this->_value_field_name,
-					'nonce' => wp_create_nonce( 'wp_rest' ),
-					'locale' => str_replace( '_', '-', strtolower( get_locale() ) )
+					'nonce' => wp_create_nonce('wp_rest'),
+					'locale' => str_replace('_', '-', strtolower(get_locale()))
 				),
 			),
 			'cache' => true,
@@ -119,10 +119,10 @@ 
 		);
 		$select2_args = array_replace_recursive(
 			$default_select2_args,
-			(array)EEH_Array::is_set( $input_settings, 'select2_args', array() )
+			(array) EEH_Array::is_set($input_settings, 'select2_args', array())
 		);
-		$this->set_display_strategy( new EE_Select2_Display_Strategy( $select2_args ) );
-		parent::__construct( array(), $input_settings );
+		$this->set_display_strategy(new EE_Select2_Display_Strategy($select2_args));
+		parent::__construct(array(), $input_settings);
 	}
 
 
@@ -140,34 +140,34 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	public function _set_raw_value( $value ) {
-		$values_for_options = (array)$value;
-		$value_field = $this->_get_model()->field_settings_for( $this->_value_field_name );
-		$display_field = $this->_get_model()->field_settings_for( $this->_display_field_name );
-		$this->_extra_select_columns[] = $value_field->get_qualified_column() . ' AS ' . $this->_value_field_name;
-		$this->_extra_select_columns[] = $display_field->get_qualified_column() . ' AS ' . $this->_display_field_name;
+	public function _set_raw_value($value) {
+		$values_for_options = (array) $value;
+		$value_field = $this->_get_model()->field_settings_for($this->_value_field_name);
+		$display_field = $this->_get_model()->field_settings_for($this->_display_field_name);
+		$this->_extra_select_columns[] = $value_field->get_qualified_column().' AS '.$this->_value_field_name;
+		$this->_extra_select_columns[] = $display_field->get_qualified_column().' AS '.$this->_display_field_name;
 		$display_values = $this->_get_model()->get_all_wpdb_results(
 			array(
 				array(
-					$this->_value_field_name => array( 'IN', $values_for_options )
+					$this->_value_field_name => array('IN', $values_for_options)
 				)
 			),
 			ARRAY_A,
-			implode( ',', $this->_extra_select_columns )
+			implode(',', $this->_extra_select_columns)
 		);
 		$select_options = array();
-		if( is_array( $select_options ) ) {
-			foreach( $display_values as $db_rows ) {
-				$db_rows = (array)$db_rows;
-				$select_options[ $db_rows[ $this->_value_field_name ] ] = apply_filters(
+		if (is_array($select_options)) {
+			foreach ($display_values as $db_rows) {
+				$db_rows = (array) $db_rows;
+				$select_options[$db_rows[$this->_value_field_name]] = apply_filters(
 					'FHEE__EE_Select_Ajax_Model_Rest_Input___set_raw_value__select_option_value',
-					$db_rows[ $this->_display_field_name ],
+					$db_rows[$this->_display_field_name],
 					$db_rows
 				);
 			}
 		}
-		$this->set_select_options( $select_options );
-		parent::_set_raw_value( $value );
+		$this->set_select_options($select_options);
+		parent::_set_raw_value($value);
 	}
 
 	/**
@@ -176,7 +176,7 @@ 
 	 * @throws EE_Error
 	 */
 	protected function _get_model() {
-		if( ! EE_Registry::instance()->is_model_name(  $this->_model_name ) ) {
+		if ( ! EE_Registry::instance()->is_model_name($this->_model_name)) {
 			throw new EE_Error(
 				sprintf(
 					__(
@@ -187,7 +187,7 @@ 
 				)
 			);
 		} else {
-			return EE_Registry::instance()->load_model( $this->_model_name );
+			return EE_Registry::instance()->load_model($this->_model_name);
 		}
 	}
 

core/libraries/rest_api/CalculatedModelFields.php

Spacing +5 added lines, -5 removed lines

@@ -16,7 +16,7 @@ 
  * @author                Mike Nelson
  * @since                 4.8.35.rc.001
  */
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -44,7 +44,7 @@ 
      */
     public function mapping($refresh = false)
     {
-        if (! $this->mapping || $refresh) {
+        if ( ! $this->mapping || $refresh) {
             $this->mapping = $this->generateNewMapping();
         }
         return $this->mapping;
@@ -60,9 +60,9 @@ 
     protected function generateNewMapping()
     {
         $rest_api_calculations_namespace = 'EventEspresso\core\libraries\rest_api\calculations\\';
-        $event_calculations_class = $rest_api_calculations_namespace . 'Event';
-        $datetime_calculations_class = $rest_api_calculations_namespace . 'Datetime';
-        $registration_class = $rest_api_calculations_namespace . 'Registration';
+        $event_calculations_class = $rest_api_calculations_namespace.'Event';
+        $datetime_calculations_class = $rest_api_calculations_namespace.'Datetime';
+        $registration_class = $rest_api_calculations_namespace.'Registration';
         return apply_filters(
             'FHEE__EventEspresso\core\libraries\rest_api\Calculated_Model_Fields__mapping',
             array(

Indentation +125 added lines, -125 removed lines

@@ -16,7 +16,7 @@ 
  * @since                 4.8.35.rc.001
  */
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -24,128 +24,128 @@ 
 class CalculatedModelFields
 {
 
-    /**
-     * @var array
-     */
-    protected $mapping;
-
-
-
-    /**
-     * @param bool $refresh
-     * @return array top-level-keys are model names (eg "Event")
-     * next-level are the calculated field names AND method names on classes
-     * which perform calculations, values are the fully qualified classnames which do the calculations
-     * These callbacks should accept as arguments:
-     * the wpdb row results,
-     * the WP_Request object,
-     * the controller object
-     */
-    public function mapping($refresh = false)
-    {
-        if (! $this->mapping || $refresh) {
-            $this->mapping = $this->generateNewMapping();
-        }
-        return $this->mapping;
-    }
-
-
-
-    /**
-     * Generates  anew mapping between model calculated fields and their callbacks
-     *
-     * @return array
-     */
-    protected function generateNewMapping()
-    {
-        $rest_api_calculations_namespace = 'EventEspresso\core\libraries\rest_api\calculations\\';
-        $event_calculations_class = $rest_api_calculations_namespace . 'Event';
-        $datetime_calculations_class = $rest_api_calculations_namespace . 'Datetime';
-        $registration_class = $rest_api_calculations_namespace . 'Registration';
-        return apply_filters(
-            'FHEE__EventEspresso\core\libraries\rest_api\Calculated_Model_Fields__mapping',
-            array(
-                'Event'        => array(
-                    'optimum_sales_at_start'          => $event_calculations_class,
-                    'optimum_sales_now'               => $event_calculations_class,
-                    'spots_taken'                     => $event_calculations_class,
-                    'spots_taken_pending_payment'     => $event_calculations_class,
-                    'spaces_remaining'                => $event_calculations_class,
-                    'registrations_checked_in_count'  => $event_calculations_class,
-                    'registrations_checked_out_count' => $event_calculations_class,
-                    'image_thumbnail'                 => $event_calculations_class,
-                    'image_medium'                    => $event_calculations_class,
-                    'image_medium_large'              => $event_calculations_class,
-                    'image_large'                     => $event_calculations_class,
-                    'image_post_thumbnail'            => $event_calculations_class,
-                    'image_full'                      => $event_calculations_class,
-                ),
-                'Datetime'     => array(
-                    'spaces_remaining_considering_tickets' => $datetime_calculations_class,
-                    'registrations_checked_in_count'       => $datetime_calculations_class,
-                    'registrations_checked_out_count'      => $datetime_calculations_class,
-                    'spots_taken_pending_payment'          => $datetime_calculations_class,
-                ),
-                'Registration' => array(
-                    'datetime_checkin_stati' => $registration_class,
-                ),
-            )
-        );
-    }
-
-
-
-    /**
-     * Gets the known calculated fields for model
-     *
-     * @param EEM_Base $model
-     * @return array allowable values for this field
-     */
-    public function retrieveCalculatedFieldsForModel(EEM_Base $model)
-    {
-        $mapping = $this->mapping();
-        if (isset($mapping[$model->get_this_model_name()])) {
-            return array_keys($mapping[$model->get_this_model_name()]);
-        } else {
-            return array();
-        }
-    }
-
-
-
-    /**
-     * Retrieves the value for this calculation
-     *
-     * @param EEM_Base                                                $model
-     * @param string                                                  $field_name
-     * @param array                                                   $wpdb_row
-     * @param \WP_REST_Request
-     * @param \EventEspresso\core\libraries\rest_api\controllers\Base $controller
-     * @return mixed|null
-     * @throws \EE_Error
-     */
-    public function retrieveCalculatedFieldValue(
-        EEM_Base $model,
-        $field_name,
-        $wpdb_row,
-        $rest_request,
-        Base $controller
-    ) {
-        $mapping = $this->mapping();
-        if (isset($mapping[$model->get_this_model_name()])
-            && isset($mapping[$model->get_this_model_name()][$field_name])
-        ) {
-            $classname = $mapping[$model->get_this_model_name()][$field_name];
-            $class_method_name = EEH_Inflector::camelize_all_but_first($field_name);
-            return call_user_func(array($classname, $class_method_name), $wpdb_row, $rest_request, $controller);
-        }
-        throw new RestException(
-            'calculated_field_does_not_exist',
-            sprintf(
-                __('There is no calculated field %1$s on resource %2$s', 'event_espresso'),
-                $field_name,
-                $model->get_this_model_name()
-            )
-        );
-    }
+	/**
+	 * @var array
+	 */
+	protected $mapping;
+
+
+
+	/**
+	 * @param bool $refresh
+	 * @return array top-level-keys are model names (eg "Event")
+	 * next-level are the calculated field names AND method names on classes
+	 * which perform calculations, values are the fully qualified classnames which do the calculations
+	 * These callbacks should accept as arguments:
+	 * the wpdb row results,
+	 * the WP_Request object,
+	 * the controller object
+	 */
+	public function mapping($refresh = false)
+	{
+		if (! $this->mapping || $refresh) {
+			$this->mapping = $this->generateNewMapping();
+		}
+		return $this->mapping;
+	}
+
+
+
+	/**
+	 * Generates  anew mapping between model calculated fields and their callbacks
+	 *
+	 * @return array
+	 */
+	protected function generateNewMapping()
+	{
+		$rest_api_calculations_namespace = 'EventEspresso\core\libraries\rest_api\calculations\\';
+		$event_calculations_class = $rest_api_calculations_namespace . 'Event';
+		$datetime_calculations_class = $rest_api_calculations_namespace . 'Datetime';
+		$registration_class = $rest_api_calculations_namespace . 'Registration';
+		return apply_filters(
+			'FHEE__EventEspresso\core\libraries\rest_api\Calculated_Model_Fields__mapping',
+			array(
+				'Event'        => array(
+					'optimum_sales_at_start'          => $event_calculations_class,
+					'optimum_sales_now'               => $event_calculations_class,
+					'spots_taken'                     => $event_calculations_class,
+					'spots_taken_pending_payment'     => $event_calculations_class,
+					'spaces_remaining'                => $event_calculations_class,
+					'registrations_checked_in_count'  => $event_calculations_class,
+					'registrations_checked_out_count' => $event_calculations_class,
+					'image_thumbnail'                 => $event_calculations_class,
+					'image_medium'                    => $event_calculations_class,
+					'image_medium_large'              => $event_calculations_class,
+					'image_large'                     => $event_calculations_class,
+					'image_post_thumbnail'            => $event_calculations_class,
+					'image_full'                      => $event_calculations_class,
+				),
+				'Datetime'     => array(
+					'spaces_remaining_considering_tickets' => $datetime_calculations_class,
+					'registrations_checked_in_count'       => $datetime_calculations_class,
+					'registrations_checked_out_count'      => $datetime_calculations_class,
+					'spots_taken_pending_payment'          => $datetime_calculations_class,
+				),
+				'Registration' => array(
+					'datetime_checkin_stati' => $registration_class,
+				),
+			)
+		);
+	}
+
+
+
+	/**
+	 * Gets the known calculated fields for model
+	 *
+	 * @param EEM_Base $model
+	 * @return array allowable values for this field
+	 */
+	public function retrieveCalculatedFieldsForModel(EEM_Base $model)
+	{
+		$mapping = $this->mapping();
+		if (isset($mapping[$model->get_this_model_name()])) {
+			return array_keys($mapping[$model->get_this_model_name()]);
+		} else {
+			return array();
+		}
+	}
+
+
+
+	/**
+	 * Retrieves the value for this calculation
+	 *
+	 * @param EEM_Base                                                $model
+	 * @param string                                                  $field_name
+	 * @param array                                                   $wpdb_row
+	 * @param \WP_REST_Request
+	 * @param \EventEspresso\core\libraries\rest_api\controllers\Base $controller
+	 * @return mixed|null
+	 * @throws \EE_Error
+	 */
+	public function retrieveCalculatedFieldValue(
+		EEM_Base $model,
+		$field_name,
+		$wpdb_row,
+		$rest_request,
+		Base $controller
+	) {
+		$mapping = $this->mapping();
+		if (isset($mapping[$model->get_this_model_name()])
+			&& isset($mapping[$model->get_this_model_name()][$field_name])
+		) {
+			$classname = $mapping[$model->get_this_model_name()][$field_name];
+			$class_method_name = EEH_Inflector::camelize_all_but_first($field_name);
+			return call_user_func(array($classname, $class_method_name), $wpdb_row, $rest_request, $controller);
+		}
+		throw new RestException(
+			'calculated_field_does_not_exist',
+			sprintf(
+				__('There is no calculated field %1$s on resource %2$s', 'event_espresso'),
+				$field_name,
+				$model->get_this_model_name()
+			)
+		);
+	}
 }

core/libraries/rest_api/calculations/Base.php

Spacing +2 added lines, -2 removed lines

@@ -12,7 +12,7 @@ 
  * @author                Mike Nelson
  * @since                 $VID:$
  */
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -28,7 +28,7 @@ 
      */
     protected static function verifyCurrentUserCan($required_permission, $attempted_calculation)
     {
-        if (! current_user_can($required_permission)) {
+        if ( ! current_user_can($required_permission)) {
             throw new RestException(
                 'permission_denied',
                 sprintf(

Indentation +38 added lines, -38 removed lines

@@ -14,7 +14,7 @@ 
  * @since                 $VID:$
  */
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -22,41 +22,41 @@ 
 class Base
 {
 
-    /**
-     * @param $required_permission
-     * @param $attempted_calculation
-     * @throws \EventEspresso\core\libraries\rest_api\RestException
-     */
-    protected static function verifyCurrentUserCan($required_permission, $attempted_calculation)
-    {
-        if (! current_user_can($required_permission)) {
-            throw new RestException(
-                'permission_denied',
-                sprintf(
-                    __(
-                        // @codingStandardsIgnoreStart
-                        'Permission denied, you cannot calculate %1$s on %2$s because you do not have the capability "%3$s"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $attempted_calculation,
-                    EEH_Inflector::pluralize_and_lower(self::getResourceName()),
-                    $required_permission
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * Gets the name of the resource of the called class
-     *
-     * @return string
-     */
-    public static function getResourceName()
-    {
-        $classname = get_called_class();
-        return substr($classname, strrpos($classname, '\\') + 1);
-    }
+	/**
+	 * @param $required_permission
+	 * @param $attempted_calculation
+	 * @throws \EventEspresso\core\libraries\rest_api\RestException
+	 */
+	protected static function verifyCurrentUserCan($required_permission, $attempted_calculation)
+	{
+		if (! current_user_can($required_permission)) {
+			throw new RestException(
+				'permission_denied',
+				sprintf(
+					__(
+						// @codingStandardsIgnoreStart
+						'Permission denied, you cannot calculate %1$s on %2$s because you do not have the capability "%3$s"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$attempted_calculation,
+					EEH_Inflector::pluralize_and_lower(self::getResourceName()),
+					$required_permission
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * Gets the name of the resource of the called class
+	 *
+	 * @return string
+	 */
+	public static function getResourceName()
+	{
+		$classname = get_called_class();
+		return substr($classname, strrpos($classname, '\\') + 1);
+	}
 }

core/libraries/rest_api/calculations/Registration.php

Spacing +2 added lines, -2 removed lines

@@ -15,7 +15,7 @@ 
  * @author                Mike Nelson
  * @since                 $VID:$
  */
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -40,7 +40,7 @@ 
         } else {
             $reg = null;
         }
-        if (! $reg instanceof EE_Registration
+        if ( ! $reg instanceof EE_Registration
         ) {
             throw new \EE_Error(
                 sprintf(

Indentation +59 added lines, -59 removed lines

@@ -17,7 +17,7 @@ 
  * @since                 $VID:$
  */
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -25,62 +25,62 @@ 
 class Registration extends Calculations_Base
 {
 
-    /**
-     * Calculates the checkin status for each datetime this registration has access to
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return array
-     * @throws \EE_Error
-     */
-    public static function datetimeCheckinStati($wpdb_row, $request, $controller)
-    {
-        if (is_array($wpdb_row) && isset($wpdb_row['Registration.REG_ID'])) {
-            $reg = EEM_Registration::instance()->get_one_by_ID($wpdb_row['Registration.REG_ID']);
-        } else {
-            $reg = null;
-        }
-        if (! $reg instanceof EE_Registration
-        ) {
-            throw new \EE_Error(
-                sprintf(
-                    __(
-                        // @codingStandardsIgnoreStart
-                        'Cannot calculate datetime_checkin_stati because the registration with ID %1$s (from database row %2$s) was not found',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $wpdb_row['Registration.REG_ID'],
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        $datetime_ids = EEM_Datetime::instance()->get_col(
-            array(
-                array(
-                    'Ticket.TKT_ID' => $reg->ticket_ID(),
-                ),
-                'default_where_conditions' => \EEM_Base::default_where_conditions_minimum_all
-            )
-        );
-        $checkin_stati = array();
-        foreach ($datetime_ids as $datetime_id) {
-            $status = $reg->check_in_status_for_datetime($datetime_id);
-            switch ($status) {
-                case EE_Checkin::status_checked_out:
-                    $status_pretty = 'OUT';
-                    break;
-                case EE_Checkin::status_checked_in:
-                    $status_pretty = 'IN';
-                    break;
-                case EE_Checkin::status_checked_never:
-                default:
-                    $status_pretty = 'NEVER';
-                    break;
-            }
-            $checkin_stati[$datetime_id] = $status_pretty;
-        }
-        return $checkin_stati;
-    }
+	/**
+	 * Calculates the checkin status for each datetime this registration has access to
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public static function datetimeCheckinStati($wpdb_row, $request, $controller)
+	{
+		if (is_array($wpdb_row) && isset($wpdb_row['Registration.REG_ID'])) {
+			$reg = EEM_Registration::instance()->get_one_by_ID($wpdb_row['Registration.REG_ID']);
+		} else {
+			$reg = null;
+		}
+		if (! $reg instanceof EE_Registration
+		) {
+			throw new \EE_Error(
+				sprintf(
+					__(
+						// @codingStandardsIgnoreStart
+						'Cannot calculate datetime_checkin_stati because the registration with ID %1$s (from database row %2$s) was not found',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$wpdb_row['Registration.REG_ID'],
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		$datetime_ids = EEM_Datetime::instance()->get_col(
+			array(
+				array(
+					'Ticket.TKT_ID' => $reg->ticket_ID(),
+				),
+				'default_where_conditions' => \EEM_Base::default_where_conditions_minimum_all
+			)
+		);
+		$checkin_stati = array();
+		foreach ($datetime_ids as $datetime_id) {
+			$status = $reg->check_in_status_for_datetime($datetime_id);
+			switch ($status) {
+				case EE_Checkin::status_checked_out:
+					$status_pretty = 'OUT';
+					break;
+				case EE_Checkin::status_checked_in:
+					$status_pretty = 'IN';
+					break;
+				case EE_Checkin::status_checked_never:
+				default:
+					$status_pretty = 'NEVER';
+					break;
+			}
+			$checkin_stati[$datetime_id] = $status_pretty;
+		}
+		return $checkin_stati;
+	}
 }

core/libraries/rest_api/controllers/config/Read.php

Spacing +3 added lines, -3 removed lines

@@ -9,7 +9,7 @@ 
 use EE_Restriction_Generator_Base;
 use EEH_DTT_Helper;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -90,8 +90,8 @@ 
             ),
             'default_currency' => EE_Config::instance()->currency,
             'authentication'   => array(
-                'received_basic_auth_data'     => (bool)$wp_json_basic_auth_received_data,
-                'insecure_usage_of_basic_auth' => (bool)$insecure_usage_of_basic_auth,
+                'received_basic_auth_data'     => (bool) $wp_json_basic_auth_received_data,
+                'insecure_usage_of_basic_auth' => (bool) $insecure_usage_of_basic_auth,
                 'warning'                      => $warning
             )
         );

Indentation +74 added lines, -74 removed lines

@@ -9,7 +9,7 @@ 
 use EEH_DTT_Helper;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -25,82 +25,82 @@ 
 class Read
 {
 
-    /**
-     * @param WP_REST_Request $request
-     * @param string           $version
-     * @return EE_Config|WP_Error
-     */
-    public static function handleRequest(WP_REST_Request $request, $version)
-    {
-        $cap = EE_Restriction_Generator_Base::get_default_restrictions_cap();
-        if (EE_Capabilities::instance()->current_user_can($cap, 'read_over_api')) {
-            return EE_Config::instance();
-        } else {
-            return new WP_Error(
-                'cannot_read_config',
-                sprintf(
-                    __(
-                        'You do not have the necessary capabilities (%s) to read Event Espresso Configuration data',
-                        'event_espresso'
-                    ),
-                    $cap
-                ),
-                array('status' => 403)
-            );
-        }
-    }
+	/**
+	 * @param WP_REST_Request $request
+	 * @param string           $version
+	 * @return EE_Config|WP_Error
+	 */
+	public static function handleRequest(WP_REST_Request $request, $version)
+	{
+		$cap = EE_Restriction_Generator_Base::get_default_restrictions_cap();
+		if (EE_Capabilities::instance()->current_user_can($cap, 'read_over_api')) {
+			return EE_Config::instance();
+		} else {
+			return new WP_Error(
+				'cannot_read_config',
+				sprintf(
+					__(
+						'You do not have the necessary capabilities (%s) to read Event Espresso Configuration data',
+						'event_espresso'
+					),
+					$cap
+				),
+				array('status' => 403)
+			);
+		}
+	}
 
 
 
-    /**
-     * Handles the request for public site info
-     *
-     * @global                 $wp_json_basic_auth_success       boolean set by the basic auth plugin, indicates if the
-     *                         current user could be authenticated using basic auth data
-     * @global                 $wp_json_basic_auth_received_data boolean set by the basic auth plugin, indicates if
-     *                         basic auth data was somehow received
-     * @param WP_REST_Request $request
-     * @param string           $version
-     * @return array|WP_Error
-     */
-    public static function handleRequestSiteInfo(WP_REST_Request $request, $version)
-    {
-        global $wp_json_basic_auth_success, $wp_json_basic_auth_received_data;
-        $insecure_usage_of_basic_auth = apply_filters(
-            // @codingStandardsIgnoreStart
-            'EventEspresso__core__libraries__rest_api__controllers__config__handle_request_site_info__insecure_usage_of_basic_auth',
-            // @codingStandardsIgnoreEnd
-            $wp_json_basic_auth_success && ! is_ssl(),
-            $request
-        );
-        if ($insecure_usage_of_basic_auth) {
-            $warning = sprintf(
-                esc_html__(
-                    // @codingStandardsIgnoreStart
-                    'Notice: We strongly recommend installing an SSL Certificate on your website to keep your data secure. %1$sPlease see our recommendations.%2$s',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                ),
-                '<a href="https://eventespresso.com/wiki/rest-api-security-recommendations/">',
-                '</a>'
-            );
-        } else {
-            $warning = '';
-        }
-        return array(
-            'default_timezone' => array(
-                'pretty' => EEH_DTT_Helper::get_timezone_string_for_display(),
-                'string' => get_option('timezone_string'),
-                'offset' => EEH_DTT_Helper::get_site_timezone_gmt_offset(),
-            ),
-            'default_currency' => EE_Config::instance()->currency,
-            'authentication'   => array(
-                'received_basic_auth_data'     => (bool)$wp_json_basic_auth_received_data,
-                'insecure_usage_of_basic_auth' => (bool)$insecure_usage_of_basic_auth,
-                'warning'                      => $warning
-            )
-        );
-    }
+	/**
+	 * Handles the request for public site info
+	 *
+	 * @global                 $wp_json_basic_auth_success       boolean set by the basic auth plugin, indicates if the
+	 *                         current user could be authenticated using basic auth data
+	 * @global                 $wp_json_basic_auth_received_data boolean set by the basic auth plugin, indicates if
+	 *                         basic auth data was somehow received
+	 * @param WP_REST_Request $request
+	 * @param string           $version
+	 * @return array|WP_Error
+	 */
+	public static function handleRequestSiteInfo(WP_REST_Request $request, $version)
+	{
+		global $wp_json_basic_auth_success, $wp_json_basic_auth_received_data;
+		$insecure_usage_of_basic_auth = apply_filters(
+			// @codingStandardsIgnoreStart
+			'EventEspresso__core__libraries__rest_api__controllers__config__handle_request_site_info__insecure_usage_of_basic_auth',
+			// @codingStandardsIgnoreEnd
+			$wp_json_basic_auth_success && ! is_ssl(),
+			$request
+		);
+		if ($insecure_usage_of_basic_auth) {
+			$warning = sprintf(
+				esc_html__(
+					// @codingStandardsIgnoreStart
+					'Notice: We strongly recommend installing an SSL Certificate on your website to keep your data secure. %1$sPlease see our recommendations.%2$s',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				),
+				'<a href="https://eventespresso.com/wiki/rest-api-security-recommendations/">',
+				'</a>'
+			);
+		} else {
+			$warning = '';
+		}
+		return array(
+			'default_timezone' => array(
+				'pretty' => EEH_DTT_Helper::get_timezone_string_for_display(),
+				'string' => get_option('timezone_string'),
+				'offset' => EEH_DTT_Helper::get_site_timezone_gmt_offset(),
+			),
+			'default_currency' => EE_Config::instance()->currency,
+			'authentication'   => array(
+				'received_basic_auth_data'     => (bool)$wp_json_basic_auth_received_data,
+				'insecure_usage_of_basic_auth' => (bool)$insecure_usage_of_basic_auth,
+				'warning'                      => $warning
+			)
+		);
+	}
 }
 
 // End of file Read.php

core/libraries/rest_api/ModelVersionInfo.php

Spacing +4 added lines, -4 removed lines

@@ -4,7 +4,7 @@ 
 use EE_Registry;
 use EED_Core_Rest_Api;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -97,7 +97,7 @@ 
      */
     public function __construct($requested_version)
     {
-        $this->requested_version = (string)$requested_version;
+        $this->requested_version = (string) $requested_version;
         $this->model_changes = array(
             '4.8.29' => array(
                 //first version where the REST API is in EE core, so no need
@@ -122,7 +122,7 @@ 
                 foreach ($extra_fields as $fieldname => $field_data) {
                     $this->resource_changes[$model_classname][$fieldname]['name'] = $fieldname;
                     foreach ($defaults as $attribute => $default_value) {
-                        if (! isset($this->resource_changes[$model_classname][$fieldname][$attribute])) {
+                        if ( ! isset($this->resource_changes[$model_classname][$fieldname][$attribute])) {
                             $this->resource_changes[$model_classname][$fieldname][$attribute] = $default_value;
                         }
                     }
@@ -294,7 +294,7 @@ 
      */
     public function fieldsOnModelInThisVersion($model)
     {
-        if (! isset($this->cached_fields_on_models[$model->get_this_model_name()])) {
+        if ( ! isset($this->cached_fields_on_models[$model->get_this_model_name()])) {
             //get all model changes between the requested version and current core version
             $changes = $this->modelChangesBetweenRequestedVersionAndCurrent();
             //fetch all fields currently on this model

Indentation +456 added lines, -456 removed lines

@@ -5,7 +5,7 @@ 
 use EED_Core_Rest_Api;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -26,461 +26,461 @@ 
 class ModelVersionInfo
 {
 
-    /**
-     * Constant used in the $_model_changes array to indicate that a model
-     * was completely new in this version
-     */
-    const MODEL_ADDED = 'model_added_in_this_version';
-
-    /**
-     * Top-level keys are versions (major and minor version numbers, eg "4.6")
-     * next-level keys are model names (eg "Event") that underwent some change in that version
-     * and the value is either Model_Version_Info::model_added (indicating the model is completely NEW in this version),
-     * or it's an array where the values are model field names,
-     * or API resource properties (ie, non-model fields that appear in REST API results)
-     * If a version is missing then we don't know anything about what changes it introduced from the previous version
-     *
-     * @var array
-     */
-    protected $model_changes = array();
-
-    /**
-     * top-level keys are version numbers,
-     * next-level keys are model CLASSNAMES (even parent classnames),
-     * and next-level keys are extra resource properties to attach to those models' resources,
-     * and next-level key-value pairs, where the keys are:
-     * 'raw', 'type', 'nullable', 'table_alias', 'table_column',  'always_available'
-     *
-     * @var array
-     */
-    protected $resource_changes = array();
-
-    /**
-     * @var string indicating what version of the API was requested
-     * (eg although core might be at version 4.8.11, they may have sent a request
-     * for 4.6)
-     */
-    protected $requested_version = null;
-
-    /**
-     * Keys are model names, values are their classnames.
-     * We cache this so we only need to calculate this once per request
-     *
-     * @var array
-     */
-    protected $cached_models_for_requested_version = null;
-
-    /**
-     * @var array
-     */
-    protected $cached_model_changes_between_requested_version_and_current = null;
-
-    /**
-     * @var array
-     */
-    protected $cached_resource_changes_between_requested_version_and_current = null;
-
-    /**
-     * 2d array where top-level keys are model names, 2nd-level keys are field names
-     * and values are the actual field objects
-     *
-     * @var array
-     */
-    protected $cached_fields_on_models = array();
-
-
-
-    /**
-     * Model_Version_Info constructor.
-     *
-     * @param string $requested_version
-     */
-    public function __construct($requested_version)
-    {
-        $this->requested_version = (string)$requested_version;
-        $this->model_changes = array(
-            '4.8.29' => array(
-                //first version where the REST API is in EE core, so no need
-                //to specify how its different from the previous
-            ),
-        );
-        //setup data for "extra" fields added onto resources which don't actually exist on models
-        $this->resource_changes = apply_filters(
-            'FHEE__Model_Version_Info___construct__extra_resource_properties_for_models',
-            array()
-        );
-        $defaults = array(
-            'raw'              => false,
-            'type'             => 'N/A',
-            'nullable'         => true,
-            'table_alias'      => 'N/A',
-            'table_column'     => 'N/A',
-            'always_available' => true,
-        );
-        foreach ($this->resource_changes as $version => $model_classnames) {
-            foreach ($model_classnames as $model_classname => $extra_fields) {
-                foreach ($extra_fields as $fieldname => $field_data) {
-                    $this->resource_changes[$model_classname][$fieldname]['name'] = $fieldname;
-                    foreach ($defaults as $attribute => $default_value) {
-                        if (! isset($this->resource_changes[$model_classname][$fieldname][$attribute])) {
-                            $this->resource_changes[$model_classname][$fieldname][$attribute] = $default_value;
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * Returns a slice of Model_Version_Info::model_changes()'s array
-     * indicating exactly what changes happened between the current core version,
-     * and the version requested
-     *
-     * @return array
-     */
-    public function modelChangesBetweenRequestedVersionAndCurrent()
-    {
-        if ($this->cached_model_changes_between_requested_version_and_current === null) {
-            $model_changes = array();
-            foreach ($this->modelChanges() as $version => $models_changed_in_version) {
-                if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
-                    $model_changes[$version] = $models_changed_in_version;
-                }
-            }
-            $this->cached_model_changes_between_requested_version_and_current = $model_changes;
-        }
-        return $this->cached_model_changes_between_requested_version_and_current;
-    }
-
-
-
-    /**
-     * Returns a slice of Model_Version_Info::model_changes()'s array
-     * indicating exactly what changes happened between the current core version,
-     * and the version requested
-     *
-     * @return array
-     */
-    public function resourceChangesBetweenRequestedVersionAndCurrent()
-    {
-        if ($this->cached_resource_changes_between_requested_version_and_current === null) {
-            $resource_changes = array();
-            foreach ($this->resourceChanges() as $version => $model_classnames) {
-                if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
-                    $resource_changes[$version] = $model_classnames;
-                }
-            }
-            $this->cached_resource_changes_between_requested_version_and_current = $resource_changes;
-        }
-        return $this->cached_resource_changes_between_requested_version_and_current;
-    }
-
-
-
-    /**
-     * If a request was sent to 'wp-json/ee/v4.7/events' this would be '4.7'
-     *
-     * @return string like '4.6'
-     */
-    public function requestedVersion()
-    {
-        return $this->requested_version;
-    }
-
-
-
-    /**
-     * Returns an array describing how the models have changed in each version of core
-     * that supports the API (starting at 4.6)
-     * Top-level keys are versions (major and minor version numbers, eg "4.6")
-     * next-level keys are model names (eg "Event") that underwent some change in that version
-     * and the value is either NULL (indicating the model is completely NEW in this version),
-     * or it's an array where fields are value names.
-     * If a version is missing then we don't know anything about what changes it introduced from the previous version
-     *
-     * @return array
-     */
-    public function modelChanges()
-    {
-        return $this->model_changes;
-    }
-
-
-
-    /**
-     * Takes into account the requested version, and the current version, and
-     * what changed between the two, and tries to return.
-     * Analogous to EE_Registry::instance()->non_abstract_db_models
-     *
-     * @return array keys are model names, values are their classname
-     */
-    public function modelsForRequestedVersion()
-    {
-        if ($this->cached_models_for_requested_version === null) {
-            $all_models_in_current_version = EE_Registry::instance()->non_abstract_db_models;
-            foreach ($this->modelChangesBetweenRequestedVersionAndCurrent() as $version => $models_changed) {
-                foreach ($models_changed as $model_name => $new_indicator_or_fields_added) {
-                    if ($new_indicator_or_fields_added === ModelVersionInfo::MODEL_ADDED) {
-                        unset($all_models_in_current_version[$model_name]);
-                    }
-                }
-            }
-            $this->cached_models_for_requested_version = apply_filters(
-                'FHEE__EventEspresso_core_libraries_rest_api__models_for_requested_version',
-                $all_models_in_current_version,
-                $this
-            );
-        }
-        return $this->cached_models_for_requested_version;
-    }
-
-
-
-    /**
-     * Determines if this is a valid model name in the requested version.
-     * Similar to EE_Registry::instance()->is_model_name(), but takes the requested
-     * version's models into account
-     *
-     * @param string $model_name eg 'Event'
-     * @return boolean
-     */
-    public function isModelNameInThisVersion($model_name)
-    {
-        $model_names = $this->modelsForRequestedVersion();
-        if (isset($model_names[$model_name])) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * Wrapper for EE_Registry::instance()->load_model(), but takes the requested
-     * version's models into account
-     *
-     * @param string $model_name
-     * @return \EEM_Base
-     * @throws \EE_Error
-     */
-    public function loadModel($model_name)
-    {
-        if ($this->isModelNameInThisVersion($model_name)) {
-            return EE_Registry::instance()->load_model($model_name);
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    __(
-                        'Cannot load model "%1$s" because it does not exist in version %2$s of Event Espresso',
-                        'event_espresso'
-                    ),
-                    $model_name,
-                    $this->requestedVersion()
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * Gets all the fields that should exist on this model right now
-     *
-     * @param \EEM_Base $model
-     * @return array|\EE_Model_Field_Base[]
-     */
-    public function fieldsOnModelInThisVersion($model)
-    {
-        if (! isset($this->cached_fields_on_models[$model->get_this_model_name()])) {
-            //get all model changes between the requested version and current core version
-            $changes = $this->modelChangesBetweenRequestedVersionAndCurrent();
-            //fetch all fields currently on this model
-            $current_fields = $model->field_settings();
-            //remove all fields that have been added since
-            foreach ($changes as $version => $changes_in_version) {
-                if (isset($changes_in_version[$model->get_this_model_name()])
-                    && $changes_in_version[$model->get_this_model_name()] !== ModelVersionInfo::MODEL_ADDED
-                ) {
-                    $current_fields = array_diff_key(
-                        $current_fields,
-                        array_flip($changes_in_version[$model->get_this_model_name()])
-                    );
-                }
-            }
-            $this->cached_fields_on_models = $current_fields;
-        }
-        return $this->cached_fields_on_models;
-    }
-
-
-
-    /**
-     * Determines if $object is of one of the classes of $classes. Similar to
-     * in_array(), except this checks if $object is a subclass of the classnames provided
-     * in $classnames
-     *
-     * @param object $object
-     * @param array  $classnames
-     * @return boolean
-     */
-    public function isSubclassOfOne($object, $classnames)
-    {
-        foreach ($classnames as $classname) {
-            if (is_a($object, $classname)) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Returns the list of model field classes that that the API basically ignores
-     *
-     * @return array
-     */
-    public function fieldsIgnored()
-    {
-        return apply_filters(
-            'FHEE__Controller_Model_Read_fields_ignored',
-            array('EE_Foreign_Key_Field_Base', 'EE_Any_Foreign_Model_Name_Field')
-        );
-    }
-
-
-
-    /**
-     * If this field one that should be ignored by the API?
-     *
-     * @param EE_Model_Field_Base
-     * @return boolean
-     */
-    public function fieldIsIgnored($field_obj)
-    {
-        return $this->isSubclassOfOne($field_obj, $this->fieldsIgnored());
-    }
-
-
-
-    /**
-     * Returns the list of model field classes that have a "raw" and non-raw formats.
-     * Normally the "raw" versions are only accessible to those who can edit them.
-     *
-     * @return array an array of EE_Model_Field_Base child classnames
-     */
-    public function fieldsThatHaveRenderedFormat()
-    {
-        return apply_filters(
-            'FHEE__Controller_Model_Read__fields_raw',
-            array('EE_Post_Content_Field', 'EE_Full_HTML_Field')
-        );
-    }
-
-
-
-    /**
-     * If this field one that has a raw format
-     *
-     * @param EE_Model_Field_Base
-     * @return boolean
-     */
-    public function fieldHasRenderedFormat($field_obj)
-    {
-        return $this->isSubclassOfOne($field_obj, $this->fieldsThatHaveRenderedFormat());
-    }
-
-
-
-    /**
-     * Returns the list of model field classes that have a "_pretty" and non-pretty versions.
-     * The pretty version of the field is NOT query-able or editable, but requires no extra permissions
-     * to view
-     *
-     * @return array an array of EE_Model_Field_Base child classnames
-     */
-    public function fieldsThatHavePrettyFormat()
-    {
-        return apply_filters(
-            'FHEE__Controller_Model_Read__fields_pretty',
-            array('EE_Enum_Integer_Field', 'EE_Enum_Text_Field', 'EE_Money_Field')
-        );
-    }
-
-
-
-    /**
-     * If this field one that has a pretty equivalent
-     *
-     * @param EE_Model_Field_Base
-     * @return boolean
-     */
-    public function fieldHasPrettyFormat($field_obj)
-    {
-        return $this->isSubclassOfOne($field_obj, $this->fieldsThatHavePrettyFormat());
-    }
-
-
-
-    /**
-     * Returns an array describing what extra API resource properties have been added through the versions
-     *
-     * @return array @see $this->_extra_resource_properties_for_models
-     */
-    public function resourceChanges()
-    {
-        return $this->resource_changes;
-    }
-
-
-
-    /**
-     * Returns an array where keys are extra resource properties in this version of the API,
-     * and values are key-value pairs describing the new properties. @see Model_Version::_resource_changes
-     *
-     * @param \EEM_Base $model
-     * @return array
-     */
-    public function extraResourcePropertiesForModel($model)
-    {
-        $extra_properties = array();
-        foreach ($this->resourceChangesBetweenRequestedVersionAndCurrent() as $version => $model_classnames) {
-            foreach ($model_classnames as $model_classname => $properties_added_in_this_version) {
-                if (is_subclass_of($model, $model_classname)) {
-                    $extra_properties = array_merge($extra_properties, $properties_added_in_this_version);
-                }
-            }
-        }
-        return $extra_properties;
-    }
-
-
-
-    /**
-     * Gets all the related models for the specified model. It's good to use this
-     * in case this model didn't exist for this version or something
-     *
-     * @param \EEM_Base $model
-     * @return \EE_Model_Relation_Base[]
-     */
-    public function relationSettings(\EEM_Base $model)
-    {
-        $relations = array();
-        foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-            if ($this->isModelNameInThisVersion($relation_name)) {
-                $relations[$relation_name] = $relation_obj;
-            }
-        }
-        //filter the results, but use the old filter name
-        return apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_result__related_models_to_include',
-            $relations,
-            $model
-        );
-    }
+	/**
+	 * Constant used in the $_model_changes array to indicate that a model
+	 * was completely new in this version
+	 */
+	const MODEL_ADDED = 'model_added_in_this_version';
+
+	/**
+	 * Top-level keys are versions (major and minor version numbers, eg "4.6")
+	 * next-level keys are model names (eg "Event") that underwent some change in that version
+	 * and the value is either Model_Version_Info::model_added (indicating the model is completely NEW in this version),
+	 * or it's an array where the values are model field names,
+	 * or API resource properties (ie, non-model fields that appear in REST API results)
+	 * If a version is missing then we don't know anything about what changes it introduced from the previous version
+	 *
+	 * @var array
+	 */
+	protected $model_changes = array();
+
+	/**
+	 * top-level keys are version numbers,
+	 * next-level keys are model CLASSNAMES (even parent classnames),
+	 * and next-level keys are extra resource properties to attach to those models' resources,
+	 * and next-level key-value pairs, where the keys are:
+	 * 'raw', 'type', 'nullable', 'table_alias', 'table_column',  'always_available'
+	 *
+	 * @var array
+	 */
+	protected $resource_changes = array();
+
+	/**
+	 * @var string indicating what version of the API was requested
+	 * (eg although core might be at version 4.8.11, they may have sent a request
+	 * for 4.6)
+	 */
+	protected $requested_version = null;
+
+	/**
+	 * Keys are model names, values are their classnames.
+	 * We cache this so we only need to calculate this once per request
+	 *
+	 * @var array
+	 */
+	protected $cached_models_for_requested_version = null;
+
+	/**
+	 * @var array
+	 */
+	protected $cached_model_changes_between_requested_version_and_current = null;
+
+	/**
+	 * @var array
+	 */
+	protected $cached_resource_changes_between_requested_version_and_current = null;
+
+	/**
+	 * 2d array where top-level keys are model names, 2nd-level keys are field names
+	 * and values are the actual field objects
+	 *
+	 * @var array
+	 */
+	protected $cached_fields_on_models = array();
+
+
+
+	/**
+	 * Model_Version_Info constructor.
+	 *
+	 * @param string $requested_version
+	 */
+	public function __construct($requested_version)
+	{
+		$this->requested_version = (string)$requested_version;
+		$this->model_changes = array(
+			'4.8.29' => array(
+				//first version where the REST API is in EE core, so no need
+				//to specify how its different from the previous
+			),
+		);
+		//setup data for "extra" fields added onto resources which don't actually exist on models
+		$this->resource_changes = apply_filters(
+			'FHEE__Model_Version_Info___construct__extra_resource_properties_for_models',
+			array()
+		);
+		$defaults = array(
+			'raw'              => false,
+			'type'             => 'N/A',
+			'nullable'         => true,
+			'table_alias'      => 'N/A',
+			'table_column'     => 'N/A',
+			'always_available' => true,
+		);
+		foreach ($this->resource_changes as $version => $model_classnames) {
+			foreach ($model_classnames as $model_classname => $extra_fields) {
+				foreach ($extra_fields as $fieldname => $field_data) {
+					$this->resource_changes[$model_classname][$fieldname]['name'] = $fieldname;
+					foreach ($defaults as $attribute => $default_value) {
+						if (! isset($this->resource_changes[$model_classname][$fieldname][$attribute])) {
+							$this->resource_changes[$model_classname][$fieldname][$attribute] = $default_value;
+						}
+					}
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * Returns a slice of Model_Version_Info::model_changes()'s array
+	 * indicating exactly what changes happened between the current core version,
+	 * and the version requested
+	 *
+	 * @return array
+	 */
+	public function modelChangesBetweenRequestedVersionAndCurrent()
+	{
+		if ($this->cached_model_changes_between_requested_version_and_current === null) {
+			$model_changes = array();
+			foreach ($this->modelChanges() as $version => $models_changed_in_version) {
+				if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
+					$model_changes[$version] = $models_changed_in_version;
+				}
+			}
+			$this->cached_model_changes_between_requested_version_and_current = $model_changes;
+		}
+		return $this->cached_model_changes_between_requested_version_and_current;
+	}
+
+
+
+	/**
+	 * Returns a slice of Model_Version_Info::model_changes()'s array
+	 * indicating exactly what changes happened between the current core version,
+	 * and the version requested
+	 *
+	 * @return array
+	 */
+	public function resourceChangesBetweenRequestedVersionAndCurrent()
+	{
+		if ($this->cached_resource_changes_between_requested_version_and_current === null) {
+			$resource_changes = array();
+			foreach ($this->resourceChanges() as $version => $model_classnames) {
+				if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
+					$resource_changes[$version] = $model_classnames;
+				}
+			}
+			$this->cached_resource_changes_between_requested_version_and_current = $resource_changes;
+		}
+		return $this->cached_resource_changes_between_requested_version_and_current;
+	}
+
+
+
+	/**
+	 * If a request was sent to 'wp-json/ee/v4.7/events' this would be '4.7'
+	 *
+	 * @return string like '4.6'
+	 */
+	public function requestedVersion()
+	{
+		return $this->requested_version;
+	}
+
+
+
+	/**
+	 * Returns an array describing how the models have changed in each version of core
+	 * that supports the API (starting at 4.6)
+	 * Top-level keys are versions (major and minor version numbers, eg "4.6")
+	 * next-level keys are model names (eg "Event") that underwent some change in that version
+	 * and the value is either NULL (indicating the model is completely NEW in this version),
+	 * or it's an array where fields are value names.
+	 * If a version is missing then we don't know anything about what changes it introduced from the previous version
+	 *
+	 * @return array
+	 */
+	public function modelChanges()
+	{
+		return $this->model_changes;
+	}
+
+
+
+	/**
+	 * Takes into account the requested version, and the current version, and
+	 * what changed between the two, and tries to return.
+	 * Analogous to EE_Registry::instance()->non_abstract_db_models
+	 *
+	 * @return array keys are model names, values are their classname
+	 */
+	public function modelsForRequestedVersion()
+	{
+		if ($this->cached_models_for_requested_version === null) {
+			$all_models_in_current_version = EE_Registry::instance()->non_abstract_db_models;
+			foreach ($this->modelChangesBetweenRequestedVersionAndCurrent() as $version => $models_changed) {
+				foreach ($models_changed as $model_name => $new_indicator_or_fields_added) {
+					if ($new_indicator_or_fields_added === ModelVersionInfo::MODEL_ADDED) {
+						unset($all_models_in_current_version[$model_name]);
+					}
+				}
+			}
+			$this->cached_models_for_requested_version = apply_filters(
+				'FHEE__EventEspresso_core_libraries_rest_api__models_for_requested_version',
+				$all_models_in_current_version,
+				$this
+			);
+		}
+		return $this->cached_models_for_requested_version;
+	}
+
+
+
+	/**
+	 * Determines if this is a valid model name in the requested version.
+	 * Similar to EE_Registry::instance()->is_model_name(), but takes the requested
+	 * version's models into account
+	 *
+	 * @param string $model_name eg 'Event'
+	 * @return boolean
+	 */
+	public function isModelNameInThisVersion($model_name)
+	{
+		$model_names = $this->modelsForRequestedVersion();
+		if (isset($model_names[$model_name])) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * Wrapper for EE_Registry::instance()->load_model(), but takes the requested
+	 * version's models into account
+	 *
+	 * @param string $model_name
+	 * @return \EEM_Base
+	 * @throws \EE_Error
+	 */
+	public function loadModel($model_name)
+	{
+		if ($this->isModelNameInThisVersion($model_name)) {
+			return EE_Registry::instance()->load_model($model_name);
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					__(
+						'Cannot load model "%1$s" because it does not exist in version %2$s of Event Espresso',
+						'event_espresso'
+					),
+					$model_name,
+					$this->requestedVersion()
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * Gets all the fields that should exist on this model right now
+	 *
+	 * @param \EEM_Base $model
+	 * @return array|\EE_Model_Field_Base[]
+	 */
+	public function fieldsOnModelInThisVersion($model)
+	{
+		if (! isset($this->cached_fields_on_models[$model->get_this_model_name()])) {
+			//get all model changes between the requested version and current core version
+			$changes = $this->modelChangesBetweenRequestedVersionAndCurrent();
+			//fetch all fields currently on this model
+			$current_fields = $model->field_settings();
+			//remove all fields that have been added since
+			foreach ($changes as $version => $changes_in_version) {
+				if (isset($changes_in_version[$model->get_this_model_name()])
+					&& $changes_in_version[$model->get_this_model_name()] !== ModelVersionInfo::MODEL_ADDED
+				) {
+					$current_fields = array_diff_key(
+						$current_fields,
+						array_flip($changes_in_version[$model->get_this_model_name()])
+					);
+				}
+			}
+			$this->cached_fields_on_models = $current_fields;
+		}
+		return $this->cached_fields_on_models;
+	}
+
+
+
+	/**
+	 * Determines if $object is of one of the classes of $classes. Similar to
+	 * in_array(), except this checks if $object is a subclass of the classnames provided
+	 * in $classnames
+	 *
+	 * @param object $object
+	 * @param array  $classnames
+	 * @return boolean
+	 */
+	public function isSubclassOfOne($object, $classnames)
+	{
+		foreach ($classnames as $classname) {
+			if (is_a($object, $classname)) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Returns the list of model field classes that that the API basically ignores
+	 *
+	 * @return array
+	 */
+	public function fieldsIgnored()
+	{
+		return apply_filters(
+			'FHEE__Controller_Model_Read_fields_ignored',
+			array('EE_Foreign_Key_Field_Base', 'EE_Any_Foreign_Model_Name_Field')
+		);
+	}
+
+
+
+	/**
+	 * If this field one that should be ignored by the API?
+	 *
+	 * @param EE_Model_Field_Base
+	 * @return boolean
+	 */
+	public function fieldIsIgnored($field_obj)
+	{
+		return $this->isSubclassOfOne($field_obj, $this->fieldsIgnored());
+	}
+
+
+
+	/**
+	 * Returns the list of model field classes that have a "raw" and non-raw formats.
+	 * Normally the "raw" versions are only accessible to those who can edit them.
+	 *
+	 * @return array an array of EE_Model_Field_Base child classnames
+	 */
+	public function fieldsThatHaveRenderedFormat()
+	{
+		return apply_filters(
+			'FHEE__Controller_Model_Read__fields_raw',
+			array('EE_Post_Content_Field', 'EE_Full_HTML_Field')
+		);
+	}
+
+
+
+	/**
+	 * If this field one that has a raw format
+	 *
+	 * @param EE_Model_Field_Base
+	 * @return boolean
+	 */
+	public function fieldHasRenderedFormat($field_obj)
+	{
+		return $this->isSubclassOfOne($field_obj, $this->fieldsThatHaveRenderedFormat());
+	}
+
+
+
+	/**
+	 * Returns the list of model field classes that have a "_pretty" and non-pretty versions.
+	 * The pretty version of the field is NOT query-able or editable, but requires no extra permissions
+	 * to view
+	 *
+	 * @return array an array of EE_Model_Field_Base child classnames
+	 */
+	public function fieldsThatHavePrettyFormat()
+	{
+		return apply_filters(
+			'FHEE__Controller_Model_Read__fields_pretty',
+			array('EE_Enum_Integer_Field', 'EE_Enum_Text_Field', 'EE_Money_Field')
+		);
+	}
+
+
+
+	/**
+	 * If this field one that has a pretty equivalent
+	 *
+	 * @param EE_Model_Field_Base
+	 * @return boolean
+	 */
+	public function fieldHasPrettyFormat($field_obj)
+	{
+		return $this->isSubclassOfOne($field_obj, $this->fieldsThatHavePrettyFormat());
+	}
+
+
+
+	/**
+	 * Returns an array describing what extra API resource properties have been added through the versions
+	 *
+	 * @return array @see $this->_extra_resource_properties_for_models
+	 */
+	public function resourceChanges()
+	{
+		return $this->resource_changes;
+	}
+
+
+
+	/**
+	 * Returns an array where keys are extra resource properties in this version of the API,
+	 * and values are key-value pairs describing the new properties. @see Model_Version::_resource_changes
+	 *
+	 * @param \EEM_Base $model
+	 * @return array
+	 */
+	public function extraResourcePropertiesForModel($model)
+	{
+		$extra_properties = array();
+		foreach ($this->resourceChangesBetweenRequestedVersionAndCurrent() as $version => $model_classnames) {
+			foreach ($model_classnames as $model_classname => $properties_added_in_this_version) {
+				if (is_subclass_of($model, $model_classname)) {
+					$extra_properties = array_merge($extra_properties, $properties_added_in_this_version);
+				}
+			}
+		}
+		return $extra_properties;
+	}
+
+
+
+	/**
+	 * Gets all the related models for the specified model. It's good to use this
+	 * in case this model didn't exist for this version or something
+	 *
+	 * @param \EEM_Base $model
+	 * @return \EE_Model_Relation_Base[]
+	 */
+	public function relationSettings(\EEM_Base $model)
+	{
+		$relations = array();
+		foreach ($model->relation_settings() as $relation_name => $relation_obj) {
+			if ($this->isModelNameInThisVersion($relation_name)) {
+				$relations[$relation_name] = $relation_obj;
+			}
+		}
+		//filter the results, but use the old filter name
+		return apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_result__related_models_to_include',
+			$relations,
+			$model
+		);
+	}
 }
 
 // End of file Model_Version_Info.php