IOC::Service::Literal - An IOC Service object whose component is a literal value


IOC documentation Contained in the IOC distribution.

Index


Code Index:

NAME

Top

IOC::Service::Literal - An IOC Service object whose component is a literal value

SYNOPSIS

Top

  use IOC::Service::Literal;

  my $container = IOC::Container->new();
  # use a literal here for our log_file 
  $container->register(IOC::Service::Literal->new('log_file' => "logfile.log" ));
  $container->register(IOC::Service->new('logger' => sub { 
      my $c = shift; 
      return FileLogger->new($c->get('log_file'));
  }));
  $container->register(IOC::Service->new('application' => sub {
      my $c = shift; 
      my $app = Application->new();
      $app->logger($c->get('logger'));
      return $app;
  }));

  $container->get('application')->run();   

DESCRIPTION

Top

In this IOC framework, the IOC::Service::Literal object holds a literal value which does not need to be initialized. This IOC::Service subclass is specifically optimized to handle values which need no initialization, like literal values, such as numbers and strings. It is sometimes useful for these types of values to be included in your configuration, this helps reduce the overhead for them.

        +--------------+
        | IOC::Service |
        +--------------+
              |
              ^
              |
   +-----------------------+                 +-----------------+
   | IOC::Service::Literal |---(instance)--->| <Literal Value> |
   +-----------------------+                 +-----------------+ 

METHODS

Top

new ($name, $literal)

Creates a service with a $name, and uses the $literal value which need not be initialized.

name

Returns the name of the service instance.

setContainer ($container)

This is a no-op method, since the service is not initialized, then it does not need an instance of the container.

removeContainer

This is a no-op method, see setContainer above.

instance

This method returns the literal value held by the service object.

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

AUTHOR

Top

stevan little, <stevan@iinteractive.com>

COPYRIGHT AND LICENSE

Top


IOC documentation Contained in the IOC distribution.

package IOC::Service::Literal;

use strict;
use warnings;

our $VERSION = '0.01';

use Scalar::Util qw(blessed);

use IOC::Exceptions;

use base 'IOC::Service';

sub new {
    my ($_class, $name, $literal) = @_;
    my $class = ref($_class) || $_class;
    my $service = {};
    bless($service, $class);
    $service->_init($name, $literal);
    return $service;
}

sub _init {
    my ($self, $name, $literal) = @_;
    (defined($name)) || throw IOC::InsufficientArguments "Service object cannot be created without a name";
    (defined($literal))
        || throw IOC::InsufficientArguments "Service::Literal object cannot be created without value";
    # set the defaults
    $self->{_instance} = $literal;
    # assign constructor args    
    $self->{name} = $name;
    # No block in this one
    ## $self->{block} = undef;
    # No container in this one either
    ## $self->{container} = undef;    
}

sub instance { (shift)->{_instance} }

# no-ops
sub setContainer    { () }
sub removeContainer { () }
sub DESTROY         { () }

1;

__END__