John Siracusa > Rose-HTML-Objects-0.618 > Rose::HTML::Object::Message

Download:
Rose-HTML-Objects-0.618.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 0.606   Source   Latest Release: Rose-HTML-Objects-0.621

NAME ^

Rose::HTML::Object::Message - Text message object.

SYNOPSIS ^

  $msg = Rose::HTML::Object::Message->new('Hello world');
  print $msg->text; # Hello world

DESCRIPTION ^

Rose::HTML::Object::Message objects encapsulate a text message with an optional integer id.

This class inherits from, and follows the conventions of, Rose::Object. See the Rose::Object documentation for more information.

OVERLOADING ^

Stringification is overloaded to call the text method. In numeric and boolean contexts, Rose::HTML::Object::Message objects always evaluate to true.

CONSTRUCTOR ^

new [ PARAMS | TEXT ]

Constructs a new Rose::HTML::Object::Message object. If a single argument is passed, it is taken as the value for the text parameter. Otherwise, PARAMS name/value pairs are expected. Any object method is a valid parameter name.

OBJECT METHODS ^

id [INT]

Get or set the message's integer identifier.

text [ TEXT | OBJECT ]

Get or set the message's text. If the message text is set to a TEXT string (rather than a Rose::HTML::Object::Message-derived OBJECT), the id is set to the value of the constant Rose::HTML::Object::Message::CUSTOM_MESSAGE.

AUTHOR ^

John C. Siracusa (siracusa@gmail.com)

LICENSE ^

Copyright (c) 2010 by John C. Siracusa. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: