1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
|
package HTTP::Headers::ActionPack::Core::BaseHeaderWithParams;
BEGIN {
$HTTP::Headers::ActionPack::Core::BaseHeaderWithParams::AUTHORITY = 'cpan:STEVAN';
}
{
$HTTP::Headers::ActionPack::Core::BaseHeaderWithParams::VERSION = '0.09';
}
# ABSTRACT: A Base header type with parameters
use strict;
use warnings;
use Carp qw[ confess ];
use parent 'HTTP::Headers::ActionPack::Core::Base';
# NOTE:
# this is meant to be
# called by subclasses
# in their BUILDARGS
# methods
# - SL
sub _prepare_params {
my ($class, @params) = @_;
confess "Params must be an even sized list" unless (((scalar @params) % 2) == 0);
my @param_order;
for ( my $i = 0; $i < $#params; $i += 2 ) {
push @param_order => $params[ $i ];
}
return +{
params => { @params },
param_order => \@param_order
};
}
sub params { (shift)->{'params'} }
sub _param_order { (shift)->{'param_order'} }
sub add_param {
my ($self, $k, $v) = @_;
$self->params->{ $k } = $v;
push @{ $self->_param_order } => $k;
}
sub remove_param {
my ($self, $k) = @_;
$self->{'param_order'} = [ grep { $_ ne $k } @{ $self->{'param_order'} } ];
return delete $self->params->{ $k };
}
sub params_in_order {
my $self = shift;
map { $_, $self->params->{ $_ } } @{ $self->_param_order }
}
sub params_are_empty {
my $self = shift;
(scalar keys %{ $self->params }) == 0 ? 1 : 0
}
1;
__END__
=pod
=head1 NAME
HTTP::Headers::ActionPack::Core::BaseHeaderWithParams - A Base header type with parameters
=head1 VERSION
version 0.09
=head1 SYNOPSIS
use HTTP::Headers::ActionPack::Core::BaseHeaderWithParams;
=head1 DESCRIPTION
This is a base class for header values which contain
a parameter list. There are no real user serviceable parts
in here.
=head1 METHODS
=over 4
=item C<params>
Accessor for the unordered hash-ref of parameters.
=item C<add_param( $key, $value )>
Add in a parameter, it will be placed at end
very end of the parameter order.
=item C<remove_param( $key )>
Remove a parameter from the link.
=item C<params_are_empty>
Returns false if there are no parameters on the invocant.
=back
=head1 AUTHOR
Stevan Little <stevan.little@iinteractive.com>
=head1 CONTRIBUTORS
=over 4
=item *
Andrew Nelson <anelson@cpan.org>
=item *
Dave Rolsky <autarch@urth.org>
=item *
Florian Ragwitz <rafl@debian.org>
=item *
Jesse Luehrs <doy@tozt.net>
=item *
Karen Etheridge <ether@cpan.org>
=back
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2012 by Infinity Interactive, Inc..
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|