CatalystX::Usul::Model::Config::Rooms - Class definition for the room configuration element

CatalystX-Usul documentation

Contained in the CatalystX-Usul distribution.

Index

Name
Version
Synopsis
Description
Subroutines/Methods
Diagnostics
Configuration and Environment
Dependencies
- CatalystX::Usul::Model::Config
Incompatibilities
Bugs and Limitations
Author
License and Copyright

Code Index:

package CatalystX::Usul::Model::Config::Rooms
- delete
- set_state
__END__
EOF

Name

CatalystX::Usul::Model::Config::Rooms - Class definition for the room configuration element

Version

0.3.$Revision: 591 $

Synopsis

   # Instantiated by Catalyst when the application starts

Description

Defines the attributes for the <rooms> configuration element

Defines three language independent attributes: acl, name and state

Defines two language dependent attributes: text and tip

Subroutines/Methods

delete

Deletes the specified rooms element from the configuration

get_list

Returns an object that contains a list of the defined rooms and the fields of the specified room

set_state

Toggles the state attribute which has the effect of opening (false) or closing (true) the room to the application

Diagnostics

None

Configuration and Environment

None

Dependencies

CatalystX::Usul::Model::Config

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

CatalystX-Usul documentation

Contained in the CatalystX-Usul distribution.

# @(#)$Id: Rooms.pm 591 2009-06-13 13:34:41Z pjf $

package CatalystX::Usul::Model::Config::Rooms;

use strict;
use warnings;
use version; our $VERSION = qv( sprintf '0.3.%d', q$Rev: 591 $ =~ /\d+/gmx );
use parent qw(CatalystX::Usul::Model::Config);

use Class::C3;

__PACKAGE__->config
   ( create_msg_key    => 'Action [_1]/[_2] created',
     delete_msg_key    => 'Action [_1]/[_2] deleted',
     keys_attr         => q(room),
     schema_attributes => {
        attributes     => [ qw(acl keywords quick_link state text tip) ],
        defaults       => { acl => [ q(any) ], state => 0, text => q() },
        element        => q(rooms),
        lang_dep       => { qw(keywords 1 text 1 tip 1) } },
     update_msg_key    => 'Action [_1]/[_2] updated', );

__PACKAGE__->mk_accessors( qw(rooms) );

sub delete {
   my ($self, $args) = @_; my $s = $self->context->stash;

   $self->next::method( $args );
   delete $s->{levels}->{ $args->{file} }->{ $args->{name} };
   return;
}

sub set_state {
   my ($self, $args) = @_;

   my %states = ( 0 => q(open), 1 => q(hidden), 2 => q(closed) );
   my $state  = $self->query_value( q(state) ) || 0;

   $args->{fields} = { state => $state };
   $self->update( $args );
   $self->clear_result;

   my $user     = $self->context->stash->{user};
   my $msg      = 'Action [_1]/[_2] state set to [_3] by [_4]';
   my @msg_args = ( $args->{file}, $args->{name}, $states{ $state }, $user );

   $self->add_result_msg( $msg, @msg_args );
   return;
}

1;

__END__

# Local Variables:
# mode: perl
# tab-width: 3
# End: