AdminPageFramework_PageMetaBox_Model::__construct() - 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

__construct() B

↳ Parent: AdminPageFramework_PageMetaBox_Model

Complexity

Conditions	2
Paths	2

Size

Total Lines	27
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	27
rs	8.8571
cc	2
eloc	18
nc	2
nop	7

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

/**
 * Provides methods which mainly deal with the stored data for creating meta boxes in admin pages added by the framework.
 * 
 * @abstract
 * @since           3.0.4
 * @package         AdminPageFramework
 * @subpackage      PageMetaBox
 * @internal
 */
abstract class AdminPageFramework_PageMetaBox_Model extends AdminPageFramework_PageMetaBox_Router {
    
    /**
     * A validation callback method.
     * 
     * The user may just override this method instead of defining a `validation_{...}` callback method.
     * 
     * @since       3.4.1
     * @since       3.5.3       Moved from `AdminPageFramework_Factory_Model`.
     * @todo        Examine if the forth parameter of submit info can be added or not.
     * @param       array       $aInput         The submit form data.
     * @param       array       $aOldInput      The previously submit form data stored in the database.
     * @param       object      $oFactory       The page meta box factory object.
     * @param       array       $aSubmitInfo    [3.5.3+] An array holding submit information such as which submit field is pressed.
     * @remark      Not defining this method for backward compatibility to avoid strict standard warnings of PHP.
     */
    // public function validate( $aInput, $aOldInput, $oFactory, $aSubmitInfo ) {
        // return $aInput;
    // }              
        
    /**
     * Sets up validation hooks.
     * 
     * @since       3.3.0
     * @since       3.7.9       Renamed from `_setUpValidationHooks`. Changed the scope to public from protected.
     * @callback    action      set_up_{instantiated class name}
     * @internal
     */
    public function _replyToSetUpValidationHooks( $oScreen ) {

        // Validation hooks
        foreach( $this->oProp->aPageSlugs as $_sIndexOrPageSlug => $_asTabArrayOrPageSlug ) {
            
            if ( is_scalar( $_asTabArrayOrPageSlug ) ) {
                $_sPageSlug = $_asTabArrayOrPageSlug;
                add_filter( "validation_saved_options_without_dynamic_elements_{$_sPageSlug}", array( $this, '_replyToFilterPageOptionsWODynamicElements' ), 10, 2 );  // 3.4.1+
                add_filter( "validation_{$_sPageSlug}", array( $this, '_replyToValidateOptions' ), 10, 4 );
                add_filter( "options_update_status_{$_sPageSlug}", array( $this, '_replyToModifyOptionsUpdateStatus' ) );
                continue;
            }
            
            // At this point, the array key is the page slug. It means the user specified the tab(s).
            $_sPageSlug = $_sIndexOrPageSlug;
            $_aTabs     = $_asTabArrayOrPageSlug;
            foreach( $_aTabs as $_sTabSlug ) {
                add_filter( "validation_{$_sPageSlug}_{$_sTabSlug}", array( $this, '_replyToValidateOptions' ), 10, 4 );
                add_filter( "validation_saved_options_without_dynamic_elements_{$_sPageSlug}_{$_sTabSlug}", array( $this, '_replyToFilterPageOptionsWODynamicElements' ), 10, 2 ); // 3.4.1+
                add_filter( "options_update_status_{$_sPageSlug}_{$_sTabSlug}", array( $this, '_replyToModifyOptionsUpdateStatus' ) );
            }
            
        }
    
    }        
                    
    /**
     * Adds the defined meta box.
     * 
     * @internal
     * @since       3.0.0
     * @since       3.7.10      Changed the name from `_replyToAddMetaBox()`.
     * @remark      Before this method is called, the pages and in-page tabs need to be registered already.
     * @return      void
     * @callback    action      add_meta_boxes
     */ 
    public function _replyToRegisterMetaBoxes( $sPageHook='' ) {

        foreach( $this->oProp->aPageSlugs as $_sKey => $_asPage ) {
            if ( is_string( $_asPage ) )  {
                $this->_registerMetaBox( $_asPage );
                continue;
            }            
            $this->_registerMetaBoxes( $_sKey, $_asPage );
        }
    }    
        /**
         * Adds meta boxes.
         * 
         * @since       3.7.0
         * @since       3.7.10      Changed the name from `_addMetaBoxes()`.
         * @internal
         * @return      void
         */
        private function _registerMetaBoxes( $sPageSlug, $asPage ) {
            foreach( $this->oUtil->getAsArray( $asPage ) as $_sTabSlug ) {
                if ( ! $this->oProp->isCurrentTab( $_sTabSlug ) ) { 
                    continue; 
                }
                $this->_registerMetaBox( $sPageSlug );
            }         
        }
        /**
         * Adds meta box with the given page slug.
         * 
         * @since       3.0.0
         * @since       3.7.10      Changed the name from `_addMetaBox()`.
         * @internal
         * @uses        add_meta_box()
         * @return      void
         */
        private function _registerMetaBox( $sPageSlug ) {
            add_meta_box( 
                $this->oProp->sMetaBoxID,                       // id
                $this->oProp->sTitle,                           // title
                array( $this, '_replyToPrintMetaBoxContents' ), // callback
                $this->oProp->_getScreenIDOfPage( $sPageSlug ), // screen ID
                $this->oProp->sContext,                         // context
                $this->oProp->sPriority,                        // priority
                null                                            // argument (deprecated)
            );
        }

    /**
     * Filters the page option array.
     * 
     * This is triggered from the system validation method of the main Admin Page Framework factory class with the `validation_saved_options_{page slug}` filter hook.
     * 
     * @since       3.0.0
     * @param       array       $aPageOptions
     * @deprecated  3.4.1
     * @internal
     */
    public function _replyToFilterPageOptions( $aPageOptions ) {
        return $aPageOptions;
    }
    /**
     * Filters the array of the options without dynamic elements.
     * 
     * @since       3.4.1       Deprecated `_replyToFilterPageOptions()`.
     * @callback    filter      validation_saved_options_without_dynamic_elements_{$_sPageSlug}
     * @callback    filter      validation_saved_options_without_dynamic_elements_{page slug}_{tab slug}
     * @internal
     */
    public function _replyToFilterPageOptionsWODynamicElements( $aOptionsWODynamicElements, $oFactory ) {

        return $this->oForm->dropRepeatableElements( $aOptionsWODynamicElements );
    }
    
    /**
     * Validates the submitted option values.
     * 
     * This method is triggered with the `validation_{page slug}` or `validation_{page slug}_{tab slug}` method of the main Admin Page Framework factory class.
     * 
     * @internal
     * @callback    filter      validation_{page slug}, validation_{page slug}_{tab slug}
     * @sicne       3.0.0       
     * @param       array       $aNewPageOptions        The array holing the field values of the page sent from the framework page class (the main class).
     * @param       array       $aOldPageOptions        The array holing the saved options of the page. Note that this will be empty if non of generic page fields are created.
     * @param       object      $oAdminPage             The admin page factory class object.
     * @param       array       $aSubmitInfo            An array containing submit information such as a pressed submit field ID.
     * @return      array       The validated form input data.
     */
    public function _replyToValidateOptions( $aNewPageOptions, $aOldPageOptions, $oAdminPage, $aSubmitInfo ) {
// 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);
    }
}
        
        $_aNewMetaBoxInputs      = $this->oForm->getSubmittedData( $_POST );
        $_aOldMetaBoxInputs      = $this->oUtil->castArrayContents( 
            $this->oForm->getDataStructureFromAddedFieldsets(),   // model
            $aOldPageOptions        // data source
        );

        // Apply filters - third party scripts will have access to the input.
        $_aNewMetaBoxInputsRaw   = $_aNewMetaBoxInputs; // copy one for validation errors.
        $_aNewMetaBoxInputs      = call_user_func_array( 
            array( $this, 'validate' ),     // triggers __call()
            array( $_aNewMetaBoxInputs, $_aOldMetaBoxInputs, $this, $aSubmitInfo ) 
        ); // 3.5.3+
        $_aNewMetaBoxInputs      = $this->oUtil->addAndApplyFilters( 
            $this, 
            "validation_{$this->oProp->sClassName}", 
            $_aNewMetaBoxInputs, 
            $_aOldMetaBoxInputs, 
            $this,
            $aSubmitInfo
        );
    
        // If there are validation errors. set the last input.
        if ( $this->hasFieldError() ) {
            $this->setLastInputs( $_aNewMetaBoxInputsRaw );           
        }    
    
        // Now merge the input values with the passed page options, and plus the old data to cover different in-page tab field options.
        return $this->oUtil->uniteArrays( 
            $_aNewMetaBoxInputs, 
            $aNewPageOptions
        );       
                        
    }

    /**
     * Modifies the options update status array.
     * 
     * This is to insert the 'field_errors' key into the options update status array when there is a field error.
     * 
     * @internal
     * @since       3.4.1
     * @callback    filter      options_update_status_{page slug}
     * @callback    filter      options_update_status_{page slug}_{tab slug}
     * @return      array
     */
    public function _replyToModifyOptionsUpdateStatus( $aStatus ) {
        
        if ( ! $this->hasFieldError() ) {
            return $aStatus;
        }
        return array( 
                'field_errors' => true 
            ) 
            + $this->oUtil->getAsArray( $aStatus );
        
    }
    
    /**
     * Called when the form object tries to set the form data from the database.
     * 
     * @callback    form        `saved_data`    
     * @remark      The `oOptions` property will be automatically set with the overload method.
     * @remark      Redefine (override) this method completely because the parent meta box factory class
     * has this method and its own way to retrieve form data.
     * @return      array       The saved form data.
     * @since       3.7.0
     */
    public function _replyToGetSavedFormData() {
        $_aPageOptions = $this->oUtil->addAndApplyFilter(
            $this, // the caller factory object
            'options_' . $this->oProp->sClassName,
            $this->oProp->oAdminPage->oProp->aOptions  
        );
        return $this->oUtil->castArrayContents( 
            $this->oForm->getDataStructureFromAddedFieldsets(),   // model
            $_aPageOptions        // data source
        );        
    }    
    
       /**
         * Extracts meta box form fields options array from the given options array of an admin page.
         * 
         * @since       3.5.6
         * @return      array       The extracted options array.
         * @internal
         * @deprecated  3.7.0
         */
        private function _getPageMetaBoxOptionsFromPageOptions( array $aPageOptions, array $aFieldsets ) {
     
            $_aOptions = array();
            foreach( $aFieldsets as $_sSectionID => $_aFieldsets ) {
                if ( '_default' === $_sSectionID  ) {
                    foreach( $_aFieldsets as $_aField ) {
                        if ( array_key_exists( $_aField[ 'field_id' ], $aPageOptions ) ) {
                            $_aOptions[ $_aField[ 'field_id' ] ] = $aPageOptions[ $_aField[ 'field_id' ] ];
                        }
                    }
                }
                if ( array_key_exists( $_sSectionID, $aPageOptions ) ) {
                    $_aOptions[ $_sSectionID ] = $aPageOptions[ $_sSectionID ];
                }
            }       
            return $_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			* Provides methods which mainly deal with the stored data for creating meta boxes in admin pages added by the framework.
11			*
12			* @abstract
13			* @since 3.0.4
14			* @package AdminPageFramework
15			* @subpackage PageMetaBox
16			* @internal
17			*/
18			abstract class AdminPageFramework_PageMetaBox_Model extends AdminPageFramework_PageMetaBox_Router {
19
20			/**
21			* A validation callback method.
22			*
23			* The user may just override this method instead of defining a `validation_{...}` callback method.
24			*
25			* @since 3.4.1
26			* @since 3.5.3 Moved from `AdminPageFramework_Factory_Model`.
27			* @todo Examine if the forth parameter of submit info can be added or not.
28			* @param array $aInput The submit form data.
29			* @param array $aOldInput The previously submit form data stored in the database.
30			* @param object $oFactory The page meta box factory object.
31			* @param array $aSubmitInfo [3.5.3+] An array holding submit information such as which submit field is pressed.
32			* @remark Not defining this method for backward compatibility to avoid strict standard warnings of PHP.
33			*/
34			// public function validate( $aInput, $aOldInput, $oFactory, $aSubmitInfo ) {
35			// return $aInput;
36			// }
37
38			/**
39			* Sets up validation hooks.
40			*
41			* @since 3.3.0
42			* @since 3.7.9 Renamed from `_setUpValidationHooks`. Changed the scope to public from protected.
43			* @callback action set_up_{instantiated class name}
44			* @internal
45			*/
46			public function _replyToSetUpValidationHooks( $oScreen ) {
47
48			// Validation hooks
49			foreach( $this->oProp->aPageSlugs as $_sIndexOrPageSlug => $_asTabArrayOrPageSlug ) {
50
51			if ( is_scalar( $_asTabArrayOrPageSlug ) ) {
52			$_sPageSlug = $_asTabArrayOrPageSlug;
53			add_filter( "validation_saved_options_without_dynamic_elements_{$_sPageSlug}", array( $this, '_replyToFilterPageOptionsWODynamicElements' ), 10, 2 ); // 3.4.1+
54			add_filter( "validation_{$_sPageSlug}", array( $this, '_replyToValidateOptions' ), 10, 4 );
55			add_filter( "options_update_status_{$_sPageSlug}", array( $this, '_replyToModifyOptionsUpdateStatus' ) );
56			continue;
57			}
58
59			// At this point, the array key is the page slug. It means the user specified the tab(s).
60			$_sPageSlug = $_sIndexOrPageSlug;
61			$_aTabs = $_asTabArrayOrPageSlug;
62			foreach( $_aTabs as $_sTabSlug ) {
63			add_filter( "validation_{$_sPageSlug}_{$_sTabSlug}", array( $this, '_replyToValidateOptions' ), 10, 4 );
64			add_filter( "validation_saved_options_without_dynamic_elements_{$_sPageSlug}_{$_sTabSlug}", array( $this, '_replyToFilterPageOptionsWODynamicElements' ), 10, 2 ); // 3.4.1+
65			add_filter( "options_update_status_{$_sPageSlug}_{$_sTabSlug}", array( $this, '_replyToModifyOptionsUpdateStatus' ) );
66			}
67
68			}
69
70			}
71
72			/**
73			* Adds the defined meta box.
74			*
75			* @internal
76			* @since 3.0.0
77			* @since 3.7.10 Changed the name from `_replyToAddMetaBox()`.
78			* @remark Before this method is called, the pages and in-page tabs need to be registered already.
79			* @return void
80			* @callback action add_meta_boxes
81			*/
82			public function _replyToRegisterMetaBoxes( $sPageHook='' ) {
			0 ignored issues – show Unused Code introduced 2015-11-21 18:44 UTC by Report Bug Copy Issue Report The parameter `$sPageHook` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
83			foreach( $this->oProp->aPageSlugs as $_sKey => $_asPage ) {
84			if ( is_string( $_asPage ) ) {
85			$this->_registerMetaBox( $_asPage );
86			continue;
87			}
88			$this->_registerMetaBoxes( $_sKey, $_asPage );
89			}
90			}
91			/**
92			* Adds meta boxes.
93			*
94			* @since 3.7.0
95			* @since 3.7.10 Changed the name from `_addMetaBoxes()`.
96			* @internal
97			* @return void
98			*/
99			private function _registerMetaBoxes( $sPageSlug, $asPage ) {
100			foreach( $this->oUtil->getAsArray( $asPage ) as $_sTabSlug ) {
101			if ( ! $this->oProp->isCurrentTab( $_sTabSlug ) ) {
102			continue;
103			}
104			$this->_registerMetaBox( $sPageSlug );
105			}
106			}
107			/**
108			* Adds meta box with the given page slug.
109			*
110			* @since 3.0.0
111			* @since 3.7.10 Changed the name from `_addMetaBox()`.
112			* @internal
113			* @uses add_meta_box()
114			* @return void
115			*/
116			private function _registerMetaBox( $sPageSlug ) {
117			add_meta_box(
118			$this->oProp->sMetaBoxID, // id
119			$this->oProp->sTitle, // title
120			array( $this, '_replyToPrintMetaBoxContents' ), // callback
121			$this->oProp->_getScreenIDOfPage( $sPageSlug ), // screen ID
122			$this->oProp->sContext, // context
123			$this->oProp->sPriority, // priority
124			null // argument (deprecated)
125			);
126			}
127
128			/**
129			* Filters the page option array.
130			*
131			* This is triggered from the system validation method of the main Admin Page Framework factory class with the `validation_saved_options_{page slug}` filter hook.
132			*
133			* @since 3.0.0
134			* @param array $aPageOptions
135			* @deprecated 3.4.1
136			* @internal
137			*/
138			public function _replyToFilterPageOptions( $aPageOptions ) {
139			return $aPageOptions;
140			}
141			/**
142			* Filters the array of the options without dynamic elements.
143			*
144			* @since 3.4.1 Deprecated `_replyToFilterPageOptions()`.
145			* @callback filter validation_saved_options_without_dynamic_elements_{$_sPageSlug}
146			* @callback filter validation_saved_options_without_dynamic_elements_{page slug}_{tab slug}
147			* @internal
148			*/
149			public function _replyToFilterPageOptionsWODynamicElements( $aOptionsWODynamicElements, $oFactory ) {
			0 ignored issues – show Unused Code introduced 2015-11-21 18:44 UTC by Report Bug Copy Issue Report The parameter `$oFactory` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
150			return $this->oForm->dropRepeatableElements( $aOptionsWODynamicElements );
151			}
152
153			/**
154			* Validates the submitted option values.
155			*
156			* This method is triggered with the `validation_{page slug}` or `validation_{page slug}_{tab slug}` method of the main Admin Page Framework factory class.
157			*
158			* @internal
159			* @callback filter validation_{page slug}, validation_{page slug}_{tab slug}
160			* @sicne 3.0.0
161			* @param array $aNewPageOptions The array holing the field values of the page sent from the framework page class (the main class).
162			* @param array $aOldPageOptions The array holing the saved options of the page. Note that this will be empty if non of generic page fields are created.
163			* @param object $oAdminPage The admin page factory class object.
164			* @param array $aSubmitInfo An array containing submit information such as a pressed submit field ID.
165			* @return array The validated form input data.
166			*/
167			public function _replyToValidateOptions( $aNewPageOptions, $aOldPageOptions, $oAdminPage, $aSubmitInfo ) {
			0 ignored issues – show Coding Style introduced 2015-11-21 18:44 UTC by Report Bug Copy Issue Report `_replyToValidateOptions` uses the super-global variable `$_POST` 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...
168
169			$_aNewMetaBoxInputs = $this->oForm->getSubmittedData( $_POST );
170			$_aOldMetaBoxInputs = $this->oUtil->castArrayContents(
171			$this->oForm->getDataStructureFromAddedFieldsets(), // model
172			$aOldPageOptions // data source
173			);
174
175			// Apply filters - third party scripts will have access to the input.
176			$_aNewMetaBoxInputsRaw = $_aNewMetaBoxInputs; // copy one for validation errors.
177			$_aNewMetaBoxInputs = call_user_func_array(
178			array( $this, 'validate' ), // triggers __call()
179			array( $_aNewMetaBoxInputs, $_aOldMetaBoxInputs, $this, $aSubmitInfo )
180			); // 3.5.3+
181			$_aNewMetaBoxInputs = $this->oUtil->addAndApplyFilters(
182			$this,
183			"validation_{$this->oProp->sClassName}",
184			$_aNewMetaBoxInputs,
185			$_aOldMetaBoxInputs,
186			$this,
187			$aSubmitInfo
188			);
189
190			// If there are validation errors. set the last input.
191			if ( $this->hasFieldError() ) {
192			$this->setLastInputs( $_aNewMetaBoxInputsRaw );
193			}
194
195			// Now merge the input values with the passed page options, and plus the old data to cover different in-page tab field options.
196			return $this->oUtil->uniteArrays(
197			$_aNewMetaBoxInputs,
198			$aNewPageOptions
199			);
200
201			}
202
203			/**
204			* Modifies the options update status array.
205			*
206			* This is to insert the 'field_errors' key into the options update status array when there is a field error.
207			*
208			* @internal
209			* @since 3.4.1
210			* @callback filter options_update_status_{page slug}
211			* @callback filter options_update_status_{page slug}_{tab slug}
212			* @return array
213			*/
214			public function _replyToModifyOptionsUpdateStatus( $aStatus ) {
215
216			if ( ! $this->hasFieldError() ) {
217			return $aStatus;
218			}
219			return array(
220			'field_errors' => true
221			)
222			+ $this->oUtil->getAsArray( $aStatus );
223
224			}
225
226			/**
227			* Called when the form object tries to set the form data from the database.
228			*
229			* @callback form `saved_data`
230			* @remark The `oOptions` property will be automatically set with the overload method.
231			* @remark Redefine (override) this method completely because the parent meta box factory class
232			* has this method and its own way to retrieve form data.
233			* @return array The saved form data.
234			* @since 3.7.0
235			*/
236			public function _replyToGetSavedFormData() {
237			$_aPageOptions = $this->oUtil->addAndApplyFilter(
238			$this, // the caller factory object
239			'options_' . $this->oProp->sClassName,
240			$this->oProp->oAdminPage->oProp->aOptions
241			);
242			return $this->oUtil->castArrayContents(
243			$this->oForm->getDataStructureFromAddedFieldsets(), // model
244			$_aPageOptions // data source
245			);
246			}
247
248			/**
249			* Extracts meta box form fields options array from the given options array of an admin page.
250			*
251			* @since 3.5.6
252			* @return array The extracted options array.
253			* @internal
254			* @deprecated 3.7.0
255			*/
256			private function _getPageMetaBoxOptionsFromPageOptions( array $aPageOptions, array $aFieldsets ) {
257
258			$_aOptions = array();
259			foreach( $aFieldsets as $_sSectionID => $_aFieldsets ) {
260			if ( '_default' === $_sSectionID ) {
261			foreach( $_aFieldsets as $_aField ) {
262			if ( array_key_exists( $_aField[ 'field_id' ], $aPageOptions ) ) {
263			$_aOptions[ $_aField[ 'field_id' ] ] = $aPageOptions[ $_aField[ 'field_id' ] ];
264			}
265			}
266			}
267			if ( array_key_exists( $_sSectionID, $aPageOptions ) ) {
268			$_aOptions[ $_sSectionID ] = $aPageOptions[ $_sSectionID ];
269			}
270			}
271			return $_aOptions;
272
273			}
274
275			}
276

michaeluno / admin-page-framework

Branch — master (163d15)

__construct() B

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like