AdminPageFramework_Utility

Complexity

Total Complexity

10

Size/Duplication

Total Lines	115
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	showDeprecationNotice()	0	12	2
A	callBack()	0	10	2
A	hasBeenCalled()	0	7	2
A	getOutputBuffer()	0	9	1
A	getObjectInfo()	0	7	1
A	getAOrB()	0	3	2

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

/**
 * Provides utility methods which do not use WordPress functions.
 *
 * @since       2.0.0
 * @since       3.7.3       Became not abstract for the xdebug max nesting level fatal error workaround.
 * @extends     AdminPageFramework_Utility_SystemInformation
 * @package     AdminPageFramework
 * @subpackage  Utility
 * @internal
 */
class AdminPageFramework_Utility extends AdminPageFramework_Utility_HTMLAttribute {
    
    /**
     * Shows a message for a deprecated item.
     * 
     * Uses the `E_USER_NOTICE` error level so that the message won't be shown if `WP_DEBUG` is `false`.
     * 
     * @remark      This method is overridden by the `AdminPageFramework_FrameworkUtility` class.
     * @return      void
     * @since       3.8.8
     */
    static public function showDeprecationNotice( $sDeprecated, $sAlternative='', $sProgramName='Admin Page Framework' ) {

As per PSR2, the static declaration should come after the visibility declaration.

        trigger_error(
            $sProgramName . ': ' . sprintf(
                $sAlternative
                    ? '<code>%1$s</code> has been deprecated. Use <code>%2$s</code> instead.'
                    : '<code>%1$s</code> has been deprecated.',
                $sDeprecated, // %1$s
                $sAlternative // %2%s
            ),
            E_USER_NOTICE
        );
    }
           
    /**
     * Calls back a user defined function.
     * 
     * This is meant to be used to filter a value using a callback. When a callback is not available, the first parameter element will be returned.
     * so set a default return value to the first element of the parameter array.
     * 
     * @since       3.7.0
     * @since       3.8.5               Moved from `AdminPageFramework_Form_Base`. Added the default value to the `$asParameters`second parameter.
     * @param       callable            $oCallable
     * @param       string|array        $asParameters       Parameters to pass to the callback function.
     */
    public function callBack( $oCallable, $asParameters=array() ) {
        $_aParameters   = self::getAsArray( 
            $asParameters, 
            true // preserve empty
        );
        $_mDefaultValue = self::getElement( $_aParameters, 0 );
        return is_callable( $oCallable )
            ? call_user_func_array( $oCallable, $_aParameters )
            : $_mDefaultValue;
    }          
           
    /**
     * Checks if the given id (usually a function name) has been called throughout the page load.
     * 
     * This is used to check if a function which needs to be done only once has been already called or not.
     * 
     * @since       3.7.0
     * @return      boolean
     */
    static public function hasBeenCalled( $sID ) {

As per PSR2, the static declaration should come after the visibility declaration.

        if ( isset( self::$_aCallStack[ $sID ] ) ) {
            return true;
        }
        self::$_aCallStack[ $sID ] = true;
        return false;
    }
        /**
         * Stores calls.
         * @internal
         */
        static private $_aCallStack = array();    
       
    /**
     * Captures the output buffer of the given function.
     * @since       3.6.3
     * @return      string      The captured output buffer.
     */
    static public function getOutputBuffer( $oCallable, array $aParameters=array() ) {

As per PSR2, the static declaration should come after the visibility declaration.

        
        ob_start(); 
        echo call_user_func_array( $oCallable, $aParameters );
        $_sContent = ob_get_contents(); 
        ob_end_clean(); 
        return $_sContent;        
        
    }
                  
    /**
     * Generates brief object information.
     * 
     * @remark      Meant to be used for the `__toString()` method.
     * @since       3.6.0
     * @return      string
     */   
    static public function getObjectInfo( $oInstance ) {

As per PSR2, the static declaration should come after the visibility declaration.

        
        $_iCount     = count( get_object_vars( $oInstance ) );
        $_sClassName = get_class( $oInstance );
        return '(object) ' . $_sClassName . ': ' . $_iCount . ' properties.';
        
    }
                   
    
    /**
     * Returns one or the other.
     * 
     * Saves one conditional statement.
     * 
     * @remark      Use this only when the performance is not critical.
     * @since       3.5.3
     * @param       boolean|integer|double|string|array|object|resource|NULL        $mValue     The value to evaluate.
     * @param       boolean|integer|double|string|array|object|resource|NULL        $mTrue      The value to return when the first parameter value yields true.
     * @param       boolean|integer|double|string|array|object|resource|NULL        $mTrue      The value to return when the first parameter value yields false.
     * @return      mixed
     */
    static public function getAOrB( $mValue, $mTrue=null, $mFalse=null ) {

As per PSR2, the static declaration should come after the visibility declaration.

        return $mValue ? $mTrue : $mFalse;
    }    
    
}