File Coverage

blib/lib/GD/Barcode/Image.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 GD::Barcode::Image;
use strict;
use Image::Magick;
use GD::Barcode;
require Exporter;
use vars qw($VERSION @ISA $AUTOLOAD);
@ISA     = qw(Exporter);    # HAS-A GD::Barcode:, no IS-A
$VERSION = 1.03;

#------------------------------------------------------------------------------
# GD::Barcode::Image  extends GD::Barcode functionality.
# GD/Barcode.pm is a package with a single factory-like method named new()
# new() itself creates objects of a specific Symbology - Barcode Type,
# which are derived classes from GD::Barcode
# There are other functions in GD/Barcode.pm such as dumpCode, and even
# plot(), but these are not object methods, and since there is never any
# object created of class GD::Barcode, all are private functions.
#
# GD::Barcode::Image follows the implementation of GD::Barcode - which is
# easiest done by using a member object of GD::Barcode:: type,
# and implementing plot_imagick and plot_gd functions.
# It would be possible to use AUTOLOAD and proxy all other methods of
# GD::Barcode:: classes, but unless someone points out the need for
# that, leaving it out for now (see example after END in this file)
# And if absolutey needed: callers can look at the GD::Barcode::
# object in this object hash: $oThis->{gd_barcode}
#------------------------------------------------------------------------------
# If these functions need to be merged into GD::Barcode, all that is to
# needed from this file are the two functions: plot_imagick and plot_gd -
# they will work with very minor modifications. The command-line script
# barcodegen should also be carried into GD::Barcode, if this module
# becomes obsolete.
#------------------------------------------------------------------------------
# new() - create an object of this class
# [not a factory method - unlike GD::Barcode]
#------------------------------------------------------------------------------
sub new($$$;$) {
    my $sClass = shift;
    my ($sType) = @_;

    # special check: since Image.pm resides in GD/Barcode, there is
    # the danger that the GD::Barcode->new() function will load/init
    # this module as a Barcode Symbology. To prevent this, check for type.
    if ( grep( /^$sType$/i, 'Image' ) ) {
        $GD::Barcode::errStr = 'Error in new() - Invalid Barcode Type: "Image"';
        return undef;
    }

    my $oThis = {};
    bless $oThis, $sClass;
    my $gdbc = GD::Barcode->new(@_);
    $oThis->{gd_barcode} = $gdbc;
    return $gdbc ? $oThis : undef;
}

#------------------------------------------------------------------------------
# init (for GD::Barcode::Image)
# special check: since Image.pm resides in GD/Barcode, there is
# the danger that the GD::Barcode->new() function will load/init this
# module as a Barcode Symbology, so check for type
#------------------------------------------------------------------------------
sub init() {
    return 'Error in init() - Invalid Barcode Type: "Image"';
}

#------------------------------------------------------------------------------
# plot_imagick: Convert to Image::Magick Object (for GD::Barcode)
# Requires both the GD and Image::Magick modules.
# signature is similar to GD::Barcode::QRcode->plot()
#------------------------------------------------------------------------------
sub plot_imagick($%) {
    my ( $oThis, %hParam ) = @_;

    #Create Image
    my $imNew = undef;
    eval {
        require Image::Magick;

        my ( $gdNew, $png ) = ( undef, undef );

        $gdNew = $oThis->{gd_barcode}->plot(%hParam);
        if ($gdNew) {
            $png   = $gdNew->png();
            $imNew = Image::Magick->new();

            $GD::Barcode::errStr = $imNew->BlobToImage($png);
            $imNew               = undef
              if ($GD::Barcode::errStr);    # on error, free imagick object
        }
    };
    return $imNew;
}

#------------------------------------------------------------------------------
# plot_gd: Convert to GD::Image Object (for GD::Barcode)
# plot_gd created to follow name pattern of "plot_imagick" - plot_
# Requires the GD module.
#------------------------------------------------------------------------------
sub plot_gd($%) {
    my ( $oThis, %hParam ) = @_;
    return $oThis->{gd_barcode}->plot(%hParam);
}

#------------------------------------------------------------------------------

1;

__END__