michaeluno / admin-page-framework

development/factory/_common/form/field_type/image/AdminPageFramework_FieldType_image.php

Spacing +37 added lines, -37 removed lines

@@ -64,7 +64,7 @@ 
     /**
      * Defines the field type slugs used for this field type.
      */
-    public $aFieldTypeSlugs = array( 'image', );
+    public $aFieldTypeSlugs = array( 'image',);
 
     /**
      * Defines the default key-values of this field type.
@@ -73,8 +73,8 @@ 
      */
     protected $aDefaultKeys = array(
         'attributes_to_store'       => array(), // ( array ) This is for the image and media field type. The attributes to save besides URL. e.g. ( for the image field type ) array( 'title', 'alt', 'width', 'height', 'caption', 'id', 'align', 'link' ).
-        'show_preview'              => true,    // ( boolean ) Indicates whether the image preview should be displayed or not.
-        'allow_external_source'     => true,    // ( boolean ) Indicates whether the media library box has the From URL tab.
+        'show_preview'              => true, // ( boolean ) Indicates whether the image preview should be displayed or not.
+        'allow_external_source'     => true, // ( boolean ) Indicates whether the media library box has the From URL tab.
         'mime_types'                => array(   // [3.9.1] To display files of different file types, add MIME types
             'image' => 'image',
             // 'text' => 'text/plain',
@@ -88,7 +88,7 @@ 
                 'maxlength' => 400,
             ),
             'button'            => array(),
-            'remove_button'     => array(),       // 3.2.0+
+            'remove_button'     => array(), // 3.2.0+
             'preview'           => array(),
         ),
     );
@@ -104,7 +104,7 @@ 
      */
     protected function doOnFieldRegistration( $aField ) {
         self::$aMimeTypes = $this->getElementAsArray( $aField, array( 'mime_types' ) ) + self::$aMimeTypes;
-        if ( ! $this->hasBeenCalled( get_class( $this ) . '/upload_mimes' ) ) {
+        if ( !$this->hasBeenCalled( get_class( $this ).'/upload_mimes' ) ) {
             add_filter( 'upload_mimes', array( $this, 'replyToGetAllowedFileTypesToUpload' ) );
         }
     }
@@ -114,7 +114,7 @@ 
          * @return array
          */
         static public function replyToGetAllowedFileTypesToUpload( $aMimeTypes ) {
-            unset( self::$aMimeTypes[ 'image' ] );  // the default 'image' is for the custom uploader and the format is different
+            unset( self::$aMimeTypes[ 'image' ] ); // the default 'image' is for the custom uploader and the format is different
             return $aMimeTypes + self::$aMimeTypes;
         }
 
@@ -134,7 +134,7 @@ 
         return array(
             array(
                 'handle_id'         => 'admin-page-framework-field-type-image',
-                'src'               => dirname( __FILE__ ) . '/js/image.bundle.js',
+                'src'               => dirname( __FILE__ ).'/js/image.bundle.js',
                 'in_footer'         => true,
                 'dependencies'      => array( 'jquery', 'admin-page-framework-script-form-main' ),
                 'translation_var'   => 'AdminPageFrameworkImageFieldType',
@@ -180,14 +180,14 @@ 
                 . "<label for='{$aField[ 'input_id' ]}'>"
                     . $aField[ 'before_input' ]
                     . $this->getAOrB(
-                        $aField[ 'label' ] && ! $aField[ 'repeatable' ],
-                        "<span " . $this->getLabelContainerAttributes( $aField, 'admin-page-framework-input-label-string' ) . ">"
+                        $aField[ 'label' ] && !$aField[ 'repeatable' ],
+                        "<span ".$this->getLabelContainerAttributes( $aField, 'admin-page-framework-input-label-string' ).">"
                             . $aField[ 'label' ]
                         . "</span>",
                         ''
                     )
-                    . "<input " . $this->getAttributes( $this->___getImageInputAttributes( $aField, $_iCountAttributes, $_sImageURL, $_aBaseAttributes ) ) . " />"
-                    . $this->_getUploaderButtonHTML( $aField[ 'input_id' ], $_aUploadButtonAttributes, ! empty( $aField[ 'repeatable' ] ), $aField[ 'allow_external_source' ] )
+                    . "<input ".$this->getAttributes( $this->___getImageInputAttributes( $aField, $_iCountAttributes, $_sImageURL, $_aBaseAttributes ) )." />"
+                    . $this->_getUploaderButtonHTML( $aField[ 'input_id' ], $_aUploadButtonAttributes, !empty( $aField[ 'repeatable' ] ), $aField[ 'allow_external_source' ] )
                     . $this->_getRemoveButtonHTMLByType( $aField[ 'input_id' ], $_aRemoveButtonAttributes, strtolower( $this->getFirstElement( $this->aFieldTypeSlugs ) ) )
                     . $aField[ 'after_input' ]
                     . "<div class='repeatable-field-buttons'></div>" // the repeatable field buttons will be replaced with this element.
@@ -210,11 +210,11 @@ 
          * @return array The generated base attribute array.
          */
         private function ___getBaseAttributes( array $aField ) {
-            $_aBaseAttributes   = $aField[ 'attributes' ] + array( 'class' => null );
+            $_aBaseAttributes = $aField[ 'attributes' ] + array( 'class' => null );
             unset(
-                $_aBaseAttributes[ 'input' ],        $_aBaseAttributes[ 'button' ],
-                $_aBaseAttributes[ 'preview' ],      $_aBaseAttributes[ 'name' ],
-                $_aBaseAttributes[ 'value' ],        $_aBaseAttributes[ 'type' ],
+                $_aBaseAttributes[ 'input' ], $_aBaseAttributes[ 'button' ],
+                $_aBaseAttributes[ 'preview' ], $_aBaseAttributes[ 'name' ],
+                $_aBaseAttributes[ 'value' ], $_aBaseAttributes[ 'type' ],
                 $_aBaseAttributes[ 'remove_button' ]
             );
             return $_aBaseAttributes;
@@ -267,8 +267,8 @@ 
          */
         protected function getExtraInputFields( array $aField ) {
             $_aOutputs = array();
-            foreach( $this->getElementAsArray( $aField, 'attributes_to_store' ) as $sAttribute ) {
-                $_aOutputs[] = "<input " . $this->getAttributes(
+            foreach ( $this->getElementAsArray( $aField, 'attributes_to_store' ) as $sAttribute ) {
+                $_aOutputs[ ] = "<input ".$this->getAttributes(
                     array(
                         'id'        => "{$aField[ 'input_id' ]}_{$sAttribute}",
                         'type'      => 'hidden',
@@ -284,7 +284,7 @@ 
                             ''
                         ),
                     )
-                ) . "/>";
+                )."/>";
             }
             return implode( PHP_EOL, $_aOutputs );
         }
@@ -295,15 +295,15 @@ 
          * @return string
          */
         protected function _getPreviewContainer( $aField, $sImageURL, $aPreviewAttributes ) {
-            if ( ! $aField[ 'show_preview' ] ) {
+            if ( !$aField[ 'show_preview' ] ) {
                 return '';
             }
             $sImageURL = esc_url( $this->getResolvedSRC( $sImageURL, true ) );
-            return "<div " . $this->getAttributes(
+            return "<div ".$this->getAttributes(
                         array(
                             'id'    => "image_preview_container_{$aField[ 'input_id' ]}",
-                            'class' => 'image_preview ' . $this->getElement( $aPreviewAttributes, 'class', '' ),
-                            'style' => $this->getAOrB( $sImageURL, '', "display: none; "  )
+                            'class' => 'image_preview '.$this->getElement( $aPreviewAttributes, 'class', '' ),
+                            'style' => $this->getAOrB( $sImageURL, '', "display: none; " )
                                 . $this->getElement( $aPreviewAttributes, 'style', '' ),
                         ) + $aPreviewAttributes
                     )
@@ -326,12 +326,12 @@ 
          */
         protected function _getUploaderButtonScript( $sInputID, $abRepeatable, $bExternalSource, array $aButtonAttributes ) {
 
-            $_bRepeatable     = ! empty( $abRepeatable );
+            $_bRepeatable = !empty( $abRepeatable );
 
             // Do not include the escaping character (backslash) in the heredoc variable declaration
             // because the minifier script will parse it and the <<<JAVASCRIPTS and JAVASCRIPTS; parts are converted to double quotes (")
             // which causes the PHP syntax error.
-            $_sButtonHTML     = '"' . $this->_getUploaderButtonHTML( $sInputID, $aButtonAttributes, $_bRepeatable, $bExternalSource ) . '"';
+            $_sButtonHTML     = '"'.$this->_getUploaderButtonHTML( $sInputID, $aButtonAttributes, $_bRepeatable, $bExternalSource ).'"';
             $_sRepeatable     = $this->getAOrB( $_bRepeatable, 'true', 'false' );
             $_bExternalSource = $this->getAOrB( $bExternalSource, 'true', 'false' );
             $_sScript = <<<JAVASCRIPTS
@@ -347,7 +347,7 @@ 
                     . '/* <![CDATA[ */'
                     . $_sScript
                     . '/* ]]> */'
-                . "</script>". PHP_EOL;
+                . "</script>".PHP_EOL;
 
         }
             /**
@@ -365,7 +365,7 @@ 
                     $bRepeatable,
                     $bExternalSource
                 );
-                return "<a " . $this->getAttributes( $_aAttributes ) . ">"
+                return "<a ".$this->getAttributes( $_aAttributes ).">"
                         . ( $_bIsLabelSet
                             ? $_aAttributes[ 'data-label' ]
                             : ( strrpos( $_aAttributes[ 'class' ], 'dashicons' )
@@ -382,7 +382,7 @@ 
                  * @return array The formatted upload button attributes array.
                  */
                 protected function _getFormattedUploadButtonAttributes( $sInputID, array $aButtonAttributes, $_bIsLabelSet, $bRepeatable, $bExternalSource ) {
-                    $_aAttributes           = array(
+                    $_aAttributes = array(
                             'id'        => "select_image_{$sInputID}",
                             'href'      => '#',
                             'data-input_id'                 => $sInputID,
@@ -397,7 +397,7 @@ 
                                 : $this->oMsg->get( 'select_image' ),
                             'data-label' => null,
                         );
-                    $_aAttributes[ 'class' ]  = $this->getClassAttribute(
+                    $_aAttributes[ 'class' ] = $this->getClassAttribute(
                         'select_image button button-small ',
                         $this->getAOrB(
                             trim( $aButtonAttributes[ 'class' ] ),
@@ -425,16 +425,16 @@ 
          * @internal
          * @deprecatead 3.9.0  Currently, not used but Kept for backward compatibility.
          */
-        protected function _getRemoveButtonScript( $sInputID, array $aButtonAttributes, $sType='image' ) {
+        protected function _getRemoveButtonScript( $sInputID, array $aButtonAttributes, $sType = 'image' ) {
 
-            if ( ! function_exists( 'wp_enqueue_media' ) ) {
+            if ( !function_exists( 'wp_enqueue_media' ) ) {
                 return '';
             }
 
             // Do not include the escaping character (backslash) in the heredoc variable declaration
             // because the minifier script will parse it and the <<<JAVASCRIPTS and JAVASCRIPTS; parts are converted to double quotes (")
             // which causes the PHP syntax error.
-            $_sButtonHTML  = '"' . $this->_getRemoveButtonHTMLByType( $sInputID, $aButtonAttributes, $sType ) . '"';
+            $_sButtonHTML = '"'.$this->_getRemoveButtonHTMLByType( $sInputID, $aButtonAttributes, $sType ).'"';
             $_sScript = <<<JAVASCRIPTS
                 if ( 0 === jQuery( 'a#remove_{$sType}_{$sInputID}' ).length ) {
                     jQuery( 'input#{$sInputID}' ).after( $_sButtonHTML );
@@ -445,7 +445,7 @@ 
                     . '/* <![CDATA[ */'
                     . $_sScript
                     . '/* ]]> */'
-                . "</script>". PHP_EOL;
+                . "</script>".PHP_EOL;
 
         }
 
@@ -455,10 +455,10 @@ 
          * @return      string      The generated HTML remove button output.
          * @internal
          */
-        protected function _getRemoveButtonHTMLByType( $sInputID, array $aButtonAttributes, $sType='image' ) {
+        protected function _getRemoveButtonHTMLByType( $sInputID, array $aButtonAttributes, $sType = 'image' ) {
             $_bIsLabelSet   = isset( $aButtonAttributes[ 'data-label' ] ) && $aButtonAttributes[ 'data-label' ];
             $_aAttributes   = $this->_getFormattedRemoveButtonAttributesByType( $sInputID, $aButtonAttributes, $_bIsLabelSet, $sType );
-            return "<a " . $this->getAttributes( $_aAttributes ) . ">"
+            return "<a ".$this->getAttributes( $_aAttributes ).">"
                     . ( $_bIsLabelSet
                         ? $_aAttributes[ 'data-label' ]
                         : $this->getAOrB(
@@ -476,10 +476,10 @@ 
              * @return      array       The formatted remove button attributes array.
              * @internal
              */
-            protected function _getFormattedRemoveButtonAttributesByType( $sInputID, array $aButtonAttributes, $_bIsLabelSet, $sType='image' ) {
+            protected function _getFormattedRemoveButtonAttributesByType( $sInputID, array $aButtonAttributes, $_bIsLabelSet, $sType = 'image' ) {
 
                 // $_sOnClickFunctionName  = 'removeInputValuesFor' . ucfirst( $sType ); // @deprecated
-                $_aAttributes           = array(
+                $_aAttributes = array(
                         'id'            => "remove_{$sType}_{$sInputID}",
                         'href'          => '#',
                         'data-input_id' => $sInputID,
@@ -493,7 +493,7 @@ 
                             ? $aButtonAttributes[ 'data-label' ]
                             : $this->oMsg->get( 'remove_value' ),
                     );
-                $_aAttributes[ 'class' ]  = $this->getClassAttribute(
+                $_aAttributes[ 'class' ] = $this->getClassAttribute(
                     "remove_value remove_{$sType} button button-small",
                     $this->getAOrB(
                         trim( $aButtonAttributes[ 'class' ] ),

development/factory/_common/form/notice/AdminPageFramework_Form___SubmitNotice.php

Spacing +9 added lines, -9 removed lines

@@ -40,7 +40,7 @@ 
          * @return string
          */
         private function _getTransientKey() {
-            return 'apf_ntc_' . get_current_user_id();
+            return 'apf_ntc_'.get_current_user_id();
         }
     
     /**
@@ -52,14 +52,14 @@ 
      * @param  string  $sType If empty, the method will check if a message exists in all types. Otherwise, it checks the existence of a message of the specified type.
      * @return boolean True if a setting notice is set; otherwise, false.
      */
-    public function hasNotice( $sType='' ) {
+    public function hasNotice( $sType = '' ) {
                 
-        if ( ! $sType ) {
+        if ( !$sType ) {
             return ( boolean ) count( self::$_aNotices );
         }
         
         // Check if there is a message of the type.
-        foreach( self::$_aNotices as $_aNotice ) {
+        foreach ( self::$_aNotices as $_aNotice ) {
             $_sClassAttribute = $this->getElement( 
                 $_aNotice, 
                 array( 
@@ -96,7 +96,7 @@ 
      * @param array   $asAttributes (optional) the tag attribute array applied to the message container HTML element. If a string is given, it is used as the ID attribute value.
      * @param boolean $bOverride    (optional) If true, only one message will be shown in the next page load. false: do not override when there is a message of the same id. true: override the previous one.
      */
-    public function set( $sMessage, $sType='error', $asAttributes=array(), $bOverride=true ) {
+    public function set( $sMessage, $sType = 'error', $asAttributes = array(), $bOverride = true ) {
         
         // If the array is empty, schedule the task of saving the array at shutdown.
         if ( empty( self::$_aNotices ) ) {
@@ -106,7 +106,7 @@ 
         $_sID = md5( trim( $sMessage ) );
             
         // If the override is false and a message is already set, do not add.
-        if ( ! $bOverride && isset( self::$_aNotices[ $_sID ] ) ) {
+        if ( !$bOverride && isset( self::$_aNotices[ $_sID ] ) ) {
             return;
         }
 
@@ -116,14 +116,14 @@ 
         }
         
         $_aAttributes = $this->getAsArray( $asAttributes );
-        if ( is_string( $asAttributes ) && ! empty( $asAttributes ) ) {
+        if ( is_string( $asAttributes ) && !empty( $asAttributes ) ) {
             $_aAttributes[ 'id' ] = $asAttributes;
         }
         self::$_aNotices[ $_sID ] = array(
             'sMessage'      => $sMessage,
             'aAttributes'   => $_aAttributes + array(
                 'class'     => $sType,
-                'id'        => 'form_submit_notice_' . $_sID,
+                'id'        => 'form_submit_notice_'.$_sID,
             ),
         );
 
@@ -161,7 +161,7 @@ 
         }
             
         // By setting false to the 'settings-notice' key, it's possible to disable the notifications set with the framework.
-        if ( isset( $_GET[ 'settings-notice' ] ) && ! $_GET[ 'settings-notice' ] ) {    // sanitization unnecessary
+        if ( isset( $_GET[ 'settings-notice' ] ) && !$_GET[ 'settings-notice' ] ) {    // sanitization unnecessary
             return; 
         }
             

Braces +4 added lines, -3 removed lines

@@ -137,7 +137,7 @@ 
          * @callback add_action() shutdown
          */
         public function _replyToSaveNotices() {
-            if ( empty( self::$_aNotices ) ) { 
+            if ( empty( self::$_aNotices ) ) {
                 return; 
             }            
             $_bResult = $this->setTransient( 
@@ -156,12 +156,13 @@ 
         
         // Retrieve the notifications set in a transient.
         $_aNotices = $this->_getNotices();
-        if ( false === $_aNotices ) { 
+        if ( false === $_aNotices ) {
             return; 
         }
             
         // By setting false to the 'settings-notice' key, it's possible to disable the notifications set with the framework.
-        if ( isset( $_GET[ 'settings-notice' ] ) && ! $_GET[ 'settings-notice' ] ) {    // sanitization unnecessary
+        if ( isset( $_GET[ 'settings-notice' ] ) && ! $_GET[ 'settings-notice' ] ) {
+// sanitization unnecessary
             return; 
         }
             

development/factory/_common/form/AdminPageFramework_Form_View.php

Spacing +1 added lines, -1 removed lines

@@ -32,7 +32,7 @@
     public function get() {
 
         $this->sCapability = $this->callBack( $this->aCallbacks[ 'capability' ], '' );
-        if ( ! $this->canUserView( $this->sCapability ) ) {
+        if ( !$this->canUserView( $this->sCapability ) ) {
             return '';
         }
 

development/factory/_common/_abstract/_view/AdminPageFramework_Factory_View__SettingNotice.php

Spacing +3 added lines, -3 removed lines

@@ -25,7 +25,7 @@ 
      * @since 3.7.9 Added the second parameter to accept an action hook name.
      */
 
-    public function __construct( $oFactory, $sActionHookName='admin_notices' ) {
+    public function __construct( $oFactory, $sActionHookName = 'admin_notices' ) {
         $this->oFactory = $oFactory;
         add_action( $sActionHookName, array( $this, '_replyToPrintSettingNotice' ) );
     }
@@ -40,7 +40,7 @@ 
      * @callback add_action() admin_notices
      */
     public function _replyToPrintSettingNotice() {
-        if ( ! $this->___shouldProceed() ) {
+        if ( !$this->___shouldProceed() ) {
             return;
         }
         $this->oFactory->oForm->printSubmitNotices();
@@ -53,7 +53,7 @@ 
          */
         private function ___shouldProceed() {
 
-            if ( ! $this->oFactory->isInThePage() ) {
+            if ( !$this->oFactory->isInThePage() ) {
                 return false;
             }
 

development/factory/_common/_abstract/AdminPageFramework_Factory_Router.php

Spacing +21 added lines, -21 removed lines

@@ -169,8 +169,8 @@ 
         }
 
         // Call the user constructor.
-        $this->start();     // defined in the controller class.
-        $this->oUtil->addAndDoAction( $this, 'start_' . $this->oProp->sClassName, $this );
+        $this->start(); // defined in the controller class.
+        $this->oUtil->addAndDoAction( $this, 'start_'.$this->oProp->sClassName, $this );
 
     }
         /**
@@ -179,8 +179,8 @@ 
          * @return      array
          */
         private function ___getSubClassNames() {
-            foreach( $this->_aSubClassPrefixes as $_sObjectVariableName => $_sPrefix ) {
-                $this->aSubClassNames[ $_sObjectVariableName ] = $_sPrefix . $this->_sStructureType;
+            foreach ( $this->_aSubClassPrefixes as $_sObjectVariableName => $_sPrefix ) {
+                $this->aSubClassNames[ $_sObjectVariableName ] = $_sPrefix.$this->_sStructureType;
             }
             return $this->aSubClassNames + $this->_aSubClassNames;
         }
@@ -194,15 +194,15 @@ 
      */
     public function _replyToLoadComponents( /* $oScreen */ ) {
 
-        if ( ! $this->_isInThePage() ) {
+        if ( !$this->_isInThePage() ) {
             return;
         }
 
-        if ( ! isset( $this->oResource ) ) {
+        if ( !isset( $this->oResource ) ) {
             $this->oResource = $this->_replyTpSetAndGetInstance_oResource();
         }
 
-        if ( ! isset(  $this->oLink ) ) {
+        if ( !isset( $this->oLink ) ) {
             $this->oLink = $this->_replyTpSetAndGetInstance_oLink();
         }
 
@@ -216,10 +216,10 @@ 
      * Calls the load method and callbacks.
      * @since       3.8.14
      */
-    protected function _load( $aActions=array() ) {
+    protected function _load( $aActions = array() ) {
         $aActions = empty( $aActions )
             ? array(
-                'load_' . $this->oProp->sClassName,
+                'load_'.$this->oProp->sClassName,
             )
             : $aActions;
         $this->load();
@@ -231,7 +231,7 @@ 
      */
     protected function _setUp() {
         $aActions = array(
-            'set_up_' . $this->oProp->sClassName,
+            'set_up_'.$this->oProp->sClassName,
         );
         $this->setUp();
         $this->oUtil->addAndDoActions( $this, $aActions, $this );
@@ -246,7 +246,7 @@ 
      * @internal
      */
     protected function _isInstantiatable() {
-        if ( ! empty( $GLOBALS[ 'pagenow' ] ) && 'async-upload.php' === $GLOBALS[ 'pagenow' ] ) {   // 3.9.1
+        if ( !empty( $GLOBALS[ 'pagenow' ] ) && 'async-upload.php' === $GLOBALS[ 'pagenow' ] ) {   // 3.9.1
             return true;
         }
         if ( $this->_isWordPressCoreAjaxRequest() ) {
@@ -261,14 +261,14 @@ 
          * @since  3.8.19
          */
         protected function _isWordPressCoreAjaxRequest() {
-            if ( ! isset( $GLOBALS[ 'pagenow' ] ) ) {
+            if ( !isset( $GLOBALS[ 'pagenow' ] ) ) {
                 return false;
             }
             if ( 'admin-ajax.php' !== $GLOBALS[ 'pagenow' ] ) {
                 return false;
             }
             return in_array(
-                isset( $_POST[ 'action' ] ) ? $_POST[ 'action' ] : '',  // sanitization unnecessary as just checking
+                isset( $_POST[ 'action' ] ) ? $_POST[ 'action' ] : '', // sanitization unnecessary as just checking
                 array( 'heartbeat', 'closed-postboxes', 'meta-box-order' ),
                 true
             );
@@ -296,7 +296,7 @@ 
      * @return  boolean
      */
     protected function _isValidAjaxReferrer() {
-        if ( ! $this->oProp->bIsAdminAjax ) {
+        if ( !$this->oProp->bIsAdminAjax ) {
             return false;
         }
         return true;
@@ -312,7 +312,7 @@ 
      */
     public function _replyToDetermineToLoad() {
 
-        if ( ! $this->_isInThePage() ) {
+        if ( !$this->_isInThePage() ) {
             return;
         }
 
@@ -378,7 +378,7 @@ 
         // Set and return the sub class object instance.
         if ( isset( $this->aSubClassNames[ $sPropertyName ] ) ) {
             return call_user_func(
-                array( $this, "_replyTpSetAndGetInstance_{$sPropertyName}"  )
+                array( $this, "_replyTpSetAndGetInstance_{$sPropertyName}" )
             );
         }
 
@@ -412,7 +412,7 @@ 
          */
         public function _replyTpSetAndGetInstance_oMsg() {
             $this->oMsg = call_user_func_array(
-                array( $this->aSubClassNames[ 'oMsg' ], 'getInstance'),
+                array( $this->aSubClassNames[ 'oMsg' ], 'getInstance' ),
                 array( $this->oProp->sTextDomain )  // parameters
             );
             return $this->oMsg;
@@ -477,7 +477,7 @@ 
      *
      * @internal
      */
-    public function __call( $sMethodName, $aArguments=null ) {
+    public function __call( $sMethodName, $aArguments = null ) {
 
         $_mFirstArg = $this->oUtil->getElement( $aArguments, 0 );
 
@@ -507,7 +507,7 @@ 
 
             // Check if the method name does not contain a backslash.
             if ( false === strpos( $sMethodName, "\\" ) ) {
-                return $this->oUtil->getElement( $aArguments, 0 );  // the first element - the filter value
+                return $this->oUtil->getElement( $aArguments, 0 ); // the first element - the filter value
             }
 
             // If the method name contains a backslash, the user may be using a name space.
@@ -518,7 +518,7 @@ 
                     array( $this, $_sAutoCallbackMethodName ),
                     $aArguments
                 )
-                : $this->oUtil->getElement( $aArguments, 0 );   // the first argument
+                : $this->oUtil->getElement( $aArguments, 0 ); // the first argument
 
         }
 
@@ -528,7 +528,7 @@ 
          */
         private function _triggerUndefinedMethodWarning( $sMethodName ) {
             trigger_error(
-                AdminPageFramework_Registry::NAME . ': '
+                AdminPageFramework_Registry::NAME.': '
                     . sprintf(
                         __( 'The method is not defined: %1$s', $this->oProp->sTextDomain ),
                         $sMethodName

Braces +2 added lines, -1 removed lines

@@ -246,7 +246,8 @@
      * @internal
      */
     protected function _isInstantiatable() {
-        if ( ! empty( $GLOBALS[ 'pagenow' ] ) && 'async-upload.php' === $GLOBALS[ 'pagenow' ] ) {   // 3.9.1
+        if ( ! empty( $GLOBALS[ 'pagenow' ] ) && 'async-upload.php' === $GLOBALS[ 'pagenow' ] ) {
+// 3.9.1
             return true;
         }
         if ( $this->_isWordPressCoreAjaxRequest() ) {

development/factory/_common/_abstract/AdminPageFramework_Factory_Controller.php

Indentation +192 added lines, -192 removed lines

@@ -319,17 +319,17 @@ 
     }
 
     /**
-    * Adds form fields.
-    *
-    * It inserts the given field definition arrays into the class property and later they are parsed when fields are registered. The field definition array requires specific keys. Refer to the parameter section of this method.
-    *
-    * @since  2.0.0
-    * @since  3.5.3 Removed the parameter declarations as they are caught with the func_get_args().
-    * @remark Accepts variadic parameters; the number of accepted parameters are not limited to three.
-    * @param  array the field definition array.
-    * @param  array (optional) another field array.
-    * @param  array (optional) add more field arrays to the next parameters as many as necessary.
-    */
+     * Adds form fields.
+     *
+     * It inserts the given field definition arrays into the class property and later they are parsed when fields are registered. The field definition array requires specific keys. Refer to the parameter section of this method.
+     *
+     * @since  2.0.0
+     * @since  3.5.3 Removed the parameter declarations as they are caught with the func_get_args().
+     * @remark Accepts variadic parameters; the number of accepted parameters are not limited to three.
+     * @param  array the field definition array.
+     * @param  array (optional) another field array.
+     * @param  array (optional) add more field arrays to the next parameters as many as necessary.
+     */
     public function addSettingFields( /* $aField1, $aField2=null, $_and_more=null */ ) {
         foreach( func_get_args() as $_aFieldset ) {
             $this->addSettingField( $_aFieldset );
@@ -360,167 +360,167 @@ 
      * @return       void
      * @remark       The $oForm property should be created in each extended class.
      * @param        array|string       $asField        A field definition array or a string of the target section id.
-    * <h4>Built-in Field Types</h4>
-    * <ul>
-    *       <li>[text](./class-AdminPageFramework_FieldType_text.html) - a normal field to enter short text input.</li>
-    *       <li>[password](./class-AdminPageFramework_FieldType_text.html) - a masked text input field.</li>
-    *       <li>[textarea](./class-AdminPageFramework_FieldType_textarea.html) - a text input field with multiple lines. It supports rich text editors.</li>
-    *       <li>[radio](./class-AdminPageFramework_FieldType_radio.html) - a set of radio buttons that lets the user pick an option.</li>
-    *       <li>[checkbox](./class-AdminPageFramework_FieldType_checkbox.html) - a check box that lets the user enable/disable an item.</li>
-    *       <li>[select](./class-AdminPageFramework_FieldType_select.html) - a drop-down list that lest the user pick one or more item(s) from a list.</li>
-    *       <li>[hidden](./class-AdminPageFramework_FieldType_hidden.html) - a field with invisible input values.</li>
-    *       <li>[file](./class-AdminPageFramework_FieldType_file.html) - a file uploader that lets the user upload files.</li>
-    *       <li>[image](./class-AdminPageFramework_FieldType_image.html) - a text field with an image uploader that lets the user set the image URL.</li>
-    *       <li>[media](./class-AdminPageFramework_FieldType_media.html) - a text field with a media uploader that lets the user set the file URL.</li>
-    *       <li>[color](./class-AdminPageFramework_FieldType_color.html) - a text field with a color picker.</li>
-    *       <li>[submit](./class-AdminPageFramework_FieldType_submit.html) - a submit button that lets the user send the form.</li>
-    *       <li>[export](./class-AdminPageFramework_FieldType_export.html) - a custom submit field that lets the user export stored data.</li>
-    *       <li>[import](./class-AdminPageFramework_FieldType_import.html) - a custom combination field of file and submit fields that let the user import data.</li>
-    *       <li>[posttype](./class-AdminPageFramework_FieldType_posttype.html) - a check-list of post types enabled on the site.</li>
-    *       <li>[taxonomy](./class-AdminPageFramework_FieldType_taxonomy.html) - a set of check-lists of taxonomies enabled on the site in a tabbed box.</li>
-    *       <li>[size](./class-AdminPageFramework_FieldType_size.html) - a combination field of the text and the select fields that let the user set sizes with a selectable unit.</li>
-    *       <li>[section_title](./class-AdminPageFramework_FieldType_section_title.html) - [3.0.0+] a text field type that will be placed in the section title so that it lets the user set the section title. Note that only one field with this field type is allowed per a section.</li>
-    *       <li>[system](./class-AdminPageFramework_FieldType_system.html) - [3.3.0+] a custom text area field that displays the system information including the PHP settings, the framework version, MySQL version etc.</li>
-    *       <li>[inline_mixed](./class-AdminPageFramework_FieldType_inline_mixed.html) - [3.8.0+] a field that include inner fields with different field types. </li>
-    * </ul>
-    * <h4>Field Definition Arguments</h4>
-    * <ul>
-    *       <li>**field_id** - (required, string) the field ID. Avoid using non-alphabetic characters except underscore and numbers.</li>
-    *       <li>**type** - (optional, string) the type of the field. The supported types are listed below. When creating nested fields, this argument can be omitted.</li>
-    *       <li>**section_id** - (optional, string) the section ID that the field belongs to. If not set, the internal `_default` section ID will be assigned.</li>
-    *       <li>**title** - (optional, string) the title of the section.</li>
-    *       <li>**description** - (optional, string) the description of the field which is inserted into the after the input field tag.</li>
-    *       <li>**tip** - (optional, string) the tip for the field which is displayed when the mouse is hovered over the field title.</li>
-    *       <li>**capability** - (optional, string) the <a href="http://codex.wordpress.org/Roles_and_Capabilities">access level</a> of the section. If the page visitor does not have sufficient capability, the section will be invisible to them.</li>
-    *       <li>**error_message** - (optional, string) the error message to display above the input field.</li>
-    *       <li>**before_field** - (optional, string) the HTML string to insert before the input field output.</li>
-    *       <li>**after_field** - (optional, string) the HTML string to insert after the input field output.</li>
-    *       <li>**if** - (optional, boolean) if the passed value is false, the section will not be registered.</li>
-    *       <li>**order** - (optional, integer) the order number of the section. The higher the number is, the lower the position it gets.</li>
-    *       <li>**label** - (optional, string) the text label(s) associated with and displayed along with the input field. Some input types can ignore this key.</li>
-    *       <li>**default** - (optional, string|array) the default value(s) assigned to the input tag's value attribute.</li>
-    *       <li>**value** - (optional, string|array) the value(s) assigned to the input tag's `value` attribute to override the default and the stored value.</li>
-    *       <li>**delimiter** - (optional, string) the HTML string that delimits multiple elements. This is available if the <var>label</var> key is passed as array. It will be enclosed in inline-block elements so the passed HTML string should not contain block elements.</li>
-    *       <li>**before_input** - (optional, string) the HTML string inserted right before the input tag. It will be enclosed in the <code>label</code> tag so the passed HTML string should not contain block elements.</li>
-    *       <li>**after_input** - (optional, string) the HTML string inserted right after the input tag. It will be enclosed in the <code>label</code> tag so the passed HTML string should not contain block elements.</li>
-    *       <li>**label_min_width** - (optional, string) the inline style property of the `min-width` of the label tag for the field. If the unit is not specified, 'px' is applied. Default: `120`. e.g. `100%`</li>
-    *       <li>**help** - (optional, string) the help description added to the contextual help tab.</li>
-    *       <li>**help_aside** - (optional, string) the additional help description for the side bar of the contextual help tab.</li>
-    *       <li>**repeatable** - [3.0.0+] (optional, array|boolean) whether the fields should be repeatable. If it yields true, the plus and the minus buttons appear next to each field that lets the user add/remove the fields. Optionally an setting array can be passed.
-    *           <h5>Repeatable Fields Setting Array</h5>
-    *           <ul>
-    *                 <li>**max** - the allowed maximum number of fields to be repeated.</li>
-    *                 <li>**min** - the allowed minimum number of fields to be repeated.</li>
-    *                <li>**disabled** - (optional, boolean|array) [3.8.13+]
-    *                    <ul>
-    *                        <li>**message** - (optional, string) the message to show when the user clicks on the `Add` repeatable button.</li>
-    *                        <li>**caption** - (optional, string) the title of the modal window that displays the message. Default: Warning</li>
-    *                        <li>**box_width** - (optional, integer) the width of the modal window that displays the message. Default: 300</li>
-    *                        <li>**box_width** - (optional, integer) the height of the modal window that displays the message. Default: 100.</li>
-    *                    <ul>
-    *                </li>
-    *           </ul>
-    *       </li>
-    *       <li>**sortable** - [3.0.0+] (optional, boolean) whether the fields should be sortable. If it yields true, the fields will be enclosed in a draggable box.
-    *       <li>**attributes** - [3.0.0+] (optional, array) holds key-value pairs representing the attribute and its property. Note that some field types have specific keys in the first dimensions. e.g. `array( 'class' => 'my_custom_class_selector', 'style' => 'background-color:#777', 'size' => 20, )` Every field holds the following nested attribute definition arrays.
-    *           <ul>
-    *               <li>**fieldrow** - the `td` tag element containing the field output.</li>
-    *               <li>**fieldset** - the `fieldset` tag element containing the field output.</li>
-    *               <li>**fields** - the `div` tag element containing the sub-fields and the main field.</li>
-    *               <li>**field** - the `div` tag element containing each field.</li>
-    *           </ul>
-    *       </li>
-    *       <li>**show_title_column** - [3.0.0+] (optional, boolean) If true, the field title column will be omitted from the output.</li>
-    *       <li>**hidden** - [3.0.0+] (optional, boolean) If true, the entire field row output will be invisible with the inline style attribute of `style="display:none"`.</li>
-    *       <li>**save** - [3.6.0+] (optional, boolean) If `false`, the field value will not be saved. Default: `true`</li>
-    *       <li>**content** - (optional, string|array) [3.6.1+] a custom section output. [3.8.0+] Supports an array to be passed for nested and inline-mixed fields. If an array holding field definitions is set, those fields will be nested.
-    *           <h4>Example</h4>
-    * <pre><code>
-    *   $this->addSettingFields(
-    *       'my_section_id', // the target section ID - pass dimensional keys of the section
-    *       array(
-    *           'field_id'      => 'Y',
-    *           'title'         => __( 'Y', 'admin-page-framework-loader' ),
-    *           'description'   => __( 'By passing an array of field definition to the <code>content</code> argument, you can nest fields.', 'admin-page-framework-loader' )
-    *               . ' ' . __( 'Also the <code>type</code> argument can be omitted.', 'admin-page-framework-loader' ),
-    *           'content'       => array(
-    *               array(
-    *                   'field_id'      => 'i',
-    *                   'title'         => __( 'i', 'admin-page-framework-loader' ),
-    *                   'type'          => 'textarea',
-    *               ),
-    *               array(
-    *                   'field_id'      => 'ii',
-    *                   'title'         => __( 'ii', 'admin-page-framework-loader' ),
-    *                   'type'          => 'color',
-    *               ),
-    *               array(
-    *                   'field_id'      => 'iii',
-    *                   'title'         => __( 'iii', 'admin-page-framework-loader' ),
-    *                   'repeatable'    => true,
-    *                   'sortable'      => true,
-    *                   'content'       => array(
-    *                       array(
-    *                           'field_id'      => 'a',
-    *                           'title'         => __( 'a', 'admin-page-framework-loader' ),
-    *                           'type'          => 'image',
-    *                           'attributes'    => array(
-    *                               'preview' => array(
-    *                                   'style' => 'max-width: 200px;',
-    *                               ),
-    *                           ),
-    *                       ),
-    *                       array(
-    *                           'field_id'      => 'b',
-    *                           'title'         => __( 'b', 'admin-page-framework-loader' ),
-    *                           'content'       => array(
-    *                               array(
-    *                                   'field_id'      => 'first',
-    *                                   'title'         => __( '1st', 'admin-page-framework-loader' ),
-    *                                   'type'          => 'color',
-    *                                   'repeatable'    => true,
-    *                                   'sortable'      => true,
-    *                               ),
-    *                               array(
-    *                                   'field_id'      => 'second',
-    *                                   'title'         => __( '2nd', 'admin-page-framework-loader' ),
-    *                                   'type'          => 'size',
-    *                               ),
-    *                               array(
-    *                                   'field_id'      => 'third',
-    *                                   'title'         => __( '3rd', 'admin-page-framework-loader' ),
-    *                                   'type'          => 'select',
-    *                                   'label'         => array(
-    *                                       'x' => 'X',
-    *                                       'y' => 'Y',
-    *                                       'z' => 'Z',
-    *                                   ),
-    *                               ),
-    *                           ),
-    *                           // 'description'   => '',
-    *                       ),
-    *                       array(
-    *                           'field_id'      => 'c',
-    *                           'title'         => __( 'c', 'admin-page-framework-loader' ),
-    *                           'type'          => 'radio',
-    *                           'label'         => array(
-    *                               'a' => __( 'Apple', 'admin-page-framework-loader' ),
-    *                               'b' => __( 'Banana', 'admin-page-framework-loader' ),
-    *                               'c' => __( 'Cherry', 'admin-page-framework-loader' ),
-    *                           ),
-    *                           'default'       => 'b',
-    *                       ),
-    *                   )
-    *               ),
-    *           ),
-    *       )
-    *   );
-    * </code></pre>
-    *       </li>
-    *       <li>**placement** - [3.8.0+] (optional, string) Specifies where the field is rendered. Either `normal` `section_title` or `field_title` is accepted. `field_title` can only be used by nested fields defined in the `content` argument.  Default: `normal`</li>
-    *       <li>**show_debug_info** - (optional, boolean) [3.8.8+] Whether to show debug information such as field definition tool-tips. Default: `true`.</li>
-    * </ul>
-    */
+     * <h4>Built-in Field Types</h4>
+     * <ul>
+     *       <li>[text](./class-AdminPageFramework_FieldType_text.html) - a normal field to enter short text input.</li>
+     *       <li>[password](./class-AdminPageFramework_FieldType_text.html) - a masked text input field.</li>
+     *       <li>[textarea](./class-AdminPageFramework_FieldType_textarea.html) - a text input field with multiple lines. It supports rich text editors.</li>
+     *       <li>[radio](./class-AdminPageFramework_FieldType_radio.html) - a set of radio buttons that lets the user pick an option.</li>
+     *       <li>[checkbox](./class-AdminPageFramework_FieldType_checkbox.html) - a check box that lets the user enable/disable an item.</li>
+     *       <li>[select](./class-AdminPageFramework_FieldType_select.html) - a drop-down list that lest the user pick one or more item(s) from a list.</li>
+     *       <li>[hidden](./class-AdminPageFramework_FieldType_hidden.html) - a field with invisible input values.</li>
+     *       <li>[file](./class-AdminPageFramework_FieldType_file.html) - a file uploader that lets the user upload files.</li>
+     *       <li>[image](./class-AdminPageFramework_FieldType_image.html) - a text field with an image uploader that lets the user set the image URL.</li>
+     *       <li>[media](./class-AdminPageFramework_FieldType_media.html) - a text field with a media uploader that lets the user set the file URL.</li>
+     *       <li>[color](./class-AdminPageFramework_FieldType_color.html) - a text field with a color picker.</li>
+     *       <li>[submit](./class-AdminPageFramework_FieldType_submit.html) - a submit button that lets the user send the form.</li>
+     *       <li>[export](./class-AdminPageFramework_FieldType_export.html) - a custom submit field that lets the user export stored data.</li>
+     *       <li>[import](./class-AdminPageFramework_FieldType_import.html) - a custom combination field of file and submit fields that let the user import data.</li>
+     *       <li>[posttype](./class-AdminPageFramework_FieldType_posttype.html) - a check-list of post types enabled on the site.</li>
+     *       <li>[taxonomy](./class-AdminPageFramework_FieldType_taxonomy.html) - a set of check-lists of taxonomies enabled on the site in a tabbed box.</li>
+     *       <li>[size](./class-AdminPageFramework_FieldType_size.html) - a combination field of the text and the select fields that let the user set sizes with a selectable unit.</li>
+     *       <li>[section_title](./class-AdminPageFramework_FieldType_section_title.html) - [3.0.0+] a text field type that will be placed in the section title so that it lets the user set the section title. Note that only one field with this field type is allowed per a section.</li>
+     *       <li>[system](./class-AdminPageFramework_FieldType_system.html) - [3.3.0+] a custom text area field that displays the system information including the PHP settings, the framework version, MySQL version etc.</li>
+     *       <li>[inline_mixed](./class-AdminPageFramework_FieldType_inline_mixed.html) - [3.8.0+] a field that include inner fields with different field types. </li>
+     * </ul>
+     * <h4>Field Definition Arguments</h4>
+     * <ul>
+     *       <li>**field_id** - (required, string) the field ID. Avoid using non-alphabetic characters except underscore and numbers.</li>
+     *       <li>**type** - (optional, string) the type of the field. The supported types are listed below. When creating nested fields, this argument can be omitted.</li>
+     *       <li>**section_id** - (optional, string) the section ID that the field belongs to. If not set, the internal `_default` section ID will be assigned.</li>
+     *       <li>**title** - (optional, string) the title of the section.</li>
+     *       <li>**description** - (optional, string) the description of the field which is inserted into the after the input field tag.</li>
+     *       <li>**tip** - (optional, string) the tip for the field which is displayed when the mouse is hovered over the field title.</li>
+     *       <li>**capability** - (optional, string) the <a href="http://codex.wordpress.org/Roles_and_Capabilities">access level</a> of the section. If the page visitor does not have sufficient capability, the section will be invisible to them.</li>
+     *       <li>**error_message** - (optional, string) the error message to display above the input field.</li>
+     *       <li>**before_field** - (optional, string) the HTML string to insert before the input field output.</li>
+     *       <li>**after_field** - (optional, string) the HTML string to insert after the input field output.</li>
+     *       <li>**if** - (optional, boolean) if the passed value is false, the section will not be registered.</li>
+     *       <li>**order** - (optional, integer) the order number of the section. The higher the number is, the lower the position it gets.</li>
+     *       <li>**label** - (optional, string) the text label(s) associated with and displayed along with the input field. Some input types can ignore this key.</li>
+     *       <li>**default** - (optional, string|array) the default value(s) assigned to the input tag's value attribute.</li>
+     *       <li>**value** - (optional, string|array) the value(s) assigned to the input tag's `value` attribute to override the default and the stored value.</li>
+     *       <li>**delimiter** - (optional, string) the HTML string that delimits multiple elements. This is available if the <var>label</var> key is passed as array. It will be enclosed in inline-block elements so the passed HTML string should not contain block elements.</li>
+     *       <li>**before_input** - (optional, string) the HTML string inserted right before the input tag. It will be enclosed in the <code>label</code> tag so the passed HTML string should not contain block elements.</li>
+     *       <li>**after_input** - (optional, string) the HTML string inserted right after the input tag. It will be enclosed in the <code>label</code> tag so the passed HTML string should not contain block elements.</li>
+     *       <li>**label_min_width** - (optional, string) the inline style property of the `min-width` of the label tag for the field. If the unit is not specified, 'px' is applied. Default: `120`. e.g. `100%`</li>
+     *       <li>**help** - (optional, string) the help description added to the contextual help tab.</li>
+     *       <li>**help_aside** - (optional, string) the additional help description for the side bar of the contextual help tab.</li>
+     *       <li>**repeatable** - [3.0.0+] (optional, array|boolean) whether the fields should be repeatable. If it yields true, the plus and the minus buttons appear next to each field that lets the user add/remove the fields. Optionally an setting array can be passed.
+     *           <h5>Repeatable Fields Setting Array</h5>
+     *           <ul>
+     *                 <li>**max** - the allowed maximum number of fields to be repeated.</li>
+     *                 <li>**min** - the allowed minimum number of fields to be repeated.</li>
+     *                <li>**disabled** - (optional, boolean|array) [3.8.13+]
+     *                    <ul>
+     *                        <li>**message** - (optional, string) the message to show when the user clicks on the `Add` repeatable button.</li>
+     *                        <li>**caption** - (optional, string) the title of the modal window that displays the message. Default: Warning</li>
+     *                        <li>**box_width** - (optional, integer) the width of the modal window that displays the message. Default: 300</li>
+     *                        <li>**box_width** - (optional, integer) the height of the modal window that displays the message. Default: 100.</li>
+     *                    <ul>
+     *                </li>
+     *           </ul>
+     *       </li>
+     *       <li>**sortable** - [3.0.0+] (optional, boolean) whether the fields should be sortable. If it yields true, the fields will be enclosed in a draggable box.
+     *       <li>**attributes** - [3.0.0+] (optional, array) holds key-value pairs representing the attribute and its property. Note that some field types have specific keys in the first dimensions. e.g. `array( 'class' => 'my_custom_class_selector', 'style' => 'background-color:#777', 'size' => 20, )` Every field holds the following nested attribute definition arrays.
+     *           <ul>
+     *               <li>**fieldrow** - the `td` tag element containing the field output.</li>
+     *               <li>**fieldset** - the `fieldset` tag element containing the field output.</li>
+     *               <li>**fields** - the `div` tag element containing the sub-fields and the main field.</li>
+     *               <li>**field** - the `div` tag element containing each field.</li>
+     *           </ul>
+     *       </li>
+     *       <li>**show_title_column** - [3.0.0+] (optional, boolean) If true, the field title column will be omitted from the output.</li>
+     *       <li>**hidden** - [3.0.0+] (optional, boolean) If true, the entire field row output will be invisible with the inline style attribute of `style="display:none"`.</li>
+     *       <li>**save** - [3.6.0+] (optional, boolean) If `false`, the field value will not be saved. Default: `true`</li>
+     *       <li>**content** - (optional, string|array) [3.6.1+] a custom section output. [3.8.0+] Supports an array to be passed for nested and inline-mixed fields. If an array holding field definitions is set, those fields will be nested.
+     *           <h4>Example</h4>
+     * <pre><code>
+     *   $this->addSettingFields(
+     *       'my_section_id', // the target section ID - pass dimensional keys of the section
+     *       array(
+     *           'field_id'      => 'Y',
+     *           'title'         => __( 'Y', 'admin-page-framework-loader' ),
+     *           'description'   => __( 'By passing an array of field definition to the <code>content</code> argument, you can nest fields.', 'admin-page-framework-loader' )
+     *               . ' ' . __( 'Also the <code>type</code> argument can be omitted.', 'admin-page-framework-loader' ),
+     *           'content'       => array(
+     *               array(
+     *                   'field_id'      => 'i',
+     *                   'title'         => __( 'i', 'admin-page-framework-loader' ),
+     *                   'type'          => 'textarea',
+     *               ),
+     *               array(
+     *                   'field_id'      => 'ii',
+     *                   'title'         => __( 'ii', 'admin-page-framework-loader' ),
+     *                   'type'          => 'color',
+     *               ),
+     *               array(
+     *                   'field_id'      => 'iii',
+     *                   'title'         => __( 'iii', 'admin-page-framework-loader' ),
+     *                   'repeatable'    => true,
+     *                   'sortable'      => true,
+     *                   'content'       => array(
+     *                       array(
+     *                           'field_id'      => 'a',
+     *                           'title'         => __( 'a', 'admin-page-framework-loader' ),
+     *                           'type'          => 'image',
+     *                           'attributes'    => array(
+     *                               'preview' => array(
+     *                                   'style' => 'max-width: 200px;',
+     *                               ),
+     *                           ),
+     *                       ),
+     *                       array(
+     *                           'field_id'      => 'b',
+     *                           'title'         => __( 'b', 'admin-page-framework-loader' ),
+     *                           'content'       => array(
+     *                               array(
+     *                                   'field_id'      => 'first',
+     *                                   'title'         => __( '1st', 'admin-page-framework-loader' ),
+     *                                   'type'          => 'color',
+     *                                   'repeatable'    => true,
+     *                                   'sortable'      => true,
+     *                               ),
+     *                               array(
+     *                                   'field_id'      => 'second',
+     *                                   'title'         => __( '2nd', 'admin-page-framework-loader' ),
+     *                                   'type'          => 'size',
+     *                               ),
+     *                               array(
+     *                                   'field_id'      => 'third',
+     *                                   'title'         => __( '3rd', 'admin-page-framework-loader' ),
+     *                                   'type'          => 'select',
+     *                                   'label'         => array(
+     *                                       'x' => 'X',
+     *                                       'y' => 'Y',
+     *                                       'z' => 'Z',
+     *                                   ),
+     *                               ),
+     *                           ),
+     *                           // 'description'   => '',
+     *                       ),
+     *                       array(
+     *                           'field_id'      => 'c',
+     *                           'title'         => __( 'c', 'admin-page-framework-loader' ),
+     *                           'type'          => 'radio',
+     *                           'label'         => array(
+     *                               'a' => __( 'Apple', 'admin-page-framework-loader' ),
+     *                               'b' => __( 'Banana', 'admin-page-framework-loader' ),
+     *                               'c' => __( 'Cherry', 'admin-page-framework-loader' ),
+     *                           ),
+     *                           'default'       => 'b',
+     *                       ),
+     *                   )
+     *               ),
+     *           ),
+     *       )
+     *   );
+     * </code></pre>
+     *       </li>
+     *       <li>**placement** - [3.8.0+] (optional, string) Specifies where the field is rendered. Either `normal` `section_title` or `field_title` is accepted. `field_title` can only be used by nested fields defined in the `content` argument.  Default: `normal`</li>
+     *       <li>**show_debug_info** - (optional, boolean) [3.8.8+] Whether to show debug information such as field definition tool-tips. Default: `true`.</li>
+     * </ul>
+     */
     public function addSettingField( $asFieldset ) {
         if ( method_exists( $this->oForm, 'addField' ) ) {
             $this->oForm->addField( $asFieldset );
@@ -583,26 +583,26 @@ 
     }
 
     /**
-    * Sets the given message to be displayed in the next page load.
-    *
-    * This is used to inform users about the submitted input data, such as "Updated successfully." or "Problem occurred." etc.
-    * and normally used in validation callback methods.
-    *
-    * <h4>Example</h4>
-    * `
-    * if ( ! $bVerified ) {
-    *       $this->setFieldErrors( $aErrors );
-    *       $this->setSettingNotice( 'There was an error in your input.' );
-    *       return $aOldPageOptions;
-    * }
-    * `
-    *
-    * @since 3.0.4
-    * @param string  $sMessage     the text message to be displayed.
-    * @param string  $sType        (optional) the type of the message, either "error" or "updated"  is used.
-    * @param array   $asAttributes (optional) the tag attribute array applied to the message container HTML element. If a string is given, it is used as the ID attribute value.
-    * @param boolean $bOverride    (optional) If true, only one message will be shown in the next page load. false: do not override when there is a message of the same id. true: override the previous one.
-    */
+     * Sets the given message to be displayed in the next page load.
+     *
+     * This is used to inform users about the submitted input data, such as "Updated successfully." or "Problem occurred." etc.
+     * and normally used in validation callback methods.
+     *
+     * <h4>Example</h4>
+     * `
+     * if ( ! $bVerified ) {
+     *       $this->setFieldErrors( $aErrors );
+     *       $this->setSettingNotice( 'There was an error in your input.' );
+     *       return $aOldPageOptions;
+     * }
+     * `
+     *
+     * @since 3.0.4
+     * @param string  $sMessage     the text message to be displayed.
+     * @param string  $sType        (optional) the type of the message, either "error" or "updated"  is used.
+     * @param array   $asAttributes (optional) the tag attribute array applied to the message container HTML element. If a string is given, it is used as the ID attribute value.
+     * @param boolean $bOverride    (optional) If true, only one message will be shown in the next page load. false: do not override when there is a message of the same id. true: override the previous one.
+     */
     public function setSettingNotice( $sMessage, $sType='error', $asAttributes=array(), $bOverride=true ) {
         $this->oForm->setSubmitNotice( $sMessage, $sType, $asAttributes, $bOverride );
     }

Spacing +7 added lines, -7 removed lines

@@ -49,7 +49,7 @@ 
      * @return   array|string
      * @since    3.7.0
      */
-    public function getMessage( $sKey='' ) {
+    public function getMessage( $sKey = '' ) {
         return $this->oMsg->get( $sKey );
     }
 
@@ -181,7 +181,7 @@ 
      * @since   2.1.0
      * @remark  This method just adds the given text into the class property. The actual registration will be performed with the `replyToRegisterHelpTabTextForMetaBox()` method.
      */
-    public function addHelpText( $sHTMLContent, $sHTMLSidebarContent="" ) {
+    public function addHelpText( $sHTMLContent, $sHTMLSidebarContent = "" ) {
         if ( method_exists( $this->oHelpPane, '_addHelpText' ) ) {
             $this->oHelpPane->_addHelpText( $sHTMLContent, $sHTMLSidebarContent );
         }
@@ -215,7 +215,7 @@ 
      */
     public function addSettingSections( /* $aSection1, $aSection2=null, $_and_more=null */ ) {
 
-        foreach( func_get_args() as $_asSectionset ) {
+        foreach ( func_get_args() as $_asSectionset ) {
             $this->addSettingSection( $_asSectionset );
         }
 
@@ -299,7 +299,7 @@ 
      */
     public function addSettingSection( $aSectionset ) {
 
-        if ( ! is_array( $aSectionset ) ) {
+        if ( !is_array( $aSectionset ) ) {
             return;
         }
 
@@ -331,7 +331,7 @@ 
     * @param  array (optional) add more field arrays to the next parameters as many as necessary.
     */
     public function addSettingFields( /* $aField1, $aField2=null, $_and_more=null */ ) {
-        foreach( func_get_args() as $_aFieldset ) {
+        foreach ( func_get_args() as $_aFieldset ) {
             $this->addSettingField( $_aFieldset );
         }
     }
@@ -603,7 +603,7 @@ 
     * @param array   $asAttributes (optional) the tag attribute array applied to the message container HTML element. If a string is given, it is used as the ID attribute value.
     * @param boolean $bOverride    (optional) If true, only one message will be shown in the next page load. false: do not override when there is a message of the same id. true: override the previous one.
     */
-    public function setSettingNotice( $sMessage, $sType='error', $asAttributes=array(), $bOverride=true ) {
+    public function setSettingNotice( $sMessage, $sType = 'error', $asAttributes = array(), $bOverride = true ) {
         $this->oForm->setSubmitNotice( $sMessage, $sType, $asAttributes, $bOverride );
     }
 
@@ -617,7 +617,7 @@ 
      * @param  string  $sType If empty, the method will check if a message exists in all types. Otherwise, it checks the existence of a message of the specified type.
      * @return boolean True if a setting notice is set; otherwise, false.
      */
-    public function hasSettingNotice( $sType='' ) {
+    public function hasSettingNotice( $sType = '' ) {
         return $this->oForm->hasSubmitNotice( $sType );
     }
 

admin-page-framework-loader.php

Spacing +22 added lines, -22 removed lines

@@ -16,9 +16,9 @@ 
  */
 class AdminPageFrameworkLoader_Registry_Base {
 
-    const VERSION        = '3.9.1';    // <--- DON'T FORGET TO CHANGE THIS AS WELL!!
+    const VERSION        = '3.9.1'; // <--- DON'T FORGET TO CHANGE THIS AS WELL!!
     const NAME           = 'Admin Page Framework - Loader'; // the name is not 'Admin Page Framework' because warning messages gets confusing.
-    const SHORTNAME      = 'Admin Page Framework';  // used for a menu title etc.
+    const SHORTNAME      = 'Admin Page Framework'; // used for a menu title etc.
     const DESCRIPTION    = 'Loads Admin Page Framework which facilitates WordPress plugin and theme development.';
     const URI            = 'https://admin-page-framework.michaeluno.jp/';
     const AUTHOR         = 'miunosoft (Michael Uno)';
@@ -55,14 +55,14 @@ 
      * @remark This is also accessed from `uninstall.php` so do not remove.
      * @remark Do not exceed 8 characters as a transient name allows 45 characters or less ( 40 for site transients ) so that md5 (32 characters) can be added.
      */
-    const TRANSIENT_PREFIX         = 'APFL_';
+    const TRANSIENT_PREFIX = 'APFL_';
 
     /**
      * The hook slug used for the prefix of action and filter hook names.
      *
      * @remark The ending underscore is not necessary.
      */
-    const HOOK_SLUG                = 'admin_page_framework_loader';
+    const HOOK_SLUG = 'admin_page_framework_loader';
 
     /**
      * The text domain slug and its path.
@@ -116,7 +116,7 @@ 
      */
     static public $aAdminPages = array(
         // key => 'page slug'
-        'about' => 'apfl_about',   // the welcome page
+        'about' => 'apfl_about', // the welcome page
         'addon' => 'apfl_addons',
         'tool'  => 'apfl_tools',
         'help'  => 'apfl_contact',
@@ -152,12 +152,12 @@ 
      * @since  3.5.0
      * @return string
      */
-    public static function getPluginURL( $sRelativePath='' ) {
+    public static function getPluginURL( $sRelativePath = '' ) {
         if ( isset( self::$_sPluginURLCache ) ) {
-            return self::$_sPluginURLCache . $sRelativePath;
+            return self::$_sPluginURLCache.$sRelativePath;
         }
         self::$_sPluginURLCache = trailingslashit( plugins_url( '', self::$sFilePath ) );
-        return self::$_sPluginURLCache . $sRelativePath;
+        return self::$_sPluginURLCache.$sRelativePath;
     }
         /**
          * @since       3.7.9
@@ -185,13 +185,13 @@ 
      * Sets an admin notice.
      * @since 3.5.0
      */
-    static public function setAdminNotice( $sMessage, $sClassAttribute='error' ) {
-        if ( ! is_admin() ) {
+    static public function setAdminNotice( $sMessage, $sClassAttribute = 'error' ) {
+        if ( !is_admin() ) {
             return;
         }
-        self::$_aAdminNotices[] = array(
+        self::$_aAdminNotices[ ] = array(
             'message'           => $sMessage,
-            'class_attribute'   => trim( $sClassAttribute ) . ' notice is-dismissible',
+            'class_attribute'   => trim( $sClassAttribute ).' notice is-dismissible',
         );
         add_action( 'admin_notices', array( __CLASS__, '_replyToSetAdminNotice' ) );
     }
@@ -200,12 +200,12 @@ 
          * @since 3.5.0
          */
         static public function _replyToSetAdminNotice() {
-            foreach( self::$_aAdminNotices as $_aAdminNotice ) {
-                echo "<div class='" . esc_attr( $_aAdminNotice[ 'class_attribute' ] ) . " notice is-dismissible'>"
+            foreach ( self::$_aAdminNotices as $_aAdminNotice ) {
+                echo "<div class='".esc_attr( $_aAdminNotice[ 'class_attribute' ] )." notice is-dismissible'>"
                         ."<p>"
                             . sprintf(
-                                '<strong>%1$s</strong>: ' . $_aAdminNotice[ 'message' ],
-                                self::NAME . ' ' . self::VERSION
+                                '<strong>%1$s</strong>: '.$_aAdminNotice[ 'message' ],
+                                self::NAME.' '.self::VERSION
                             )
                         . "</p>"
                     . "</div>";
@@ -217,7 +217,7 @@ 
 AdminPageFrameworkLoader_Registry::setUp( __FILE__ );
 
 // Initial checks. - Do no load if accessed directly, not exiting because the 'uninstall.php' and inclusion list generator will load this file.
-if ( ! defined( 'ABSPATH' ) ) {
+if ( !defined( 'ABSPATH' ) ) {
     return;
 }
 if ( defined( 'DOING_UNINSTALL' ) && DOING_UNINSTALL ) {
@@ -229,8 +229,8 @@ 
 
     $_bFrameworkLoaded = class_exists( 'AdminPageFramework_Registry', false );
     if (
-        ! $_bFrameworkLoaded
-        || ! defined( 'AdminPageFramework_Registry::VERSION' ) // backward compatibility
+        !$_bFrameworkLoaded
+        || !defined( 'AdminPageFramework_Registry::VERSION' ) // backward compatibility
         || version_compare( AdminPageFramework_Registry::VERSION, AdminPageFrameworkLoader_Registry::VERSION, '<' )
     ) {
         AdminPageFrameworkLoader_Registry::setAdminNotice(
@@ -248,18 +248,18 @@ 
 add_action( 'admin_init', 'AdminPageFrameworkLoader_Warning' );
 
 // Include the library file - the development version will be available if you cloned the GitHub repository.
-$_sDevelopmentVersionPath = AdminPageFrameworkLoader_Registry::$sDirPath . '/development/admin-page-framework.php';
+$_sDevelopmentVersionPath = AdminPageFrameworkLoader_Registry::$sDirPath.'/development/admin-page-framework.php';
 $_bDebugMode              = defined( 'WP_DEBUG' ) && WP_DEBUG;
 $_bLoadDevelopmentVersion = $_bDebugMode && file_exists( $_sDevelopmentVersionPath );
 include(
     $_bLoadDevelopmentVersion
         ? $_sDevelopmentVersionPath
-        : AdminPageFrameworkLoader_Registry::$sDirPath . '/library/apf/admin-page-framework.php'
+        : AdminPageFrameworkLoader_Registry::$sDirPath.'/library/apf/admin-page-framework.php'
 );
 
 // Include the framework loader plugin components.
 include( AdminPageFramework_Registry::$aClassFiles[ 'AdminPageFramework_PluginBootstrap' ] );
-include( AdminPageFrameworkLoader_Registry::$sDirPath . '/include/class/AdminPageFrameworkLoader_Bootstrap.php' );
+include( AdminPageFrameworkLoader_Registry::$sDirPath.'/include/class/AdminPageFrameworkLoader_Bootstrap.php' );
 new AdminPageFrameworkLoader_Bootstrap(
     AdminPageFrameworkLoader_Registry::$sFilePath,
     AdminPageFrameworkLoader_Registry::HOOK_SLUG    // hook prefix