Name
CatalystX::Usul::File - Read and write configuration files
Version
0.3.$Revision: 576 $
Synopsis
use CatalystX::Usul::File;Description
Provides CRUD methods for read and write configuration files. For each schema a subclass is defined that inherits from this class
Subroutines/Methods
new
Creates a new result source
add_to_attribute_list
$c->model( q(Config::*) )->add_to_attribute_list( $args );Add new items to an attribute list. The $args hash requires these keys; file the name of the file to edit, name the name of the element to edit, list the attribute of the named element containing the list of existing items, req the request object and field the field on the request object containing the list of new items
create
$c->model( q(Config::*) )->create( $args );Creates a new element. The $args hash requires these keys; file the name of the file to edit, name the name of the element to edit and fields is a hash containing the attributes of the new element. Missing attributes are defaulted from the defaults attribute of the CatalystX::Usul::File::Schema object
delete
$c->model( q(Config::*) )->delete( $args );Deletes an element
find
$c->model( q(Config::*) )->find( $args );get_list
$c->model( q(Config::*) )->get_list( $args );Retrieves the named element and a list of elements
load_files
remove_from_attribute_list
$c->model( q(Config::*) )->remove_from_attribute_list( $args );Removes items from an attribute list
search
$c->model( q(Config::*) )->search( $args );Search for elements that match the supplied criteria
update
$c->model( q(Config::*) )->update( $args );Updates the named element
Diagnostics
None
Configuration and Environment
None
Dependencies
Incompatibilities
There are no known incompatibilities in this module
Bugs and Limitations
There are no known bugs in this module. Please report problems to the address below. Patches are welcome
Author
Peter Flanigan, <Support at RoxSoft.co.uk>
License and Copyright
Copyright (c) 2008 Peter Flanigan. All rights reserved
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic
This program is distributed in the hope that it will be useful, but WITHOUT WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE