Admin Page Framework Documentation

Packages

  • AdminPageFramework
    • Common
      • Factory
      • Form
        • FieldType
      • Utility
    • Factory
      • AdminPage
      • MetaBox
      • NetworkAdmin
      • PageMetaBox
      • PostType
      • TaxonomyField
      • TermMeta
      • UserMeta
      • Widget
    • Utility

Classes

  • AdminPageFramework_AdminNotice
  • AdminPageFramework_ArrayHandler
  • AdminPageFramework_Debug
  • AdminPageFramework_Debug_Base
  • AdminPageFramework_Debug_Log
  • AdminPageFramework_Debug_Utility
  • AdminPageFramework_RegisterClasses

Resources

  • Tutorials
  • Support
  • Reporting Issues

Class AdminPageFramework_ArrayHandler

Provides methods to help handle array contents.

This is useful when you edit multi-dimensional arrays.

Usage

Instantiate the class by passing an array to manipulate. Then use the set(), get(), and delete() methods to retrieve/modify the contents.

Example

$_aArray = array(
     'a' => array(
         'a_i' => array(
             'a_i_x' => array(
                 'foo',
                 'bar',
             ),
         ),
     )
);
$_oData  = new AdminPageFramework_ArrayHandler( $_aArray );
$_oData->set( array( 'a', 'a_i', 'a_i_y' ), 'A New Value' );
var_dump( $_oData->get( 'a', 'a_i' ) );
$_oData->delete( array( 'a', 'a_i' ) );
var_dump( $_oData->get( 'a' ) );

Package: AdminPageFramework\Common\Utility
Since: 3.6.0
Extends: AdminPageFramework_FrameworkUtility
Located at factory/_common/utility/AdminPageFramework_ArrayHandler.php

Methods summary

public
# __construct( )

Sets up properties.

Since

3.6.0
public
# get( )

Returns the specified option value.

Since

3.6.0
public
# set( )

Sets an value by specified dimensional keys.

Since

3.6.0
public
# delete( )

Removes an element by dimensional keys.

Since

3.6.0

Magic methods summary

Related

If you find undocumented functionality, please report it here.

Admin Page Framework