Changeset 3197083

Timestamp:

11/26/2024 06:52:59 AM (13 months ago)

Author:

navzme

Message:

• [Added] support for GraphQL
• [Fixed] issue with get_fields()

Location:

acf-galerie-4/trunk

Files:

• LICENSE (added)
• acf-galerie-4.php (modified) (5 diffs)
• class-acfg4-register-field-type.php (modified) (8 diffs)
• providers (added)
• providers/class.wpgraphql.php (added)
• providers/index.php (added)
• readme.txt (modified) (2 diffs)

acf-galerie-4/trunk/acf-galerie-4.php

@@ -9 +9 @@
  * License: GPL v2 or later
  * License URI: https://www.gnu.org/licenses/gpl-2.0.html
- * Version: 1.2.0
+ * Version: 1.3.0
  * Domain Path: /lang
  * Requires PHP: 7.4
@@ -19 +19 @@
 }
 
-define( 'ACFG4_VERSION', '1.2.0' );
+define( 'ACFG4_VERSION', '1.3.0' );
 define( 'ACFG4_PLUGIN', __FILE__ );
 define( 'ACFG4_PLUGIN_BASENAME', plugin_basename( ACFG4_PLUGIN ) );
@@ -25 +25 @@
 define( 'ACFG4_PLUGIN_DIR', untrailingslashit( dirname( ACFG4_PLUGIN ) ) );
 
-//Load the text domain
+/**
+ * Loads the text domain for translation in the plugin.
+ *
+ * Hooks into the `init` action to:
+ * - Load the plugin's text domain for translation, allowing the plugin to support
+ *   multiple languages.
+ * - Specifies the path to the translation files, located in the `lang` directory.
+ * - The `acf-galerie-4` text domain is used for translation strings within the plugin.
+ *
+ * This ensures that any text strings in the plugin can be translated according
+ * to the user's WordPress language settings.
+ *
+ * @return void
+ */
 add_action('init', 'acfg4_textdomain');
 function acfg4_textdomain() {
@@ -31 +44 @@
 }
 
-//Registers the ACF field type.
+/**
+ * Registers the custom ACF field type during WordPress initialization.
+ *
+ * Hooks into the `init` action to:
+ * - Check if the `acf_register_field_type` function is available. 
+ *   This ensures compatibility with ACF Pro 5.0 or higher.
+ * - Require the file that defines the `acfg4_register_field_type` class.
+ * - Register the custom field type (`acfg4_register_field_type`) with ACF.
+ *
+ * This setup ensures that the `galerie-4` custom field type is properly
+ * initialized and available for use in ACF field groups.
+ *
+ * @return void
+ */
 add_action( 'init', 'acfg4_init_register_type' );
 function acfg4_init_register_type() {
@@ -38 +64 @@
     acf_register_field_type( 'acfg4_register_field_type' );
 }
+
+/**
+ * Registers the custom ACF field type with WPGraphQL.
+ *
+ * Hooks into the `wpgraphql/acf/registry_init` action to initialize
+ * support for the custom `galerie-4` ACF field type in WPGraphQL.
+ *
+ * The function:
+ * - Requires the WPGraphQL integration class file.
+ * - Instantiates the `acfg4_wpgraphql` class to register and configure 
+ *   the field type within the WPGraphQL schema.
+ */
+add_action( 'wpgraphql/acf/registry_init', function() {
+    require_once __DIR__ . '/providers/class.wpgraphql.php';
+    new acfg4_wpgraphql();
+});

acf-galerie-4/trunk/class-acfg4-register-field-type.php

@@ -24 +24 @@
 
     /**
-     * Constructor.
+     * Initializes the custom field type with its properties and defaults.
+     *
+     * This constructor sets up the essential information and configurations
+     * for the custom ACF field type `galerie-4`. It defines:
+     * - Name and label for identification and display in the UI.
+     * - Category under which the field type is listed in the picker.
+     * - Description for the field type, displayed in field settings.
+     * - Links to documentation and tutorial resources for user guidance.
+     * - Default settings specific to this field type.
+     * - Environment settings, including the plugin version.
+     *
+     * Inherits functionality from the parent field type class.
      */
     public function __construct() {
@@ -44 +55 @@
          * The category the field appears within in the field type picker.
          */
-        $this->category = 'content'; // basic | content | choice | relational | jquery | layout | CUSTOM GROUP NAME
+        $this->category = 'content';
 
         /**
@@ -75 +86 @@
             'version' => ACFG4_VERSION,
         );
-
+        
         parent::__construct();
     }
@@ -103 +114 @@
         if ( !empty( $field ) and !empty( $field['value'] ) ) {
             $attachment_ids = array_map( 'intval', $field['value'] );
-            $attachments = $this->get_attachments( $attachment_ids );
+            $attachments = $this->transform( $attachment_ids );
         }
     ?>
@@ -154 +165 @@
     }
 
+    /**
+     * Validates and processes the submitted field value before saving it.
+     *
+     * This function performs the following tasks:
+     * - Verifies the nonce for security to ensure the request is valid.
+     * - Checks the presence of the required POST data for the field.
+     * - Sanitizes and processes the input value into an array of integers.
+     *
+     * If the nonce validation fails or required data is missing, the function 
+     * terminates execution to prevent further processing.
+     *
+     * @param mixed $value    The raw value submitted for the field.
+     * @param int   $post_id  The ID of the post where the field is being updated.
+     * @param array $field    The field configuration array, containing metadata about the field.
+     * 
+     * @return array An array of sanitized integer values representing the field's data.
+     */
     function update_value( $value, $post_id, $field ) {
         $field_type = $field['type'];
@@ -176 +204 @@
     }
 
+    /**
+     * Formats the field value into a structured attachment data array.
+     *
+     * Converts raw attachment IDs into integer values, validates them, and 
+     * transforms the data into a detailed structure with attachment metadata.
+     *
+     * - If the input `$value` is empty, an empty array is returned.
+     * - Valid attachment IDs are passed to the `transform` method for processing.
+     *
+     * @param mixed $value    The raw field value, typically an array of attachment IDs.
+     * @param int   $post_id  The ID of the post where the field is being used.
+     * @param array $field    The field configuration array.
+     * 
+     * @return array Structured attachment data generated by the `transform` method.
+     */
     function format_value( $value, $post_id, $field ) {
-        if ( empty($value) ) die();
-
         $attachment_ids = array_map( 'intval', $value );
 
-        return $this->get_attachments( $attachment_ids );
-    }
-
-    function get_attachments( $attachment_ids ){
-        $attachments = get_posts(
-            array(
-                'post_type' => 'attachment',
-                'post__in' => $attachment_ids,
-                'post_status' => 'inherit',
-                'orderby' => 'post__in',
-                'order' => 'ASC',
-                'numberposts' => -1
-            )
-        );
-
+        if( empty( $attachment_ids ) ){
+            return array();
+        }
+
+        return $this->transform( $attachment_ids );
+    }
+
+    /**
+     * Transforms attachment IDs into structured attachment and metadata information.
+     *
+     * Fetches attachment data for the provided IDs and formats the output 
+     * to include detailed metadata such as file information, dimensions, 
+     * MIME types, and URLs for different image sizes.
+     *
+     * - Non-image attachments include basic file metadata such as MIME type and file size.
+     * - Image attachments include metadata for the full image as well as additional sizes.
+     *
+     * Sensitive fields like `post_password` and `guid` are removed from the attachment object.
+     *
+     * @param array $attachment_ids List of attachment IDs to retrieve and transform.
+     *
+     * @return array A structured array containing attachment data and metadata. 
+     *               Each element includes:
+     *               - 'attachment': The sanitized attachment object.
+     *               - 'metadata': An array of metadata details (e.g., file size, URLs).
+     */
+    public function transform( $attachment_ids ){
         $attachment_data = array();
+        $attachments = $this->get_attachments( $attachment_ids );
 
         if ( !empty( $attachments ) ) {
@@ -247 +301 @@
     }
     
+    /**
+     * Generates a sanitized CSS class name for an ACF field.
+     *
+     * Prepends a prefix to the provided class name and ensures it is properly escaped.
+     *
+     * @param string $class The class name to be prefixed and sanitized.
+     * 
+     * @return string The sanitized and prefixed CSS class name.
+     */
     function add_class($class){
         return esc_attr("acf-galerie-4-{$class}");
     }
 
+    /**
+     * Prepares an array of HTML attributes for an ACF field.
+     *
+     * Generates attributes including an ID, a nonce for security, 
+     * and a CSS class for the ACF field.
+     *
+     * @param array $field The field configuration array containing field details.
+     * 
+     * @return array Associative array of sanitized HTML attributes for the field.
+     */
     function add_attrs($field){
         return array(
@@ -295 +368 @@
         }
     }
+    
+    /**
+     * Retrieves attachment posts based on the provided attachment IDs.
+     *
+     * Fetches attachment posts matching the given IDs in their original order, 
+     * with a post type of 'attachment' and a status of 'inherit'.
+     *
+     * @param array $attachment_ids List of attachment post IDs to retrieve.
+     *
+     * @return array List of attachment posts that match the criteria.
+     */
+    public function get_attachments( $attachment_ids ){
+        return get_posts(
+            array(
+                'post_type' => 'attachment',
+                'post__in' => $attachment_ids,
+                'post_status' => 'inherit',
+                'orderby' => 'post__in',
+                'order' => 'ASC',
+                'numberposts' => -1
+            )
+        );
+    }
+    
 }

acf-galerie-4/trunk/readme.txt

@@ -4 +4 @@
 Tags: acf, gallery, images, videos, media
 Requires at least: 5.8
-Tested up to: 6.6
-Stable tag: 1.2.0
+Tested up to: 6.7
+Stable tag: 1.3.0
 Requires PHP: 7.0
 License: GPLv2 or later
@@ -36 +36 @@
 
 == Changelog ==
+= 1.3.0 =
+* [Added] support for GraphQL
+* [Fixed] issue with get_fields()
+
 = 1.2.0 =
 * [Added] support for taxonomy