NAME

Liz::TTS - Total Texts System ( NL: Totaal Tekst Systeem )


SYNOPSIS

 use Liz::TTS;

 $file = new Liz::TTS;


EXAMPLES

 #!/usr/local/bin/perl

 use Liz::TTS;


DESCRIPTION

The Liz::TTS package allows


new

Create a new Liz::TTS object. Creates connection or re-establishes connection with the MySQL database. Usually not called by itself, but rather incorporated inside a Client Module.

Input Parameters

 1 Liz::SQL compatible handle or reference to routine that performs connect
   (default: &Connect from caller's namespace)
 2 identification name of the tts
   (default: default file set for database)
Output Parameters

 1 instantiated object
 2 flag whether TTS was just created
Example

 $client = new Client;
 $tts = $client->TTS( 'environment' );

In A_Client.pm:

 sub TTS { Liz::TTS->new( @_ ) }


reset

Delete all tables of the TTS object. Please use this with caution, as it will destroy any information that is stored for this TTS. If called in a void context, no tables exist for this TTS anymore, and any references in the NextID table are also removed. Otherwise, the tables will be re-created automatically and a new object will be returned, just as if the new method was called.

Output Parameters

 1 newly created TTS object, current object will not work anymore
Example

 $tts->reset;
Example

 $tts = $tts->reset;


CONSTRUCTOR METHODS

The following methods allow for the instantiation of TTS related objects


Article

Create a new Liz::TTS::Article object, either from existing information or for a new entry. For more documentation, see the Liz::TTS::Article object itself.

Input Parameters

 1 ID to create Article object with
   (default: none = new record)
Output Parameters

 1 instantiated Article object
Example

 $client = new A_Client;
 $tts = $client->TTS( 'environment' );

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


Picture

Create a new Liz::TTS::Picture object, either from existing information or for a new entry. For more documentation, see the Liz::PictureSet::Picture object itself.

Output Parameters

 1 instantiated Liz::TTS::Picture object


PictureSet

Return the PictureSet object that belongs to this TTSet

Output Parameters

 1 PictureSet object
Example

 $client = new Client;
 $pictureset = $client->PictureSet;


Text

Create a new Liz::TTS::Text object, either from existing information or for a new entry. For more documentation, see the Liz::TTS::Text object itself.

Input Parameters

 1 ID to create Text object with
   (default: none = new record)
Output Parameters

 1 instantiated Text object
Example

 $client = new A_Client;
 $tts = $client->TTS( 'environment' );

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


LIST METHODS

The following methods allow listing of information in the TTS.


Articles

Return an SQL statement handle for a list of Articles.

Input Parameters

 1 ordinal number or ID of article from which to commence listing
 2 fields to return (comma delimited)
   (default: 
      'ID,name,intro,sortname,created,updated,published,status,pictureID')
 3 fieldname on which to order the result
   (default: 'sortname')
 4 extra condition to be applied
   (default: none)
 5 limit for the number of results returned
Output Parameters

 1 SQL statement handle (on which method "fetchrow" can be applied)


Texts

Return an SQL statement handle for a list of Texts.

Input Parameters

 1 ordinal number or ID of article from which to commence listing
 2 fields to return (comma delimited)
   (default: 
      'ID,name,body,sortname,created,updated,published,status,articleID,pictureID')
 3 fieldname on which to order the result
   (default: 'sortname')
 4 extra condition to be applied
   (default: none)
 5 limit for the number of results returned
Output Parameters

 1 SQL statement handle (on which method "fetchrow" can be applied)


CONTENT METHODS

The following methods allow changes to information that is associated with an entire tts.


Name

Specify or return the current name of the tts object. The name can be anything to further identify the goal of the tts.

Input Parameters

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

 1 current/old name of tts
Example

 $xxlink = new xxLINK;
 $tts = $xxlink->TTS( 'environment' );
 $tts->Name( 'The Environment Newsroom' );


AUTHOR

Sjoerd Lawende ( sjoerd@xxlink.nl )


COPYRIGHT

(C) 1998-1999 xxLINK Internet Services


HISTORY

Version 0.13, 3 December 1999

Put module name between quotes to fix obscure bug in Perl 5.005x under ModPerl in method PictureSet.

Version 0.12, 25 November 1999

Put module name between quotes to fix obscure bug in Perl 5.005x under ModPerl in methods Article, Picture and Text.

Version 0.11, 28 October 1999

Added create for Article tables.

Version 0.10, 27 October 1999

First version of this module.