| CatalystX-Usul documentation | view source | Contained in the CatalystX-Usul distribution. |
CatalystX::Usul::Model::Config - Read and write configuration files
0.3.$Revision: 576 $
use base qw(CatalystX::Usul::Model::Config);
Provides CRUD methods for read and write configuration files. For each schema a subclass is defined that inherits from this class
The constructor sets up the ctrldir attribute which acts as a default
directory if one is not supplied in the file name
Creates a new CatalystX::Usul::File object and takes a copy of the stashed language
$c->model( q(Config::*) )->config_form;
Creates the form to edit an element
$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
$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
$c->model( q(Config::*) )->create_or_update( $args );
Creates a new element if one does not exist or updates the existing one if it does exist
$c->model( q(Config::*) )->delete( $args );
Deletes an element
$c->model( q(Config::*) )->find( $file, $name );
$c->model( q(Config::*) )->get_list( $file, $name );
Retrieves the named element and a list of elements
$config = eval { $c->model( q(Config) )->load_files( @{ $files } ) };
Loads the required configuration files. Returns a hash ref
$c->model( q(Config::*) )->remove_from_attribute_list( $args );
Removes items from an attribute list
@elements = $c->model( q(Config::*) )->search( $args );
Searches the given file for elements matching the given criteria. Returns an array of element objects
$c->model( q(Config::*) )->update( $args );
Updates the named element
None
None
There are no known incompatibilities in this module
There are no known bugs in this module. Please report problems to the address below. Patches are welcome
Peter Flanigan, <Support at RoxSoft.co.uk>
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
| CatalystX-Usul documentation | view source | Contained in the CatalystX-Usul distribution. |