AdminPageFramework_Utility_HTMLAttribute

Complexity

Total Complexity

18

Size/Duplication

Total Lines	156
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getInlineCSS()	0	7	2
A	generateInlineCSS()	0	3	1
B	getStyleAttribute()	0	25	5
A	generateStyleAttribute()	0	3	1
A	getClassAttribute()	0	20	4
A	generateClassAttribute()	0	7	1
A	getDataAttributeArray()	0	12	4

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

/**
 * Provides utility methods which do not use WordPress functions.
 *
 * @since       DEVVER
 * @subpackage  Utility
 * @internal
 */
abstract class AdminPageFramework_Utility_HTMLAttribute extends AdminPageFramework_Utility_SystemInformation {

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

    /**
     * Generates inline CSS rules from the given array.
     * 
     * For example,
     * <code>
     * array(
     *      'width'  => '32px',
     *      'height' => '32px',
     * )
     * </code>
     * will be
     * <code>
     * 'width: 32px; height: 32px;'
     * </code>
     * 
     * @since       3.6.0
     * @return      string
     */
    static public function getInlineCSS( array $aCSSRules ) {

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

        $_aOutput = array();
        foreach( $aCSSRules as $_sProperty => $_sValue ) {
            $_aOutput[] = $_sProperty . ': ' . $_sValue;
        }
        return implode( '; ', $_aOutput );
    }    
        /**
         * @since           3.2.0
         * @deprecated      3.6.0       Use `getInlineCSS()` instead.
         */
        static public function generateInlineCSS( array $aCSSRules ) {

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

            return self::getInlineCSS( $aCSSRules );
        }
    
    /**
     * Generates a string of inline styles for the style attribute value from multiple arguments.
     * 
     * Duplicated items will be merged.
     * 
     * For example,
     * `
     * getStyleAttribute( array( 'margin-top' => '10px', 'display: inline-block' ), 'float:right; display: none;' )
     * `
     * will generate
     * `
     * margin-top: 10px; display: inline-block; float:right;
     * `
     * @since       3.6.0
     * @return      string
     */
    static public function getStyleAttribute( $asInlineCSSes ) {

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

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

        
        $_aCSSRules = array();
        foreach( array_reverse( func_get_args() ) as $_asCSSRules ) {
            
            // For array, store in the container.
            if ( is_array( $_asCSSRules ) ) {
                $_aCSSRules = array_merge( $_asCSSRules, $_aCSSRules );
                continue;
            }
            
            // At this point, it is a string. Break them down to array elements.
            $__aCSSRules = explode( ';', $_asCSSRules );
            foreach( $__aCSSRules as $_sPair ) {
                $_aCSSPair = explode( ':', $_sPair );
                if ( ! isset( $_aCSSPair[ 0 ], $_aCSSPair[ 1 ] ) ) {
                    continue;
                }
                $_aCSSRules[ $_aCSSPair[ 0 ] ] = $_aCSSPair[ 1 ];
            }
            
        }
        return self::getInlineCSS( array_unique( $_aCSSRules ) );
        
    }
        /**
         * @since           3.3.1
         * @deprecated      3.6.0       Use `getStyleAttribute()` instead.
         */
        static public function generateStyleAttribute( $asInlineCSSes ) {

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

            self::getStyleAttribute( $asInlineCSSes );
        }
    
    /**
     * Generates a string of class selectors from multiple arguments.
     * 
     * For example, 
     * <code>
     * $sClasses = getClassAttribute( array( 'button, button-primary' ), 'remove_button button' );
     * </code>
     * Will generates
     * <code>
     *  button button-primary remove_button
     * </code>
     * 
     * @remark      Duplicated items will be merged.
     * @since       3.6.0
     * @todo        Fix an issue that when a multidimensional array is passed, it causes a warning:  Notice: Array to string conversion.
     * @return      string
     */
    static public function getClassAttribute( /* $asClassSelectors1, $asClassSelectors12, ... */ ) {

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

63% of this comment could be valid code. Did you maybe forget this after debugging?

        
        $_aClasses  = array();
        foreach( func_get_args() as $_asClasses ) {
            if ( ! in_array( gettype( $_asClasses ), array( 'array', 'string' ) ) ) {
                continue;
            }            
            $_aClasses = array_merge( 
                $_aClasses,
                is_array( $_asClasses )
                    ? $_asClasses
                    : explode( ' ', $_asClasses )
            );
        }
        $_aClasses  = array_unique( array_filter( $_aClasses ) );
        
        // @todo examine if it is okay to remove the trim() function below.
        return trim( implode( ' ', $_aClasses ) );
        
    }    
        /**
         * Generates a string of class selectors from multiple arguments.
         * 
         * @since       3.2.0
         * @return      string
         * @deprecated  3.6.0
         */
        static public function generateClassAttribute( /* $asClassSelectors1, $asClassSelectors12 ... */ ) {

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

58% of this comment could be valid code. Did you maybe forget this after debugging?

            $_aParams = func_get_args();
            return call_user_func_array(
                array( __CLASS__ , 'getClassAttribute' ), 
                $_aParams
            );        
        }
    
    /**
     * Returns an array for generating a data attribute from the given associative array.
     * 
     * @since       3.4.0
     * @return      array
     */
    static public function getDataAttributeArray( array $aArray ) {

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

        
        $_aNewArray = array();
        foreach( $aArray as $sKey => $v ) {
            if ( in_array( gettype( $v ), array( 'array', 'object' ) ) ) {
                continue;
            }            
            $_aNewArray[ "data-{$sKey}" ] = $v ? $v : '0';
        }
        return $_aNewArray;
        
    }
    
}