File Coverage

blib/lib/XAO/DO/Embeddable.pm

Criterion	Covered	Total	%
statement	17	17	100.0
branch			n/a
condition			n/a
subroutine	6	6	100.0
pod	2	2	100.0
total	25	25	100.0

=head1 NAME

XAO::DO::Embeddable - recommended base object for XAO embeddable configs

=head1 SYNOPSIS

 package XAO::DO::Foo::Config;
 use strict;
 use XAO::Objects;
 use base XAO::Objects->load(objname => 'Embeddable');

=head1 DESCRIPTION

Provides set_base_config() and base_config() methods to embeddable
configs based on it.

=head1 METHODS

=over

=cut

###############################################################################
package XAO::DO::Embeddable;
use strict;
use warnings;
use XAO::Objects;
use base XAO::Objects->load(objname => 'Atom');

our $VERSION=2.1;

###############################################################################

=item set_base_config ($)

Called automatically with one argument -- reference to the configuration
object it is being embedded into.

=cut

sub set_base_config ($$) {
    my ($self,$base)=@_;
    $self->{'_embedding_base_config'}=$base;
    return $self;
}

###############################################################################

=item base_config ($)

Returns previously stored base config reference. Reason to have this
method is the following: methods of embedded configs are called in the
namespace of their own and common configuration object is not available
from them through normal @ISA relations.

=cut

sub base_config ($) {
    my $self=shift;
    return $self->{'_embedding_base_config'};
}

###############################################################################
1;
__END__