NAME

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

SYNOPSIS

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


 $article = $tts->Article;
 $article = $tts->Article( $ID );


 $article->update;

EXAMPLES

DESCRIPTION

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

BASIC METHODS

new

Create a new Article object from a TTS object.

Input Parameters

 1 Liz::TTS object
 2 ID to created Article object with
   (default: none = new article)
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;
 $article = $tts->Article;
 $article = $tts->Article( $ID );

update

Update an Article object in the Liz::TTS database.

Output Parameters

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

 $ID = $article->update;

delete

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

Output Parameters

 1 flag: whether action was successful
Example

 $article->delete;

CONTENT METHODS

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

AuthorIDs

Return or set the AuthorIDs of the Liz::TTS::Article object.

Output Parameters

 1..N new AuthorIDs (default: no change)
Output Parameters

 1..N current / old AuthorIDs
Example

 @authorID = $article->AuthorIDs;

Intro

Set / return the Intro of the Liz::TTS::Article object.

Input Parameters

 1 Intro of the Article
Output Parameters

 1 Intro of the Article
Example

 $intro = $article->Intro;
 $article->Intro( $the_intro );

Created

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

Output Parameters

 1 current timestamp value of the Created date
Example

 $created = $article->Created;

ID

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

Output Parameters

 1 current ID of the object
Example

 $ID = $article->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

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

AddTextID

Add or move (eg. change order of) a text ID in the article. If the ID exists in the list already, it is moved. If it does not exist yet, it is added (at the specified location).

Input Parameters

 1 ID to add/move
 2 Location to move to (default: at the beginning)
   Note: to add a text at the end of the list, use 'end'
Example

# Add text at the beginning # Add text at end # Move an existing ID (basically the same operation as above) 

 $article->AddTextID( $newID );
 $article->AddTextID( $newID,'end' );
 $article->AddTextID( $moveID,'end' );

TextIDs

Return or set the TextIDs of the Liz::TTS::Article object.

Output Parameters

 1..N new textIDs (default: no change)
Output Parameters

 1..N current / old textIDs
Example

 @textID = $article->TextIDs;

PictureID

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

Output Parameters

 1 current ID of the object
Example

 $ID = $article->PictureID;

SortName

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

Output Parameters

 1 current ID of the object
Example

 $ID = $article->SortName;

Updated

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

Output Parameters

 1 current timestamp value of the Updated date
Example

 $updated = $article->Updated;

AUTHOR

Sjoerd Lawende( sjoerd@xxLINK.nl )

COPYRIGHT

(C) 1998-1999 xxLINK Internet Services

HISTORY

Version 0.11, 31 October 1999

Added methods AddTextID, TextIDs, fixed some problems in new and update.

Version 0.10, 28 October 1999

First version of this module.