Updates

Author: PDowney

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Fixed
+- **Code Style and Documentation**: Addressed multiple code style issues, including whitespace, alignment, and indentation, to improve readability and maintainability.
+- **PHPDoc Blocks**: Added comprehensive PHPDoc blocks to all functions, ensuring all parameters and return values are clearly documented.
+
 ### Fixed
 - Fixed WordPress coding standards violations in function formatting
 - Fixed anonymous function spacing and indentation issues

free-gift-bulk-coupon-generator.php

@@ -14,7 +14,7 @@
  * Domain Path: /languages
  *
  * @package wc-free-gift-coupons-bulk-coupons-generator
- * 
+ *
  * Note: This is the main plugin file and follows WordPress plugin naming conventions.
  * The filename free-gift-bulk-coupon-generator.php is intentionally different from
  * the class name to follow WordPress plugin standards.
@@ -180,7 +180,9 @@ function () {
         $product_ids       = isset( $_POST['product_id'] ) ? array_map( 'absint', (array) wp_unslash( $_POST['product_id'] ) ) : array();
         $number_of_coupons = isset( $_POST['number_of_coupons'] ) ? absint( wp_unslash( $_POST['number_of_coupons'] ) ) : 0;
         $coupon_prefix     = isset( $_POST['coupon_prefix'] ) ? sanitize_text_field( wp_unslash( $_POST['coupon_prefix'] ) ) : '';
-        $discount_type     = isset( $_POST['discount_type'] ) ? sanitize_text_field( wp_unslash( $_POST['discount_type'] ) ) : 'free_gift';        // Validate discount type against allowed values.
+        $discount_type     = isset( $_POST['discount_type'] ) ? sanitize_text_field( wp_unslash( $_POST['discount_type'] ) ) : 'free_gift';
+        
+        // Validate discount type against allowed values.
         $allowed_discount_types = array( 'free_gift', 'percent', 'fixed_cart', 'fixed_product' );
         if ( ! in_array( $discount_type, $allowed_discount_types, true ) ) {
             $discount_type = 'free_gift'; // Default to safe value.
@@ -246,11 +248,11 @@ function () {
                 'admin_notices',
                 function () use ( $generated_coupons ) {
                     echo '<div class="notice notice-success is-dismissible"><p>' .
-                         sprintf(
-                             /* translators: %d: Number of coupons generated */
-                             esc_html__( 'Successfully generated %d coupons.', 'wc-free-gift-coupons-bulk-coupons-generator' ),
-                             esc_html( $generated_coupons )
-                         ) .
+                        sprintf(
+                            /* translators: %d: Number of coupons generated */
+                            esc_html__( 'Successfully generated %d coupons.', 'wc-free-gift-coupons-bulk-coupons-generator' ),
+                            esc_html( $generated_coupons )
+                        ) .
                          '</p></div>';
                 }
             );
@@ -321,6 +323,11 @@ private function validate_products( $product_ids ) {
 
     /**
      * Prepare generation parameters
+     *
+     * @param int    $number_of_coupons Number of coupons to generate.
+     * @param string $prefix           Coupon prefix.
+     * @param string $discount_type    Type of discount.
+     * @return array Generation parameters array.
      */
     private function prepare_generation_params( $number_of_coupons, $prefix, $discount_type ) {
         return array(
@@ -334,6 +341,9 @@ private function prepare_generation_params( $number_of_coupons, $prefix, $discou
 
     /**
      * Prepare gift information for coupons
+     *
+     * @param array $valid_products Array of valid product objects.
+     * @return array Gift information array.
      */
     private function prepare_gift_info( $valid_products ) {
         $gift_info = array();
@@ -350,6 +360,11 @@ private function prepare_gift_info( $valid_products ) {
 
     /**
      * Execute the coupon generation process
+     *
+     * @param array $valid_products Array of valid product objects.
+     * @param array $gift_info      Gift information array.
+     * @param array $params         Generation parameters.
+     * @return int Number of coupons generated.
      */
     private function execute_coupon_generation( $valid_products, $gift_info, $params ) {
         $generated_count = 0;
@@ -377,6 +392,12 @@ private function execute_coupon_generation( $valid_products, $gift_info, $params
 
     /**
      * Create a single coupon
+     *
+     * @param array $valid_products Array of valid product objects.
+     * @param array $gift_info      Gift information array.
+     * @param array $params         Generation parameters.
+     * @param int   $current_number Current coupon number in batch.
+     * @return bool True if coupon was created successfully, false otherwise.
      */
     private function create_single_coupon( $valid_products, $gift_info, $params, $current_number ) {
         try {
@@ -409,6 +430,12 @@ private function create_single_coupon( $valid_products, $gift_info, $params, $cu
 
     /**
      * Set coupon properties
+     *
+     * @param WC_Coupon $coupon         The coupon object.
+     * @param string    $code           The coupon code.
+     * @param array     $valid_products Array of valid product objects.
+     * @param array     $params         Generation parameters.
+     * @param int       $current_number Current coupon number in batch.
      */
     private function set_coupon_properties( $coupon, $code, $valid_products, $params, $current_number ) {
         // Create product names list for description.
@@ -438,6 +465,10 @@ private function set_coupon_properties( $coupon, $code, $valid_products, $params
 
     /**
      * Set coupon metadata
+     *
+     * @param WC_Coupon $coupon    The coupon object.
+     * @param array     $gift_info Gift information array.
+     * @param array     $params    Generation parameters.
      */
     private function set_coupon_metadata( $coupon, $gift_info, $params ) {
         // For free gift coupons, add the gift data.
@@ -468,6 +499,8 @@ private function handle_generation_delay( $current_number ) {
 
     /**
      * Log coupon generation errors
+     *
+     * @param Exception $exception The exception that occurred.
      */
     private function log_coupon_error( $exception ) {
         // Only log in debug mode.
@@ -485,6 +518,9 @@ private function log_coupon_error( $exception ) {
 
     /**
      * Generate unique coupon code
+     *
+     * @param string $prefix Optional prefix for the coupon code.
+     * @return string Generated coupon code.
      */
     private function generate_coupon_code( $prefix = '' ) {
         $code_length   = 12;
@@ -506,6 +542,8 @@ private function generate_coupon_code( $prefix = '' ) {
 
     /**
      * Get products for dropdown
+     *
+     * @return array Array of product options for dropdown.
      */
     private function get_products_for_dropdown() {
         // Use transient caching for performance.
@@ -568,6 +606,8 @@ public function admin_page() {
 
     /**
      * Render admin form
+     *
+     * @param array $products Array of products for the dropdown.
      */
     private function render_admin_form( $products ) {
         ?>
@@ -591,6 +631,8 @@ private function render_admin_form( $products ) {
 
     /**
      * Render product selection field
+     *
+     * @param array $products Array of products for the dropdown.
      */
     private function render_product_selection_field( $products ) {
         ?>

readme.txt

@@ -114,6 +114,8 @@ along with this program.  If not, see <https://www.gnu.org/licenses/>.
 * **Improvement**: Removed deprecated load_plugin_textdomain() call as WordPress automatically handles translations for plugins hosted on WordPress.org.
 * **Improvement**: Updated all repository links to use lowercase format.
 * **Testing**: Added helper function for plugin load testing to improve compatibility with testing frameworks.
+* **Code Style and Documentation**: Addressed multiple code style issues, including whitespace, alignment, and indentation, to improve readability and maintainability.
+* **PHPDoc Blocks**: Added comprehensive PHPDoc blocks to all functions, ensuring all parameters and return values are clearly documented.
 
 = 1.3.0 =
 * **Security Enhancement**: Replaced `wp_rand()` with `random_int()` for cryptographically secure coupon code generation.