eventespresso / event-espresso-core

core/libraries/payment_methods/EE_Payment_Method_Manager.lib.php

Spacing +73 added lines, -73 removed lines

@@ -35,7 +35,7 @@ 
 	 */
 	public static function instance() {
 		// check if class object is instantiated, and instantiated properly
-		if ( ! self::$_instance instanceof EE_Payment_Method_Manager ) {
+		if ( ! self::$_instance instanceof EE_Payment_Method_Manager) {
 			self::$_instance = new self();
 		}
 		EE_Registry::instance()->load_lib('PMT_Base');
@@ -46,7 +46,7 @@ 
 	 * Resets the instance and returns a new one
 	 * @return EE_Payment_Method_Manager
 	 */
-	public static function reset(){
+	public static function reset() {
 		self::$_instance = NULL;
 		return self::instance();
 	}
@@ -57,12 +57,12 @@ 
 	 * or just re-use the PMTs we found last time we checked during this request (if
 	 * we have not yet checked during this request, then we need to check anyways)
 	 */
-	public function maybe_register_payment_methods( $force_recheck = FALSE ){
-		if( ! $this->_payment_method_types || $force_recheck ){
+	public function maybe_register_payment_methods($force_recheck = FALSE) {
+		if ( ! $this->_payment_method_types || $force_recheck) {
 			$this->_register_payment_methods();
 			//if in admin lets ensure caps are set.
-			if ( is_admin() ) {
-				add_filter( 'FHEE__EE_Capabilities__init_caps_map__caps', array( $this, 'add_payment_method_caps' ) );
+			if (is_admin()) {
+				add_filter('FHEE__EE_Capabilities__init_caps_map__caps', array($this, 'add_payment_method_caps'));
 				EE_Registry::instance()->CAP->init_caps();
 			}
 		}
@@ -75,19 +75,19 @@ 
 	 */
 	protected function _register_payment_methods() {
 		// grab list of installed modules
-		$pm_to_register = glob( EE_PAYMENT_METHODS . '*', GLOB_ONLYDIR );
+		$pm_to_register = glob(EE_PAYMENT_METHODS.'*', GLOB_ONLYDIR);
 		// filter list of modules to register
-		$pm_to_register = apply_filters( 'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register', $pm_to_register );
+		$pm_to_register = apply_filters('FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register', $pm_to_register);
 
 		// loop through folders
-		foreach ( $pm_to_register as $pm_path ) {
-				$this->register_payment_method( $pm_path );
+		foreach ($pm_to_register as $pm_path) {
+				$this->register_payment_method($pm_path);
 		}
-		do_action( 'FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods' );
+		do_action('FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods');
 		// filter list of installed modules
 		//keep them organized alphabetically by the payment method type's name
-		ksort( $this->_payment_method_types );
-		return apply_filters( 'FHEE__EE_Payment_Method_Manager__register_payment_methods__installed_payment_methods', $this->_payment_method_types );
+		ksort($this->_payment_method_types);
+		return apply_filters('FHEE__EE_Payment_Method_Manager__register_payment_methods__installed_payment_methods', $this->_payment_method_types);
 	}
 
 
@@ -99,35 +99,35 @@ 
 	 * @param string $payment_method_path - full path up to and including payment method folder
 	 * @return boolean
 	 */
-	public function register_payment_method( $payment_method_path = '' ) {
-		do_action( 'AHEE__EE_Payment_Method_Manager__register_payment_method__begin',$payment_method_path );
+	public function register_payment_method($payment_method_path = '') {
+		do_action('AHEE__EE_Payment_Method_Manager__register_payment_method__begin', $payment_method_path);
 		$module_ext = '.pm.php';
 		// make all separators match
-		$payment_method_path = rtrim( str_replace( '/\\', DS, $payment_method_path ), DS );
+		$payment_method_path = rtrim(str_replace('/\\', DS, $payment_method_path), DS);
 		// grab and sanitize module name
-		$module_dir = basename( $payment_method_path );
+		$module_dir = basename($payment_method_path);
 		// create classname from module directory name
-		$module = str_replace( ' ', '_', str_replace( '_', ' ', $module_dir ));
+		$module = str_replace(' ', '_', str_replace('_', ' ', $module_dir));
 		// add class prefix
-		$module_class = 'EE_PMT_' . $module;
+		$module_class = 'EE_PMT_'.$module;
 		// does the module exist ?
-		if ( ! is_readable( $payment_method_path . DS . $module_class . $module_ext )) {
-			$msg = sprintf( __( 'The requested %s payment method file could not be found or is not readable due to file permissions.', 'event_espresso' ), $module );
-			EE_Error::add_error( $msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__ );
+		if ( ! is_readable($payment_method_path.DS.$module_class.$module_ext)) {
+			$msg = sprintf(__('The requested %s payment method file could not be found or is not readable due to file permissions.', 'event_espresso'), $module);
+			EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
 			return FALSE;
 		}
-		if ( WP_DEBUG === TRUE ) { EEH_Debug_Tools::instance()->start_timer(); }
+		if (WP_DEBUG === TRUE) { EEH_Debug_Tools::instance()->start_timer(); }
 		// load the module class file
-		require_once( $payment_method_path . DS . $module_class . $module_ext );
-		if ( WP_DEBUG === TRUE ) { EEH_Debug_Tools::instance()->stop_timer("Requiring payment method $module_class"); }
+		require_once($payment_method_path.DS.$module_class.$module_ext);
+		if (WP_DEBUG === TRUE) { EEH_Debug_Tools::instance()->stop_timer("Requiring payment method $module_class"); }
 		// verify that class exists
-		if ( ! class_exists( $module_class )) {
-			$msg = sprintf( __( 'The requested %s module class does not exist.', 'event_espresso' ), $module_class );
-			EE_Error::add_error( $msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__ );
+		if ( ! class_exists($module_class)) {
+			$msg = sprintf(__('The requested %s module class does not exist.', 'event_espresso'), $module_class);
+			EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
 			return FALSE;
 		}
 		// add to array of registered modules
-		$this->_payment_method_types[ $module ] = $payment_method_path . DS . $module_class . $module_ext;
+		$this->_payment_method_types[$module] = $payment_method_path.DS.$module_class.$module_ext;
 		return TRUE;
 	}
 	/**
@@ -136,15 +136,15 @@ 
 	 * @param boolean $force_recheck whether to force re-checking for new payment method types
 	 * @return boolean
 	 */
-	public function payment_method_type_exists($payment_method_name, $force_recheck = FALSE){
-		if ( ! is_array( $this->_payment_method_types ) || ! isset( $this->_payment_method_types[$payment_method_name] )
-				|| $force_recheck ) {
+	public function payment_method_type_exists($payment_method_name, $force_recheck = FALSE) {
+		if ( ! is_array($this->_payment_method_types) || ! isset($this->_payment_method_types[$payment_method_name])
+				|| $force_recheck) {
 			$this->maybe_register_payment_methods($force_recheck);
 		}
-		if(isset($this->_payment_method_types[$payment_method_name])){
+		if (isset($this->_payment_method_types[$payment_method_name])) {
 			require_once($this->_payment_method_types[$payment_method_name]);
 			return true;
-		}else{
+		} else {
 			return false;
 		}
 	}
@@ -155,16 +155,16 @@ 
 	 * @param boolean $force_recheck whether to force re-checking for new payment method types
 	 * @return array
 	 */
-	public function payment_method_type_names($with_prefixes = FALSE, $force_recheck = FALSE ){
+	public function payment_method_type_names($with_prefixes = FALSE, $force_recheck = FALSE) {
 		$this->maybe_register_payment_methods($force_recheck);
-		if($with_prefixes){
+		if ($with_prefixes) {
 			$classnames = array_keys($this->_payment_method_types);
 			$payment_methods = array();
-			foreach($classnames as $classname){
+			foreach ($classnames as $classname) {
 				$payment_methods[] = $this->payment_method_class_from_type($classname);
 			}
 			return $payment_methods;
-		}else{
+		} else {
 			return array_keys($this->_payment_method_types);
 		}
 	}
@@ -174,10 +174,10 @@ 
 	 * @param boolean $force_recheck whether to force re-checking for new payment method types
 	 * @return EE_PMT_Base[]
 	 */
-	public function payment_method_types( $force_recheck = FALSE ){
+	public function payment_method_types($force_recheck = FALSE) {
 		$this->maybe_register_payment_methods($force_recheck);
 		$pmt_objs = array();
-		foreach($this->payment_method_type_names(true) as $classname){
+		foreach ($this->payment_method_type_names(true) as $classname) {
 			$pmt_objs[] = new $classname;
 		}
 		return $pmt_objs;
@@ -189,8 +189,8 @@ 
 	 * @param string $classname
 	 * @return string
 	 */
-	public function payment_method_type_sans_class_prefix($classname){
-		$pmt_name = str_replace("EE_PMT_","",$classname);
+	public function payment_method_type_sans_class_prefix($classname) {
+		$pmt_name = str_replace("EE_PMT_", "", $classname);
 		return $pmt_name;
 	}
 
@@ -199,7 +199,7 @@ 
 	 * @param string $type
 	 * @return string
 	 */
-	public function payment_method_class_from_type($type){
+	public function payment_method_class_from_type($type) {
 		$this->maybe_register_payment_methods();
 		return "EE_PMT_".$type;
 	}
@@ -213,39 +213,39 @@ 
 	 * @return \EE_Payment_Method
 	 * @throws \EE_Error
 	 */
-	public function activate_a_payment_method_of_type( $payment_method_type ){
+	public function activate_a_payment_method_of_type($payment_method_type) {
 		$payment_method = EEM_Payment_Method::instance()->get_one_of_type($payment_method_type);
-		if( ! $payment_method instanceof EE_Payment_Method ){
+		if ( ! $payment_method instanceof EE_Payment_Method) {
 			$pm_type_class = $this->payment_method_class_from_type($payment_method_type);
-			if(class_exists($pm_type_class)){
+			if (class_exists($pm_type_class)) {
 				/** @var $pm_type_obj EE_PMT_Base */
 				$pm_type_obj = new $pm_type_class;
 				$payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_type_obj->system_name());
-				if( ! $payment_method){
-					$payment_method = $this->create_payment_method_of_type( $pm_type_obj );
+				if ( ! $payment_method) {
+					$payment_method = $this->create_payment_method_of_type($pm_type_obj);
 				}
-				$payment_method->set_type( $payment_method_type );
-				$this->initialize_payment_method( $payment_method );
+				$payment_method->set_type($payment_method_type);
+				$this->initialize_payment_method($payment_method);
 			} else {
 				throw new EE_Error(
 					sprintf(
-						__( 'There is no payment method of type %1$s, so it could not be activated', 'event_espresso'),
+						__('There is no payment method of type %1$s, so it could not be activated', 'event_espresso'),
 						$pm_type_class )
 				);
 			}
 		}
 		$payment_method->set_active();
 		$payment_method->save();
-		$this->set_usable_currencies_on_payment_method( $payment_method );
-		if( $payment_method->type() == 'Invoice' ){
+		$this->set_usable_currencies_on_payment_method($payment_method);
+		if ($payment_method->type() == 'Invoice') {
 			/** @type EE_Messages $messages_controller */
-			$messages_controller = EE_Registry::instance()->load_lib( 'messages' );
-			$messages_controller->ensure_message_type_is_active( 'invoice', 'html' );
-			$messages_controller->ensure_messenger_is_active( 'pdf' );
+			$messages_controller = EE_Registry::instance()->load_lib('messages');
+			$messages_controller->ensure_message_type_is_active('invoice', 'html');
+			$messages_controller->ensure_messenger_is_active('pdf');
 			EE_Error::add_attention(
 				sprintf(
-					__( 'Note, when the invoice payment method is activated, the invoice message type, html messenger, and pdf messenger are activated as well for the %1$smessages system%2$s.', 'event_espresso' ),
-					'<a href="' . admin_url( 'admin.php?page=espresso_messages') . '">',
+					__('Note, when the invoice payment method is activated, the invoice message type, html messenger, and pdf messenger are activated as well for the %1$smessages system%2$s.', 'event_espresso'),
+					'<a href="'.admin_url('admin.php?page=espresso_messages').'">',
 					'</a>'
 				)
 			);
@@ -259,17 +259,17 @@ 
 	 * @param EE_PMT_Base $pm_type_obj
 	 * @return EE_Payment_Method
 	 */
-	public function create_payment_method_of_type( $pm_type_obj ) {
+	public function create_payment_method_of_type($pm_type_obj) {
 		global $current_user;
 		$payment_method = EE_Payment_Method::new_instance(
 			array(
 				'PMD_type' 		 => $pm_type_obj->system_name(),
 				'PMD_name' 		 => $pm_type_obj->pretty_name(),
 				'PMD_admin_name' => $pm_type_obj->pretty_name(),
-				'PMD_slug' 		 => $pm_type_obj->system_name(),//automatically converted to slug
+				'PMD_slug' 		 => $pm_type_obj->system_name(), //automatically converted to slug
 				'PMD_wp_user' 	 => $current_user->ID,
 				'PMD_order' 	 => EEM_Payment_Method::instance()->count(
-					array( array( 'PMD_type' => array( '!=', 'Admin_Only' )))
+					array(array('PMD_type' => array('!=', 'Admin_Only')))
 				) * 10,
 			)
 		);
@@ -281,16 +281,16 @@ 
 	 * @param EE_Payment_Method $payment_method
 	 * @return EE_Payment_Method
 	 */
-	public function initialize_payment_method( $payment_method ) {
+	public function initialize_payment_method($payment_method) {
 		$pm_type_obj = $payment_method->type_obj();
-		$payment_method->set_description( $pm_type_obj->default_description() );
-		if( ! $payment_method->button_url() ){
-			$payment_method->set_button_url( $pm_type_obj->default_button_url() );
+		$payment_method->set_description($pm_type_obj->default_description());
+		if ( ! $payment_method->button_url()) {
+			$payment_method->set_button_url($pm_type_obj->default_button_url());
 		}
 		//now add setup its default extra meta properties
 		$extra_metas = $pm_type_obj->settings_form()->extra_meta_inputs();
-		foreach( $extra_metas as $meta_name => $input ){
-			$payment_method->update_extra_meta($meta_name, $input->raw_value() );
+		foreach ($extra_metas as $meta_name => $input) {
+			$payment_method->update_extra_meta($meta_name, $input->raw_value());
 		}
 		return $payment_method;
 	}
@@ -300,8 +300,8 @@ 
 	 * @param EE_Payment_Method $payment_method
 	 * @return EE_Payment_Method
 	 */
-	public function set_usable_currencies_on_payment_method( $payment_method ) {
-		foreach($payment_method->get_all_usable_currencies() as $currency_obj){
+	public function set_usable_currencies_on_payment_method($payment_method) {
+		foreach ($payment_method->get_all_usable_currencies() as $currency_obj) {
 			$payment_method->_add_relation_to($currency_obj, 'Currency');
 		}
 		return $payment_method;
@@ -319,8 +319,8 @@ 
 	 *
 	 * @return int count of rows updated.
 	 */
-	public function deactivate_payment_method( $payment_method_slug ) {
-		$count_updated = EEM_Payment_Method::instance()->update(array('PMD_scope'=>array()),array(array('PMD_slug'=>$payment_method_slug)));
+	public function deactivate_payment_method($payment_method_slug) {
+		$count_updated = EEM_Payment_Method::instance()->update(array('PMD_scope'=>array()), array(array('PMD_slug'=>$payment_method_slug)));
 		return $count_updated;
 	}
 
@@ -333,7 +333,7 @@ 
 	 * @param array $caps capabilities being filtered
 	 * @return array
 	 */
-	public function add_payment_method_caps( $caps ) {
+	public function add_payment_method_caps($caps) {
 		/* add dynamic caps from payment methods
 		 * at the time of writing, october 20 2014, these are the caps added:
 		 * ee_payment_method_admin_only
@@ -348,7 +348,7 @@ 
 		 * their related capability automatically added too, so long as they are
 		 * registered properly using EE_Register_Payment_Method::register()
 		 */
-		foreach( $this->payment_method_types() as $payment_method_type_obj ){
+		foreach ($this->payment_method_types() as $payment_method_type_obj) {
 			$caps['administrator'][] = $payment_method_type_obj->cap_name();
 		}
 		return $caps;