AdminPageFrameworkLoader_AdminPage_Tool_Compiler_CustomFieldTypes

Complexity

Total Complexity

30

Size/Duplication

Total Lines	457
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	___getModifiedFileContents()	0	39	2
A	___getClassListOfCustomFieldTypes()	0	19	2
A	___getClassPrefixRegexReplacements()	0	14	1
A	___getModifiedIncludeList()	0	5	1
A	___getClassNamesPrefixed()	0	10	1
A	___getClassPrefixRegexPatterns()	0	7	2
A	__construct()	0	41	1
B	___setProperties()	0	77	2
A	replyToModifyFileContents()	0	27	5
A	___getClassNameIfSelected()	0	9	3
A	___replyToSetPrefix()	0	2	1
A	___getCheckedCustomFieldTypeKeys()	0	12	1
A	replyToGetAdditionalHeaderComment()	0	9	4
A	___getSelectedCustomFieldTypes()	0	17	2
A	replyToSetAdditionalDirectoriesForGenerator()	0	9	2

<?php
/**
 * Admin Page Framework Loader
 *
 * http://admin-page-framework.michaeluno.jp/
 * Copyright (c) 2013-2022, Michael Uno; Licensed GPLv2
 */

/**
 * Adds the 'custom_field_types' field to the 'Compiler' section.
 *
 * @since 3.6.0
 */
class AdminPageFrameworkLoader_AdminPage_Tool_Compiler_CustomFieldTypes {

    /**
     * Stores the admin page factory object.
     * @var AdminPageFramework
     */
    public $oFactory;

    /**
     * @var string
     */
    public $sSectionID = '';

    /**
     * @var array
     * ### Structure
     * ```
     * array(
     *     'class_name'           => '',   // the source class name to be prefixed with the user specified one.
     *     'directory_path'       => '',
     *     'label'                => '',
     *     'description'          => '',
     *     'archive_file_path'    => '',
     *     'archive_dir_path'     => '',
     *     'text_domain'          => '',   // the source text domain to be converted to the user specified one.
     * )
     * ```
     */
    public $aCustomFieldTypes = array();

    public $aCustomFieldTypeLabels = array();

    /**
     * Sets up hooks and properties.
     */
    public function __construct( $oFactory, $sSectionID ) {

        // Properties
        $this->oFactory   = $oFactory;
        $this->sSectionID = $sSectionID;
        $this->___setProperties();

        // Form fields - the field type pack extension also uses this field.
        $oFactory->addSettingFields(
            $sSectionID, // the target section id
            array(
                'field_id'              => 'custom_field_types',
                'title'                 => __( 'Custom Field Types', 'admin-page-framework-loader' ),
                'type'                  => 'checkbox',
                'order'                 => 13,
                'label'                 => $this->aCustomFieldTypeLabels,
                'label_min_width'       => '100%',
                'select_all_button'     => true,
                'select_none_button'    => true,
            )
        );

        // Hooks
        /// Register custom field files to the Generator of the framework loader.
        add_filter(
            'admin_page_framework_loader_filter_generator_additional_source_directories',
            array( $this, 'replyToSetAdditionalDirectoriesForGenerator' )
        );

        /// Register a callback to modify archive files.
        add_filter(
            'admin_page_framework_loader_filter_generator_file_contents',
            array( $this, 'replyToModifyFileContents' ),
            10,
            4
        );

        /// [3.9.0] Insert checked custom field types in the file comment header
        add_filter(
            AdminPageFrameworkLoader_Registry::HOOK_SLUG . '_filter_generator_header_comment',
            array( $this, 'replyToGetAdditionalHeaderComment' )
        );

    }
        /**
         * Sets up properties.
         * @since 3.6.0
         */
        private function ___setProperties() {

            $this->aCustomFieldTypes = array(
                'AceCustomFieldType'   =>  array(
                    'class_name'           => 'AceCustomFieldType',
                    'label'                => __( 'ACE', 'admin-page-framework-loader' ),
                    'description'          => __( 'provides code syntax highlighting in a text area field.', 'admin-page-framework-loader' ),
                    'directory_path'       => AdminPageFrameworkLoader_Registry::$sDirPath . '/example/library/ace-custom-field-type',
                    'archive_file_path'    => 'custom-field-types/ace-custom-field-type/AceCustomFieldType.php',
                    'archive_dir_path'     => 'custom-field-types/ace-custom-field-type',
                    'text_domain'          => 'admin-page-framework',
                ),
                'GitHubCustomFieldType'   =>  array(
                    'class_name'           => 'GitHubCustomFieldType',
                    'label'                => __( 'GitHub Buttons', 'admin-page-framework-loader' ),
                    'description'          => __( 'allows you to display GitHub buttons in a field.', 'admin-page-framework-loader' ),
                    'directory_path'       => AdminPageFrameworkLoader_Registry::$sDirPath . '/include/library/github-custom-field-type',
                    'archive_file_path'    => 'custom-field-types/github-custom-field-type/GitHubCustomFieldType.php',
                    'archive_dir_path'     => 'custom-field-types/github-custom-field-type',
                    'text_domain'          => 'admin-page-framework',
                ),
                'PathCustomFieldType'   =>  array(
                    'class_name'           => 'PathCustomFieldType',
                    'label'                => __( 'Path', 'admin-page-framework-loader' ),
                    'description'          => __( 'allows the user to select a file path on the server.', 'admin-page-framework-loader' ),
                    'directory_path'       => AdminPageFrameworkLoader_Registry::$sDirPath . '/example/library/path-custom-field-type',
                    'archive_file_path'    => 'custom-field-types/path-custom-field-type/PathCustomFieldType.php',
                    'archive_dir_path'     => 'custom-field-types/path-custom-field-type',
                    'text_domain'          => 'admin-page-framework',
                ),
                'ToggleCustomFieldType'   =>  array(
                    'class_name'           => 'ToggleCustomFieldType',
                    'label'                => __( 'Toggle', 'admin-page-framework-loader' ),
                    'description'          => __( 'allows the user to switch a button.', 'admin-page-framework-loader' ),
                    'directory_path'       => AdminPageFrameworkLoader_Registry::$sDirPath . '/example/library/toggle-custom-field-type',
                    'archive_file_path'    => 'custom-field-types/toggle-custom-field-type/ToggleCustomFieldType.php',
                    'archive_dir_path'     => 'custom-field-types/toggle-custom-field-type',
                    'text_domain'          => 'admin-page-framework',
                ),
                'NoUISliderCustomFieldType'   =>  array(
                    'class_name'           => 'NoUISliderCustomFieldType',
                    'label'                => __( 'NoUISlider (Range Slider)', 'admin-page-framework-loader' ),
                    'description'          => __( 'allows the user to set values in ranges.', 'admin-page-framework-loader' ),
                    'directory_path'       => AdminPageFrameworkLoader_Registry::$sDirPath . '/example/library/nouislider-custom-field-type',
                    'archive_file_path'    => 'custom-field-types/nouislider-custom-field-type/NoUISliderCustomFieldType.php',
                    'archive_dir_path'     => 'custom-field-types/nouislider-custom-field-type',
                    'text_domain'          => 'admin-page-framework',
                ),
                'Select2CustomFieldType'   =>  array(
                    'class_name'           => 'Select2CustomFieldType',
                    'label'                => __( 'Select2', 'admin-page-framework-loader' ),
                    'description'          => __( 'allows the user to select items with autocomplete from a list which can be populated with AJAX.', 'admin-page-framework-loader' ),
                    'directory_path'       => AdminPageFrameworkLoader_Registry::$sDirPath . '/example/library/select2-custom-field-type',
                    'archive_file_path'    => 'custom-field-types/select2-custom-field-type/Select2CustomFieldType.php',
                    'archive_dir_path'     => 'custom-field-types/select2-custom-field-type',
                    'text_domain'          => 'admin-page-framework',
                ),
                'PostTypeTaxonomyCustomFieldType'   =>  array(
                    'class_name'           => 'PostTypeTaxonomyCustomFieldType',
                    'label'                => __( 'Post Type Taxonomy', 'admin-page-framework-loader' ),
                    'description'          => __( 'allows the user to select taxonomy terms of selected post types.', 'admin-page-framework-loader' ),
                    'directory_path'       => AdminPageFrameworkLoader_Registry::$sDirPath . '/example/library/post_type_taxonomy_field-type',
                    'archive_file_path'    => 'custom-field-types/post_type_taxonomy_field-type/PostTypeTaxonomyCustomFieldType.php',
                    'archive_dir_path'     => 'custom-field-types/post_type_taxonomy_field-type',
                    'text_domain'          => 'admin-page-framework',
                ),
            );

            // Let third-party scripts add custom field types.
            $this->aCustomFieldTypes = apply_filters(
                AdminPageFrameworkLoader_Registry::HOOK_SLUG . '_filter_generator_custom_field_types',
                $this->aCustomFieldTypes
            );

            foreach( $this->aCustomFieldTypes as $_sKey => $_aCustomFieldType ) {
                $this->aCustomFieldTypeLabels[ $_sKey ] = $_aCustomFieldType[ 'label' ]
                    . ' - <span class="description">' . $_aCustomFieldType[ 'description' ] . '</span>';
            }

        }

            /**
             * Modifies the file contents.
             *
             * @since    3.6.0
             * @return   string
             * @callback add_filter() admin_page_framework_loader_filter_generator_file_contents
             */
            public function replyToModifyFileContents( $sFileContents, $sPathInArchive, $aFormData, $oFactory ) {

The parameter $oFactory is not used and could be removed.

The parameter $aFormData is not used and could be removed.

                // Check the file extension.
                $_aAllowedExtensions = apply_filters(
                    AdminPageFrameworkLoader_Registry::HOOK_SLUG . '_filter_generator_allowed_file_extensions',
                    array( 'php', 'css', 'js' )
                );
                if ( ! in_array( pathinfo( $sPathInArchive, PATHINFO_EXTENSION ), $_aAllowedExtensions, true ) ) {
                    return $sFileContents;
                }

                // Skip the framework bootstrap file.
                if ( $this->oFactory->oUtil->hasSuffix( 'admin-page-framework.php', $sPathInArchive ) ) {
                    return $sFileContents;
                }

                // The inclusion class list file needs to be handled differently.
                if ( $this->oFactory->oUtil->hasSuffix( 'admin-page-framework-class-map.php', $sPathInArchive ) ) {
                    return $this->___getModifiedIncludeList( $sFileContents );
                }

                $_bsParsingClassName = $this->___getClassNameIfSelected( $sPathInArchive );
                if ( $_bsParsingClassName ) {
                    return $this->___getModifiedFileContents( $sFileContents, $sPathInArchive, $_bsParsingClassName );
                }

                return $sFileContents;

            }
                /**
                 * Modifies the class include list.
                 * @since  3.6.0
                 * @return string
                 */
                private function ___getModifiedIncludeList( $sFileContents ) {
                    return str_replace(
                        ');', // search
                        $this->___getClassListOfCustomFieldTypes() . ');', // replace - @todo insert the selected class list here
                        $sFileContents // subject
                    );
                }
                    /**
                     * @since  3.6.0
                     * @return string
                     */
                    private function ___getClassListOfCustomFieldTypes() {

                        $_aCheckedCustomFieldTypes = $this->___getSelectedCustomFieldTypes( $this->aCustomFieldTypes );
                        $_sClassPrefix             = sanitize_text_field( $this->oFactory->oUtil->getElement(
                            $_POST,
                            array(
                                $this->oFactory->oProp->sOptionKey,
                                'compiler',    // section id
                                'class_prefix'  // field id
                            ),
                            ''
                        ) );
                        $_aOutput = array();
                        foreach( $_aCheckedCustomFieldTypes as $_sClassName => $_aCustomFieldType ) {
                            $_aOutput[] = '    "' . $_sClassPrefix . $_sClassName . '"'
                                . ' => '
                                . 'AdminPageFramework_Registry::$sDirPath . ' . '"/' . ltrim( $_aCustomFieldType[ 'archive_file_path' ], '/' ) . '",';
                        }
                        return implode( PHP_EOL, $_aOutput ) . PHP_EOL;

                    }

                /**
                 * Retrieves the custom field type class name from the given archive path.
                 *
                 * Checks if the user select the field type in the Generator form.
                 *
                 * @since  3.6.0
                 * @since  3.9.0       Changed the return value from `false` to an empty string if not found.
                 * @return string      The found class name. An empty string if not found.
                 */
                private function ___getClassNameIfSelected( $sPathInArchive ) {
                    $_aSelectedCustomFieldTypes = $this->___getSelectedCustomFieldTypes( $this->aCustomFieldTypes );
                    foreach( $_aSelectedCustomFieldTypes as $_sClassName => $_aCustomFieldType ) {
                        $_sThisArchiveDirPath = $this->oFactory->oUtil->getElement( $_aCustomFieldType, 'archive_dir_path' );
                        if ( false !== strpos( $sPathInArchive, $_sThisArchiveDirPath ) ) {
                            return $_sClassName;
                        }
                    }
                    return '';
                }

                /**
                 * Modify the file contents of the given path.
                 *
                 * Converts the class name by adding the user-set class name prefix.
                 * Also, the text domain used in the custom field type will be converted.
                 *
                 * @remark The reason why it retrieves all the selected custom field type classes, not the parsing item is
                 * because some custom field types extend another custom field type. In that case, a name is used among multiple files.
                 * @since  3.6.0
                 * @since  3.7.2  Added the `$sParsingClassName` argument.
                 * @return string
                 */
                private function ___getModifiedFileContents( $sFileContents, $sPathInArchive, $sParsingClassName ) {

                    // 3.8.4+ Some custom field types names conflict each other such as `TuneCustomFieldType` and `DateTimeCustomFieldType` so they must be dealt with regular expressions.
                    $sFileContents = $this->___getClassNamesPrefixed( $sFileContents );

                    // Searches and replaces for `str_replace()`.
                    $_aSearches = array();
                    $_aReplaces = array();

                    $_sUserTextDomain = sanitize_text_field( $this->oFactory->oUtil->getElement(
                        $_POST,
                        array(
                            $this->oFactory->oProp->sOptionKey,
                            'compiler', // section id
                            'text_domain' // field id
                        ),
                        ''
                    ) );

                    // Change the text domain.

                    /// 3.7.2+ Get the custom field type text domain.
                    $_sFieldTypeTextDomain = $this->oFactory->oUtil->getElement(
                        $this->aCustomFieldTypes,
                        array( $sParsingClassName, 'text_domain' )
                    );
                    if ( $_sFieldTypeTextDomain ) {
                        $_aSearches[] = $_sFieldTypeTextDomain;
                        $_aReplaces[] = $_sUserTextDomain;
                    }

                    $_aSearches[] = 'admin-page-framework';
                    $_aReplaces[] = $_sUserTextDomain;

                    // Return the converted string.
                    return str_replace(
                        $_aSearches,    // search
                        $_aReplaces,    // replace
                        $sFileContents  // subject
                    );

                }

                    /**
                     * Modifies the given content by replacing the class names with a prefix.
                     * @since  3.8.4
                     * @return string
                     */
                    private function ___getClassNamesPrefixed( $sFileContents ) {

                        $_aSelectedFieldTypeClassNames = array_keys(
                            $this->___getSelectedCustomFieldTypes( $this->aCustomFieldTypes )
                        );

                        return preg_replace(
                            $this->___getClassPrefixRegexPatterns( $_aSelectedFieldTypeClassNames ),    // search
                            $this->___getClassPrefixRegexReplacements( $_aSelectedFieldTypeClassNames ),    // replace
                            $sFileContents  // subject
                        );

                    }
                        /**
                         * Returns an array holding regular expressions needle patterns for class names.
                         * @since       3.8.4
                         * @return      array
                         */
                        private function ___getClassPrefixRegexPatterns( array $aSelectedFieldTypeClassNames ) {

                            $_aPregSearches = array();
                            foreach( $aSelectedFieldTypeClassNames as $_sClassName ) {
                                $_aPregSearches[] = '/(?<=[^a-zA-Z0-9])(' . $_sClassName . ')/';
                            }
                            return $_aPregSearches;

                        }
                        /**
                         * Returns an array holding regular expressions replacements for class names.
                         * @since  3.8.4
                         * @return array
                         */
                        private function ___getClassPrefixRegexReplacements( array $aSelectedFieldTypeClassNames ) {

                            $_aPrefixedClassNames = $aSelectedFieldTypeClassNames;
                            $_sPrefix             = sanitize_text_field( $this->oFactory->oUtil->getElement(
                                $_POST,
                                array(
                                    $this->oFactory->oProp->sOptionKey,
                                    'compiler', // section id
                                    'class_prefix' // field id
                                ),
                                ''
                             ) );
                            array_walk( $_aPrefixedClassNames, array( $this, '___replyToSetPrefix' ), $_sPrefix );
                            return $_aPrefixedClassNames;

                        }
                            /**
                             * @since    3.6.0
                             * @since    3.8.4        Changed it for regular expression patterns.
                             * @since    3.9.0        Changed the visibility scope from `public` to `private`.
                             * @callback array_walk()
                             */
                            private function ___replyToSetPrefix( &$sClassName, $sKey, $sPrefix ) {
                                $sClassName = $sPrefix . '$0';
                            }


            /**
             * Inserts extra archive directories of custom field types chosen by the user.
             *
             * Structure:
             * Archive directory path => Source directory path
             * `
             * array(
             *  'custom-field-types/my-custom-field-type' =>  AdminPageFrameworkLoader_Registry::$sDirPath . '/include/library/my-custom-field-type',
             * )
             * `
             *
             * @since       3.6.0
             * @return      array
             * @callback    add_filter() admin_page_framework_loader_filter_generator_additional_source_directories
             */
            public function replyToSetAdditionalDirectoriesForGenerator( $aDirPaths ) {
                $_aCheckedCustomFieldTypes = $this->___getSelectedCustomFieldTypes( $this->aCustomFieldTypes );
                $_aDirPathInfo             = array();
                foreach( $_aCheckedCustomFieldTypes as $_sKey => $_aCheckedCustomFieldType ) {
                    $_sArchiveDirPath = $this->oFactory->oUtil->getElement( $_aCheckedCustomFieldType, 'archive_dir_path' );
                    $_sSourceDirPath  = $this->oFactory->oUtil->getElement( $_aCheckedCustomFieldType, 'directory_path' );
                    $_aDirPathInfo[ $_sArchiveDirPath ] = $_sSourceDirPath;
                }
                return $aDirPaths + $_aDirPathInfo;
            }
                /**
                 * @return array The array keys of the checked items.
                 * @since  3.6.0
                 */
                private function ___getSelectedCustomFieldTypes( array $aSubject=array() ) {
                    static $_aCheckedCustomFieldTypes;  // cache
                    if ( ! isset( $_aCheckedCustomFieldTypes ) ) {
                        $_aCheckedCustomFieldTypes = $this->oFactory->oUtil->getElementAsArray(
                            $_POST,
                            array(
                                $this->oFactory->oProp->sOptionKey,
                                'compiler', // section id
                                'custom_field_types' // field id
                            ),
                            array()
                        );
                        $_aCheckedCustomFieldTypes = $this->oFactory->oUtil->getArrayMappedRecursive( 'sanitize_text_field', $_aCheckedCustomFieldTypes );
                    }
                    return array_intersect_key(
                        $aSubject,
                        array_filter( $_aCheckedCustomFieldTypes ) // drop 0 values
                    );
                }

    /**
     * @param  string $sComment
     * @return string
     * @since  3.9.0
     */
    public function replyToGetAdditionalHeaderComment( $sComment ) {
        $_aCustomFieldTypeLabels = array();
        foreach( $this->___getCheckedCustomFieldTypeKeys() as $_sCheckedKey ) {
            $_sThisLabel = $this->oFactory->oUtil->getElement( $this->aCustomFieldTypes, array( $_sCheckedKey, 'label' ) );
            $_aCustomFieldTypeLabels[] = strlen( $_sThisLabel ) ? $_sThisLabel : $_sCheckedKey;
        }
        return empty( $_aCustomFieldTypeLabels )
            ? $sComment
            : $sComment . PHP_EOL . ' * Custom Field Types: ' . implode( ', ', $_aCustomFieldTypeLabels );
    }
        /**
         * @return string[]
         * @since  3.9.0
         */
        private function ___getCheckedCustomFieldTypeKeys() {
            $_aChecked = $this->oFactory->oUtil->getElementAsArray(
                $_POST,
                array(
                    $this->oFactory->oProp->sOptionKey,
                    $this->sSectionID,
                    'custom_field_types' // field id
                ),
                array()
            );
            $_aChecked = array_filter( $_aChecked );
            return array_keys( $_aChecked );
        }
}