Form Class Reference

Inheritance diagram for Form:

[legend]

Collaboration diagram for Form:

[legend]

Public Member Functions
	add ($element, $options=array())
	addButton ($name, $value, $klass="btnPrimary", $extra="", $type="submit")
	addCancelButton ($name)
	addExpertButton ($name, $value)
	addOnClickButton ($text, $url)
	addSummary ($msg)
	addValidateButton ($name)
	begin ()
	display ()
	end ()
	Form ($options=array())
	getButtonString ($name, $value, $klass="btnPrimary", $extra="", $type="submit")
	hasBeenPopped ()
	HtmlContainer ()
	pop ()
	push ($element)
Data Fields
	$debug
	$elements
	$index
	$popped

---

Detailed Description

Definition at line 2071 of file PageGenerator.php.

---

Member Function Documentation

HtmlContainer::add	(	$	element,
		$	options = array()
	)			[inherited]

Definition at line 1999 of file PageGenerator.php.

                                               {
        $element->setOptions($options);
        $this->push($element);
    }

Form::addButton	(	$	name,
		$	value,
		$	klass = "btnPrimary",
		$	extra = "",
		$	type = "submit"
	)

Definition at line 2098 of file PageGenerator.php.

                                                                                            {
        $b = new Button();
        $this->buttons[] = $b->getButtonString($name, $value, $klass, $extra, $type);
    }

Form::addCancelButton

(

$

name

)

Reimplemented in PopupForm.

Definition at line 2108 of file PageGenerator.php.

                                    {
        $b = new Button();
        $this->buttons[] = $b->getCancelButtonString($name, "btnSecondary");
    }

Form::addExpertButton	(	$	name,
		$	value
	)

Definition at line 2113 of file PageGenerator.php.

                                            {
        $d = new DivExpertMode();
        $b = new Button();
        $this->buttons[] = $d->begin() . $b->getButtonString($name, $value) . $d->end();
    }

Form::addOnClickButton	(	$	text,
		$	url
	)

Definition at line 2128 of file PageGenerator.php.

                                           {
        $b = new Button();
        $this->buttons[] = $b->getOnClickButton($text, $url);
    }

Form::addSummary

(

$

msg

)

Definition at line 2119 of file PageGenerator.php.

                              {
        $this->summary = $msg;
    }

Form::addValidateButton

(

$

name

)

Definition at line 2103 of file PageGenerator.php.

                                      {
        $b = new Button();
        $this->buttons[] = $b->getValidateButtonString($name);
    }

Form::begin

(

)

Reimplemented from HtmlContainer.

Reimplemented in PopupForm.

Definition at line 2081 of file PageGenerator.php.

                     {
        $str = "";
        foreach($this->options as $key => $value) $str.= " $key=\"$value\"";
        $ret = "<form$str>";
        if (isset($this->summary)) {
            $ret = "<p>" . $this->summary . "</p>\n" . $ret;
        }
        return $ret;
    }

HtmlContainer::display

(

)

[inherited]

Definition at line 1993 of file PageGenerator.php.

                       {
        print "\n" . $this->begin() . "\n";
        foreach($this->elements as $element) $element->display();
        print "\n" . $this->end() . "\n";
    }

Form::end

(

)

Reimplemented from HtmlContainer.

Reimplemented in ValidatingForm, and PopupForm.

Definition at line 2091 of file PageGenerator.php.

                   {
        $str = "";
        foreach($this->buttons as $button) $str .= "\n$button\n";
        $str .= "\n</form>\n";
        return $str;
    }

Form::Form

(

$

options = array()

)

Definition at line 2073 of file PageGenerator.php.

                                      {
        $this->HtmlContainer();
        if (!isset($options["method"])) $options["method"] = "post";
        $this->options = $options;
        $this->buttons = array();
        $this->summary = NULL;
    }

Form::getButtonString	(	$	name,
		$	value,
		$	klass = "btnPrimary",
		$	extra = "",
		$	type = "submit"
	)

Definition at line 2123 of file PageGenerator.php.

                                                                                                  {
        $b = new Button();
        return $b->getButtonString($name, $value, $klass, $extra, $type);
    }

HtmlContainer::hasBeenPopped

(

)

[inherited]

Definition at line 2023 of file PageGenerator.php.

                             {

        if ($this->popped) $ret = True;
        else if ($this->index == -1) $ret = False;
        else $ret = False;
        return $ret;
    }

HtmlContainer::HtmlContainer

(

)

[inherited]

Definition at line 1979 of file PageGenerator.php.

                             {
        $this->elements = array();
        $this->popped = False;
        $this->index = -1;
    }

HtmlContainer::pop

(

)

[inherited]

Definition at line 2031 of file PageGenerator.php.

                   {
        if (!$this->popped) {
            if ($this->index == -1)
                $this->popped = True;
            else if ($this->elements[$this->index]->hasBeenPopped())
                $this->popped = True;
            else $this->elements[$this->index]->pop();
            //if ($this->popped) print "popping " . $this->options["id"] . "<br>";
        } else die("Nothing more to pop");
    }

HtmlContainer::push

(

$

element

)

[inherited]

Definition at line 2004 of file PageGenerator.php.

                            {
        if ($this->index == -1) {
            /* Add first element to container */
            $this->index++;
            $this->elements[$this->index] = $element;
            //print "pushing " . $element->options["id"] . " into " . $this->options["id"] . "<br>";
        } else {
            if ($this->elements[$this->index]->hasBeenPopped()) {
                /* All the contained elements have been popped, so add the new element in the list */
                $this->index++;
                $this->elements[$this->index] = $element;
                //print "pushing " . $element->options["id"] . " into " . $this->options["id"] . "<br>";
            } else {
                /* Recursively push a new element into the container */
                $this->elements[$this->index]->push($element);
            }
        }
    }

---

Field Documentation

HtmlContainer::$debug [inherited]

Definition at line 1977 of file PageGenerator.php.

HtmlContainer::$elements [inherited]

Definition at line 1974 of file PageGenerator.php.

HtmlContainer::$index [inherited]

Definition at line 1975 of file PageGenerator.php.

HtmlContainer::$popped [inherited]

Definition at line 1976 of file PageGenerator.php.

---

The documentation for this class was generated from the following file:

• mmc/includes/PageGenerator.php