AdminPageFramework_WPUtility_Option

Complexity

Total Complexity

29

Size/Duplication

Total Lines	369
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	isNetworkAdmin()	0	7	2
A	cleanTransients()	0	19	3
A	cleanTransientsForNetwork()	0	14	2
A	getTransientAsArray()	0	5	1
A	getTransientWithoutCacheAsArray()	0	5	1
A	getTransientWithoutCache()	0	27	3
A	getTransientWithoutCacheForNetwork()	0	24	2
A	deleteTransient()	0	19	1
A	getTransient()	0	25	3
A	setTransient()	0	19	1
A	_getCompatibleTransientKey()	0	21	4
A	getOption()	0	3	1
A	getSiteOption()	0	3	1
A	_getOptionByFunctionName()	0	42	4

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

/**
 * Provides utility methods dealing with the options table which use WordPress functions.
 *
 * @since       3.0.1
 * @extends     AdminPageFramework_Utility
 * @package     AdminPageFramework/Utility
 * @internal
 */
class AdminPageFramework_WPUtility_Option extends AdminPageFramework_WPUtility_File {

    /**
     * @since 3.8.23
     * @return bool
     */
    static public function isNetworkAdmin() {
        if ( isset( self::$_bIsNetworkAdmin ) ) {
            return self::$_bIsNetworkAdmin;
        }
        self::$_bIsNetworkAdmin = is_network_admin();
        return self::$_bIsNetworkAdmin;
    }

    /**
     * Deletes transient items by prefix of a transient key.
     *
     * @since   3.8.23
     * @param   array|string    $asPrefixes
     * @retuen  void
     */
    public static function cleanTransients( $asPrefixes=array( 'apf' ) ) {

        $_aPrefixes = self::getAsArray( $asPrefixes );
        if ( self::isNetworkAdmin() ) {
            self::cleanTransientsForNetwork( $asPrefixes );
            return;
        }
        /**
         * @var wpdb
         */
        $_oWPDB     = $GLOBALS[ 'wpdb' ];
        foreach( $_aPrefixes as $_sPrefix ) {
            $_sSQLQuery = "DELETE FROM `{$_oWPDB->options}` "
                . "WHERE `option_name` "
                . "LIKE ( '_transient_%{$_sPrefix}%' )";    // this also matches _transient_timeout_{prefix}
            $_oWPDB->query( $_sSQLQuery );
        }

    }

    /**
     * @param $asPrefixes
     * @sicne 3.8.23
     * @return void
     */
    public static function cleanTransientsForNetwork( $asPrefixes ) {
        $_aPrefixes = self::getAsArray( $asPrefixes );
        /**
         * @var wpdb
         */
        $_oWPDB     = $GLOBALS[ 'wpdb' ];
        foreach( $_aPrefixes as $_sPrefix ) {
            $_sSQLQuery = "DELETE FROM `{$_oWPDB->sitemeta}` "
                . "WHERE "
                // this matches _site_transient_timeout_{...} as well
                . "`meta_key` LIKE ( '_site_transient_%{$_sPrefix}%' )";
            $_oWPDB->query( $_sSQLQuery );
        }
    }

    /**
     * @param  $sTransientKey
     * @param  mixed $mDefault
     * @return array
     * @since  3.8.23
     */
    static public function getTransientAsArray( $sTransientKey, $mDefault=null ) {
        return self::getAsArray(
            self::getTransient( $sTransientKey, $mDefault )
        );
    }

    /**
     * @param $sTransientKey
     * @param null $mDefault
     * @return array
     * @since  3.8.23
     */
    static public function getTransientWithoutCacheAsArray( $sTransientKey, $mDefault=null ) {
        return self::getAsArray(
            self::getTransientWithoutCache( $sTransientKey, $mDefault )
        );
    }

    /**
     * Retrieve the transient value directly from the database.
     *
     * Similar to the built-in get_transient() method but this one does not use the stored cache in the memory.
     * Used for checking a lock in a sub-routine that should not run simultaneously.
     *
     * @param   string  $sTransientKey
     * @param   mixed   $mDefault
     * @sicne   3.8.23
     * @return  mixed|false `false` on failing to retrieve the transient value.
     */
    static public function getTransientWithoutCache( $sTransientKey, $mDefault=null ) {

        $sTransientKey  = self::_getCompatibleTransientKey( $sTransientKey );
        if ( self::isNetworkAdmin() ) {
            return self::getTransientWithoutCacheForNetwork( $sTransientKey, $mDefault );
        }
        /**
         * @var wpdb $_oWPDB
         */
        $_oWPDB         = $GLOBALS[ 'wpdb' ];
        $_sTableName    = $_oWPDB->options;
        $_sSQLQuery     = "SELECT o1.option_value FROM `{$_sTableName}` o1"
            . " INNER JOIN `{$_sTableName}` o2"
            . " WHERE o1.option_name = %s "
            . " AND o2.option_name = %s "
            . " AND o2.option_value >= UNIX_TIMESTAMP() " // timeout value >= current time
            . " LIMIT 1";
        $_mData = $_oWPDB->get_var(
            $_oWPDB->prepare(
                $_sSQLQuery,
                '_transient_' . $sTransientKey,
                '_transient_timeout_' . $sTransientKey
            )
        );
        return is_null( $_mData ) ? $mDefault : maybe_unserialize( $_mData );

    }

    /**
     * @param   string  $sTransientKey
     * @param   mixed   $mDefault
     * @since   3.8.23
     * @return  mixed
     */
    static public function getTransientWithoutCacheForNetwork($sTransientKey, $mDefault ) {

        /**
         * @var wpdb $_oWPDB
         */
        $_oWPDB         = $GLOBALS[ 'wpdb' ];
        $_sSQLQuery     = "SELECT o1.meta_value FROM `{$_oWPDB->sitemeta}` o1"
            . " INNER JOIN `{$_oWPDB->sitemeta}` o2"
            . " WHERE o1.meta_key = %s "
            . " AND o2.meta_key = %s "
            . " AND o2.site_id = %d "
            . " AND o2.meta_value >= UNIX_TIMESTAMP() " // timeout value >= current time
            . " LIMIT 1";
        $_mData = $_oWPDB->get_var(
            $_oWPDB->prepare(
                $_sSQLQuery,
                '_site_transient_' . $sTransientKey,
                '_site_transient_timeout_' . $sTransientKey,
                get_current_network_id()
            )
        );
        return is_null( $_mData ) ? $mDefault : maybe_unserialize( $_mData );

    }

    /**
     * Stores whether the page is loaded in the network admin or not.
     * @since 3.1.3
     */
    static private $_bIsNetworkAdmin;

    /**
     * Deletes the given transient.
     *
     * @since 3.1.3
     * @param   string  $sTransientKey
     * @return  boolean True if the transient was deleted, false otherwise.
     */
    static public function deleteTransient( $sTransientKey ) {

        // Temporarily disable `$_wp_using_ext_object_cache`.
        global $_wp_using_ext_object_cache;
        $_bWpUsingExtObjectCacheTemp    = $_wp_using_ext_object_cache;
        $_wp_using_ext_object_cache     = false;

        $sTransientKey   = self::_getCompatibleTransientKey( $sTransientKey );
        $_aFunctionNames = array(
            0 => 'delete_transient',
            1 => 'delete_site_transient',
        );
        $_vTransient     = $_aFunctionNames[ ( integer ) self::isNetworkAdmin() ]( $sTransientKey );

        // reset prior value of $_wp_using_ext_object_cache
        $_wp_using_ext_object_cache = $_bWpUsingExtObjectCacheTemp;

        return $_vTransient;
    }
    /**
     * Retrieves the given transient.
     *
     * @since   3.1.3
     * @since   3.1.5   Added the $vDefault parameter.
     * @param   string  $sTransientKey
     * @param   mixed   $vDefault
     * @return  mixed
     */
    static public function getTransient( $sTransientKey, $vDefault=null ) {

        // Temporarily disable $_wp_using_ext_object_cache
        global $_wp_using_ext_object_cache;
        $_bWpUsingExtObjectCacheTemp    = $_wp_using_ext_object_cache;
        $_wp_using_ext_object_cache     = false;

        $sTransientKey   = self::_getCompatibleTransientKey( $sTransientKey );
        $_aFunctionNames = array(
            0 => 'get_transient',
            1 => 'get_site_transient',
        );
        $_vTransient     = $_aFunctionNames[ ( integer ) self::isNetworkAdmin() ]( $sTransientKey );

        // Restore the prior value of `$_wp_using_ext_object_cache`.
        $_wp_using_ext_object_cache = $_bWpUsingExtObjectCacheTemp;

        return null === $vDefault
            ? $_vTransient
            : ( false === $_vTransient
                ? $vDefault
                : $_vTransient
            );

    }
    /**
     * Sets the given transient.
     *
     * @since       3.1.3
     * @return      boolean     True if set; otherwise, false.
     * @param       string      $sTransientKey
     * @param       mixed       $vValue
     * @param       integer     $iExpiration
     */
    static public function setTransient( $sTransientKey, $vValue, $iExpiration=0 ) {

        // Temporarily disable `$_wp_using_ext_object_cache`.
        global $_wp_using_ext_object_cache;
        $_bWpUsingExtObjectCacheTemp    = $_wp_using_ext_object_cache;
        $_wp_using_ext_object_cache     = false;

        $sTransientKey   = self::_getCompatibleTransientKey( $sTransientKey );
        $_aFunctionNames = array(
            0 => 'set_transient',
            1 => 'set_site_transient',
        );
        $_bIsSet = $_aFunctionNames[ ( integer ) self::isNetworkAdmin() ]( $sTransientKey, $vValue, $iExpiration );

        // Restore the prior value of $_wp_using_ext_object_cache
        $_wp_using_ext_object_cache = $_bWpUsingExtObjectCacheTemp;

        return $_bIsSet;
    }
        /**
         * Returns a compatible transient key when it is too long.
         *
         * @since       3.5.9
         * @since       3.8.23  Deprecated the second parameter.
         * @see         https://codex.wordpress.org/Function_Reference/set_transient
         * @param       string      $sSubject      The subject string to format.
         * @param       integer     $iDeprecated   Deprecated. Previously, the allowed character length for the transient key: 40 for network and 45 for regular sites.
         * The method will replace last ending 33 characters if the given string in the first parameter exceeds the limit. So this number must be greater than 33.
         * @return      string
         * @todo it is said as of WordPress 4.3, it will be 255 since the database table column type becomes VARCHAR(255).
         */
        static public function _getCompatibleTransientKey( $sSubject, $iDeprecated=null ) {

            $_iAllowedCharacterLength = isset( $iDeprecated )
                ? $iDeprecated
                : ( self::isNetworkAdmin() ? 40 : 45 );

            // Check if the given string exceeds the length limit.
            if ( strlen( $sSubject ) <= $_iAllowedCharacterLength ) {
                return $sSubject;
            }

            // Otherwise, a too long option key is given.
            $_iPrefixLengthToKeep = $_iAllowedCharacterLength - 33; //  _ + {md5 32 characters}
            $_sPrefixToKeep       = substr(
                $sSubject,
                0, // start position
                $_iPrefixLengthToKeep - 1 // how many characters to extract
            );
            return $_sPrefixToKeep . '_' . md5( $sSubject );

        }

    /**
     * Retrieves the saved option value from the options table with the given option key, field ID, and section ID by giving a function name.
     *
     * @since   3.0.1
     * @since   3.3.0           Added the <var>$aAdditionalOptions</var> parameter.
     * @param   string          $sOptionKey   the option key of the options table.
     * @param   string|array    $asKey        the field id or the array that represents the key structure consisting of the section ID and the field ID.
     * @param   mixed           $vDefault     the default value that will be returned if nothing is stored.
     * @param   array           $aAdditionalOptions     an additional options array to merge with the options array.
     * @return  mixed
     */
    static public function getOption( $sOptionKey, $asKey=null, $vDefault=null, array $aAdditionalOptions=array() ) {
        return self::_getOptionByFunctionName( $sOptionKey, $asKey, $vDefault, $aAdditionalOptions );

It seems like $asKey defined by parameter $asKey on line 312 can also be of type array or string; however, AdminPageFramework_WPUtility_Option::_getOptionByFunctionName() does only seem to accept null, maybe add an additional type check?

    }
    /**
     * Retrieves the saved option value from the site options table with the given option key, field ID, and section ID by giving a function name.
     *
     * @since   3.1.0
     * @since   3.5.3           Added the $aAdditionalOptions parameter.
     * @param   string          $sOptionKey     the option key of the options table.
     * @param   array|string    $asKey          the field id or the array that represents the key structure consisting of the section ID and the field ID.
     * @param   mixed           $vDefault       the default value that will be returned if nothing is stored.
     * @param   array           $aAdditionalOptions     an additional options array to merge with the options array.
     * @remark  Used in the network admin area.
     * @return  mixed
     */
    static public function getSiteOption( $sOptionKey, $asKey=null, $vDefault=null, array $aAdditionalOptions=array() ) {
        return self::_getOptionByFunctionName( $sOptionKey, $asKey, $vDefault, $aAdditionalOptions, 'get_site_option' );

It seems like $asKey defined by parameter $asKey on line 327 can also be of type array or string; however, AdminPageFramework_WPUtility_Option::_getOptionByFunctionName() does only seem to accept null, maybe add an additional type check?

    }

        /**
         * Retrieves the saved option value from the options table
         * with the given option key, field ID, and section ID by giving a function name.
         *
         * @param $sOptionKey
         * @param null $asKey
         * @param null $vDefault
         * @param array $aAdditionalOptions
         * @param string $sFunctionName
         * @return      mixed
         * @since       3.5.3
         */
        static private function _getOptionByFunctionName( $sOptionKey, $asKey=null, $vDefault=null, array $aAdditionalOptions=array(), $sFunctionName='get_option' ) {

            // Entire options
            if ( ! isset( $asKey ) ) {
                $_aOptions = $sFunctionName(
                    $sOptionKey,
                    isset( $vDefault )
                        ? $vDefault
                        : array()
                );;
                return empty( $aAdditionalOptions )
                    ? $_aOptions
                    : self::uniteArrays(
                        $_aOptions,
                        $aAdditionalOptions
                    );
            }

            // Now either the section ID or field ID is given.
            return self::getArrayValueByArrayKeys(

                // subject array
                self::uniteArrays(
                    self::getAsArray(
                        $sFunctionName( $sOptionKey, array() ), // options data
                        true        // preserve empty
                    ),
                    $aAdditionalOptions
                ),

                // dimensional keys
                self::getAsArray(
                    $asKey,
                    true        // preserve empty. e.g. '0' -> array( 0 )
                ),

                // default
                $vDefault

            );

        }

}