File Coverage

blib/lib/Icon/FamFamFam/Silk.pm

Criterion	Covered	Total	%
statement	23	32	71.8
branch	4	10	40.0
condition			n/a
subroutine	8	11	72.7
pod	7	7	100.0
total	42	60	70.0

package Icon::FamFamFam::Silk;

use 5.006;
use MIME::Base64 qw[];
use URI;

our $VERSION = '0.002001003';
our $_data   = {};

sub new
{
	my ($class, $icon) = @_;
	bless \$icon, $class;
}

sub _load_data()
{
	return if %$_data;
	local $/;
	eval ;
}

sub name
{
	my ($icon) = @_;
	return (ref $icon) ? ${$icon} : $icon;
}

sub list
{
	my ($class) = @_;
	_load_data() unless %$_data;
	return map { my $icon = $_; bless \$icon, $class; } keys %$_data;
}

sub base64
{
	my ($icon) = @_;
	_load_data() unless %$_data;
	return (ref $icon) ? $_data->{${$icon}} : $_data->{$icon};
}

sub uri
{
	my ($icon) = @_;
	return URI->new('data:image/png;base64,' . base64($icon));
}

sub raw
{
	my ($icon) = @_;
	MIME::Base64::decode_base64(base64($icon));
}

sub attribution_data
{
	my %data = (
		-url             => 'http://www.famfamfam.com/lab/icons/silk/famfamfam_silk_icons_v013.zip',
		-title           => 'Silk icons',
		-attributionName => 'Mark James',
		-attributionURL  => 'http://www.famfamfam.com/lab/icons/silk/',
		-licence         => 'by',
		-type            => 'Collection',
		);
	return %data;
}

1;

=head1 NAME

Icon::FamFamFam::Silk - embed these famous icons in your code

=head1 VERSION

0.002001003

(Version 0.002 of this module and version 1.3 of the icons.)

=head1 SYNOPSIS

 use Icon::FamFamFam::Silk;
 my $wrench = Icon::FamFamFam::Silk->new('wrench_orange');
 print $wrench->base64;

or

 use Icon::FamFamFam::Silk;
 print Icon::FamFamFam::Silk::base64('wrench_orange');

=head1 DESCRIPTION

These methods can be called as functions taking the name of the icon (a string)
as their argument, or can be called as object methods on an instantiated icon
object. (See L.)

=over

=item C<< Icon::FamFamFam::Silk->new($name) >>

Returns a blessed icon object.

=item C<< Icon::FamFamFam::Silk->list >>

Returns a list of all the icons.

=item C<< $icon->name >>

Returns the name of the icon.

=item C<< $icon->base64 >>

Returns base64-encoded PNG data.

=item C<< $icon->raw >>

Returns raw PNG data.

=item C<< $icon->uri >>

Returns a "data:" URI for the icon.

=item C<< $icon->attribution_data >>
=item C<< Icon::FamFamFam::Silk->attribution_data >>

Returns a hash of data useful for giving credit to Mark James.

This is in a format suitable for passing to L's
C function, should you want to do something like
that.

=back

=head1 BUGS

Please report any bugs to L.

=head1 SEE ALSO

L.

=head1 AUTHOR

Icons by Mark James of L.

Module by Toby Inkster [e-mail].

=head1 COPYRIGHT AND LICENCE

Mark James distributes the icons themselves under the CC-BY 3.0 licence
L. Applications using
Icon::FamFamFam::Silk (even indirectly via another module) must provide
credit. Including a link to L in the
documentation of the application is probably sufficient.

Toby Inkster releases the additional Perl coding into the Public Domain.

=head1 DISCLAIMER OF WARRANTIES

THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.

=cut

__DATA__