File Coverage

blib/lib/OpenInteract2/ParamContainer.pm

Criterion	Covered	Total	%
statement	4	6	66.6
branch			n/a
condition			n/a
subroutine	2	2	100.0
pod			n/a
total	6	8	75.0

package OpenInteract2::ParamContainer;

# $Id: ParamContainer.pm,v 1.2 2005/02/13 20:19:10 lachoy Exp $

use strict;
use OpenInteract2::Exception qw( oi_error );

$OpenInteract2::ParamContainer::VERSION  = sprintf( "%d.%02d", q$Revision: 1.2 $ =~ /(\d+)\.(\d+)/ );

sub get_skip_params { return () }

sub param {
    my ( $self, $key, $value ) = @_;
    $self->{params} ||= {};
    return \%{ $self->{params} } unless ( $key );
    if ( defined $value ) {
        $self->{params}{ $key } = $value;
    }
    if ( ref $self->{params}{ $key } eq 'ARRAY' ) {
        return ( wantarray )
                 ? @{ $self->{params}{ $key } }
                 : $self->{params}{ $key };
    }
    return ( wantarray )
             ? ( $self->{params}{ $key } )
             : $self->{params}{ $key };
}

sub param_add {
    my ( $self, $key, @values ) = @_;
    return undef unless ( $key );
    $self->{params} ||= {};
    my $num_values = scalar @values;
    return $self->{params}{ $key } unless ( scalar @values );
    if ( my $existing = $self->{params}{ $key } ) {
        my $typeof = ref( $existing );
        if ( $typeof eq 'ARRAY' ) {
            push @{ $self->{params}{ $key } }, @values;
        }
        elsif ( ! $typeof ) {
            $self->{params}{ $key } = [ $existing, @values ];
        }
        else {
            oi_error "Cannot add $num_values values to parameter '$key' ",
                     "since the parameter is defined as a '$typeof' to ",
                     "which I cannot reliably add values.";
        }
    }
    else {
        if ( $num_values == 1 ) {
            $self->{params}{ $key } = $values[0];
        }
        else {
            $self->{params}{ $key } = [ @values ];
        }
    }
    return $self->param( $key );
}

sub param_clear {
    my ( $self, $key ) = @_;
    $self->{params} ||= {};
    return delete $self->{params}{ $key };
}

sub param_assign {
    my ( $self, $params ) = @_;
    return unless ( ref $params eq 'HASH' );
    my %skip_params = $self->get_skip_params();
    while ( my ( $key, $value ) = each %{ $params } ) {
        next if ( $skip_params{ $key } );
        next unless ( defined $value );
        $self->param( $key, $value );
    }
    return $self;
}

1;

__END__