File Coverage

blib/lib/HTML/Widget/Plugin/Image.pm

Criterion	Covered	Total	%
statement	26	26	100.0
branch	6	6	100.0
condition	3	3	100.0
subroutine	8	8	100.0
pod	2	2	100.0
total	45	45	100.0

use strict;
use warnings;
package HTML::Widget::Plugin::Image;
# ABSTRACT: an image object
$HTML::Widget::Plugin::Image::VERSION = '0.202';
use parent 'HTML::Widget::Plugin';

#pod =head1 SYNOPSIS
#pod
#pod   $widget_factory->image({
#pod     src => 'http://example.com/example.jpg',
#pod     alt => 'An Example Image',
#pod   });
#pod
#pod =head1 DESCRIPTION
#pod
#pod This plugin provides a basic image widget.
#pod
#pod =cut

use Carp ();
use HTML::Element;

#pod =head1 METHODS
#pod
#pod =head2 C< provided_widgets >
#pod
#pod This plugin provides the following widgets: image
#pod
#pod =cut

sub provided_widgets { qw(image) }

#pod =head2 C< image >
#pod
#pod This method returns a basic image element.
#pod
#pod In addition to the generic L attributes, the following
#pod are valid arguments:
#pod
#pod =over
#pod
#pod =item src
#pod
#pod This is the source href for the image.  "href" is a synonym for src.  If no
#pod href is supplied, an exception is thrown.
#pod
#pod =item alt
#pod
#pod This is the alt text for the image.
#pod
#pod =back
#pod
#pod =cut

sub _attribute_args { qw(src alt) }

sub image {
  my ($self, $factory, $arg) = @_;

  if ($arg->{attr}{src} and $arg->{href}) {
    Carp::croak "don't provide both href and src for image widget";
  }

  $arg->{attr}{src} = $arg->{href} if not defined $arg->{attr}{src};

  Carp::croak "can't create an image without a src"
    unless defined $arg->{attr}{src};

  my $widget = HTML::Element->new('img');
  $widget->attr($_ => $arg->{attr}{$_}) for keys %{ $arg->{attr} };

  return $widget->as_XML;
}

1;

__END__