AdminPageFrameworkLoader_AdminPage_Tab_ReadMeBase

Complexity

Total Complexity

13

Size/Duplication

Total Lines	127
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	4

Test Coverage

Coverage

0%

4 Methods

Rating	Name	Duplication	Size	Complexity
B	_getReadmeContents()	0	28	3
A	_replyToProcessShortcodes()	0	7	1
B	_replyToProcessShortcode_embed()	0	26	3
B	getContentsByHeader()	0	32	6

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

/**
 * A base class that provides methods to display readme file contents.
 * 
 * @sicne       3.5.3       Extends `AdminPageFrameworkLoader_AdminPage_Tab_Base`.
 * @extends     AdminPageFrameworkLoader_AdminPage_Tab_Base
 */
abstract class AdminPageFrameworkLoader_AdminPage_Tab_ReadMeBase extends AdminPageFrameworkLoader_AdminPage_Tab_Base {

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

As per PSR2, the opening brace for this class should be on a new line.

        
    /**
     * 
     * @since       3.5.3
     */
    protected function _getReadmeContents( $sFilePath, $sTOCTitle, $asSections=array() ) {

Method name "_getReadmeContents" should not be prefixed with an underscore to indicate visibility

        
        $_oWPReadmeParser = new AdminPageFramework_WPReadmeParser( 
            $sFilePath, 
            array( // replacements
                '%PLUGIN_DIR_URL%'  => AdminPageFrameworkLoader_Registry::getPluginURL(),
                '%WP_ADMIN_URL%'    => admin_url(),
            ),
            array( // callbacks
                'content_before_parsing' => array( $this, '_replyToProcessShortcodes' ),
            )
        );    
        $_sContent = '';
        foreach( ( array ) $asSections as $_sSection  ) {
            $_sContent .= $_oWPReadmeParser->getSection( $_sSection );  
        }        
        if ( $sTOCTitle ) {            
            $_oTOC = new AdminPageFramework_TableOfContents(
                $_sContent,
                4,
                $sTOCTitle
            );
            return $_oTOC->get();        
        }
        return ''
         . $_sContent;
        
    }
    
        /**
         * @return      string 
         * @return      3.6.1

The doc-type 3.6.1 could not be parsed: Unknown type name "3.6.1" at position 0. (view supported doc-types)

         */
        public function _replyToProcessShortcodes( $sContent ) {

Method name "_replyToProcessShortcodes" should not be prefixed with an underscore to indicate visibility

            // Register the 'embed' shortcode.
            add_shortcode( 'embed', array( $this, '_replyToProcessShortcode_embed' ) );
            return do_shortcode( $sContent );
            
        }
               
            /**
             * @since       3.6.1
             * @return      string      The generate HTML output.
             */
            public function _replyToProcessShortcode_embed( $aAttributes, $sURL, $sShortcode='' ) {

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

Method name "_replyToProcessShortcode_embed" should not be prefixed with an underscore to indicate visibility

                $sURL   = isset( $aAttributes[ 'src' ] ) ? $aAttributes[ 'src' ] : $sURL;      
                $_sHTML = wp_oembed_get( $sURL );
                
                // If there was a result, return it
                if ( $_sHTML ) {
                    // This filter is documented in wp-includes/class-wp-embed.php
                    return "<div class='video oembed'>" 
                                . apply_filters(
                                    'embed_oembed_html', 
                                    $_sHTML, 
                                    $sURL, 
                                    $aAttributes, 
                                    0
                                )
                        . "</div>";
                }        
                
                // If not found, return the link.
                $_oWPEmbed = new WP_Embed;        
                return "<div class='video oembed'>" 
                        . $_oWPEmbed->maybe_make_link( $sURL )
                    . "</div>";
                
            }         
 
    /**
     * Returns HTML contents divided by heading.
     * 
     * For example,
     * <h3>First Heading</h3>
     * Some text.
     * <h3>Second Heading</h3>
     * Another text.
     * 
     * Will be
     * array(  
     *  array( 'First Heading' => 'Some text', ),
     *  array( 'Second Heading' => 'Another text', ),
     * )
     */
    public function getContentsByHeader( $sContents, $iHeaderNumber=2 ) {
    
        $_aContents = array();
        $_aSplitContents = preg_split( 
            // '/^[\s]*==[\s]*(.+?)[\s]*==/m', 
            '/(<h[' . $iHeaderNumber . ']*[^>]*>.*?<\/h[' . $iHeaderNumber . ']>)/i',
            $sContents,
            -1, 
            PREG_SPLIT_DELIM_CAPTURE|PREG_SPLIT_NO_EMPTY 
        );                   

        foreach( $_aSplitContents as $_iIndex => $_sSplitContent ) {
            if ( ! preg_match( '/<h[' . $iHeaderNumber . ']*[^>]*>(.*?)<\/h[' . $iHeaderNumber . ']>/i', $_sSplitContent , $_aMatches ) ) {
                continue;
            }
        
            if ( ! isset( $_aMatches[ 1 ] ) ) {
                continue;
            }
            if ( isset( $_aSplitContents[ $_iIndex + 1 ] ) )  {
                $_aContents[] = array( 
                    $_aMatches[ 1 ],
                    $_aSplitContents[ $_iIndex + 1 ]
                );
            }
        }
   
        return empty( $_aContents )
            ? array( array( '', $sContents ) ) 
            : $_aContents;
        
    }
 
}

According to PSR2, the closing brace of classes should be placed on the next line directly after the body.