APF_Demo_BuiltinFieldTypes_Text_Text::__construct PHP Method

__construct() public method

Sets up a form section.
public __construct ( $oFactory )
    public function __construct($oFactory)
    {
        /**
         * ( optional ) Create a form - To create a form in Admin Page Framework, you need two kinds of components: sections and fields.
         * A section groups fields and fields belong to a section. So a section needs to be created prior to fields.
         * Use the addSettingSections() method to create sections and use the addSettingFields() method to create fields.
         */
        /**
         * Sections
         */
        $oFactory->addSettingSections($this->sPageSlug, array('section_id' => $this->sSectionID, 'tab_slug' => $this->sTabSlug, 'title' => __('Text Fields', 'admin-page-framework-loader'), 'tip' => __('With the <code>tip</code> argument in a section definition array, a tool tip can be inserted.', 'admin-page-framework-loader'), 'description' => __('These are text type fields.', 'admin-page-framework-loader'), 'order' => 10));
        /**
         * Text input fields - text, password, number, textarea, rich text editor
         */
        $oFactory->addSettingFields($this->sSectionID, array('field_id' => 'text', 'type' => 'text', 'title' => __('Text', 'admin-page-framework-loader'), 'order' => 1, 'default' => 123456, 'description' => array(__('Type something here.', 'admin-page-framework-loader'), "<pre>" . $oFactory->oWPRMParser->getSyntaxHighlightedPHPCode(<<<EOD
array(
    'type'              => 'text',
    'title'             => 'Text',
    'default'           => 123456,
)
EOD
) . "</pre>")), array('field_id' => 'text_with_help', 'type' => 'text', 'title' => __('Text with Help Pane', 'admin-page-framework-loader'), 'help' => __('This is a text field and typed text will be saved.', 'admin-page-framework-loader') . ' ' . __('This text is inserted with the <code>help</code> argument in the field definition array.', 'admin-page-framework-loader'), 'description' => array(__('Click and open the top-right help pane to see the set text is displayed', 'admin-page-framework-loader'), "<pre>" . $oFactory->oWPRMParser->getSyntaxHighlightedPHPCode(<<<EOD
array(
    'type'              => 'text',
    'help'              => 'This contextual help text can be set with the...',
)
EOD
) . "</pre>")), array('field_id' => 'text_with_placeholder', 'type' => 'text', 'title' => __('Placeholder', 'admin-page-framework-loader'), 'attributes' => array('size' => 40, 'placeholder' => __('Type something here.', 'admin-page-framework-loader')), 'description' => array("<pre>" . $oFactory->oWPRMParser->getSyntaxHighlightedPHPCode(<<<EOD
array(
    'type'              => 'text',
    'attributes'        => array(
        'size' => 40,
        'placeholder' => 'Type something here.',
    ),
)
EOD
) . "</pre>")), array('field_id' => 'text_with_tip', 'type' => 'text', 'title' => __('Text with Tip', 'admin-page-framework-loader'), 'tip' => __('With the <code>tip</code> argument in a field definition array, a tool tip can be inserted.', 'admin-page-framework-loader'), 'description' => array(__('This text is inserted with the <code>description</code> argument in the field definition array.', 'admin-page-framework-loader'), __('The argument accepts as an array and each element will be treated as one paragraph.', 'admin-page-framework-loader'), "<pre>" . $oFactory->oWPRMParser->getSyntaxHighlightedPHPCode(<<<EOD
array(
    'type'              => 'text',
    'tip'               => 'With the <code>tip</code> argument in a field...',
    'description'       => array(
        'This text is inserted with...',
        'The argument accepts as an array...',
    ),
)
EOD
) . "</pre>")), array('field_id' => 'read_only_text', 'title' => __('Read Only', 'admin-page-framework-loader'), 'type' => 'text', 'attributes' => array('size' => 20, 'readonly' => 'readonly'), 'value' => __('This is a read-only value.', 'admin-page-framework-loader'), 'description' => array(__('The attribute can be set with the <code>attributes</code> argument.', 'admin-page-framework-loader'), __('The argument accepts as an array and each element will be treated as one paragraph.', 'admin-page-framework-loader'), "<pre>" . $oFactory->oWPRMParser->getSyntaxHighlightedPHPCode(<<<EOD
array(
    'type'              => 'text',
    'value'             => 'This is a read-only value.',
    'attributes'        => array(
        'size'          => 20,
        'readonly'      => 'readonly',
        // Similarly, disabled can be specified like so
        // 'disabled' => 'disabled', 
    ),
)
EOD
) . "</pre>")), array('field_id' => 'text_multiple_with_label', 'title' => __('Multiple with Labels', 'admin-page-framework-loader'), 'type' => 'text', 'default' => array('first' => 'First Item', 'second' => 'Second Item', 'third' => 'Third Item'), 'label' => array('first' => __('First', 'admin-page-framework-loader'), 'second' => __('Second', 'admin-page-framework-loader'), 'third' => __('Third', 'admin-page-framework-loader')), 'description' => array(__('These uses the <code>label</code> argument to crate multiple elements.', 'admin-page-framework-loader'), "<pre>" . $oFactory->oWPRMParser->getSyntaxHighlightedPHPCode(<<<EOD
array(
    'type'              => 'text',
    'default'           => array(
        'first'  => 'First Item',
        'second' => 'Second Item',
        'third'  => 'Third Item',
    ),
    'label'             => array(
        'first'  => 'First',
        'second' => 'Second',
        'third'  => 'Third',
    ),
)
EOD
) . "</pre>")), array('field_id' => 'text_repeatable', 'title' => __('Repeatable', 'admin-page-framework-loader'), 'type' => 'text', 'default' => 'a', 'repeatable' => true, 'tip' => array(__('With the <code>repeatable</code> argument, you can let your users add and remove field items dynamically.', 'admin-page-framework-loader'), __('Press the <code>+</code>/<code>-</code> button to add/remove the fields. To enable the repeatable fields functionality, set the <code>repeatable</code> argument to <code>true</code>.', 'admin-page-framework-loader')), 'description' => array("<pre>" . $oFactory->oWPRMParser->getSyntaxHighlightedPHPCode(<<<EOD
array(
    'type'              => 'text',
    'default'           => 'a',
    'repeatable'        => true,
)
EOD
) . "</pre>")), array('field_id' => 'text_repeatable_with_arguments', 'title' => __('Maximum and Minimum Number to Repeat', 'admin-page-framework-loader'), 'type' => 'text', 'default' => __('Keep clicking on the <code>+</code> button', 'admin-page-framework-loader'), 'repeatable' => array('max' => 10, 'min' => 3), 'description' => array(__('To set maximum and minimum numbers of fields, set the <code>max</code> and <code>min</code> arguments in the <code>repeatable</code> argument array in the field definition array.'), "<pre>" . $oFactory->oWPRMParser->getSyntaxHighlightedPHPCode(<<<EOD
array(
    'type'              => 'text',
    'repeatable'        => array(
        'max' => 10,
        'min' => 3,
    ),
)
EOD
) . "</pre>")), array('field_id' => 'text_sortable', 'title' => __('Sortable', 'admin-page-framework-loader'), 'type' => 'text', 'default' => 'a', 'label' => __('Sortable Item', 'admin-page-framework-loader'), 'sortable' => true, array('default' => 'b'), array('default' => 'c'), array('label' => __('Disabled Item', 'admin-page-framework-loader'), 'default' => 'd', 'attributes' => array('disabled' => 'disabled')), 'description' => array(__('Drag and drop the fields to change the order.', 'admin-page-framework-loader'), "<pre>" . $oFactory->oWPRMParser->getSyntaxHighlightedPHPCode(<<<EOD
array(
    'type'              => 'text',
    'default'           => 'a',
    'label'             => __( 'Sortable Item', 'admin-page-framework-loader' ),
    'sortable'          => true,
    array(
        'default'       => 'b',
    ),
    array(
        'default'       => 'c',
    ),     
    array(
        'label'         => __( 'Disabled Item', 'admin-page-framework-loader' ),
        'default'       => 'd',
        'attributes'    => array(
            'disabled' => 'disabled',
        ),
    ),
)
EOD
) . "</pre>")), array('field_id' => 'text_repeatable_and_sortable', 'title' => __('Repeatable & Sortable', 'admin-page-framework-loader'), 'type' => 'text', 'repeatable' => true, 'sortable' => true, 'description' => array(__('Drag and drop the fields to change the order.', 'admin-page-framework-loader'), "<pre>" . $oFactory->oWPRMParser->getSyntaxHighlightedPHPCode(<<<EOD
array(
    'type'              => 'text',
    'sortable'          => true,
    'repeatable'    => true,
)
EOD
) . "</pre>")), array('field_id' => 'password', 'title' => __('Password', 'admin-page-framework-loader'), 'tip' => __('This input will be masked.', 'admin-page-framework-loader'), 'type' => 'password', 'help' => __('This is a password type field; the user\'s entered input will be masked.', 'admin-page-framework-loader'), 'attributes' => array('size' => 20), 'description' => array(__('The entered characters will be masked.', 'admin-page-framework-loader'), "<pre>" . $oFactory->oWPRMParser->getSyntaxHighlightedPHPCode(<<<EOD
array(
    'type'              => 'password',
)
EOD
) . "</pre>")), array('field_id' => 'number', 'title' => __('Number', 'admin-page-framework-loader'), 'type' => 'number', 'default' => 42, 'description' => array("<pre>" . $oFactory->oWPRMParser->getSyntaxHighlightedPHPCode(<<<EOD
array(
    'type'              => 'number',
)
EOD
) . "</pre>")), array('field_id' => 'number_with_attributes', 'title' => __('Number with Attributes', 'admin-page-framework-loader'), 'type' => 'number', 'attributes' => array('max' => 100, 'min' => 0, 'step' => 10), 'default' => 50, 'description' => array("<pre>" . $oFactory->oWPRMParser->getSyntaxHighlightedPHPCode(<<<EOD
array(
    'type'              => 'number',
    'attributes'        => array(
        'max'   => 100,
        'min'   => 0,
        'step'  => 10,
    ),
)
EOD
) . "</pre>")), array());
    }
APF_Demo_BuiltinFieldTypes_Text_Text