Floris Luiten

Close-up van een blonde jongeman met bril die en kop koffie drinkt in een cafe

Floris Luiten is programmeur bij u0192. Hij houdt van programmeren, cijfers, logica en het bestuderen van het menselijk gedrag. Op deze website laat hij zich over deze en nog meer onderwerpen uit. Wil je weten wat Floris nu denkt? Volg hem via Twitter (@florisl).
Meer informatie over Floris Luiten

EAN-8 en PHP

Zoals je in mijn vorige blogpost over EAN-13 kon lezen, heb ik een class in PHP geschreven waarmee je zelf EAN-13 barcodes kunt genereren. Nadat ik de code met jullie had gedeeld voelde ik gelijk de noodzaak om ook EAN-8 te implementeren. De hoofdreden? Omdat EAN-8 zoveel lijkt op EAN-13! Dat zou dus inhouden dat de uitbreiding niet al te moeilijk moet zijn, nietwaar?

EAN-13 versie 1.01

Toen ik de code van EAN-13 aandachtig bekeek besefte ik mij dat deze welliswaar een hoop functies bevat die ik in EAN-8 zou gebruiken, maar dat hij toch niet flexibel genoeg was om gelijk te kunnen gebruiken. Ik zou natuurlijk simpelweg de code kunnen kopiëren en waarnodig aanpassen, maar dan maak je niet optimaal gebruik van de mogelijkheden van classes. Ik besloot derhalve om eerst EAN-13 te modificeren zodat deze ook voor EAN-8 gebruikt zou kunnen worden.

Aan de abstract-class heb ik de volgende properties toegevoegd:

<?php
abstract class digitBarCodes {
  
//A single bitArray
  
protected $leftGuard = array();
  
//A single bitArray
  
protected $rightGuard = array();
  
//Array containing bitArray(s)
  
protected $centerGuards = array();
  
  protected 
$barcodeGuardLength 50;
  protected 
$barcodeLength 40;
  
/* Rest staat hieronder gewoon */

Deze modificaties zijn nodig omdat wij de guards (aan 't begin van de barcode, halverwege en aan 't einde van de barcode) pas in de generateBarcodeImage-functie zullen gebruiken. Dit zodat we de guards langer kunnen maken dan de andere code. De belangrijkste reden is dat we later de code in cijfers onder de barcode kunnen printen zodat mensen de code kunnen intypen als de barcode niet werkt. Dit om te voldoen aan de "echte" standaard.

Verder zie je dat ik de lengte van de barcode en de guards hier specificeer zodat je deze later indien nodig gemakkelijk kunt verlengen.

generateBarcodeImage revised

Uiteraard hebben we nu een nieuwe generateBarcodeImage-functie nodig. Deze functie is gemodificeert t.o.v. de vorige versie in de zin dat de guards nu apart worden getekend, zodat deze in een andere lengte getekend kunnen worden. De $imageWidth berekening die we voorheen hadden hebben we ook aangepast zodat de afbeelding in elk geval breed genoeg is om de hele barcode te kunnen printen.

Bovendien is deze functie nu subtiel gewijzigd om een door mij ontdekte bug tegen te gaan. De vorige versie was zo gemaakt worden dat als de $size-parameter groot genoeg was, er een deel van de eerste streep kan missen. Hierdoor zou mogelijkerwijs de eerste lijn kunnen wegvallen, waardoor de barcode onbruikbaar is. Daarom gebruik ik nu $xPos+$size. De barcode schuift hierdoor in z'n geheel naar rechts. Ik heb hier uiteraard rekening mee gehouden bij de $imageWidth-berekening, om te voorkomen dat nu de laatste lijn zou kunnen wegvallen. 

De gereviseerde code is als volgt:

<?php
public function generateBarcodeImage($bitArray$size=1) {
  
$imageWidth count($bitArrayCOUNT_RECURSIVE) - count($bitArray);
  
  
$imageWidth += count($this->leftGuard);
  
$imageWidth += count($this->centerGuardsCOUNT_RECURSIVE) - count($this->centerGuards);
  
$imageWidth += count($this->rightGuard);
  
$imageWidth += $size;
  
  
$image imagecreate(($imageWidth $size), ($this->barcodeGuardLength $size));
  
imagecolorallocate($image255255255); // White background
  
$imColorBarcode imagecolorallocate($image000); // Black color
  
$xPos 0;
  
  foreach (
$this->leftGuard AS $bit) {
    if (
$bit == 1) {
      
$this->imagelinethick($image$xPos+$size0$xPos+$size, ($this->barcodeGuardLength $size), $imColorBarcode$size);
    }
    
$xPos += $size;
  }
    
  foreach (
$bitArray AS $index => $bitArray) {
    foreach (
$bitArray AS $bit) {
      if (
$bit == 1) {
        
$this->imagelinethick($image$xPos+$size0$xPos+$size, ($this->barcodeLength $size), $imColorBarcode$size);
      }
      
$xPos += $size;
    }
    
    if (isset(
$this->centerGuards[$index])) {
      foreach (
$this->centerGuards[$index] AS $bit) {
        if (
$bit == 1) {
          
$this->imagelinethick($image$xPos+$size0$xPos+$size, ($this->barcodeGuardLength $size), $imColorBarcode$size);
        }
        
$xPos += $size;
      }
    }
  }
  
  foreach (
$this->rightGuard AS $bit) {
    if (
$bit == 1) {
      
$this->imagelinethick($image$xPos+$size0$xPos+$size, ($this->barcodeGuardLength $size), $imColorBarcode$size);
    }
    
$xPos += $size;
  }
  
  return 
$image;
}

De toevoeging noodzakelijk om de EAN13Barcode-class te laten functioneren stammen af van de hierboven genoemde wijzigingen. Ik geef ze derhalve zonder hier al te veel over uit te leggen, maar lees anders het commentaar in de code zelf.

<?php
class EAN13Barcode extends digitBarCodes {
  protected 
$codeLengthNoCheckum 12;
  protected 
$codeLength 1;
  
  protected 
$leftGuard = array(101);
  protected 
$rightGuard = array(101);
  protected 
$centerGuards = array(=> array(01010));
  
  protected 
$encodeStartDigit 1;
  
/* codeLookupTable en alle methods staan hier */
  
  /* (...) */
  
  /*De getBitarray functie is nu voorzien van een optionele parameter
    waarmee je een bitArray krijgt zonder de guards, wat nodig is voor
    de generateBarcodeImage. Die functie voegt namenlijk zelf
    de guards toe op de juiste locatie */
  
public function getBitarray($code$includeGuards=true) {
    
$code $this->getValidatedCode($code);
    if (
$code == false) {
      return 
false;
    }
        
    
$return = array();
    if (
$includeGuards) {
      
$return[] = $this->leftGuard;
    }
    
$structureMask str_split($this->getStructureMask($code));
    
    foreach (
str_split(substr($code$this->encodeStartDigit)) AS $index => $digit) {
      
$return[] = $this->encode($digit$structureMask[$index]);
      if (isset(
$this->centerGuards[$index]) AND $includeGuards) {
        
$return[] = $this->centerGuards[$index];
      }
    }
    if (
$includeGuards) {
      
$return[] = $this->rightGuard;
    }
    return 
$return;
  }
}

Verder heb alle functies van "private" naar "protected" gezet zodat eventuele extending classes deze kunnen overrulen.

En dan nu: EAN-8

Door het voorwerk wat wij hebben gedaan, is het schrijven van de EAN-8 class zeer simpel geworden. We zullen de nieuwe class extenden vanuit de EAN13Barcode class, met een aantal andere properties:

<?php
class EAN8Barcode extends EAN13Barcode {
  protected 
$codeLengthNoCheckum 7;
  protected 
$codeLength 1;
  
  protected 
$centerGuards = array(=> array(01010));
  
  protected 
$encodeStartDigit 0;
  
  protected function 
getStructureMask($code) {
    if (!
ctype_digit($code)) {
      return 
false;
    }
    return 
'LLLLRRRR';
  }
}

Echt waar, zo simpel is 't nu om EAN-8 te implementeren nu we EAN-13 al gedaan hebben. Je ziet dat we de properties anders ingesteld hebben en een nieuwe getStructureMask-functie geschreven. Dit is genoeg om een legitieme EAN-8 code te genereren, echt waar! Probeer maar!

Het resultaat

De gehele code (v1.01):

<?php
/**
 * Barcode abstract
 * 
 * @author Floris Luiten <www.florisluiten.nl>
 * @package DigitBarCodes
 * @version $Id: digitbarcodes (abstract.php), v1.01 2011/02/12 $
 * @copyright Please contact author for copyright information, but
 *            in general these rules apply:
 *            
 *            - Want to use this code to learn how to write your own
 *              classes or teach others how to code? Go ahead! Please 
 *              give me credits in a proper way. Also, I'd love to hear
 *              your from you how you used this code. 
 *              
 *            - Want to use this code to generate a library for personal
 *              use? Please, go ahead! I'd love to hear from you how 
 *              this code helped you and where you have applied it.
 *              
 *            - Want to make money off this code? Please don't do that
 *              without consulting me first. If you really don't want
 *              to contact me for whatever reason, donate a FAIR amount
 *              to charity, in relation to how much money you make.
 */
/**
 * Abstract class for barcodes containing digits only
 *
 * @package DigitBarCodes
 * @author Floris Luiten <www.florisluiten.nl>
 * @abstract
 */
abstract class digitBarCodes {
  
/**
   * The bitArray for the left guard
   * @access protected
   * @var array
   */
  
protected $leftGuard = array();
  
/**
   * The bitArray for the right guard
   * @access protected
   * @var array
   */
  
protected $rightGuard = array();
  
/**
   * A multi-dimensional array containing the center guards.
   *
   * @example array(4 => (1, 0, 1)) Will insert the guard 101 at 
   *          position 4
   * @access protected
   * @var array
   */
  
protected $centerGuards = array();
  
/**
   * Declares the height of a guard
   * @access protected
   * @var integer
   */
  
protected $barcodeGuardLength 50;
  
/**
   * Declares the height of a regular bar
   * @access protected
   * @var integer
   */
  
protected $barcodeLength 40;
  
  
/**
   * Dummy function for returning the checksum based on the
   * code. Returns false if no checksum could be generated
   *
   * @param integer The code
   * @return integer|False The checksum as digit or False
   *                       when no checksum could be created
   */
  
abstract public function calculateChecksum($code);
  
  
/**
   * Dummy function to generate a bitArray from the code.
   * This bitArray can be used to render the actual
   * barcode as an image.
   * Returns False when no bitArray could be generated, 
   * for example when the checksum failed or non-valid
   * characters were found.
   *
   * @param string The code with or without the checksum
   * @param array|False A bitArray or False otherwise
   */
  
abstract public function getBitarray($code);
  
  
/**
   * Dummy function to return the code if it's valid,
   * if no checksum is provided the return will include this
   *
   * @param string The code to check
   * @param string|False The valid code or False otherwise
   */
  
abstract public function getValidatedCode($code);
  
  
/**
   * Bitwise NOT on a bitArray (an array containing 0 or 1's)
   *
   * @param array The bitArray
   * @return array The NOT bitArray
   */
  
public function bitArrayNOT($bits) {
    foreach (
$bits AS $index => $bit) {
      
$bits[$index] = $bit;
    }
    return 
$bits;
  }
  
  
/**
   * Convert a bitArray to an integer
   *
   * @param array The bitarray
   * @return integer The integer
   */
  
public function bitArrayToInteger($bits) {
    
$bitValue 1;
    
$sum 0;
    
    foreach (
array_reverse($bits) AS $index => $bit) {
      
$sum += $bit $bitValue;
      
$bitValue *= 2;
    }
    return 
$sum;
  }
  
  
/**
   * Function generate the barcode based on the code. It first checks
   * the checksum or creates it if it's missing.
   *
   * @param string The code (with or without the checksum)
   * @param integer optional An optional size
   */
  
public function getBarcodeImage($code$size=1) {
    
$code $this->getValidatedCode($code);
    if (
$code == false) {
      return 
false;
    }
    return 
$this->generateBarcodeImage($this->getBitarray($codefalse), $size);
  }
  
  
/**
   * Generates an image containing the barcode to use
   * in printing or on screen. 
   *
   * @param array The bitarray containing the code
   * @param integer optional An optional size (default: @default)
   */
  
public function generateBarcodeImage($bitArray$size=1) {
    
$imageWidth count($bitArrayCOUNT_RECURSIVE) - count($bitArray);
    
    
$imageWidth += count($this->leftGuard);
    
$imageWidth += count($this->centerGuardsCOUNT_RECURSIVE) - count($this->centerGuards);
    
$imageWidth += count($this->rightGuard);
    
$imageWidth += $size;
    
    
$image imagecreate(($imageWidth $size), ($this->barcodeGuardLength $size));
    
imagecolorallocate($image255255255); // White background
    
$imColorBarcode imagecolorallocate($image000); // Black color
    
$xPos 0;
    
    foreach (
$this->leftGuard AS $bit) {
      if (
$bit == 1) {
        
$this->imagelinethick($image$xPos+$size0$xPos+$size, ($this->barcodeGuardLength $size), $imColorBarcode$size);
      }
      
$xPos += $size;
    }
      
    foreach (
$bitArray AS $index => $bitArray) {
      foreach (
$bitArray AS $bit) {
        if (
$bit == 1) {
          
$this->imagelinethick($image$xPos+$size0$xPos+$size, ($this->barcodeLength $size), $imColorBarcode$size);
        }
        
$xPos += $size;
      }
      
      if (isset(
$this->centerGuards[$index])) {
        foreach (
$this->centerGuards[$index] AS $bit) {
          if (
$bit == 1) {
            
$this->imagelinethick($image$xPos+$size0$xPos+$size, ($this->barcodeGuardLength $size), $imColorBarcode$size);
          }
          
$xPos += $size;
        }
      }
    }
    
    foreach (
$this->rightGuard AS $bit) {
      if (
$bit == 1) {
        
$this->imagelinethick($image$xPos+$size0$xPos+$size, ($this->barcodeGuardLength $size), $imColorBarcode$size);
      }
      
$xPos += $size;
    }
    
    return 
$image;
  }
  
  
/**
   * Draw a line on the image of a specific width.
   * 
   * @link http://nl.php.net/manual/en/function.imageline.php
   * 
   * @param resource The image resource
   * @param integer The x1
   * @param integer The y1
   * @param integer The x2
   * @param integer The y2
   * @param resource The color
   * @param integer The thickness of the line
   * @return boolean True on success, FALSE otherwise
   */
  
private function imagelinethick($image$x1$y1$x2$y2$color$thick 1) {
    if (
$thick == 1) {
      return 
imageline($image$x1$y1$x2$y2$color);
    }
    
$t $thick 0.5;
    if (
$x1 == $x2 || $y1 == $y2) {
      return 
imagefilledrectangle($imageround(min($x1$x2) - $t), round(min($y1$y2) - $t), round(max($x1$x2) + $t), round(max($y1$y2) + $t), $color);
    }
    
$k = ($y2 $y1) / ($x2 $x1);
    
$a $t sqrt(pow($k2));
    
$points = array(
      
round($x1 - (1+$k)*$a), round($y1 + (1-$k)*$a),
      
round($x1 - (1-$k)*$a), round($y1 - (1+$k)*$a),
      
round($x2 + (1+$k)*$a), round($y2 - (1-$k)*$a),
      
round($x2 + (1-$k)*$a), round($y2 + (1+$k)*$a),
    );
    
imagefilledpolygon($image$points4$color);
    return 
imagepolygon($image$points4$color);
  }
}

/**
 * Class for EAN-13 codes
 * 
 * @package DigitBarCodes 
 */
class EAN13Barcode extends digitBarCodes {
  protected 
$codeLengthNoCheckum 12;
  protected 
$codeLength 1;
  
  protected 
$leftGuard = array(101);
  protected 
$rightGuard = array(101);
  protected 
$centerGuards = array(=> array(01010));
  
  protected 
$encodeStartDigit 1;
  
  protected 
$codeLookupTable = array(
    
'L' => array(
      
'0' => 
        array(
0001101),
      
'1' => 
        array(
0011001),
      
'2' => 
        array(
0010011),
      
'3' => 
        array(
0111101),
      
'4' => 
        array(
0100011),
      
'5' => 
        array(
0110001),
      
'6' => 
        array(
0101111),
      
'7' => 
        array(
0111011),
      
'8' => 
        array(
0110111),
      
'9' => 
        array(
0001011)
      ));
  
  
/**
   * Function for returning the checksum based on the input.
   * Returns false if no checksum could be generated
   *
   * @param string The barcode
   * @return integer The checksum as digit
   */
  
public function calculateChecksum($code) {
    if (!
ctype_digit($code) OR !ctype_digit($code)) {
      return 
false;
    }
    
$sum 0;
    foreach (
str_split(strrev($code)) AS $index => $digit) {
      
//Thank god PHP thinks 1 & 0 == 0
      
$sum += ($index) ? $digit $digit 3;
    }
    return (
$sum 10 == 0) ? 10 - ($sum 10);
  }
  
  
/**
   * Function to generate a bitArray from the code.
   * This bitArray can be used to render the actual
   * barcode as an image.
   *
   * @param string The code with or without the checksum
   * @param boolean optional Include guards? (default: true)
   * @return array|False A bitArray or False otherwise
   */
  
public function getBitarray($code$includeGuards=true) {
    
$code $this->getValidatedCode($code);
    if (
$code == false) {
      return 
false;
    }
        
    
$return = array();
    if (
$includeGuards) {
      
$return[] = $this->leftGuard;
    }
    
$structureMask str_split($this->getStructureMask($code));
    
    foreach (
str_split(substr($code$this->encodeStartDigit)) AS $index => $digit) {
      
$return[] = $this->encode($digit$structureMask[$index]);
      if (isset(
$this->centerGuards[$index]) AND $includeGuards) {
        
$return[] = $this->centerGuards[$index];
      }
    }
    if (
$includeGuards) {
      
$return[] = $this->rightGuard;
    }
    return 
$return;
  }

 
  
/**
   * Function to return the code if it's valid, if no if no checksum is
   * provided the return will include this
   *
   * @param string The code to check
   * @param string|False The valid code or False otherwise
   */
  
public function getValidatedCode($code) {
    if (!
ctype_digit($code) OR !ctype_digit($code)) {
      return 
false;
    }
    if (
strlen($code) == $this->codeLengthNoCheckum) {
      return 
$code $this->calculateChecksum($code);
    } elseif (
strlen($code) == ($this->codeLengthNoCheckum $this->codeLength)) {
      if (
$this->calculateChecksum(substr($code0, (-  $this->codeLength))) != substr($code, (-  $this->codeLength))) {
        return 
false;
      }
      return 
$code;
    }
    return 
false;
  }
  
  
/**
   * Returns the mask to use for the EAN-13 code
   *
   * @param string The code (with or without the checksum)
   * @return string The mask to use
   */
  
protected function getStructureMask($code) {
    if (!
ctype_digit($code)) {
      return 
false;
    }
    switch (
substr($code01)) {
      case 
'0':
        return 
'LLLLLLRRRRRR';
      case 
'1':
        return 
'LLGLGGRRRRRR';
      case 
'2':
        return 
'LLGGLGRRRRRR';
      case 
'3':
        return 
'LLGGGLRRRRRR';
      case 
'4':
        return 
'LGLLGGRRRRRR';
      case 
'5':
        return 
'LGGLLGRRRRRR';
      case 
'6':
        return 
'LGGGLLRRRRRR';
      case 
'7':
        return 
'LGLGLGRRRRRR';
      case 
'8':
        return 
'LGLGGLRRRRRR';
      case 
'9':
        return 
'LGGLGLRRRRRR';
    }
    return 
false//Even though we can never actually reach this
  
}
  
  
/**
   * Returns the L/G/R-code for the integer for usage with EAN-13
   *
   * @param integer The integer to encode
   * @param string The codebase (R/G/L)
   * @return integer The encoded integer
   */
  
protected function encode($integer$codeBase) {
    if (
$codeBase == 'R') {
      return 
$this->bitArrayNOT($this->codeLookupTable['L'][$integer]);
    } elseif (
$codeBase == 'G') {
      return 
array_reverse($this->bitArrayNOT($this->codeLookupTable['L'][$integer]));
    } else {
      return 
$this->codeLookupTable['L'][$integer];
    }
  }
}

/**
 * Class for EAN-8, based on the EAN-13 class
 * 
 * @package DigitBarCodes 
 */
class EAN8Barcode extends EAN13Barcode {
  protected 
$codeLengthNoCheckum 7;
  protected 
$codeLength 1;
  
  protected 
$centerGuards = array(=> array(01010));
  
  protected 
$encodeStartDigit 0;
  
  
/**
   * Returns the mask to use for the EAN-8 code
   *
   * @param string The code (with or without the checksum)
   * @return string The mask to use
   */
  
protected function getStructureMask($code) {
    if (!
ctype_digit($code)) {
      return 
false;
    }
    return 
'LLLLRRRR';
  }
}

Uiteraard is deze PHP implementatie van EAN-8 en EAN-13 te downloaden.

Bekijk andere blog posts