Wolfgang Sourdeau > CGI-Listman-0.05 > CGI::Listman::line

Download:
CGI-Listman-0.05.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source  

NAME ^

CGI::Listman::line - the internal representation of a database row

SYNOPSIS ^

    use CGI::Listman::line;

DESCRIPTION ^

A CGI::Listman::line represents a row of database stored in a way that permits CGI::Listman and the developer to easily manage some aspects of it. For example, it also contains data on when the row was created, if it was exported through a CGI::Listman::exporter, if it was listed or displayed in some way within a web interface.

The order in which the fields are specified or used should be the same throughout the use of the same instance of CGI::Listman.

API ^

new

This method is to instantiate a CGI::Listman::line. It optionnally takes an array ref as argument which will be the database row this instance will represent in the framework of CGI::Listman.

Parameters

The parameter "data" is optional with this method.

data

A reference to an ARRAY representing a database record. This parameter is optional.

Return values

This method returns a blessed reference to a CGI::Listman::line.

mark_seen

This method should be called whenever the line is considered as being displayed on a user interface.

Parameters

This method takes no parameter.

Return values

This method returns nothing.

mark_exported

This method is called internally by CGI::Listman whenever the line is added to an instance of CGI::Listman::exporter. It should not otherwise be used directly by the developer, except when using its own implementation of an exporter, but please choose to extend the CGI::Listman::exporter API instead.

Parameters

This method takes no parameter.

Return values

This method returns nothing.

number

This method returns the integer representing its position in the database table. This number will be assigned only if the instance get added to a CGI::Listman, otherwise it will stay at 0.

Parameters

This method takes no parameter.

Return values

An integer representing the position of this line.

set_fields

This will set the actual data row of this instance if not previously set by new or this method.

Parameters
fields

A reference to an ARRAY representing a database record.

Return values

This method returns nothing.

update_fields

Since set_fields can only be called once and updating a row requires some internal handling, you need to use this method whenever you update a line's data.

Parameters
fields

A reference to an ARRAY representing a database record.

Return values

This method returns nothing.

line_fields

Use this method whenever you want to access the data encapsulated within this object. Be careful to not modify the resulting fields unless you want to do so since it returns the actual data and not a copy.

Parameters

This method takes no parameter.

Return values

A reference to an ARRAY representing the instance of CGI::Listman::line.

AUTHOR ^

Wolfgang Sourdeau, <Wolfgang@Contre.COM>

COPYRIGHT ^

Copyright (C) 2002 iScream multimédia <info@iScream.ca>

This package is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO ^

CGI::Listman::selection(3) CGI::Listman::exporter(3)

syntax highlighting: