AdminPageFramework_Property_NetworkAdmin::updateOption() - Code Metrics - Inspection of "Daily Inspection: - Changed the version to 3.7.12..." - michaeluno/admin-page-framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (163d15)

unknown

created 2016-03-01 18:52 UTC

teOption() A

↳ Parent: AdminPageFramework_Property_network_admin_page

Complexity

Conditions	3
Paths	2

Size

Total Lines	13
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	13
rs	9.4285
cc	3
eloc	8
nc	2
nop	1

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

/**
 * Stores properties of a network admin object.
 * 
 * @since       3.1.0
 * @package     AdminPageFramework
 * @subpackage  Property
 * @extends     AdminPageFramework_Property_admin_page
 * @internal
 */
class AdminPageFramework_Property_network_admin_page extends AdminPageFramework_Property_admin_page {
    
    /**
     * Defines the property type.
     * 
     * @since       3.1.0
     * @internal
     */
    public $_sPropertyType = 'network_admin_page';
    
    /**
     * Defines the fields type.
     * 
     * @since       3.1.0
     */
    public $sStructureType = 'network_admin_page';
    
    /**
     * Indicates the action hook to display setting notices.
     * @since       3.7.9
     */
    public $sSettingNoticeActionHook = 'network_admin_notices';

    /**
     * Returns the option array.
     * 
     * @since       3.1.0
     * @internal
     */
    protected function _getOptions() {
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
        
        return $this->addAndApplyFilter( 
            $this->getElement( // the caller object
                $GLOBALS, 
                array( 'aAdminPageFramework', 'aPageClasses', $this->sClassName ) 
            ),
            'options_' . $this->sClassName, // options_{instantiated class name}
            $this->sOptionKey 
                ? get_site_option( $this->sOptionKey, array() ) 
                : array()
        );
        
    }
    
    /**
     * Utility methods
     */
    /**
     * Saves the options into the database.
     * 
     * @since       3.1.0
     * @since       3.1.1       Made it return a boolean value.
     * @return      boolean     True if saved; otherwise, false.
     */
    public function updateOption( $aOptions=null ) {
        
        if ( $this->_bDisableSavingOptions ) {
            return;
        }        
        return update_site_option( 
            $this->sOptionKey, 
            $aOptions !== null 
                ? $aOptions 
                : $this->aOptions 
            );
        
    }    
    
}


1			<?php
2			/**
3			* Admin Page Framework
4			*
5			* http://en.michaeluno.jp/admin-page-framework/
6			* Copyright (c) 2013-2016 Michael Uno; Licensed MIT
7			*
8			*/
9
10			/**
11			* Stores properties of a network admin object.
12			*
13			* @since 3.1.0
14			* @package AdminPageFramework
15			* @subpackage Property
16			* @extends AdminPageFramework_Property_admin_page
17			* @internal
18			*/
19			class AdminPageFramework_Property_network_admin_page extends AdminPageFramework_Property_admin_page {
20
21			/**
22			* Defines the property type.
23			*
24			* @since 3.1.0
25			* @internal
26			*/
27			public $_sPropertyType = 'network_admin_page';
28
29			/**
30			* Defines the fields type.
31			*
32			* @since 3.1.0
33			*/
34			public $sStructureType = 'network_admin_page';
35
36			/**
37			* Indicates the action hook to display setting notices.
38			* @since 3.7.9
39			*/
40			public $sSettingNoticeActionHook = 'network_admin_notices';
41
42			/**
43			* Returns the option array.
44			*
45			* @since 3.1.0
46			* @internal
47			*/
48			protected function _getOptions() {
			0 ignored issues – show Coding Style introduced 2015-11-21 18:44 UTC by Report Bug Copy Issue Report `_getOptions` uses the super-global variable `$GLOBALS` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
49
50			return $this->addAndApplyFilter(
51			$this->getElement( // the caller object
52			$GLOBALS,
53			array( 'aAdminPageFramework', 'aPageClasses', $this->sClassName )
54			),
55			'options_' . $this->sClassName, // options_{instantiated class name}
56			$this->sOptionKey
57			? get_site_option( $this->sOptionKey, array() )
58			: array()
59			);
60
61			}
62
63			/**
64			* Utility methods
65			*/
66			/**
67			* Saves the options into the database.
68			*
69			* @since 3.1.0
70			* @since 3.1.1 Made it return a boolean value.
71			* @return boolean True if saved; otherwise, false.
72			*/
73			public function updateOption( $aOptions=null ) {
74
75			if ( $this->_bDisableSavingOptions ) {
76			return;
77			}
78			return update_site_option(
79			$this->sOptionKey,
80			$aOptions !== null
81			? $aOptions
82			: $this->aOptions
83			);
84
85			}
86
87			}
88

michaeluno / admin-page-framework

Branch — master (163d15)

teOption() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like