Merge pull request #14 from kimcoleman/prep-for-release

Prep for release

classes/class-pmprogroupacct-group-member.php

@@ -3,13 +3,13 @@
 /**
  * The PMPro Group Account Member object.
  *
- * @since TBD
+ * @since 1.0
  */
 class PMProGroupAcct_Group_Member {
 	/**
 	 * The ID of the group member entry.
 	 *
-	 * @since TBD
+	 * @since 1.0
 	 *
 	 * @var int
 	 */
@@ -18,7 +18,7 @@ class PMProGroupAcct_Group_Member {
 	/**
 	 * The user ID of the group member.
 	 *
-	 * @since TBD
+	 * @since 1.0
 	 *
 	 * @var int
 	 */
@@ -27,7 +27,7 @@ class PMProGroupAcct_Group_Member {
 	/**
 	 * The level ID that the group member claimed using this group.
 	 *
-	 * @since TBD
+	 * @since 1.0
 	 *
 	 * @var int
 	 */
@@ -36,7 +36,7 @@ class PMProGroupAcct_Group_Member {
 	/**
 	 * The group ID that the group member is associated with.
 	 *
-	 * @since TBD
+	 * @since 1.0
 	 *
 	 * @var int
 	 */
@@ -46,7 +46,7 @@ class PMProGroupAcct_Group_Member {
 	 * The status of the group member.
 	 * 'active' if they are still using the claimed level, 'inactive' if they are not.
 	 *
-	 * @since TBD
+	 * @since 1.0
 	 *
 	 * @var string
 	 */
@@ -55,7 +55,7 @@ class PMProGroupAcct_Group_Member {
 	/**
 	 * Get a group member object by ID.
 	 *
-	 * @since TBD
+	 * @since 1.0
 	 *
 	 * @param int $member_id The group member ID to populate.
 	 */
@@ -83,7 +83,7 @@ public function __construct( $member_id ) {
 	/**
 	 * Get the list of members based on passed query arguments.
 	 *
-	 * @since TBD
+	 * @since 1.0
 	 *
 	 * @param array $args The query arguments to use to retrieve the members.
 	 * @return PMProGroupAcct_Member[]|int The list of members or the count of members if $args['return_count'] is `true`.
@@ -175,7 +175,7 @@ public static function get_group_members( $args = array() ) {
 	/**
 	 * Create a new group member.
 	 *
-	 * @since TBD
+	 * @since 1.0
 	 *
 	 * @param int $group_child_user_id The user ID of the group member.
 	 * @param int $group_child_level_id The level ID that the group member claimed using this group.
@@ -222,7 +222,7 @@ public static function create( $group_child_user_id, $group_child_level_id, $gro
 	/**
 	 * Magic getter to retrieve protected properties.
 	 *
-	 * @since TBD
+	 * @since 1.0
 	 *
 	 * @param string $name The name of the property to retrieve.
 	 * @return mixed The value of the property.
@@ -236,7 +236,7 @@ public function __get( $name ) {
 	/**
 	 * Magic isset to check protected properties.
 	 *
-	 * @since TBD
+	 * @since 1.0
 	 *
 	 * @param string $name The name of the property to check.
 	 * @return bool Whether the property is set.
@@ -251,7 +251,7 @@ public function __isset( $name ) {
 	/**
 	 * Update the status of the group member.
 	 *
-	 * @since TBD
+	 * @since 1.0
 	 *
 	 * @param string $group_child_status The new status of the group member. 'active' or 'inactive'.
 	 */

classes/class-pmprogroupacct-group.php

@@ -3,13 +3,13 @@
 /**
  * The PMPro Group Account Group object.
  *
- * @since TBD
+ * @since 1.0
  */
 class PMProGroupAcct_Group {
 	/**
 	 * The ID of the group entry.
 	 *
-	 * @since TBD
+	 * @since 1.0
 	 *
 	 * @var int
 	 */
@@ -18,7 +18,7 @@ class PMProGroupAcct_Group {
 	/**
 	 * The user ID of the group parent.
 	 *
-	 * @since TBD
+	 * @since 1.0
 	 *
 	 * @var int
 	 */
@@ -27,7 +27,7 @@ class PMProGroupAcct_Group {
 	/**
 	 * The parent user's level ID that this group is associated with.
 	 *
-	 * @since TBD
+	 * @since 1.0
 	 *
 	 * @var int
 	 */
@@ -36,7 +36,7 @@ class PMProGroupAcct_Group {
 	/**
 	 * The total number of seats in this group.
 	 *
-	 * @since TBD
+	 * @since 1.0
 	 *
 	 * @var int
 	 */
@@ -45,7 +45,7 @@ class PMProGroupAcct_Group {
 	/**
 	 * The checkout code to join this group.
 	 *
-	 * @since TBD
+	 * @since 1.0
 	 *
 	 * @var string
 	 */
@@ -54,7 +54,7 @@ class PMProGroupAcct_Group {
 	/**
 	 * Get a group object by ID.
 	 *
-	 * @since TBD
+	 * @since 1.0
 	 *
 	 * @param int $group The group ID to populate.
 	 */
@@ -82,7 +82,7 @@ public function __construct( $group_id ) {
 	/**
 	 * Get the list of groups based on query arguments.
 	 *
-	 * @since TBD
+	 * @since 1.0
 	 *
 	 * @param array $args The query arguments to use to retrieve groups.
 	 *
@@ -160,7 +160,7 @@ public static function get_groups( $args = array() ) {
 	/**
 	 * Get a group object by parent user ID and parent level ID.
 	 *
-	 * @since TBD
+	 * @since 1.0
 	 *
 	 * @param int $group_parent_user_id The user ID of the parent user.
 	 * @param int $group_parent_level_id The level ID of the parent user.
@@ -183,7 +183,7 @@ public static function get_group_by_parent_user_id_and_parent_level_id( $group_p
 	/**
 	 * Get a group object by checkout code.
 	 *
-	 * @since TBD
+	 * @since 1.0
 	 *
 	 * @param string $group_checkout_code The checkout code to search for.
 	 * @return PMProGroupAcct_Group|null The group object or null if the group could not be found.
@@ -204,7 +204,7 @@ public static function get_group_by_checkout_code( $group_checkout_code ) {
 	/**
 	 * Create a new group.
 	 *
-	 * @since TBD
+	 * @since 1.0
 	 *
 	 * @param int $group_parent_user_id The user ID of the parent user.
 	 * @param int $group_parent_level_id The level ID of the parent user.
@@ -250,7 +250,7 @@ public static function create( $group_parent_user_id, $group_parent_level_id, $g
 	/**
 	 * Magic getter to retrieve protected properties.
 	 *
-	 * @since TBD
+	 * @since 1.0
 	 *
 	 * @param string $name The name of the property to retrieve.
 	 * @return mixed The value of the property.
@@ -264,7 +264,7 @@ public function __get( $name ) {
 	/**
 	 * Magic isset to check protected properties.
 	 *
-	 * @since TBD
+	 * @since 1.0
 	 *
 	 * @param string $name The name of the property to check.
 	 * @return bool Whether the property is set.
@@ -279,7 +279,7 @@ public function __isset( $name ) {
 	/**
 	 * Regenerate the checkout code for this group.
 	 *
-	 * @since TBD
+	 * @since 1.0
 	 */
 	public function regenerate_group_checkout_code() {
 		global $wpdb;
@@ -304,7 +304,7 @@ public function regenerate_group_checkout_code() {
 	/**
 	 * Update the number of seats in this group.
 	 *
-	 * @since TBD
+	 * @since 1.0
 	 *
 	 * @param int $group_total_seats The new number of seats in the group.
 	 */
@@ -340,7 +340,7 @@ public function update_group_total_seats( $group_total_seats ) {
 	 * Specifically checks whether the parent user still has the level that the group is associated with
 	 * and whether the group has any seats available.
 	 *
-	 * @since TBD
+	 * @since 1.0
 	 *
 	 * @return bool Whether the group is accepting signups.
 	 */
@@ -361,7 +361,7 @@ public function is_accepting_signups() {
 	/**
 	 * Get the active members in this group.
 	 *
-	 * @since TBD
+	 * @since 1.0
 	 *
 	 * @param bool return_count Whether to return the count of members instead of the list of members.
 	 * @return PMProGroupAcct_Group_Member[]|int The list of members or the count of members.
@@ -378,7 +378,7 @@ public function get_active_members( $return_count = false ) {
 	/**
 	 * Generate a checkout code.
 	 *
-	 * @since TBD
+	 * @since 1.0
 	 *
 	 * @return string The checkout code.
 	 */

includes/admin.php

@@ -6,7 +6,7 @@
 /**
  * Runs only when the plugin is activated.
  *
- * @since TBD
+ * @since 1.0
  */
 function pmprogroupacct_admin_notice_activation_hook() {
 	// Create transient data.
@@ -17,7 +17,7 @@ function pmprogroupacct_admin_notice_activation_hook() {
 /**
  * Admin Notice on Activation.
  *
- * @since TBD
+ * @since 1.0
  */
 function pmprogroupacct_admin_notice() {
 	// Check transient, if available display notice.
@@ -84,7 +84,7 @@ function pmprogroupacct_after_order_settings( $order ) {
  *
  * @param array $columns The columns for the Orders list table.
  * @return array The columns for the Orders list table.
- * @since TBD
+ * @since 1.0
  */
 function pmprogroupacct_manage_orderslist_columns( $columns ) {
 	$columns['pmprogroupacct_code'] = __( 'Group Code', 'pmpro-group-accounts' );
@@ -120,7 +120,7 @@ function pmprogroupacct_manage_orderslist_column_body( $column_name, $item ) {
 /**
  * Add links to the plugin row meta
  *
- * @since TBD
+ * @since 1.0
  *
  * @param $links - Links for plugin
  * @param $file - main plugin filename

includes/children.php

@@ -3,7 +3,7 @@
  * If a group code is passed and no other checkout messages are being shown, show a message that the group code has been applied if
  * the code is valid or an error message if not.
  *
- * @since TBD
+ * @since 1.0
  */
 function pmprogroupacct_checkout_before_form_child() {
 	// Get the level being checked out for.
@@ -42,7 +42,7 @@ function pmprogroupacct_checkout_before_form_child() {
  *
  * If a group code is already being passed via URL, we will check if it is valid and show a message to the user accordingly.
  *
- * @since TBD
+ * @since 1.0
  */
 function pmprogroupacct_checkout_after_level_cost_child() {
 	// Get the level being checked out for.
@@ -79,7 +79,7 @@ function pmprogroupacct_checkout_after_level_cost_child() {
 	 * Filter whether or not to show the group code field on the checkout page.
 	 * By default, this is true
 	 *
-	 * @since TBD
+	 * @since 1.0
 	 * @param bool $show_group_code_field Whether or not to show the group code field on the checkout page.
 	 * @return bool Whether or not to show the group code field on the checkout page.
 	 */
@@ -105,7 +105,7 @@ function pmprogroupacct_checkout_after_level_cost_child() {
 /**
  * If a valid group code is being used, we need to reduce the level cost to 0.
  *
- * @since TBD
+ * @since 1.0
  *
  * @param object $level The level being checked out for.
  * @return object The level being checked out for.
@@ -138,7 +138,7 @@ function pmprogroupacct_pmpro_checkout_level_child( $level ) {
 /**
  * If a valid group code is being used, unset the level cost text.
  *
- * @since TBD
+ * @since 1.0
  *
  * @param string $level_cost_text The level cost text.
  * @param object $level The level being checked out for.
@@ -169,7 +169,7 @@ function pmprogroupacct_pmpro_level_cost_text_child_checkout( $level_cost_text,
  * If a group code is being used, we need to make sure that the code is valid and
  * that the current user is allowed to use this code before letting checkouts go through.
  *
- * @since TBD
+ * @since 1.0
  *
  * @param bool $pmpro_continue_registration Whether or not to continue with the checkout.
  * @return bool Whether or not to continue with the checkout.
@@ -242,7 +242,7 @@ function pmprogroupacct_pmpro_registration_checks_child( $pmpro_continue_registr
  *
  * Similarly, if the user was already a member of a group using this level, we need to remove them from that group.
  *
- * @since TBD
+ * @since 1.0
  *
  * @param int $user_id The ID of the user being checked out for.
  * @param MemberOrder $morder The order being checked out for.
@@ -311,7 +311,7 @@ function pmprogroupacct_pmpro_after_checkout_child( $user_id, $morder ) {
  * If a child loses a membership level associated with a group,
  * we need to remove them from that group.
  *
- * @since TBD
+ * @since 1.0
  *
  * @param array $old_user_levels The old levels the users had.
  */
@@ -348,7 +348,7 @@ function pmprogroupacct_pmpro_after_all_membership_level_changes_child( $old_use
  * If a group was joined with the invoice that is being displayed,
  * show an invoice bullet with the group parent.
  *
- * @since TBD
+ * @since 1.0
  *
  * @param MemberOrder $invoice The invoice being displayed.
  */
@@ -391,7 +391,7 @@ function pmprogroupacct_pmpro_invoice_bullets_bottom_child( $invoice ) {
  * If we're on the Membership Account page, for levels that were claimed by being a part
  * of a membership group, filter the level cost to show who is paying for the membership.
  *
- * @since TBD
+ * @since 1.0
  *
  * @param string $level_cost The level cost.
  * @param object $level The level being displayed.