PEAR Manual
Prev |  | Next

# Controller::container()

Controller::container() -- Returns a reference to the form's values container.

## Synopsis

    require_once 'HTML/QuickForm/Controller.php';

``array &HTML_QuickForm_Controller::container` ([bool $reset = `FALSE`])`

## Description

Returns a reference to a session variable containing the form-page values and pages' validation status. This is a "low-level" method, use exportValues() if you want just to get the form's values.

The structure of the container is the following

    array (
        'defaults'  => array(... default form values ...),
        'constants' => array(... constant form values ...),
        'values'    => array(
            'page1' => array(... submitted values for this page ...),
            ...
            'pageN' => array(... submitted values for this page ...)
        ),
        'valid'     => array(
            'page1' => null if the page was never validated, true if valid, false otherwise
            ...
            'pageN' => null if the page was never validated, true if valid, false otherwise
        )
    )

## Parameter

boolean `$reset`

  If true, then reset the container: clear all default, constant and submitted values

## Throws

throws no exceptions thrown

## Note

This function can not be called statically.

Prev | Home | Next
Controller::applyDefaults() | Up | Controller::exportValue()