.
Gyro-PHP > Documentation

Message Class Reference
[Lib]

Success message class. More...

Inheritance diagram for Message:
Status

List of all members.

Public Member Functions
  is_error ()
  Returns true, if status is an error.
  is_message ()
  Kept for compatability.
  is_ok ()
  Indicates if there is an error or not.
  render ($policy=self::OUTPUT_HTML)
  Render status.

Detailed Description

Success message class.

Used to indicate success

For the Status class, each text passed turns it into an error. The Message class however, allows to return a message on success, too

Attention:
Don't try to mix Status and Message, e.g. by merging a Message with a Status. The result will be definitely not meaningful, since neither of them can handle such a case.
Author:
Gerd Riesselmann

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

Member Function Documentation

Message::is_error (  ) 

Returns true, if status is an error.

Returns:
bool

Reimplemented from Status.

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

00251                                    {
00252                 return false;
00253         }
Message::is_message (  ) 

Kept for compatability.

. Meaningless

Deprecated:
Returns:
bool

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

00273                                      {
00274                 return true;
00275         }
Message::is_ok (  ) 

Indicates if there is an error or not.

Returns:
Boolean

Reimplemented from Status.

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

00255                                 {
00256                 return true;
00257         }
Message::render ( $  policy = self::OUTPUT_HTML  ) 

Render status.

Returns:
string

Reimplemented from Status.

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

00259                                                                 {
00260                 $ret = $this->to_string($policy);
00261                 if ($policy == self::OUTPUT_HTML) {
00262                         $ret = html::success($ret);
00263                 }
00264                 return $ret;
00265         }
The documentation for this class was generated from the following file: