yikesinc / yikes-inc-easy-mailchimp-extender

admin/class-yikes-inc-easy-mailchimp-extender-admin.php

Doc Comments -4 removed lines

@@ -1214,8 +1214,6 @@ 
 	 * the correct WordPress options API (old plugin stored options wierdly)
 	 *
 	 * @since    1.0.0
-	 * @param      string    $yikes_inc_easy_mailchimp_extender       The name of this plugin.
-	 * @param      string    $version    The version of this plugin.
 	 */
 	public function check_for_old_yks_mc_options() {
 		$old_plugin_options = get_option( 'ykseme_storage' );
@@ -1250,8 +1248,6 @@ 
 		 * the correct WordPress options API (old plugin stored options wierdly)
 		 *
 		 * @since    1.0.0
-		 * @param      string    $yikes_inc_easy_mailchimp_extender       The name of this plugin.
-		 * @param      string    $version    The version of this plugin.
 		 */
 		public function display_options_migrate_notice() {
 			

Indentation +83 added lines, -83 removed lines

@@ -492,10 +492,10 @@ 
 		}
 
 		/**
-		*	Dismiss the migrate options notice (incase the user wants to do things manually)
-		*
-		*	@since 6.0.0
-		**/
+		 *	Dismiss the migrate options notice (incase the user wants to do things manually)
+		 *
+		 *	@since 6.0.0
+		 **/
 		public function yikes_easy_mailchimp_dismiss_option_migrate() {
 			// delete the options and allow the user to manually updadte things
 
@@ -626,10 +626,10 @@ 
 		}
 
 		/**
-		* Localize Script
-		* Pass our imported list data, to the JS file
-		* to build the drop down list in the modal
-		*/
+		 * Localize Script
+		 * Pass our imported list data, to the JS file
+		 * to build the drop down list in the modal
+		 */
 		public function tinymce_yikes_easy_mc() {
 			// check capabilities
 			if( ! current_user_can( apply_filters( 'yikes-mailchimp-user-role-access' , 'manage_options' ) ) ) {
@@ -857,9 +857,9 @@ 
 	}
 
 	/**
-	*	Register our admin pages
-	*	used to display data back to the user
-	**/
+	 *	Register our admin pages
+	 *	used to display data back to the user
+	 **/
 	public function register_admin_pages() {
 
 		/* Top Level Menu 'Easy MailChimp' */
@@ -1013,82 +1013,82 @@ 
 	}
 
 	/**
-	* Generate YIKES Inc. Easy MailChimp Manage Forms Page
-	*
-	* @since    1.0.0
-	*/
+	 * Generate YIKES Inc. Easy MailChimp Manage Forms Page
+	 *
+	 * @since    1.0.0
+	 */
 	function generateManageFormsPage() {
 		require_once YIKES_MC_PATH . 'admin/partials/menu/manage-forms.php'; // include our manage forms page
 	}
 
 	/**
-	* Generate YIKES Inc. Easy MailChimp Manage Lists Page
-	*
-	* @since    1.0.0
-	*/
+	 * Generate YIKES Inc. Easy MailChimp Manage Lists Page
+	 *
+	 * @since    1.0.0
+	 */
 	function generateManageListsPage() {
 		require_once YIKES_MC_PATH . 'admin/partials/menu/manage-lists.php'; // include our lists page
 	}
 
 	/**
-	* Generate YIKES Inc. Easy MailChimp Account Details Page
-	*
-	* @since    1.0.0
-	*/
+	 * Generate YIKES Inc. Easy MailChimp Account Details Page
+	 *
+	 * @since    1.0.0
+	 */
 	function generateAccountDetailsPage() {
 		require_once YIKES_MC_PATH . 'admin/partials/menu/account-details.php'; // include our account details page
 	}
 
 	/**
-	* Generate YIKES Inc. Easy MailChimp Support Page
-	*
-	* @since    1.0.0
-	*/
+	 * Generate YIKES Inc. Easy MailChimp Support Page
+	 *
+	 * @since    1.0.0
+	 */
 	function generateSupportPage() {
 		require_once YIKES_MC_PATH . 'admin/partials/menu/support.php'; // include our options page
 	}
 
 	/**
-	* Generate YIKES Inc. Easy MailChimp Edit Form Page
-	*
-	* @since    1.0.0
-	*/
+	 * Generate YIKES Inc. Easy MailChimp Edit Form Page
+	 *
+	 * @since    1.0.0
+	 */
 	function generateEditFormPage() {
 		require_once YIKES_MC_PATH . 'admin/partials/edit-form.php'; // include our options page
 	}
 
 	/**
-	* Generate YIKES Inc. Easy MailChimp Welcome Page
-	*
-	* @since    1.0.0
-	*/
+	 * Generate YIKES Inc. Easy MailChimp Welcome Page
+	 *
+	 * @since    1.0.0
+	 */
 	function generateWelcomePage() {
 		require_once YIKES_MC_PATH . 'admin/partials/welcome-page/welcome.php'; // include our options page
 	}
 
 	/**
-	* Generate YIKES Inc. Easy MailChimp View List Page
-	*
-	* @since    1.0.0
-	*/
+	 * Generate YIKES Inc. Easy MailChimp View List Page
+	 *
+	 * @since    1.0.0
+	 */
 	function generateViewListPage() {
 		require_once YIKES_MC_PATH . 'admin/partials/view-list.php'; // include our options page
 	}
 
 	/**
-	* Generate YIKES Inc. Easy MailChimp View User Page
-	*
-	* @since    1.0.0
-	*/
+	 * Generate YIKES Inc. Easy MailChimp View User Page
+	 *
+	 * @since    1.0.0
+	 */
 	function generateViewUserPage() {
 		require_once YIKES_MC_PATH . 'admin/partials/view-user.php'; // include our options page
 	}
 
 	/**
-	*	Register our plugin settings, and display them on our settings page
-	*
-	* @since v.5.4
-	**/
+	 *	Register our plugin settings, and display them on our settings page
+	 *
+	 * @since v.5.4
+	 **/
 	function yikes_easy_mc_settings_init() {
 
 		/* Register General Settings Section */
@@ -1204,9 +1204,9 @@ 
 	}
 
 	/**
-	*	Options Sanitization & Validation
-	*	@since complete re-write
-	**/
+	 *	Options Sanitization & Validation
+	 *	@since complete re-write
+	 **/
 	function yikes_mc_validate_api_key( $input ) {
 		if( $input === '' ) {
 			update_option( 'yikes-mc-api-validation' , 'invalid_api_key' );
@@ -1248,20 +1248,20 @@ 
 	}
 
 	/**
-	* Generate YIKES Inc. Easy Forms for MailChimp Options Page
-	*
-	* @since    1.0.0
-	*/
+	 * Generate YIKES Inc. Easy Forms for MailChimp Options Page
+	 *
+	 * @since    1.0.0
+	 */
 	function generatePageOptions() {
 		require_once YIKES_MC_PATH . 'admin/partials/menu/options.php'; // include our options page
 	}
 
 	/**
-	*	Check if users API key is valid, if not
-	*	this function will apply a disabled attribute
-	*	to form fields. (input, dropdowns, buttons etc.)
-	* 	@since v5.5 re-write
-	**/
+	 *	Check if users API key is valid, if not
+	 *	this function will apply a disabled attribute
+	 *	to form fields. (input, dropdowns, buttons etc.)
+	 * 	@since v5.5 re-write
+	 **/
 	public function is_user_mc_api_valid_form( $echo=true ) {
 		if( $echo == true ) {
 			if( get_option( 'yikes-mc-api-validation' , 'invalid_api_key' ) == 'invalid_api_key' ) {
@@ -1301,7 +1301,7 @@ 
 	 * Migrate our old options , to the new options API
 	 * moving from 5.5 and beyond..
 	 * @since
-	*/
+	 */
 	public function migrate_old_yks_mc_options() {
 		// include our migrate options helper file
 		include_once YIKES_MC_PATH . 'admin/partials/upgrade-helpers/upgrade-migrate-options.php';
@@ -1310,7 +1310,7 @@ 
 	/**
 		Admin Notices
 		- Notifications displayed at the top of admin pages, back to the user
-	**/
+	 **/
 
 		/**
 		 * Check for existing plugin options
@@ -1369,12 +1369,12 @@ 
 		*	- http://stackoverflow.com/questions/6661530/php-multi-dimensional-array-search
 		*/
 		function findMCListID($id, $array) {
-		   foreach ($array as $key => $val) {
-			   if ($val['id'] === $id) {
-				   return $key;
-			   }
-		   }
-		   return null;
+			foreach ($array as $key => $val) {
+				if ($val['id'] === $id) {
+					return $key;
+				}
+			}
+			return null;
 		} // end
 
 		/* Ajax Migrate Options */
@@ -1727,9 +1727,9 @@ 
 			}
 
 			/**
-			*	Custom action hook for our extensions to hook into
-			*	@parameter	get_current_screen()	current screen information
-			*/
+			 *	Custom action hook for our extensions to hook into
+			 *	@parameter	get_current_screen()	current screen information
+			 */
 			do_action( 'yikes-mailchimp-admin-sidebar', get_current_screen() );
 
 		}
@@ -2773,12 +2773,12 @@ 
 		}
 
 		/**
-		*	Return an array of MailChimp lists associated with this account
-		*
-		*	Used when deleting the sites MailChimp cache stored
-		*	@since 6.0.2
-		*	@return 	$list_id_array - array of list id's to loop over
-		*/
+		 *	Return an array of MailChimp lists associated with this account
+		 *
+		 *	Used when deleting the sites MailChimp cache stored
+		 *	@since 6.0.2
+		 *	@return 	$list_id_array - array of list id's to loop over
+		 */
 		public function get_mailchimp_list_ids_on_account() {
 			$api_key = yikes_get_mc_api_key();
 			if( ! $api_key ) {
@@ -2888,19 +2888,19 @@ 
 		}
 
 		/**
-		*	Hook in and display our support page/knowledge base articles
-		*	on the support page
-		*	@since 6.0.3.8
-		*/
+		 *	Hook in and display our support page/knowledge base articles
+		 *	on the support page
+		 *	@since 6.0.3.8
+		 */
 		public function hook_and_display_kb_article_RSS() {
 			// include_once( YIKES_MC_PATH . 'admin/partials/helpers/knowledge-base-articles-RSS.php' );
 			include_once( YIKES_MC_PATH . 'admin/partials/helpers/knowledge-base-article-links.php' );
 		}
 
 		/**
-		*	Check the users version number, and display a notice to upgrade the databse if needed
-		*	@since 6.0.4
-		*/
+		 *	Check the users version number, and display a notice to upgrade the databse if needed
+		 *	@since 6.0.4
+		 */
 		public function check_yikes_mc_table_version() {
 			if( get_option( 'yikes_mc_database_version', '0.00' ) < '1.0' ) {
 				require_once YIKES_MC_PATH . 'includes/class-yikes-inc-easy-mailchimp-extender-activator.php';

public/classes/checkbox-integrations.php

Doc Comments +12 added lines

@@ -23,6 +23,10 @@ 
 		*	@since 6.0.0
 		*	@$integration_type - pass in the type of checkbox integration
 		*/
+
+		/**
+		 * @param string $integration_type
+		 */
 		public function is_user_already_subscribed( $integration_type ) {
 			// first check if the user is logged in
 			if( is_user_logged_in() ) {
@@ -69,6 +73,10 @@ 
 		*	@$email - users email address entered into the form
 		*	@$integration_type - pass in the type of checkbox integration
 		*/
+
+		/**
+		 * @param string $integration_type
+		 */
 		public function is_new_registration_already_subscribed( $email , $integration_type ) {
 			// first check if the user is logged in
 			$checkbox_options = get_option( 'optin-checkbox-init' , '' );
@@ -233,6 +241,10 @@ 
 		*	before continuing
 		*	@since 6.0.0
 		*/
+
+		/**
+		 * @param string $type
+		 */
 		public function was_checkbox_checked( $type ) {
 			// was sign-up checkbox checked - return the value
 			return ( isset( $_POST[ 'yikes_mailchimp_checkbox_'.$type ] ) && $_POST[ 'yikes_mailchimp_checkbox_'.$type ] == 1 );

Indentation +14 added lines, -14 removed lines

@@ -102,10 +102,10 @@ 
 		}
 
 		/**
-		* 	Get the checkbox for the given integration and render it on the front end
-		* 	@return string
-		*	@since 6.0.0
-		*/
+		 * 	Get the checkbox for the given integration and render it on the front end
+		 * 	@return string
+		 *	@since 6.0.0
+		 */
 		public function yikes_get_checkbox() {
 			// enqueue our checkbox styles whenever the checkbox is displayed
 			wp_enqueue_style( 'yikes-easy-mailchimp-checkbox-integration-styles', plugin_dir_url( __FILE__ ) . '../css/yikes-inc-easy-mailchimp-checkbox-integration.min.css' );
@@ -135,7 +135,7 @@ 
 		 *	a new integration type is submitted
 		 *
 		 *	@since 6.0.0
-		**/
+		 **/
 		public function subscribe_user_integration( $email, $type, $merge_vars ) {
 			// get checkbox data
 			$checkbox_options = get_option( 'optin-checkbox-init' , '' );
@@ -198,9 +198,9 @@ 
 		}
 
 		/**
-		* Build merge varaibles array
-		*	@since 6.0.0
-		*/
+		 * Build merge varaibles array
+		 *	@since 6.0.0
+		 */
 		public function user_merge_vars( WP_User $user ) {
 			// start with user_login as name, since that's always known
 			$merge_vars = array(
@@ -240,10 +240,10 @@ 
 
 
 		/**
-		*	Alter the registraton complete message
-		*	if the registration form checkbox integration is toggled on
-		* 	@since 6.0.0
-		**/
+		 *	Alter the registraton complete message
+		 *	if the registration form checkbox integration is toggled on
+		 * 	@since 6.0.0
+		 **/
 		public function yikes_reg_complete_msg( $errors, $redirect_to ) {
 			if( isset( $errors->errors['registered'] ) ) {
 				$email_error = get_option( 'yikes_register_subscription_error' , '' );
@@ -262,8 +262,8 @@ 
 					unset( $tmp );
 					delete_option( 'yikes_register_subscription_error' );
 				}
-		   }
-		   return $errors;
+			}
+			return $errors;
 		}
 
 	}

public/classes/checkbox-integrations/class.bbpress_forms-checkbox.php

Doc Comments +1 added lines, -1 removed lines

@@ -41,7 +41,7 @@
 		 * @param array $anonymous_data
 		 * @param int $user_id
 		 * @param string $trigger
-		 * @return boolean
+		 * @return boolean|null
 		 */
 		public function subscribe_from_bbpress( $anonymous_data, $user_id, $trigger ) {
 			$user_data = get_userdata( $user_id );

Indentation +2 added lines, -2 removed lines

@@ -27,8 +27,8 @@
 		
 		
 		/**
-		* Outputs a checkbox
-		*/
+		 * Outputs a checkbox
+		 */
 		public function output_checkbox() {
 			if( $this->is_user_already_subscribed( $this->type ) == '1' ) {
 				return;

public/classes/checkbox-integrations/class.buddypress_form-checkbox.php

Doc Comments -1 removed lines

@@ -40,7 +40,6 @@
 		 * @param string $user_login
 		 * @param string $user_password
 		 * @param string $user_email
-		 * @param array $usermeta
 		 */
 		public function subscribe_from_buddypress_form( $user_id, $user_login, $user_password, $user_email ) {
 			if ( $this->was_checkbox_checked( $this->type ) === false ) {

Indentation +2 added lines, -2 removed lines

@@ -18,8 +18,8 @@
 		}
 		
 		/**
-		* Outputs a checkbox, if user is not already subscribed
-		*/
+		 * Outputs a checkbox, if user is not already subscribed
+		 */
 		public function output_checkbox() {
 			if( $this->is_user_already_subscribed( $this->type ) == '1' ) {
 				return;

public/classes/checkbox-integrations/class.easy_digital_downloads_checkout_form-checkbox.php

Doc Comments +1 added lines, -2 removed lines

@@ -41,7 +41,6 @@ 
 		
 		
 		/**
-		 * @param array $meta
 		 *
 		 * @return array
 		 */
@@ -57,7 +56,7 @@ 
 		/**
 		 * @param int $payment_id The ID of the payment
 		 *
-		 * @return bool|string
+		 * @return false|null
 		 */
 		public function subscribe_from_edd_purchase( $payment_id ) {
 			$meta = get_post_meta( $payment_id , '_yikes_easy_mc_optin' , true );

Indentation +2 added lines, -2 removed lines

@@ -27,8 +27,8 @@
 		
 		
 		/**
-		* Outputs a checkbox
-		*/
+		 * Outputs a checkbox
+		 */
 		public function output_checkbox() {
 			if( $this->is_user_already_subscribed( $this->type ) == '1' ) {
 				return;

public/classes/checkbox-integrations/class.registration_form-checkbox.php

Doc Comments +1 added lines, -1 removed lines

@@ -35,7 +35,7 @@
 	 *
 	 * @param int $user_id
 	 *
-	 * @return bool|string
+	 * @return false|null
 	*/
 	public function subscribe_from_registration( $user_id ) {
 		// was sign-up checkbox checked?

Indentation +3 added lines, -3 removed lines

@@ -24,8 +24,8 @@ 
 	}
 	
 	/**
-	* Outputs a checkbox
-	*/
+	 * Outputs a checkbox
+	 */
 	public function output_checkbox() {
 		echo $this->yikes_get_checkbox();
 	}
@@ -36,7 +36,7 @@ 
 	 * @param int $user_id
 	 *
 	 * @return bool|string
-	*/
+	 */
 	public function subscribe_from_registration( $user_id ) {
 		// was sign-up checkbox checked?
 		if ( $this->was_checkbox_checked( $this->type ) === false ) {

admin/partials/ajax/class.ajax.php

Indentation +9 added lines, -9 removed lines

@@ -154,17 +154,17 @@
 		public function findMCListIndex( $id, $array, $tag ) {
 			if( $tag == 'tag' ) {
 				foreach( $array as $key => $val ) {
-					   if ( $val['tag'] === $id ) {
-						   return $key;
-					   }
-				   }
-			   return null;
+						if ( $val['tag'] === $id ) {
+							return $key;
+						}
+					}
+				return null;
 			} else {
 				foreach ( $array as $key => $val ) {
-				   if ( $val['id'] == $id ) {
-					   return $key;
-				   }
-			   }
+					if ( $val['id'] == $id ) {
+						return $key;
+					}
+				}
 			return null;
 			}
 	  	} // end

admin/partials/helpers/init.php

Indentation +23 added lines, -23 removed lines

@@ -7,13 +7,13 @@ 
 	class Yikes_Inc_Easy_Mailchimp_Extender_Helper {
 	
 			/**
-			*	Helper functions to help out with extensions (still fleshing out)
-			*	@since 6.0
-			*	@ Parameters (array of data)
-			*		-	Section ID - id of the section, should be a slug style text ie: 'custom-section'
-			*		-	Link Text - Visible text for this link ie: 'Custom Section'
-			*		-	Dashicon - class of the icon you would like to use for this link
-			**/
+			 *	Helper functions to help out with extensions (still fleshing out)
+			 *	@since 6.0
+			 *	@ Parameters (array of data)
+			 *		-	Section ID - id of the section, should be a slug style text ie: 'custom-section'
+			 *		-	Link Text - Visible text for this link ie: 'Custom Section'
+			 *		-	Dashicon - class of the icon you would like to use for this link
+			 **/
 			public static function add_edit_form_section_link( $link_array=array() ) {
 				if( !empty( $link_array ) ) {
 					$link_data = wp_parse_args( array() , $link_array );
@@ -36,17 +36,17 @@ 
 			}
 			
 			/**
-			*	Helper functions to help out with extensions (still fleshing out)
-			*	@since 6.0
-			*	@ Parameters:
-			*		-	Section ID - id of the section, should be a slug style text ie: 'custom-section'
-			*		-	Class - class file to call function from?
-			*		-	Main Callback - call back for main section
-			*		-	Main Section Title - main section title
-			*		-	Sidebar Callback - callback for the sidebar section
-			*		-	Sidebar Title - title of the sidebar section
-			*		-	Class - class to reference funtions out of (optiona, if left blank functions should be defined in functions.php (or outside of a class))
-			**/
+			 *	Helper functions to help out with extensions (still fleshing out)
+			 *	@since 6.0
+			 *	@ Parameters:
+			 *		-	Section ID - id of the section, should be a slug style text ie: 'custom-section'
+			 *		-	Class - class file to call function from?
+			 *		-	Main Callback - call back for main section
+			 *		-	Main Section Title - main section title
+			 *		-	Sidebar Callback - callback for the sidebar section
+			 *		-	Sidebar Title - title of the sidebar section
+			 *		-	Class - class to reference funtions out of (optiona, if left blank functions should be defined in functions.php (or outside of a class))
+			 **/
 			public static function add_edit_form_section( $section_array=array() ) {
 				if( !empty( $section_array ) ) {
 					$section_data = wp_parse_args( array() , $section_array );
@@ -59,11 +59,11 @@ 
 			}
 			
 			/**
-			*	Check if the custom section is single or two columns (with sidebar)
-			*	@since 6.0
-			*	@Parameters:
-			*		-	Section Data - the array of data associated with the custom field you've set up
-			*/
+			 *	Check if the custom section is single or two columns (with sidebar)
+			 *	@since 6.0
+			 *	@Parameters:
+			 *		-	Section Data - the array of data associated with the custom field you've set up
+			 */
 			public static function is_custom_section_two_column( $custom_section_data ) {
 				// print_r( $custom_section_data );
 				$value = ( isset( $custom_section_data['sidebar_title'] ) && isset( $custom_section_data['sidebar_fields'] ) && !empty( $custom_section_data['sidebar_fields'] ) ) ?  true : false;

admin/partials/view-list.php

Indentation +6 added lines, -6 removed lines

@@ -356,9 +356,9 @@ 
 									?></ul><?php
 								}
 								/**
-								*	Custom action hook for our add-ons to hook into
-								*	@since 6.0.3.8
-								*/
+								 *	Custom action hook for our add-ons to hook into
+								 *	@since 6.0.3.8
+								 */
 								do_action( 'yikes-mailchimp-list-form-fields-metabox' );
 							?>
 							
@@ -385,9 +385,9 @@ 
 									<?php
 								}
 								/**
-								*	Custom action hook for our add-ons to hook into
-								*	@since 6.0.3.8
-								*/
+								 *	Custom action hook for our add-ons to hook into
+								 *	@since 6.0.3.8
+								 */
 								do_action( 'yikes-mailchimp-list-interest-groups-metabox' );
 							?>