/ 
CPANTS-Weight-0.08
River stage zero No dependents
/ CPANTS::Weight::AuthorWeight

NAME

CPANTS::Weight::AuthorWeight - CPANTS::Weight class for the author_weight table

SYNOPSIS

TO BE COMPLETED

DESCRIPTION

TO BE COMPLETED

METHODS

select

# Get all objects in list context
my @list = CPANTS::Weight::AuthorWeight->select;

# Get a subset of objects in scalar context
my $array_ref = CPANTS::Weight::AuthorWeight->select(
    'where id > ? order by id',
    1000,
);

The select method executes a typical SQL SELECT query on the author_weight table.

It takes an optional argument of a SQL phrase to be added after the FROM author_weight section of the query, followed by variables to be bound to the placeholders in the SQL phrase. Any SQL that is compatible with SQLite can be used in the parameter.

Returns a list of CPANTS::Weight::AuthorWeight objects when called in list context, or a reference to an ARRAY of CPANTS::Weight::AuthorWeight objects when called in scalar context.

Throws an exception on error, typically directly from the DBI layer.

count

# How many objects are in the table
my $rows = CPANTS::Weight::AuthorWeight->count;

# How many objects 
my $small = CPANTS::Weight::AuthorWeight->count(
    'where id > ?',
    1000,
);

The count method executes a SELECT COUNT(*) query on the author_weight table.

It takes an optional argument of a SQL phrase to be added after the FROM author_weight section of the query, followed by variables to be bound to the placeholders in the SQL phrase. Any SQL that is compatible with SQLite can be used in the parameter.

Returns the number of objects that match the condition.

Throws an exception on error, typically directly from the DBI layer.

new

TO BE COMPLETED

The new constructor is used to create a new abstract object that is not (yet) written to the database.

Returns a new CPANTS::Weight::AuthorWeight object.

create

my $object = CPANTS::Weight::AuthorWeight->create(

    id => 'value',

    pauseid => 'value',

);

The create constructor is a one-step combination of new and insert that takes the column parameters, creates a new CPANTS::Weight::AuthorWeight object, inserts the appropriate row into the author_weight table, and then returns the object.

If the primary key column id is not provided to the constructor (or it is false) the object returned will have id set to the new unique identifier.

Returns a new author_weight object, or throws an exception on error, typically from the DBI layer.

insert

$object->insert;

The insert method commits a new object (created with the new method) into the database.

If a the primary key column id is not provided to the constructor (or it is false) the object returned will have id set to the new unique identifier.

Returns the object itself as a convenience, or throws an exception on error, typically from the DBI layer.

delete

# Delete a single instantiated object
$object->delete;

# Delete multiple rows from the author_weight table
CPANTS::Weight::AuthorWeight->delete('where id > ?', 1000);

The delete method can be used in a class form and an instance form.

When used on an existing CPANTS::Weight::AuthorWeight instance, the delete method removes that specific instance from the author_weight, leaving the object ntact for you to deal with post-delete actions as you wish.

When used as a class method, it takes a compulsory argument of a SQL phrase to be added after the DELETE FROM author_weight section of the query, followed by variables to be bound to the placeholders in the SQL phrase. Any SQL that is compatible with SQLite can be used in the parameter.

Returns true on success or throws an exception on error, or if you attempt to call delete without a SQL condition phrase.

truncate

# Delete all records in the author_weight table
CPANTS::Weight::AuthorWeight->truncate;

To prevent the common and extremely dangerous error case where deletion is called accidentally without providing a condition, the use of the delete method without a specific condition is forbidden.

Instead, the distinct method truncate is provided to delete all records in a table with specific intent.

Returns true, or throws an exception on error.

ACCESSORS

id

if ( $object->id ) {
    print "Object has been inserted\n";
} else {
    print "Object has not been inserted\n";
}

Returns true, or throws an exception on error.

REMAINING ACCESSORS TO BE COMPLETED

SQL

The author_weight table was originally created with the following SQL command.

CREATE TABLE author_weight (
	id         integer      not null primary key,
	pauseid    varchar(255) not null unique
)

SUPPORT

CPANTS::Weight::AuthorWeight is part of the CPANTS::Weight API.

See the documentation for CPANTS::Weight for more information.

AUTHOR

The Author

COPYRIGHT

Copyright 2009 The Author.

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

The full text of the license can be found in the LICENSE file included with this module.