AdminPageFrameworkLoader_AdminPage_Help_Example::getReadMeContents() - Code Metrics - Inspection of "- Advanced the version to help identify the change..." - michaeluno/admin-page-framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — dev (a3767f)

by Michael

created 2015-11-23 09:51 UTC

getReadMeContents() A

↳ Parent: AdminPageFrameworkLoader_AdminPage_Help_Example

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Metric	Value
dl	0
loc	7
rs	9.4286
ccs	0
cts	7
cp	0
cc	1
eloc	5
nc	1
nop	0
crap	2

<?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
 * 
 */

/**
 * Adds a tab of the set page to the loader plugin.
 * 
 * @since       3.5.0    
 */
class AdminPageFrameworkLoader_AdminPage_Help_Example extends AdminPageFrameworkLoader_AdminPage_Tab_ReadMeBase {
namespace YourVendor;

class YourClass { }
        
    /**
     * Triggered when the tab is loaded.
     */
    public function replyToLoadTab( $oAdminPage ) {
            
        $_aItems     = $this->getContentsByHeader( $this->getReadmeContents(), 3 );
        $_iLastIndex = count( $_aItems ) - 1;
        foreach( $_aItems as $_iIndex => $_aContent ) {

            $_oParser   = new AdminPageFramework_WPReadmeParser;
            $_oParser->setText( $_aContent[ 1 ] );
            $_sContent  = $_oParser->get();
            $oAdminPage->addSettingSections(    
                $this->sPageSlug, // the target page slug  
                array(
                    'section_id'        => 'examples_' . $_iIndex,             
                    'title'             => $_aContent[ 0 ],
                    'collapsible'       => array(
                        'toggle_all_button' => $_iLastIndex === $_iIndex 
                            ? array( 'bottom-right' )
                            : ( 0 === $_iIndex
                                ? array( 'top-right' )
                                : false
                            ),
                    ),
                    'content'           => $_sContent,
                            
                )
            );              
            
        }        

    }
        /**
         * @return      string
         */
        private function getReadMeContents()  {       
            return $this->_getReadmeContents( 
                AdminPageFrameworkLoader_Registry::$sDirPath . '/asset/text/examples.txt',
                '',
                array( 'Examples' )
            );     
        }       
    
}
// Incorrect placement according to PSR2
class MyClass
{
    public function foo()
    {

    }
    // This blank line is not allowed.

}

// Correct
class MyClass
{
    public function foo()
    {

    } // No blank lines after this line.
}

1			<?php
2			/**
3			* Admin Page Framework Loader
4			*
5			* Demonstrates the usage of Admin Page Framework.
6			*
7			* http://en.michaeluno.jp/admin-page-framework/
8			* Copyright (c) 2013-2015 Michael Uno; Licensed GPLv2
9			*
10			*/
11
12			/**
13			* Adds a tab of the set page to the loader plugin.
14			*
15			* @since 3.5.0
16			*/
17			class AdminPageFrameworkLoader_AdminPage_Help_Example extends AdminPageFrameworkLoader_AdminPage_Tab_ReadMeBase {
			2 ignored issues – show Coding Style Compatibility introduced 2015-11-21 18:44 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history... Coding Style introduced 2015-11-21 18:44 UTC by Report Bug Copy Issue Report As per PSR2, the opening brace for this class should be on a new line. Loading history...
18
19			/**
20			* Triggered when the tab is loaded.
21			*/
22			public function replyToLoadTab( $oAdminPage ) {
23
24			$_aItems = $this->getContentsByHeader( $this->getReadmeContents(), 3 );
25			$_iLastIndex = count( $_aItems ) - 1;
26			foreach( $_aItems as $_iIndex => $_aContent ) {
27
28			$_oParser = new AdminPageFramework_WPReadmeParser;
29			$_oParser->setText( $_aContent[ 1 ] );
30			$_sContent = $_oParser->get();
31			$oAdminPage->addSettingSections(
32			$this->sPageSlug, // the target page slug
33			array(
34			'section_id' => 'examples_' . $_iIndex,
35			'title' => $_aContent[ 0 ],
36			'collapsible' => array(
37			'toggle_all_button' => $_iLastIndex === $_iIndex
38			? array( 'bottom-right' )
39			: ( 0 === $_iIndex
40			? array( 'top-right' )
41			: false
42			),
43			),
44			'content' => $_sContent,
45
46			)
47			);
48
49			}
50
51			}
52			/**
53			* @return string
54			*/
55			private function getReadMeContents() {
56			return $this->_getReadmeContents(
57			AdminPageFrameworkLoader_Registry::$sDirPath . '/asset/text/examples.txt',
58			'',
59			array( 'Examples' )
60			);
61			}
62
63			}
			1 ignored issue – show Coding Style introduced 2015-11-21 18:44 UTC by Report Bug Copy Issue Report According to PSR2, the closing brace of classes should be placed on the next line directly after the body. Below you find some examples: // Incorrect placement according to PSR2 class MyClass { public function foo() { } // This blank line is not allowed. } // Correct class MyClass { public function foo() { } // No blank lines after this line. } Loading history...

michaeluno / admin-page-framework

Branch — dev (a3767f)

getReadMeContents() A

Complexity

Size

Duplication

Code Coverage

Duplication Side-by-Side

Filter issues like