eventespresso / event-espresso-core

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

Doc Comments +1 added lines, -1 removed lines

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

Spacing +35 added lines, -35 removed lines

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

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

Doc Comments +1 added lines, -1 removed lines

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

Spacing +27 added lines, -27 removed lines

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

core/libraries/form_sections/strategies/normalization/EE_Int_Normalization.strategy.php

Doc Comments +1 added lines, -1 removed lines

@@ -11,7 +11,7 @@
 
 	/**
 	 * @param string $value_to_normalize
-	 * @return int|mixed|string
+	 * @return integer
 	 * @throws \EE_Validation_Error
 	 */
 	public function normalize($value_to_normalize) {

Spacing +15 added lines, -15 removed lines

@@ -7,7 +7,7 @@ 
  * @subpackage
  * @author				Mike Nelson
  */
-class EE_Int_Normalization extends EE_Normalization_Strategy_Base{
+class EE_Int_Normalization extends EE_Normalization_Strategy_Base {
 
 	/**
 	 * @param string $value_to_normalize
@@ -15,33 +15,33 @@ 
 	 * @throws \EE_Validation_Error
 	 */
 	public function normalize($value_to_normalize) {
-		if( is_int( $value_to_normalize ) ){
+		if (is_int($value_to_normalize)) {
 			return $value_to_normalize;
 		}
-		if( ! is_string( $value_to_normalize )){
-			throw new EE_Validation_Error( sprintf( __( 'The value "%s" must be a string submitted for normalization, it was %s', 'event_espresso' ), print_r( $value_to_normalize, TRUE), gettype( $value_to_normalize ) ) );
+		if ( ! is_string($value_to_normalize)) {
+			throw new EE_Validation_Error(sprintf(__('The value "%s" must be a string submitted for normalization, it was %s', 'event_espresso'), print_r($value_to_normalize, TRUE), gettype($value_to_normalize)));
 		}
 		$thousands_separator = EE_Config::instance()->currency->thsnds;
-		$value_to_normalize = str_replace( $thousands_separator, "", $value_to_normalize );
-		$value_to_normalize = str_replace( array(" ","\t"), '', $value_to_normalize );
-		if ( preg_match( '/^\d+$/', $value_to_normalize )) {
-			return intval( $value_to_normalize );
+		$value_to_normalize = str_replace($thousands_separator, "", $value_to_normalize);
+		$value_to_normalize = str_replace(array(" ", "\t"), '', $value_to_normalize);
+		if (preg_match('/^\d+$/', $value_to_normalize)) {
+			return intval($value_to_normalize);
 		} else {
 			//find if this input has a int validation strategy
 			//in which case, use its message
 			$validation_error_message = NULL;
-			foreach( $this->_input->get_validation_strategies() as $validation_strategy ){
-				if( $validation_strategy instanceof EE_Int_Validation_Strategy ){
+			foreach ($this->_input->get_validation_strategies() as $validation_strategy) {
+				if ($validation_strategy instanceof EE_Int_Validation_Strategy) {
 					$validation_error_message = $validation_strategy->get_validation_error_message();
 				}
 			}
 			//this really shouldn't ever happen because fields with a int normalization strategy
 			//should also have a int validation strategy, but in case it doesnt use the default
-			if( ! $validation_error_message ){
+			if ( ! $validation_error_message) {
 				$default_validation_strategy = new EE_Int_Validation_Strategy();
 				$validation_error_message = $default_validation_strategy->get_validation_error_message();
 			}
-			throw new EE_Validation_Error( $validation_error_message, 'numeric_only' );
+			throw new EE_Validation_Error($validation_error_message, 'numeric_only');
 		}
 	}
 
@@ -50,10 +50,10 @@ 
 	 * @param int $normalized_value
 	 * @return string
 	 */
-	public function unnormalize( $normalized_value ) {
-		if( empty( $normalized_value ) ){
+	public function unnormalize($normalized_value) {
+		if (empty($normalized_value)) {
 			return '0';
-		}else{
+		} else {
 			return "$normalized_value";
 		}
 	}

Braces +1 added lines, -1 removed lines

@@ -90,7 +90,7 @@
 		//so in case teh IPN is arriving later, let's try to process an IPN!
 		if($_SERVER['REQUEST_METHOD'] == 'POST'){
 			return $this->handle_ipn($_POST, $transaction );
-		}else{
+		} else{
 			return parent::finalize_payment_for( $transaction );
 		}
 	}

core/libraries/form_sections/strategies/validation/EE_Many_Valued_Validation_Strategy.strategy.php

Doc Comments +1 added lines, -1 removed lines

@@ -27,7 +27,7 @@
 	/**
 	 * Applies all teh individual item validation strategies on each item in the array
 	 * @param array $normalized_value
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	function validate($normalized_value) {
 		if( is_array($normalized_value)){

Spacing +9 added lines, -9 removed lines

@@ -11,14 +11,14 @@ 
  * @since 				4.6
  *
  */
-class EE_Many_Valued_Validation_Strategy extends EE_Validation_Strategy_Base{
+class EE_Many_Valued_Validation_Strategy extends EE_Validation_Strategy_Base {
 	protected $_individual_item_validation_strategies = array();
 	/**
 	 *
 	 * @param EE_Validation_Strategy_Base[] $individual_item_validation_strategies (or a single EE_Validation_Strategy_Base)
 	 */
 	public function __construct($individual_item_validation_strategies) {
-		if( ! is_array($individual_item_validation_strategies)){
+		if ( ! is_array($individual_item_validation_strategies)) {
 			$individual_item_validation_strategies = array($individual_item_validation_strategies);
 		}
 		$this->_individual_item_validation_strategies = $individual_item_validation_strategies;
@@ -30,14 +30,14 @@ 
 	 * @return boolean
 	 */
 	function validate($normalized_value) {
-		if( is_array($normalized_value)){
+		if (is_array($normalized_value)) {
 			$items_to_validate = $normalized_value;
-		}else{
+		} else {
 			$items_to_validate = array($normalized_value);
 		}
-		foreach($items_to_validate as $individual_item){
-			foreach($this->_individual_item_validation_strategies as $validation_strategy){
-				if ( $validation_strategy instanceof EE_Validation_Strategy_Base ) {
+		foreach ($items_to_validate as $individual_item) {
+			foreach ($this->_individual_item_validation_strategies as $validation_strategy) {
+				if ($validation_strategy instanceof EE_Validation_Strategy_Base) {
 					$validation_strategy->validate($individual_item);
 				}
 			}
@@ -50,8 +50,8 @@ 
 	 */
 	function _construct_finalize(\EE_Form_Input_Base $form_input) {
 		parent::_construct_finalize($form_input);
-		foreach($this->_individual_item_validation_strategies as $item_validation_strategy){
-			if ( $item_validation_strategy instanceof EE_Validation_Strategy_Base ) {
+		foreach ($this->_individual_item_validation_strategies as $item_validation_strategy) {
+			if ($item_validation_strategy instanceof EE_Validation_Strategy_Base) {
 				$item_validation_strategy->_construct_finalize($form_input);
 			}
 		}

Braces +1 added lines, -1 removed lines

@@ -90,7 +90,7 @@
 		//so in case teh IPN is arriving later, let's try to process an IPN!
 		if($_SERVER['REQUEST_METHOD'] == 'POST'){
 			return $this->handle_ipn($_POST, $transaction );
-		}else{
+		} else{
 			return parent::finalize_payment_for( $transaction );
 		}
 	}

core/libraries/form_sections/strategies/validation/EE_URL_Validation_Strategy.strategy.php

Doc Comments +1 added lines, -1 removed lines

@@ -26,7 +26,7 @@
 	 * just checks the field isn't blank
 	 *
 	 * @param $normalized_value
-	 * @return bool
+	 * @return boolean|null
 	 * @throws \EE_Validation_Error
 	 */
 	function validate($normalized_value) {

Braces +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
 		if( $normalized_value ){
 			if (filter_var($normalized_value, FILTER_VALIDATE_URL) === false){
 				throw new EE_Validation_Error( $this->get_validation_error_message(), 'invalid_url');
-			}else{
+			} else{
 				EE_Registry::instance()->load_helper('URL');
 				if( ! EEH_URL::remote_file_exists(
 						$normalized_value,

Spacing +13 added lines, -13 removed lines

@@ -8,16 +8,16 @@ 
  * @since 				4.6
  *
  */
-class EE_URL_Validation_Strategy extends EE_Validation_Strategy_Base{
+class EE_URL_Validation_Strategy extends EE_Validation_Strategy_Base {
 
 	/**
 	 * @param null $validation_error_message
 	 */
-	public function __construct( $validation_error_message = NULL ) {
-		if( ! $validation_error_message ){
+	public function __construct($validation_error_message = NULL) {
+		if ( ! $validation_error_message) {
 			$validation_error_message = __("Please enter a valid URL", "event_espresso");
 		}
-		parent::__construct( $validation_error_message );
+		parent::__construct($validation_error_message);
 	}
 
 
@@ -30,16 +30,16 @@ 
 	 * @throws \EE_Validation_Error
 	 */
 	function validate($normalized_value) {
-		if( $normalized_value ){
-			if (filter_var($normalized_value, FILTER_VALIDATE_URL) === false){
-				throw new EE_Validation_Error( $this->get_validation_error_message(), 'invalid_url');
-			}else{
-				if( ! EEH_URL::remote_file_exists(
+		if ($normalized_value) {
+			if (filter_var($normalized_value, FILTER_VALIDATE_URL) === false) {
+				throw new EE_Validation_Error($this->get_validation_error_message(), 'invalid_url');
+			} else {
+				if ( ! EEH_URL::remote_file_exists(
 						$normalized_value,
 						array(
 							'sslverify' => false, 
-							'limit_response_size' => 4095,//we don't really care for a full response, but we do want headers at least. Lets just ask for a one block
-						))){
+							'limit_response_size' => 4095, //we don't really care for a full response, but we do want headers at least. Lets just ask for a one block
+						))) {
 					throw new EE_Validation_Error(sprintf(__("That URL seems to be broken. Please enter a valid URL", "event_espresso")));
 				}
 			}
@@ -51,8 +51,8 @@ 
 	/**
 	 * @return array
 	 */
-	function get_jquery_validation_rule_array(){
-		return array( 'validUrl'=>true, 'messages' => array( 'validUrl' => $this->get_validation_error_message() ) );
+	function get_jquery_validation_rule_array() {
+		return array('validUrl'=>true, 'messages' => array('validUrl' => $this->get_validation_error_message()));
 	}
 }
 

core/libraries/line_item_display/EE_Receipt_Line_Item_Display_Strategy.strategy.php

Doc Comments +1 added lines, -1 removed lines

@@ -31,7 +31,7 @@
 	/**
 	 * @param EE_Line_Item $line_item
 	 * @param array        $options
-	 * @return mixed
+	 * @return string
 	 */
 	public function display_line_item( EE_Line_Item $line_item, $options = array() ) {
 

Indentation +11 added lines, -11 removed lines

@@ -14,17 +14,17 @@
  * ------------------------------------------------------------------------
  */
  /**
- *
- * Class EE_Receipt_Line_Item_Display_Strategy
- *
- * Description
- *
- * @package         Event Espresso
- * @subpackage    core
- * @author				Brent Christensen
- * @since		 	   $VID:$
- *
- */
+  *
+  * Class EE_Receipt_Line_Item_Display_Strategy
+  *
+  * Description
+  *
+  * @package         Event Espresso
+  * @subpackage    core
+  * @author				Brent Christensen
+  * @since		 	   $VID:$
+  *
+  */
 
 class EE_Receipt_Line_Item_Display_Strategy  implements EEI_Line_Item_Display {
 

Spacing +7 added lines, -7 removed lines

@@ -33,7 +33,7 @@ 
 	 * @param array        $options
 	 * @return mixed
 	 */
-	public function display_line_item( EE_Line_Item $line_item, $options = array() ) {
+	public function display_line_item(EE_Line_Item $line_item, $options = array()) {
 
 		$html = '';
 		// set some default options and merge with incoming
@@ -41,12 +41,12 @@ 
 			'show_desc' => TRUE,
 			'odd' => FALSE
 		);
-		$options = array_merge( $default_options, (array)$options );
-		switch( $line_item->type() ) {
+		$options = array_merge($default_options, (array) $options);
+		switch ($line_item->type()) {
 
 			case EEM_Line_Item::type_total:
 				// loop thru children
-				foreach( $line_item->children() as $child_line_item ) {
+				foreach ($line_item->children() as $child_line_item) {
 					// recursively feed children back into this method
 //					$html .= $this->display_line_item( $child_line_item, $options );
 				}
@@ -57,7 +57,7 @@ 
 
 			case EEM_Line_Item::type_sub_total:
 				// loop thru children
-				foreach( $line_item->children() as $child_line_item ) {
+				foreach ($line_item->children() as $child_line_item) {
 					// recursively feed children back into this method
 //					$html .= $this->display_line_item( $child_line_item, $options );
 				}
@@ -67,7 +67,7 @@ 
 
 			case EEM_Line_Item::type_tax_sub_total:
 				// loop thru children
-				foreach( $line_item->children() as $child_line_item ) {
+				foreach ($line_item->children() as $child_line_item) {
 					// recursively feed children back into this method
 //					$html .= $this->display_line_item( $child_line_item, $options );
 				}
@@ -79,7 +79,7 @@ 
 				// item row
 //				$html .= $this->_item_row( $line_item, $options );
 				// got any kids?
-				foreach( $line_item->children() as $child_line_item ) {
+				foreach ($line_item->children() as $child_line_item) {
 //					$this->display_line_item( $child_line_item, $options );
 				}
 				break;

core/libraries/line_item_display/EE_SPCO_Line_Item_Display_Strategy.strategy.php

Doc Comments +10 added lines, -10 removed lines

@@ -67,7 +67,7 @@ 
 	/**
 	 * @param EE_Line_Item $line_item
 	 * @param array        $options
-	 * @return mixed
+	 * @return string
 	 */
 	public function display_line_item( EE_Line_Item $line_item, $options = array() ) {
 
@@ -206,7 +206,7 @@ 
 	 *    _event_row - basically a Heading row displayed once above each event's ticket rows
 	 *
 	 * @param EE_Line_Item $line_item
-	 * @return mixed
+	 * @return string
 	 */
 	private function _event_row( EE_Line_Item $line_item ) {
 		// start of row
@@ -225,7 +225,7 @@ 
 	 *
 	 * @param EE_Line_Item $line_item
 	 * @param array        $options
-	 * @return mixed
+	 * @return string
 	 */
 	private function _ticket_row( EE_Line_Item $line_item, $options = array() ) {
 		// start of row
@@ -268,7 +268,7 @@ 
 	 *
 	 * @param EE_Line_Item $line_item
 	 * @param array        $options
-	 * @return mixed
+	 * @return string
 	 */
 	private function _item_row( EE_Line_Item $line_item, $options = array() ) {
 		// start of row
@@ -314,7 +314,7 @@ 
 	 *
 	 * @param EE_Line_Item $line_item
 	 * @param array        $options
-	 * @return mixed
+	 * @return string
 	 */
 	private function _sub_item_row( EE_Line_Item $line_item, $options = array() ) {
 		// start of row
@@ -344,7 +344,7 @@ 
 	 *
 	 * @param EE_Line_Item $line_item
 	 * @param array        $options
-	 * @return mixed
+	 * @return string
 	 */
 	private function _tax_row( EE_Line_Item $line_item, $options = array() ) {
 		// start of row
@@ -374,7 +374,7 @@ 
 	 * @param EE_Line_Item $line_item
 	 * @param string $text
 	 * @param array $options
-	 * @return mixed
+	 * @return string
 	 */
 	private function _total_tax_row( EE_Line_Item $line_item, $text = '', $options = array() ) {
 		$html = '';
@@ -401,7 +401,7 @@ 
 	 * @param EE_Line_Item $line_item
 	 * @param string       $text
 	 * @param array        $options
-	 * @return mixed
+	 * @return string
 	 */
 	private function _sub_total_row( EE_Line_Item $line_item, $text = '', $options = array() ) {
 		$html = '';
@@ -426,7 +426,7 @@ 
 	 *
 	 * @param EE_Line_Item $line_item
 	 * @param string       $text
-	 * @return mixed
+	 * @return string
 	 */
 	private function _total_row( EE_Line_Item $line_item, $text = '' ) {
 		// start of row
@@ -446,7 +446,7 @@ 
 	 * 	_payments_and_amount_owing_rows
 	 *
 	 * @param EE_Line_Item $line_item
-	 * @return mixed
+	 * @return string
 	 */
 	private function _payments_and_amount_owing_rows( EE_Line_Item $line_item ) {
 		$html = '';

Indentation +11 added lines, -11 removed lines

@@ -1,16 +1,16 @@
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); }
  /**
- *
- * Class EE_SPCO_Line_Item_Display_Strategy
- *
- * Description
- *
- * @package         Event Espresso
- * @subpackage    core
- * @author				Brent Christensen
- * @since		 	   $VID:$
- *
- */
+  *
+  * Class EE_SPCO_Line_Item_Display_Strategy
+  *
+  * Description
+  *
+  * @package         Event Espresso
+  * @subpackage    core
+  * @author				Brent Christensen
+  * @since		 	   $VID:$
+  *
+  */
 
 class EE_SPCO_Line_Item_Display_Strategy implements EEI_Line_Item_Display {
 

Spacing +118 added lines, -118 removed lines

@@ -69,101 +69,101 @@ 
 	 * @param array        $options
 	 * @return mixed
 	 */
-	public function display_line_item( EE_Line_Item $line_item, $options = array() ) {
+	public function display_line_item(EE_Line_Item $line_item, $options = array()) {
 
 		$html = '';
 		// set some default options and merge with incoming
 		$default_options = array(
-			'show_desc' => true,  // 	true 		false
+			'show_desc' => true, // 	true 		false
 			'odd' => false
 		);
-		$options = array_merge( $default_options, (array)$options );
+		$options = array_merge($default_options, (array) $options);
 
-		switch( $line_item->type() ) {
+		switch ($line_item->type()) {
 
 			case EEM_Line_Item::type_line_item:
 				$this->_show_taxes = $line_item->is_taxable() ? true : $this->_show_taxes;
-				if ( $line_item->OBJ_type() == 'Ticket' ) {
+				if ($line_item->OBJ_type() == 'Ticket') {
 					// item row
-					$html .= $this->_ticket_row( $line_item, $options );
+					$html .= $this->_ticket_row($line_item, $options);
 					// got any kids?
-					foreach ( $line_item->children() as $child_line_item ) {
-						$this->display_line_item( $child_line_item, $options );
+					foreach ($line_item->children() as $child_line_item) {
+						$this->display_line_item($child_line_item, $options);
 					}
 				} else {
 					// item row
-					$html .= $this->_item_row( $line_item, $options );
+					$html .= $this->_item_row($line_item, $options);
 					// got any kids?
-					foreach ( $line_item->children() as $child_line_item ) {
-						$this->display_line_item( $child_line_item, $options );
+					foreach ($line_item->children() as $child_line_item) {
+						$this->display_line_item($child_line_item, $options);
 					}
 				}
 				break;
 
 			case EEM_Line_Item::type_sub_line_item:
-				$html .= $this->_sub_item_row( $line_item, $options );
+				$html .= $this->_sub_item_row($line_item, $options);
 				break;
 
 			case EEM_Line_Item::type_sub_total:
 				static $sub_total = 0;
 				$event_sub_total = 0;
-				$text = __( 'Sub-Total', 'event_espresso' );
-				if ( $line_item->OBJ_type() == 'Event' ) {
-					$options[ 'event_id' ] = $event_id = $line_item->OBJ_ID();
-					if ( ! isset( $this->_events[ $options[ 'event_id' ] ] ) ) {
-						$event = EEM_Event::instance()->get_one_by_ID( $options[ 'event_id' ] );
-						if ( $event instanceof EE_Event ) {
-							if ( $event->default_registration_status() == EEM_Registration::status_id_not_approved ) {
+				$text = __('Sub-Total', 'event_espresso');
+				if ($line_item->OBJ_type() == 'Event') {
+					$options['event_id'] = $event_id = $line_item->OBJ_ID();
+					if ( ! isset($this->_events[$options['event_id']])) {
+						$event = EEM_Event::instance()->get_one_by_ID($options['event_id']);
+						if ($event instanceof EE_Event) {
+							if ($event->default_registration_status() == EEM_Registration::status_id_not_approved) {
 								return '';
 							}
 						}
-						$this->_events[ $options[ 'event_id' ] ] = 0;
-						$html .= $this->_event_row( $line_item );
-						$text = __( 'Event Sub-Total', 'event_espresso' );
+						$this->_events[$options['event_id']] = 0;
+						$html .= $this->_event_row($line_item);
+						$text = __('Event Sub-Total', 'event_espresso');
 					}
 				}
 				$child_line_items = $line_item->children();
 				// loop thru children
-				foreach( $child_line_items as $child_line_item ) {
+				foreach ($child_line_items as $child_line_item) {
 					// recursively feed children back into this method
-					$html .= $this->display_line_item( $child_line_item, $options );
+					$html .= $this->display_line_item($child_line_item, $options);
 				}
-				$event_sub_total += isset( $options[ 'event_id' ] ) ? $this->_events[ $options[ 'event_id' ] ] : 0;
+				$event_sub_total += isset($options['event_id']) ? $this->_events[$options['event_id']] : 0;
 				$sub_total += $event_sub_total;
 				if (
 					(
 						// event subtotals
 						$line_item->code() != 'pre-tax-subtotal' &&
-						count( $child_line_items ) > 1
+						count($child_line_items) > 1
 					)
 					||
 					(
 						// pre-tax subtotals
 						$line_item->code() == 'pre-tax-subtotal' &&
-						count( $this->_events ) > 1
+						count($this->_events) > 1
 					)
 				) {
 					$options['sub_total'] = $line_item->OBJ_type() == 'Event' ? $event_sub_total : $sub_total;
-					$html .= $this->_sub_total_row( $line_item, $text, $options );
+					$html .= $this->_sub_total_row($line_item, $text, $options);
 				}
 				break;
 
 			case EEM_Line_Item::type_tax:
-				if ( $this->_show_taxes ) {
-					$this->_taxes_html .= $this->_tax_row( $line_item, $options );
+				if ($this->_show_taxes) {
+					$this->_taxes_html .= $this->_tax_row($line_item, $options);
 				}
 				break;
 
 			case EEM_Line_Item::type_tax_sub_total:
-				if ( $this->_show_taxes ) {
+				if ($this->_show_taxes) {
 					$child_line_items = $line_item->children();
 					// loop thru children
-					foreach( $child_line_items as $child_line_item ) {
+					foreach ($child_line_items as $child_line_item) {
 						// recursively feed children back into this method
-						$html .= $this->display_line_item( $child_line_item, $options );
+						$html .= $this->display_line_item($child_line_item, $options);
 					}
-					if ( count( $child_line_items ) > 1 ) {
-						$this->_taxes_html .= $this->_total_tax_row( $line_item, __( 'Tax Total', 'event_espresso' ) );
+					if (count($child_line_items) > 1) {
+						$this->_taxes_html .= $this->_total_tax_row($line_item, __('Tax Total', 'event_espresso'));
 					}
 				}
 				break;
@@ -172,25 +172,25 @@ 
 				// get all child line items
 				$children = $line_item->children();
 				// loop thru all non-tax child line items
-				foreach( $children as $child_line_item ) {
-					if ( $child_line_item->type() != EEM_Line_Item::type_tax_sub_total ) {
+				foreach ($children as $child_line_item) {
+					if ($child_line_item->type() != EEM_Line_Item::type_tax_sub_total) {
 						// recursively feed children back into this method
-						$html .= $this->display_line_item( $child_line_item, $options );
+						$html .= $this->display_line_item($child_line_item, $options);
 					}
 				}
 
 				// now loop thru  tax child line items
-				foreach( $children as $child_line_item ) {
-					if ( $child_line_item->type() == EEM_Line_Item::type_tax_sub_total ) {
+				foreach ($children as $child_line_item) {
+					if ($child_line_item->type() == EEM_Line_Item::type_tax_sub_total) {
 						// recursively feed children back into this method
-						$html .= $this->display_line_item( $child_line_item, $options );
+						$html .= $this->display_line_item($child_line_item, $options);
 					}
 				}
 				$html .= $this->_taxes_html;
-				$html .= $this->_total_row( $line_item, __('Total', 'event_espresso') );
+				$html .= $this->_total_row($line_item, __('Total', 'event_espresso'));
 
 
-				$html .= $this->_payments_and_amount_owing_rows( $line_item, $options );
+				$html .= $this->_payments_and_amount_owing_rows($line_item, $options);
 				break;
 
 		}
@@ -205,11 +205,11 @@ 
 	 * @param EE_Line_Item $line_item
 	 * @return mixed
 	 */
-	private function _event_row( EE_Line_Item $line_item ) {
+	private function _event_row(EE_Line_Item $line_item) {
 		// start of row
-		$html = EEH_HTML::tr( '', 'event-cart-total-row', 'total_tr odd' );
+		$html = EEH_HTML::tr('', 'event-cart-total-row', 'total_tr odd');
 		// event name td
-		$html .= EEH_HTML::td( EEH_HTML::strong( $line_item->name() ), '', 'event-header', '', ' colspan="4"' );
+		$html .= EEH_HTML::td(EEH_HTML::strong($line_item->name()), '', 'event-header', '', ' colspan="4"');
 		// end of row
 		$html .= EEH_HTML::trx();
 		return $html;
@@ -224,10 +224,10 @@ 
 	 * @param array        $options
 	 * @return mixed
 	 */
-	private function _ticket_row( EE_Line_Item $line_item, $options = array() ) {
+	private function _ticket_row(EE_Line_Item $line_item, $options = array()) {
 		// start of row
 		$row_class = $options['odd'] ? 'item odd' : 'item';
-		$html = EEH_HTML::tr( '', '', $row_class );
+		$html = EEH_HTML::tr('', '', $row_class);
 		// name && desc
 		$name_and_desc = apply_filters(
 			'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__name',
@@ -236,23 +236,23 @@ 
 		);
 		$name_and_desc .= apply_filters(
 			'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__desc',
-			( $options['show_desc'] ? '<span class="line-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>' : '' ),
+			($options['show_desc'] ? '<span class="line-item-desc-spn smaller-text">: '.$line_item->desc().'</span>' : ''),
 			$line_item,
 			$options
 		);
 		$name_and_desc .= $line_item->is_taxable() ? ' * ' : '';
 		// name td
-		$html .= EEH_HTML::td( /*__FUNCTION__ .*/ $name_and_desc, '',  'item_l' );
+		$html .= EEH_HTML::td( /*__FUNCTION__ .*/ $name_and_desc, '', 'item_l' );
 		// price td
-		$html .= EEH_HTML::td( $line_item->unit_price_no_code(), '',  'item_c jst-rght' );
+		$html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c jst-rght');
 		// quantity td
-		$html .= EEH_HTML::td( $line_item->quantity(), '', 'item_l jst-rght' );
+		$html .= EEH_HTML::td($line_item->quantity(), '', 'item_l jst-rght');
 		$this->_total_items += $line_item->quantity();
 		// determine total for line item
 		$total = $line_item->total();
-		$this->_events[ $options[ 'event_id' ] ] += $total;
+		$this->_events[$options['event_id']] += $total;
 		// total td
-		$html .= EEH_HTML::td( EEH_Template::format_currency( $total, false, false ), '',  'item_r jst-rght' );
+		$html .= EEH_HTML::td(EEH_Template::format_currency($total, false, false), '', 'item_r jst-rght');
 		// end of row
 		$html .= EEH_HTML::trx();
 		return $html;
@@ -267,41 +267,41 @@ 
 	 * @param array        $options
 	 * @return mixed
 	 */
-	private function _item_row( EE_Line_Item $line_item, $options = array() ) {
+	private function _item_row(EE_Line_Item $line_item, $options = array()) {
 		// start of row
 		$row_class = $options['odd'] ? 'item odd' : 'item';
-		$html = EEH_HTML::tr( '', '', $row_class );
-		$obj_name = $line_item->OBJ_type() ? $line_item->OBJ_type_i18n() . ': ' : '';
+		$html = EEH_HTML::tr('', '', $row_class);
+		$obj_name = $line_item->OBJ_type() ? $line_item->OBJ_type_i18n().': ' : '';
 		// name && desc
 		$name_and_desc = apply_filters(
 			'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__name',
-			 $obj_name . $line_item->name(),
+			 $obj_name.$line_item->name(),
 			$line_item
 		);
 		$name_and_desc .= apply_filters(
 			'FHEE__EE_SPCO_Line_Item_Display_Strategy__item_row__desc',
-			( $options['show_desc'] ? '<span class="line-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>' : '' ),
+			($options['show_desc'] ? '<span class="line-item-desc-spn smaller-text">: '.$line_item->desc().'</span>' : ''),
 			$line_item,
 			$options
 		);
 		$name_and_desc .= $line_item->is_taxable() ? ' * ' : '';
 		// name td
-		$html .= EEH_HTML::td( $name_and_desc, '',  'item_l' );
+		$html .= EEH_HTML::td($name_and_desc, '', 'item_l');
 		// price td
-		if ( $line_item->is_percent() ) {
-			$html .= EEH_HTML::td( $line_item->percent() . '%', '', 'item_c jst-rght' );
+		if ($line_item->is_percent()) {
+			$html .= EEH_HTML::td($line_item->percent().'%', '', 'item_c jst-rght');
 		} else {
-			$html .= EEH_HTML::td( $line_item->unit_price_no_code(), '', 'item_c jst-rght' );
+			$html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c jst-rght');
 		}
 		// quantity td
-		$html .= EEH_HTML::td( $line_item->quantity(), '', 'item_l jst-rght' );
+		$html .= EEH_HTML::td($line_item->quantity(), '', 'item_l jst-rght');
 		//$total = $line_item->total() * $line_item->quantity();
 		$total = $line_item->total();
-		if( isset( $options[ 'event_id' ] ) && isset( $this->_events[ $options[ 'event_id' ] ] ) ) {
-			$this->_events[ $options[ 'event_id' ] ] += $total;
+		if (isset($options['event_id']) && isset($this->_events[$options['event_id']])) {
+			$this->_events[$options['event_id']] += $total;
 		}
 		// total td
-		$html .= EEH_HTML::td( EEH_Template::format_currency( $total, false, false ), '',  'item_r jst-rght' );
+		$html .= EEH_HTML::td(EEH_Template::format_currency($total, false, false), '', 'item_r jst-rght');
 		// end of row
 		$html .= EEH_HTML::trx();
 		return $html;
@@ -316,22 +316,22 @@ 
 	 * @param array        $options
 	 * @return mixed
 	 */
-	private function _sub_item_row( EE_Line_Item $line_item, $options = array() ) {
+	private function _sub_item_row(EE_Line_Item $line_item, $options = array()) {
 		// start of row
-		$html = EEH_HTML::tr( '', 'item sub-item-row' );
+		$html = EEH_HTML::tr('', 'item sub-item-row');
 		// name && desc
 		$name_and_desc = $line_item->name();
-		$name_and_desc .= $options['show_desc'] ? '<span class="line-sub-item-desc-spn smaller-text">: ' . $line_item->desc() . '</span>' : '';
+		$name_and_desc .= $options['show_desc'] ? '<span class="line-sub-item-desc-spn smaller-text">: '.$line_item->desc().'</span>' : '';
 		// name td
-		$html .= EEH_HTML::td( /*__FUNCTION__ .*/ $name_and_desc, '',  'item_l sub-item' );
+		$html .= EEH_HTML::td( /*__FUNCTION__ .*/ $name_and_desc, '', 'item_l sub-item' );
 		// discount/surcharge td
-		if ( $line_item->is_percent() ) {
-			$html .= EEH_HTML::td( $line_item->percent() . '%', '',  'item_c' );
+		if ($line_item->is_percent()) {
+			$html .= EEH_HTML::td($line_item->percent().'%', '', 'item_c');
 		} else {
-			$html .= EEH_HTML::td( $line_item->unit_price_no_code(), '',  'item_c jst-rght' );
+			$html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c jst-rght');
 		}
 		// total td
-		$html .= EEH_HTML::td( EEH_Template::format_currency( $line_item->total(), false, false ), '',  'item_r jst-rght' );
+		$html .= EEH_HTML::td(EEH_Template::format_currency($line_item->total(), false, false), '', 'item_r jst-rght');
 		// end of row
 		$html .= EEH_HTML::trx();
 		return $html;
@@ -346,21 +346,21 @@ 
 	 * @param array        $options
 	 * @return mixed
 	 */
-	private function _tax_row( EE_Line_Item $line_item, $options = array() ) {
+	private function _tax_row(EE_Line_Item $line_item, $options = array()) {
 		// start of row
-		$html = EEH_HTML::tr( '', 'item sub-item tax-total' );
+		$html = EEH_HTML::tr('', 'item sub-item tax-total');
 		// name && desc
 		$name_and_desc = $line_item->name();
-		$name_and_desc .= '<span class="smaller-text lt-grey-text" style="margin:0 0 0 2em;">' . __( ' * taxable items', 'event_espresso' ) . '</span>';
-		$name_and_desc .= $options[ 'show_desc' ] ? '<br/>' . $line_item->desc() : '';
+		$name_and_desc .= '<span class="smaller-text lt-grey-text" style="margin:0 0 0 2em;">'.__(' * taxable items', 'event_espresso').'</span>';
+		$name_and_desc .= $options['show_desc'] ? '<br/>'.$line_item->desc() : '';
 		// name td
-		$html .= EEH_HTML::td( /*__FUNCTION__ .*/ $name_and_desc, '',  'item_l sub-item' );
+		$html .= EEH_HTML::td( /*__FUNCTION__ .*/ $name_and_desc, '', 'item_l sub-item' );
 		// percent td
-		$html .= EEH_HTML::td( $line_item->percent() . '%', '',  ' jst-rght', '' );
+		$html .= EEH_HTML::td($line_item->percent().'%', '', ' jst-rght', '');
 		// empty td (price)
-		$html .= EEH_HTML::td( EEH_HTML::nbsp() );
+		$html .= EEH_HTML::td(EEH_HTML::nbsp());
 		// total td
-		$html .= EEH_HTML::td( EEH_Template::format_currency( $line_item->total(), false, false ), '',  'item_r jst-rght' );
+		$html .= EEH_HTML::td(EEH_Template::format_currency($line_item->total(), false, false), '', 'item_r jst-rght');
 		// end of row
 		$html .= EEH_HTML::trx();
 		return $html;
@@ -375,17 +375,17 @@ 
 	 * @param string $text
 	 * @return mixed
 	 */
-	private function _total_tax_row( EE_Line_Item $line_item, $text = '' ) {
+	private function _total_tax_row(EE_Line_Item $line_item, $text = '') {
 		$html = '';
-		if ( $line_item->total() ) {
+		if ($line_item->total()) {
 			// start of row
-			$html = EEH_HTML::tr( '', '', 'total_tr odd' );
+			$html = EEH_HTML::tr('', '', 'total_tr odd');
 			// total td
-			$html .= EEH_HTML::td( $text, '', 'total_currency total jst-rght', '', ' colspan="2"' );
+			$html .= EEH_HTML::td($text, '', 'total_currency total jst-rght', '', ' colspan="2"');
 			// empty td (price)
-			$html .= EEH_HTML::td( EEH_HTML::nbsp() );
+			$html .= EEH_HTML::td(EEH_HTML::nbsp());
 			// total td
-			$html .= EEH_HTML::td( EEH_Template::format_currency( $line_item->total(), false, false ), '', 'total jst-rght' );
+			$html .= EEH_HTML::td(EEH_Template::format_currency($line_item->total(), false, false), '', 'total jst-rght');
 			// end of row
 			$html .= EEH_HTML::trx();
 		}
@@ -402,15 +402,15 @@ 
 	 * @param array        $options
 	 * @return mixed
 	 */
-	private function _sub_total_row( EE_Line_Item $line_item, $text = '', $options = array() ) {
+	private function _sub_total_row(EE_Line_Item $line_item, $text = '', $options = array()) {
 		$html = '';
-		if ( $line_item->total() ) {
+		if ($line_item->total()) {
 			// start of row
-			$html = EEH_HTML::tr( '', '', 'total_tr odd' );
+			$html = EEH_HTML::tr('', '', 'total_tr odd');
 			// total td
-			$html .= EEH_HTML::td( $text, '', 'total_currency total jst-rght', '', ' colspan="3"' );
+			$html .= EEH_HTML::td($text, '', 'total_currency total jst-rght', '', ' colspan="3"');
 			// total td
-			$html .= EEH_HTML::td( EEH_Template::format_currency( $options[ 'sub_total' ], false, false ), '', 'total jst-rght' );
+			$html .= EEH_HTML::td(EEH_Template::format_currency($options['sub_total'], false, false), '', 'total jst-rght');
 			// end of row
 			$html .= EEH_HTML::trx();
 		}
@@ -427,13 +427,13 @@ 
 	 * @param string       $text
 	 * @return mixed
 	 */
-	private function _total_row( EE_Line_Item $line_item, $text = '' ) {
+	private function _total_row(EE_Line_Item $line_item, $text = '') {
 		// start of row
-		$html = EEH_HTML::tr( '', '', 'spco-grand-total total_tr odd' );
+		$html = EEH_HTML::tr('', '', 'spco-grand-total total_tr odd');
 		// total td
-		$html .= EEH_HTML::td( $text, '',  'total_currency total jst-rght',  '',  ' colspan="3"' );
+		$html .= EEH_HTML::td($text, '', 'total_currency total jst-rght', '', ' colspan="3"');
 		// total td
-		$html .= EEH_HTML::td( EEH_Template::format_currency( $line_item->total(), false, false ), '',  'total jst-rght' );
+		$html .= EEH_HTML::td(EEH_Template::format_currency($line_item->total(), false, false), '', 'total jst-rght');
 		// end of row
 		$html .= EEH_HTML::trx();
 		return $html;
@@ -448,30 +448,30 @@ 
 	 * @param array        $options
 	 * @return mixed
 	 */
-	private function _payments_and_amount_owing_rows( EE_Line_Item $line_item, $options = array() ) {
+	private function _payments_and_amount_owing_rows(EE_Line_Item $line_item, $options = array()) {
 		$html = '';
 		$owing = $line_item->total();
-		$transaction = EEM_Transaction::instance()->get_one_by_ID( $line_item->TXN_ID() );
-		if ( $transaction instanceof EE_Transaction ) {
+		$transaction = EEM_Transaction::instance()->get_one_by_ID($line_item->TXN_ID());
+		if ($transaction instanceof EE_Transaction) {
 			$registration_payments = array();
-			$registrations = ! empty( $options['registrations'] )
-				? $options[ 'registrations' ]
+			$registrations = ! empty($options['registrations'])
+				? $options['registrations']
 				: $transaction->registrations();
-			foreach ( $registrations as $registration ) {
-				if ( $registration instanceof EE_Registration && $registration->owes_monies_and_can_pay() ) {
+			foreach ($registrations as $registration) {
+				if ($registration instanceof EE_Registration && $registration->owes_monies_and_can_pay()) {
 					$registration_payments = $registration_payments + $registration->registration_payments();
 				}
 			}
-			if ( ! empty( $registration_payments )) {
-				foreach ( $registration_payments as $registration_payment ) {
-					if ( $registration_payment instanceof EE_Registration_Payment ) {
+			if ( ! empty($registration_payments)) {
+				foreach ($registration_payments as $registration_payment) {
+					if ($registration_payment instanceof EE_Registration_Payment) {
 						$owing = $owing - $registration_payment->amount();
 						$payment = $registration_payment->payment();
-						if ( $payment instanceof EE_Payment ) {
+						if ($payment instanceof EE_Payment) {
 							$payment_desc = sprintf(
-								__( 'Payment%1$s Received: %2$s', 'event_espresso' ),
+								__('Payment%1$s Received: %2$s', 'event_espresso'),
 								$payment->txn_id_chq_nmbr() != ''
-									? ' <span class="small-text">(#' . $payment->txn_id_chq_nmbr() . ')</span> '
+									? ' <span class="small-text">(#'.$payment->txn_id_chq_nmbr().')</span> '
 									: '',
 								$payment->timestamp()
 							);
@@ -479,12 +479,12 @@ 
 							$payment_desc = '';
 						}
 						// start of row
-						$html .= EEH_HTML::tr( '', '', 'total_tr odd' );
+						$html .= EEH_HTML::tr('', '', 'total_tr odd');
 						// payment desc
-						$html .= EEH_HTML::td( $payment_desc, '', '', '', ' colspan="3"' );
+						$html .= EEH_HTML::td($payment_desc, '', '', '', ' colspan="3"');
 						// total td
 						$html .= EEH_HTML::td(
-							EEH_Template::format_currency( $registration_payment->amount(), false, false ),
+							EEH_Template::format_currency($registration_payment->amount(), false, false),
 							'',
 							'total jst-rght'
 						);
@@ -492,17 +492,17 @@ 
 						$html .= EEH_HTML::trx();
 					}
 				}
-				if ( $line_item->total() ) {
+				if ($line_item->total()) {
 					// start of row
-					$html .= EEH_HTML::tr( '', '', 'total_tr odd' );
+					$html .= EEH_HTML::tr('', '', 'total_tr odd');
 					// total td
 					$html .= EEH_HTML::td(
 						__('Amount Owing', 'event_espresso'),
-						'',  'total_currency total jst-rght',  '',  ' colspan="3"'
+						'', 'total_currency total jst-rght', '', ' colspan="3"'
 					);
 					// total td
 					$html .= EEH_HTML::td(
-						EEH_Template::format_currency( $owing, false, false ), '',  'total jst-rght'
+						EEH_Template::format_currency($owing, false, false), '', 'total jst-rght'
 					);
 					// end of row
 					$html .= EEH_HTML::trx();

core/libraries/messages/defaults/EE_Messages_Template_Pack.core.php

Doc Comments +1 added lines

@@ -316,6 +316,7 @@
 	 * @param EE_message_type $message_type
 	 * @param string          $field          The field reference for the specific template being looked up.
 	 * @param string          $context      The context reference for the specific template being looked up
+	 * @param EE_Messages_Template_Pack_Default|null $default_pack
 	 *
 	 * @return string          The template contents.
 	 */

Braces +6 added lines, -3 removed lines

@@ -5,7 +5,9 @@ 
  * @subpackage messages
  * @since           4.5.0
  */
-if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
+}
 
 /**
  * EE_Template_Packs are classes that contain all the information related to messages templates for a given "template pack".
@@ -282,8 +284,9 @@ 
 
 		foreach ( $contexts as $context => $details ) {
 			foreach ( $fields as $field => $field_details ) {
-				if ( empty( $field_details ) )
-					continue;
+				if ( empty( $field_details ) ) {
+									continue;
+				}
 				/**
 				 * is this a field array (linked to a main field)?
 				 */

Spacing +85 added lines, -85 removed lines

@@ -167,44 +167,44 @@ 
 	public function __construct() {
 		$this->_set_props();
 		//make sure classname is correct
-		$classname = get_class( $this );
+		$classname = get_class($this);
 		//make sure required props have been set
 
 		//if label is empty then throw an error because we should have it defined by now.
-		if ( ! isset( $this->label )  ) {
-			throw new EE_Error( sprintf( __('The label property is not set for %s.  Please ensure that is set for the class.', 'event_espresso' ), $classname ) );
+		if ( ! isset($this->label)) {
+			throw new EE_Error(sprintf(__('The label property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
 		}
 
 
 		//the reference for this template pack
-		if ( ! isset( $this->dbref )  ) {
-			throw new EE_Error( sprintf( __('The dbref property is not set for %s.  Please ensure that is set for the class.', 'event_espresso' ), $classname ) );
+		if ( ! isset($this->dbref)) {
+			throw new EE_Error(sprintf(__('The dbref property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
 		}
 
 		//make sure dbref is safe
-		$this->dbref = str_replace( '-', '_', sanitize_key( $this->dbref ) );
+		$this->dbref = str_replace('-', '_', sanitize_key($this->dbref));
 
-		$should_be = 'EE_Messages_Template_Pack_' . str_replace( ' ', '_', ucwords( str_replace( '_', ' ', $this->dbref ) ) );
+		$should_be = 'EE_Messages_Template_Pack_'.str_replace(' ', '_', ucwords(str_replace('_', ' ', $this->dbref)));
 
-		if ( $should_be !== $classname ) {
-			throw new EE_Error( sprintf( __('The name of the template pack instantiated class is "%s".  It should be "%s".  Make sure that the name of the template pack class matches is prepended with "EE_Messages_Template_Pack_" and appended with a sentence case iteration of the value for your template pack\'s dbref property.', 'event_espresso' ), $classname, $should_be ) );
+		if ($should_be !== $classname) {
+			throw new EE_Error(sprintf(__('The name of the template pack instantiated class is "%s".  It should be "%s".  Make sure that the name of the template pack class matches is prepended with "EE_Messages_Template_Pack_" and appended with a sentence case iteration of the value for your template pack\'s dbref property.', 'event_espresso'), $classname, $should_be));
 		}
 
 		//if _base_path is not set then throw an error because a base path string is needed.
-		if ( empty( $this->_base_path ) ) {
-			throw new EE_Error( sprintf( __('The _base_path property is not set for %s.  Please ensure that is set for the class.', 'event_espresso' ), $classname ) );
+		if (empty($this->_base_path)) {
+			throw new EE_Error(sprintf(__('The _base_path property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
 		}
 
 
 		//if _base_url is not set then throw an error because a  string is needed for variations.
-		if ( empty( $this->_base_url ) ) {
-			throw new EE_Error( sprintf( __('The _base_url property is not set for %s.  Please ensure that is set for the class.', 'event_espresso' ), $classname ) );
+		if (empty($this->_base_url)) {
+			throw new EE_Error(sprintf(__('The _base_url property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
 		}
 
 
 		//if $supports is not set then throw an error because that effectively means this template_pack does not have any templates!
-		if ( empty( $this->_supports ) ) {
-			throw new EE_Error( sprintf( __('The supports property is not set for %s.  Please ensure that is set for the class.', 'event_espresso' ), $classname ) );
+		if (empty($this->_supports)) {
+			throw new EE_Error(sprintf(__('The supports property is not set for %s.  Please ensure that is set for the class.', 'event_espresso'), $classname));
 		}
 
 
@@ -241,8 +241,8 @@ 
 	 *
 	 * @return array
 	 */
-	public function get_templates( EE_messenger $messenger, EE_message_type $message_type ) {
-		return isset( $this->_templates[$messenger->name][$message_type->name] ) ? $this->_templates[$messenger->name][$message_type->name] : $this->_get_templates( $messenger, $message_type );
+	public function get_templates(EE_messenger $messenger, EE_message_type $message_type) {
+		return isset($this->_templates[$messenger->name][$message_type->name]) ? $this->_templates[$messenger->name][$message_type->name] : $this->_get_templates($messenger, $message_type);
 	}
 
 
@@ -259,7 +259,7 @@ 
 	 * @return array          Returns an multi-level associative array indexed by template context and field in the format:
 	 *                                array( 'context' => array( 'field' => 'value', 'another-field', 'value' ) );
 	 */
-	protected function _get_templates( EE_messenger $messenger, EE_message_type $message_type ) {
+	protected function _get_templates(EE_messenger $messenger, EE_message_type $message_type) {
 		$templates = array();
 
 		/**
@@ -278,28 +278,28 @@ 
 		$contexts = $message_type->get_contexts();
 
 
-		foreach ( $contexts as $context => $details ) {
-			foreach ( $fields as $field => $field_details ) {
-				if ( empty( $field_details ) )
+		foreach ($contexts as $context => $details) {
+			foreach ($fields as $field => $field_details) {
+				if (empty($field_details))
 					continue;
 				/**
 				 * is this a field array (linked to a main field)?
 				 */
-				if ( $field == 'extra'  ) {
-					foreach ( $field_details as $main_field => $sub_fields ) {
-						foreach ( $sub_fields as $sub_field => $sub_field_details ) {
+				if ($field == 'extra') {
+					foreach ($field_details as $main_field => $sub_fields) {
+						foreach ($sub_fields as $sub_field => $sub_field_details) {
 							//make sure that the template_field_ref matches what the main template field is for this template group.
 							$template_field_ref = $sub_field == 'main' ? $main_field : $sub_field;
-							$templates[ $context ][ $main_field ][ $sub_field ] = $this->_get_specific_template( $default_pack, $messenger, $message_type, $template_field_ref, $context );
+							$templates[$context][$main_field][$sub_field] = $this->_get_specific_template($default_pack, $messenger, $message_type, $template_field_ref, $context);
 						}
 					}
 				} else {
-					$templates[ $context ][ $field ] = $this->_get_specific_template( $default_pack, $messenger, $message_type, $field, $context );
+					$templates[$context][$field] = $this->_get_specific_template($default_pack, $messenger, $message_type, $field, $context);
 				}
 			}
 		}
 
-		$templates = apply_filters( 'FHEE__EE_Template_Pack___get_templates__templates', $templates, $messenger, $message_type, $this );
+		$templates = apply_filters('FHEE__EE_Template_Pack___get_templates__templates', $templates, $messenger, $message_type, $this);
 
 		$this->_templates[$messenger->name][$message_type->name] = $templates;
 		 return $templates;
@@ -317,22 +317,22 @@ 
 	 *
 	 * @return string          The template contents.
 	 */
-	protected function _get_specific_template( $default_pack, EE_messenger $messenger, EE_message_type $message_type, $field, $context ) {
+	protected function _get_specific_template($default_pack, EE_messenger $messenger, EE_message_type $message_type, $field, $context) {
 
 		//default templates
-		$default_templates = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_templates( $messenger, $message_type ) : array();
+		$default_templates = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_templates($messenger, $message_type) : array();
 
 		//first we allow for the $_base_path to be filtered.  However, we assign this to a new variable so that we have the original base_path as a fallback.
-		$filtered_base_path = apply_filters( 'FHEE__EE_Template_Pack___get_specific_template__filtered_base_path', $this->_base_path, $messenger, $message_type, $field, $context, $this );
+		$filtered_base_path = apply_filters('FHEE__EE_Template_Pack___get_specific_template__filtered_base_path', $this->_base_path, $messenger, $message_type, $field, $context, $this);
 
 		$master_templates = $message_type->get_master_templates();
-		$master_templates_mt = isset( $master_templates[$messenger->name] ) ? $master_templates[$messenger->name] : $message_type->name;
-		$full_path = $filtered_base_path . $messenger->name . '_' . $message_type->name . '_' . $field . '_' . $context . '.template.php';
-		$fallback_path = $filtered_base_path . $messenger->name . '_' . $message_type->name . '_' . $field . '.template.php';
-		$mt_defined_full_path = $filtered_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '_' . $context . '.template.php';
-		$mt_defined_fallback_path = $filtered_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '.template.php';
-		$base_defined_full_path = $this->_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '_' . $context . '.template.php';
-		$base_defined_fallback_path = $this->_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '.template.php';
+		$master_templates_mt = isset($master_templates[$messenger->name]) ? $master_templates[$messenger->name] : $message_type->name;
+		$full_path = $filtered_base_path.$messenger->name.'_'.$message_type->name.'_'.$field.'_'.$context.'.template.php';
+		$fallback_path = $filtered_base_path.$messenger->name.'_'.$message_type->name.'_'.$field.'.template.php';
+		$mt_defined_full_path = $filtered_base_path.$messenger->name.'_'.$master_templates_mt.'_'.$field.'_'.$context.'.template.php';
+		$mt_defined_fallback_path = $filtered_base_path.$messenger->name.'_'.$master_templates_mt.'_'.$field.'.template.php';
+		$base_defined_full_path = $this->_base_path.$messenger->name.'_'.$master_templates_mt.'_'.$field.'_'.$context.'.template.php';
+		$base_defined_fallback_path = $this->_base_path.$messenger->name.'_'.$master_templates_mt.'_'.$field.'.template.php';
 
 		/**
 		 * Template checks are done hierarchically in the following order:
@@ -346,28 +346,28 @@ 
 		 */
 
 
-		if ( is_readable( $full_path ) ) {
+		if (is_readable($full_path)) {
 			$actual_path = $full_path;
-		} elseif ( is_readable( $fallback_path ) ) {
+		} elseif (is_readable($fallback_path)) {
 			$actual_path = $fallback_path;
-		} elseif ( is_readable( $mt_defined_full_path ) ) {
+		} elseif (is_readable($mt_defined_full_path)) {
 			$actual_path = $mt_defined_full_path;
-		} elseif ( is_readable( $mt_defined_fallback_path ) ) {
+		} elseif (is_readable($mt_defined_fallback_path)) {
 			$actual_path = $mt_defined_fallback_path;
-		} elseif ( is_readable( $base_defined_full_path ) ) {
+		} elseif (is_readable($base_defined_full_path)) {
 			$actual_path = $base_defined_full_path;
-		} elseif ( is_readable( $base_defined_fallback_path ) ) {
+		} elseif (is_readable($base_defined_fallback_path)) {
 			$actual_path = $base_defined_fallback_path;
-		} else  {
+		} else {
 			$actual_path = '';
 		}
-		if ( empty( $actual_path ) ) {
-			$contents = isset( $default_templates[$context][$field] ) ? $default_templates[$context][$field] : '';
+		if (empty($actual_path)) {
+			$contents = isset($default_templates[$context][$field]) ? $default_templates[$context][$field] : '';
 		} else {
-			$contents = EEH_Template::display_template( $actual_path, array(), TRUE );
+			$contents = EEH_Template::display_template($actual_path, array(), TRUE);
 		}
 
-		return apply_filters( 'FHEE__EE_Messages_Template_Pack__get_specific_template__contents', $contents, $actual_path, $messenger, $message_type, $field, $context, $this );
+		return apply_filters('FHEE__EE_Messages_Template_Pack__get_specific_template__contents', $contents, $actual_path, $messenger, $message_type, $field, $context, $this);
 	}
 
 
@@ -382,8 +382,8 @@ 
 	 * @return array
 	 */
 	public function get_supports() {
-		$supports = apply_filters( 'FHEE__' . get_class( $this ) . '__get_supports', $this->_supports );
-		return apply_filters( 'FHEE__EE_Messages_Template_Pack__get_supports', $supports, $this );
+		$supports = apply_filters('FHEE__'.get_class($this).'__get_supports', $this->_supports);
+		return apply_filters('FHEE__EE_Messages_Template_Pack__get_supports', $supports, $this);
 	}
 
 
@@ -398,11 +398,11 @@ 
 	 *
 	 * @return array|string
 	 */
-	public function get_default_variation_labels( $messenger = '' ) {
-		$label = empty( $messenger ) ? $this->_default_variation_labels : array();
-		$label = empty( $label ) && ! empty( $this->_default_variation_labels[$messenger] ) ? $this->_default_variation_labels[$messenger] : __('Default', 'event_espresso');
+	public function get_default_variation_labels($messenger = '') {
+		$label = empty($messenger) ? $this->_default_variation_labels : array();
+		$label = empty($label) && ! empty($this->_default_variation_labels[$messenger]) ? $this->_default_variation_labels[$messenger] : __('Default', 'event_espresso');
 
-		return apply_filters( 'FHEE__EE_Messages_Template_Pack__get_default_variation_labels', $label, $this->_default_variation_labels, $messenger );
+		return apply_filters('FHEE__EE_Messages_Template_Pack__get_default_variation_labels', $label, $this->_default_variation_labels, $messenger);
 	}
 
 
@@ -418,25 +418,25 @@ 
 	 * @param string $message_type if included then css variations matching the message_type are returned (must have $messenger set).  Otherwise the array of variations per message type are returned.  If message_type is provided but NOT the messenger, then just all variations for all messengers are returned.
 	 * @return array
 	 */
-	public function get_variations( $messenger = '', $message_type = '' ) {
-		$messenger_variations = ! empty( $messenger ) && isset( $this->_variations[$messenger] ) ? $this->_variations[$messenger] : array();
+	public function get_variations($messenger = '', $message_type = '') {
+		$messenger_variations = ! empty($messenger) && isset($this->_variations[$messenger]) ? $this->_variations[$messenger] : array();
 
 		//message_type provided? IF so, then we've requested a specific set of variations, so we need to make sure we set it as empty if that's not present.
-		$variations = !empty( $messenger ) && !empty( $message_type ) && isset( $messenger_variations[$message_type] ) ? $messenger_variations[$message_type] : array();
+		$variations = ! empty($messenger) && ! empty($message_type) && isset($messenger_variations[$message_type]) ? $messenger_variations[$message_type] : array();
 
 		//now let's account for the possibility we just want all the variations for a messenger (which is indicated by providing the messenger but not the message type).
-		$variations = empty( $variations ) && !empty( $messenger ) && empty( $message_type ) ? $messenger_variations : $variations;
+		$variations = empty($variations) && ! empty($messenger) && empty($message_type) ? $messenger_variations : $variations;
 
 		//filter per template pack and globally.
-		$variations = apply_filters( 'FHEE__' . get_class( $this ) . '__get_variations', $variations, $messenger, $message_type );
-		$variations = apply_filters( 'FHEE__EE_Messages_Template_Pack__get_variations', $variations, $messenger, $message_type, $this );
+		$variations = apply_filters('FHEE__'.get_class($this).'__get_variations', $variations, $messenger, $message_type);
+		$variations = apply_filters('FHEE__EE_Messages_Template_Pack__get_variations', $variations, $messenger, $message_type, $this);
 
 		//prepend the _default_variation, but ONLY if we're returning the fully validated array.
-		if ( !empty( $messenger ) && !empty( $message_type ) && ! empty( $variations ) ) {
-			$variations = array( 'default' => $this->get_default_variation_labels( $messenger ) ) + $variations;
+		if ( ! empty($messenger) && ! empty($message_type) && ! empty($variations)) {
+			$variations = array('default' => $this->get_default_variation_labels($messenger)) + $variations;
 		}
 
-		return empty( $variations ) ? array( 'default' => $this->get_default_variation_labels('dft') ): $variations;
+		return empty($variations) ? array('default' => $this->get_default_variation_labels('dft')) : $variations;
 	}
 
 
@@ -457,39 +457,39 @@ 
 	 *
 	 * @return string The variation path or url (typically css reference)
 	 */
-	public function get_variation( $messenger, $message_type, $type, $variation, $url = true, $file_extension = '.css', $skip_filters = FALSE ) {
+	public function get_variation($messenger, $message_type, $type, $variation, $url = true, $file_extension = '.css', $skip_filters = FALSE) {
 
 		$base = $url ? $this->_base_url : $this->_base_path;
 		$base_path = $this->_base_path;
 
-		if ( ! $skip_filters ) {
-			$base =  apply_filters( 'FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url', $base, $messenger, $message_type, $type, $variation, $url, $file_extension, $this );
-			$base_path = apply_filters( 'FHEE__EE_Messages_Template_Pack__get_variation__base_path', $base_path, $messenger, $message_type, $type, $variation, FALSE, $file_extension, $this );
+		if ( ! $skip_filters) {
+			$base = apply_filters('FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url', $base, $messenger, $message_type, $type, $variation, $url, $file_extension, $this);
+			$base_path = apply_filters('FHEE__EE_Messages_Template_Pack__get_variation__base_path', $base_path, $messenger, $message_type, $type, $variation, FALSE, $file_extension, $this);
 		}
 
-		$default_pack = get_class( $this ) != 'EE_Messages_Template_Pack_Default' ? new EE_Messages_Template_Pack_Default() : $this;
+		$default_pack = get_class($this) != 'EE_Messages_Template_Pack_Default' ? new EE_Messages_Template_Pack_Default() : $this;
 
 		//possible variation paths considering whether message type is present or not in the file name.
-		$path_string = 'variations/' . $messenger . '_' . $message_type . '_'  . $type . '_' . $variation . $file_extension;
-		$default_path_string = 'variations/' . $messenger . '_' . $type . '_' . $variation . $file_extension;
+		$path_string = 'variations/'.$messenger.'_'.$message_type.'_'.$type.'_'.$variation.$file_extension;
+		$default_path_string = 'variations/'.$messenger.'_'.$type.'_'.$variation.$file_extension;
 
 		//first see if fully validated file exists.
-		if ( is_readable( $base_path . $path_string ) ) {
-			$variation_path = $base . $path_string;
+		if (is_readable($base_path.$path_string)) {
+			$variation_path = $base.$path_string;
 		//otherwise see if default exists.
-		} elseif ( is_readable( $base_path . $default_path_string ) ) {
-			$variation_path = $base . $default_path_string;
+		} elseif (is_readable($base_path.$default_path_string)) {
+			$variation_path = $base.$default_path_string;
 		} else {
-			$variation_path = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_default_variation( $messenger, $message_type, $type, $url, $file_extension ) : '';
+			$variation_path = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_default_variation($messenger, $message_type, $type, $url, $file_extension) : '';
 		}
 
-		if ( $skip_filters ) {
+		if ($skip_filters) {
 			return $variation_path;
 		}
 
 		//filter result
-		$variation_path = apply_filters( 'FHEE__' . get_class( $this ) . '__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url );
-		return apply_filters( 'FHEE__EE_Messages_Template_Pack__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url, $this );
+		$variation_path = apply_filters('FHEE__'.get_class($this).'__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url);
+		return apply_filters('FHEE__EE_Messages_Template_Pack__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url, $this);
 	}
 
 
@@ -504,19 +504,19 @@ 
 	 *
 	 * @return string returns the path for the requested wrapper template.
 	 */
-	public function get_wrapper( $messenger, $type = 'main' ) {
-		$default_pack = get_class( $this ) !== 'EE_Messages_Template_Pack_Default' ? new EE_Messages_Template_Pack_Default() : NULL;
+	public function get_wrapper($messenger, $type = 'main') {
+		$default_pack = get_class($this) !== 'EE_Messages_Template_Pack_Default' ? new EE_Messages_Template_Pack_Default() : NULL;
 
-		$path_string = $this->_base_path . $messenger . '_' . $type . '_wrapper.template.php';
+		$path_string = $this->_base_path.$messenger.'_'.$type.'_wrapper.template.php';
 
-		if ( is_readable( $path_string ) ) {
+		if (is_readable($path_string)) {
 			$template = $path_string;
 		} else {
-			$template = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_wrapper( $messenger, $type ) : '';
+			$template = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_wrapper($messenger, $type) : '';
 		}
 
 		//filter
-		$template = apply_filters( 'FHEE__' . get_class( $this ) . '__get_wrapper', $template, $messenger, $type );
-		return apply_filters( 'FHEE__EE_Messages_Template_Pack__get_wrapper', $template, $messenger, $type, $this );
+		$template = apply_filters('FHEE__'.get_class($this).'__get_wrapper', $template, $messenger, $type);
+		return apply_filters('FHEE__EE_Messages_Template_Pack__get_wrapper', $template, $messenger, $type, $this);
 	}
 }

core/libraries/messages/messenger/EE_Pdf_messenger.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -332,7 +332,7 @@
 
 
 	/**
-	 * @return string
+	 * @return boolean|null
 	 */
 	protected function _preview() { return $this->_send_message(); }
 

Braces +2 added lines, -1 removed lines

@@ -6,8 +6,9 @@
  * @package Event Espresso
  * @subpackage messages
  */
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if (!defined('EVENT_ESPRESSO_VERSION') ) {
 	exit('NO direct script access allowed');
+}
 
 /**
  *

Spacing +25 added lines, -25 removed lines

@@ -6,7 +6,7 @@ 
  * @package Event Espresso
  * @subpackage messages
  */
-if (!defined('EVENT_ESPRESSO_VERSION') )
+if ( ! defined('EVENT_ESPRESSO_VERSION'))
 	exit('NO direct script access allowed');
 
 /**
@@ -20,7 +20,7 @@ 
  * @subpackage		messages
  * @author			Darren Ethier
  */
-class EE_Pdf_messenger extends EE_messenger  {
+class EE_Pdf_messenger extends EE_messenger {
 
 
 	/**
@@ -65,7 +65,7 @@ 
 	 * @see abstract declaration in EE_messenger for details.
 	 */
 	protected function _set_admin_pages() {
-		$this->admin_registered_pages = array( 'events_edit' => false );
+		$this->admin_registered_pages = array('events_edit' => false);
 	}
 
 
@@ -85,10 +85,10 @@ 
 	protected function _set_validator_config() {
 		$this->_validator_config = array(
 			'subject' => array(
-				'shortcodes' => array('recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email','event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime')
+				'shortcodes' => array('recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email', 'event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime')
 				),
 			'content' => array(
-				'shortcodes' => array( 'recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email','event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime')
+				'shortcodes' => array('recipient_details', 'organization', 'event', 'ticket', 'venue', 'primary_registration_details', 'event_author', 'email', 'event_meta', 'recipient_list', 'transaction', 'datetime_list', 'datetime')
 				),
 			'attendee_list' => array(
 				'shortcodes' => array('attendee', 'event_list', 'ticket_list'),
@@ -99,7 +99,7 @@ 
 				'required' => array('[EVENT_LIST]')
 				),
 			'ticket_list' => array(
-				'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list','primary_registration_details', 'recipient_details'),
+				'shortcodes' => array('event_list', 'attendee_list', 'ticket', 'datetime_list', 'primary_registration_details', 'recipient_details'),
 				'required' => array('[TICKET_LIST]')
 				),
 			'datetime_list' => array(
@@ -119,7 +119,7 @@ 
 	 */
 	public  function enqueue_scripts_styles() {
 		parent::enqueue_scripts_styles();
-		do_action( 'AHEE__EE_Pdf_messenger__enqueue_scripts_styles');
+		do_action('AHEE__EE_Pdf_messenger__enqueue_scripts_styles');
 	}
 
 
@@ -245,18 +245,18 @@ 
 	 */
 	protected function _send_message() {
 		$this->_template_args = array(
-			'page_title' => html_entity_decode( stripslashes( $this->_subject ), ENT_QUOTES, "UTF-8"),
-			'base_css' => $this->get_variation( $this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'base', $this->_variation ),
-			'print_css' => $this->get_variation( $this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'print', $this->_variation ),
-			'main_css' => $this->get_variation( $this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'main', $this->_variation ),
-			'extra_css' => EE_LIBRARIES_URL . 'messages/defaults/default/variations/pdf_base_default.css',
-			'main_body' => apply_filters( 'FHEE__EE_Pdf_messenger___send_message__main_body', wpautop(stripslashes_deep( html_entity_decode($this->_content,  ENT_QUOTES,"UTF-8" ) )), $this->_content )
+			'page_title' => html_entity_decode(stripslashes($this->_subject), ENT_QUOTES, "UTF-8"),
+			'base_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'base', $this->_variation),
+			'print_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'print', $this->_variation),
+			'main_css' => $this->get_variation($this->_tmp_pack, $this->_incoming_message_type->name, TRUE, 'main', $this->_variation),
+			'extra_css' => EE_LIBRARIES_URL.'messages/defaults/default/variations/pdf_base_default.css',
+			'main_body' => apply_filters('FHEE__EE_Pdf_messenger___send_message__main_body', wpautop(stripslashes_deep(html_entity_decode($this->_content, ENT_QUOTES, "UTF-8"))), $this->_content)
 			);
 		$this->_deregister_wp_hooks();
-		add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_scripts_styles' ) );
+		add_action('wp_enqueue_scripts', array($this, 'enqueue_scripts_styles'));
 		$content = $this->_get_main_template();
 //		die( $content );
-		$this->_do_pdf( $content );
+		$this->_do_pdf($content);
 		exit(0);
 	}
 
@@ -280,8 +280,8 @@ 
 
 		//just add back in wp_enqueue_scripts and wp_print_footer_scripts cause that's all we want to load.
 		add_action('wp_head', 'wp_enqueue_scripts');
-		add_action( 'wp_footer', 'wp_print_footer_scripts' );
-		add_action( 'wp_print_footer_scripts', '_wp_footer_scripts' );
+		add_action('wp_footer', 'wp_print_footer_scripts');
+		add_action('wp_print_footer_scripts', '_wp_footer_scripts');
 	}
 
 
@@ -294,11 +294,11 @@ 
 	 * @param bool $preview
 	 * @return string
 	 */
-	protected function _get_main_template( $preview = FALSE ) {
-		$wrapper_template = $this->_tmp_pack->get_wrapper( 'html', 'main' );
+	protected function _get_main_template($preview = FALSE) {
+		$wrapper_template = $this->_tmp_pack->get_wrapper('html', 'main');
 		//add message type to template_args
 		$this->_template_args['message_type'] = $this->_incoming_message_type;
-		return EEH_Template::display_template( $wrapper_template, $this->_template_args, TRUE );
+		return EEH_Template::display_template($wrapper_template, $this->_template_args, TRUE);
 	}
 
 
@@ -311,21 +311,21 @@ 
 	 *
 	 * @return void
 	 */
-	protected function _do_pdf( $content = '' ) {
-		$invoice_name = html_entity_decode( $this->_subject, ENT_QUOTES, "UTF-8");
+	protected function _do_pdf($content = '') {
+		$invoice_name = html_entity_decode($this->_subject, ENT_QUOTES, "UTF-8");
 
 		//only load dompdf if nobody else has yet...
-		if( ! defined('DOMPDF_DIR')){
+		if ( ! defined('DOMPDF_DIR')) {
 			define('DOMPDF_ENABLE_REMOTE', TRUE);
 			define('DOMPDF_ENABLE_JAVASCRIPT', FALSE);
 			define('DOMPDF_ENABLE_CSS_FLOAT', TRUE);
-			require_once(EE_THIRD_PARTY . 'dompdf/dompdf_config.inc.php');
+			require_once(EE_THIRD_PARTY.'dompdf/dompdf_config.inc.php');
 		}
 		$dompdf = new DOMPDF();
 		$dompdf->load_html($content);
 		$dompdf->render();
 		//forcing the browser to open a download dialog.
-		$dompdf->stream($invoice_name . ".pdf", array( 'Attachment' => TRUE ));
+		$dompdf->stream($invoice_name.".pdf", array('Attachment' => TRUE));
 	}