Breno G. de Oliveira > Padre-0.45 > Padre::DB::History

Download:
Padre-0.45.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.45   Source   Latest Release: Padre-1.00

NAME ^

Padre::DB::History - Padre::DB class for the history table

SYNOPSIS ^

  TO BE COMPLETED

DESCRIPTION ^

TO BE COMPLETED

METHODS ^

recent

  # Get the values for a "Recent Files" menu
  my @files = Padre::DB::History->recent('files', 10);

The recent method is non-ORLite method that is used to retrieve the most recent distinct values for a particular history category.

It takes a compulory parameter of the history type to retrieve, and an optional positive integer for the maximum number of distinct values to retrieve (10 by default).

Returns a list of zero or more 'name' values in array context.

Returns a reference to an array of zero or more 'name' values in scalar context.

Throws an exception if the history query fails.

previous

  # Get the single most recent file
  my $file = Padre::DB::History->previous('files');

The previous method is the single-value form of the recent method.

It takes a compulsory parameter of the history type to retrieve.

Returns the single most recent value as a string.

Returns undef if there are no values.

Throws an exception if the history query fails.

select

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

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

It takes an optional argument of a SQL phrase to be added after the FROM history 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::History objects when called in list context, or a reference to an ARRAY of Padre::DB::History 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::History->count;
  
  # How many objects 
  my $small = Padre::DB::History->count(
      'where id > ?',
      1000,
  );

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

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

create

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

      id => 'value',

      type => 'value',

      name => 'value',

  );

The create constructor is a one-step combination of new and insert that takes the column parameters, creates a new Padre::DB::History object, inserts the appropriate row into the history 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 history 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 history table
  Padre::DB::History->delete('where id > ?', 1000);

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

When used on an existing Padre::DB::History instance, the delete method removes that specific instance from the history, 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 history 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 history table
  Padre::DB::History->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 history table was originally created with the following SQL command.

  CREATE TABLE history (id INTEGER PRIMARY KEY, type VARCHAR(100), name VARCHAR(100))

SUPPORT ^

Padre::DB::History 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.

syntax highlighting: