AdminPageFramework_Widget_Factory

Complexity

Total Complexity

15

Size/Duplication

Total Lines	278
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

8 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	28	1
B	widget()	0	26	1
B	_getTitle()	0	24	3
A	update()	0	14	1
B	form()	0	31	1
A	_loadFrameworkFactory()	0	13	1
A	_replyToGetFieldName()	0	14	3
A	_replyToGetFieldInputName()	0	20	4

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

/**
 * A back-end factory class that redirects callback methods to the main widget class.
 * 
 * @abstract
 * @since       3.2.0
 * @package     AdminPageFramework
 * @subpackage  Widget
 * @extends     WP_Widget
 * @internal
 */
class AdminPageFramework_Widget_Factory extends WP_Widget {

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

    
    /**
     * Sets up internal properties.
     * 
     * @since       3.2.0
     * @return      void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
	public function __construct( $oCaller, $sWidgetTitle, array $aArguments=array() ) {
		
        $aArguments = $aArguments 
            + array( 
                'classname'     => 'admin_page_framework_widget',
                'description'   => '',  
            );
            
		parent::__construct( 
            $oCaller->oProp->sClassName,  // base id 
            $sWidgetTitle,      // widget title
            $aArguments         // widget arguments
        );
        $this->oCaller = $oCaller;
    
        // Set up callbacks for field element outputs such as for name and it attributes.
        $this->oCaller->oProp->aFormCallbacks = array( 
            'hfID'          => array( $this, 'get_field_id' ),    // defined in the WP_Widget class.  
            'hfTagID'       => array( $this, 'get_field_id' ),    // defined in the WP_Widget class.  
            'hfName'        => array( $this, '_replyToGetFieldName' ),  // defined in the WP_Widget class.  
            'hfInputName'   => array( $this, '_replyToGetFieldInputName' ),
            // 'hfClass'       => array( $this, '_replyToAddClassSelector' ),

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

            // 'hfNameFlat'    => array( $this, '_replyToGetFlatFieldName' ), // @deprecated 3.6.0+ the same as the framework factory method.

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

        ) + $this->oCaller->oProp->aFormCallbacks;
        $this->oCaller->oForm->aCallbacks = $this->oCaller->oProp->aFormCallbacks + $this->oCaller->oForm->aCallbacks;
        
        
	}
    
    /**
     * Displays the widget contents in the front end.
     * 
     * @since       3.2.0
     * @since       3.5.9       Changed the timing of the hooks (do_{...} and content_{...} ) to allow the user to decide 
     * whether the title should be visible or not depending on the content.
     * @return      void
     */
	public function widget( $aArguments, $aFormData ) {
           
        echo $aArguments[ 'before_widget' ];
        
        $this->oCaller->oUtil->addAndDoActions( 
            $this->oCaller, 
            'do_' . $this->oCaller->oProp->sClassName, 
            $this->oCaller
        );
       
        $_sContent = $this->oCaller->oUtil->addAndApplyFilters(
            $this->oCaller, 
            "content_{$this->oCaller->oProp->sClassName}", 
            $this->oCaller->content( '', $aArguments, $aFormData ),
            $aArguments,
            $aFormData
        );    
        
        // 3.5.9+ Moved this after the content_{...} filter hook so that the user can decide whether the title shoudl be visible or not.
        echo $this->_getTitle( $aArguments, $aFormData );

        echo $_sContent;
        
		echo $aArguments[ 'after_widget' ];
		
	}
        /**
         * Returns the widget title.
         * 
         * @since       3.5.7
         * @remark      The user needs to add a field with the id, `title` to display a title.
         * @remark      In order to disable the title, add a field with the id  `show_title` and if the value yields `false`, 
         * the title will not be displayed.
         * @return      string      The widget title
         */
        private function _getTitle( array $aArguments, array $aFormData ) {
                
            if ( ! $this->oCaller->oProp->bShowWidgetTitle ) {
                return '';
            }
            
            $_sTitle = apply_filters(
                'widget_title',
                $this->oCaller->oUtil->getElement(
                    $aFormData,
                    'title',
                    ''
                ),
                $aFormData,
                $this->id_base 
            );
            if ( ! $_sTitle ) {
                return '';
            }
           return $aArguments['before_title'] 
                . $_sTitle 
            . $aArguments['after_title'];           
            
        }
            
    /**
     * Validates the submitted form data.
     * 
     * @since       3.2.0
     * @return      mixed       The validated form data. The type should be an array but it is dealt by the framework user it will be unknown.
     */
	public function update( $aSubmittedFormData, $aSavedFormData ) {
                
        return $this->oCaller->oUtil->addAndApplyFilters(
            $this->oCaller, 
            "validation_{$this->oCaller->oProp->sClassName}", 
            call_user_func_array( 
                array( $this->oCaller, 'validate' ),    // triggers __call()
                array( $aSubmittedFormData, $aSavedFormData, $this->oCaller ) // parameters
            ), // 3.5.3+                        
            $aSavedFormData,
            $this->oCaller
        );
 
	}
    
    /**
     * Constructs the widget form with the given saved form data.
     * 
     * In widgets.php, this method is called multiple times per instance of the class defining the widget (widget model).
     * It is called for the number of added widget instances via drag-and-drop in the UI
     * of the widget model that the caller class defines.
     * 
     * This means, the framework factory class has to renew the saved data every time this method is called.
     * 
     * @return      void
     */
	public function form( $aFormData ) {

        /**
         * Set the form data - the form object will trigger a callback to construct the saved form data.
         * And the factory abstract class has a defined method (_replyToGetSavedFormData()) for it 
         * and it applies a filter (options_{...}) to the form data (options) array.
         */
        $this->oCaller->oProp->aOptions = $aFormData;     
        
        // The hook (load_{...}) in the method triggers the form registration method.
        $this->_loadFrameworkFactory();
        
        // Render the form 
        $this->oCaller->_printWidgetForm();            

        /** 
         * Initialize the form object that stores registered sections and fields
         * because this class gets called multiple times to render the form including added widgets 
         * and the initial widget that gets listed on the left hand side of the page.
         * 
         * @since       3.5.2
         */
        $this->oCaller->oForm = new AdminPageFramework_Form_widget(
            array(
                'register_if_action_already_done' => false, // do not register fields right away
            ) + $this->oCaller->oProp->aFormArguments,  // form arguments  
            $this->oCaller->oProp->aFormCallbacks,  // callbacks
            $this->oCaller->oMsg
        );
        
	}
        /**
         * Calls the load() method of the caller factory object.
         * 
         * Ensures it is called once per a page load.
         * @since       DEVVER
         */
        private function _loadFrameworkFactory() {
                                       
            // Trigger the load() method and load_{...} actions. The user sets up the form.
            $this->oCaller->load( $this->oCaller );
            $this->oCaller->oUtil->addAndDoActions( 
                $this->oCaller, 
                array(
                    'load_' . $this->oCaller->oProp->sClassName, 
                ),
                $this->oCaller 
            );            
            
        }    
    
        /**
         * 
         * @remark      This one is tricky as the core widget factory method enclose this value in []. So when the framework field has a section, it must NOT end with ].
         * @since       3.5.7       Moved from `AdminPageFramework_FormField`.
         * @since       3.6.0       Changed the name from `_replyToGetInputName`.
         * @return      string
         */
        public function _replyToGetFieldName( /* $sNameAttribute, array $aField */ ) {

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

            
            $_aParams      = func_get_args() + array( null, null, null );
            $aField        = $_aParams[ 1 ];
            
            $_sSectionIndex = isset( $aField['section_id'], $aField['_section_index'] ) 
                ? "[{$aField['_section_index']}]" 
                : "";             
            $_sID           = $this->oCaller->isSectionSet( $aField )
                ? $aField['section_id'] . "]" . $_sSectionIndex . "[" . $aField[ 'field_id' ]
                : $aField['field_id'];
            return $this->get_field_name( $_sID );
        
        }    
        
        /**
         * 
         * @since       3.6.0
         * @return      string
         */
        public function _replyToGetFieldInputName( /* $sNameAttribute, array $aField, $sIndex */ ) {

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

            
            $_aParams      = func_get_args() + array( null, null, null );
            $aField        = $_aParams[ 1 ];
            $sIndex        = $_aParams[ 2 ];
            
            $_sIndex = $this->oCaller->oUtil->getAOrB(
                '0' !== $sIndex && empty( $sIndex ),
                '',
                "[" . $sIndex . "]"
            );                        
            $_sSectionIndex = isset( $aField['section_id'], $aField['_section_index'] ) 
                ? "[{$aField['_section_index']}]" 
                : "";             
            $_sID           = $this->oCaller->isSectionSet( $aField )
                ? $aField['section_id'] . "]" . $_sSectionIndex . "[" . $aField[ 'field_id' ]
                : $aField[ 'field_id' ];
            return $this->get_field_name( $_sID ) . $_sIndex;
            
        }
        
        /**
         * Returns the flat input name.
         * 
         * A flat input name is a 'name' attribute value whose dimensional elements are delimited by the pile character.
         * 
         * Instead of [] enclosing array elements, it uses the pipe(|) to represent the multi dimensional array key.
         * This is used to create a reference to the submit field name to determine which button is pressed.
         * 
         * @since       3.5.7       Moved from `AdminPageFramework_FormField`.
         * @since       3.6.0       Changed the name from `_replyToGetFlatInputName()`.
         * @return      string
         * @deprecated
         */
        // protected function _replyToGetFlatFieldName( /* $sFlatInputName, array $aField */ ) {

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

            // $_aParams       = func_get_args() + array( null, null );            

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

            // $aField         = $_aParams[ 1 ];

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

            
            // $_sSectionIndex = isset( $aField['section_id'], $aField['_section_index'] )

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

                // ? "|{$aField['_section_index']}" 
                // : '';                        
            // $sFlatInputName = $this->oCaller->isSectionSet( $aField )

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

                // ? "{$aField['section_id']}{$_sSectionIndex}|{$aField['field_id']}"
                // : "{$aField['field_id']}";
            // return $sFlatInputName;
        // }
    
    /**
     * Modifies the class Selector.
     * 
     * @since   3.2.0
     * @remark  currently not used
     * @deprecated
     */
    // public function _replyToAddClassSelector( $sClassSelectors ) {

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

        
        // $sClassSelectors .= ' widefat';

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

        // return trim( $sClassSelectors );

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

        
    // }
    
}