eventespresso / event-espresso-core

admin_pages/registration_form/Registration_Form_Admin_Page.core.php

Spacing +146 added lines, -146 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('NO direct script access allowed');
 
 /**
@@ -68,12 +68,12 @@ 
 	 * 		@param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
 	 * 		@access public
 	 */
-	public function __construct( $routing = TRUE ) {
-		require_once( EE_MODELS . 'EEM_Question.model.php' );
-		require_once( EE_MODELS . 'EEM_Question_Group.model.php' );
-		$this->_question_model=  EEM_Question::instance();
-		$this->_question_group_model=EEM_Question_Group::instance();
-		parent::__construct( $routing );
+	public function __construct($routing = TRUE) {
+		require_once(EE_MODELS.'EEM_Question.model.php');
+		require_once(EE_MODELS.'EEM_Question_Group.model.php');
+		$this->_question_model = EEM_Question::instance();
+		$this->_question_group_model = EEM_Question_Group::instance();
+		parent::__construct($routing);
 	}
 
 
@@ -109,7 +109,7 @@ 
 	 *_set_page_routes
 	 */
 	protected function _set_page_routes() {
-		$qst_id = ! empty( $this->_req_data['QST_ID'] ) ? $this->_req_data['QST_ID'] : 0;
+		$qst_id = ! empty($this->_req_data['QST_ID']) ? $this->_req_data['QST_ID'] : 0;
 		$this->_page_routes = array(
 			'default' => array(
 				'func' => '_questions_overview_list_table',
@@ -130,7 +130,7 @@ 
 
 			'update_question' => array(
 				'func' => '_insert_or_update_question',
-				'args' => array('new_question' => FALSE ),
+				'args' => array('new_question' => FALSE),
 				'capability' => 'ee_edit_question',
 				'obj_id' => $qst_id,
 				'noheader' => TRUE,
@@ -165,7 +165,7 @@ 
 						'filename' => 'registration_form_questions_overview_views_bulk_actions_search'
 						)
 					),
-				'help_tour' => array( 'Registration_Form_Questions_Overview_Help_Tour'),
+				'help_tour' => array('Registration_Form_Questions_Overview_Help_Tour'),
 				'require_nonce' => FALSE,
 				'qtips' => array(
 					'EE_Registration_Form_Tips'
@@ -184,7 +184,7 @@ 
 						'filename' => 'registration_form_question_groups'
 						),
 					),
-				'help_tour' => array( 'Registration_Form_Question_Groups_Help_Tour'),
+				'help_tour' => array('Registration_Form_Question_Groups_Help_Tour'),
 				'require_nonce' => FALSE
 				),
 
@@ -193,16 +193,16 @@ 
 					'label' => __('Edit Question', 'event_espresso'),
 					'order' => 15,
 					'persistent' => FALSE,
-					'url' => isset($this->_req_data['question_id']) ? add_query_arg(array('question_id' => $this->_req_data['question_id'] ), $this->_current_page_view_url )  : $this->_admin_base_url
+					'url' => isset($this->_req_data['question_id']) ? add_query_arg(array('question_id' => $this->_req_data['question_id']), $this->_current_page_view_url) : $this->_admin_base_url
 					),
-				'metaboxes' => array_merge( $this->_default_espresso_metaboxes, array('_publish_post_box' ) ),
+				'metaboxes' => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
 				'help_tabs' => array(
 					'registration_form_edit_question_group_help_tab' => array(
 						'title' => __('Edit Question', 'event_espresso'),
 						'filename' => 'registration_form_edit_question'
 						),
 					),
-                'help_tour' => array( 'Registration_Form_Edit_Question_Help_Tour'),
+                'help_tour' => array('Registration_Form_Edit_Question_Help_Tour'),
 				'require_nonce' => FALSE
 				),
 			);
@@ -230,7 +230,7 @@ 
 	//none of the below group are currently used for Event Categories
 	protected function _add_feature_pointers() {}
 	public function load_scripts_styles() {
-		wp_register_style( 'espresso_registration', REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.css', array(), EVENT_ESPRESSO_VERSION );
+		wp_register_style('espresso_registration', REGISTRATION_FORM_ASSETS_URL.'espresso_registration_form_admin.css', array(), EVENT_ESPRESSO_VERSION);
 		wp_enqueue_style('espresso_registration');
 	}
 	public function admin_init() {}
@@ -246,20 +246,20 @@ 
 
 	public function load_scripts_styles_add_question() {
 		$this->load_scripts_styles_forms();
-		wp_register_script( 'espresso_registration_form_single', REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.js', array('jquery-ui-sortable'), EVENT_ESPRESSO_VERSION, TRUE );
-		wp_enqueue_script( 'espresso_registration_form_single' );
+		wp_register_script('espresso_registration_form_single', REGISTRATION_FORM_ASSETS_URL.'espresso_registration_form_admin.js', array('jquery-ui-sortable'), EVENT_ESPRESSO_VERSION, TRUE);
+		wp_enqueue_script('espresso_registration_form_single');
 	}
 	public function load_scripts_styles_edit_question() {
 		$this->load_scripts_styles_forms();
-		wp_register_script( 'espresso_registration_form_single', REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.js', array('jquery-ui-sortable'), EVENT_ESPRESSO_VERSION, TRUE );
-		wp_enqueue_script( 'espresso_registration_form_single' );
+		wp_register_script('espresso_registration_form_single', REGISTRATION_FORM_ASSETS_URL.'espresso_registration_form_admin.js', array('jquery-ui-sortable'), EVENT_ESPRESSO_VERSION, TRUE);
+		wp_enqueue_script('espresso_registration_form_single');
 	}
 
 
 
 
 	public function recaptcha_info_help_tab() {
-		$template = REGISTRATION_FORM_TEMPLATE_PATH . 'recaptcha_info_help_tab.template.php';
+		$template = REGISTRATION_FORM_TEMPLATE_PATH.'recaptcha_info_help_tab.template.php';
 		EEH_Template::display_template($template, array());
 	}
 
@@ -291,7 +291,7 @@ 
 				)
 		);
 
-		if ( EE_Registry::instance()->CAP->current_user_can( 'ee_delete_questions', 'espresso_registration_form_trash_questions' ) ) {
+		if (EE_Registry::instance()->CAP->current_user_can('ee_delete_questions', 'espresso_registration_form_trash_questions')) {
 			$this->_views['trash'] = array(
 				'slug' => 'trash',
 				'label' => __('Trash', 'event_espresso'),
@@ -309,9 +309,9 @@ 
 	 */
 	protected function _questions_groups_preview() {
 		$this->_admin_page_title = __('Question Groups (Preview)', 'event_espresso');
-		$this->_template_args['preview_img'] = '<img src="' . REGISTRATION_FORM_ASSETS_URL . 'caf_reg_form_preview.jpg" alt="' . esc_attr__( 'Preview Question Groups Overview List Table screenshot', 'event_espresso' ) . '" />';
-		$this->_template_args['preview_text'] = '<strong>'.__( 'Question Groups is a feature that is only available in the Caffeinated version of Event Espresso.  With the Question Groups feature you are able to: create new question groups, edit existing question groups, and also create and edit new questions and add them to question groups.', 'event_espresso' ).'</strong>';
-		$this->display_admin_caf_preview_page( 'question_groups_tab' );
+		$this->_template_args['preview_img'] = '<img src="'.REGISTRATION_FORM_ASSETS_URL.'caf_reg_form_preview.jpg" alt="'.esc_attr__('Preview Question Groups Overview List Table screenshot', 'event_espresso').'" />';
+		$this->_template_args['preview_text'] = '<strong>'.__('Question Groups is a feature that is only available in the Caffeinated version of Event Espresso.  With the Question Groups feature you are able to: create new question groups, edit existing question groups, and also create and edit new questions and add them to question groups.', 'event_espresso').'</strong>';
+		$this->display_admin_caf_preview_page('question_groups_tab');
 	}
 
 
@@ -322,58 +322,58 @@ 
 	 * @param \EEM_Base $model
 	 * @return array where each key is the name of a model's field/db column, and each value is its value.
 	 */
-	protected function _set_column_values_for(EEM_Base $model){
-		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
-		$set_column_values=array();
+	protected function _set_column_values_for(EEM_Base $model) {
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$set_column_values = array();
 
 		//some initial checks for proper values.
 		//if QST_admin_only, then no matter what QST_required is we disable.
-		if ( !empty( $this->_req_data['QST_admin_only'] ) ) {
+		if ( ! empty($this->_req_data['QST_admin_only'])) {
 			$this->_req_data['QST_required'] = 0;
 		}
-		foreach($model->field_settings() as $fieldName=>$settings){
+		foreach ($model->field_settings() as $fieldName=>$settings) {
 			// basically if QSG_identifier is empty or not set
-			if ( $fieldName === 'QSG_identifier' && ( isset( $this->_req_data['QSG_identifier'] ) && empty( $this->_req_data['QSG_identifier'] ) )) {
-				$QSG_name = isset( $this->_req_data['QSG_name'] ) ? $this->_req_data['QSG_name'] : '' ;
-				$set_column_values[$fieldName] = sanitize_title($QSG_name ) . '-' . uniqid( '', true );
+			if ($fieldName === 'QSG_identifier' && (isset($this->_req_data['QSG_identifier']) && empty($this->_req_data['QSG_identifier']))) {
+				$QSG_name = isset($this->_req_data['QSG_name']) ? $this->_req_data['QSG_name'] : '';
+				$set_column_values[$fieldName] = sanitize_title($QSG_name).'-'.uniqid('', true);
 //				dd($set_column_values);
 			}
 			//if the admin label is blank, use a slug version of the question text
-			else if ( $fieldName === 'QST_admin_label' && ( isset( $this->_req_data['QST_admin_label'] ) && empty( $this->_req_data['QST_admin_label'] )  )) {
-				$QST_text = isset( $this->_req_data['QST_display_text'] ) ? $this->_req_data['QST_display_text'] : '' ;
-				$set_column_values[$fieldName] = sanitize_title(wp_trim_words($QST_text,10));
+			else if ($fieldName === 'QST_admin_label' && (isset($this->_req_data['QST_admin_label']) && empty($this->_req_data['QST_admin_label']))) {
+				$QST_text = isset($this->_req_data['QST_display_text']) ? $this->_req_data['QST_display_text'] : '';
+				$set_column_values[$fieldName] = sanitize_title(wp_trim_words($QST_text, 10));
 			}
 
 
-			else if ( $fieldName === 'QST_admin_only' && ( !isset( $this->_req_data['QST_admin_only'] ) ) ) {
+			else if ($fieldName === 'QST_admin_only' && ( ! isset($this->_req_data['QST_admin_only']))) {
 				$set_column_values[$fieldName] = 0;
 			}
 
-			else if ( $fieldName === 'QST_max' ) {
+			else if ($fieldName === 'QST_max') {
 				$qst_system = EEM_Question::instance()->get_var(
 					array(
 						array(
-							'QST_ID' => isset( $this->_req_data[ 'QST_ID' ] ) ? $this->_req_data[ 'QST_ID' ] : 0
+							'QST_ID' => isset($this->_req_data['QST_ID']) ? $this->_req_data['QST_ID'] : 0
 						)
 					),
 					'QST_system' );
-				$max_max = EEM_Question::instance()->absolute_max_for_system_question( $qst_system );
-				if( empty( $this->_req_data[ 'QST_max' ] ) ||
-					 $this->_req_data[ 'QST_max' ] > $max_max ) {
-					$set_column_values[ $fieldName ] = $max_max;
+				$max_max = EEM_Question::instance()->absolute_max_for_system_question($qst_system);
+				if (empty($this->_req_data['QST_max']) ||
+					 $this->_req_data['QST_max'] > $max_max) {
+					$set_column_values[$fieldName] = $max_max;
 				}
 			}
 
 
 			//only add a property to the array if it's not null (otherwise the model should just use the default value)
-			if(
-				! isset( $set_column_values[ $fieldName ] ) &&
-				isset($this->_req_data[$fieldName] ) ){
-				$set_column_values[$fieldName]=$this->_req_data[$fieldName];
+			if (
+				! isset($set_column_values[$fieldName]) &&
+				isset($this->_req_data[$fieldName]) ) {
+				$set_column_values[$fieldName] = $this->_req_data[$fieldName];
 			}
 
 		}
-		return $set_column_values;//validation fo this data to be performed by the model before insertion.
+		return $set_column_values; //validation fo this data to be performed by the model before insertion.
 	}
 
 
@@ -392,29 +392,29 @@ 
 	 * _edit_question
 	 */
 	protected function _edit_question() {
-		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
-		$ID=isset( $this->_req_data['QST_ID'] ) && ! empty( $this->_req_data['QST_ID'] ) ? absint( $this->_req_data['QST_ID'] ) : FALSE;
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$ID = isset($this->_req_data['QST_ID']) && ! empty($this->_req_data['QST_ID']) ? absint($this->_req_data['QST_ID']) : FALSE;
 
-		$this->_admin_page_title = ucwords( str_replace( '_', ' ', $this->_req_action ));
+		$this->_admin_page_title = ucwords(str_replace('_', ' ', $this->_req_action));
 		// add PRC_ID to title if editing
-		$this->_admin_page_title = $ID ? $this->_admin_page_title . ' # ' . $ID : $this->_admin_page_title;
-		if($ID){
-			$question=$this->_question_model->get_one_by_ID($ID);
-			$additional_hidden_fields=array('QST_ID'=>array('type'=>'hidden','value'=>$ID));
+		$this->_admin_page_title = $ID ? $this->_admin_page_title.' # '.$ID : $this->_admin_page_title;
+		if ($ID) {
+			$question = $this->_question_model->get_one_by_ID($ID);
+			$additional_hidden_fields = array('QST_ID'=>array('type'=>'hidden', 'value'=>$ID));
 			$this->_set_add_edit_form_tags('update_question', $additional_hidden_fields);
-		}else{
-			$question= EE_Question::new_instance();
+		} else {
+			$question = EE_Question::new_instance();
 			$question->set_order_to_latest();
 			$this->_set_add_edit_form_tags('insert_question');
 		}
-		$question_types = $question->has_answers() ?  $this->_question_model->question_types_in_same_category( $question->type() ) : $this->_question_model->allowed_question_types();
-		$this->_template_args['QST_ID']=$ID;
-		$this->_template_args['question']=$question;
-		$this->_template_args['question_types']= $question_types;
-		$this->_template_args['max_max'] = EEM_Question::instance()->absolute_max_for_system_question( $question->system_ID() );
+		$question_types = $question->has_answers() ? $this->_question_model->question_types_in_same_category($question->type()) : $this->_question_model->allowed_question_types();
+		$this->_template_args['QST_ID'] = $ID;
+		$this->_template_args['question'] = $question;
+		$this->_template_args['question_types'] = $question_types;
+		$this->_template_args['max_max'] = EEM_Question::instance()->absolute_max_for_system_question($question->system_ID());
 		$this->_template_args['question_type_descriptions'] = $this->_get_question_type_descriptions();
-		$this->_set_publish_post_box_vars( 'id', $ID );
-		$this->_template_args['admin_page_content'] = EEH_Template::display_template( REGISTRATION_FORM_TEMPLATE_PATH . 'questions_main_meta_box.template.php', $this->_template_args, TRUE );
+		$this->_set_publish_post_box_vars('id', $ID);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(REGISTRATION_FORM_TEMPLATE_PATH.'questions_main_meta_box.template.php', $this->_template_args, TRUE);
 
 		// the details template wrapper
 		$this->display_admin_page_with_sidebar();
@@ -429,18 +429,18 @@ 
 		EE_Registry::instance()->load_helper('HTML');
 		$descriptions = '';
 		$question_type_descriptions = EEM_Question::instance()->question_descriptions();
-		foreach ( $question_type_descriptions as $type => $question_type_description ) {
-			if ( $type == 'HTML_TEXTAREA' ) {
+		foreach ($question_type_descriptions as $type => $question_type_description) {
+			if ($type == 'HTML_TEXTAREA') {
 				$html = new EE_Simple_HTML_Validation_Strategy();
 				$question_type_description .= sprintf(
-					__( '%1$s(allowed tags: %2$s)', 'event_espresso' ),
+					__('%1$s(allowed tags: %2$s)', 'event_espresso'),
 					'<br/>',
 					$html->get_list_of_allowed_tags()
 				);
 			}
 			$descriptions .= EEH_HTML::p(
 				$question_type_description,
-				'question_type_description-' . $type,
+				'question_type_description-'.$type,
 				'question_type_description description',
 				'display:none;'
 			);
@@ -454,58 +454,58 @@ 
 	 * @param bool|true $new_question
 	 * @throws \EE_Error
 	 */
-	protected function _insert_or_update_question( $new_question = TRUE) {
-		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
-		$set_column_values=$this->_set_column_values_for($this->_question_model);
-		if($new_question){
-			$ID=$this->_question_model->insert($set_column_values);
+	protected function _insert_or_update_question($new_question = TRUE) {
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$set_column_values = $this->_set_column_values_for($this->_question_model);
+		if ($new_question) {
+			$ID = $this->_question_model->insert($set_column_values);
 			$success = $ID ? true : false;
 			$action_desc = 'added';
-		}else{
-			$ID=absint($this->_req_data['QST_ID']);
-			$pk=$this->_question_model->primary_key_name();
-			$wheres=array($pk=>$ID);
+		} else {
+			$ID = absint($this->_req_data['QST_ID']);
+			$pk = $this->_question_model->primary_key_name();
+			$wheres = array($pk=>$ID);
 			unset($set_column_values[$pk]);
-			$success= $this->_question_model->update($set_column_values,array($wheres));
-			$action_desc='updated';
+			$success = $this->_question_model->update($set_column_values, array($wheres));
+			$action_desc = 'updated';
 		}
 
-		if ($ID){
+		if ($ID) {
 			//save the related options
 			//trash removed options, save old ones
 			//get list of all options
 			/** @type EE_Question $question */
-			$question=$this->_question_model->get_one_by_ID($ID);
-			$options=$question->options();
-			if(! empty($options)){
-				foreach($options as $option_ID=>$option){
-					$option_req_index=$this->_get_option_req_data_index($option_ID);
-					if($option_req_index!==FALSE){
+			$question = $this->_question_model->get_one_by_ID($ID);
+			$options = $question->options();
+			if ( ! empty($options)) {
+				foreach ($options as $option_ID=>$option) {
+					$option_req_index = $this->_get_option_req_data_index($option_ID);
+					if ($option_req_index !== FALSE) {
 						$option->save($this->_req_data['question_options'][$option_req_index]);
-					}else{
+					} else {
 						//not found, remove it
 						$option->delete();
 					}
 				}
 			}
 			//save new related options
-			foreach($this->_req_data['question_options'] as $index=>$option_req_data){
-				if( empty($option_req_data['QSO_ID'] ) && (  ( isset( $option_req_data['QSO_value'] ) && $option_req_data['QSO_value'] !== '' ) || ! empty( $option_req_data['QSO_desc'] ) ) ) {//no ID! save it!
-					if( ! isset( $option_req_data['QSO_value'] ) || $option_req_data['QSO_value'] === ''  ){
-						$option_req_data['QSO_value']=$option_req_data['QSO_desc'];
+			foreach ($this->_req_data['question_options'] as $index=>$option_req_data) {
+				if (empty($option_req_data['QSO_ID']) && ((isset($option_req_data['QSO_value']) && $option_req_data['QSO_value'] !== '') || ! empty($option_req_data['QSO_desc']))) {//no ID! save it!
+					if ( ! isset($option_req_data['QSO_value']) || $option_req_data['QSO_value'] === '') {
+						$option_req_data['QSO_value'] = $option_req_data['QSO_desc'];
 					}
-					$new_option=EE_Question_Option::new_instance( array( 'QSO_value' => $option_req_data['QSO_value'], 'QSO_desc' => $option_req_data['QSO_desc'], 'QSO_order' => $option_req_data['QSO_order'], 'QST_ID' => $question->ID()));
+					$new_option = EE_Question_Option::new_instance(array('QSO_value' => $option_req_data['QSO_value'], 'QSO_desc' => $option_req_data['QSO_desc'], 'QSO_order' => $option_req_data['QSO_order'], 'QST_ID' => $question->ID()));
 					$new_option->save();
 				}
 			}
 		}
-		$query_args = array( 'action' => 'edit_question', 'QST_ID' => $ID );
-		if ( $success !== FALSE ) {
-			$msg = $new_question ? sprintf( __('The %s has been created', 'event_espresso'), $this->_question_model->item_name() ) : sprintf( __('The %s has been updated', 'event_espresso' ), $this->_question_model->item_name() );
-			EE_Error::add_success( $msg );
+		$query_args = array('action' => 'edit_question', 'QST_ID' => $ID);
+		if ($success !== FALSE) {
+			$msg = $new_question ? sprintf(__('The %s has been created', 'event_espresso'), $this->_question_model->item_name()) : sprintf(__('The %s has been updated', 'event_espresso'), $this->_question_model->item_name());
+			EE_Error::add_success($msg);
 		}
 
-		$this->_redirect_after_action( FALSE, '', $action_desc, $query_args, TRUE);
+		$this->_redirect_after_action(FALSE, '', $action_desc, $query_args, TRUE);
 	}
 
 
@@ -518,10 +518,10 @@ 
 	 * @param int $ID of the question option to find
 	 * @return int index in question_options array if successful, FALSE if unsuccessful
 	 */
-	protected function _get_option_req_data_index($ID){
-		$req_data_for_question_options=$this->_req_data['question_options'];
-		foreach($req_data_for_question_options as $num=>$option_data){
-			if( array_key_exists('QSO_ID',$option_data) && (int)$option_data['QSO_ID'] === $ID ){
+	protected function _get_option_req_data_index($ID) {
+		$req_data_for_question_options = $this->_req_data['question_options'];
+		foreach ($req_data_for_question_options as $num=>$option_data) {
+			if (array_key_exists('QSO_ID', $option_data) && (int) $option_data['QSO_ID'] === $ID) {
 				return $num;
 			}
 		}
@@ -543,25 +543,25 @@ 
 	 * @param int      $current_page
 	 * @return array lik EEM_Base::get_all's $query_params parameter
 	 */
-	protected function get_query_params($model, $per_page=10,$current_page=10){
+	protected function get_query_params($model, $per_page = 10, $current_page = 10) {
 		$query_params = array();
-		$offset=($current_page-1)*$per_page;
-		$query_params['limit']=array($offset,$per_page);
-		$order = ( isset( $this->_req_data['order'] ) && ! empty( $this->_req_data['order'] )) ? $this->_req_data['order'] : 'ASC';
+		$offset = ($current_page - 1) * $per_page;
+		$query_params['limit'] = array($offset, $per_page);
+		$order = (isset($this->_req_data['order']) && ! empty($this->_req_data['order'])) ? $this->_req_data['order'] : 'ASC';
 		$orderby_field = $model instanceof EEM_Question ? 'QST_ID' : 'QSG_order';
 		$field_to_order_by = empty($this->_req_data['orderby']) ? $orderby_field : $this->_req_data['orderby'];
-		$query_params['order_by']=array( $field_to_order_by => $order );
-		$search_string = array_key_exists('s',$this->_req_data) ? $this->_req_data['s'] : null;
-		if(! empty($search_string)){
-			if($model instanceof EEM_Question_Group){
-				$query_params[0]=array(
+		$query_params['order_by'] = array($field_to_order_by => $order);
+		$search_string = array_key_exists('s', $this->_req_data) ? $this->_req_data['s'] : null;
+		if ( ! empty($search_string)) {
+			if ($model instanceof EEM_Question_Group) {
+				$query_params[0] = array(
 					'OR'=>array(
-						'QSG_name'=>array('LIKE',"%$search_string%"),
-						'QSG_desc'=>array('LIKE',"%$search_string%"))
+						'QSG_name'=>array('LIKE', "%$search_string%"),
+						'QSG_desc'=>array('LIKE', "%$search_string%"))
 					);
-			}else{
-				$query_params[0]=array(
-					'QST_display_text'=>array('LIKE',"%$search_string%")
+			} else {
+				$query_params[0] = array(
+					'QST_display_text'=>array('LIKE', "%$search_string%")
 					);
 			}
 		}
@@ -609,13 +609,13 @@ 
 	 * @param bool|false $count
 	 * @return \EE_Soft_Delete_Base_Class[]|int
 	 */
-	public function get_questions( $per_page=10, $current_page = 1, $count = FALSE ) {
+	public function get_questions($per_page = 10, $current_page = 1, $count = FALSE) {
 		$QST = EEM_Question::instance();
 		$query_params = $this->get_query_params($QST, $per_page, $current_page);
-		if ($count){
-			$where = isset( $query_params[0] ) ? array( $query_params[0] ) : array();
+		if ($count) {
+			$where = isset($query_params[0]) ? array($query_params[0]) : array();
 			$results = $QST->count($where);
-		}else{
+		} else {
 			$results = $QST->get_all($query_params);
 		}
 		return $results;
@@ -630,10 +630,10 @@ 
 	 * @param bool|false $count
 	 * @return \EE_Soft_Delete_Base_Class[]|int
 	 */
-	public function get_trashed_questions( $per_page, $current_page = 1, $count = FALSE ) {
-		$query_params =$this->get_query_params( EEM_Question::instance(), $per_page, $current_page);
-		$where        = isset( $query_params[0] ) ? array($query_params[0]) : array();
-		$questions    =$count ? EEM_Question::instance()->count_deleted($where) : EEM_Question::instance()->get_all_deleted($query_params);
+	public function get_trashed_questions($per_page, $current_page = 1, $count = FALSE) {
+		$query_params = $this->get_query_params(EEM_Question::instance(), $per_page, $current_page);
+		$where        = isset($query_params[0]) ? array($query_params[0]) : array();
+		$questions    = $count ? EEM_Question::instance()->count_deleted($where) : EEM_Question::instance()->get_all_deleted($query_params);
 		return $questions;
 	}
 
@@ -645,12 +645,12 @@ 
 	 * @param bool|false $count
 	 * @return \EE_Soft_Delete_Base_Class[]
 	 */
-	public function get_question_groups( $per_page, $current_page = 1, $count = FALSE ) {
+	public function get_question_groups($per_page, $current_page = 1, $count = FALSE) {
 		/** @type EEM_Question_Group $questionGroupModel */
 		$questionGroupModel = EEM_Question_Group::instance();
 		//note: this a subclass of EEM_Soft_Delete_Base, so this is actually only getting non-trashed items
 		return $questionGroupModel->get_all(
-			$this->get_query_params( $questionGroupModel, $per_page, $current_page )
+			$this->get_query_params($questionGroupModel, $per_page, $current_page)
 		);
 	}
 
@@ -667,36 +667,36 @@ 
 
 		$this->_template_args['values'] = $this->_yes_no_values;
 
-		$this->_template_args['use_captcha'] = isset( EE_Registry::instance()->CFG->registration->use_captcha ) ? EE_Registry::instance()->CFG->registration->use_captcha : FALSE;
-		$this->_template_args['show_captcha_settings'] = $this->_template_args['use_captcha'] ? 'style="display:table-row;"': '';
+		$this->_template_args['use_captcha'] = isset(EE_Registry::instance()->CFG->registration->use_captcha) ? EE_Registry::instance()->CFG->registration->use_captcha : FALSE;
+		$this->_template_args['show_captcha_settings'] = $this->_template_args['use_captcha'] ? 'style="display:table-row;"' : '';
 
-		$this->_template_args['recaptcha_publickey'] = isset( EE_Registry::instance()->CFG->registration->recaptcha_publickey ) ? stripslashes( EE_Registry::instance()->CFG->registration->recaptcha_publickey ) : '';
-		$this->_template_args['recaptcha_privatekey'] = isset( EE_Registry::instance()->CFG->registration->recaptcha_privatekey ) ? stripslashes( EE_Registry::instance()->CFG->registration->recaptcha_privatekey ) : '';
-		$this->_template_args['recaptcha_width'] = isset( EE_Registry::instance()->CFG->registration->recaptcha_width ) ? absint( EE_Registry::instance()->CFG->registration->recaptcha_width ) : 500;
+		$this->_template_args['recaptcha_publickey'] = isset(EE_Registry::instance()->CFG->registration->recaptcha_publickey) ? stripslashes(EE_Registry::instance()->CFG->registration->recaptcha_publickey) : '';
+		$this->_template_args['recaptcha_privatekey'] = isset(EE_Registry::instance()->CFG->registration->recaptcha_privatekey) ? stripslashes(EE_Registry::instance()->CFG->registration->recaptcha_privatekey) : '';
+		$this->_template_args['recaptcha_width'] = isset(EE_Registry::instance()->CFG->registration->recaptcha_width) ? absint(EE_Registry::instance()->CFG->registration->recaptcha_width) : 500;
 
 		$this->_template_args['recaptcha_theme_options'] = array(
-				array('id'  => 'red','text'=> __('Red', 'event_espresso')),
-				array('id'  => 'white','text'=> __('White', 'event_espresso')),
-				array('id'  => 'blackglass','text'=> __('Blackglass', 'event_espresso')),
-				array('id'  => 'clean','text'=> __('Clean', 'event_espresso'))
+				array('id'  => 'red', 'text'=> __('Red', 'event_espresso')),
+				array('id'  => 'white', 'text'=> __('White', 'event_espresso')),
+				array('id'  => 'blackglass', 'text'=> __('Blackglass', 'event_espresso')),
+				array('id'  => 'clean', 'text'=> __('Clean', 'event_espresso'))
 			);
-		$this->_template_args['recaptcha_theme'] = isset( EE_Registry::instance()->CFG->registration->recaptcha_theme ) ? EE_Registry::instance()->CFG->registration->get_pretty( 'recaptcha_theme' ) : 'clean';
+		$this->_template_args['recaptcha_theme'] = isset(EE_Registry::instance()->CFG->registration->recaptcha_theme) ? EE_Registry::instance()->CFG->registration->get_pretty('recaptcha_theme') : 'clean';
 
 		$this->_template_args['recaptcha_language_options'] = array(
-				array('id'  => 'en','text'=> __('English', 'event_espresso')),
-				array('id'  => 'es','text'=> __('Spanish', 'event_espresso')),
-				array('id'  => 'nl','text'=> __('Dutch', 'event_espresso')),
-				array('id'  => 'fr','text'=> __('French', 'event_espresso')),
-				array('id'  => 'de','text'=> __('German', 'event_espresso')),
-				array('id'  => 'pt','text'=> __('Portuguese', 'event_espresso')),
-				array('id'  => 'ru','text'=> __('Russian', 'event_espresso')),
-				array('id'  => 'tr','text'=> __('Turkish', 'event_espresso'))
+				array('id'  => 'en', 'text'=> __('English', 'event_espresso')),
+				array('id'  => 'es', 'text'=> __('Spanish', 'event_espresso')),
+				array('id'  => 'nl', 'text'=> __('Dutch', 'event_espresso')),
+				array('id'  => 'fr', 'text'=> __('French', 'event_espresso')),
+				array('id'  => 'de', 'text'=> __('German', 'event_espresso')),
+				array('id'  => 'pt', 'text'=> __('Portuguese', 'event_espresso')),
+				array('id'  => 'ru', 'text'=> __('Russian', 'event_espresso')),
+				array('id'  => 'tr', 'text'=> __('Turkish', 'event_espresso'))
 			);
-		$this->_template_args['recaptcha_language'] = isset( EE_Registry::instance()->CFG->registration->recaptcha_language ) ? EE_Registry::instance()->CFG->registration->recaptcha_language : 'en';
+		$this->_template_args['recaptcha_language'] = isset(EE_Registry::instance()->CFG->registration->recaptcha_language) ? EE_Registry::instance()->CFG->registration->recaptcha_language : 'en';
 
-		$this->_set_add_edit_form_tags( 'update_reg_form_settings' );
-		$this->_set_publish_post_box_vars( NULL, FALSE, FALSE, NULL, FALSE );
-		$this->_template_args['admin_page_content'] = EEH_Template::display_template( REGISTRATION_FORM_TEMPLATE_PATH . 'reg_form_settings.template.php', $this->_template_args, TRUE );
+		$this->_set_add_edit_form_tags('update_reg_form_settings');
+		$this->_set_publish_post_box_vars(NULL, FALSE, FALSE, NULL, FALSE);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(REGISTRATION_FORM_TEMPLATE_PATH.'reg_form_settings.template.php', $this->_template_args, TRUE);
 		$this->display_admin_page_with_sidebar();
 	}
 

core/data_migration_scripts/EE_DMS_Core_4_9_0.dms.php

Spacing +39 added lines, -39 removed lines

@@ -8,13 +8,13 @@ 
 //(all other times it gets resurrected from a wordpress option)
 $stages = glob(EE_CORE.'data_migration_scripts/4_9_0_stages/*');
 $class_to_filepath = array();
-foreach($stages as $filepath){
+foreach ($stages as $filepath) {
 	$matches = array();
-	preg_match('~4_9_0_stages/(.*).dmsstage.php~',$filepath,$matches);
+	preg_match('~4_9_0_stages/(.*).dmsstage.php~', $filepath, $matches);
 	$class_to_filepath[$matches[1]] = $filepath;
 }
 //give addons a chance to autoload their stages too
-$class_to_filepath = apply_filters('FHEE__EE_DMS_4_9_0__autoloaded_stages',$class_to_filepath);
+$class_to_filepath = apply_filters('FHEE__EE_DMS_4_9_0__autoloaded_stages', $class_to_filepath);
 EEH_Autoloader::register_autoloader($class_to_filepath);
 
 
@@ -30,7 +30,7 @@ 
  * @since                4.6.0
  *
  */
-class EE_DMS_Core_4_9_0 extends EE_Data_Migration_Script_Base{
+class EE_DMS_Core_4_9_0 extends EE_Data_Migration_Script_Base {
 
 	/**
 	 * return EE_DMS_Core_4_9_0
@@ -54,14 +54,14 @@ 
 	 */
 	public function can_migrate_from_version($version_array) {
 		$version_string = $version_array['Core'];
-		if( $version_string <= '4.9.0' && $version_string >= '4.8.0' ){
+		if ($version_string <= '4.9.0' && $version_string >= '4.8.0') {
 //			echo "$version_string can be migrated from";
 			return true;
-		} elseif( ! $version_string ){
+		} elseif ( ! $version_string) {
 //			echo "no version string provided: $version_string";
 			//no version string provided... this must be pre 4.3
-			return false;//changed mind. dont want people thinking they should migrate yet because they cant
-		}else{
+			return false; //changed mind. dont want people thinking they should migrate yet because they cant
+		} else {
 //			echo "$version_string doesnt apply";
 			return false;
 		}
@@ -82,18 +82,18 @@ 
 	 * @return bool
 	 */
 	public function schema_changes_before_migration() {
-		require_once( EE_HELPERS . 'EEH_Activation.helper.php' );
-		$now_in_mysql = current_time( 'mysql', true );
+		require_once(EE_HELPERS.'EEH_Activation.helper.php');
+		$now_in_mysql = current_time('mysql', true);
 
-		$table_name='esp_answer';
-		$sql=" ANS_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$table_name = 'esp_answer';
+		$sql = " ANS_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					REG_ID int(10) unsigned NOT NULL,
 					QST_ID int(10) unsigned NOT NULL,
 					ANS_value text NOT NULL,
 					PRIMARY KEY  (ANS_ID),
 					KEY REG_ID (REG_ID),
 					KEY QST_ID (QST_ID)";
-		$this->_table_has_not_changed_since_previous($table_name,$sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
 		$table_name = 'esp_attendee_meta';
 		$sql = "ATTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
@@ -115,7 +115,7 @@ 
 				KEY ATT_fname (ATT_fname)";
 		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
 
-		$table_name='esp_checkin';
+		$table_name = 'esp_checkin';
 		$sql = "CHK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				REG_ID int(10) unsigned NOT NULL,
 				DTT_ID int(10) unsigned NOT NULL,
@@ -143,7 +143,7 @@ 
 				CNT_is_EU tinyint(1) DEFAULT '0',
 				CNT_active tinyint(1) DEFAULT '0',
 				PRIMARY KEY  (CNT_ISO)";
-		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB' );
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
 		$table_name = 'esp_currency';
 		$sql = "CUR_code varchar(6) collate utf8_bin NOT NULL,
@@ -153,7 +153,7 @@ 
 				CUR_dec_plc varchar(1) collate utf8_bin NOT NULL DEFAULT '2',
 				CUR_active tinyint(1) DEFAULT '0',
 				PRIMARY KEY  (CUR_code)";
-		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB' );
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
 
 		$table_name = 'esp_currency_payment_method';
@@ -181,7 +181,7 @@ 
 				KEY DTT_EVT_start (DTT_EVT_start),
 				KEY EVT_ID (EVT_ID),
 				KEY DTT_is_primary (DTT_is_primary)";
-		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB' );
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 		
 		$table_name = "esp_datetime_ticket";
 		$sql = "DTK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
@@ -199,7 +199,7 @@ 
 				PRIMARY KEY  (EMT_ID),
 				KEY EVT_ID (EVT_ID),
 				KEY GRP_ID (GRP_ID)";
-		$this->_table_has_not_changed_since_previous( $table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
 		$table_name = 'esp_event_meta';
 		$sql = "EVTM_ID int(10) NOT NULL AUTO_INCREMENT,
@@ -217,9 +217,9 @@ 
 				EVT_donations tinyint(1) NULL,
 				PRIMARY KEY  (EVTM_ID),
 				KEY EVT_ID (EVT_ID)";
-		$this->_table_has_not_changed_since_previous($table_name,$sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
-		$table_name='esp_event_question_group';
+		$table_name = 'esp_event_question_group';
 		$sql = "EQG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				QSG_ID int(10) unsigned NOT NULL,
@@ -227,17 +227,17 @@ 
 				PRIMARY KEY  (EQG_ID),
 				KEY EVT_ID (EVT_ID),
 				KEY QSG_ID (QSG_ID)";
-		$this->_table_is_changed_in_this_version($table_name,$sql, 'ENGINE=InnoDB');
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
 
-		$table_name='esp_event_venue';
+		$table_name = 'esp_event_venue';
 		$sql = "EVV_ID int(11) NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				VNU_ID bigint(20) unsigned NOT NULL,
 				EVV_primary tinyint(1) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (EVV_ID)";
-		$this->_table_has_not_changed_since_previous($table_name,$sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
-		$table_name='esp_extra_meta';
+		$table_name = 'esp_extra_meta';
 		$sql = "EXM_ID int(11) NOT NULL AUTO_INCREMENT,
 				OBJ_ID int(11) DEFAULT NULL,
 				EXM_type varchar(45) DEFAULT NULL,
@@ -245,7 +245,7 @@ 
 				EXM_value text,
 				PRIMARY KEY  (EXM_ID),
 				KEY EXM_type (EXM_type,OBJ_ID,EXM_key)";
-		$this->_table_has_not_changed_since_previous($table_name,$sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
 		$table_name = 'esp_extra_join';
 		$sql = "EXJ_ID int(11) NOT NULL AUTO_INCREMENT,
@@ -258,7 +258,7 @@ 
 				KEY second_model (EXJ_second_model_name,EXJ_second_model_id)";
 		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
 
-		$table_name='esp_line_item';
+		$table_name = 'esp_line_item';
 		$sql = "LIN_ID int(11) NOT NULL AUTO_INCREMENT,
 				LIN_code varchar(245) NOT NULL DEFAULT '',
 				TXN_ID int(11) DEFAULT NULL,
@@ -278,7 +278,7 @@ 
 				PRIMARY KEY  (LIN_ID),
 				KEY LIN_code (LIN_code(191)),
 				KEY TXN_ID (TXN_ID)";
-		$this->_table_has_not_changed_since_previous($table_name,$sql, 'ENGINE=InnoDB' );
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
 		$table_name = 'esp_log';
 		$sql = "LOG_ID int(11) NOT NULL AUTO_INCREMENT,
@@ -327,7 +327,7 @@ 
 				KEY STS_ID (STS_ID),
 				KEY MSG_created (MSG_created),
 				KEY MSG_modified (MSG_modified)";
-		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB' );
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
 		
 		$table_name = 'esp_message_template';
 		$sql = "MTP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
@@ -352,7 +352,7 @@ 
 				MTP_is_active tinyint(1) NOT NULL DEFAULT '1',
 				PRIMARY KEY  (GRP_ID),
 				KEY MTP_user_id (MTP_user_id)";
-		$this->_table_has_not_changed_since_previous( $table_name, $sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
 		$table_name = 'esp_payment';
 		$sql = "PAY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
@@ -410,7 +410,7 @@ 
 				PRIMARY KEY  (TTM_ID)";
 		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
-		$table_name='esp_question';
+		$table_name = 'esp_question';
 		$sql = 'QST_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				QST_display_text text NOT NULL,
 				QST_admin_label varchar(255) NOT NULL,
@@ -425,9 +425,9 @@ 
 				QST_deleted tinyint(2) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (QST_ID),
 				KEY QST_order (QST_order)';
-		$this->_table_has_not_changed_since_previous($table_name,$sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
-		$table_name='esp_question_group_question';
+		$table_name = 'esp_question_group_question';
 		$sql = "QGQ_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				QSG_ID int(10) unsigned NOT NULL,
 				QST_ID int(10) unsigned NOT NULL,
@@ -435,9 +435,9 @@ 
 				PRIMARY KEY  (QGQ_ID),
 				KEY QST_ID (QST_ID),
 				KEY QSG_ID_order (QSG_ID,QGQ_order)";
-		$this->_table_has_not_changed_since_previous($table_name,$sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
-		$table_name='esp_question_option';
+		$table_name = 'esp_question_option';
 		$sql = "QSO_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				QSO_value varchar(255) NOT NULL,
 				QSO_desc text NOT NULL,
@@ -448,7 +448,7 @@ 
 				PRIMARY KEY  (QSO_ID),
 				KEY QST_ID (QST_ID),
 				KEY QSO_order (QSO_order)";
-		$this->_table_has_not_changed_since_previous($table_name,$sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
 		$table_name = 'esp_registration';
 		$sql = "REG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
@@ -561,7 +561,7 @@ 
 				PRC_parent int(10) unsigned DEFAULT 0,
 				PRIMARY KEY  (PRC_ID),
 				KEY PRT_ID (PRT_ID)";
-		$this->_table_has_not_changed_since_previous($table_name,$sql, 'ENGINE=InnoDB');
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
 		$table_name = "esp_price_type";
 		$sql = "PRT_ID tinyint(3) unsigned NOT NULL AUTO_INCREMENT,
@@ -598,7 +598,7 @@ 
 				TKT_deleted tinyint(1) NOT NULL DEFAULT '0',
 				PRIMARY KEY  (TKT_ID),
 				KEY TKT_start_date (TKT_start_date)";
-		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB' );
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
 		$table_name = 'esp_question_group';
 		$sql = 'QSG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
@@ -614,7 +614,7 @@ 
 				PRIMARY KEY  (QSG_ID),
 				UNIQUE KEY QSG_identifier_UNIQUE (QSG_identifier),
 				KEY QSG_order (QSG_order)';
-		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB' );
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
 
 		/** @var EE_DMS_Core_4_1_0 $script_4_1_defaults */
 		$script_4_1_defaults = EE_Registry::instance()->load_dms('Core_4_1_0');
@@ -648,5 +648,5 @@ 
 		return true;
 	}
 
-	public function migration_page_hooks(){}
+	public function migration_page_hooks() {}
 }
\ No newline at end of file

core/business/EE_Transaction_Payments.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -161,7 +161,7 @@
 	 * @param EE_Transaction $transaction
 	 * @param string         $payment_status One of EEM_Payment's statuses, like 'PAP' (Approved).
 	 *                                       By default, searches for approved payments
-	 * @return float|false   float on success, false on fail
+	 * @return double   float on success, false on fail
 	 * @throws \EE_Error
 	 */
 	public function recalculate_total_payments_for_transaction( EE_Transaction $transaction, $payment_status = EEM_Payment::status_id_approved ) {

Spacing +55 added lines, -55 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); }
-EE_Registry::instance()->load_class( 'Processor_Base' );
+EE_Registry::instance()->load_class('Processor_Base');
 
 /**
  * Class EE_Transaction_Payments
@@ -44,7 +44,7 @@ 
 	 */
 	public static function instance() {
 		// check if class object is instantiated
-		if ( ! self::$_instance instanceof EE_Transaction_Payments ) {
+		if ( ! self::$_instance instanceof EE_Transaction_Payments) {
 			self::$_instance = new self();
 		}
 		return self::$_instance;
@@ -72,9 +72,9 @@ 
 	/**
 	 * @param string $old_txn_status
 	 */
-	public function set_old_txn_status( $old_txn_status ) {
+	public function set_old_txn_status($old_txn_status) {
 		// only set the first time
-		if ( $this->_old_txn_status === null ) {
+		if ($this->_old_txn_status === null) {
 			$this->_old_txn_status = $old_txn_status;
 		}
 	}
@@ -93,7 +93,7 @@ 
 	/**
 	 * @param string $new_txn_status
 	 */
-	public function set_new_txn_status( $new_txn_status ) {
+	public function set_new_txn_status($new_txn_status) {
 		$this->_new_txn_status = $new_txn_status;
 	}
 
@@ -105,7 +105,7 @@ 
 	 * @return bool
 	 */
 	public function txn_status_updated() {
-		return $this->_new_txn_status !== $this->_old_txn_status && $this->_old_txn_status !== null  ? true : false;
+		return $this->_new_txn_status !== $this->_old_txn_status && $this->_old_txn_status !== null ? true : false;
 	}
 
 
@@ -125,22 +125,22 @@ 
 	 * @return    boolean        whether the TXN was saved
 	 * @throws \EE_Error
 	 */
-	public function calculate_total_payments_and_update_status( EE_Transaction $transaction, $update_txn = true ){
+	public function calculate_total_payments_and_update_status(EE_Transaction $transaction, $update_txn = true) {
 		// verify transaction
-		if ( ! $transaction instanceof EE_Transaction ) {
-			EE_Error::add_error( __( 'Please provide a valid EE_Transaction object.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+		if ( ! $transaction instanceof EE_Transaction) {
+			EE_Error::add_error(__('Please provide a valid EE_Transaction object.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
 		// set incoming TXN_Status
-		$this->set_old_txn_status( $transaction->status_ID() );
+		$this->set_old_txn_status($transaction->status_ID());
 		// calculate total paid
-		$total_paid = $this->recalculate_total_payments_for_transaction( $transaction );
+		$total_paid = $this->recalculate_total_payments_for_transaction($transaction);
 		// if total paid has changed
-		if ( $total_paid !== false && (float)$total_paid !== $transaction->paid() ) {
-			$transaction->set_paid( $total_paid );
+		if ($total_paid !== false && (float) $total_paid !== $transaction->paid()) {
+			$transaction->set_paid($total_paid);
 			// maybe update status, and make sure to save transaction if not done already
-			if ( ! $this->update_transaction_status_based_on_total_paid( $transaction, $update_txn )) {
-				if ( $update_txn ) {
+			if ( ! $this->update_transaction_status_based_on_total_paid($transaction, $update_txn)) {
+				if ($update_txn) {
 					return $transaction->save() ? true : false;
 				}
 			} else {
@@ -164,18 +164,18 @@ 
 	 * @return float|false   float on success, false on fail
 	 * @throws \EE_Error
 	 */
-	public function recalculate_total_payments_for_transaction( EE_Transaction $transaction, $payment_status = EEM_Payment::status_id_approved ) {
+	public function recalculate_total_payments_for_transaction(EE_Transaction $transaction, $payment_status = EEM_Payment::status_id_approved) {
 		// verify transaction
-		if ( ! $transaction instanceof EE_Transaction ) {
-			EE_Error::add_error( __( 'Please provide a valid EE_Transaction object.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+		if ( ! $transaction instanceof EE_Transaction) {
+			EE_Error::add_error(__('Please provide a valid EE_Transaction object.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
 		// ensure Payment model is loaded
-		EE_Registry::instance()->load_model( 'Payment' );
+		EE_Registry::instance()->load_model('Payment');
 		// calls EEM_Base::sum()
 		return EEM_Payment::instance()->sum(
 			// query params
-			array( array( 'TXN_ID' => $transaction->ID(), 'STS_ID' => $payment_status )),
+			array(array('TXN_ID' => $transaction->ID(), 'STS_ID' => $payment_status)),
 			// field to sum
 			'PAY_amount'
 		);
@@ -191,36 +191,36 @@ 
 	 * @return 	boolean 	 	whether the TXN was saved
 	 * @throws \EE_Error
 	 */
-	public function update_transaction_status_based_on_total_paid( EE_Transaction $transaction, $update_txn = TRUE ) {
+	public function update_transaction_status_based_on_total_paid(EE_Transaction $transaction, $update_txn = TRUE) {
 		// verify transaction
-		if ( ! $transaction instanceof EE_Transaction ) {
+		if ( ! $transaction instanceof EE_Transaction) {
 			EE_Error::add_error(
-				__( 'Please provide a valid EE_Transaction object.', 'event_espresso' ),
+				__('Please provide a valid EE_Transaction object.', 'event_espresso'),
 				__FILE__, __FUNCTION__, __LINE__
 			);
 			return FALSE;
 		}
 		// set incoming TXN_Status
-		$this->set_old_txn_status( $transaction->status_ID() );
+		$this->set_old_txn_status($transaction->status_ID());
 		// set transaction status based on comparison of TXN_paid vs TXN_total
-		if ( EEH_Money::compare_floats( $transaction->paid(), $transaction->total(), '>' ) ){
+		if (EEH_Money::compare_floats($transaction->paid(), $transaction->total(), '>')) {
 			$new_txn_status = EEM_Transaction::overpaid_status_code;
-		} else if ( EEH_Money::compare_floats( $transaction->paid(), $transaction->total() ) ) {
+		} else if (EEH_Money::compare_floats($transaction->paid(), $transaction->total())) {
 			$new_txn_status = EEM_Transaction::complete_status_code;
-		} else if ( EEH_Money::compare_floats( $transaction->paid(), $transaction->total(), '<' ) ) {
+		} else if (EEH_Money::compare_floats($transaction->paid(), $transaction->total(), '<')) {
 			$new_txn_status = EEM_Transaction::incomplete_status_code;
 		} else {
 			EE_Error::add_error(
-				__( 'The total paid calculation for this transaction is inaccurate.', 'event_espresso' ),
+				__('The total paid calculation for this transaction is inaccurate.', 'event_espresso'),
 				__FILE__, __FUNCTION__, __LINE__
 			);
 			return FALSE;
 		}
-		if ( $new_txn_status !== $transaction->status_ID() ) {
+		if ($new_txn_status !== $transaction->status_ID()) {
 			// set incoming TXN_Status
-			$this->set_new_txn_status( $new_txn_status );
-			$transaction->set_status( $new_txn_status );
-			if ( $update_txn ) {
+			$this->set_new_txn_status($new_txn_status);
+			$transaction->set_status($new_txn_status);
+			if ($update_txn) {
 				return $transaction->save() ? TRUE : FALSE;
 			}
 		}
@@ -238,17 +238,17 @@ 
 	 * @return boolean
 	 * @throws \EE_Error
 	 */
-	public function delete_payment_and_update_transaction( EE_Payment $payment ) {
+	public function delete_payment_and_update_transaction(EE_Payment $payment) {
 		// verify payment
-		if ( ! $payment instanceof EE_Payment ) {
-			EE_Error::add_error( __( 'A valid Payment object was not received.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+		if ( ! $payment instanceof EE_Payment) {
+			EE_Error::add_error(__('A valid Payment object was not received.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
-		if ( ! $this->delete_registration_payments_and_update_registrations( $payment ) ) {
+		if ( ! $this->delete_registration_payments_and_update_registrations($payment)) {
 			return false;
 		}
-		if ( ! $payment->delete() ) {
-			EE_Error::add_error( __( 'The payment could not be deleted.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+		if ( ! $payment->delete()) {
+			EE_Error::add_error(__('The payment could not be deleted.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
 
@@ -259,14 +259,14 @@ 
 			|| $TXN_status === EEM_Transaction::failed_status_code
 			|| $payment->amount() === 0
 		) {
-			EE_Error::add_success( __( 'The Payment was successfully deleted.', 'event_espresso' ) );
+			EE_Error::add_success(__('The Payment was successfully deleted.', 'event_espresso'));
 			return true;
 		}
 
 
 		//if this fails, that just means that the transaction didn't get its status changed and/or updated.
 		//however the payment was still deleted.
-		if ( ! $this->calculate_total_payments_and_update_status( $transaction ) ) {
+		if ( ! $this->calculate_total_payments_and_update_status($transaction)) {
 
 			EE_Error::add_attention(
 				__(
@@ -300,28 +300,28 @@ 
 	 * @return bool
 	 * @throws \EE_Error
 	 */
-	public function delete_registration_payments_and_update_registrations( EE_Payment $payment, $reg_payment_query_params = array() ) {
+	public function delete_registration_payments_and_update_registrations(EE_Payment $payment, $reg_payment_query_params = array()) {
 		$save_payment = false;
-		$reg_payment_query_params = ! empty( $reg_payment_query_params ) ? $reg_payment_query_params : array( array( 'PAY_ID' => $payment->ID() ) );
-		$registration_payments = EEM_Registration_Payment::instance()->get_all( $reg_payment_query_params );
-		if ( ! empty( $registration_payments )) {
-			foreach ( $registration_payments as $registration_payment ) {
-				if ( $registration_payment instanceof EE_Registration_Payment ) {
+		$reg_payment_query_params = ! empty($reg_payment_query_params) ? $reg_payment_query_params : array(array('PAY_ID' => $payment->ID()));
+		$registration_payments = EEM_Registration_Payment::instance()->get_all($reg_payment_query_params);
+		if ( ! empty($registration_payments)) {
+			foreach ($registration_payments as $registration_payment) {
+				if ($registration_payment instanceof EE_Registration_Payment) {
 					$amount_paid = $registration_payment->amount();
 					$registration = $registration_payment->registration();
-					if ( $registration instanceof EE_Registration ) {
-						$registration->set_paid( $registration->paid() - $amount_paid );
-						if ( $registration->save() ) {
-							if ( $registration_payment->delete() ) {
-								$registration->_remove_relation_to( $payment, 'Payment' );
-								$payment->_remove_relation_to( $registration, 'Registration' );
+					if ($registration instanceof EE_Registration) {
+						$registration->set_paid($registration->paid() - $amount_paid);
+						if ($registration->save()) {
+							if ($registration_payment->delete()) {
+								$registration->_remove_relation_to($payment, 'Payment');
+								$payment->_remove_relation_to($registration, 'Registration');
 							}
 							$save_payment = true;
 						}
 					} else {
 						EE_Error::add_error(
 							sprintf(
-								__( 'An invalid Registration object was associated with Registration Payment ID# %1$d.', 'event_espresso' ),
+								__('An invalid Registration object was associated with Registration Payment ID# %1$d.', 'event_espresso'),
 								$registration_payment->ID()
 							),
 							__FILE__, __FUNCTION__, __LINE__
@@ -331,7 +331,7 @@ 
 				} else {
 					EE_Error::add_error(
 						sprintf(
-							__( 'An invalid Registration Payment object was associated with payment ID# %1$d.', 'event_espresso' ),
+							__('An invalid Registration Payment object was associated with payment ID# %1$d.', 'event_espresso'),
 							$payment->ID()
 						),
 						__FILE__, __FUNCTION__, __LINE__
@@ -340,7 +340,7 @@ 
 				}
 			}
 		}
-		if ( $save_payment ) {
+		if ($save_payment) {
 			$payment->save();
 		}
 		return true;

core/db_classes/EE_CPT_Base.class.php

Doc Comments +8 added lines, -8 removed lines

@@ -130,7 +130,7 @@ 
 	 *
 	 * @link   http://codex.wordpress.org/Function_Reference/get_the_post_thumbnail
 	 * @access protected
-	 * @param string|array $size (optional) Image size. Defaults to 'post-thumbnail' but can also be a 2-item array representing width and height in pixels (i.e. array(32,32) ).
+	 * @param string $size (optional) Image size. Defaults to 'post-thumbnail' but can also be a 2-item array representing width and height in pixels (i.e. array(32,32) ).
 	 * @param string|array $attr Optional. Query string or array of attributes.
 	 * @return string HTML image element
 	 */
@@ -158,7 +158,7 @@ 
 
 	/**
 	 * This uses the wp "wp_get_attachment_image_src()" function to return the feature image for the current class using the given size params.
-	 * @param  string|array $size can either be a string: 'thumbnail', 'medium', 'large', 'full' OR 2-item array representing width and height in pixels eg. array(32,32).
+	 * @param  integer[] $size can either be a string: 'thumbnail', 'medium', 'large', 'full' OR 2-item array representing width and height in pixels eg. array(32,32).
 	 * @return string|boolean          the url of the image or false if not found
 	 */
 	public function feature_image_url( $size = 'thumbnail' ) {
@@ -172,7 +172,7 @@ 
 	 * This is a method for restoring this_obj using details from the given $revision_id
 	 *
 	 * @param int $revision_id 		ID of the revision we're getting data from
-	 * @param array $related_obj_names if included this will be used to restore for related obj
+	 * @param string[] $related_obj_names if included this will be used to restore for related obj
 	 *                                 if not included then we just do restore on the meta.
 	 *                                 We will accept an array of related_obj_names for restoration here.
 	 * @param array $where_query       You can optionally include an array of key=>value pairs
@@ -227,7 +227,7 @@ 
 	 * Wrapper for get_post_meta, http://codex.wordpress.org/Function_Reference/get_post_meta
 	 * @param string  $meta_key
 	 * @param boolean $single
-	 * @return mixed <ul><li>If only $id is set it will return all meta values in an associative array.</li>
+	 * @return string|null <ul><li>If only $id is set it will return all meta values in an associative array.</li>
 	 * <li>If $single is set to false, or left blank, the function returns an array containing all values of the specified key.</li>
 	 * <li>If $single is set to true, the function returns the first value of the specified key (not in an array</li></ul>
 	 */
@@ -255,8 +255,8 @@ 
 
 	/**
 	 * Wrapper for add_post_meta, http://codex.wordpress.org/Function_Reference/add_post_meta
-	 * @param mixed $meta_key
-	 * @param mixed $meta_value
+	 * @param string $meta_key
+	 * @param string $meta_value
 	 * @param bool  $unique . If postmeta for this $meta_key already exists, whether to add an additional item or not
 	 * @return boolean Boolean true, except if the $unique argument was set to true and a custom field with the given key already exists, in which case false is returned.
 	 */
@@ -272,7 +272,7 @@ 
 	/**
 	 * Wrapper for delete_post_meta, http://codex.wordpress.org/Function_Reference/delete_post_meta
 	 *
-	 * @param mixed $meta_key
+	 * @param string $meta_key
 	 * @param mixed $meta_value
 	 * @return boolean False for failure. True for success.
 	 */
@@ -300,7 +300,7 @@ 
 	/**
 	 * Gets all the term-taxonomies for this CPT
 	 * @param array $query_params
-	 * @return EE_Term_Taxonomy
+	 * @return EE_Base_Class[]
 	 */
 	public function term_taxonomies( $query_params = array() ) {
 		return $this->get_many_related( 'Term_Taxonomy', $query_params );

Spacing +56 added lines, -56 removed lines

@@ -1,5 +1,5 @@ 
-<?php if ( !defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 /**
  * Event Espresso
@@ -47,8 +47,8 @@ 
 	 * @param int    $parent_term_taxonomy_id optional
 	 * @return EE_Term_Taxonomy
 	 */
-	function add_event_category( $category_name, $category_description = NULL, $parent_term_taxonomy_id = NULL ) {
-		return $this->get_model()->add_event_category( $this, $category_name, $category_description, $parent_term_taxonomy_id );
+	function add_event_category($category_name, $category_description = NULL, $parent_term_taxonomy_id = NULL) {
+		return $this->get_model()->add_event_category($this, $category_name, $category_description, $parent_term_taxonomy_id);
 	}
 
 
@@ -58,8 +58,8 @@ 
 	 * @param string $category_name
 	 * @return bool
 	 */
-	function remove_event_category( $category_name ) {
-		return $this->get_model()->remove_event_category( $this, $category_name );
+	function remove_event_category($category_name) {
+		return $this->get_model()->remove_event_category($this, $category_name);
 	}
 
 
@@ -70,14 +70,14 @@ 
 	 * @param EE_Term_Taxonomy $term_taxonomy
 	 * @return EE_Base_Class the relation was removed from
 	 */
-	function remove_relation_to_term_taxonomy( $term_taxonomy ) {
-		if ( !$term_taxonomy ) {
-			EE_Error::add_error( sprintf( __( "No Term_Taxonomy provided which to remove from model object of type %s and id %d", "event_espresso" ), get_class( $this ), $this->ID() ), __FILE__, __FUNCTION__, __LINE__ );
+	function remove_relation_to_term_taxonomy($term_taxonomy) {
+		if ( ! $term_taxonomy) {
+			EE_Error::add_error(sprintf(__("No Term_Taxonomy provided which to remove from model object of type %s and id %d", "event_espresso"), get_class($this), $this->ID()), __FILE__, __FUNCTION__, __LINE__);
 			return NULL;
 		}
-		$term_taxonomy->set_count( $term_taxonomy->count() - 1 );
+		$term_taxonomy->set_count($term_taxonomy->count() - 1);
 		$term_taxonomy->save();
-		return $this->_remove_relation_to( $term_taxonomy, 'Term_Taxonomy' );
+		return $this->_remove_relation_to($term_taxonomy, 'Term_Taxonomy');
 	}
 
 
@@ -101,7 +101,7 @@ 
 	 * @return int
 	 */
 	public function parent() {
-		return $this->get( 'parent' );
+		return $this->get('parent');
 	}
 
 
@@ -111,7 +111,7 @@ 
 	 * @return string
 	 */
 	public function status() {
-		return $this->get( 'status' );
+		return $this->get('status');
 	}
 
 
@@ -119,8 +119,8 @@ 
 	/**
 	 * @param string $status
 	 */
-	public function set_status( $status ) {
-		$this->set( 'status', $status );
+	public function set_status($status) {
+		$this->set('status', $status);
 	}
 
 
@@ -134,12 +134,12 @@ 
 	 * @param string|array $attr Optional. Query string or array of attributes.
 	 * @return string HTML image element
 	 */
-	protected function _get_feature_image( $size, $attr ) {
+	protected function _get_feature_image($size, $attr) {
 		//first let's see if we already have the _feature_image property set AND if it has a cached element on it FOR the given size
-		$attr_key = is_array( $attr ) ? implode( '_', $attr ) : $attr;
-		$cache_key = is_array( $size ) ? implode( '_', $size ) . $attr_key : $size . $attr_key;
-		$this->_feature_image[ $cache_key ] = isset( $this->_feature_image[ $cache_key ] ) ? $this->_feature_image[ $cache_key ] : $this->get_model()->get_feature_image( $this->ID(), $size, $attr );
-		return $this->_feature_image[ $cache_key ];
+		$attr_key = is_array($attr) ? implode('_', $attr) : $attr;
+		$cache_key = is_array($size) ? implode('_', $size).$attr_key : $size.$attr_key;
+		$this->_feature_image[$cache_key] = isset($this->_feature_image[$cache_key]) ? $this->_feature_image[$cache_key] : $this->get_model()->get_feature_image($this->ID(), $size, $attr);
+		return $this->_feature_image[$cache_key];
 	}
 
 
@@ -150,8 +150,8 @@ 
 	 * @param string|array $attr
 	 * @return string of html
 	 */
-	public function feature_image( $size = 'thumbnail', $attr = '' ) {
-		return $this->_get_feature_image( $size, $attr );
+	public function feature_image($size = 'thumbnail', $attr = '') {
+		return $this->_get_feature_image($size, $attr);
 	}
 
 
@@ -161,9 +161,9 @@ 
 	 * @param  string|array $size can either be a string: 'thumbnail', 'medium', 'large', 'full' OR 2-item array representing width and height in pixels eg. array(32,32).
 	 * @return string|boolean          the url of the image or false if not found
 	 */
-	public function feature_image_url( $size = 'thumbnail' ) {
-		$attachment = wp_get_attachment_image_src( get_post_thumbnail_id( $this->ID() ), $size );
-		return !empty( $attachment ) ? $attachment[ 0 ] : FALSE;
+	public function feature_image_url($size = 'thumbnail') {
+		$attachment = wp_get_attachment_image_src(get_post_thumbnail_id($this->ID()), $size);
+		return ! empty($attachment) ? $attachment[0] : FALSE;
 	}
 
 
@@ -185,36 +185,36 @@ 
 	 *                                 This array is INDEXED by RELATED OBJ NAME (so it corresponds with the obj_names sent);
 	 * @return void
 	 */
-	public function restore_revision( $revision_id, $related_obj_names = array(), $where_query = array() ) {
+	public function restore_revision($revision_id, $related_obj_names = array(), $where_query = array()) {
 		//get revision object
-		$revision_obj = $this->get_model()->get_one_by_ID( $revision_id );
-		if ( $revision_obj instanceof EE_CPT_Base ) {
+		$revision_obj = $this->get_model()->get_one_by_ID($revision_id);
+		if ($revision_obj instanceof EE_CPT_Base) {
 			//no related_obj_name so we assume we're saving a revision on this object.
-			if ( empty( $related_obj_names ) ) {
+			if (empty($related_obj_names)) {
 				$fields = $this->get_model()->get_meta_table_fields();
-				foreach ( $fields as $field ) {
-					$this->set( $field, $revision_obj->get( $field ) );
+				foreach ($fields as $field) {
+					$this->set($field, $revision_obj->get($field));
 				}
 				$this->save();
 			}
-			$related_obj_names = (array)$related_obj_names;
-			foreach ( $related_obj_names as $related_name ) {
+			$related_obj_names = (array) $related_obj_names;
+			foreach ($related_obj_names as $related_name) {
 				//related_obj_name so we're saving a revision on an object related to this object
 				//do we have $where_query params for this related object?  If we do then we include that.
-				$cols_n_values = isset( $where_query[ $related_name ] ) ? $where_query[ $related_name ] : array();
-				$where_params = !empty( $cols_n_values ) ? array( $cols_n_values ) : array();
-				$related_objs = $this->get_many_related( $related_name, $where_params );
-				$revision_related_objs = $revision_obj->get_many_related( $related_name, $where_params );
+				$cols_n_values = isset($where_query[$related_name]) ? $where_query[$related_name] : array();
+				$where_params = ! empty($cols_n_values) ? array($cols_n_values) : array();
+				$related_objs = $this->get_many_related($related_name, $where_params);
+				$revision_related_objs = $revision_obj->get_many_related($related_name, $where_params);
 				//load helper
 				//remove related objs from this object that are not in revision
 				//array_diff *should* work cause I think objects are indexed by ID?
-				$related_to_remove = EEH_Array::object_array_diff( $related_objs, $revision_related_objs );
-				foreach ( $related_to_remove as $rr ) {
-					$this->_remove_relation_to( $rr, $related_name, $cols_n_values );
+				$related_to_remove = EEH_Array::object_array_diff($related_objs, $revision_related_objs);
+				foreach ($related_to_remove as $rr) {
+					$this->_remove_relation_to($rr, $related_name, $cols_n_values);
 				}
 				//add all related objs attached to revision to this object
-				foreach ( $revision_related_objs as $r_obj ) {
-					$this->_add_relation_to( $r_obj, $related_name, $cols_n_values );
+				foreach ($revision_related_objs as $r_obj) {
+					$this->_add_relation_to($r_obj, $related_name, $cols_n_values);
 				}
 			}
 		}
@@ -230,8 +230,8 @@ 
 	 * <li>If $single is set to false, or left blank, the function returns an array containing all values of the specified key.</li>
 	 * <li>If $single is set to true, the function returns the first value of the specified key (not in an array</li></ul>
 	 */
-	public function get_post_meta( $meta_key = NULL, $single = FALSE ) {
-		return get_post_meta( $this->ID(), $meta_key, $single );
+	public function get_post_meta($meta_key = NULL, $single = FALSE) {
+		return get_post_meta($this->ID(), $meta_key, $single);
 	}
 
 
@@ -243,11 +243,11 @@ 
 	 * @param mixed  $prev_value
 	 * @return mixed Returns meta_id if the meta doesn't exist, otherwise returns true on success and false on failure. NOTE: If the meta_value passed to this function is the same as the value that is already in the database, this function returns false.
 	 */
-	public function update_post_meta( $meta_key, $meta_value, $prev_value = NULL ) {
-		if ( ! $this->ID() ) {
+	public function update_post_meta($meta_key, $meta_value, $prev_value = NULL) {
+		if ( ! $this->ID()) {
 			$this->save();
 		}
-		return update_post_meta( $this->ID(), $meta_key, $meta_value, $prev_value );
+		return update_post_meta($this->ID(), $meta_key, $meta_value, $prev_value);
 	}
 
 
@@ -259,11 +259,11 @@ 
 	 * @param bool  $unique . If postmeta for this $meta_key already exists, whether to add an additional item or not
 	 * @return boolean Boolean true, except if the $unique argument was set to true and a custom field with the given key already exists, in which case false is returned.
 	 */
-	public function add_post_meta( $meta_key, $meta_value, $unique = FALSE ) {
-		if ( $this->ID() ) {
+	public function add_post_meta($meta_key, $meta_value, $unique = FALSE) {
+		if ($this->ID()) {
 			$this->save();
 		}
-		return add_post_meta( $this->ID(), $meta_key, $meta_value, $unique );
+		return add_post_meta($this->ID(), $meta_key, $meta_value, $unique);
 	}
 
 
@@ -275,13 +275,13 @@ 
 	 * @param mixed $meta_value
 	 * @return boolean False for failure. True for success.
 	 */
-	public function delete_post_meta( $meta_key, $meta_value = '' ) {
-		if ( ! $this->ID() ) {
+	public function delete_post_meta($meta_key, $meta_value = '') {
+		if ( ! $this->ID()) {
 			//there are obviously no postmetas for this if it's not saved
 			//so let's just report this as a success
 			return true;
 		}
-		return delete_post_meta( $this->ID(), $meta_key, $meta_value );
+		return delete_post_meta($this->ID(), $meta_key, $meta_value);
 	}
 
 
@@ -291,7 +291,7 @@ 
 	 * @return string
 	 */
 	public function get_permalink() {
-		return get_permalink( $this->ID() );
+		return get_permalink($this->ID());
 	}
 
 
@@ -301,8 +301,8 @@ 
 	 * @param array $query_params
 	 * @return EE_Term_Taxonomy
 	 */
-	public function term_taxonomies( $query_params = array() ) {
-		return $this->get_many_related( 'Term_Taxonomy', $query_params );
+	public function term_taxonomies($query_params = array()) {
+		return $this->get_many_related('Term_Taxonomy', $query_params);
 	}
 
 

core/db_classes/EE_Line_Item.class.php

Doc Comments +13 added lines, -13 removed lines

@@ -107,7 +107,7 @@ 
 	/**
 	 * Sets TXN_ID
 	 * @param int $TXN_ID
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	function set_TXN_ID( $TXN_ID ) {
 		$this->set( 'TXN_ID', $TXN_ID );
@@ -132,7 +132,7 @@ 
 	/**
 	 * Sets name
 	 * @param string $name
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	function set_name( $name ) {
 		$this->set( 'LIN_name', $name );
@@ -153,7 +153,7 @@ 
 	/**
 	 * Sets desc
 	 * @param string $desc
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	function set_desc( $desc ) {
 		$this->set( 'LIN_desc', $desc );
@@ -174,7 +174,7 @@ 
 	/**
 	 * Sets quantity
 	 * @param int $quantity
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	function set_quantity( $quantity ) {
 		$this->set( 'LIN_quantity', $quantity );
@@ -195,7 +195,7 @@ 
 	/**
 	 * Sets item_id
 	 * @param string $item_id
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	function set_OBJ_ID( $item_id ) {
 		$this->set( 'OBJ_ID', $item_id );
@@ -216,7 +216,7 @@ 
 	/**
 	 * Sets item_type
 	 * @param string $OBJ_type
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	function set_OBJ_type( $OBJ_type ) {
 		$this->set( 'OBJ_type', $OBJ_type );
@@ -237,7 +237,7 @@ 
 	/**
 	 * Sets unit_price
 	 * @param float $unit_price
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	function set_unit_price( $unit_price ) {
 		$this->set( 'LIN_unit_price', $unit_price );
@@ -285,7 +285,7 @@ 
 	/**
 	 * Sets percent (between 100-0.01)
 	 * @param float $percent
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	function set_percent( $percent ) {
 		$this->set( 'LIN_percent', $percent );
@@ -306,7 +306,7 @@ 
 	/**
 	 * Sets total
 	 * @param float $total
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	function set_total( $total ) {
 		$this->set( 'LIN_total', $total );
@@ -347,7 +347,7 @@ 
 	/**
 	 * Sets parent
 	 * @param int $parent
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	function set_parent_ID( $parent ) {
 		$this->set( 'LIN_parent', $parent );
@@ -368,7 +368,7 @@ 
 	/**
 	 * Sets type
 	 * @param string $type
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	function set_type( $type ) {
 		$this->set( 'LIN_type', $type );
@@ -426,7 +426,7 @@ 
 	/**
 	 * Sets code
 	 * @param string $code
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	function set_code( $code ) {
 		$this->set( 'LIN_code', $code );
@@ -447,7 +447,7 @@ 
 	/**
 	 * Sets is_taxable
 	 * @param boolean $is_taxable
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	function set_is_taxable( $is_taxable ) {
 		$this->set( 'LIN_is_taxable', $is_taxable );

Spacing +211 added lines, -211 removed lines

@@ -1,5 +1,5 @@ 
-<?php if ( !defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 /**
  * Event Espresso
@@ -50,9 +50,9 @@ 
 	 *                             		    date_format and the second value is the time format
 	 * @return EE_Line_Item
 	 */
-	public static function new_instance( $props_n_values = array(), $timezone = null, $date_formats = array() ) {
-		$has_object = parent::_check_for_object( $props_n_values, __CLASS__, $timezone, $date_formats );
-		return $has_object ? $has_object : new self( $props_n_values, false, $timezone, $date_formats );
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) {
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
 	}
 
 
@@ -63,8 +63,8 @@ 
 	 *                          		the website will be used.
 	 * @return EE_Line_Item
 	 */
-	public static function new_instance_from_db( $props_n_values = array(), $timezone = null ) {
-		return new self( $props_n_values, TRUE, $timezone );
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null) {
+		return new self($props_n_values, TRUE, $timezone);
 	}
 
 
@@ -75,10 +75,10 @@ 
 	 * @param bool   $bydb
 	 * @param string $timezone
 	 */
-	protected function __construct( $fieldValues = array(), $bydb = FALSE, $timezone = '' ) {
-		parent::__construct( $fieldValues, $bydb, $timezone );
-		if ( ! $this->get( 'LIN_code' ) ) {
-			$this->set_code( $this->generate_code() );
+	protected function __construct($fieldValues = array(), $bydb = FALSE, $timezone = '') {
+		parent::__construct($fieldValues, $bydb, $timezone);
+		if ( ! $this->get('LIN_code')) {
+			$this->set_code($this->generate_code());
 		}
 	}
 
@@ -89,7 +89,7 @@ 
 	 * @return int
 	 */
 	function ID() {
-		return $this->get( 'LIN_ID' );
+		return $this->get('LIN_ID');
 	}
 
 
@@ -99,7 +99,7 @@ 
 	 * @return int
 	 */
 	function TXN_ID() {
-		return $this->get( 'TXN_ID' );
+		return $this->get('TXN_ID');
 	}
 
 
@@ -109,8 +109,8 @@ 
 	 * @param int $TXN_ID
 	 * @return boolean
 	 */
-	function set_TXN_ID( $TXN_ID ) {
-		$this->set( 'TXN_ID', $TXN_ID );
+	function set_TXN_ID($TXN_ID) {
+		$this->set('TXN_ID', $TXN_ID);
 	}
 
 
@@ -120,9 +120,9 @@ 
 	 * @return string
 	 */
 	function name() {
-		$name =  $this->get( 'LIN_name' );
-		if( ! $name ){
-			$name = ucwords( str_replace( '-', ' ', $this->type() ) );
+		$name = $this->get('LIN_name');
+		if ( ! $name) {
+			$name = ucwords(str_replace('-', ' ', $this->type()));
 		}
 		return $name;
 	}
@@ -134,8 +134,8 @@ 
 	 * @param string $name
 	 * @return boolean
 	 */
-	function set_name( $name ) {
-		$this->set( 'LIN_name', $name );
+	function set_name($name) {
+		$this->set('LIN_name', $name);
 	}
 
 
@@ -145,7 +145,7 @@ 
 	 * @return string
 	 */
 	function desc() {
-		return $this->get( 'LIN_desc' );
+		return $this->get('LIN_desc');
 	}
 
 
@@ -155,8 +155,8 @@ 
 	 * @param string $desc
 	 * @return boolean
 	 */
-	function set_desc( $desc ) {
-		$this->set( 'LIN_desc', $desc );
+	function set_desc($desc) {
+		$this->set('LIN_desc', $desc);
 	}
 
 
@@ -166,7 +166,7 @@ 
 	 * @return int
 	 */
 	function quantity() {
-		return $this->get( 'LIN_quantity' );
+		return $this->get('LIN_quantity');
 	}
 
 
@@ -176,8 +176,8 @@ 
 	 * @param int $quantity
 	 * @return boolean
 	 */
-	function set_quantity( $quantity ) {
-		$this->set( 'LIN_quantity', $quantity );
+	function set_quantity($quantity) {
+		$this->set('LIN_quantity', $quantity);
 	}
 
 
@@ -187,7 +187,7 @@ 
 	 * @return string
 	 */
 	function OBJ_ID() {
-		return $this->get( 'OBJ_ID' );
+		return $this->get('OBJ_ID');
 	}
 
 
@@ -197,8 +197,8 @@ 
 	 * @param string $item_id
 	 * @return boolean
 	 */
-	function set_OBJ_ID( $item_id ) {
-		$this->set( 'OBJ_ID', $item_id );
+	function set_OBJ_ID($item_id) {
+		$this->set('OBJ_ID', $item_id);
 	}
 
 
@@ -208,7 +208,7 @@ 
 	 * @return string
 	 */
 	function OBJ_type() {
-		return $this->get( 'OBJ_type' );
+		return $this->get('OBJ_type');
 	}
 
 
@@ -218,8 +218,8 @@ 
 	 * @param string $OBJ_type
 	 * @return boolean
 	 */
-	function set_OBJ_type( $OBJ_type ) {
-		$this->set( 'OBJ_type', $OBJ_type );
+	function set_OBJ_type($OBJ_type) {
+		$this->set('OBJ_type', $OBJ_type);
 	}
 
 
@@ -229,7 +229,7 @@ 
 	 * @return float
 	 */
 	function unit_price() {
-		return $this->get( 'LIN_unit_price' );
+		return $this->get('LIN_unit_price');
 	}
 
 
@@ -239,8 +239,8 @@ 
 	 * @param float $unit_price
 	 * @return boolean
 	 */
-	function set_unit_price( $unit_price ) {
-		$this->set( 'LIN_unit_price', $unit_price );
+	function set_unit_price($unit_price) {
+		$this->set('LIN_unit_price', $unit_price);
 	}
 
 
@@ -251,19 +251,19 @@ 
 	 * @return boolean
 	 */
 	function is_percent() {
-		if( $this->is_tax_sub_total() ) {
+		if ($this->is_tax_sub_total()) {
 			//tax subtotals HAVE a percent on them, that percentage only applies
 			//to taxable items, so its' an exception. Treat it like a flat line item
 			return false;
 		}
-		$unit_price = abs( $this->get( 'LIN_unit_price' ) );
-		$percent = abs( $this->get( 'LIN_percent' ) );
-		if ( $unit_price < .001 && $percent ) {
+		$unit_price = abs($this->get('LIN_unit_price'));
+		$percent = abs($this->get('LIN_percent'));
+		if ($unit_price < .001 && $percent) {
 			return TRUE;
-		} elseif ( $unit_price >= .001 && !$percent ) {
+		} elseif ($unit_price >= .001 && ! $percent) {
 			return FALSE;
-		} elseif ( $unit_price >= .001 && $percent ) {
-			throw new EE_Error( sprintf( __( "A Line Item can not have a unit price of (%s) AND a percent (%s)!", "event_espresso" ), $unit_price, $percent ) );
+		} elseif ($unit_price >= .001 && $percent) {
+			throw new EE_Error(sprintf(__("A Line Item can not have a unit price of (%s) AND a percent (%s)!", "event_espresso"), $unit_price, $percent));
 		} else {
 			// if they're both 0, assume its not a percent item
 			return FALSE;
@@ -277,7 +277,7 @@ 
 	 * @return float
 	 */
 	function percent() {
-		return $this->get( 'LIN_percent' );
+		return $this->get('LIN_percent');
 	}
 
 
@@ -287,8 +287,8 @@ 
 	 * @param float $percent
 	 * @return boolean
 	 */
-	function set_percent( $percent ) {
-		$this->set( 'LIN_percent', $percent );
+	function set_percent($percent) {
+		$this->set('LIN_percent', $percent);
 	}
 
 
@@ -298,7 +298,7 @@ 
 	 * @return float
 	 */
 	function total() {
-		return $this->get( 'LIN_total' );
+		return $this->get('LIN_total');
 	}
 
 
@@ -308,8 +308,8 @@ 
 	 * @param float $total
 	 * @return boolean
 	 */
-	function set_total( $total ) {
-		$this->set( 'LIN_total', $total );
+	function set_total($total) {
+		$this->set('LIN_total', $total);
 	}
 
 
@@ -319,7 +319,7 @@ 
 	 * @return int
 	 */
 	function order() {
-		return $this->get( 'LIN_order' );
+		return $this->get('LIN_order');
 	}
 
 
@@ -328,8 +328,8 @@ 
 	 * Sets order
 	 * @param int $order
 	 */
-	function set_order( $order ) {
-		$this->set( 'LIN_order', $order );
+	function set_order($order) {
+		$this->set('LIN_order', $order);
 	}
 
 
@@ -339,7 +339,7 @@ 
 	 * @return int
 	 */
 	function parent_ID() {
-		return $this->get( 'LIN_parent' );
+		return $this->get('LIN_parent');
 	}
 
 
@@ -349,8 +349,8 @@ 
 	 * @param int $parent
 	 * @return boolean
 	 */
-	function set_parent_ID( $parent ) {
-		$this->set( 'LIN_parent', $parent );
+	function set_parent_ID($parent) {
+		$this->set('LIN_parent', $parent);
 	}
 
 
@@ -360,7 +360,7 @@ 
 	 * @return string
 	 */
 	function type() {
-		return $this->get( 'LIN_type' );
+		return $this->get('LIN_type');
 	}
 
 
@@ -370,8 +370,8 @@ 
 	 * @param string $type
 	 * @return boolean
 	 */
-	function set_type( $type ) {
-		$this->set( 'LIN_type', $type );
+	function set_type($type) {
+		$this->set('LIN_type', $type);
 	}
 
 
@@ -384,8 +384,8 @@ 
 	 * @return EE_Line_Item
 	 */
 	public function parent() {
-		if( $this->ID() ) {
-			return $this->get_model()->get_one_by_ID( $this->parent_ID() );
+		if ($this->ID()) {
+			return $this->get_model()->get_one_by_ID($this->parent_ID());
 		} else {
 			return $this->_parent;
 		}
@@ -398,13 +398,13 @@ 
 	 * @return EE_Line_Item[]
 	 */
 	public function children() {
-		if ( $this->ID() ) {
+		if ($this->ID()) {
 			return $this->get_model()->get_all(
 					array(
-						array( 'LIN_parent' => $this->ID() ),
-						'order_by' => array( 'LIN_order' => 'ASC' ) ) );
+						array('LIN_parent' => $this->ID()),
+						'order_by' => array('LIN_order' => 'ASC') ) );
 		} else {
-			if ( ! is_array( $this->_children ) ) {
+			if ( ! is_array($this->_children)) {
 				$this->_children = array();
 			}
 			return $this->_children;
@@ -418,7 +418,7 @@ 
 	 * @return string
 	 */
 	function code() {
-		return $this->get( 'LIN_code' );
+		return $this->get('LIN_code');
 	}
 
 
@@ -428,8 +428,8 @@ 
 	 * @param string $code
 	 * @return boolean
 	 */
-	function set_code( $code ) {
-		$this->set( 'LIN_code', $code );
+	function set_code($code) {
+		$this->set('LIN_code', $code);
 	}
 
 
@@ -439,7 +439,7 @@ 
 	 * @return boolean
 	 */
 	function is_taxable() {
-		return $this->get( 'LIN_is_taxable' );
+		return $this->get('LIN_is_taxable');
 	}
 
 
@@ -449,8 +449,8 @@ 
 	 * @param boolean $is_taxable
 	 * @return boolean
 	 */
-	function set_is_taxable( $is_taxable ) {
-		$this->set( 'LIN_is_taxable', $is_taxable );
+	function set_is_taxable($is_taxable) {
+		$this->set('LIN_is_taxable', $is_taxable);
 	}
 
 
@@ -465,7 +465,7 @@ 
 	 */
 	function get_object() {
 		$model_name_of_related_obj = $this->OBJ_type();
-		return $this->get_model()->has_relation(  $model_name_of_related_obj ) ? $this->get_first_related( $model_name_of_related_obj ) : NULL;
+		return $this->get_model()->has_relation($model_name_of_related_obj) ? $this->get_first_related($model_name_of_related_obj) : NULL;
 	}
 
 
@@ -476,11 +476,11 @@ 
 	 * @param array $query_params
 	 * @return EE_Ticket
 	 */
-	function ticket( $query_params = array() ) {
+	function ticket($query_params = array()) {
 		//we're going to assume that when this method is called we always want to receive the attached ticket EVEN if that ticket is archived.  This can be overridden via the incoming $query_params argument
-		$remove_defaults = array( 'default_where_conditions' => 'none' );
-		$query_params = array_merge( $remove_defaults, $query_params );
-		return $this->get_first_related( 'Ticket', $query_params );
+		$remove_defaults = array('default_where_conditions' => 'none');
+		$query_params = array_merge($remove_defaults, $query_params);
+		return $this->get_first_related('Ticket', $query_params);
 	}
 
 
@@ -490,11 +490,11 @@ 
 	 * @return EE_Datetime | NULL
 	 */
 	function get_ticket_datetime() {
-		if ( $this->OBJ_type() === 'Ticket' ) {
+		if ($this->OBJ_type() === 'Ticket') {
 			$ticket = $this->ticket();
-			if ( $ticket instanceof EE_Ticket ) {
+			if ($ticket instanceof EE_Ticket) {
 				$datetime = $ticket->first_datetime();
-				if ( $datetime instanceof EE_Datetime ) {
+				if ($datetime instanceof EE_Datetime) {
 					return $datetime;
 				}
 			}
@@ -510,9 +510,9 @@ 
 	 * @return string
 	 */
 	function ticket_event_name() {
-		$event_name = __( "Unknown", "event_espresso" );
+		$event_name = __("Unknown", "event_espresso");
 		$event = $this->ticket_event();
-		if ( $event instanceof EE_Event ) {
+		if ($event instanceof EE_Event) {
 			$event_name = $event->name();
 		}
 		return $event_name;
@@ -526,9 +526,9 @@ 
 	function ticket_event() {
 		$event = null;
 		$ticket = $this->ticket();
-		if ( $ticket instanceof EE_Ticket ) {
+		if ($ticket instanceof EE_Ticket) {
 			$datetime = $ticket->first_datetime();
-			if ( $datetime instanceof EE_Datetime ) {
+			if ($datetime instanceof EE_Datetime) {
 				$event = $datetime->event();
 			}
 		}
@@ -543,11 +543,11 @@ 
 	 * @param string $time_format
 	 * @return string
 	 */
-	function ticket_datetime_start( $date_format = '', $time_format = '' ) {
-		$first_datetime_string = __( "Unknown", "event_espresso" );
+	function ticket_datetime_start($date_format = '', $time_format = '') {
+		$first_datetime_string = __("Unknown", "event_espresso");
 		$datetime = $this->get_ticket_datetime();
-		if ( $datetime ) {
-			$first_datetime_string = $datetime->start_date_and_time( $date_format, $time_format );
+		if ($datetime) {
+			$first_datetime_string = $datetime->start_date_and_time($date_format, $time_format);
 		}
 		return $first_datetime_string;
 	}
@@ -562,26 +562,26 @@ 
 	 * @return bool success
 	 * @throws \EE_Error
 	 */
-	function add_child_line_item( EEI_Line_Item $line_item, $set_order = true ) {
+	function add_child_line_item(EEI_Line_Item $line_item, $set_order = true) {
 		// should we calculate the LIN_order for this line item ?
-		if ( $set_order || $line_item->order() === null ) {
-			$line_item->set_order( count( $this->children() ) );
+		if ($set_order || $line_item->order() === null) {
+			$line_item->set_order(count($this->children()));
 		}
-		if ( $this->ID() ) {
+		if ($this->ID()) {
 			//check for any duplicate line items (with the same code), if so, this replaces it
-			$line_item_with_same_code = $this->get_child_line_item(  $line_item->code() );
-			if( $line_item_with_same_code instanceof EE_Line_Item && $line_item_with_same_code !== $line_item ) {
-				$this->delete_child_line_item( $line_item_with_same_code->code() );
+			$line_item_with_same_code = $this->get_child_line_item($line_item->code());
+			if ($line_item_with_same_code instanceof EE_Line_Item && $line_item_with_same_code !== $line_item) {
+				$this->delete_child_line_item($line_item_with_same_code->code());
 			}
-			$line_item->set_parent_ID( $this->ID() );
-			if( $this->TXN_ID() ){
-				$line_item->set_TXN_ID( $this->TXN_ID() );
+			$line_item->set_parent_ID($this->ID());
+			if ($this->TXN_ID()) {
+				$line_item->set_TXN_ID($this->TXN_ID());
 			}
 			return $line_item->save();
 		} else {
-			$this->_children[ $line_item->code() ] = $line_item;
-			if( $line_item->parent() != $this ) {
-				$line_item->set_parent( $this );
+			$this->_children[$line_item->code()] = $line_item;
+			if ($line_item->parent() != $this) {
+				$line_item->set_parent($this);
 			}
 			return TRUE;
 		}
@@ -595,16 +595,16 @@ 
 	 * @param EE_Line_Item $line_item
 	 *
 	 */
-	public function set_parent( $line_item ) {
-		if ( $this->ID() ) {
-			if( ! $line_item->ID() ) {
+	public function set_parent($line_item) {
+		if ($this->ID()) {
+			if ( ! $line_item->ID()) {
 				$line_item->save();
 			}
-			$this->set_parent_ID( $line_item->ID() );
+			$this->set_parent_ID($line_item->ID());
 			$this->save();
 		} else {
 			$this->_parent = $line_item;
-			$this->set_parent_ID( $line_item->ID() );
+			$this->set_parent_ID($line_item->ID());
 		}
 	}
 
@@ -617,11 +617,11 @@ 
 	 * @param string $code
 	 * @return EE_Line_Item
 	 */
-	function get_child_line_item( $code ) {
-		if ( $this->ID() ) {
-			return $this->get_model()->get_one( array( array( 'LIN_parent' => $this->ID(), 'LIN_code' => $code ) ) );
+	function get_child_line_item($code) {
+		if ($this->ID()) {
+			return $this->get_model()->get_one(array(array('LIN_parent' => $this->ID(), 'LIN_code' => $code)));
 		} else {
-			return isset( $this->_children[ $code ] ) ? $this->_children[ $code ] : null;
+			return isset($this->_children[$code]) ? $this->_children[$code] : null;
 		}
 	}
 
@@ -632,10 +632,10 @@ 
 	 * @return int
 	 */
 	function delete_children_line_items() {
-		if ( $this->ID() ) {
-			return $this->get_model()->delete( array( array( 'LIN_parent' => $this->ID() ) ) );
+		if ($this->ID()) {
+			return $this->get_model()->delete(array(array('LIN_parent' => $this->ID())));
 		} else {
-			$count = count( $this->_children );
+			$count = count($this->_children);
 			$this->_children = array();
 			return $count;
 		}
@@ -652,25 +652,25 @@ 
 	 * @param bool $stop_search_once_found
 	 * @return int count of items deleted (or simply removed from the line item's cache, if not has not been saved to the DB yet)
 	 */
-	function delete_child_line_item( $code, $stop_search_once_found = true ) {
-		if ( $this->ID() ) {
+	function delete_child_line_item($code, $stop_search_once_found = true) {
+		if ($this->ID()) {
 			$items_deleted = 0;
-			if( $this->code() == $code ) {
-				$items_deleted += EEH_Line_Item::delete_all_child_items( $this );
-				$items_deleted += intval( $this->delete() );
-				if( $stop_search_once_found ){
+			if ($this->code() == $code) {
+				$items_deleted += EEH_Line_Item::delete_all_child_items($this);
+				$items_deleted += intval($this->delete());
+				if ($stop_search_once_found) {
 					return $items_deleted;
 				}
 			}
-			foreach( $this->children() as $child_line_item ) {
-				$items_deleted += $child_line_item->delete_child_line_item( $code, $stop_search_once_found );
+			foreach ($this->children() as $child_line_item) {
+				$items_deleted += $child_line_item->delete_child_line_item($code, $stop_search_once_found);
 			}
 			return $items_deleted;
 		} else {
-			if( isset( $this->_children[ $code ] ) ) {
-				unset( $this->_children[ $code ] );
+			if (isset($this->_children[$code])) {
+				unset($this->_children[$code]);
 				return 1;
-			}else{
+			} else {
 				return 0;
 			}
 		}
@@ -683,9 +683,9 @@ 
 	 * @return boolean
 	 */
 	public function delete_if_childless_subtotal() {
-		if( $this->ID() &&
+		if ($this->ID() &&
 				$this->type() == EEM_Line_Item::type_sub_total &&
-				! $this->children() ) {
+				! $this->children()) {
 			return $this->delete();
 		} else {
 			return false;
@@ -700,7 +700,7 @@ 
 	 */
 	function generate_code() {
 		// each line item in the cart requires a unique identifier
-		return md5( $this->get( 'OBJ_type' ) . $this->get( 'OBJ_ID' ) . microtime() );
+		return md5($this->get('OBJ_type').$this->get('OBJ_ID').microtime());
 	}
 
 
@@ -764,7 +764,7 @@ 
 	 * @return string like '2, 004.00', formatted according to the localized currency
 	 */
 	function unit_price_no_code() {
-		return $this->get_pretty( 'LIN_unit_price', 'no_currency_code' );
+		return $this->get_pretty('LIN_unit_price', 'no_currency_code');
 	}
 
 
@@ -774,7 +774,7 @@ 
 	 * @return string like '2, 004.00', formatted according to the localized currency
 	 */
 	function total_no_code() {
-		return $this->get_pretty( 'LIN_total', 'no_currency_code' );
+		return $this->get_pretty('LIN_total', 'no_currency_code');
 	}
 
 
@@ -793,17 +793,17 @@ 
 
 		$total = $pre_tax_total + $tax_total;
 		// no negative totals plz
-		$total = max( $total, 0 );
-		$this->set_total( $total );
+		$total = max($total, 0);
+		$this->set_total($total);
 		//only update the related transaction's total
 		//if we intend to save this line item and its a grand total
-		if(
+		if (
 			$this->allow_persist() &&
 			$this->type() == EEM_Line_Item::type_total &&
 			$this->transaction() instanceof EE_Transaction
-		){
-			$this->transaction()->set_total( $total );
-			if ( $this->transaction()->ID() ) {
+		) {
+			$this->transaction()->set_total($total);
+			if ($this->transaction()->ID()) {
 				$this->transaction()->save();
 			}
 		}
@@ -824,42 +824,42 @@ 
 		$total = 0;
 		$my_children = $this->children();
 		//completely ignore tax and tax sub-totals when calculating the pre-tax-total
-		if ( $this->is_tax_sub_total() || $this->is_tax() ) {
+		if ($this->is_tax_sub_total() || $this->is_tax()) {
 			return 0;
 		} elseif (
-			( $this->is_sub_line_item() || $this->is_line_item() )
-			&& empty( $my_children )
+			($this->is_sub_line_item() || $this->is_line_item())
+			&& empty($my_children)
 		) {
 			$total = $this->unit_price() * $this->quantity();
-		} elseif( $this->is_sub_total() || $this->is_total() ) {
-			$total = $this->_recalculate_pretax_total_for_subtotal( $total, $my_children );
-		} elseif (  $this->is_line_item() && ! empty( $my_children ) ) {
-			$total = $this->_recalculate_pretax_total_for_line_item( $total, $my_children );
+		} elseif ($this->is_sub_total() || $this->is_total()) {
+			$total = $this->_recalculate_pretax_total_for_subtotal($total, $my_children);
+		} elseif ($this->is_line_item() && ! empty($my_children)) {
+			$total = $this->_recalculate_pretax_total_for_line_item($total, $my_children);
 		}
 		//ensure all non-line items and non-sub-line-items have a quantity of 1
-		if( ! $this->is_line_item() && ! $this->is_sub_line_item() ) {
-			$this->set_quantity( 1 );
-			if( ! $this->is_percent() ) {
-				$this->set_unit_price( $this->total() );
+		if ( ! $this->is_line_item() && ! $this->is_sub_line_item()) {
+			$this->set_quantity(1);
+			if ( ! $this->is_percent()) {
+				$this->set_unit_price($this->total());
 			}
 		}
 
 		//we don't want to bother saving grand totals, because that needs to factor in taxes anyways
 		//so it ought to be
-		if( ! $this->is_total() ) {
-			$this->set_total( $total );
+		if ( ! $this->is_total()) {
+			$this->set_total($total);
 			//if not a percent line item, make sure we keep the unit price in sync
-			if(
+			if (
 				$this->is_line_item() &&
-				! empty( $my_children ) &&
+				! empty($my_children) &&
 				! $this->is_percent()
 			) {
-				if( $this->quantity() === 0 ){
+				if ($this->quantity() === 0) {
 					$new_unit_price = 0;
 				} else {
 					$new_unit_price = $this->total() / $this->quantity();
 				}
-				$this->set_unit_price( $new_unit_price );
+				$this->set_unit_price($new_unit_price);
 			}
 			$this->maybe_save();
 		}
@@ -875,14 +875,14 @@ 
 	 * @param EE_Line_Item[] $my_children
 	 * @return float
 	 */
-	protected function _recalculate_pretax_total_for_subtotal( $calculated_total_so_far, $my_children = null ) {
-		if( $my_children === null ) {
+	protected function _recalculate_pretax_total_for_subtotal($calculated_total_so_far, $my_children = null) {
+		if ($my_children === null) {
 			$my_children = $this->children();
 		}
 		//get the total of all its children
-		foreach ( $my_children as $child_line_item ) {
-			if ( $child_line_item instanceof EE_Line_Item ) {
-				if ( $child_line_item->is_percent() ) {
+		foreach ($my_children as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
+				if ($child_line_item->is_percent()) {
 					
 					//round as we go so that the line items add up ok
 					$percent_total = round(
@@ -890,25 +890,25 @@ 
 						EE_Registry::instance()->CFG->currency->dec_plc
 					);
 					
-					$child_line_item->set_total( $percent_total );
+					$child_line_item->set_total($percent_total);
 					//so far all percent line items should have a quantity of 1
 					//(ie, no double percent discounts. Although that might be requested someday)
-					$child_line_item->set_quantity( 1 );
+					$child_line_item->set_quantity(1);
 					$child_line_item->maybe_save();
 					$calculated_total_so_far += $percent_total;
 				} else {
 					//verify flat sub-line-item quantities match their parent
-					if( $child_line_item->is_sub_line_item() ) {
-						$child_line_item->set_quantity( $this->quantity() );
+					if ($child_line_item->is_sub_line_item()) {
+						$child_line_item->set_quantity($this->quantity());
 					}
 					$calculated_total_so_far += $child_line_item->recalculate_pre_tax_total();
 				}
 			}
 		}
 
-		if( $this->is_sub_total() ){
+		if ($this->is_sub_total()) {
 			// no negative totals plz
-			$calculated_total_so_far = max( $calculated_total_so_far, 0 );
+			$calculated_total_so_far = max($calculated_total_so_far, 0);
 		}
 		return $calculated_total_so_far;
 	}
@@ -922,8 +922,8 @@ 
 	 * @param EE_Line_Item[] $my_children
 	 * @return float
 	 */
-	protected function _recalculate_pretax_total_for_line_item( $calculated_total_so_far, $my_children = null ) {
-		if( $my_children === null ) {
+	protected function _recalculate_pretax_total_for_line_item($calculated_total_so_far, $my_children = null) {
+		if ($my_children === null) {
 			$my_children = $this->children();
 		}
 		//we need to keep track of the running total for a single item,
@@ -931,9 +931,9 @@ 
 		$unit_price_for_total = 0;
 		$quantity_for_total = 1;
 		//get the total of all its children
-		foreach ( $my_children as $child_line_item ) {
-			if ( $child_line_item instanceof EE_Line_Item ) {
-				if ( $child_line_item->is_percent() ) {
+		foreach ($my_children as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
+				if ($child_line_item->is_percent()) {
 					//it should be the unit-price-so-far multiplied by teh percent multiplied by the quantity
 					//not total multiplied by percent, because that ignores rounding along-the-way
 					$percent_unit_price = round(
@@ -941,17 +941,17 @@ 
 						EE_Registry::instance()->CFG->currency->dec_plc
 					);
 					$percent_total = $percent_unit_price * $quantity_for_total;
-					$child_line_item->set_total( $percent_total );
+					$child_line_item->set_total($percent_total);
 					//so far all percent line items should have a quantity of 1
 					//(ie, no double percent discounts. Although that might be requested someday)
-					$child_line_item->set_quantity( 1 );
+					$child_line_item->set_quantity(1);
 					$child_line_item->maybe_save();
 					$calculated_total_so_far += $percent_total;
 					$unit_price_for_total += $percent_unit_price;
 				} else {
 					//verify flat sub-line-item quantities match their parent
-					if( $child_line_item->is_sub_line_item() ) {
-						$child_line_item->set_quantity( $this->quantity() );
+					if ($child_line_item->is_sub_line_item()) {
+						$child_line_item->set_quantity($this->quantity());
 					}
 					$quantity_for_total = $child_line_item->quantity();
 					$calculated_total_so_far += $child_line_item->recalculate_pre_tax_total();
@@ -975,10 +975,10 @@ 
 		//calculate the pretax total
 		$taxable_total = $this->taxable_total();
 		$tax_total = 0;
-		foreach ( $taxes as $tax ) {
+		foreach ($taxes as $tax) {
 			$total_on_this_tax = $taxable_total * $tax->percent() / 100;
 			//remember the total on this line item
-			$tax->set_total( $total_on_this_tax );
+			$tax->set_total($total_on_this_tax);
 			$tax_total += $tax->total();
 		}
 		$this->_recalculate_tax_sub_total();
@@ -992,21 +992,21 @@ 
 	 * @return void
 	 */
 	private function _recalculate_tax_sub_total() {
-		if ( $this->is_tax_sub_total() ) {
+		if ($this->is_tax_sub_total()) {
 			$total = 0;
 			$total_percent = 0;
 			//simply loop through all its children (which should be taxes) and sum their total
-			foreach ( $this->children() as $child_tax ) {
-				if ( $child_tax instanceof EE_Line_Item ) {
+			foreach ($this->children() as $child_tax) {
+				if ($child_tax instanceof EE_Line_Item) {
 					$total += $child_tax->total();
 					$total_percent += $child_tax->percent();
 				}
 			}
-			$this->set_total( $total );
-			$this->set_percent( $total_percent );
-		} elseif ( $this->is_total() ) {
-			foreach ( $this->children() as $maybe_tax_subtotal ) {
-				if ( $maybe_tax_subtotal instanceof EE_Line_Item ) {
+			$this->set_total($total);
+			$this->set_percent($total_percent);
+		} elseif ($this->is_total()) {
+			foreach ($this->children() as $maybe_tax_subtotal) {
+				if ($maybe_tax_subtotal instanceof EE_Line_Item) {
 					$maybe_tax_subtotal->_recalculate_tax_sub_total();
 				}
 			}
@@ -1022,8 +1022,8 @@ 
 	public function get_total_tax() {
 		$this->_recalculate_tax_sub_total();
 		$total = 0;
-		foreach ( $this->tax_descendants() as $tax_line_item ) {
-			if ( $tax_line_item instanceof EE_Line_Item ) {
+		foreach ($this->tax_descendants() as $tax_line_item) {
+			if ($tax_line_item instanceof EE_Line_Item) {
 				$total += $tax_line_item->total();
 			}
 		}
@@ -1037,15 +1037,15 @@ 
 	 */
 	public function get_items_total() {
 		//by default, let's make sure we're consistent with the existing line item
-		if( $this->is_total() ) {
-			$pretax_subtotal_li = EEH_Line_Item::get_pre_tax_subtotal( $this );
-			if( $pretax_subtotal_li instanceof EE_Line_Item ) {
+		if ($this->is_total()) {
+			$pretax_subtotal_li = EEH_Line_Item::get_pre_tax_subtotal($this);
+			if ($pretax_subtotal_li instanceof EE_Line_Item) {
 				return $pretax_subtotal_li->total();
 			}
 		}
 		$total = 0;
-		foreach ( $this->get_items() as $item ) {
-			if ( $item instanceof EE_Line_Item ) {
+		foreach ($this->get_items() as $item) {
+			if ($item instanceof EE_Line_Item) {
 				$total += $item->total();
 			}
 		}
@@ -1060,7 +1060,7 @@ 
 	 * @return EE_Line_Item[]
 	 */
 	function tax_descendants() {
-		return EEH_Line_Item::get_tax_descendants( $this );
+		return EEH_Line_Item::get_tax_descendants($this);
 	}
 
 
@@ -1070,7 +1070,7 @@ 
 	 * @return EE_Line_Item[]
 	 */
 	function get_items() {
-		return EEH_Line_Item::get_line_item_descendants( $this );
+		return EEH_Line_Item::get_line_item_descendants($this);
 	}
 
 
@@ -1084,22 +1084,22 @@ 
 	 */
 	function taxable_total() {
 		$total = 0;
-		if ( $this->children() ) {
-			foreach ( $this->children() as $child_line_item ) {
-				if ( $child_line_item->type() == EEM_Line_Item::type_line_item && $child_line_item->is_taxable()) {
+		if ($this->children()) {
+			foreach ($this->children() as $child_line_item) {
+				if ($child_line_item->type() == EEM_Line_Item::type_line_item && $child_line_item->is_taxable()) {
 					//if it's a percent item, only take into account the percent
 					//that's taxable too (the taxable total so far)
-					if( $child_line_item->is_percent() ) {
-						$total = $total + ( $total * $child_line_item->percent() / 100 );
-					}else{
+					if ($child_line_item->is_percent()) {
+						$total = $total + ($total * $child_line_item->percent() / 100);
+					} else {
 						$total += $child_line_item->total();
 					}
-				}elseif( $child_line_item->type() == EEM_Line_Item::type_sub_total ){
+				}elseif ($child_line_item->type() == EEM_Line_Item::type_sub_total) {
 					$total += $child_line_item->taxable_total();
 				}
 			}
 		}
-		return max( $total, 0 );
+		return max($total, 0);
 	}
 
 
@@ -1109,7 +1109,7 @@ 
 	 * @return EE_Transaction
 	 */
 	public function transaction() {
-		return $this->get_first_related( 'Transaction' );
+		return $this->get_first_related('Transaction');
 	}
 
 
@@ -1122,17 +1122,17 @@ 
 	 * @param int $txn_id if none is provided, assumes $this->TXN_ID()
 	 * @return int count of items saved
 	 */
-	public function save_this_and_descendants_to_txn( $txn_id = NULL ) {
-		if ( ! $txn_id ) {
+	public function save_this_and_descendants_to_txn($txn_id = NULL) {
+		if ( ! $txn_id) {
 			$txn_id = $this->TXN_ID();
 		}
-		$this->set_TXN_ID( $txn_id );
+		$this->set_TXN_ID($txn_id);
 		$children = $this->children();
 		$this->save();
-		foreach ( $children as $child_line_item ) {
-			if ( $child_line_item instanceof EE_Line_Item ) {
-				$child_line_item->set_parent_ID( $this->ID() );
-				$child_line_item->save_this_and_descendants_to_txn( $txn_id );
+		foreach ($children as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
+				$child_line_item->set_parent_ID($this->ID());
+				$child_line_item->save_this_and_descendants_to_txn($txn_id);
 			}
 		}
 	}
@@ -1144,9 +1144,9 @@ 
 	 * @param string $type one of the constants on EEM_Line_Item
 	 * @return EE_Line_Item[]
 	 */
-	protected function _get_descendants_of_type( $type ) {
-		EE_Error::doing_it_wrong( 'EE_Line_Item::_get_descendants_of_type()', __('Method replaced with EEH_Line_Item::get_descendants_of_type()', 'event_espresso'), '4.6.0' );
-		return EEH_Line_Item::get_descendants_of_type( $this, $type );
+	protected function _get_descendants_of_type($type) {
+		EE_Error::doing_it_wrong('EE_Line_Item::_get_descendants_of_type()', __('Method replaced with EEH_Line_Item::get_descendants_of_type()', 'event_espresso'), '4.6.0');
+		return EEH_Line_Item::get_descendants_of_type($this, $type);
 	}
 
 
@@ -1156,9 +1156,9 @@ 
 	 * @param string $type like one of the EEM_Line_Item::type_*
 	 * @return EE_Line_Item
 	 */
-	public function get_nearest_descendant_of_type( $type ) {
-		EE_Error::doing_it_wrong( 'EE_Line_Item::get_nearest_descendant_of_type()', __('Method replaced with EEH_Line_Item::get_nearest_descendant_of_type()', 'event_espresso'), '4.6.0' );
-		return EEH_Line_Item::get_nearest_descendant_of_type( $this, $type );
+	public function get_nearest_descendant_of_type($type) {
+		EE_Error::doing_it_wrong('EE_Line_Item::get_nearest_descendant_of_type()', __('Method replaced with EEH_Line_Item::get_nearest_descendant_of_type()', 'event_espresso'), '4.6.0');
+		return EEH_Line_Item::get_nearest_descendant_of_type($this, $type);
 	}
 
 
@@ -1169,7 +1169,7 @@ 
 	 * @return int count of items saved
 	 */
 	public function maybe_save() {
-		if ( $this->ID() ) {
+		if ($this->ID()) {
 			return $this->save();
 		}
 		return false;

core/db_classes/EE_Message_Template_Group.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -224,7 +224,7 @@
 	 * appropriately.
 	 *
 	 * @throws EE_Error
-	 * @return EE_message_type|false if exception thrown.
+	 * @return null|EE_message_type if exception thrown.
 	 */
 	public function message_type_obj() {
 		$message_type = $this->message_type();

Spacing +51 added lines, -51 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');
 }
 /**
  * EE_Message_Template_Group class
@@ -18,9 +18,9 @@ 
 	 * @param string $timezone
 	 * @return EE_Message_Template_Group|mixed
 	 */
-	public static function new_instance( $props_n_values = array(), $timezone = '' ) {
-		$has_object = parent::_check_for_object( $props_n_values, __CLASS__, $timezone );
-		return $has_object ? $has_object : new self( $props_n_values, FALSE, $timezone );
+	public static function new_instance($props_n_values = array(), $timezone = '') {
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone);
+		return $has_object ? $has_object : new self($props_n_values, FALSE, $timezone);
 	}
 
 
@@ -30,8 +30,8 @@ 
 	 * @param string $timezone
 	 * @return EE_Message_Template_Group
 	 */
-	public static function new_instance_from_db( $props_n_values = array(), $timezone = '' ) {
-		return new self( $props_n_values, TRUE, $timezone );
+	public static function new_instance_from_db($props_n_values = array(), $timezone = '') {
+		return new self($props_n_values, TRUE, $timezone);
 	}
 
 
@@ -40,11 +40,11 @@ 
 	 * @param bool $message_type
 	 * @throws EE_Error
 	 */
-	public function set_message_type( $message_type = FALSE ) {
-		if ( ! $message_type ) {
-			throw new EE_Error( __( 'Missing required value for the message_type parameter', 'event_espresso' ) );
+	public function set_message_type($message_type = FALSE) {
+		if ( ! $message_type) {
+			throw new EE_Error(__('Missing required value for the message_type parameter', 'event_espresso'));
 		}
-		$this->set( 'MTP_message_type', $message_type );
+		$this->set('MTP_message_type', $message_type);
 	}
 
 
@@ -53,11 +53,11 @@ 
 	 * @param bool $messenger
 	 * @throws EE_Error
 	 */
-	public function set_messenger( $messenger = FALSE ) {
-		if ( ! $messenger ) {
-			throw new EE_Error( __( 'Missing required value for the messenger parameter', 'event_espresso' ) );
+	public function set_messenger($messenger = FALSE) {
+		if ( ! $messenger) {
+			throw new EE_Error(__('Missing required value for the messenger parameter', 'event_espresso'));
 		}
-		$this->set( 'MTP_messenger', $messenger );
+		$this->set('MTP_messenger', $messenger);
 	}
 
 
@@ -66,11 +66,11 @@ 
 	 * @param bool $GRP_ID
 	 * @throws EE_Error
 	 */
-	public function set_group_template_id( $GRP_ID = FALSE ) {
-		if ( ! $GRP_ID ) {
-			throw new EE_Error( __( 'Missing required value for the message template group id', 'event_espresso' ) );
+	public function set_group_template_id($GRP_ID = FALSE) {
+		if ( ! $GRP_ID) {
+			throw new EE_Error(__('Missing required value for the message template group id', 'event_espresso'));
 		}
-		$this->set( 'GRP_ID', $GRP_ID );
+		$this->set('GRP_ID', $GRP_ID);
 	}
 
 
@@ -81,7 +81,7 @@ 
 	 * @return int
 	 */
 	public function GRP_ID() {
-		return $this->get( 'GRP_ID' );
+		return $this->get('GRP_ID');
 	}
 
 
@@ -92,8 +92,8 @@ 
 	 * @return int
 	 */
 	public function user() {
-		$user_id = $this->get( 'MTP_user_id' );
-		return empty( $user_id ) ? get_current_user_id() : $user_id;
+		$user_id = $this->get('MTP_user_id');
+		return empty($user_id) ? get_current_user_id() : $user_id;
 	}
 
 
@@ -116,7 +116,7 @@ 
 	 * @return int
 	 */
 	public function count_events() {
-		return $this->count_related( 'Event' );
+		return $this->count_related('Event');
 	}
 
 
@@ -126,7 +126,7 @@ 
 	 * @return string
 	 */
 	public function name() {
-		return $this->get( 'MTP_name' );
+		return $this->get('MTP_name');
 	}
 
 
@@ -136,7 +136,7 @@ 
 	 * @return string
 	 */
 	public function description() {
-		return $this->get( 'MTP_description' );
+		return $this->get('MTP_description');
 	}
 
 
@@ -146,8 +146,8 @@ 
 	 * @param  array $query_params like EEM_Base::get_all()
 	 * @return EE_Message_Template[]
 	 */
-	public function message_templates( $query_params = array() ) {
-		return $this->get_many_related( 'Message_Template', $query_params );
+	public function message_templates($query_params = array()) {
+		return $this->get_many_related('Message_Template', $query_params);
 	}
 
 
@@ -158,7 +158,7 @@ 
 	 * @return string
 	 */
 	public function messenger() {
-		return $this->get( 'MTP_messenger' );
+		return $this->get('MTP_messenger');
 	}
 
 
@@ -175,10 +175,10 @@ 
 	public function messenger_obj() {
 		$messenger = $this->messenger();
 		try {
-			$messenger = EEH_MSG_Template::messenger_obj( $messenger );
-		} catch( EE_Error $e ) {
+			$messenger = EEH_MSG_Template::messenger_obj($messenger);
+		} catch (EE_Error $e) {
 			//if an exception was thrown then let's deactivate this message template group because it means there is no class for this messenger in this group.
-			$this->set( 'MTP_is_active', false );
+			$this->set('MTP_is_active', false);
 			$this->save();
 			return null;
 		}
@@ -194,7 +194,7 @@ 
 	 * @return string
 	 */
 	public function message_type() {
-		return $this->get( 'MTP_message_type' );
+		return $this->get('MTP_message_type');
 	}
 
 
@@ -212,10 +212,10 @@ 
 	public function message_type_obj() {
 		$message_type = $this->message_type();
 		try {
-			$message_type = EEH_MSG_Template::message_type_obj( $message_type );
-		} catch(EE_Error $e) {
+			$message_type = EEH_MSG_Template::message_type_obj($message_type);
+		} catch (EE_Error $e) {
 			//if an exception was thrown then let's deactivate this message template group because it means there is no class for the message type in this group.
-			$this->set( 'MTP_is_active', false );
+			$this->set('MTP_is_active', false);
 			$this->save();
 			return null;
 		}
@@ -252,13 +252,13 @@ 
 	 */
 	public function context_templates() {
 		$mtps_arr = array();
-		$mtps = $this->get_many_related( 'Message_Template' );
-		if ( empty( $mtps ) ) {
+		$mtps = $this->get_many_related('Message_Template');
+		if (empty($mtps)) {
 			return array();
 		}
 		//note contexts could have CHECKBOX fields per context. So we return the objects indexed by context AND field.
-		foreach ( $mtps as $mtp ) {
-			$mtps_arr[ $mtp->get( 'MTP_context' ) ][ $mtp->get( 'MTP_template_field' ) ] = $mtp;
+		foreach ($mtps as $mtp) {
+			$mtps_arr[$mtp->get('MTP_context')][$mtp->get('MTP_template_field')] = $mtp;
 		}
 		return $mtps_arr;
 	}
@@ -270,7 +270,7 @@ 
 	 * @return boolean true if it is, false if it isn't
 	 */
 	public function is_global() {
-		return $this->get( 'MTP_is_global' );
+		return $this->get('MTP_is_global');
 	}
 
 
@@ -280,7 +280,7 @@ 
 	 * @return boolean true if it is, false if it isn't
 	 */
 	public function is_active() {
-		return $this->get( 'MTP_is_active' );
+		return $this->get('MTP_is_active');
 	}
 
 
@@ -296,10 +296,10 @@ 
 	 * @param bool   $merged  If TRUE then we don't return shortcodes indexed by field but instead an array of the unique shortcodes for all the given (or all) fields.
 	 * @return mixed (array|bool) an array of shortcodes in the format array( '[shortcode] => 'label') OR FALSE if no shortcodes found.
 	 */
-	public function get_shortcodes( $context, $fields = array(), $merged = FALSE ) {
+	public function get_shortcodes($context, $fields = array(), $merged = FALSE) {
 		$messenger = $this->messenger();
 		$message_type = $this->message_type();
-		return EEH_MSG_Template::get_shortcodes( $message_type, $messenger, $fields, $context, $merged );
+		return EEH_MSG_Template::get_shortcodes($message_type, $messenger, $fields, $context, $merged);
 	}
 
 
@@ -340,7 +340,7 @@ 
 	 * @return string
 	 */
 	public function get_template_pack_name() {
-		return $this->get_extra_meta( 'MTP_template_pack', true, 'default' );
+		return $this->get_extra_meta('MTP_template_pack', true, 'default');
 	}
 
 
@@ -355,8 +355,8 @@ 
 	 */
 	public function get_template_pack() {
 		$pack_name = $this->get_template_pack_name();
-		EE_Registry::instance()->load_helper( 'MSG_Template' );
-		return EEH_MSG_Template::get_template_pack( $pack_name );
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::get_template_pack($pack_name);
 	}
 
 
@@ -369,7 +369,7 @@ 
 	 * @return string
 	 */
 	public function get_template_pack_variation() {
-		return $this->get_extra_meta( 'MTP_variation', TRUE, 'default' );
+		return $this->get_extra_meta('MTP_variation', TRUE, 'default');
 	}
 
 
@@ -381,8 +381,8 @@ 
 	 * @param string $template_pack_name What message template pack is assigned.
 	 * @return int
 	 */
-	public function set_template_pack_name( $template_pack_name ) {
-		return $this->update_extra_meta( 'MTP_template_pack', $template_pack_name );
+	public function set_template_pack_name($template_pack_name) {
+		return $this->update_extra_meta('MTP_template_pack', $template_pack_name);
 	}
 
 
@@ -394,8 +394,8 @@ 
 	 * @param string $variation What variation is being set on the message template group.
 	 * @return int
 	 */
-	public function set_template_pack_variation( $variation ) {
-		return $this->update_extra_meta( 'MTP_variation', $variation );
+	public function set_template_pack_variation($variation) {
+		return $this->update_extra_meta('MTP_variation', $variation);
 	}
 }
 //end EE_Message_Template_Group class

core/db_classes/EE_Payment.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -15,7 +15,7 @@ 
 	 * @param array  $props_n_values          incoming values
 	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
 	 *                                        used.)
-	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 * @param string[]  $date_formats            incoming date_formats in an array where the first value is the
 	 *                                        date_format and the second value is the time format
 	 * @return EE_Payment
 	 * @throws \EE_Error
@@ -590,7 +590,7 @@ 
 	 * Gets all the extra meta info on this payment
 	 *
 	 * @param array $query_params like EEM_Base::get_all
-	 * @return EE_Extra_Meta
+	 * @return EE_Base_Class[]
 	 * @throws \EE_Error
 	 */
 	public function extra_meta( $query_params = array() ) {

Indentation +10 added lines, -10 removed lines

@@ -662,11 +662,11 @@ 
 				$redirect_url = str_replace( '?' . $querystring, '', $redirect_url );
 			}
 			$form = EEH_HTML::nl( 1 )
-			        . '<form method="'
-			        . $method
-			        . '" name="gateway_form" action="'
-			        . $redirect_url
-			        . '">';
+					. '<form method="'
+					. $method
+					. '" name="gateway_form" action="'
+					. $redirect_url
+					. '">';
 			$form .= EEH_HTML::nl( 1 ) . $this->redirect_args_as_inputs();
 			$form .= $inside_form_html;
 			$form .= EEH_HTML::nl( -1 ) . '</form>' . EEH_HTML::nl( -1 );
@@ -704,11 +704,11 @@ 
 			EE_Registry::instance()->load_helper( 'HTML' );
 			foreach ( $args as $name => $value ) {
 				$html .= EEH_HTML::nl( 0 )
-				         . '<input type="hidden" name="'
-				         . $name
-				         . '" value="'
-				         . esc_attr( $value )
-				         . '"/>';
+						 . '<input type="hidden" name="'
+						 . $name
+						 . '" value="'
+						 . esc_attr( $value )
+						 . '"/>';
 			}
 		}
 		return $html;

Spacing +103 added lines, -103 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');
 }
 
 /**
@@ -20,9 +20,9 @@ 
 	 * @return EE_Payment
 	 * @throws \EE_Error
 	 */
-	public static function new_instance( $props_n_values = array(), $timezone = null, $date_formats = array() ) {
-		$has_object = parent::_check_for_object( $props_n_values, __CLASS__, $timezone, $date_formats );
-		return $has_object ? $has_object : new self( $props_n_values, false, $timezone, $date_formats );
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) {
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
 	}
 
 
@@ -34,8 +34,8 @@ 
 	 * @return EE_Payment
 	 * @throws \EE_Error
 	 */
-	public static function new_instance_from_db( $props_n_values = array(), $timezone = null ) {
-		return new self( $props_n_values, true, $timezone );
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null) {
+		return new self($props_n_values, true, $timezone);
 	}
 
 
@@ -47,8 +47,8 @@ 
 	 * @param int $TXN_ID
 	 * @throws \EE_Error
 	 */
-	public function set_transaction_id( $TXN_ID = 0 ) {
-		$this->set( 'TXN_ID', $TXN_ID );
+	public function set_transaction_id($TXN_ID = 0) {
+		$this->set('TXN_ID', $TXN_ID);
 	}
 
 
@@ -60,7 +60,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function transaction() {
-		return $this->get_first_related( 'Transaction' );
+		return $this->get_first_related('Transaction');
 	}
 
 
@@ -72,8 +72,8 @@ 
 	 * @param string $STS_ID
 	 * @throws \EE_Error
 	 */
-	public function set_status( $STS_ID = '' ) {
-		$this->set( 'STS_ID', $STS_ID );
+	public function set_status($STS_ID = '') {
+		$this->set('STS_ID', $STS_ID);
 	}
 
 
@@ -85,8 +85,8 @@ 
 	 * @param int $timestamp
 	 * @throws \EE_Error
 	 */
-	public function set_timestamp( $timestamp = 0 ) {
-		$this->set( 'PAY_timestamp', $timestamp );
+	public function set_timestamp($timestamp = 0) {
+		$this->set('PAY_timestamp', $timestamp);
 	}
 
 
@@ -98,8 +98,8 @@ 
 	 * @param string $PAY_source
 	 * @throws \EE_Error
 	 */
-	public function set_source( $PAY_source = '' ) {
-		$this->set( 'PAY_source', $PAY_source );
+	public function set_source($PAY_source = '') {
+		$this->set('PAY_source', $PAY_source);
 	}
 
 
@@ -111,8 +111,8 @@ 
 	 * @param float $amount
 	 * @throws \EE_Error
 	 */
-	public function set_amount( $amount = 0.00 ) {
-		$this->set( 'PAY_amount', (float)$amount );
+	public function set_amount($amount = 0.00) {
+		$this->set('PAY_amount', (float) $amount);
 	}
 
 
@@ -124,8 +124,8 @@ 
 	 * @param string $gateway_response
 	 * @throws \EE_Error
 	 */
-	public function set_gateway_response( $gateway_response = '' ) {
-		$this->set( 'PAY_gateway_response', $gateway_response );
+	public function set_gateway_response($gateway_response = '') {
+		$this->set('PAY_gateway_response', $gateway_response);
 	}
 
 
@@ -148,7 +148,7 @@ 
 			),
 			'4.6.0'
 		);
-		return $this->payment_method() ? $this->payment_method()->name() : __( 'Unknown', 'event_espresso' );
+		return $this->payment_method() ? $this->payment_method()->name() : __('Unknown', 'event_espresso');
 	}
 
 
@@ -160,8 +160,8 @@ 
 	 * @param string $txn_id_chq_nmbr
 	 * @throws \EE_Error
 	 */
-	public function set_txn_id_chq_nmbr( $txn_id_chq_nmbr = '' ) {
-		$this->set( 'PAY_txn_id_chq_nmbr', $txn_id_chq_nmbr );
+	public function set_txn_id_chq_nmbr($txn_id_chq_nmbr = '') {
+		$this->set('PAY_txn_id_chq_nmbr', $txn_id_chq_nmbr);
 	}
 
 
@@ -173,8 +173,8 @@ 
 	 * @param string $po_number
 	 * @throws \EE_Error
 	 */
-	public function set_po_number( $po_number = '' ) {
-		$this->set( 'PAY_po_number', $po_number );
+	public function set_po_number($po_number = '') {
+		$this->set('PAY_po_number', $po_number);
 	}
 
 
@@ -186,8 +186,8 @@ 
 	 * @param string $extra_accntng
 	 * @throws \EE_Error
 	 */
-	public function set_extra_accntng( $extra_accntng = '' ) {
-		$this->set( 'PAY_extra_accntng', $extra_accntng );
+	public function set_extra_accntng($extra_accntng = '') {
+		$this->set('PAY_extra_accntng', $extra_accntng);
 	}
 
 
@@ -199,11 +199,11 @@ 
 	 * @param bool $via_admin
 	 * @throws \EE_Error
 	 */
-	public function set_payment_made_via_admin( $via_admin = false ) {
-		if ( $via_admin ) {
-			$this->set( 'PAY_source', EEM_Payment_Method::scope_admin );
+	public function set_payment_made_via_admin($via_admin = false) {
+		if ($via_admin) {
+			$this->set('PAY_source', EEM_Payment_Method::scope_admin);
 		} else {
-			$this->set( 'PAY_source', EEM_Payment_Method::scope_cart );
+			$this->set('PAY_source', EEM_Payment_Method::scope_cart);
 		}
 	}
 
@@ -216,13 +216,13 @@ 
 	 * @param string|array $details
 	 * @throws \EE_Error
 	 */
-	public function set_details( $details = '' ) {
-		if ( is_array( $details ) ) {
-			array_walk_recursive( $details, array( $this, '_strip_all_tags_within_array' ) );
+	public function set_details($details = '') {
+		if (is_array($details)) {
+			array_walk_recursive($details, array($this, '_strip_all_tags_within_array'));
 		} else {
-			$details = wp_strip_all_tags( $details );
+			$details = wp_strip_all_tags($details);
 		}
-		$this->set( 'PAY_details', $details );
+		$this->set('PAY_details', $details);
 	}
 
 
@@ -233,8 +233,8 @@ 
 	 * @param string $redirect_url
 	 * @throws \EE_Error
 	 */
-	public function set_redirect_url( $redirect_url ) {
-		$this->set( 'PAY_redirect_url', $redirect_url );
+	public function set_redirect_url($redirect_url) {
+		$this->set('PAY_redirect_url', $redirect_url);
 	}
 
 
@@ -245,8 +245,8 @@ 
 	 * @param array $redirect_args
 	 * @throws \EE_Error
 	 */
-	public function set_redirect_args( $redirect_args ) {
-		$this->set( 'PAY_redirect_args', $redirect_args );
+	public function set_redirect_args($redirect_args) {
+		$this->set('PAY_redirect_args', $redirect_args);
 	}
 
 
@@ -258,7 +258,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function TXN_ID() {
-		return $this->get( 'TXN_ID' );
+		return $this->get('TXN_ID');
 	}
 
 
@@ -270,7 +270,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function status() {
-		return $this->get( 'STS_ID' );
+		return $this->get('STS_ID');
 	}
 
 
@@ -282,7 +282,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function STS_ID() {
-		return $this->get( 'STS_ID' );
+		return $this->get('STS_ID');
 	}
 
 
@@ -296,8 +296,8 @@ 
 	 * @return string
 	 * @throws \EE_Error
 	 */
-	public function timestamp( $dt_frmt = '', $tm_frmt = '' ) {
-		return $this->get_datetime( 'PAY_timestamp', $dt_frmt, $tm_frmt );
+	public function timestamp($dt_frmt = '', $tm_frmt = '') {
+		return $this->get_datetime('PAY_timestamp', $dt_frmt, $tm_frmt);
 	}
 
 
@@ -309,7 +309,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function source() {
-		return $this->get( 'PAY_source' );
+		return $this->get('PAY_source');
 	}
 
 
@@ -322,7 +322,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function amount() {
-		return (float)$this->get( 'PAY_amount' );
+		return (float) $this->get('PAY_amount');
 	}
 
 
@@ -332,7 +332,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function amount_no_code() {
-		return $this->get_pretty( 'PAY_amount', 'no_currency_code' );
+		return $this->get_pretty('PAY_amount', 'no_currency_code');
 	}
 
 
@@ -344,7 +344,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function gateway_response() {
-		return $this->get( 'PAY_gateway_response' );
+		return $this->get('PAY_gateway_response');
 	}
 
 
@@ -356,7 +356,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function txn_id_chq_nmbr() {
-		return $this->get( 'PAY_txn_id_chq_nmbr' );
+		return $this->get('PAY_txn_id_chq_nmbr');
 	}
 
 
@@ -368,7 +368,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function po_number() {
-		return $this->get( 'PAY_po_number' );
+		return $this->get('PAY_po_number');
 	}
 
 
@@ -380,7 +380,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function extra_accntng() {
-		return $this->get( 'PAY_extra_accntng' );
+		return $this->get('PAY_extra_accntng');
 	}
 
 
@@ -392,7 +392,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function payment_made_via_admin() {
-		return ( $this->get( 'PAY_source' ) === EEM_Payment_Method::scope_admin );
+		return ($this->get('PAY_source') === EEM_Payment_Method::scope_admin);
 	}
 
 
@@ -404,7 +404,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function details() {
-		return $this->get( 'PAY_details' );
+		return $this->get('PAY_details');
 	}
 
 
@@ -416,7 +416,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function redirect_url() {
-		return $this->get( 'PAY_redirect_url' );
+		return $this->get('PAY_redirect_url');
 	}
 
 
@@ -428,7 +428,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function redirect_args() {
-		return $this->get( 'PAY_redirect_args' );
+		return $this->get('PAY_redirect_args');
 	}
 
 
@@ -440,8 +440,8 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	public function e_pretty_status( $show_icons = false ) {
-		echo $this->pretty_status( $show_icons );
+	public function e_pretty_status($show_icons = false) {
+		echo $this->pretty_status($show_icons);
 	}
 
 
@@ -453,14 +453,14 @@ 
 	 * @return string
 	 * @throws \EE_Error
 	 */
-	public function pretty_status( $show_icons = false ) {
+	public function pretty_status($show_icons = false) {
 		$status = EEM_Status::instance()->localized_status(
-			array( $this->STS_ID() => __( 'unknown', 'event_espresso' ) ),
+			array($this->STS_ID() => __('unknown', 'event_espresso')),
 			false,
 			'sentence'
 		);
 		$icon = '';
-		switch ( $this->STS_ID() ) {
+		switch ($this->STS_ID()) {
 			case EEM_Payment::status_id_approved:
 				$icon = $show_icons
 					? '<span class="dashicons dashicons-yes ee-icon-size-24 green-text"></span>'
@@ -482,7 +482,7 @@ 
 					: '';
 				break;
 		}
-		return $icon . $status[ $this->STS_ID() ];
+		return $icon.$status[$this->STS_ID()];
 	}
 
 
@@ -494,7 +494,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function is_approved() {
-		return $this->status_is( EEM_Payment::status_id_approved );
+		return $this->status_is(EEM_Payment::status_id_approved);
 	}
 
 
@@ -508,7 +508,7 @@ 
 	 * @return boolean whether the status of this payment equals the status id
 	 * @throws \EE_Error
 	 */
-	protected function status_is( $STS_ID ) {
+	protected function status_is($STS_ID) {
 		return $STS_ID === $this->STS_ID() ? true : false;
 	}
 
@@ -521,7 +521,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function is_pending() {
-		return $this->status_is( EEM_Payment::status_id_pending );
+		return $this->status_is(EEM_Payment::status_id_pending);
 	}
 
 
@@ -533,7 +533,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function is_cancelled() {
-		return $this->status_is( EEM_Payment::status_id_cancelled );
+		return $this->status_is(EEM_Payment::status_id_cancelled);
 	}
 
 
@@ -545,7 +545,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function is_declined() {
-		return $this->status_is( EEM_Payment::status_id_declined );
+		return $this->status_is(EEM_Payment::status_id_declined);
 	}
 
 
@@ -557,7 +557,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function is_failed() {
-		return $this->status_is( EEM_Payment::status_id_failed );
+		return $this->status_is(EEM_Payment::status_id_failed);
 	}
 
 
@@ -581,7 +581,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function status_obj() {
-		return $this->get_first_related( 'Status' );
+		return $this->get_first_related('Status');
 	}
 
 
@@ -593,8 +593,8 @@ 
 	 * @return EE_Extra_Meta
 	 * @throws \EE_Error
 	 */
-	public function extra_meta( $query_params = array() ) {
-		return $this->get_many_related( 'Extra_Meta', $query_params );
+	public function extra_meta($query_params = array()) {
+		return $this->get_many_related('Extra_Meta', $query_params);
 	}
 
 
@@ -608,7 +608,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function payment_method() {
-		return $this->get_first_related( 'Payment_Method' );
+		return $this->get_first_related('Payment_Method');
 	}
 
 
@@ -626,18 +626,18 @@ 
 	 * @return string html
 	 * @throws \EE_Error
 	 */
-	public function redirect_form( $inside_form_html = null ) {
+	public function redirect_form($inside_form_html = null) {
 		$redirect_url = $this->redirect_url();
-		if ( ! empty( $redirect_url ) ) {
+		if ( ! empty($redirect_url)) {
 			// what ? no inner form content?
-			if ( $inside_form_html === null ) {
+			if ($inside_form_html === null) {
 				$inside_form_html = EEH_HTML::p(
 					sprintf(
 						__(
 							'If you are not automatically redirected to the payment website within 10 seconds... %1$s %2$s Click Here %3$s',
 							'event_espresso'
 						),
-						EEH_HTML::br( 2 ),
+						EEH_HTML::br(2),
 						'<input type="submit" value="',
 						'">'
 					),
@@ -653,22 +653,22 @@ 
 			);
 			//if it's a GET request, we need to remove all the GET params in the querystring
 			//and put them into the form instead
-			if ( $method === 'GET' ) {
-				$querystring = parse_url( $redirect_url, PHP_URL_QUERY );
+			if ($method === 'GET') {
+				$querystring = parse_url($redirect_url, PHP_URL_QUERY);
 				$get_params = null;
-				parse_str( $querystring, $get_params );
-				$inside_form_html .= $this->_args_as_inputs( $get_params );
-				$redirect_url = str_replace( '?' . $querystring, '', $redirect_url );
+				parse_str($querystring, $get_params);
+				$inside_form_html .= $this->_args_as_inputs($get_params);
+				$redirect_url = str_replace('?'.$querystring, '', $redirect_url);
 			}
-			$form = EEH_HTML::nl( 1 )
+			$form = EEH_HTML::nl(1)
 			        . '<form method="'
 			        . $method
 			        . '" name="gateway_form" action="'
 			        . $redirect_url
 			        . '">';
-			$form .= EEH_HTML::nl( 1 ) . $this->redirect_args_as_inputs();
+			$form .= EEH_HTML::nl(1).$this->redirect_args_as_inputs();
 			$form .= $inside_form_html;
-			$form .= EEH_HTML::nl( -1 ) . '</form>' . EEH_HTML::nl( -1 );
+			$form .= EEH_HTML::nl( -1 ).'</form>'.EEH_HTML::nl( -1 );
 			return $form;
 		} else {
 			return null;
@@ -685,7 +685,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function redirect_args_as_inputs() {
-		return $this->_args_as_inputs( $this->redirect_args() );
+		return $this->_args_as_inputs($this->redirect_args());
 	}
 
 
@@ -697,15 +697,15 @@ 
 	 * @param array $args key-value pairs
 	 * @return string
 	 */
-	protected function _args_as_inputs( $args ) {
+	protected function _args_as_inputs($args) {
 		$html = '';
-		if ( $args !== null && is_array( $args ) ) {
-			foreach ( $args as $name => $value ) {
-				$html .= EEH_HTML::nl( 0 )
+		if ($args !== null && is_array($args)) {
+			foreach ($args as $name => $value) {
+				$html .= EEH_HTML::nl(0)
 				         . '<input type="hidden" name="'
 				         . $name
 				         . '" value="'
-				         . esc_attr( $value )
+				         . esc_attr($value)
 				         . '"/>';
 			}
 		}
@@ -734,14 +734,14 @@ 
 	 * @access private
 	 * @param mixed $item
 	 */
-	private function _strip_all_tags_within_array( &$item ) {
-		if ( is_object( $item ) ) {
-			$item = (array)$item;
+	private function _strip_all_tags_within_array(&$item) {
+		if (is_object($item)) {
+			$item = (array) $item;
 		}
-		if ( is_array( $item ) ) {
-			array_walk_recursive( $item, array( $this, '_strip_all_tags_within_array' ) );
+		if (is_array($item)) {
+			array_walk_recursive($item, array($this, '_strip_all_tags_within_array'));
 		} else {
-			$item = wp_strip_all_tags( $item );
+			$item = wp_strip_all_tags($item);
 		}
 	}
 
@@ -758,7 +758,7 @@ 
 		$original_status = EEH_Array::is_set(
 			$this->_props_n_values_provided_in_constructor,
 			'STS_ID',
-			$this->get_model()->field_settings_for( 'STS_ID' )->get_default_value()
+			$this->get_model()->field_settings_for('STS_ID')->get_default_value()
 		);
 		$current_status = $this->status();
 		if (
@@ -784,11 +784,11 @@ 
 	 * @return mixed
 	 * @throws \EE_Error
 	 */
-	public function get_pretty( $field_name, $extra_cache_ref = null ) {
-		if ( $field_name === 'PAY_gateway' ) {
-			return $this->payment_method() ? $this->payment_method()->name() : __( 'Unknown', 'event_espresso' );
+	public function get_pretty($field_name, $extra_cache_ref = null) {
+		if ($field_name === 'PAY_gateway') {
+			return $this->payment_method() ? $this->payment_method()->name() : __('Unknown', 'event_espresso');
 		}
-		return $this->_get_cached_property( $field_name, true, $extra_cache_ref );
+		return $this->_get_cached_property($field_name, true, $extra_cache_ref);
 	}
 
 
@@ -800,8 +800,8 @@ 
 	 * @return EE_Registration_Payment[]
 	 * @throws \EE_Error
 	 */
-	public function registration_payments( $query_params = array() ) {
-		return $this->get_many_related( 'Registration_Payment', $query_params );
+	public function registration_payments($query_params = array()) {
+		return $this->get_many_related('Registration_Payment', $query_params);
 	}
 
 

core/db_classes/EE_Registration.class.php

Doc Comments +4 added lines, -3 removed lines

@@ -802,7 +802,7 @@ 
 	 * (either the question's ID or a question object)
 	 * @param EE_Question|int $question
 	 * @param bool            $pretty_value
-	 * @return array|string if pretty_value= true, the result will always be a string
+	 * @return string if pretty_value= true, the result will always be a string
 	 * (because the answer might be an array of answer values, so passing pretty_value=true
 	 * will convert it into some kind of string)
 	 */
@@ -901,7 +901,7 @@ 
 	/**
 	 * Sets deleted
 	 * @param boolean $deleted
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	public function set_deleted($deleted) {
 		$this->set( 'REG_deleted', $deleted );
@@ -945,6 +945,7 @@ 
 	 *
 	 * @param int | EE_Datetime $DTT_OR_ID The datetime the registration is being checked against
 	 * @param bool   $check_approved   This is used to indicate whether the caller wants can_checkin to also consider registration status as well as datetime access.
+	 * @param integer $DTT_OR_ID
 	 *
 	 * @return bool
 	 */
@@ -1305,7 +1306,7 @@ 
 	 * This grabs the payment method corresponding to the last payment made for the amount owing on the registration.
 	 * Note: if there are no payments on the registration there will be no payment method returned.
 	 *
-	 * @return EE_Payment_Method|null
+	 * @return EE_Base_Class|null
 	 */
 	public function payment_method() {
 		return EEM_Payment_Method::instance()->get_last_used_for_registration( $this );

Spacing +188 added lines, -188 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');
 }
 /**
  * EE_Registration class
@@ -41,9 +41,9 @@ 
 	 *                             		    date_format and the second value is the time format
 	 * @return EE_Registration
 	 */
-	public static function new_instance( $props_n_values = array(), $timezone = null, $date_formats = array() ) {
-		$has_object = parent::_check_for_object( $props_n_values, __CLASS__, $timezone, $date_formats );
-		return $has_object ? $has_object : new self( $props_n_values, false, $timezone, $date_formats );
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array()) {
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
 	}
 
 
@@ -54,8 +54,8 @@ 
 	 *                          		the website will be used.
 	 * @return EE_Registration
 	 */
-	public static function new_instance_from_db( $props_n_values = array(), $timezone = null ) {
-		return new self( $props_n_values, TRUE, $timezone );
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null) {
+		return new self($props_n_values, TRUE, $timezone);
 	}
 
 
@@ -66,8 +66,8 @@ 
 	 * @access        public
 	 * @param        int $EVT_ID Event ID
 	 */
-	public function set_event( $EVT_ID = 0 ) {
-		$this->set( 'EVT_ID', $EVT_ID );
+	public function set_event($EVT_ID = 0) {
+		$this->set('EVT_ID', $EVT_ID);
 	}
 
 
@@ -78,18 +78,18 @@ 
 	 * @param mixed  $field_value
 	 * @param bool   $use_default
 	 */
-	public function set( $field_name, $field_value, $use_default = FALSE ) {
-		switch( $field_name ) {
+	public function set($field_name, $field_value, $use_default = FALSE) {
+		switch ($field_name) {
 			case 'REG_code' :
-				if ( ! empty( $field_value ) && $this->reg_code() == '' ) {
-					$this->set_reg_code( $field_value, $use_default );
+				if ( ! empty($field_value) && $this->reg_code() == '') {
+					$this->set_reg_code($field_value, $use_default);
 				}
 				break;
 			case 'STS_ID' :
-				$this->set_status( $field_value, $use_default );
+				$this->set_status($field_value, $use_default);
 				break;
 			default :
-				parent::set( $field_name, $field_value, $use_default );
+				parent::set($field_name, $field_value, $use_default);
 		}
 	}
 
@@ -106,30 +106,30 @@ 
 	 * @param boolean $use_default
 	 * @return bool
 	 */
-	public function set_status( $new_STS_ID = NULL, $use_default = FALSE ) {
+	public function set_status($new_STS_ID = NULL, $use_default = FALSE) {
 		// get current REG_Status
 		$old_STS_ID = $this->status_ID();
 		// if status has changed
-		if ( $old_STS_ID != $new_STS_ID  ) {
+		if ($old_STS_ID != $new_STS_ID) {
 			// TO approved
-			if ( $new_STS_ID == EEM_Registration::status_id_approved ) {
+			if ($new_STS_ID == EEM_Registration::status_id_approved) {
 				// reserve a space by incrementing ticket and datetime sold values
 				$this->_reserve_registration_space();
-				do_action( 'AHEE__EE_Registration__set_status__to_approved', $this, $old_STS_ID, $new_STS_ID );
+				do_action('AHEE__EE_Registration__set_status__to_approved', $this, $old_STS_ID, $new_STS_ID);
 			// OR FROM  approved
-			} else if ( $old_STS_ID == EEM_Registration::status_id_approved ) {
+			} else if ($old_STS_ID == EEM_Registration::status_id_approved) {
 				// release a space by decrementing ticket and datetime sold values
 				$this->_release_registration_space();
-				do_action( 'AHEE__EE_Registration__set_status__from_approved', $this, $old_STS_ID, $new_STS_ID );
+				do_action('AHEE__EE_Registration__set_status__from_approved', $this, $old_STS_ID, $new_STS_ID);
 			}
 			// update status
-			parent::set( 'STS_ID', $new_STS_ID, $use_default );
-			do_action( 'AHEE__EE_Registration__set_status__after_update', $this );
+			parent::set('STS_ID', $new_STS_ID, $use_default);
+			do_action('AHEE__EE_Registration__set_status__after_update', $this);
 			return TRUE;
-		}else{
+		} else {
 			//even though the old value matches the new value, it's still good to
 			//allow the parent set method to have a say
-			parent::set( 'STS_ID', $new_STS_ID, $use_default );
+			parent::set('STS_ID', $new_STS_ID, $use_default);
 			return TRUE;
 		}
 	}
@@ -141,7 +141,7 @@ 
 	 * @access        public
 	 */
 	public function status_ID() {
-		return $this->get( 'STS_ID' );
+		return $this->get('STS_ID');
 	}
 
 
@@ -166,12 +166,12 @@ 
 	 * @param boolean $include_archived whether to include archived tickets or not.
 	 * @return EE_Ticket
 	 */
-	public function ticket( $include_archived = TRUE ) {
+	public function ticket($include_archived = TRUE) {
 		$query_params = array();
-		if ( $include_archived ) {
-			$query_params[ 'default_where_conditions' ] = 'none';
+		if ($include_archived) {
+			$query_params['default_where_conditions'] = 'none';
 		}
-		return $this->get_first_related( 'Ticket', $query_params );
+		return $this->get_first_related('Ticket', $query_params);
 	}
 
 
@@ -181,7 +181,7 @@ 
 	 * @return EE_Event
 	 */
 	public function event() {
-		return $this->get_first_related( 'Event' );
+		return $this->get_first_related('Event');
 	}
 
 
@@ -195,7 +195,7 @@ 
 	 */
 	public function wp_user() {
 		$event = $this->event();
-		if ( $event instanceof EE_Event ) {
+		if ($event instanceof EE_Event) {
 			return $event->wp_user();
 		}
 		return 0;
@@ -221,8 +221,8 @@ 
 	 * @access        public
 	 * @param        int $ATT_ID Attendee ID
 	 */
-	public function set_attendee_id( $ATT_ID = 0 ) {
-		$this->set( 'ATT_ID', $ATT_ID );
+	public function set_attendee_id($ATT_ID = 0) {
+		$this->set('ATT_ID', $ATT_ID);
 	}
 
 
@@ -233,8 +233,8 @@ 
 	 * @access        public
 	 * @param        int $TXN_ID Transaction ID
 	 */
-	public function set_transaction_id( $TXN_ID = 0 ) {
-		$this->set( 'TXN_ID', $TXN_ID );
+	public function set_transaction_id($TXN_ID = 0) {
+		$this->set('TXN_ID', $TXN_ID);
 	}
 
 
@@ -245,8 +245,8 @@ 
 	 * @access    public
 	 * @param    string $REG_session PHP Session ID
 	 */
-	public function set_session( $REG_session = '' ) {
-		$this->set( 'REG_session', $REG_session );
+	public function set_session($REG_session = '') {
+		$this->set('REG_session', $REG_session);
 	}
 
 
@@ -257,8 +257,8 @@ 
 	 * @access    public
 	 * @param    string $REG_url_link Registration URL Link
 	 */
-	public function set_reg_url_link( $REG_url_link = '' ) {
-		$this->set( 'REG_url_link', $REG_url_link );
+	public function set_reg_url_link($REG_url_link = '') {
+		$this->set('REG_url_link', $REG_url_link);
 	}
 
 
@@ -269,8 +269,8 @@ 
 	 * @access        public
 	 * @param        int $REG_count Primary Attendee
 	 */
-	public function set_count( $REG_count = 1 ) {
-		$this->set( 'REG_count', $REG_count );
+	public function set_count($REG_count = 1) {
+		$this->set('REG_count', $REG_count);
 	}
 
 
@@ -281,8 +281,8 @@ 
 	 * @access        public
 	 * @param        boolean $REG_group_size Group Registration
 	 */
-	public function set_group_size( $REG_group_size = FALSE ) {
-		$this->set( 'REG_group_size', $REG_group_size );
+	public function set_group_size($REG_group_size = FALSE) {
+		$this->set('REG_group_size', $REG_group_size);
 	}
 
 
@@ -365,8 +365,8 @@ 
 	 * @access        public
 	 * @param        mixed ( int or string ) $REG_date Registration Date - Unix timestamp or string representation of Date
 	 */
-	public function set_reg_date( $REG_date = FALSE ) {
-		$this->set( 'REG_date', $REG_date );
+	public function set_reg_date($REG_date = FALSE) {
+		$this->set('REG_date', $REG_date);
 	}
 
 
@@ -377,8 +377,8 @@ 
 	 * @access    public
 	 * @param    float $REG_final_price
 	 */
-	public function set_final_price( $REG_final_price = 0.00 ) {
-		$this->set( 'REG_final_price', $REG_final_price );
+	public function set_final_price($REG_final_price = 0.00) {
+		$this->set('REG_final_price', $REG_final_price);
 	}
 
 
@@ -389,8 +389,8 @@ 
 	 * @access    public
 	 * @param    float $REG_paid
 	 */
-	public function set_paid( $REG_paid = 0.00 ) {
-		$this->set( 'REG_paid', $REG_paid );
+	public function set_paid($REG_paid = 0.00) {
+		$this->set('REG_paid', $REG_paid);
 	}
 
 
@@ -401,8 +401,8 @@ 
 	 * @access        public
 	 * @param        boolean $REG_att_is_going Attendee Is Going
 	 */
-	public function set_att_is_going( $REG_att_is_going = FALSE ) {
-		$this->set( 'REG_att_is_going', $REG_att_is_going );
+	public function set_att_is_going($REG_att_is_going = FALSE) {
+		$this->set('REG_att_is_going', $REG_att_is_going);
 	}
 
 
@@ -412,7 +412,7 @@ 
 	 * @return EE_Attendee
 	 */
 	public function attendee() {
-		return $this->get_first_related( 'Attendee' );
+		return $this->get_first_related('Attendee');
 	}
 
 
@@ -422,7 +422,7 @@ 
 	 * @access        public
 	 */
 	public function event_ID() {
-		return $this->get( 'EVT_ID' );
+		return $this->get('EVT_ID');
 	}
 
 
@@ -433,7 +433,7 @@ 
 	 */
 	public function event_name() {
 		$event = $this->event_obj();
-		if ( $event ) {
+		if ($event) {
 			return $event->name();
 		} else {
 			return NULL;
@@ -447,7 +447,7 @@ 
 	 * @return EE_Event
 	 */
 	public function event_obj() {
-		return $this->get_first_related( 'Event' );
+		return $this->get_first_related('Event');
 	}
 
 
@@ -457,7 +457,7 @@ 
 	 * @access        public
 	 */
 	public function attendee_ID() {
-		return $this->get( 'ATT_ID' );
+		return $this->get('ATT_ID');
 	}
 
 
@@ -467,7 +467,7 @@ 
 	 * @access        public
 	 */
 	public function session_ID() {
-		return $this->get( 'REG_session' );
+		return $this->get('REG_session');
 	}
 
 
@@ -477,7 +477,7 @@ 
 	 * @param string $messenger 'pdf' or 'html'.  Default 'html'.
 	 * @return string
 	 */
-	public function receipt_url( $messenger = 'html' ) {
+	public function receipt_url($messenger = 'html') {
 
 		/**
 		 * The below will be deprecated one version after this.  We check first if there is a custom receipt template already in use on old system.  If there is then we just return the standard url for it.
@@ -485,12 +485,12 @@ 
 		 * @since 4.5.0
 		 */
 		$template_relative_path = 'modules/gateways/Invoice/lib/templates/receipt_body.template.php';
-		$has_custom = EEH_Template::locate_template( $template_relative_path , array(), TRUE, TRUE, TRUE );
+		$has_custom = EEH_Template::locate_template($template_relative_path, array(), TRUE, TRUE, TRUE);
 
-		if ( $has_custom ) {
-			return add_query_arg( array( 'receipt' => 'true' ), $this->invoice_url( 'launch' ) );
+		if ($has_custom) {
+			return add_query_arg(array('receipt' => 'true'), $this->invoice_url('launch'));
 		}
-		return apply_filters( 'FHEE__EE_Registration__receipt_url__receipt_url', '', $this, $messenger, 'receipt' );
+		return apply_filters('FHEE__EE_Registration__receipt_url__receipt_url', '', $this, $messenger, 'receipt');
 	}
 
 
@@ -501,28 +501,28 @@ 
 	 * @param string $messenger 'pdf' or 'html'.  Default 'html'.
 	 * @return string
 	 */
-	public function invoice_url( $messenger = 'html' ) {
+	public function invoice_url($messenger = 'html') {
 		/**
 		 * The below will be deprecated one version after this.  We check first if there is a custom invoice template already in use on old system.  If there is then we just return the standard url for it.
 		 *
 		 * @since 4.5.0
 		 */
 		$template_relative_path = 'modules/gateways/Invoice/lib/templates/invoice_body.template.php';
-		$has_custom = EEH_Template::locate_template( $template_relative_path , array(), TRUE, TRUE, TRUE );
+		$has_custom = EEH_Template::locate_template($template_relative_path, array(), TRUE, TRUE, TRUE);
 
-		if ( $has_custom ) {
-			if ( $messenger == 'html' ) {
-				return $this->invoice_url( 'launch' );
+		if ($has_custom) {
+			if ($messenger == 'html') {
+				return $this->invoice_url('launch');
 			}
 			$route = $messenger == 'download' || $messenger == 'pdf' ? 'download_invoice' : 'launch_invoice';
 
-			$query_args = array( 'ee' => $route, 'id' => $this->reg_url_link() );
-			if ( $messenger == 'html' ) {
+			$query_args = array('ee' => $route, 'id' => $this->reg_url_link());
+			if ($messenger == 'html') {
 				$query_args['html'] = TRUE;
 			}
-			return add_query_arg( $query_args, get_permalink( EE_Registry::instance()->CFG->core->thank_you_page_id ) );
+			return add_query_arg($query_args, get_permalink(EE_Registry::instance()->CFG->core->thank_you_page_id));
 		}
-		return apply_filters( 'FHEE__EE_Registration__invoice_url__invoice_url', '', $this, $messenger, 'invoice' );
+		return apply_filters('FHEE__EE_Registration__invoice_url__invoice_url', '', $this, $messenger, 'invoice');
 	}
 
 
@@ -535,7 +535,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public function reg_url_link() {
-		return (string)$this->get( 'REG_url_link' );
+		return (string) $this->get('REG_url_link');
 	}
 
 
@@ -545,8 +545,8 @@ 
 	 * @param string $type 'download','launch', or 'html' (default is 'launch')
 	 * @return void
 	 */
-	public function e_invoice_url( $type = 'launch' ) {
-		echo $this->invoice_url( $type );
+	public function e_invoice_url($type = 'launch') {
+		echo $this->invoice_url($type);
 	}
 
 
@@ -566,7 +566,7 @@ 
 	 * @return string
 	 */
 	public function payment_overview_url() {
-		return add_query_arg( array( 'e_reg_url_link' => $this->reg_url_link(), 'step' => 'payment_options', 'revisit' => TRUE ), EE_Registry::instance()->CFG->core->reg_page_url() );
+		return add_query_arg(array('e_reg_url_link' => $this->reg_url_link(), 'step' => 'payment_options', 'revisit' => TRUE), EE_Registry::instance()->CFG->core->reg_page_url());
 	}
 
 
@@ -577,7 +577,7 @@ 
 	 * @return string
 	 */
 	public function edit_attendee_information_url() {
-		return add_query_arg( array( 'e_reg_url_link' => $this->reg_url_link(), 'step' => 'attendee_information', 'revisit' => TRUE ), EE_Registry::instance()->CFG->core->reg_page_url() );
+		return add_query_arg(array('e_reg_url_link' => $this->reg_url_link(), 'step' => 'attendee_information', 'revisit' => TRUE), EE_Registry::instance()->CFG->core->reg_page_url());
 	}
 
 
@@ -587,7 +587,7 @@ 
 	 * @return string
 	 */
 	public function get_admin_edit_url() {
-		return EEH_URL::add_query_args_and_nonce( array( 'page' => 'espresso_registrations', 'action' => 'view_registration', '_REG_ID' => $this->ID() ), admin_url( 'admin.php' ) );
+		return EEH_URL::add_query_args_and_nonce(array('page' => 'espresso_registrations', 'action' => 'view_registration', '_REG_ID' => $this->ID()), admin_url('admin.php'));
 	}
 
 
@@ -597,7 +597,7 @@ 
 	 * @access        public
 	 */
 	public function is_primary_registrant() {
-		return $this->get( 'REG_count' ) == 1 ? TRUE : FALSE;
+		return $this->get('REG_count') == 1 ? TRUE : FALSE;
 	}
 
 
@@ -606,12 +606,12 @@ 
 	 * This returns the primary registration object for this registration group (which may be this object).
 	 * @return EE_Registration
 	 */
-	public function get_primary_registration()  {
-		if ( $this->is_primary_registrant() )
+	public function get_primary_registration() {
+		if ($this->is_primary_registrant())
 			return $this;
 
 		//k reg_count !== 1 so let's get the EE_Registration object matching this txn_id and reg_count == 1
-		$primary_registrant = EEM_Registration::instance()->get_one( array( array('TXN_ID' => $this->transaction_ID(), 'REG_count' => 1 ) ) );
+		$primary_registrant = EEM_Registration::instance()->get_one(array(array('TXN_ID' => $this->transaction_ID(), 'REG_count' => 1)));
 		return $primary_registrant;
 	}
 
@@ -622,7 +622,7 @@ 
 	* 		@access		public
 	*/
 	public function count() {
-		return $this->get( 'REG_count' );
+		return $this->get('REG_count');
 	}
 
 
@@ -632,7 +632,7 @@ 
 	 * @access        public
 	 */
 	public function group_size() {
-		return $this->get( 'REG_group_size' );
+		return $this->get('REG_group_size');
 	}
 
 
@@ -642,7 +642,7 @@ 
 	 * @access        public
 	 */
 	public function date() {
-		return $this->get( 'REG_date' );
+		return $this->get('REG_date');
 	}
 
 
@@ -653,8 +653,8 @@ 
 	 * @param string $time_format
 	 * @return string
 	 */
-	public function pretty_date( $date_format = NULL, $time_format = NULL ) {
-		return $this->get_datetime( 'REG_date', $date_format, $time_format );
+	public function pretty_date($date_format = NULL, $time_format = NULL) {
+		return $this->get_datetime('REG_date', $date_format, $time_format);
 	}
 
 
@@ -667,7 +667,7 @@ 
 	 * @return    float
 	 */
 	public function final_price() {
-		return $this->get( 'REG_final_price' );
+		return $this->get('REG_final_price');
 	}
 
 
@@ -678,7 +678,7 @@ 
 	 * @return string
 	 */
 	public function pretty_final_price() {
-		return $this->get_pretty( 'REG_final_price' );
+		return $this->get_pretty('REG_final_price');
 	}
 
 
@@ -689,7 +689,7 @@ 
 	 * @return 	float
 	 */
 	public function paid() {
-		return $this->get( 'REG_paid' );
+		return $this->get('REG_paid');
 	}
 
 
@@ -700,7 +700,7 @@ 
 	 * @return 	float
 	 */
 	public function pretty_paid() {
-		return $this->get_pretty( 'REG_paid' );
+		return $this->get_pretty('REG_paid');
 	}
 
 
@@ -712,11 +712,11 @@ 
 	 * @param array $requires_payment
 	 * @return bool
 	 */
-	public function owes_monies_and_can_pay( $requires_payment = array()) {
+	public function owes_monies_and_can_pay($requires_payment = array()) {
 		// these reg statuses require payment (if event is not free)
-		$requires_payment = ! empty( $requires_payment ) ? $requires_payment : EEM_Registration::reg_statuses_that_allow_payment();
+		$requires_payment = ! empty($requires_payment) ? $requires_payment : EEM_Registration::reg_statuses_that_allow_payment();
 		if (
-			in_array( $this->status_ID(), $requires_payment ) &&
+			in_array($this->status_ID(), $requires_payment) &&
 			$this->final_price() != 0 &&
 			$this->final_price() != $this->paid()
 		) {
@@ -733,8 +733,8 @@ 
 	 * @param bool $show_icons
 	 * @return void
 	 */
-	public function e_pretty_status( $show_icons = FALSE ) {
-		echo $this->pretty_status( $show_icons );
+	public function e_pretty_status($show_icons = FALSE) {
+		echo $this->pretty_status($show_icons);
 	}
 
 
@@ -745,10 +745,10 @@ 
 	 * @param bool $show_icons
 	 * @return string
 	 */
-	public function pretty_status( $show_icons = FALSE ) {
-		$status = EEM_Status::instance()->localized_status( array( $this->status_ID() => __( 'unknown', 'event_espresso' ) ), FALSE, 'sentence' );
+	public function pretty_status($show_icons = FALSE) {
+		$status = EEM_Status::instance()->localized_status(array($this->status_ID() => __('unknown', 'event_espresso')), FALSE, 'sentence');
 		$icon = '';
-		switch ( $this->status_ID() ) {
+		switch ($this->status_ID()) {
 			case EEM_Registration::status_id_approved:
 				$icon = $show_icons ? '<span class="dashicons dashicons-star-filled ee-icon-size-16 green-text"></span>' : '';
 				break;
@@ -768,7 +768,7 @@ 
 				$icon = $show_icons ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>' : '';
 				break;
 		}
-		return $icon . $status[ $this->status_ID() ];
+		return $icon.$status[$this->status_ID()];
 	}
 
 
@@ -778,7 +778,7 @@ 
 	 * @access        public
 	 */
 	public function att_is_going() {
-		return $this->get( 'REG_att_is_going' );
+		return $this->get('REG_att_is_going');
 	}
 
 
@@ -788,8 +788,8 @@ 
 	 * @param array $query_params like EEM_Base::get_all
 	 * @return EE_Answer[]
 	 */
-	public function answers( $query_params = NULL ) {
-		return $this->get_many_related( 'Answer', $query_params );
+	public function answers($query_params = NULL) {
+		return $this->get_many_related('Answer', $query_params);
 	}
 
 
@@ -803,9 +803,9 @@ 
 	 * (because the answer might be an array of answer values, so passing pretty_value=true
 	 * will convert it into some kind of string)
 	 */
-	public function answer_value_to_question( $question, $pretty_value=true ) {
+	public function answer_value_to_question($question, $pretty_value = true) {
 		$question_id = EEM_Question::instance()->ensure_is_ID($question);
-		return EEM_Answer::instance()->get_answer_value_to_question($this,$question_id,$pretty_value);
+		return EEM_Answer::instance()->get_answer_value_to_question($this, $question_id, $pretty_value);
 	}
 
 
@@ -818,13 +818,13 @@ 
 	 */
 	public function question_groups() {
 		$question_groups = array();
-		if ( $this->event() instanceof EE_Event ) {
+		if ($this->event() instanceof EE_Event) {
 			$question_groups = $this->event()->question_groups(
 				array(
 					array(
 						'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false
 					),
-					'order_by' => array( 'QSG_order' => 'ASC' )
+					'order_by' => array('QSG_order' => 'ASC')
 				)
 			);
 		}
@@ -841,7 +841,7 @@ 
 	 */
 	public function count_question_groups() {
 		$qg_count = 0;
-		if ( $this->event() instanceof EE_Event ) {
+		if ($this->event() instanceof EE_Event) {
 			$qg_count = $this->event()->count_related(
 				'Question_Group',
 				array(
@@ -862,7 +862,7 @@ 
 	 * @return string
 	 */
 	public function reg_date() {
-		return $this->get_datetime( 'REG_date' );
+		return $this->get_datetime('REG_date');
 	}
 
 
@@ -874,7 +874,7 @@ 
 	 * @return EE_Datetime_Ticket
 	 */
 	public function datetime_ticket() {
-		return $this->get_first_related( 'Datetime_Ticket' );
+		return $this->get_first_related('Datetime_Ticket');
 	}
 
 
@@ -884,15 +884,15 @@ 
 	 * @param EE_Datetime_Ticket $datetime_ticket
 	 * @return EE_Datetime_Ticket
 	 */
-	public function set_datetime_ticket( $datetime_ticket ) {
-		return $this->_add_relation_to( $datetime_ticket, 'Datetime_Ticket' );
+	public function set_datetime_ticket($datetime_ticket) {
+		return $this->_add_relation_to($datetime_ticket, 'Datetime_Ticket');
 	}
 	/**
 	 * Gets deleted
 	 * @return boolean
 	 */
 	public function deleted() {
-		return $this->get( 'REG_deleted' );
+		return $this->get('REG_deleted');
 	}
 
 	/**
@@ -901,7 +901,7 @@ 
 	 * @return boolean
 	 */
 	public function set_deleted($deleted) {
-		$this->set( 'REG_deleted', $deleted );
+		$this->set('REG_deleted', $deleted);
 	}
 
 
@@ -911,7 +911,7 @@ 
 	 * @return EE_Status
 	 */
 	public function status_obj() {
-		return $this->get_first_related( 'Status' );
+		return $this->get_first_related('Status');
 	}
 
 
@@ -922,7 +922,7 @@ 
 	 * @return int
 	 */
 	public function count_checkins() {
-		return $this->get_model()->count_related( $this, 'Checkin' );
+		return $this->get_model()->count_related($this, 'Checkin');
 	}
 
 
@@ -932,7 +932,7 @@ 
 	 * @return int
 	 */
 	public function count_checkins_not_checkedout() {
-		return $this->get_model()->count_related( $this, 'Checkin', array( array( 'CHK_in' => 1 ) ) );
+		return $this->get_model()->count_related($this, 'Checkin', array(array('CHK_in' => 1)));
 	}
 
 
@@ -945,20 +945,20 @@ 
 	 *
 	 * @return bool
 	 */
-	public function can_checkin( $DTT_OR_ID, $check_approved = TRUE ) {
-		$DTT_ID = EEM_Datetime::instance()->ensure_is_ID( $DTT_OR_ID );
+	public function can_checkin($DTT_OR_ID, $check_approved = TRUE) {
+		$DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
 
 		//first check registration status
-		if (  ( $check_approved && ! $this->is_approved() ) || ! $DTT_ID ) {
+		if (($check_approved && ! $this->is_approved()) || ! $DTT_ID) {
 			return false;
 		}
 		//is there a datetime ticket that matches this dtt_ID?
-		if ( ! ( EEM_Datetime_Ticket::instance()->exists( array( array( 'TKT_ID' => $this->get('TKT_ID' ), 'DTT_ID' => $DTT_ID ) ) ) ) ) {
+		if ( ! (EEM_Datetime_Ticket::instance()->exists(array(array('TKT_ID' => $this->get('TKT_ID'), 'DTT_ID' => $DTT_ID))))) {
 			return false;
 		}
 
 		//final check is against TKT_uses
-		return $this->verify_can_checkin_against_TKT_uses( $DTT_ID );
+		return $this->verify_can_checkin_against_TKT_uses($DTT_ID);
 	}
 
 
@@ -971,10 +971,10 @@ 
 	 * @param int | EE_Datetime  $DTT_OR_ID  The datetime the registration is being checked against
 	 * @return bool   true means can checkin.  false means cannot checkin.
 	 */
-	public function verify_can_checkin_against_TKT_uses( $DTT_OR_ID ) {
-		$DTT_ID = EEM_Datetime::instance()->ensure_is_ID( $DTT_OR_ID );
+	public function verify_can_checkin_against_TKT_uses($DTT_OR_ID) {
+		$DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
 
-		if ( ! $DTT_ID ) {
+		if ( ! $DTT_ID) {
 			return false;
 		}
 
@@ -982,23 +982,23 @@ 
 
 		// if max uses is not set or equals infinity then return true cause its not a factor for whether user can check-in
 		// or not.
-		if ( ! $max_uses || $max_uses === EE_INF ) {
+		if ( ! $max_uses || $max_uses === EE_INF) {
 			return true;
 		}
 
 		//does this datetime have a checkin record?  If so, then the dtt count has already been verified so we can just
 		//go ahead and toggle.
-		if ( EEM_Checkin::instance()->exists( array( array( 'REG_ID' => $this->ID(), 'DTT_ID' => $DTT_ID ) ) ) ) {
+		if (EEM_Checkin::instance()->exists(array(array('REG_ID' => $this->ID(), 'DTT_ID' => $DTT_ID)))) {
 			return true;
 		}
 
 		//made it here so the last check is whether the number of checkins per unique datetime on this registration
 		//disallows further check-ins.
-		$count_unique_dtt_checkins = EEM_Checkin::instance()->count( array( array( 'REG_ID' => $this->ID(), 'CHK_in' => true ) ), 'DTT_ID', true );
+		$count_unique_dtt_checkins = EEM_Checkin::instance()->count(array(array('REG_ID' => $this->ID(), 'CHK_in' => true)), 'DTT_ID', true);
 		// checkins have already reached their max number of uses
 		// so registrant can NOT checkin
-		if ( $count_unique_dtt_checkins >= $max_uses ) {
-			EE_Error::add_error( __( 'Check-in denied because number of datetime uses for the ticket has been reached or exceeded.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+		if ($count_unique_dtt_checkins >= $max_uses) {
+			EE_Error::add_error(__('Check-in denied because number of datetime uses for the ticket has been reached or exceeded.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
 		return true;
@@ -1019,15 +1019,15 @@ 
 	 * @param  bool $verify  If true then can_checkin() is used to verify whether the person can be checked in or not.  Otherwise this forces change in checkin status.
 	 * @return int|BOOL            the chk_in status toggled to OR false if nothing got changed.
 	 */
-	public function toggle_checkin_status( $DTT_ID = null, $verify = false ) {
-		if ( empty( $DTT_ID ) ) {
+	public function toggle_checkin_status($DTT_ID = null, $verify = false) {
+		if (empty($DTT_ID)) {
 			$datetime = $this->get_related_primary_datetime();
 			$DTT_ID = $datetime->ID();
 		// verify the registration can checkin for the given DTT_ID
-		} elseif ( ! $this->can_checkin( $DTT_ID, $verify ) ) {
+		} elseif ( ! $this->can_checkin($DTT_ID, $verify)) {
 			EE_Error::add_error(
 					sprintf(
-						__( 'The given registration (ID:%1$d) can not be checked in to the given DTT_ID (%2$d), because the registration does not have access', 'event_espresso'),
+						__('The given registration (ID:%1$d) can not be checked in to the given DTT_ID (%2$d), because the registration does not have access', 'event_espresso'),
 						$this->ID(),
 						$DTT_ID
 					),
@@ -1041,8 +1041,8 @@ 
 			EE_Registration::checkin_status_out => EE_Registration::checkin_status_in
 		);
 		//start by getting the current status so we know what status we'll be changing to.
-		$cur_status = $this->check_in_status_for_datetime( $DTT_ID, NULL );
-		$status_to = $status_paths[ $cur_status ];
+		$cur_status = $this->check_in_status_for_datetime($DTT_ID, NULL);
+		$status_to = $status_paths[$cur_status];
 		// database only records true for checked IN or false for checked OUT
 		// no record ( null ) means checked in NEVER, but we obviously don't save that
 		$new_status = $status_to == EE_Registration::checkin_status_in ? true : false;
@@ -1050,24 +1050,24 @@ 
 		// because we are keeping track of Check-ins over time.
 		// Eventually we'll probably want to show a list table
 		// for the individual Check-ins so that they can be managed.
-		$checkin = EE_Checkin::new_instance( array(
+		$checkin = EE_Checkin::new_instance(array(
 				'REG_ID' => $this->ID(),
 				'DTT_ID' => $DTT_ID,
 				'CHK_in' => $new_status
-		) );
+		));
 		// if the record could not be saved then return false
-		if ( $checkin->save() === 0 ) {
-			if ( WP_DEBUG ) {
+		if ($checkin->save() === 0) {
+			if (WP_DEBUG) {
 				global $wpdb;
 				$error = sprintf(
-					__( 'Registration check in update failed because of the following database error: %1$s%2$s', 'event_espresso' ),
+					__('Registration check in update failed because of the following database error: %1$s%2$s', 'event_espresso'),
 					'<br />',
 					$wpdb->last_error
 				);
 			} else {
-				$error = __( 'Registration check in update failed because of an unknown database error', 'event_espresso' );
+				$error = __('Registration check in update failed because of an unknown database error', 'event_espresso');
 			}
-			EE_Error::add_error( $error, __FILE__, __FUNCTION__, __LINE__ );
+			EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
 			return false;
 		}
 		return $status_to;
@@ -1091,19 +1091,19 @@ 
 	 * @param EE_Checkin $checkin If present, we use the given checkin object rather than the dtt_id.
 	 * @return int            Integer representing Check-in status.
 	 */
-	public function check_in_status_for_datetime( $DTT_ID = 0, $checkin = NULL ) {
-		if ( empty( $DTT_ID ) && ! $checkin instanceof EE_Checkin ) {
+	public function check_in_status_for_datetime($DTT_ID = 0, $checkin = NULL) {
+		if (empty($DTT_ID) && ! $checkin instanceof EE_Checkin) {
 			$datetime = $this->get_related_primary_datetime();
-			if ( ! $datetime instanceof EE_Datetime ) {
+			if ( ! $datetime instanceof EE_Datetime) {
 				return 0;
 			}
 			$DTT_ID = $datetime->ID();
 		//verify the registration can checkin for the given DTT_ID
 		}
 		//get checkin object (if exists)
-		$checkin = $checkin instanceof EE_Checkin ? $checkin : $this->get_first_related( 'Checkin', array( array( 'DTT_ID' => $DTT_ID ), 'order_by' => array( 'CHK_timestamp' => 'DESC' ) ) );
-		if ( $checkin instanceof EE_Checkin ) {
-			if ( $checkin->get( 'CHK_in' ) ) {
+		$checkin = $checkin instanceof EE_Checkin ? $checkin : $this->get_first_related('Checkin', array(array('DTT_ID' => $DTT_ID), 'order_by' => array('CHK_timestamp' => 'DESC')));
+		if ($checkin instanceof EE_Checkin) {
+			if ($checkin->get('CHK_in')) {
 				return EE_Registration::checkin_status_in; //checked in
 			} else {
 				return EE_Registration::checkin_status_out; //had checked in but is now checked out.
@@ -1121,28 +1121,28 @@ 
 	 * @param bool $error  This just flags that you want an error message returned. This is put in so that the error message can be customized with the attendee name.
 	 * @return string         internationalized message
 	 */
-	public function get_checkin_msg( $DTT_ID, $error = FALSE ) {
+	public function get_checkin_msg($DTT_ID, $error = FALSE) {
 		//let's get the attendee first so we can include the name of the attendee
-		$attendee = $this->get_first_related( 'Attendee' );
-		if ( $attendee instanceof EE_Attendee ) {
-			if ( $error ) {
-				return sprintf( __( "%s's check-in status was not changed.", "event_espresso" ), $attendee->full_name() );
+		$attendee = $this->get_first_related('Attendee');
+		if ($attendee instanceof EE_Attendee) {
+			if ($error) {
+				return sprintf(__("%s's check-in status was not changed.", "event_espresso"), $attendee->full_name());
 			}
-			$cur_status = $this->check_in_status_for_datetime( $DTT_ID );
+			$cur_status = $this->check_in_status_for_datetime($DTT_ID);
 			//what is the status message going to be?
-			switch ( $cur_status ) {
+			switch ($cur_status) {
 				case EE_Registration::checkin_status_never :
-					return sprintf( __( "%s has been removed from Check-in records", "event_espresso" ), $attendee->full_name() );
+					return sprintf(__("%s has been removed from Check-in records", "event_espresso"), $attendee->full_name());
 					break;
 				case EE_Registration::checkin_status_in :
-					return sprintf( __( '%s has been checked in', 'event_espresso' ), $attendee->full_name() );
+					return sprintf(__('%s has been checked in', 'event_espresso'), $attendee->full_name());
 					break;
 				case EE_Registration::checkin_status_out :
-					return sprintf( __( '%s has been checked out', 'event_espresso' ), $attendee->full_name() );
+					return sprintf(__('%s has been checked out', 'event_espresso'), $attendee->full_name());
 					break;
 			}
 		}
-		return __( "The check-in status could not be determined.", "event_espresso" );
+		return __("The check-in status could not be determined.", "event_espresso");
 	}
 
 
@@ -1152,7 +1152,7 @@ 
 	 * @return EE_Transaction
 	 */
 	public function transaction() {
-		return $this->get_first_related( 'Transaction' );
+		return $this->get_first_related('Transaction');
 	}
 
 
@@ -1163,7 +1163,7 @@ 
 	 * @access        public
 	 */
 	public function reg_code() {
-		return $this->get( 'REG_code' );
+		return $this->get('REG_code');
 	}
 
 
@@ -1173,7 +1173,7 @@ 
 	 * @access        public
 	 */
 	public function transaction_ID() {
-		return $this->get( 'TXN_ID' );
+		return $this->get('TXN_ID');
 	}
 
 
@@ -1182,7 +1182,7 @@ 
 	 * @return int
 	 */
 	public function ticket_ID() {
-		return $this->get( 'TKT_ID' );
+		return $this->get('TKT_ID');
 	}
 
 
@@ -1194,17 +1194,17 @@ 
 	 * @param    string $REG_code Registration Code
 	 * @param	boolean $use_default
 	 */
-	public function set_reg_code( $REG_code, $use_default = FALSE ) {
-		if ( empty( $REG_code )) {
-			EE_Error::add_error( __( 'REG_code can not be empty.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__ );
+	public function set_reg_code($REG_code, $use_default = FALSE) {
+		if (empty($REG_code)) {
+			EE_Error::add_error(__('REG_code can not be empty.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return;
 		}
-		if ( ! $this->reg_code() ) {
-			parent::set( 'REG_code', $REG_code, $use_default );
+		if ( ! $this->reg_code()) {
+			parent::set('REG_code', $REG_code, $use_default);
 		} else {
 			EE_Error::doing_it_wrong(
-				__CLASS__ . '::' . __FUNCTION__,
-				__( 'Can not change a registration REG_code once it has been set.', 'event_espresso' ),
+				__CLASS__.'::'.__FUNCTION__,
+				__('Can not change a registration REG_code once it has been set.', 'event_espresso'),
 				'4.6.0'
 			);
 		}
@@ -1224,17 +1224,17 @@ 
 	 * @return EE_Registration[]  or empty array if this isn't a group registration.
 	 */
 	public function get_all_other_registrations_in_group() {
-		if ( $this->group_size() < 2 ) {
+		if ($this->group_size() < 2) {
 			return array();
 		}
 
 		$query[0] = array(
 			'TXN_ID' => $this->transaction_ID(),
-			'REG_ID' => array( '!=', $this->ID() ),
+			'REG_ID' => array('!=', $this->ID()),
 			'TKT_ID' => $this->ticket_ID()
 			);
 
-		$registrations = $this->get_model()->get_all( $query );
+		$registrations = $this->get_model()->get_all($query);
 		return $registrations;
 	}
 
@@ -1243,14 +1243,14 @@ 
 	 * @return string
 	 */
 	public function get_admin_details_link() {
-		EE_Registry::instance()->load_helper( 'URL' );
+		EE_Registry::instance()->load_helper('URL');
 		return EEH_URL::add_query_args_and_nonce(
 			array(
 				'page' => 'espresso_registrations',
 				'action' => 'view_registration',
 				'_REG_ID' => $this->ID()
 			),
-			admin_url( 'admin.php' )
+			admin_url('admin.php')
 		);
 	}
 
@@ -1275,12 +1275,12 @@ 
 	 * @return string
 	 */
 	public function get_admin_overview_link() {
-		EE_Registry::instance()->load_helper( 'URL' );
+		EE_Registry::instance()->load_helper('URL');
 		return EEH_URL::add_query_args_and_nonce(
 			array(
 				'page' => 'espresso_registrations'
 			),
-			admin_url( 'admin.php' )
+			admin_url('admin.php')
 		);
 	}
 
@@ -1289,8 +1289,8 @@ 
 	 * @param array $query_params
 	 * @return \EE_Registration[]
 	 */
-	public function payments( $query_params = array() ) {
-		return $this->get_many_related( 'Payment', $query_params );
+	public function payments($query_params = array()) {
+		return $this->get_many_related('Payment', $query_params);
 	}
 
 
@@ -1299,8 +1299,8 @@ 
 	 * @param array $query_params
 	 * @return \EE_Registration[]
 	 */
-	public function registration_payments( $query_params = array() ) {
-		return $this->get_many_related( 'Registration_Payment', $query_params );
+	public function registration_payments($query_params = array()) {
+		return $this->get_many_related('Registration_Payment', $query_params);
 	}
 
 
@@ -1311,7 +1311,7 @@ 
 	 * @access 	public
 	 */
 	public function price_paid() {
-		EE_Error::doing_it_wrong( 'EE_Registration::price_paid()', __( 'This method is deprecated, please use EE_Registration::final_price() instead.', 'event_espresso' ), '4.7.0' );
+		EE_Error::doing_it_wrong('EE_Registration::price_paid()', __('This method is deprecated, please use EE_Registration::final_price() instead.', 'event_espresso'), '4.7.0');
 		return $this->final_price();
 	}
 
@@ -1323,9 +1323,9 @@ 
 	 * @access    public
 	 * @param    float $REG_final_price
 	 */
-	public function set_price_paid( $REG_final_price = 0.00 ) {
-		EE_Error::doing_it_wrong( 'EE_Registration::set_price_paid()', __( 'This method is deprecated, please use EE_Registration::set_final_price() instead.', 'event_espresso' ), '4.7.0' );
-		$this->set_final_price( $REG_final_price );
+	public function set_price_paid($REG_final_price = 0.00) {
+		EE_Error::doing_it_wrong('EE_Registration::set_price_paid()', __('This method is deprecated, please use EE_Registration::set_final_price() instead.', 'event_espresso'), '4.7.0');
+		$this->set_final_price($REG_final_price);
 	}
 
 
@@ -1336,7 +1336,7 @@ 
 	 * @return string
 	 */
 	public function pretty_price_paid() {
-		EE_Error::doing_it_wrong( 'EE_Registration::pretty_price_paid()', __( 'This method is deprecated, please use EE_Registration::pretty_final_price() instead.', 'event_espresso' ), '4.7.0' );
+		EE_Error::doing_it_wrong('EE_Registration::pretty_price_paid()', __('This method is deprecated, please use EE_Registration::pretty_final_price() instead.', 'event_espresso'), '4.7.0');
 		return $this->pretty_final_price();
 	}
 
@@ -1350,7 +1350,7 @@ 
 	 * @return EE_Payment_Method|null
 	 */
 	public function payment_method() {
-		return EEM_Payment_Method::instance()->get_last_used_for_registration( $this );
+		return EEM_Payment_Method::instance()->get_last_used_for_registration($this);
 	}
 
 

core/EE_Cart.core.php

Doc Comments +3 added lines, -3 removed lines

@@ -197,7 +197,7 @@ 
 	 *	@access public
 	 *	@param EE_Ticket $ticket
 	 *	@param int $qty
-	 *	@return TRUE on success, FALSE on fail
+	 *	@return boolean on success, FALSE on fail
 	 */
 	public function add_ticket_to_cart( EE_Ticket $ticket, $qty = 1 ) {
 		EEH_Line_Item::add_ticket_purchase( $this->get_grand_total(), $ticket, $qty );
@@ -284,7 +284,7 @@ 
 	/**
 	 *	@remove ALL items from cart and delete total as well
 	 *	@access public
-	 *	@return bool
+	 *	@return integer
 	 */
 	public function delete_cart() {
 		EE_Registry::instance()->load_helper( 'Line_Item' );
@@ -313,7 +313,7 @@ 
 	  * @save cart to session
 	  * @access public
 	  * @param bool $apply_taxes
-	  * @return TRUE on success, FALSE on fail
+	  * @return boolean on success, FALSE on fail
 	  */
 	public function save_cart( $apply_taxes = TRUE ) {
 		if ( $apply_taxes && $this->_grand_total instanceof EE_Line_Item ) {

Spacing +53 added lines, -53 removed lines

@@ -1,5 +1,5 @@ 
-<?php if (!defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
-do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );/**
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
+do_action('AHEE_log', __FILE__, __FUNCTION__, ''); /**
  *
  * Event Espresso
  *
@@ -67,24 +67,24 @@ 
 	  * @param EE_Session $session
 	  * @return \EE_Cart
 	  */
-	 public static function instance( EE_Line_Item $grand_total = null, EE_Session $session = null ) {
-		if ( ! empty( $grand_total ) ){
-			self::$_instance = new self( $grand_total, $session );
+	 public static function instance(EE_Line_Item $grand_total = null, EE_Session $session = null) {
+		if ( ! empty($grand_total)) {
+			self::$_instance = new self($grand_total, $session);
 		}
 		// or maybe retrieve an existing one ?
-		if ( ! self::$_instance instanceof EE_Cart ) {
+		if ( ! self::$_instance instanceof EE_Cart) {
 			// try getting the cart out of the session
 			$saved_cart = $session instanceof EE_Session ? $session->cart() : null;
-			self::$_instance = $saved_cart instanceof EE_Cart ? $saved_cart : new self( $grand_total, $session );
-			unset( $saved_cart );
+			self::$_instance = $saved_cart instanceof EE_Cart ? $saved_cart : new self($grand_total, $session);
+			unset($saved_cart);
 		}
 		// verify that cart is ok and grand total line item exists
-		if ( ! self::$_instance instanceof EE_Cart || ! self::$_instance->_grand_total instanceof EE_Line_Item ) {
-			self::$_instance = new self( $grand_total, $session );
+		if ( ! self::$_instance instanceof EE_Cart || ! self::$_instance->_grand_total instanceof EE_Line_Item) {
+			self::$_instance = new self($grand_total, $session);
 		}
 		self::$_instance->get_grand_total();
 		 // once everything is all said and done, save the cart to the EE_Session
-		add_action( 'shutdown', array( self::$_instance, 'save_cart' ), 90 );
+		add_action('shutdown', array(self::$_instance, 'save_cart'), 90);
 		return self::$_instance;
 	}
 
@@ -98,11 +98,11 @@ 
 	  * @param EE_Session $session
 	  * @return \EE_Cart
 	  */
-	 private function __construct( EE_Line_Item $grand_total = null, EE_Session $session = null ) {
-		 do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
-		 $this->set_session( $session );
-		 if ( $grand_total instanceof EE_Line_Item ) {
-			 $this->set_grand_total_line_item( $grand_total );
+	 private function __construct(EE_Line_Item $grand_total = null, EE_Session $session = null) {
+		 do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		 $this->set_session($session);
+		 if ($grand_total instanceof EE_Line_Item) {
+			 $this->set_grand_total_line_item($grand_total);
 		 }
 	 }
 
@@ -114,13 +114,13 @@ 
 	  * @param EE_Session $session
 	  * @return EE_Cart
 	  */
-	 public static function reset( EE_Line_Item $grand_total = null, EE_Session $session = null ) {
-		 remove_action( 'shutdown', array( self::$_instance, 'save_cart' ), 90 );
-		 if ( $session instanceof EE_Session ) {
+	 public static function reset(EE_Line_Item $grand_total = null, EE_Session $session = null) {
+		 remove_action('shutdown', array(self::$_instance, 'save_cart'), 90);
+		 if ($session instanceof EE_Session) {
 			 $session->reset_cart();
 		 }
 		 self::$_instance = null;
-		 return self::instance( $grand_total, $session );
+		 return self::instance($grand_total, $session);
 	 }
 
 
@@ -128,8 +128,8 @@ 
 	 /**
 	  * @param EE_Session $session
 	  */
-	 public function set_session( EE_Session $session = null ) {
-		 $this->_session = $session instanceof EE_Session ? $session : EE_Registry::instance()->load_core( 'Session' );
+	 public function set_session(EE_Session $session = null) {
+		 $this->_session = $session instanceof EE_Session ? $session : EE_Registry::instance()->load_core('Session');
 	 }
 
 
@@ -139,7 +139,7 @@ 
 	  *  know the grand total line item on it
 	  * @param EE_Line_Item $line_item
 	  */
-	 public function set_grand_total_line_item( EE_Line_Item $line_item ) {
+	 public function set_grand_total_line_item(EE_Line_Item $line_item) {
 		 $this->_grand_total = $line_item;
 	 }
 
@@ -152,11 +152,11 @@ 
 	  * @param EE_Session $session
 	  * @return \EE_Cart
 	  */
-	public static function get_cart_from_txn( EE_Transaction $transaction, EE_Session $session = null ) {
+	public static function get_cart_from_txn(EE_Transaction $transaction, EE_Session $session = null) {
 		$grand_total = $transaction->total_line_item();
 		$grand_total->get_items();
 		$grand_total->tax_descendants();
-		return EE_Cart::instance( $grand_total, $session );
+		return EE_Cart::instance($grand_total, $session);
 	}
 
 
@@ -165,7 +165,7 @@ 
 	 * Creates the total line item, and ensures it has its 'tickets' and 'taxes' sub-items
 	 * @return EE_Line_Item
 	 */
-	private function _create_grand_total(){
+	private function _create_grand_total() {
 		$this->_grand_total = EEH_Line_Item::create_total_line_item();
 		return $this->_grand_total;
 	}
@@ -178,7 +178,7 @@ 
 	 *	@return \EE_Line_Item[]
 	 */
 	public function get_tickets() {
-		return EEH_Line_Item::get_ticket_line_items( $this->_grand_total );
+		return EEH_Line_Item::get_ticket_line_items($this->_grand_total);
 	}
 
 
@@ -191,11 +191,11 @@ 
 	 */
 	public function all_ticket_quantity_count() {
 		$tickets = $this->get_tickets();
-		if ( empty( $tickets )) {
+		if (empty($tickets)) {
 			return 0;
 		}
 		$count = 0;
-		foreach ( $tickets as $ticket ) {
+		foreach ($tickets as $ticket) {
 			$count = $count + $ticket->get('LIN_quantity');
 		}
 		return $count;
@@ -207,8 +207,8 @@ 
 	 *  Gets all the tax line items
 	 * @return \EE_Line_Item[]
 	 */
-	public function get_taxes(){
-		return EEH_Line_Item::get_taxes_subtotal( $this->_grand_total )->children();
+	public function get_taxes() {
+		return EEH_Line_Item::get_taxes_subtotal($this->_grand_total)->children();
 	}
 
 
@@ -217,7 +217,7 @@ 
 	 * Gets the total line item (which is a parent of all other line items) on this cart
 	 * @return EE_Line_Item
 	 */
-	public function get_grand_total(){
+	public function get_grand_total() {
 		return $this->_grand_total instanceof EE_Line_Item ? $this->_grand_total : $this->_create_grand_total();
 	}
 
@@ -230,8 +230,8 @@ 
 	 *	@param int $qty
 	 *	@return TRUE on success, FALSE on fail
 	 */
-	public function add_ticket_to_cart( EE_Ticket $ticket, $qty = 1 ) {
-		EEH_Line_Item::add_ticket_purchase( $this->get_grand_total(), $ticket, $qty );
+	public function add_ticket_to_cart(EE_Ticket $ticket, $qty = 1) {
+		EEH_Line_Item::add_ticket_purchase($this->get_grand_total(), $ticket, $qty);
 		return $this->save_cart() ? TRUE : FALSE;
 	}
 
@@ -254,7 +254,7 @@ 
 	 *	@return float
 	 */
 	public function get_applied_taxes() {
-		return EEH_Line_Item::ensure_taxes_applied( $this->_grand_total );
+		return EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
 	}
 
 
@@ -265,7 +265,7 @@ 
 	 *	@return float
 	 */
 	public function get_cart_grand_total() {
-		EEH_Line_Item::ensure_taxes_applied( $this->_grand_total );
+		EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
 		return $this->get_grand_total()->total();
 	}
 
@@ -278,8 +278,8 @@ 
 	 */
 	public function recalculate_all_cart_totals() {
 		$pre_tax_total = $this->get_cart_total_before_tax();
-		$taxes_total = EEH_Line_Item::ensure_taxes_applied( $this->_grand_total );
-		$this->_grand_total->set_total( $pre_tax_total + $taxes_total );
+		$taxes_total = EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
+		$this->_grand_total->set_total($pre_tax_total + $taxes_total);
 		$this->_grand_total->save_this_and_descendants_to_txn();
 		return $this->get_grand_total()->total();
 	}
@@ -292,9 +292,9 @@ 
 	 *	@param array|bool|string $line_item_codes
 	 *	@return int on success, FALSE on fail
 	 */
-	public function delete_items( $line_item_codes = FALSE ) {
-		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
-		return EEH_Line_Item::delete_items($this->get_grand_total(), $line_item_codes );
+	public function delete_items($line_item_codes = FALSE) {
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		return EEH_Line_Item::delete_items($this->get_grand_total(), $line_item_codes);
 	}
 
 
@@ -305,9 +305,9 @@ 
 	 *	@return bool
 	 */
 	public function empty_cart() {
-		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
 		$this->_grand_total = $this->_create_grand_total();
-		return $this->save_cart( TRUE );
+		return $this->save_cart(TRUE);
 	}
 
 
@@ -318,8 +318,8 @@ 
 	 *	@return bool
 	 */
 	public function delete_cart() {
-		$deleted = EEH_Line_Item::delete_all_child_items( $this->_grand_total );
-		if ( $deleted ) {
+		$deleted = EEH_Line_Item::delete_all_child_items($this->_grand_total);
+		if ($deleted) {
 			$deleted += $this->_grand_total->delete();
 			$this->_grand_total = null;
 		}
@@ -334,17 +334,17 @@ 
 	  * @param bool $apply_taxes
 	  * @return TRUE on success, FALSE on fail
 	  */
-	public function save_cart( $apply_taxes = TRUE ) {
-		if ( $apply_taxes && $this->_grand_total instanceof EE_Line_Item ) {
-			EEH_Line_Item::ensure_taxes_applied( $this->_grand_total );
+	public function save_cart($apply_taxes = TRUE) {
+		if ($apply_taxes && $this->_grand_total instanceof EE_Line_Item) {
+			EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
 			//make sure we don't cache the transaction because it can get stale
-			if( $this->_grand_total->get_one_from_cache( 'Transaction' ) instanceof EE_Transaction &&
-				$this->_grand_total->get_one_from_cache( 'Transaction' )->ID()) {
-				$this->_grand_total->clear_cache( 'Transaction', null, true );
+			if ($this->_grand_total->get_one_from_cache('Transaction') instanceof EE_Transaction &&
+				$this->_grand_total->get_one_from_cache('Transaction')->ID()) {
+				$this->_grand_total->clear_cache('Transaction', null, true);
 			}
 		}
-		if ( $this->_session instanceof EE_Session ) {
-			return $this->_session->set_cart( $this );
+		if ($this->_session instanceof EE_Session) {
+			return $this->_session->set_cart($this);
 		} else {
 			return false;
 		}