/ 
Padre-0.39
River stage two • 56 direct dependents • 56 total dependents
/ Padre::DB::Bookmark

NAME

Padre::DB::Bookmark - Padre::DB class for the bookmark table

SYNOPSIS

TO BE COMPLETED

DESCRIPTION

TO BE COMPLETED

METHODS

select

# Get all objects in list context
my @list = Padre::DB::Bookmark->select;

# Get a subset of objects in scalar context
my $array_ref = Padre::DB::Bookmark->select(
    'where name > ? order by name',
    1000,
);

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

It takes an optional argument of a SQL phrase to be added after the FROM bookmark 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 Padre::DB::Bookmark objects when called in list context, or a reference to an ARRAY of Padre::DB::Bookmark 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 = Padre::DB::Bookmark->count;

# How many objects 
my $small = Padre::DB::Bookmark->count(
    'where name > ?',
    1000,
);

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

It takes an optional argument of a SQL phrase to be added after the FROM bookmark 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 Padre::DB::Bookmark object.

create

my $object = Padre::DB::Bookmark->create(

    name => 'value',

    file => 'value',

    line => 'value',

);

The create constructor is a one-step combination of new and insert that takes the column parameters, creates a new Padre::DB::Bookmark object, inserts the appropriate row into the bookmark table, and then returns the object.

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

Returns a new bookmark 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 name is not provided to the constructor (or it is false) the object returned will have name 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 bookmark table
Padre::DB::Bookmark->delete('where name > ?', 1000);

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

When used on an existing Padre::DB::Bookmark instance, the delete method removes that specific instance from the bookmark, 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 bookmark 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 bookmark table
Padre::DB::Bookmark->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

name

if ( $object->name ) {
    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 bookmark table was originally created with the following SQL command.

CREATE TABLE bookmark (
	name VARCHAR(255) NOT NULL PRIMARY KEY,
	file VARCHAR(255) NOT NULL,
	line INTEGER NOT NULL
)

SUPPORT

Padre::DB::Bookmark is part of the Padre::DB API.

See the documentation for Padre::DB for more information.

AUTHOR

Adam Kennedy

COPYRIGHT

Copyright 2008-2009 The Padre development team as listed in Padre.pm.

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.