eventespresso / event-espresso-core

core/db_models/EEM_Payment_Method.model.php

Doc Comments +3 added lines, -3 removed lines

@@ -201,7 +201,7 @@ 
 	/**
 	 * Overrides parent ot also check by the slug
 	 * @see EEM_Base::ensure_is_obj()
-	 * @param string|int|EE_Payment_Method $base_class_obj_or_id
+	 * @param EE_Payment_Method $base_class_obj_or_id
 	 * @param boolean                      $ensure_is_in_db
 	 * @return EE_Payment_Method
 	 * @throws EE_Error
@@ -363,8 +363,8 @@ 
 	 * Note: if an offline payment method was selected on the related transaction then this will have no payment methods returned.
 	 * It will ONLY return a payment method for a PAYMENT recorded against the registration.
 	 *
-	 * @param EE_Registration|int $registration_or_reg_id  Either the EE_Registration object or the id for the registration.
-	 * @return EE_Payment|null
+	 * @param EE_Registration $registration_or_reg_id  Either the EE_Registration object or the id for the registration.
+	 * @return EE_Base_Class|null
 	 */
 	public function get_last_used_for_registration( $registration_or_reg_id ) {
 		$registration_id = EEM_Registration::instance()->ensure_is_ID( $registration_or_reg_id );

Spacing +91 added lines, -91 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');
 }
 /**
  *
@@ -37,33 +37,33 @@ 
 	 * @access   protected
 	 * @return EEM_Payment_Method
 	 */
-	protected function __construct( $timezone = NULL ) {
-		$this->singlular_item = __( 'Payment Method', 'event_espresso' );
-		$this->plural_item = __( 'Payment Methods', 'event_espresso' );
-		$this->_tables = array( 'Payment_Method' => new EE_Primary_Table( 'esp_payment_method', 'PMD_ID' ) );
+	protected function __construct($timezone = NULL) {
+		$this->singlular_item = __('Payment Method', 'event_espresso');
+		$this->plural_item = __('Payment Methods', 'event_espresso');
+		$this->_tables = array('Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID'));
 		$this->_fields = array(
 			'Payment_Method' => array(
-				'PMD_ID' => new EE_Primary_Key_Int_Field( 'PMD_ID', __( "ID", 'event_espresso' ) ),
-				'PMD_type' => new EE_Plain_Text_Field( 'PMD_type', __( "Payment Method Type", 'event_espresso' ), FALSE, 'Admin_Only' ),
-				'PMD_name' => new EE_Plain_Text_Field( 'PMD_name', __( "Name", 'event_espresso' ), FALSE ),
-				'PMD_desc' => new EE_Post_Content_Field( 'PMD_desc', __( "Description", 'event_espresso' ), FALSE, '' ),
-				'PMD_admin_name' => new EE_Plain_Text_Field( 'PMD_admin_name', __( "Admin-Only Name", 'event_espresso' ), TRUE ),
-				'PMD_admin_desc' => new EE_Post_Content_Field( 'PMD_admin_desc', __( "Admin-Only Description", 'event_espresso' ), TRUE ),
-				'PMD_slug' => new EE_Slug_Field( 'PMD_slug', __( "Slug", 'event_espresso' ), FALSE ),
-				'PMD_order' => new EE_Integer_Field( 'PMD_order', __( "Order", 'event_espresso' ), FALSE, 0 ),
-				'PMD_debug_mode' => new EE_Boolean_Field( 'PMD_debug_mode', __( "Debug Mode On?", 'event_espresso' ), FALSE, FALSE ),
-				'PMD_wp_user' => new EE_WP_User_Field( 'PMD_wp_user', __( "Payment Method Creator ID", 'event_espresso' ), FALSE ),
-				'PMD_open_by_default' => new EE_Boolean_Field( 'PMD_open_by_default', __( "Open by Default?", 'event_espresso' ), FALSE, FALSE ), 'PMD_button_url' => new EE_Plain_Text_Field( 'PMD_button_url', __( "Button URL", 'event_espresso' ), TRUE, '' ),
-				'PMD_scope' => new EE_Serialized_Text_Field( 'PMD_scope', __( "Usable From?", 'event_espresso' ), FALSE, array() ), //possible values currently are 'CART','ADMIN','API'
+				'PMD_ID' => new EE_Primary_Key_Int_Field('PMD_ID', __("ID", 'event_espresso')),
+				'PMD_type' => new EE_Plain_Text_Field('PMD_type', __("Payment Method Type", 'event_espresso'), FALSE, 'Admin_Only'),
+				'PMD_name' => new EE_Plain_Text_Field('PMD_name', __("Name", 'event_espresso'), FALSE),
+				'PMD_desc' => new EE_Post_Content_Field('PMD_desc', __("Description", 'event_espresso'), FALSE, ''),
+				'PMD_admin_name' => new EE_Plain_Text_Field('PMD_admin_name', __("Admin-Only Name", 'event_espresso'), TRUE),
+				'PMD_admin_desc' => new EE_Post_Content_Field('PMD_admin_desc', __("Admin-Only Description", 'event_espresso'), TRUE),
+				'PMD_slug' => new EE_Slug_Field('PMD_slug', __("Slug", 'event_espresso'), FALSE),
+				'PMD_order' => new EE_Integer_Field('PMD_order', __("Order", 'event_espresso'), FALSE, 0),
+				'PMD_debug_mode' => new EE_Boolean_Field('PMD_debug_mode', __("Debug Mode On?", 'event_espresso'), FALSE, FALSE),
+				'PMD_wp_user' => new EE_WP_User_Field('PMD_wp_user', __("Payment Method Creator ID", 'event_espresso'), FALSE),
+				'PMD_open_by_default' => new EE_Boolean_Field('PMD_open_by_default', __("Open by Default?", 'event_espresso'), FALSE, FALSE), 'PMD_button_url' => new EE_Plain_Text_Field('PMD_button_url', __("Button URL", 'event_espresso'), TRUE, ''),
+				'PMD_scope' => new EE_Serialized_Text_Field('PMD_scope', __("Usable From?", 'event_espresso'), FALSE, array()), //possible values currently are 'CART','ADMIN','API'
 		) );
 		$this->_model_relations = array(
  //			'Event'=>new EE_HABTM_Relation('Event_Payment_Method'),
 			'Payment' => new EE_Has_Many_Relation(),
-			'Currency' => new EE_HABTM_Relation( 'Currency_Payment_Method' ),
+			'Currency' => new EE_HABTM_Relation('Currency_Payment_Method'),
 			'Transaction' => new EE_Has_Many_Relation(),
 			'WP_User' => new EE_Belongs_To_Relation(),
 		);
-		parent::__construct( $timezone );
+		parent::__construct($timezone);
 	}
 
 
@@ -73,8 +73,8 @@ 
 	 * @param string $slug
 	 * @return EE_Payment_Method
 	 */
-	public function get_one_by_slug( $slug ) {
-		return $this->get_one( array( array( 'PMD_slug' => $slug ) ) );
+	public function get_one_by_slug($slug) {
+		return $this->get_one(array(array('PMD_slug' => $slug)));
 	}
 
 
@@ -88,8 +88,8 @@ 
 		return apply_filters(
 			'FHEE__EEM_Payment_Method__scopes',
 			array(
-				self::scope_cart 		=> __( "Front-end Registration Page", 'event_espresso' ),
-				self::scope_admin 	=> __( "Admin Registration Page (no online processing)", 'event_espresso' )
+				self::scope_cart 		=> __("Front-end Registration Page", 'event_espresso'),
+				self::scope_admin 	=> __("Admin Registration Page (no online processing)", 'event_espresso')
 			)
 		);
 	}
@@ -101,9 +101,9 @@ 
 	 * @param string $scope like one of EEM_Payment_Method::instance()->scopes()
 	 * @return boolean
 	 */
-	public function is_valid_scope( $scope ) {
+	public function is_valid_scope($scope) {
 		$scopes = $this->scopes();
-		if ( isset( $scopes[ $scope ] ) ) {
+		if (isset($scopes[$scope])) {
 			return TRUE;
 		} else {
 			return FALSE;
@@ -119,11 +119,11 @@ 
 	 * @throws EE_Error
 	 * @return EE_Payment_Method[]
 	 */
-	public function get_all_active( $scope = NULL, $query_params = array() ) {
-		if( ! isset( $query_params[ 'order_by' ] ) && ! isset( $query_params[ 'order' ] ) ) {
-			$query_params = array( 'order_by' => array( 'PMD_order' => 'ASC', 'PMD_ID' => 'ASC' ) );
+	public function get_all_active($scope = NULL, $query_params = array()) {
+		if ( ! isset($query_params['order_by']) && ! isset($query_params['order'])) {
+			$query_params = array('order_by' => array('PMD_order' => 'ASC', 'PMD_ID' => 'ASC'));
 		}
-		return $this->get_all( $this->_get_query_params_for_all_active( $scope, $query_params ) );
+		return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
 	}
 
 	/**
@@ -132,8 +132,8 @@ 
 	 * @param array $query_params
 	 * @return int
 	 */
-	public function count_active( $scope = NULL, $query_params = array() ){
-		return $this->count( $this->_get_query_params_for_all_active( $scope, $query_params ) );
+	public function count_active($scope = NULL, $query_params = array()) {
+		return $this->count($this->_get_query_params_for_all_active($scope, $query_params));
 	}
 
 	/**
@@ -144,21 +144,21 @@ 
 	 * @return array like param of EEM_Base::get_all()
 	 * @throws EE_Error
 	 */
-	protected function _get_query_params_for_all_active( $scope = NULL, $query_params = array() ){
-		if ( $scope ) {
-			if ( $this->is_valid_scope( $scope ) ) {
-				return array_replace_recursive( array( array( 'PMD_scope' => array( 'LIKE', "%$scope%" ) ) ), $query_params );
+	protected function _get_query_params_for_all_active($scope = NULL, $query_params = array()) {
+		if ($scope) {
+			if ($this->is_valid_scope($scope)) {
+				return array_replace_recursive(array(array('PMD_scope' => array('LIKE', "%$scope%"))), $query_params);
 			} else {
-				throw new EE_Error( sprintf( __( "'%s' is not a valid scope for a payment method", "event_espresso" ), $scope ) );
+				throw new EE_Error(sprintf(__("'%s' is not a valid scope for a payment method", "event_espresso"), $scope));
 			}
 		} else {
 			$acceptable_scopes = array();
 			$count = 0;
-			foreach ( $this->scopes() as $scope_name => $desc ) {
+			foreach ($this->scopes() as $scope_name => $desc) {
 				$count++;
-				$acceptable_scopes[ 'PMD_scope*' . $count ] = array( 'LIKE', '%' . $scope_name . '%' );
+				$acceptable_scopes['PMD_scope*'.$count] = array('LIKE', '%'.$scope_name.'%');
 			}
-			return array_replace_recursive( array( array( 'OR*active_scope' => $acceptable_scopes ) ), $query_params );
+			return array_replace_recursive(array(array('OR*active_scope' => $acceptable_scopes)), $query_params);
 		}
 	}
 
@@ -170,8 +170,8 @@ 
 	 * @return array like param of EEM_Base::get_all()
 	 * @throws EE_Error
 	 */
-	public function get_query_params_for_all_active( $scope = NULL, $query_params = array() ) {
-		return $this->_get_query_params_for_all_active( $scope, $query_params );
+	public function get_query_params_for_all_active($scope = NULL, $query_params = array()) {
+		return $this->_get_query_params_for_all_active($scope, $query_params);
 	}
 
 
@@ -181,8 +181,8 @@ 
 	 * @param array  $query_params
 	 * @return EE_Payment_Method
 	 */
-	public function get_one_active( $scope = NULL, $query_params = array() ) {
-		return $this->get_one( $this->_get_query_params_for_all_active( $scope, $query_params ) );
+	public function get_one_active($scope = NULL, $query_params = array()) {
+		return $this->get_one($this->_get_query_params_for_all_active($scope, $query_params));
 	}
 
 
@@ -192,8 +192,8 @@ 
 	 * @param string $type
 	 * @return EE_Payment_Method
 	 */
-	public function get_one_of_type( $type ) {
-		return $this->get_one( array( array( 'PMD_type' => $type ) ) );
+	public function get_one_of_type($type) {
+		return $this->get_one(array(array('PMD_type' => $type)));
 	}
 
 
@@ -206,22 +206,22 @@ 
 	 * @return EE_Payment_Method
 	 * @throws EE_Error
 	 */
-	public function ensure_is_obj( $base_class_obj_or_id, $ensure_is_in_db = FALSE ) {
+	public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = FALSE) {
 		//first: check if it's a slug
-		if( is_string( $base_class_obj_or_id ) ) {
-			$obj = $this->get_one_by_slug( $base_class_obj_or_id );
-			if( $obj ) {
+		if (is_string($base_class_obj_or_id)) {
+			$obj = $this->get_one_by_slug($base_class_obj_or_id);
+			if ($obj) {
 				return $obj;
 			}
 		}
 		//ok so it wasn't a slug we were passed. try the usual then (ie, it's an object or an ID)
 		try {
-			return parent::ensure_is_obj( $base_class_obj_or_id, $ensure_is_in_db );
+			return parent::ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db);
 		}
-		catch ( EE_Error $e ) {
+		catch (EE_Error $e) {
 			//handle it outside the catch
 		}
-		throw new EE_Error( sprintf( __( "'%s' is neither a Payment Method ID, slug, nor object.", "event_espresso" ), $base_class_obj_or_id ) );
+		throw new EE_Error(sprintf(__("'%s' is neither a Payment Method ID, slug, nor object.", "event_espresso"), $base_class_obj_or_id));
 	}
 
 
@@ -232,12 +232,12 @@ 
 	 * @param mixed $base_obj_or_id_or_slug
 	 * @return int
 	 */
-	function ensure_is_ID( $base_obj_or_id_or_slug ) {
-		if ( is_string( $base_obj_or_id_or_slug ) ) {
+	function ensure_is_ID($base_obj_or_id_or_slug) {
+		if (is_string($base_obj_or_id_or_slug)) {
 			//assume it's a slug
-			$base_obj_or_id_or_slug = $this->get_one_by_slug( $base_obj_or_id_or_slug );
+			$base_obj_or_id_or_slug = $this->get_one_by_slug($base_obj_or_id_or_slug);
 		}
-		return parent::ensure_is_ID( $base_obj_or_id_or_slug );
+		return parent::ensure_is_ID($base_obj_or_id_or_slug);
 	}
 
 
@@ -246,37 +246,37 @@ 
 	 * Verifies the button urls on all the passed payment methods have a valid button url. If not, resets them to their default.
 	 * @param EE_Payment_Method[] $payment_methods. If NULL is provided defaults to all payment methods active in the cart
 	 */
-	function verify_button_urls( $payment_methods = NULL ) {
-		EE_Registry::instance()->load_helper( 'URL' );
-		$payment_methods = is_array( $payment_methods ) ? $payment_methods : $this->get_all_active(EEM_Payment_Method::scope_cart);
-		foreach ( $payment_methods as $payment_method ) {
+	function verify_button_urls($payment_methods = NULL) {
+		EE_Registry::instance()->load_helper('URL');
+		$payment_methods = is_array($payment_methods) ? $payment_methods : $this->get_all_active(EEM_Payment_Method::scope_cart);
+		foreach ($payment_methods as $payment_method) {
 			try {
 				$current_button_url = $payment_method->button_url();
-				$buttons_urls_to_try = apply_filters( 'FHEE__EEM_Payment_Method__verify_button_urls__button_urls_to_try', array(
-					'current_ssl' => str_replace( "http://", "https://", $current_button_url ),
-					'current' => str_replace( "https://", "http://", $current_button_url ),
-					'default_ssl' => str_replace( "http://", "https://", $payment_method->type_obj()->default_button_url() ),
-					'default' => str_replace( "https://", "http://", $payment_method->type_obj()->default_button_url() ),
-				) );
-				foreach( $buttons_urls_to_try as $button_url_to_try ) {
-					if(
+				$buttons_urls_to_try = apply_filters('FHEE__EEM_Payment_Method__verify_button_urls__button_urls_to_try', array(
+					'current_ssl' => str_replace("http://", "https://", $current_button_url),
+					'current' => str_replace("https://", "http://", $current_button_url),
+					'default_ssl' => str_replace("http://", "https://", $payment_method->type_obj()->default_button_url()),
+					'default' => str_replace("https://", "http://", $payment_method->type_obj()->default_button_url()),
+				));
+				foreach ($buttons_urls_to_try as $button_url_to_try) {
+					if (
 							(//this is the current url and it exists, regardless of SSL issues
 								$button_url_to_try == $current_button_url &&
 								EEH_URL::remote_file_exists(
 										$button_url_to_try,
 										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
 											) )
 							)
 							||
 							(//this is NOT the current url and it exists with a working SSL cert
 								$button_url_to_try != $current_button_url &&
-								EEH_URL::remote_file_exists( $button_url_to_try )
+								EEH_URL::remote_file_exists($button_url_to_try)
 							) ) {
-						if( $current_button_url != $button_url_to_try ){
-							$payment_method->save( array( 'PMD_button_url' => $button_url_to_try ) );
-							EE_Error::add_attention( sprintf( __( "Payment Method %s's button url was set to %s, because the old image either didnt exist or SSL was recently enabled.", "event_espresso" ), $payment_method->name(), $button_url_to_try ) );
+						if ($current_button_url != $button_url_to_try) {
+							$payment_method->save(array('PMD_button_url' => $button_url_to_try));
+							EE_Error::add_attention(sprintf(__("Payment Method %s's button url was set to %s, because the old image either didnt exist or SSL was recently enabled.", "event_espresso"), $payment_method->name(), $button_url_to_try));
 						}
 						//this image exists. So if wasn't set before, now it is;
 						//or if it was already set, we have nothing to do
@@ -284,8 +284,8 @@ 
 					}
 				}
 			}
-			catch ( EE_Error $e ) {
-				$payment_method->set_active( FALSE );
+			catch (EE_Error $e) {
+				$payment_method->set_active(FALSE);
 			}
 		}
 	}
@@ -299,16 +299,16 @@ 
 	 * @param array $rows
 	 * @return EE_Payment_Method[]
 	 */
-	protected function _create_objects( $rows = array() ) {
-		$payment_methods = parent::_create_objects( $rows );
+	protected function _create_objects($rows = array()) {
+		$payment_methods = parent::_create_objects($rows);
 		/* @var $payment_methods EE_Payment_Method[] */
 		$usable_payment_methods = array();
-		foreach ( $payment_methods as $key => $payment_method ) {
+		foreach ($payment_methods as $key => $payment_method) {
 			try {
 				$payment_method->type_obj();
-				$usable_payment_methods[ $key ] = $payment_method;
+				$usable_payment_methods[$key] = $payment_method;
 			}
-			catch ( EE_Error $e ) {
+			catch (EE_Error $e) {
 				//if it threw an exception, its because the payment type object
 				//isn't defined (probably because somehow the DB got borked,
 				//or an addon which defined it got deactivated
@@ -317,10 +317,10 @@ 
 				$payment_method->save();
 				EE_Error::add_attention(
 					sprintf(
-						__( 'An error occurred while attempting to use the "%1$s" payment method, so it was deactivated.%2$sWas the "%1$s" Plugin recently deactivated?%2$sIt can be reactivated on the %3$sPlugins admin page%4$s||%2$sThe actual error was:%2$s%5$s', 'event_espresso' ),
+						__('An error occurred while attempting to use the "%1$s" payment method, so it was deactivated.%2$sWas the "%1$s" Plugin recently deactivated?%2$sIt can be reactivated on the %3$sPlugins admin page%4$s||%2$sThe actual error was:%2$s%5$s', 'event_espresso'),
 						$payment_method->name(),
 						'<br />',
-						'<a href="' . admin_url('plugins.php') . '">',
+						'<a href="'.admin_url('plugins.php').'">',
 						'</a>',
 						$e->getMessage()
 					),
@@ -341,16 +341,16 @@ 
 	 * @param string 	$scope @see EEM_Payment_Method::get_all_for_events
 	 * @return EE_Payment_Method[]
 	 */
-	public function get_all_for_transaction( $transaction, $scope ) {
+	public function get_all_for_transaction($transaction, $scope) {
 		//@todo take relations between events and payment methods into account, once that relation exists
-		if ( $transaction instanceof EE_Transaction ) {
+		if ($transaction instanceof EE_Transaction) {
 			//@todo take the relation between transaction and currencies into account
 		}
-		$currencies_for_events = array( EE_Config::instance()->currency->code );
+		$currencies_for_events = array(EE_Config::instance()->currency->code);
 		//give addons a chance to override what payment methods are chosen based on the transaction
 		return apply_filters(
 			'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
-			$this->get_all_active( $scope, array( array( 'Currency.CUR_code' => array( 'IN', $currencies_for_events ) ) ) ),
+			$this->get_all_active($scope, array(array('Currency.CUR_code' => array('IN', $currencies_for_events)))),
 			$transaction,
 			$scope
 		);
@@ -366,16 +366,16 @@ 
 	 * @param EE_Registration|int $registration_or_reg_id  Either the EE_Registration object or the id for the registration.
 	 * @return EE_Payment|null
 	 */
-	public function get_last_used_for_registration( $registration_or_reg_id ) {
-		$registration_id = EEM_Registration::instance()->ensure_is_ID( $registration_or_reg_id );
+	public function get_last_used_for_registration($registration_or_reg_id) {
+		$registration_id = EEM_Registration::instance()->ensure_is_ID($registration_or_reg_id);
 
 		$query_params = array(
 			0 => array(
 				'Payment.Registration.REG_ID' => $registration_id,
 			),
-			'order_by' => array( 'Payment.PAY_ID' => 'DESC' )
+			'order_by' => array('Payment.PAY_ID' => 'DESC')
 		);
-		return $this->get_one( $query_params );
+		return $this->get_one($query_params);
 	}
 
 }