eventespresso / event-espresso-core

core/db_models/fields/EE_Primary_Key_Int_Field.php

Doc Comments +4 added lines

@@ -4,6 +4,10 @@
 	function get_wpdb_data_type(){
 		return '%d';
 	}
+
+	/**
+	 * @param string $table_column
+	 */
 	public function __construct($table_column, $nicename) {
 		parent::__construct($table_column, $nicename, 0);
 	}

Spacing +4 added lines, -4 removed lines

@@ -1,14 +1,14 @@
 <?php
-require_once( EE_MODELS . 'fields/EE_Primary_Key_Field_Base.php');
-class EE_Primary_Key_Int_Field extends EE_Primary_Key_Field_Base{
-	function get_wpdb_data_type(){
+require_once(EE_MODELS.'fields/EE_Primary_Key_Field_Base.php');
+class EE_Primary_Key_Int_Field extends EE_Primary_Key_Field_Base {
+	function get_wpdb_data_type() {
 		return '%d';
 	}
 	public function __construct($table_column, $nicename) {
 		parent::__construct($table_column, $nicename, 0);
 	}
 	function prepare_for_set($value_inputted_for_field_on_model_object) {
-		if($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)){
+		if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
 			$value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
 		}
 		return absint($value_inputted_for_field_on_model_object);

core/db_models/fields/EE_Primary_Key_String_Field.php

Doc Comments +4 added lines

@@ -4,6 +4,10 @@
 	function get_wpdb_data_type(){
 		return '%s';
 	}
+
+	/**
+	 * @param string $table_column
+	 */
 	public function __construct($table_column, $nicename) {
 		parent::__construct($table_column, $nicename, NULL);
 	}

Spacing +3 added lines, -3 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 require_once('EE_Primary_Key_Field_Base.php');
-class EE_Primary_Key_String_Field extends EE_Primary_Key_Field_Base{
-	function get_wpdb_data_type(){
+class EE_Primary_Key_String_Field extends EE_Primary_Key_Field_Base {
+	function get_wpdb_data_type() {
 		return '%s';
 	}
 	public function __construct($table_column, $nicename) {
@@ -13,7 +13,7 @@ 
 	 * @return string
 	 */
 	function prepare_for_set($value_inputted_for_field_on_model_object) {
-	if($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)){
+	if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
 			$value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
 		}
 		return wp_strip_all_tags($value_inputted_for_field_on_model_object);

core/db_models/fields/EE_WP_Post_Status_Field.php

Doc Comments -1 removed lines

@@ -26,7 +26,6 @@
 	 *   )
 	 * )
 	 * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info
-	 * @param boolean $store_in_db_as_int By default, enums are stored as STRINGS in the DB. However, if this var is set to true, it will be stored as an INT
 	 */
 	function __construct($table_column, $nicename, $nullable, $default_value, $new_stati = array()){
 		$this->_register_new_stati( $new_stati );

Spacing +16 added lines, -16 removed lines

@@ -1,6 +1,6 @@ 
 <?php
-require_once( EE_MODELS . 'fields/EE_Enum_Text_Field.php' );
-class EE_WP_Post_Status_Field extends EE_Enum_Text_Field{
+require_once(EE_MODELS.'fields/EE_Enum_Text_Field.php');
+class EE_WP_Post_Status_Field extends EE_Enum_Text_Field {
 
 	protected $_wp_post_stati;
 
@@ -28,8 +28,8 @@ 
 	 * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info
 	 * @param boolean $store_in_db_as_int By default, enums are stored as STRINGS in the DB. However, if this var is set to true, it will be stored as an INT
 	 */
-	function __construct($table_column, $nicename, $nullable, $default_value, $new_stati = array()){
-		$this->_register_new_stati( $new_stati );
+	function __construct($table_column, $nicename, $nullable, $default_value, $new_stati = array()) {
+		$this->_register_new_stati($new_stati);
 		$this->_set_allowed_enum_values();
 		parent::__construct($table_column, $nicename, $nullable, $default_value, $this->_allowed_enum_values);
 	}
@@ -46,18 +46,18 @@ 
 	 * @param  array $new_stati statuses
 	 * @return void
 	 */
-	protected function _register_new_stati( $new_stati ) {
+	protected function _register_new_stati($new_stati) {
 
-		foreach ( (array) $new_stati as $status_key => $status_args ) {
+		foreach ((array) $new_stati as $status_key => $status_args) {
 			$args = array(
-				'label' => isset( $status_args['label'] ) ? $status_args['label'] : $status_key,
-				'public' => isset( $status_args['public'] ) && is_bool( $status_args['public'] ) ? $status_args['public'] : TRUE,
-				'exclude_from_search' => isset( $status_args['exclude_from_search'] ) && is_bool($status_args['exclude_from_search'] ) ? $status_args['exclude_from_search'] : FALSE,
-				'show_in_admin_all_list' => isset( $status_args['show_in_admin_all_list'] ) && is_bool( $status_args['show_in_admin_all_list'] ) ? $status_args['show_in_admin_all_list'] : FALSE,
-				'show_in_admin_status_list' =>  isset( $status_args['show_in_admin_status_list'] ) && is_bool( $status_args['show_in_admin_status_list'] ) ? $status_args['show_in_admin_status_list'] : TRUE,
-				'label_count' => isset( $status_args['label_count'] ) ? $status_args['label_count'] : ''
+				'label' => isset($status_args['label']) ? $status_args['label'] : $status_key,
+				'public' => isset($status_args['public']) && is_bool($status_args['public']) ? $status_args['public'] : TRUE,
+				'exclude_from_search' => isset($status_args['exclude_from_search']) && is_bool($status_args['exclude_from_search']) ? $status_args['exclude_from_search'] : FALSE,
+				'show_in_admin_all_list' => isset($status_args['show_in_admin_all_list']) && is_bool($status_args['show_in_admin_all_list']) ? $status_args['show_in_admin_all_list'] : FALSE,
+				'show_in_admin_status_list' =>  isset($status_args['show_in_admin_status_list']) && is_bool($status_args['show_in_admin_status_list']) ? $status_args['show_in_admin_status_list'] : TRUE,
+				'label_count' => isset($status_args['label_count']) ? $status_args['label_count'] : ''
 				);
-			register_post_status( $status_key, $status_args );
+			register_post_status($status_key, $status_args);
 		}
 
 	}
@@ -78,7 +78,7 @@ 
 		global $wp_post_statuses;
 		$this->_wp_post_stati = $wp_post_statuses;
 
-		foreach( $this->_wp_post_stati  as $post_status => $args_object ) {
+		foreach ($this->_wp_post_stati  as $post_status => $args_object) {
 			$this->_allowed_enum_values[$post_status] = $args_object->label;
 		}
 
@@ -108,7 +108,7 @@ 
 	 * @param  string $status What status object you want
 	 * @return std_object         the status object or FALSE if it doesn't exist.
 	 */
-	public function get_status_object( $status ) {
-		return isset( $this->_wp_post_stati[$status] ) ? $this->_wp_post_stati[$status] : FALSE;
+	public function get_status_object($status) {
+		return isset($this->_wp_post_stati[$status]) ? $this->_wp_post_stati[$status] : FALSE;
 	}
 }
\ No newline at end of file

core/db_models/helpers/EE_Model_Query_Info_Carrier.php

Doc Comments +14 added lines, -1 removed lines

@@ -43,16 +43,30 @@ 
    
    private $_group_by_sql;
    
+   /**
+    * @param string $limit_sql
+    */
    function set_limit_sql($limit_sql){
 	   $this->_limit_sql = $limit_sql;
 	}
 	
+	/**
+	 * @param string $order_by_sql
+	 */
 	function set_order_by_sql($order_by_sql){
 		$this->_order_by_sql = $order_by_sql;
 	}
+
+	/**
+	 * @param string $group_by_sql
+	 */
 	function set_group_by_sql($group_by_sql){
 		$this->_group_by_sql = $group_by_sql;
 	}
+
+	/**
+	 * @param string $having_sql
+	 */
 	function set_having_sql($having_sql){
 		$this->_having_sql = $having_sql;
 	}
@@ -72,7 +86,6 @@ 
     * 
     * @param type $model_included_name
     * @param type $join_sql
-    * @param type $data_types
     */
    public function __construct($model_included_name= array(), $join_sql = ''){
 	   $this->_models_included = $model_included_name;

Indentation +3 added lines, -3 removed lines

@@ -11,8 +11,8 @@ 
 */
 class EE_Model_Query_Info_Carrier extends EE_Base{
    /**
-	* @var string SQL for performing joins (Eg, "INNER JOIN blah ON blah=blah INNER JOIN FOO ON foo=foo...")
-	*/
+    * @var string SQL for performing joins (Eg, "INNER JOIN blah ON blah=blah INNER JOIN FOO ON foo=foo...")
+    */
    private $_join_sql;
    /**
     *
@@ -132,7 +132,7 @@ 
     * @return string
     */
   public function get_main_model_join_sql() {
-    return $this->_main_join_sql;
+	return $this->_main_join_sql;
   }
 
 

Spacing +23 added lines, -23 removed lines

@@ -9,7 +9,7 @@ 
 * We could have returned an array
 * with two keys 'join_sql' and 'data_types', but this better-defines the data being passed around
 */
-class EE_Model_Query_Info_Carrier extends EE_Base{
+class EE_Model_Query_Info_Carrier extends EE_Base {
    /**
 	* @var string SQL for performing joins (Eg, "INNER JOIN blah ON blah=blah INNER JOIN FOO ON foo=foo...")
 	*/
@@ -43,29 +43,29 @@ 
    
    private $_group_by_sql;
    
-   function set_limit_sql($limit_sql){
+   function set_limit_sql($limit_sql) {
 	   $this->_limit_sql = $limit_sql;
 	}
 	
-	function set_order_by_sql($order_by_sql){
+	function set_order_by_sql($order_by_sql) {
 		$this->_order_by_sql = $order_by_sql;
 	}
-	function set_group_by_sql($group_by_sql){
+	function set_group_by_sql($group_by_sql) {
 		$this->_group_by_sql = $group_by_sql;
 	}
-	function set_having_sql($having_sql){
+	function set_having_sql($having_sql) {
 		$this->_having_sql = $having_sql;
 	}
-	function get_limit_sql(){
+	function get_limit_sql() {
 		return $this->_limit_sql;
 	}
-	function get_order_by_sql(){
+	function get_order_by_sql() {
 		return $this->_order_by_sql;
 	}
-	function get_group_by_sql(){
+	function get_group_by_sql() {
 		return $this->_group_by_sql;
 	}
-	function get_having_sql(){
+	function get_having_sql() {
 		return $this->_having_sql;
 	}
    /**
@@ -74,7 +74,7 @@ 
     * @param type $join_sql
     * @param type $data_types
     */
-   public function __construct($model_included_name= array(), $join_sql = ''){
+   public function __construct($model_included_name = array(), $join_sql = '') {
 	   $this->_models_included = $model_included_name;
 	   $this->_join_sql = $join_sql;
    }
@@ -83,10 +83,10 @@ 
     * Merges info from the other EEM_Related_Model_Info_Carrier into this one.
     * @param EE_Model_Query_Info_Carrier $other_model_query_info_carrier
     */
-   public function merge( $other_model_query_info_carrier ){
-	   if( $other_model_query_info_carrier && ! $this->_have_already_included_one_of_these_models($other_model_query_info_carrier->get_model_names_included())){
-			$model_included_on_other_join_sql_and_data_types_carrier =  $other_model_query_info_carrier->get_model_names_included();
-			$this->_models_included = array_merge( $this->_models_included, $model_included_on_other_join_sql_and_data_types_carrier );
+   public function merge($other_model_query_info_carrier) {
+	   if ($other_model_query_info_carrier && ! $this->_have_already_included_one_of_these_models($other_model_query_info_carrier->get_model_names_included())) {
+			$model_included_on_other_join_sql_and_data_types_carrier = $other_model_query_info_carrier->get_model_names_included();
+			$this->_models_included = array_merge($this->_models_included, $model_included_on_other_join_sql_and_data_types_carrier);
 			$this->_join_sql .= $other_model_query_info_carrier->_join_sql;
 	   }
 	   //otherwise don't merge our data.
@@ -100,9 +100,9 @@ 
     * @param array $model_names just like EE_MOdel_QUery_Info_Carrier::_models_included: keys are model chain paths, values are the model names only
     * @return boolean
     */
-   protected function  _have_already_included_one_of_these_models($model_names){
-	   foreach($this->_models_included as $model_relation_path=>$model_included){
-		   if(array_key_exists($model_relation_path, $model_names)){
+   protected function  _have_already_included_one_of_these_models($model_names) {
+	   foreach ($this->_models_included as $model_relation_path=>$model_included) {
+		   if (array_key_exists($model_relation_path, $model_names)) {
 			   return true;
 		   }
 	   }
@@ -112,17 +112,17 @@ 
     * Array keys are model names, values are "model relation paths". See EE_Model_Query_Info_Carrier::_models_included for details
     * @return array like EE_Model_Query_Info_Carrier::_models_included
     */
-   public function get_model_names_included(){
+   public function get_model_names_included() {
 	   return $this->_models_included;
    }
    /**
     * sets the $where_sql for later use from client code
     * @param string $where_sql
     */
-   public function set_where_sql($where_sql){
+   public function set_where_sql($where_sql) {
 	   $this->_where_sql = $where_sql;
    }
-   public function get_where_sql(){
+   public function get_where_sql() {
 	   return $this->_where_sql;
    }
 
@@ -143,10 +143,10 @@ 
     * after the FROM and before the WHERE.)
     * @param string $join_sql
     */
-   public function set_main_model_join_sql($join_sql){
+   public function set_main_model_join_sql($join_sql) {
 	   $this->_main_join_sql = $join_sql;
    }
-   public function get_full_join_sql(){
-	   return $this->_main_join_sql . $this->_join_sql;
+   public function get_full_join_sql() {
+	   return $this->_main_join_sql.$this->_join_sql;
    }
 }
\ No newline at end of file

core/db_models/helpers/EE_Secondary_Table.php

Doc Comments +2 added lines, -1 removed lines

@@ -49,7 +49,7 @@ 
 	 * creates join statement FROM primary table
 	 * gets SQL like "LEFT JOIN table_name AS table_alias ON other_table_alias.pk = table_alias.fk
 	 *
-	 * @param string $table allows us to set special conditions on the $table_name portion of the join query (i.e. doing a subquery)
+	 * @param string $primary_table_alias_with_model_chain_prefix
 	 * @return string of SQL
 	 */
 	function get_join_sql( $primary_table_alias_with_model_chain_prefix  ){
@@ -72,6 +72,7 @@ 
 	 * " LEFT JOIN secondary_table_table AS Secondary ON ..." like get_join_sql, this function returns
 	 * " LEFT JOIN primary_table AS Primary ON ...".
 	 * This is useful if the secondary table is already included in the SQL, but the primary table is not yet.
+	 * @param string $secondary_table_alias_with_model_chain_prefix
 	 * @return string
 	 */
 	function get_inverse_join_sql($secondary_table_alias_with_model_chain_prefix){

Spacing +21 added lines, -21 removed lines

@@ -5,8 +5,8 @@ 
  * table's rows. Ie, it can't have many rows in the secondary table that point to
  * a single row in the primary table
  */
-require_once( EE_MODELS . 'helpers/EE_Table_Base.php');
-class EE_Secondary_Table extends EE_Table_Base{
+require_once(EE_MODELS.'helpers/EE_Table_Base.php');
+class EE_Secondary_Table extends EE_Table_Base {
 	protected $_extra_join_conditions;
 
 	/**
@@ -19,15 +19,15 @@ 
 	 * @param boolean $global whether the table is "global" as in there is only 1 table on an entire multisite install,
 	 *					or whether each site on a multisite install has a copy of this table
 	 */
-	function __construct($table_name, $pk_column,  $fk_column = null, $extra_join_conditions = null, $global = false ){
+	function __construct($table_name, $pk_column, $fk_column = null, $extra_join_conditions = null, $global = false) {
 		$this->_fk_on_table = $fk_column;
 		$this->_extra_join_conditions = $extra_join_conditions;
-		parent::__construct( $table_name, $pk_column, $global );
+		parent::__construct($table_name, $pk_column, $global);
 	}
-	function get_fk_on_table(){
+	function get_fk_on_table() {
 		return $this->_fk_on_table;
 	}
-	function _construct_finalize_set_table_to_join_with(EE_Table_Base $table){
+	function _construct_finalize_set_table_to_join_with(EE_Table_Base $table) {
 		$this->_table_to_join_with = $table;
 	}
 	/**
@@ -35,14 +35,14 @@ 
 	 * @return string of sql like "Event.post_type = 'event'", which gets added to
 	 * the end of the join statement with the primary table
 	 */
-	function get_extra_join_conditions(){
+	function get_extra_join_conditions() {
 		return $this->_extra_join_conditions;
 	}
 	/**
 	 *
 	 * @return EE_Primary_Table
 	 */
-	function get_table_to_join_with(){
+	function get_table_to_join_with() {
 		return $this->_table_to_join_with;
 	}
 	/**
@@ -52,15 +52,15 @@ 
 	 * @param string $table allows us to set special conditions on the $table_name portion of the join query (i.e. doing a subquery)
 	 * @return string of SQL
 	 */
-	function get_join_sql( $primary_table_alias_with_model_chain_prefix  ){
+	function get_join_sql($primary_table_alias_with_model_chain_prefix) {
 
 		$table_name = $this->get_table_name();
-		$secondary_table_alias = EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix($primary_table_alias_with_model_chain_prefix) . $this->get_table_alias();
+		$secondary_table_alias = EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix($primary_table_alias_with_model_chain_prefix).$this->get_table_alias();
 		$other_table_pk = $this->get_table_to_join_with()->get_pk_column();
 		$fk = $this->get_fk_on_table();
 		$join_sql = " LEFT JOIN $table_name AS $secondary_table_alias ON $primary_table_alias_with_model_chain_prefix.$other_table_pk = $secondary_table_alias.$fk ";
-		if($this->get_extra_join_conditions()){
-			$join_sql.="AND ".$this->get_extra_join_conditions();
+		if ($this->get_extra_join_conditions()) {
+			$join_sql .= "AND ".$this->get_extra_join_conditions();
 		}
 		return $join_sql;
 	}
@@ -74,14 +74,14 @@ 
 	 * This is useful if the secondary table is already included in the SQL, but the primary table is not yet.
 	 * @return string
 	 */
-	function get_inverse_join_sql($secondary_table_alias_with_model_chain_prefix){
-		$primary_table_name =$this->get_table_to_join_with()->get_table_name();
-		$primary_table_alias = EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix($secondary_table_alias_with_model_chain_prefix) . $this->get_table_to_join_with()->get_table_alias();
-		$primary_table_pk = $this->get_table_to_join_with()->get_pk_column();//$this->get_pk_column();
+	function get_inverse_join_sql($secondary_table_alias_with_model_chain_prefix) {
+		$primary_table_name = $this->get_table_to_join_with()->get_table_name();
+		$primary_table_alias = EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix($secondary_table_alias_with_model_chain_prefix).$this->get_table_to_join_with()->get_table_alias();
+		$primary_table_pk = $this->get_table_to_join_with()->get_pk_column(); //$this->get_pk_column();
 		$fk = $this->get_fk_on_table();
 		$join_sql = " LEFT JOIN $primary_table_name AS $primary_table_alias ON $primary_table_alias.$primary_table_pk = $secondary_table_alias_with_model_chain_prefix.$fk ";
-		if($this->get_extra_join_conditions()){
-			$join_sql.="AND ".$this->get_extra_join_conditions();
+		if ($this->get_extra_join_conditions()) {
+			$join_sql .= "AND ".$this->get_extra_join_conditions();
 		}
 		return $join_sql;
 	}
@@ -94,7 +94,7 @@ 
 	public function get_select_join_limit_join($limit) {
 		//first get the select
 		$select = $this->get_select_join_limit($limit);
-		$join_sql = $this->get_join_sql( $select );
+		$join_sql = $this->get_join_sql($select);
 		return $join_sql;
 	}
 
@@ -103,12 +103,12 @@ 
 	function get_fully_qualified_fk_column() {
 		$table_alias = $this->get_table_alias();
 		$fk = $this->get_fk_on_table();
-		return $table_alias . '.' . $fk;
+		return $table_alias.'.'.$fk;
 	}
 
 	function get_fully_qualified_pk_on_fk_table() {
 		$table_alias = $this->get_table_to_join_with()->get_table_alias();
 		$pk = $this->get_table_to_join_with()->get_pk_column();
-		return $table_alias . '.' . $pk;
+		return $table_alias.'.'.$pk;
 	}
 }
\ No newline at end of file

core/db_models/relations/EE_HABTM_Relation.php

Doc Comments +2 added lines, -1 removed lines

@@ -17,6 +17,7 @@ 
 	 * get related models across the relation, and add-and-remove the relationships.
 	 * @param boolean $block_deletes for this type of relation, we block by default for now. if there are related models across this relation, block (prevent and add an error) the deletion of this model
 	 * @param type $blocking_delete_error_message a customized error message on blocking deletes instead of the default
+	 * @param string $joining_model_name
 	 */
 	function __construct($joining_model_name,$block_deletes = true, $blocking_delete_error_message =''){
 		$this->_joining_model_name = $joining_model_name;
@@ -24,7 +25,7 @@ 
 	}
 	/**
 	 * Gets the joining model's object
-	 * @return EEM_Base
+	 * @return boolean
 	 */
 	function get_join_model(){
 		return $this->_get_model($this->_joining_model_name);

Spacing +30 added lines, -30 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 
-require_once( EE_MODELS . 'relations/EE_Model_Relation_Base.php');
-class EE_HABTM_Relation extends EE_Model_Relation_Base{
+require_once(EE_MODELS.'relations/EE_Model_Relation_Base.php');
+class EE_HABTM_Relation extends EE_Model_Relation_Base {
 	/**
 	 * Model whicih defines the relation between two other models. Eg, the EE_Event_Question_Group model,
 	 * which joins EE_Event and EE_Question_Group
@@ -18,7 +18,7 @@ 
 	 * @param boolean $block_deletes for this type of relation, we block by default for now. if there are related models across this relation, block (prevent and add an error) the deletion of this model
 	 * @param type $blocking_delete_error_message a customized error message on blocking deletes instead of the default
 	 */
-	function __construct($joining_model_name,$block_deletes = true, $blocking_delete_error_message =''){
+	function __construct($joining_model_name, $block_deletes = true, $blocking_delete_error_message = '') {
 		$this->_joining_model_name = $joining_model_name;
 		parent::__construct($block_deletes, $blocking_delete_error_message);
 	}
@@ -26,7 +26,7 @@ 
 	 * Gets the joining model's object
 	 * @return EEM_Base
 	 */
-	function get_join_model(){
+	function get_join_model() {
 		return $this->_get_model($this->_joining_model_name);
 	}
 	/**
@@ -34,21 +34,21 @@ 
 	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
 	 * @return string of SQL
 	 */
-	function get_join_to_intermediate_model_statement($model_relation_chain){
+	function get_join_to_intermediate_model_statement($model_relation_chain) {
 		//create sql like
 		//LEFT JOIN join_table AS join_table_alias ON this_table_alias.this_table_pk = join_table_alias.join_table_fk_to_this
 		//LEFT JOIN other_table AS other_table_alias ON join_table_alias.join_table_fk_to_other = other_table_alias.other_table_pk
 		//remember the model relation chain to the JOIN model, because we'll
 		//need it for get_join_statement()
 		$this->_model_relation_chain_to_join_model = $model_relation_chain;
-		$this_table_pk_field = $this->get_this_model()->get_primary_key_field();//get_foreign_key_to($this->get_other_model()->get_this_model_name());
+		$this_table_pk_field = $this->get_this_model()->get_primary_key_field(); //get_foreign_key_to($this->get_other_model()->get_this_model_name());
 		$join_table_fk_field_to_this_table = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-		$this_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this->get_this_model()->get_this_model_name()) . $this_table_pk_field->get_table_alias();
+		$this_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this->get_this_model()->get_this_model_name()).$this_table_pk_field->get_table_alias();
 
-		$join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this->get_join_model()->get_this_model_name()) . $join_table_fk_field_to_this_table->get_table_alias();
+		$join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this->get_join_model()->get_this_model_name()).$join_table_fk_field_to_this_table->get_table_alias();
 		$join_table = $this->get_join_model()->get_table_for_alias($join_table_alias);
 		//phew! ok, we have all the info we need, now we can create the SQL join string
-		$SQL = $this->_left_join($join_table, $join_table_alias, $join_table_fk_field_to_this_table->get_table_column(), $this_table_alias, $this_table_pk_field->get_table_column()) . $this->get_join_model()->_construct_internal_join_to_table_with_alias($join_table_alias);
+		$SQL = $this->_left_join($join_table, $join_table_alias, $join_table_fk_field_to_this_table->get_table_column(), $this_table_alias, $this_table_pk_field->get_table_column()).$this->get_join_model()->_construct_internal_join_to_table_with_alias($join_table_alias);
 
 		return $SQL;
 	}
@@ -60,18 +60,18 @@ 
 	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
 	 * @return string of SQL
 	 */
-	function get_join_statement($model_relation_chain){
-		if( $this->_model_relation_chain_to_join_model === NULL ){
-			throw new EE_Error( sprintf( __( 'When using EE_HABTM_Relation to create a join, you must call get_join_to_intermediate_model_statement BEFORE get_join_statement', 'event_espresso' )));
+	function get_join_statement($model_relation_chain) {
+		if ($this->_model_relation_chain_to_join_model === NULL) {
+			throw new EE_Error(sprintf(__('When using EE_HABTM_Relation to create a join, you must call get_join_to_intermediate_model_statement BEFORE get_join_statement', 'event_espresso')));
 		}
 		$join_table_fk_field_to_this_table = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-		$join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($this->_model_relation_chain_to_join_model, $this->get_join_model()->get_this_model_name()) . $join_table_fk_field_to_this_table->get_table_alias();
+		$join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($this->_model_relation_chain_to_join_model, $this->get_join_model()->get_this_model_name()).$join_table_fk_field_to_this_table->get_table_alias();
 		$other_table_pk_field = $this->get_other_model()->get_primary_key_field();
 		$join_table_fk_field_to_other_table = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
-		$other_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this->get_other_model()->get_this_model_name()) . $other_table_pk_field->get_table_alias();
+		$other_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this->get_other_model()->get_this_model_name()).$other_table_pk_field->get_table_alias();
 		$other_table = $this->get_other_model()->get_table_for_alias($other_table_alias);
 
-		$SQL = $this->_left_join($other_table, $other_table_alias, $other_table_pk_field->get_table_column(), $join_table_alias, $join_table_fk_field_to_other_table->get_table_column()) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
+		$SQL = $this->_left_join($other_table, $other_table_alias, $other_table_pk_field->get_table_column(), $join_table_alias, $join_table_fk_field_to_other_table->get_table_column()).$this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
 		return $SQL;
 	}
 
@@ -84,36 +84,36 @@ 
 	 * @param array             $where_query col=>val pairs that are used as extra conditions for checking existing values and for setting new rows if no exact matches.
 	 * @return EE_Base_Class
 	 */
-	 function add_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array() ){
+	 function add_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array()) {
 		 $this_model_obj = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
 		 $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
 		//check if such a relationship already exists
 		 $join_model_fk_to_this_model = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
 		 $join_model_fk_to_other_model = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
 
-		 $cols_n_values =  array(
+		 $cols_n_values = array(
 				 $join_model_fk_to_this_model->get_name() => $this_model_obj->ID(),
 				 $join_model_fk_to_other_model->get_name() => $other_model_obj->ID());
 
 		 //if $where_query exists lets add them to the query_params.
-		 if ( !empty( $where_query ) ) {
+		 if ( ! empty($where_query)) {
 		 	//make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
 		 	//make sure we strip THIS models name from the query param
-		 	foreach ( $where_query as $query_param => $val ) {
-				$query_param = str_replace($this->get_join_model()->get_this_model_name().".","", $query_param);
+		 	foreach ($where_query as $query_param => $val) {
+				$query_param = str_replace($this->get_join_model()->get_this_model_name().".", "", $query_param);
 				$parsed_query[$query_param] = $val;
 			}
-		 	$cols_n_values = array_merge( $cols_n_values, $parsed_query );
+		 	$cols_n_values = array_merge($cols_n_values, $parsed_query);
 		 }
 
-		 $query_params = array( $cols_n_values );
+		 $query_params = array($cols_n_values);
 
 
 		 $existing_entry_in_join_table = $this->get_join_model()->get_one($query_params);
 		//if there is already an entry in the join table, indicating a relationship, we're done
 		 //again, if you want more sophisticated logic or insertions (handling more columns than just 2 foreign keys to
 		 //the other tables, use the joining model directly!
-		 if( ! $existing_entry_in_join_table ){
+		 if ( ! $existing_entry_in_join_table) {
 			$this->get_join_model()->insert($cols_n_values);
 		}
 		return $other_model_obj;
@@ -125,29 +125,29 @@ 
 	 * * @param array           $where_query col=>val pairs that are used as extra conditions for checking existing values and for removing existing rows if exact matches exist.
 	 * @return EE_Base_Class
 	 */
-	 function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array() ){
+	 function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array()) {
 		  $this_model_obj = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
 		 $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
 		//check if such a relationship already exists
 		 $join_model_fk_to_this_model = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
 		 $join_model_fk_to_other_model = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name());
 
-		 $cols_n_values =  array(
+		 $cols_n_values = array(
 				 $join_model_fk_to_this_model->get_name() => $this_model_obj->ID(),
 				 $join_model_fk_to_other_model->get_name() => $other_model_obj->ID());
 
 		//if $where_query exists lets add them to the query_params.
-		 if ( !empty( $where_query ) ) {
+		 if ( ! empty($where_query)) {
 		 	//make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
 		 	//make sure we strip THIS models name from the query param
-		 	foreach ( $where_query as $query_param => $val ) {
-				$query_param = str_replace($this->get_join_model()->get_this_model_name().".","", $query_param);
+		 	foreach ($where_query as $query_param => $val) {
+				$query_param = str_replace($this->get_join_model()->get_this_model_name().".", "", $query_param);
 				$parsed_query[$query_param] = $val;
 			}
-		 	$cols_n_values = array_merge( $cols_n_values, $parsed_query );
+		 	$cols_n_values = array_merge($cols_n_values, $parsed_query);
 		 }
 
-		 $existing_entry_in_join_table = $this->get_join_model()->delete( array($cols_n_values) );
+		 $existing_entry_in_join_table = $this->get_join_model()->delete(array($cols_n_values));
 		return $other_model_obj;
 	 }
 }

core/db_models/relations/EE_Model_Relation_Base.php

Doc Comments +8 added lines, -8 removed lines

@@ -50,7 +50,7 @@ 
 
 
 	/**
-	 * @param $this_model_name
+	 * @param string $this_model_name
 	 * @param $other_model_name
 	 * @throws EE_Error
 	 */
@@ -67,7 +67,7 @@ 
 
 	/**
 	 * Gets the model where this relation is defined.
-	 * @return EEM_Base
+	 * @return boolean
 	 */
 	function get_this_model(){
 		return $this->_get_model($this->_this_model_name);
@@ -78,7 +78,7 @@ 
 	/**
 	 * Gets the model which this relation establishes the relation TO (ie,
 	 * this relation object was defined on get_this_model(), get_other_model() is the other one)
-	 * @return EEM_Base
+	 * @return boolean
 	 */
 	function get_other_model(){
 		return $this->_get_model($this->_other_model_name);
@@ -89,7 +89,7 @@ 
 	/**
 	 * Internally used by get_this_model() and get_other_model()
 	 * @param string $model_name like Event, Question_Group, etc. omit the EEM_
-	 * @return EEM_Base
+	 * @return boolean
 	 */
 	protected function _get_model($model_name){
 		$modelInstance = EE_Registry::instance()->load_model( $model_name );
@@ -112,9 +112,9 @@ 
 
 	/**
 	 * @param        $other_table
-	 * @param        $other_table_alias
+	 * @param        string $other_table_alias
 	 * @param        $other_table_column
-	 * @param        $this_table_alias
+	 * @param        string $this_table_alias
 	 * @param        $this_table_join_column
 	 * @param string $extra_join_sql
 	 * @return string
@@ -168,7 +168,7 @@ 
 	 * parameters are specified, then all related model objects will be deleted.
 	 * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
 	 * model objects will only be soft-deleted.
-	 * @param EE_Base_Class|int|string $model_object_or_id
+	 * @param EE_Base_Class $model_object_or_id
 	 * @param array $query_params
 	 * @return int of how many related models got deleted
 	 */
@@ -196,7 +196,7 @@ 
 	 * parameters are specified, then all related model objects will be deleted.
 	 * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
 	 * model objects will only be soft-deleted.
-	 * @param EE_Base_Class|int|string $model_object_or_id
+	 * @param EE_Base_Class $model_object_or_id
 	 * @param array $query_params
 	 * @return int of how many related models got deleted
 	 */

Braces +7 added lines, -6 removed lines

@@ -104,8 +104,9 @@ 
 	 * @param string $timezone timezone to set.
 	 */
 	public function set_timezone( $timezone ) {
-		if($timezone !== NULL)
-			$this->_timezone = $timezone;
+		if($timezone !== NULL) {
+					$this->_timezone = $timezone;
+		}
 	}
 
 
@@ -213,12 +214,12 @@ 
 				$deleted_count++;
 				if( ! $delete_is_blocked ){
 					$related_model_object->delete_permanently();
-				}else{
+				} else{
 					//delete is blocked
 					//brent and darren, in this case, wanted to just soft delete it then
 					$related_model_object->delete();
 				}
-			}else{
+			} else{
 				//its not a soft-deletable thing anyways. do the normal logic.
 				if( ! $delete_is_blocked ){
 					$this->remove_relation_to($model_object_or_id, $related_model_object);
@@ -241,7 +242,7 @@ 
 	protected function _get_model_object_id($model_object_or_id) {
 		if($model_object_or_id instanceof EE_Base_Class){
 			$model_object_id = $model_object_or_id->ID();
-		}else{
+		} else{
 			$model_object_id = $model_object_or_id;
 		}
 		if( ! $model_object_id){
@@ -316,7 +317,7 @@ 
 	public function get_deletion_error_message(){
 		if($this->_blocking_delete_error_message){
 			return $this->_blocking_delete_error_message;
-		}else{
+		} else{
 //			return sprintf(__('Cannot delete %1$s when there are related %2$s', "event_espresso"),$this->get_this_model()->item_name(2),$this->get_other_model()->item_name(2));
 			return sprintf(
 				__( 'This %1$s is currently linked to one or more %2$s records. If this %1$s is incorrect, then please remove it from all %3$s before attempting to delete it.', "event_espresso"),

Spacing +44 added lines, -44 removed lines

@@ -7,7 +7,7 @@ 
  * Once those two models are setup correctly, and the relation object has the names of each, it can
  * magically figure out what tables must be joined on what fields during querying.
  */
-abstract class EE_Model_Relation_Base{
+abstract class EE_Model_Relation_Base {
 	/**
 	 * The model name of which this relation is a component (ie, the model that called new EE_Model_Relation_Base)
 	 * @var string eg Event, Question_Group, Registration
@@ -42,9 +42,9 @@ 
 	 * @param boolean $block_deletes if there are related models across this relation, block (prevent and add an error) the deletion of this model
 	 * @param string $blocking_delete_error_message a customized error message on blocking deletes instead of the default
 	 */
-	function __construct($block_deletes, $blocking_delete_error_message){
+	function __construct($block_deletes, $blocking_delete_error_message) {
 		$this->_blocking_delete = $block_deletes;
-		$this->_blocking_delete_error_message=$blocking_delete_error_message;
+		$this->_blocking_delete_error_message = $blocking_delete_error_message;
 	}
 
 
@@ -54,12 +54,12 @@ 
 	 * @param $other_model_name
 	 * @throws EE_Error
 	 */
-	function _construct_finalize_set_models($this_model_name, $other_model_name){
+	function _construct_finalize_set_models($this_model_name, $other_model_name) {
 		$this->_this_model_name = $this_model_name;
 		$this->_other_model_name = $other_model_name;
-		if(is_string($this->_blocking_delete)){
+		if (is_string($this->_blocking_delete)) {
 			throw new EE_Error(sprintf(__("When instantiating the relation of type %s from %s to %s, the \$block_deletes argument should be a boolean, not a string (%s)", "event_espresso"),
-						get_class($this),$this_model_name,$other_model_name,$this->_blocking_delete));
+						get_class($this), $this_model_name, $other_model_name, $this->_blocking_delete));
 		}
 	}
 
@@ -69,7 +69,7 @@ 
 	 * Gets the model where this relation is defined.
 	 * @return EEM_Base
 	 */
-	function get_this_model(){
+	function get_this_model() {
 		return $this->_get_model($this->_this_model_name);
 	}
 
@@ -80,7 +80,7 @@ 
 	 * this relation object was defined on get_this_model(), get_other_model() is the other one)
 	 * @return EEM_Base
 	 */
-	function get_other_model(){
+	function get_other_model() {
 		return $this->_get_model($this->_other_model_name);
 	}
 
@@ -91,9 +91,9 @@ 
 	 * @param string $model_name like Event, Question_Group, etc. omit the EEM_
 	 * @return EEM_Base
 	 */
-	protected function _get_model($model_name){
-		$modelInstance = EE_Registry::instance()->load_model( $model_name );
-		$modelInstance->set_timezone( $this->_timezone );
+	protected function _get_model($model_name) {
+		$modelInstance = EE_Registry::instance()->load_model($model_name);
+		$modelInstance->set_timezone($this->_timezone);
 		return $modelInstance;
 	}
 
@@ -103,8 +103,8 @@ 
 	 * entirely possible that relations may be called from a model and we need to make sure those relations have their timezone set correctly.
 	 * @param string $timezone timezone to set.
 	 */
-	public function set_timezone( $timezone ) {
-		if($timezone !== NULL)
+	public function set_timezone($timezone) {
+		if ($timezone !== NULL)
 			$this->_timezone = $timezone;
 	}
 
@@ -119,8 +119,8 @@ 
 	 * @param string $extra_join_sql
 	 * @return string
 	 */
-	protected function _left_join($other_table,$other_table_alias,$other_table_column,$this_table_alias,$this_table_join_column, $extra_join_sql = ''){
-		return " LEFT JOIN ".$other_table." AS ".$other_table_alias. " ON ".$other_table_alias.".".$other_table_column."=".$this_table_alias.".".$this_table_join_column. ($extra_join_sql ? " AND $extra_join_sql" : '');
+	protected function _left_join($other_table, $other_table_alias, $other_table_column, $this_table_alias, $this_table_join_column, $extra_join_sql = '') {
+		return " LEFT JOIN ".$other_table." AS ".$other_table_alias." ON ".$other_table_alias.".".$other_table_column."=".$this_table_alias.".".$this_table_join_column.($extra_join_sql ? " AND $extra_join_sql" : '');
 	}
 
 
@@ -136,10 +136,10 @@ 
 	 * @param boolean $values_already_prepared_by_model_object
 	 * @return EE_Base_Class[]
 	 */
-	public function get_all_related($model_object_or_id, $query_params = array(), $values_already_prepared_by_model_object = false){
+	public function get_all_related($model_object_or_id, $query_params = array(), $values_already_prepared_by_model_object = false) {
 		$query_params = $this->_disable_default_where_conditions_on_query_param($query_params);
 		$query_param_where_this_model_pk = $this->get_this_model()->get_this_model_name().".".$this->get_this_model()->get_primary_key_field()->get_name();
-		$model_object_id = $this->_get_model_object_id( $model_object_or_id );
+		$model_object_id = $this->_get_model_object_id($model_object_or_id);
 		$query_params[0][$query_param_where_this_model_pk] = $model_object_id;
 		return $this->get_other_model()->get_all($query_params);
 	}
@@ -151,9 +151,9 @@ 
 	 * @param string $query_params
 	 * @return string
 	 */
-	protected function _disable_default_where_conditions_on_query_param($query_params){
-		if( ! isset($query_params['default_where_conditions'])){
-			$query_params['default_where_conditions']='none';
+	protected function _disable_default_where_conditions_on_query_param($query_params) {
+		if ( ! isset($query_params['default_where_conditions'])) {
+			$query_params['default_where_conditions'] = 'none';
 		}
 		return $query_params;
 	}
@@ -169,15 +169,15 @@ 
 	 * @param array $query_params
 	 * @return int of how many related models got deleted
 	 */
-	public function delete_all_related($model_object_or_id,$query_params = array()){
+	public function delete_all_related($model_object_or_id, $query_params = array()) {
 		//for each thing we would delete,
-		$related_model_objects = $this->get_all_related($model_object_or_id,$query_params);
+		$related_model_objects = $this->get_all_related($model_object_or_id, $query_params);
 		//determine if it's blocked by anything else before it can be deletedx
 		$deleted_count = 0;
-		foreach($related_model_objects as $related_model_object){
+		foreach ($related_model_objects as $related_model_object) {
 			$delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models($related_model_object, $model_object_or_id);
 			/* @var $model_object_or_id EE_Base_Class */
-			if( ! $delete_is_blocked ){
+			if ( ! $delete_is_blocked) {
 				$this->remove_relation_to($model_object_or_id, $related_model_object);
 				$related_model_object->delete();
 				$deleted_count++;
@@ -197,27 +197,27 @@ 
 	 * @param array $query_params
 	 * @return int of how many related models got deleted
 	 */
-	public function delete_related_permanently($model_object_or_id,$query_params = array()){
+	public function delete_related_permanently($model_object_or_id, $query_params = array()) {
 		//for each thing we would delete,
-		$related_model_objects = $this->get_all_related($model_object_or_id,$query_params);
+		$related_model_objects = $this->get_all_related($model_object_or_id, $query_params);
 		//determine if it's blocked by anything else before it can be deletedx
 		$deleted_count = 0;
-		foreach($related_model_objects as $related_model_object){
+		foreach ($related_model_objects as $related_model_object) {
 			$delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models($related_model_object, $model_object_or_id);
 			/* @var $model_object_or_id EE_Base_Class */
-			if( $related_model_object instanceof EE_Soft_Delete_Base_Class ){
+			if ($related_model_object instanceof EE_Soft_Delete_Base_Class) {
 				$this->remove_relation_to($model_object_or_id, $related_model_object);
 				$deleted_count++;
-				if( ! $delete_is_blocked ){
+				if ( ! $delete_is_blocked) {
 					$related_model_object->delete_permanently();
-				}else{
+				} else {
 					//delete is blocked
 					//brent and darren, in this case, wanted to just soft delete it then
 					$related_model_object->delete();
 				}
-			}else{
+			} else {
 				//its not a soft-deletable thing anyways. do the normal logic.
-				if( ! $delete_is_blocked ){
+				if ( ! $delete_is_blocked) {
 					$this->remove_relation_to($model_object_or_id, $related_model_object);
 					$related_model_object->delete();
 					$deleted_count++;
@@ -236,13 +236,13 @@ 
 	 * @return int
 	 */
 	protected function _get_model_object_id($model_object_or_id) {
-		if($model_object_or_id instanceof EE_Base_Class){
+		if ($model_object_or_id instanceof EE_Base_Class) {
 			$model_object_id = $model_object_or_id->ID();
-		}else{
+		} else {
 			$model_object_id = $model_object_or_id;
 		}
-		if( ! $model_object_id){
-			throw new EE_Error(sprintf(__("Sorry, we cant get the related %s model objects to %s model object before it has an ID. You can solve that by just saving it before trying to get its related model objects", "event_espresso"),$this->get_other_model()->get_this_model_name(),$this->get_this_model()->get_this_model_name()));
+		if ( ! $model_object_id) {
+			throw new EE_Error(sprintf(__("Sorry, we cant get the related %s model objects to %s model object before it has an ID. You can solve that by just saving it before trying to get its related model objects", "event_espresso"), $this->get_other_model()->get_this_model_name(), $this->get_this_model()->get_this_model_name()));
 		}
 		return $model_object_id;
 	}
@@ -285,10 +285,10 @@ 
 	 * @param array $where_query_param  like EEM_Base::get_all's $query_params[0] (where conditions)
 	 * @return EE_Base_Class[]
 	 */
-	public function remove_relations($this_obj_or_id,$where_query_param = array()){
-		$related_things = $this->get_all_related($this_obj_or_id,array($where_query_param));
+	public function remove_relations($this_obj_or_id, $where_query_param = array()) {
+		$related_things = $this->get_all_related($this_obj_or_id, array($where_query_param));
 		$objs_removed = array();
-		foreach($related_things as $related_thing){
+		foreach ($related_things as $related_thing) {
 			$objs_removed[] = $this->remove_relation_to($this_obj_or_id, $related_thing);
 		}
 		return $objs_removed;
@@ -301,7 +301,7 @@ 
 	 * related objects exist, returns false.
 	 * @return boolean
 	 */
-	public function block_delete_if_related_models_exist(){
+	public function block_delete_if_related_models_exist() {
 		return $this->_blocking_delete;
 	}
 
@@ -310,13 +310,13 @@ 
 	 * Gets the error message to show
 	 * @return string
 	 */
-	public function get_deletion_error_message(){
-		if($this->_blocking_delete_error_message){
+	public function get_deletion_error_message() {
+		if ($this->_blocking_delete_error_message) {
 			return $this->_blocking_delete_error_message;
-		}else{
+		} else {
 //			return sprintf(__('Cannot delete %1$s when there are related %2$s', "event_espresso"),$this->get_this_model()->item_name(2),$this->get_other_model()->item_name(2));
 			return sprintf(
-				__( 'This %1$s is currently linked to one or more %2$s records. If this %1$s is incorrect, then please remove it from all %3$s before attempting to delete it.', "event_espresso"),
+				__('This %1$s is currently linked to one or more %2$s records. If this %1$s is incorrect, then please remove it from all %3$s before attempting to delete it.', "event_espresso"),
 				$this->get_this_model()->item_name(1),
 				$this->get_other_model()->item_name(1),
 				$this->get_other_model()->item_name(2)

core/db_models/strategies/EE_CPT_Where_Conditions.strategy.php

Doc Comments +5 added lines, -1 removed lines

@@ -7,6 +7,11 @@ 
 
 	protected $_post_type;
 	protected $_meta_field;
+
+	/**
+	 * @param string $post_type
+	 * @param string $meta_field_to_chk
+	 */
 	function __construct($post_type, $meta_field_to_chk){
 		$this->_post_type = $post_type;
 		$this->_meta_field = $meta_field_to_chk;
@@ -27,7 +32,6 @@ 
 	}
 	/**
 	 * Gets the where default where conditions for a custom post type model
-	 * @param string $model_relation_path. Eg, from Event to Payment, this should be "Registration.Transaction.Payment"
 	 * @return array like EEM_Base::get_all's $query_params's index [0] (where conditions)
 	 */
 	protected function _get_default_where_conditions() {

Spacing +7 added lines, -7 removed lines

@@ -3,11 +3,11 @@ 
 /*
  * Strategy specifically for adding where conditions specific to CPT models.
  */
-class EE_CPT_Where_Conditions extends EE_Default_Where_Conditions{
+class EE_CPT_Where_Conditions extends EE_Default_Where_Conditions {
 
 	protected $_post_type;
 	protected $_meta_field;
-	function __construct($post_type, $meta_field_to_chk){
+	function __construct($post_type, $meta_field_to_chk) {
 		$this->_post_type = $post_type;
 		$this->_meta_field = $meta_field_to_chk;
 	}
@@ -17,10 +17,10 @@ 
 	 * @param string $column column name
 	 * @return EE_Model_Field_Base
 	 */
-	protected function _get_field_on_column($column){
+	protected function _get_field_on_column($column) {
 		$all_fields = $this->_model->field_settings(true);
-		foreach($all_fields as $field_name => $field_obj){
-			if($column == $field_obj->get_table_column()){
+		foreach ($all_fields as $field_name => $field_obj) {
+			if ($column == $field_obj->get_table_column()) {
 				return $field_obj;
 			}
 		}
@@ -34,8 +34,8 @@ 
 		//find post_type field
 		$post_type_field = $this->_get_field_on_column('post_type');
 		$status_field = $this->_get_field_on_column('post_status');
-		return array( $post_type_field->get_name() => $this->_post_type,
-				$status_field->get_name() => array('NOT IN',array('auto-draft','trash'))
+		return array($post_type_field->get_name() => $this->_post_type,
+				$status_field->get_name() => array('NOT IN', array('auto-draft', 'trash'))
 		);
 	}
 }

core/EE_Addon.core.php

Doc Comments +1 added lines, -1 removed lines

@@ -110,7 +110,7 @@
 	/**
 	 * Sets addon_name
 	 * @param string $addon_name
-	 * @return boolean
+	 * @return string
 	 */
 	function set_name( $addon_name ) {
 		return $this->_addon_name = $addon_name;

Spacing +63 added lines, -63 removed lines

@@ -1,5 +1,5 @@ 
-<?php if ( !defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 /**
  *
@@ -73,7 +73,7 @@ 
 	/**
 	 * @param mixed $version
 	 */
-	public function set_version( $version = NULL ) {
+	public function set_version($version = NULL) {
 		$this->_version = $version;
 	}
 
@@ -91,7 +91,7 @@ 
 	/**
 	 * @param mixed $min_core_version
 	 */
-	public function set_min_core_version( $min_core_version = NULL ) {
+	public function set_min_core_version($min_core_version = NULL) {
 		$this->_min_core_version = $min_core_version;
 	}
 
@@ -112,7 +112,7 @@ 
 	 * @param string $addon_name
 	 * @return boolean
 	 */
-	function set_name( $addon_name ) {
+	function set_name($addon_name) {
 		return $this->_addon_name = $addon_name;
 	}
 
@@ -138,7 +138,7 @@ 
 		do_action("AHEE__{$classname}__new_install");
 		do_action("AHEE__EE_Addon__new_install", $this);
 		EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-		add_action( 'AHEE__EE_System__perform_activations_upgrades_and_migrations', array( $this, 'initialize_db_if_no_migrations_required' ) );
+		add_action('AHEE__EE_System__perform_activations_upgrades_and_migrations', array($this, 'initialize_db_if_no_migrations_required'));
 	}
 
 
@@ -153,16 +153,16 @@ 
 		do_action("AHEE__{$classname}__reactivation");
 		do_action("AHEE__EE_Addon__reactivation", $this);
 		EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-		add_action( 'AHEE__EE_System__perform_activations_upgrades_and_migrations', array( $this, 'initialize_db_if_no_migrations_required' ) );
+		add_action('AHEE__EE_System__perform_activations_upgrades_and_migrations', array($this, 'initialize_db_if_no_migrations_required'));
 	}
 
-	public function deactivation(){
+	public function deactivation() {
 		$classname = get_class($this);
 //		echo "Deactivating $classname";die;
 		do_action("AHEE__{$classname}__deactivation");
 		do_action("AHEE__EE_Addon__deactivation", $this);
 		//check if the site no longer needs to be in maintenance mode
-		EE_Register_Addon::deregister( $this->name() );
+		EE_Register_Addon::deregister($this->name());
 		EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
 	}
 
@@ -176,16 +176,16 @@ 
 	 * This is a resource-intensive job so we prefer to only do it when necessary
 	 * @return void
 	 */
-	public function initialize_db_if_no_migrations_required( $verify_schema = true ) {
-		if( $verify_schema === '' ) {
+	public function initialize_db_if_no_migrations_required($verify_schema = true) {
+		if ($verify_schema === '') {
 			//wp core bug imo: if no args are passed to `do_action('some_hook_name')` besides the hook's name
 			//(ie, no 2nd or 3rd arguments), instead of calling the registered callbacks with no arguments, it
 			//calls them with an argument of an empty string (ie ""), which evaluates to false
 			//so we need to treat the empty string as if nothing had been passed, and should instead use the default
 			$verify_schema = true;
 		}
-		if ( EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance ) {
-			if( $verify_schema ) {
+		if (EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance) {
+			if ($verify_schema) {
 				$this->initialize_db();
 			}
 			$this->initialize_default_data();
@@ -199,15 +199,15 @@ 
 			 */
 			EE_Registry::instance()->load_helper('Activation');
 			EEH_Activation::initialize_db_content();
-			update_option( 'ee_flush_rewrite_rules', TRUE );
+			update_option('ee_flush_rewrite_rules', TRUE);
 			//in case there are lots of addons being activated at once, let's force garbage collection
 			//to help avoid memory limit errors
 			//EEH_Debug_Tools::instance()->measure_memory( 'db content initialized for ' . get_class( $this), true );
 			gc_collect_cycles();
-		}else{
+		} else {
 			//ask the data migration manager to init this addon's data
 			//when migrations are finished because we can't do it now
-			EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for( $this->name() );
+			EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for($this->name());
 		}
 	}
 
@@ -221,20 +221,20 @@ 
 	 */
 	public function initialize_db() {
 		//find the migration script that sets the database to be compatible with the code
-		$current_dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms( $this->name() );
-		if( $current_dms_name ){
-			$current_data_migration_script = EE_Registry::instance()->load_dms( $current_dms_name );
-			$current_data_migration_script->set_migrating( FALSE );
+		$current_dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms($this->name());
+		if ($current_dms_name) {
+			$current_data_migration_script = EE_Registry::instance()->load_dms($current_dms_name);
+			$current_data_migration_script->set_migrating(FALSE);
 			$current_data_migration_script->schema_changes_before_migration();
 			$current_data_migration_script->schema_changes_after_migration();
-			if ( $current_data_migration_script->get_errors() ) {
-				foreach( $current_data_migration_script->get_errors() as $error ) {
-					EE_Error::add_error( $error, __FILE__, __FUNCTION__, __LINE__ );
+			if ($current_data_migration_script->get_errors()) {
+				foreach ($current_data_migration_script->get_errors() as $error) {
+					EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
 				}
 			}
 		}
 		//if not DMS was found that should be ok. This addon just doesn't require any database changes
-		EE_Data_Migration_Manager::instance()->update_current_database_state_to( array( 'slug' => $this->name(), 'version' => $this->version() ) );
+		EE_Data_Migration_Manager::instance()->update_current_database_state_to(array('slug' => $this->name(), 'version' => $this->version()));
 	}
 
 
@@ -256,7 +256,7 @@ 
 		 * default data)
 		 * @param EE_Addon $addon the addon that called this
 		 */
-		do_action( 'AHEE__EE_Addon__initialize_default_data__begin', $this );
+		do_action('AHEE__EE_Addon__initialize_default_data__begin', $this);
 		//override to insert default data. It is safe to use the models here
 		//because the site should not be in maintenance mode
 	}
@@ -275,7 +275,7 @@ 
 		do_action("AHEE__EE_Addon__upgrade", $this);
 		EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
 		//also it's possible there is new default data that needs to be added
-		add_action( 'AHEE__EE_System__perform_activations_upgrades_and_migrations', array( $this, 'initialize_db_if_no_migrations_required' ) );
+		add_action('AHEE__EE_System__perform_activations_upgrades_and_migrations', array($this, 'initialize_db_if_no_migrations_required'));
 	}
 
 
@@ -288,7 +288,7 @@ 
 		do_action("AHEE__{$classname}__downgrade");
 		do_action("AHEE__EE_Addon__downgrade", $this);
 		//it's possible there's old default data that needs to be double-checked
-		add_action( 'AHEE__EE_System__perform_activations_upgrades_and_migrations', array( $this, 'initialize_db_if_no_migrations_required' ) );
+		add_action('AHEE__EE_System__perform_activations_upgrades_and_migrations', array($this, 'initialize_db_if_no_migrations_required'));
 	}
 
 
@@ -299,7 +299,7 @@ 
 	 * plugin activation only. In the future, we'll want to do it on plugin updates too
 	 * @return bool
 	 */
-	public function set_db_update_option_name(){
+	public function set_db_update_option_name() {
 		EE_Error::doing_it_wrong(__FUNCTION__, __('EE_Addon::set_db_update_option_name was renamed to EE_Addon::set_activation_indicator_option', 'event_espresso'), '4.3.0.alpha.016');
 		//let's just handle this on the next request, ok? right now we're just not really ready
 		return $this->set_activation_indicator_option();
@@ -327,7 +327,7 @@ 
 	 */
 	public function set_activation_indicator_option() {
 		// let's just handle this on the next request, ok? right now we're just not really ready
-		return update_option( $this->get_activation_indicator_option_name(), TRUE );
+		return update_option($this->get_activation_indicator_option_name(), TRUE);
 	}
 
 
@@ -335,8 +335,8 @@ 
 	 * Gets the name of the wp option which is used to temporarily indicate that this addon was activated
 	 * @return string
 	 */
-	public function get_activation_indicator_option_name(){
-		return 'ee_activation_' . $this->name();
+	public function get_activation_indicator_option_name() {
+		return 'ee_activation_'.$this->name();
 	}
 
 
@@ -346,7 +346,7 @@ 
 	 * Used by EE_System to set the request type of this addon. Should not be used by addon developers
 	 * @param int $req_type
 	 */
-	function set_req_type( $req_type ) {
+	function set_req_type($req_type) {
 		$this->_req_type = $req_type;
 	}
 
@@ -357,7 +357,7 @@ 
 	 * of addons
 	 */
 	function detect_req_type() {
-		if( ! $this->_req_type ){
+		if ( ! $this->_req_type) {
 			$this->detect_activation_or_upgrade();
 		}
 		return $this->_req_type;
@@ -370,36 +370,36 @@ 
 	 * Should only be called once per request
 	 * @return void
 	 */
-	function detect_activation_or_upgrade(){
+	function detect_activation_or_upgrade() {
 		$activation_history_for_addon = $this->get_activation_history();
 //		d($activation_history_for_addon);
 		$request_type = EE_System::detect_req_type_given_activation_history($activation_history_for_addon, $this->get_activation_indicator_option_name(), $this->version());
 		$this->set_req_type($request_type);
 		$classname = get_class($this);
-		switch($request_type){
+		switch ($request_type) {
 			case EE_System::req_type_new_activation:
-				do_action( "AHEE__{$classname}__detect_activations_or_upgrades__new_activation" );
-				do_action( "AHEE__EE_Addon__detect_activations_or_upgrades__new_activation", $this );
+				do_action("AHEE__{$classname}__detect_activations_or_upgrades__new_activation");
+				do_action("AHEE__EE_Addon__detect_activations_or_upgrades__new_activation", $this);
 				$this->new_install();
-				$this->update_list_of_installed_versions( $activation_history_for_addon );
+				$this->update_list_of_installed_versions($activation_history_for_addon);
 				break;
 			case EE_System::req_type_reactivation:
-				do_action( "AHEE__{$classname}__detect_activations_or_upgrades__reactivation" );
-				do_action( "AHEE__EE_Addon__detect_activations_or_upgrades__reactivation", $this );
+				do_action("AHEE__{$classname}__detect_activations_or_upgrades__reactivation");
+				do_action("AHEE__EE_Addon__detect_activations_or_upgrades__reactivation", $this);
 				$this->reactivation();
-				$this->update_list_of_installed_versions( $activation_history_for_addon );
+				$this->update_list_of_installed_versions($activation_history_for_addon);
 				break;
 			case EE_System::req_type_upgrade:
-				do_action( "AHEE__{$classname}__detect_activations_or_upgrades__upgrade" );
-				do_action( "AHEE__EE_Addon__detect_activations_or_upgrades__upgrade", $this );
+				do_action("AHEE__{$classname}__detect_activations_or_upgrades__upgrade");
+				do_action("AHEE__EE_Addon__detect_activations_or_upgrades__upgrade", $this);
 				$this->upgrade();
-				$this->update_list_of_installed_versions($activation_history_for_addon );
+				$this->update_list_of_installed_versions($activation_history_for_addon);
 				break;
 			case EE_System::req_type_downgrade:
-				do_action( "AHEE__{$classname}__detect_activations_or_upgrades__downgrade" );
-				do_action( "AHEE__EE_Addon__detect_activations_or_upgrades__downgrade", $this );
+				do_action("AHEE__{$classname}__detect_activations_or_upgrades__downgrade");
+				do_action("AHEE__EE_Addon__detect_activations_or_upgrades__downgrade", $this);
 				$this->downgrade();
-				$this->update_list_of_installed_versions($activation_history_for_addon );
+				$this->update_list_of_installed_versions($activation_history_for_addon);
 				break;
 			case EE_System::req_type_normal:
 			default:
@@ -407,7 +407,7 @@ 
 				break;
 		}
 
-		do_action( "AHEE__{$classname}__detect_if_activation_or_upgrade__complete" );
+		do_action("AHEE__{$classname}__detect_if_activation_or_upgrade__complete");
 	}
 
 	/**
@@ -416,17 +416,17 @@ 
 	 * @param string $current_version_to_add
 	 * @return boolean success
 	 */
-	public function update_list_of_installed_versions($version_history = NULL,$current_version_to_add = NULL) {
-		if( ! $version_history ) {
+	public function update_list_of_installed_versions($version_history = NULL, $current_version_to_add = NULL) {
+		if ( ! $version_history) {
 			$version_history = $this->get_activation_history();
 		}
-		if( $current_version_to_add == NULL){
+		if ($current_version_to_add == NULL) {
 			$current_version_to_add = $this->version();
 		}
-		$version_history[ $current_version_to_add ][] = date( 'Y-m-d H:i:s',time() );
+		$version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
 		// resave
 //		echo "updating list of installed versions:".$this->get_activation_history_option_name();d($version_history);
-		return update_option( $this->get_activation_history_option_name(), $version_history );
+		return update_option($this->get_activation_history_option_name(), $version_history);
 	}
 
 	/**
@@ -434,8 +434,8 @@ 
 	 * of this addon
 	 * @return string
 	 */
-	function get_activation_history_option_name(){
-		return self::ee_addon_version_history_option_prefix . $this->name();
+	function get_activation_history_option_name() {
+		return self::ee_addon_version_history_option_prefix.$this->name();
 	}
 
 
@@ -444,7 +444,7 @@ 
 	 * Gets the wp option which stores the activation history for this addon
 	 * @return array
 	 */
-	function get_activation_history(){
+	function get_activation_history() {
 		return get_option($this->get_activation_history_option_name(), NULL);
 	}
 
@@ -453,8 +453,8 @@ 
 	/**
 	 * @param string $config_section
 	 */
-	public function set_config_section( $config_section = '' ) {
-		$this->_config_section = ! empty( $config_section ) ? $config_section : 'addons';
+	public function set_config_section($config_section = '') {
+		$this->_config_section = ! empty($config_section) ? $config_section : 'addons';
 	}
 	/**
 	 *	filepath to the main file, which can be used for register_activation_hook, register_deactivation_hook, etc.
@@ -467,14 +467,14 @@ 
 	 * Sets the filepath to the main plugin file
 	 * @param string $filepath
 	 */
-	public function set_main_plugin_file( $filepath ) {
+	public function set_main_plugin_file($filepath) {
 		$this->_main_plugin_file = $filepath;
 	}
 	/**
 	 * gets the filepath to teh main file
 	 * @return string
 	 */
-	public function get_main_plugin_file(){
+	public function get_main_plugin_file() {
 		return $this->_main_plugin_file;
 	}
 
@@ -484,15 +484,15 @@ 
 	 * @return string
 	 */
 	public function get_main_plugin_file_basename() {
-		return plugin_basename( $this->get_main_plugin_file() );
+		return plugin_basename($this->get_main_plugin_file());
 	}
 
 	/**
 	 * Gets the folder name which contains the main plugin file
 	 * @return string
 	 */
-	public function get_main_plugin_file_dirname(){
-		return dirname( $this->get_main_plugin_file() );
+	public function get_main_plugin_file_dirname() {
+		return dirname($this->get_main_plugin_file());
 	}
 
 }

Braces +1 added lines, -1 removed lines

@@ -204,7 +204,7 @@
 			//to help avoid memory limit errors
 			//EEH_Debug_Tools::instance()->measure_memory( 'db content initialized for ' . get_class( $this), true );
 			gc_collect_cycles();
-		}else{
+		} else{
 			//ask the data migration manager to init this addon's data
 			//when migrations are finished because we can't do it now
 			EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for( $this->name() );