Stefan Hornburg (Racke) > Nitesi-0.0080 > Nitesi::Object::Singleton

Download:
Nitesi-0.0080.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Source  

NAME ^

Nitesi::Object::Singleton - Singleton base class for Nitesi

SYNOPSIS ^

    package My::Nitesi::Extension;

    use strict;
    use warnings;
    use base 'Nitesi::Object::Singleton';

    __PACKAGE__->attributes( qw/name value this that/ );

    sub init {
        my ($class, $instance) = @_;
        # our initialization code, if we need one
    }

    # .. later on ..

    # returns the unique instance
    my $singleton_intance = My::Nitesi::Extension->instance();

DESCRIPTION ^

Nitesi::Object::Singleton is meant to be used instead of Nitesi::Object, if you want your object to be a singleton, that is, a class that has only one instance in the application.

It is derived from Dancer::Object::Singleton, which the exception that instance allows parameters.

It provides you with attributes and an initializer.

METHODS ^

instance

Returns the instance of the singleton. The instance is created only when needed. The creation will call the init() method, which you should implement.

init

Exists but does nothing. This is so you won't have to write an initializer if you don't want to. init receives the instance as argument.

get_attributes

Get the attributes of the specific class.

attributes

Generates attributes for whatever object is extending Nitesi::Object and saves them in an internal hashref so they can be later fetched using get_attributes.

new

Calling the constructor will fail as this is a singleton, please use instance instead.

AUTHOR ^

Damien Krotkine

LICENSE AND COPYRIGHT ^

Copyright 2010 Damien Krotkine.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

syntax highlighting: