NAME

Liz::TTS::Text - module for Text objects of the TTS


SYNOPSIS

 use Liz::TTS;
 $tts = new Liz::TTS;

 $text = $tts->Text;
 $text = $tts->Text( $ID );

 $text->update;


EXAMPLES


DESCRIPTION

Provide object oriented access to texts in a TTS. Usually not accessed directly, but rather through the Liz::TTS object and its Text method.


BASIC METHODS


new

Create a new Text object from a TTS object.

Input Parameters

 1 Liz::TTS object
 2 ID to created Text object with
   (default: none = new text)
Output Parameters

 1 instantiated object
Note

It is not intended to call this method directly, but rather indirectly through the Liz::TTS module.

Example

 $tts = new Liz::TTS;
 $text = $tts->Text;
 $text = $tts->Text( $ID );


update

Update a Text object in the Liz::TTS database.

Output Parameters

 1 ID with which the object was updated (undef = error)
Example

 $ID = $text->update;


delete

Delete the Liz::TTS::Text object from the database.

Output Parameters

 1 flag: whether action was successful
Example

 $text->delete;


CONTENT METHODS

The following methods allow you to inspect and/or change certain fields of the Liz::TTS::Text object.


ArticleID

Return the ArticleID of the Liz::TTS::Text object.

Output Parameters

 1 current ArticleID 
Example

 $created = $text->ArticleID;


AuthorID

Return the AuthorID of the Liz::TTS::Text object.

Output Parameters

 1 current ID of the object
Example

 $ID = $text->AuthorID;


Created

Return the Created timestamp of the Liz::TTS::Text object.

Output Parameters

 1 current timestamp value of the Created date
Example

 $created = $text->Created;


ID

Return the ID of the Liz::TTS::Text object.

Output Parameters

 1 current ID of the object
Example

 $ID = $text->ID;


Name

Return or set the Name information of the object.

Input Parameters

 1 new name of the Name
   (default: no change)
Output Parameters

 1 current/old name of the Name
Example

 $text->Name( 'Chapter 2' );
 $name = $text->Name;


PictureID

Return the PictureID of the Liz::TTS::Text object.

Output Parameters

 1 current ID of the object
Example

 $ID = $text->PictureID;


SortName

Return the SortName of the Liz::TTS::Text object.

Output Parameters

 1 current ID of the object
Example

 $ID = $text->SortName;


Updated

Return the Updated timestamp of the Liz::TTS::Text object.

Output Parameters

 1 current timestamp value of the Updated date
Example

 $updated = $text->Updated;


AUTHOR

Sjoerd Lawende( sjoerd@xxLINK.nl )


COPYRIGHT

(C) 1998-1999 xxLINK Internet Services


HISTORY

Version 0.12, 31 October 1999

Corrected the $FIELDS definition

Version 0.11, 28 October 1999

Now uses 'goto &Liz::Name'-trick to set / get the Name Added documentation for autoloaded methods

Version 0.10, 27 October 1999

First version of this module.