Status Class Reference
[Lib]

Status class. More...

Inheritance diagram for Status:

List of all members.

Public Member Functions
	__construct ($message=false)
	Constructor.
	__get ($name)
	Catch old clients access former public member $message for compatability reason.
	__toString ()
	Convert to string.
	append ($text)
	Append $text to the error message and turns this status into an error.
	count ()
	Returns number of error messages.
	display ($policy=self::OUTPUT_HTML)
	Print status messages.
	get_messages ()
	Returns messages as array.
	is_empty ()
	Returns true, if there is no message.
	is_error ()
	Returns true, if status is an error.
	is_ok ()
	Indicates if there is an error or not.
	merge ($other)
	Merges with another status.
	persist ()
	Save status into session.
	render ($policy=self::OUTPUT_HTML)
	Render status.
	to_string ($policy=self::OUTPUT_HTML)
	Converts messages to a string.
Static Public Member Functions
static	restore ()
	Restore status from sessiom.
Public Attributes
const	OUTPUT_HTML = 'html'
const	OUTPUT_PLAIN = 'plain'
Protected Attributes
	$isError = false
	$messages = array()

---

Detailed Description

Status class.

Indicates either success or an error

If a function returns successfull, it can return a status with isError == false, which is equivalent to is_ok() == true. This is obtained using the default contructor. If a function returns an error, it uses the constructor with a message. isError in this case is true, and is_ok() returns false.

Attention:

Status should be used with plain text message only, since its output routines convert everythig to HTML entities. If you for some reason want HTML in you error messages, you must write your own string conversion.

Author:

Gerd Riesselmann

Definition at line 20 of file status.cls.php.

---

Constructor & Destructor Documentation

Status::__construct

(

$

message = false

)

Constructor.

Parameters:

Mixed

If String: The error message, else if left blank : No error

Definition at line 51 of file status.cls.php.

                                                      {
                if (!empty($message)) {
                        $this->append($message);
                } 
        }

---

Member Function Documentation

Status::__get

(

$

name

)

Catch old clients access former public member $message for compatability reason.

Definition at line 68 of file status.cls.php.

                                 {
        if ($name === 'message') {
                return $this->to_string();
        }
    }

Status::__toString

(

)

Convert to string.

Definition at line 60 of file status.cls.php.

                                     {
                return $this->to_string();
        }

Status::append

(

$

text

)

Append $text to the error message and turns this status into an error.

Parameters:

String

Returns:

void

Definition at line 111 of file status.cls.php.

                                      {
                if (!empty($text)) {
                        $this->messages[] = $text;
                        $this->isError = true;
                }
        }

Status::count

(

)

Returns number of error messages.

Returns:

int

Definition at line 174 of file status.cls.php.

                                {
                return count($this->messages);
        }

Status::display

(

$

policy = self::OUTPUT_HTML

)

Print status messages.

Returns:

void

Definition at line 183 of file status.cls.php.

                                                           {
                print $this->render($policy);
        }

Status::get_messages

(

)

Returns messages as array.

Returns:

array

Definition at line 101 of file status.cls.php.

                                       {
                return $this->messages;
        }

Status::is_empty

(

)

Returns true, if there is no message.

Returns:

bool

Definition at line 166 of file status.cls.php.

                                   {
                return ($this->count() == 0);
        }

Status::is_error

(

)

Returns true, if status is an error.

Returns:

bool

Reimplemented in Message.

Definition at line 157 of file status.cls.php.

                                   {
                return ($this->isError == true);
        }

Status::is_ok

(

)

Indicates if there is an error or not.

Returns:

Boolean

Reimplemented in Message.

Definition at line 148 of file status.cls.php.

                                {
                return ($this->isError == false);
        }

Status::merge

(

$

other

)

Merges with another status.

Messages are added and this status becomes an error if either this or the merged status are errors

Parameters:

Status|Exception|PEAR_Error|string

$other Either Status, Exception, PEAR_Error or a string

Definition at line 126 of file status.cls.php.

                                      {
                if ($other instanceof Status) {
                        foreach($other->get_messages() as $m) {
                                $this->append($m);
                        }
                }
                else if ($other instanceof PEAR_Error) {
                        $this->append($other->getMessage());
                }
                else if ($other instanceof Exception) {
                        $this->append($other->getMessage());
                }
                else if (!empty($other) && is_string($other)){
                        $this->append($other);
                }
        }  

Status::persist

(

)

Save status into session.

Returns:

bool True, if status was persisted

Definition at line 205 of file status.cls.php.

                                  {
                if (!$this->is_empty()) {
                        Session::push('status', $this);
                        return true;
                }
                return false;
        }

Status::render

(

$

policy = self::OUTPUT_HTML

)

Render status.

Returns:

string

Reimplemented in Message.

Definition at line 192 of file status.cls.php.

                                                          {
                $ret = $this->to_string($policy);
                if ($ret !== '' && $policy == self::OUTPUT_HTML) {
                        $ret = html::error($ret);
                }
                return $ret;
        }

static Status::restore

(

)

[static]

Restore status from sessiom.

Returns:

Status False if no status was in session

Definition at line 218 of file status.cls.php.

                                         {
                $ret = false;
                if (Session::is_started()) {
                        $ret = Session::pull('status');
                }
                return $ret;
        }  

Status::to_string

(

$

policy = self::OUTPUT_HTML

)

Converts messages to a string.

Messages are divided by
for HTML and
for plain text output.

Attention:

For HTML output, messages are escaped, so if your messages contain HTML tags, they will be converted to < etc

Returns:

string

Definition at line 84 of file status.cls.php.

                                                             {
                $ret = '';
                if ($policy == self::OUTPUT_PLAIN) {
                        $ret .= implode("\n", $this->messages); 
                }
                else {
                        $tmp = array_map(array('String', 'escape'), $this->messages);
                        $ret .= implode('<br />', $tmp);
                }
                return $ret; 
        }

---

Member Data Documentation

Status::$isError = false [protected]

Definition at line 44 of file status.cls.php.

Status::$messages = array() [protected]

Definition at line 37 of file status.cls.php.

const Status::OUTPUT_HTML = 'html'

Definition at line 21 of file status.cls.php.

const Status::OUTPUT_PLAIN = 'plain'

Definition at line 22 of file status.cls.php.

---

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

• gyro/core/lib/helpers/status.cls.php