IOC::Registry - Registry singleton for the IOC Framework


IOC documentation Contained in the IOC distribution.

Index


Code Index:

NAME

Top

IOC::Registry - Registry singleton for the IOC Framework

SYNOPSIS

Top

  use IOC::Registry;

  my $container = IOC::Container->new('database');
  my $other_container = IOC::Container->new('logging');
  # ... bunch of IOC::Container creation code omitted

  # create a registry singleton
  my $reg = IOC::Registry->new();
  $reg->registerContainer($container);
  $reg->registerContainer($other_container);

  # ... somewhere later in your program

  my $reg = IOC::Registry->instance(); # get the singleton

  # and try and find a service
  my $service = $reg->searchForService('laundry') || die "Could not find the laundry service";

  my $database = $reg->getRegisteredContainer('database');

  # get a list of container names
  my @container_names = $reg->getRegisteredContainerList();

  # and you can unregister containers too
  my $unregistered_container = $reg->unregisterContainer($container);

DESCRIPTION

Top

This is a singleton object which is meant to be used as a global registry for all your IoC needs.

METHODS

Top

new

Creates a new singleton instance of the Registry, the same singleton will be returned each time new is called after the first one.

Container Registration Methods

registerContainer ($container)

This method will add a $container to the registry, where it can be accessed by it's name.

unregisterContainer ($container|$name)

This method accepts either the $container instance itself, or the $name of the container and removes said container from the registry.

hasRegisteredContainer ($name)

This will return true (1) if a container by that $name exists within the registry, and false (0) otherwise.

getRegisteredContainer ($name)

This will retrieve a registered container by $name from the registry. If $name is not defined, then an IOC::InsufficientArguments exception will be thrown. If no container is found with $name, then an IOC::ContainerNotFound exception will be thrown.

getRegisteredContainerList

This will return the list of string names of all the registered containers.

Aliasing Methods

aliasService ($real_path, $alias_path)

This allows you to alias a path to a real service ($real_path) to be accessible from a different path ($alias_path). Basically, it is sometimes useful for the same service to be found at two different paths, especially when re-useing and combining IOC configurations for different frameworks.

The aliases set by this method will only affect the services retrieved through the locateService method. The aliases do not have any meaning outside of the IOC::Registry.

NOTE: There is no easy way to validate that the $real_path is actually a valid path, so we make the assumption that you know what you are doing.

Search Methods

locateService ($path)

Given a $path to a service, this will locate the service and return it. If $path is not specificed an IOC::InsufficientArguments exception will be thrown.

searchForService ($name)

Given a $name for a service, this will attempt to locate the service within the entire heirarchy and return it. If the service is not found, then this method will return undef. If $name is not specificed an IOC::InsufficientArguments exception will be thrown.

locateContainer ($path)

Given a $path to a container, this will locate the container and return it. If $path is not specificed an IOC::InsufficientArguments exception will be thrown.

searchForContainer ($name)

Given a $name for a container, this will attempt to locate the container within the entire heirarchy and return it. If the container is not found, then this method will return undef. If $name is not specificed an IOC::InsufficientArguments exception will be thrown.

TO DO

Top

Work on the documentation

BUGS

Top

None that I am aware of. Of course, if you find a bug, let me know, and I will be sure to fix it.

CODE COVERAGE

Top

I use Devel::Cover to test the code coverage of my tests, see the CODE COVERAGE section of IOC for more information.

SEE ALSO

Top

Class::StrongSingleton

This is a subclass of Class::StrongSingleton, if you want to know about how the singleton-ness is handled, check there.

AUTHOR

Top

stevan little, <stevan@iinteractive.com>

COPYRIGHT AND LICENSE

Top


IOC documentation Contained in the IOC distribution.

package IOC::Registry;

use strict;
use warnings;

our $VERSION = '0.05';

use Scalar::Util qw(blessed);

use IOC::Exceptions;
use IOC::Interfaces;

use IOC::Visitor::SearchForService;
use IOC::Visitor::SearchForContainer;

use base 'Class::StrongSingleton';

sub new {
    my ($_class) = @_;
    my $class = ref($_class) || $_class;
    my $registry = {
        containers => {},
        service_aliases => {}
        };
    bless($registry, $class);
    $registry->_init();
    return $registry;
}

# add and remove containers

sub registerContainer {
    my ($self, $container) = @_;
    (blessed($container) && $container->isa('IOC::Container'))
        || throw IOC::InsufficientArguments "You must supply a valid IOC::Container object";
    my $name = $container->name();
    (!exists ${$self->{containers}}{$name})
        || throw IOC::ContainerAlreadyExists "Duplicate Container '$name'";
    $self->{containers}->{$name} = $container;
}

sub unregisterContainer {
    my ($self, $container_or_name) = @_;
    (defined($container_or_name)) || throw IOC::InsufficientArguments "You must supply a name or a container";    
    my $name;
    if (ref($container_or_name)) {
        (blessed($container_or_name) && $container_or_name->isa('IOC::Container'))
            || throw IOC::InsufficientArguments "You must supply a valid IOC::Container object";
        $name = $container_or_name->name();
    }
    else {
        $name = $container_or_name;
    }
    (exists ${$self->{containers}}{$name})
        || throw IOC::ContainerNotFound "Cannot unregister a container we do not have";
    my $container = $self->{containers}->{$name};
    delete $self->{containers}->{$name};    
    return $container;
}

# fetching the containers

sub getRegisteredContainer {
    my ($self, $name) = @_;
    (defined($name)) || throw IOC::InsufficientArguments "You must supply a name of a container";
    (exists ${$self->{containers}}{$name}) 
        || throw IOC::ContainerNotFound "There is no container by the name '${name}'";     
    return $self->{containers}->{$name};
}

sub getRegisteredContainerList {
    my ($self) = @_;
    return keys %{$self->{containers}};
}

sub hasRegisteredContainer {
    my ($self, $name) = @_;
    (defined($name)) || throw IOC::InsufficientArguments "You must supply a name of a container";
    return (exists ${$self->{containers}}{$name}) ? 1 : 0;
}

# aliasing

sub aliasService {
    my ($self, $real_path, $alias_path) = @_;
    (defined($alias_path) && defined($real_path)) 
        || throw IOC::InsufficientArguments "You must supply a alias path and a real path";
    $self->{service_aliases}->{$alias_path} = $real_path;
}

# locate Service by path

sub locateService {
    my ($self, $path, @extra_args) = @_;
    (defined($path)) || throw IOC::InsufficientArguments "You must supply a path to a service";
    # if the service has been aliased, get the real path ...
    $path = $self->{service_aliases}->{$path} if exists ${$self->{service_aliases}}{$path};
    # and go about your normal business ...
    my @path = grep { $_ } split /\// => $path;
    my $registered_container_name = shift @path;
    (exists ${$self->{containers}}{$registered_container_name}) 
        || throw IOC::ContainerNotFound "There is no registered container found at '$registered_container_name' for the path '${path}'"; 
    my $service;
    eval {
        $service = $self->{containers}->{$registered_container_name}->find((join "/" => @path), \@extra_args);
    };
    throw IOC::ServiceNotFound "There is no service found at the path '${path}'" => $@ if $@;    
    return $service;
}

sub locateContainer {
    my ($self, $path) = @_;
    (defined($path)) || throw IOC::InsufficientArguments "You must supply a path to a container";    
    my @path = grep { $_ } split /\// => $path;
    my $registered_container_name = shift @path;
    (exists ${$self->{containers}}{$registered_container_name}) 
        || throw IOC::ContainerNotFound "There is no container found at the path '${path}'"; 
    my $current = $self->{containers}->{$registered_container_name};
    eval {
        $current = $current->getSubContainer(shift @path) while @path;
    };
    throw IOC::ContainerNotFound "There is no container found at the path '${path}'" => $@ if $@;
    # otherwise ...
    return $current;
}

# searching for containers

sub searchForContainer {
    my ($self, $container_to_find) = @_;
    my $container_found;
    foreach my $container (values %{$self->{containers}}) {
        $container_found = $container->accept(IOC::Visitor::SearchForContainer->new($container_to_find));
        last if defined $container_found;
    }
    return $container_found;
}

sub searchForService {
    my ($self, $service_to_find) = @_;
    my $service;
    foreach my $container (values %{$self->{containers}}) {
        $service = $container->accept(IOC::Visitor::SearchForService->new($service_to_find));
        last if $service;
    }
    return $service;
}

sub DESTROY {
    my ($self) = @_;
    # get rid of all our containers
    foreach my $container (values %{$self->{containers}}) {
        defined $container && $container->DESTROY;
    }     
    # let the Singleton do its work
    $self->SUPER::DESTROY();
}

1;

__END__