Refactor ACF init of qTranslate fields (#1299)

ACF code is unnecessarily duplicated for the initialization. Re-use `parent` methods for constructor and `initialize`. Define ACF_CATEGORY_QTX for the category ID.
qtranslate · Mar 25, 2023 · 2859d47 · 2859d47
1 parent 5f63b50
commit 2859d47
Show file tree

Hide file tree

Showing 8 changed files with 44 additions and 122 deletions.
diff --git a/src/modules/acf/fields/file.php b/src/modules/acf/fields/file.php
@@ -15,36 +15,20 @@ class QTX_Module_Acf_Field_File extends acf_field_file {
      */
     function __construct( $register, $do_initialize ) {
         $this->register = $register;
-
         if ( $do_initialize ) {
             $this->initialize();
         }
-
-        acf_field::__construct();
+        parent::__construct();
     }
 
     /**
      * Setup the field type data
      */
     function initialize() {
+        parent::initialize();
         $this->name     = 'qtranslate_file';
-        $this->label    = __( "File", 'acf' ) . " (qTranslate-XT)";
-        $this->category = "qTranslate-XT";
-        $this->defaults = array(
-            'return_format' => 'array',
-            'library'       => 'all',
-            'min_size'      => 0,
-            'max_size'      => 0,
-            'mime_types'    => ''
-        );
-        $this->l10n     = array(
-            'select'     => __( "Select File", 'acf' ),
-            'edit'       => __( "Edit File", 'acf' ),
-            'update'     => __( "Update File", 'acf' ),
-            'uploadedTo' => __( "Uploaded to this post", 'acf' ),
-        );
-
-        add_filter( 'get_media_item_args', array( $this, 'get_media_item_args' ) );
+        $this->category = QTX_Module_Acf_Register::ACF_CATEGORY_QTX;
+        $this->label    .= ' [' . $this->category . ']';
     }
 
     /**

diff --git a/src/modules/acf/fields/image.php b/src/modules/acf/fields/image.php
@@ -15,46 +15,20 @@ class QTX_Module_Acf_Field_Image extends acf_field_image {
      */
     function __construct( $register, $do_initialize ) {
         $this->register = $register;
-
         if ( $do_initialize ) {
             $this->initialize();
         }
-
-        acf_field::__construct();
+        parent::__construct();
     }
 
     /**
      *  Setup the field type data
      */
     function initialize() {
+        parent::initialize();
         $this->name     = 'qtranslate_image';
-        $this->label    = __( "Image", 'acf' ) . " (qTranslate-XT)";
-        $this->category = "qTranslate-XT";
-        $this->defaults = array(
-            'return_format' => 'array',
-            'preview_size'  => 'medium',
-            'library'       => 'all',
-            'min_width'     => 0,
-            'min_height'    => 0,
-            'min_size'      => 0,
-            'max_width'     => 0,
-            'max_height'    => 0,
-            'max_size'      => 0,
-            'mime_types'    => ''
-        );
-        $this->l10n     = array(
-            'select'     => __( "Select Image", 'acf' ),
-            'edit'       => __( "Edit Image", 'acf' ),
-            'update'     => __( "Update Image", 'acf' ),
-            'uploadedTo' => __( "Uploaded to this post", 'acf' ),
-            'all'        => __( "All images", 'acf' ),
-        );
-
-        add_filter( 'get_media_item_args', array( $this, 'get_media_item_args' ) );
-        // removed from ACF 5.8.3
-        if ( method_exists( $this, 'wp_prepare_attachment_for_js' ) ) {
-            add_filter( 'wp_prepare_attachment_for_js', array( $this, 'wp_prepare_attachment_for_js' ), 10, 3 );
-        }
+        $this->category = QTX_Module_Acf_Register::ACF_CATEGORY_QTX;
+        $this->label    .= ' [' . $this->category . ']';
     }
 
     /**
@@ -76,15 +50,15 @@ function render_field( $field ) {
             acf_enqueue_uploader();
         }
 
-        $default_value     = '';
-        $default_div_attrs = array(
+        $default_value                  = '';
+        $default_div_attrs              = array(
             'class'             => 'acf-image-uploader qtranxs-translatable',
             'data-preview_size' => $field['preview_size'],
             'data-library'      => $field['library'],
             'data-mime_types'   => $field['mime_types'],
             'data-uploader'     => $uploader,
         );
-        $default_img_attrs = array(
+        $default_img_attrs              = array(
             'src'       => '',
             'alt'       => '',
             'data-name' => 'image',
@@ -101,7 +75,7 @@ function render_field( $field ) {
         }
 
         foreach ( $languages as $language ):
-            $field['name']              = $field_name . '[' . $language . ']';
+            $field['name'] = $field_name . '[' . $language . ']';
             $field['value']             = $values[ $language ];
             $value                      = $default_value;
             $div_attrs                  = $default_div_attrs;
@@ -143,9 +117,11 @@ function render_field( $field ) {
                     <img <?php echo acf_esc_attrs( $img_attrs ); ?> />
                     <div class="acf-actions -hover">
                         <?php if ( $uploader !== 'basic' ) : ?>
-                            <a class="acf-icon -pencil dark" data-name="edit" href="#" title="<?php _e( 'Edit', 'acf' ); ?>"></a>
+                            <a class="acf-icon -pencil dark" data-name="edit" href="#"
+                               title="<?php _e( 'Edit', 'acf' ); ?>"></a>
                         <?php endif; ?>
-                        <a class="acf-icon -cancel dark" data-name="remove" href="#" title="<?php _e( 'Remove', 'acf' ); ?>"></a>
+                        <a class="acf-icon -cancel dark" data-name="remove" href="#"
+                           title="<?php _e( 'Remove', 'acf' ); ?>"></a>
                     </div>
                 </div>
                 <div class="hide-if-value">
@@ -165,7 +141,9 @@ function render_field( $field ) {
                             ?>
                         </label>
                     <?php else : ?>
-                        <p><?php _e( 'No image selected', 'acf' ); ?> <a data-name="add" class="acf-button button" href="#"><?php _e( 'Add Image', 'acf' ); ?></a></p>
+                        <p><?php _e( 'No image selected', 'acf' ); ?> <a data-name="add" class="acf-button button"
+                                                                         href="#"><?php _e( 'Add Image', 'acf' ); ?></a>
+                        </p>
                     <?php endif; ?>
                 </div>
             </div>

diff --git a/src/modules/acf/fields/post_object.php b/src/modules/acf/fields/post_object.php
@@ -15,32 +15,20 @@ class QTX_Module_Acf_Field_Post_Object extends acf_field_post_object {
      */
     function __construct( $register, $do_initialize ) {
         $this->register = $register;
-
         if ( $do_initialize ) {
             $this->initialize();
         }
-
-        acf_field::__construct();
+        parent::__construct();
     }
 
     /**
      *  Setup the field type data
      */
     function initialize() {
+        parent::initialize();
         $this->name     = 'qtranslate_post_object';
-        $this->label    = __( "Post Object", 'acf' ) . " (qTranslate-XT)";
-        $this->category = "qTranslate-XT";
-        $this->defaults = array(
-            'post_type'     => array(),
-            'taxonomy'      => array(),
-            'allow_null'    => 0,
-            'multiple'      => 0,
-            'return_format' => 'object',
-            'ui'            => 1,
-        );
-
-        add_action( 'wp_ajax_acf/fields/qtranslate_post_object/query', array( $this, 'ajax_query' ) );
-        add_action( 'wp_ajax_nopriv_acf/fields/qtranslate_post_object/query', array( $this, 'ajax_query' ) );
+        $this->category = QTX_Module_Acf_Register::ACF_CATEGORY_QTX;
+        $this->label    .= ' [' . $this->category . ']';
     }
 
     /**

diff --git a/src/modules/acf/fields/text.php b/src/modules/acf/fields/text.php
@@ -15,28 +15,20 @@ class QTX_Module_Acf_Field_Text extends acf_field_text {
      */
     function __construct( $register, $do_initialize ) {
         $this->register = $register;
-
         if ( $do_initialize ) {
             $this->initialize();
         }
-
-        acf_field::__construct();
+        parent::__construct();
     }
 
     /**
      *  Setup the field type data
      */
     function initialize() {
+        parent::initialize();
         $this->name     = 'qtranslate_text';
-        $this->label    = __( "Text", 'acf' ) . " (qTranslate-XT)";
-        $this->category = "qTranslate-XT";
-        $this->defaults = array(
-            'default_value' => '',
-            'maxlength'     => '',
-            'placeholder'   => '',
-            'prepend'       => '',
-            'append'        => ''
-        );
+        $this->category = QTX_Module_Acf_Register::ACF_CATEGORY_QTX;
+        $this->label .= ' [' . $this->category . ']';
     }
 
     /**

diff --git a/src/modules/acf/fields/textarea.php b/src/modules/acf/fields/textarea.php
@@ -15,28 +15,20 @@ class QTX_Module_Acf_Field_Textarea extends acf_field_textarea {
      */
     function __construct( $register, $do_initialize ) {
         $this->register = $register;
-
         if ( $do_initialize ) {
             $this->initialize();
         }
-
-        acf_field::__construct();
+        parent::__construct();
     }
 
     /**
      * Setup the field type data
      */
     function initialize() {
+        parent::initialize();
         $this->name     = 'qtranslate_textarea';
-        $this->label    = __( "Textarea", 'acf' ) . " (qTranslate-XT)";
-        $this->category = "qTranslate-XT";
-        $this->defaults = array(
-            'default_value' => '',
-            'new_lines'     => '',
-            'maxlength'     => '',
-            'placeholder'   => '',
-            'rows'          => ''
-        );
+        $this->category = QTX_Module_Acf_Register::ACF_CATEGORY_QTX;
+        $this->label    .= ' [' . $this->category . ']';
     }
 
     /**

diff --git a/src/modules/acf/fields/url.php b/src/modules/acf/fields/url.php
@@ -15,25 +15,20 @@ class QTX_Module_Acf_Field_Url extends acf_field_url {
      */
     function __construct( $register, $do_initialize ) {
         $this->register = $register;
-
         if ( $do_initialize ) {
             $this->initialize();
         }
-
-        acf_field::__construct();
+        parent::__construct();
     }
 
     /**
      * Setup the field type data
      */
     function initialize() {
+        parent::initialize();
         $this->name     = 'qtranslate_url';
-        $this->label    = __( "Url", 'acf' ) . " (qTranslate-XT)";
-        $this->category = "qTranslate-XT";
-        $this->defaults = array(
-            'default_value' => '',
-            'placeholder'   => '',
-        );
+        $this->category = QTX_Module_Acf_Register::ACF_CATEGORY_QTX;
+        $this->label    .= ' [' . $this->category . ']';
     }
 
     /**

diff --git a/src/modules/acf/fields/wysiwyg.php b/src/modules/acf/fields/wysiwyg.php
@@ -15,32 +15,20 @@ class QTX_Module_Acf_Field_Wysiwyg extends acf_field_wysiwyg {
      */
     function __construct( $register, $do_initialize ) {
         $this->register = $register;
-
         if ( $do_initialize ) {
             $this->initialize();
         }
-
-        acf_field::__construct();
+        parent::__construct();
     }
 
     /**
      * Setup the field type data
      */
     function initialize() {
+        parent::initialize();
         $this->name     = 'qtranslate_wysiwyg';
-        $this->label    = __( "Wysiwyg Editor", 'acf' ) . " (qTranslate-XT)";
-        $this->category = "qTranslate-XT";
-        $this->defaults = array(
-            'tabs'          => 'all',
-            'toolbar'       => 'full',
-            'media_upload'  => 1,
-            'default_value' => '',
-            'delay'         => 0
-        );
-
-        if ( method_exists( $this, 'add_filters' ) ) {
-            $this->add_filters();
-        }
+        $this->category = QTX_Module_Acf_Register::ACF_CATEGORY_QTX;
+        $this->label    .= ' [' . $this->category . ']';
     }
 
     /**

diff --git a/src/modules/acf/register.php b/src/modules/acf/register.php
@@ -4,6 +4,11 @@
  * Allows the integration with ACF by setting up the derived fields.
  */
 class QTX_Module_Acf_Register {
+    /**
+     * @var string ACF category ID for the qTranslate extended fields.
+     */
+    const ACF_CATEGORY_QTX = 'qTranslate-XT';
+
     /**
      * Constructor
      */