Barcode/Renderer/Image.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Barcode
subpackage: Renderer
version: $Id: Image.php 20367 2010-01-18 04:51:23Z ralph $
Classes: Zend_Barcode_Renderer_Image

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Barcode_Renderer_Image
jump to top

Extends from: Zend_Barcode_Renderer_RendererAbstract
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Barcode
Properties: $_allowedImageType; $_imageType; $_resource; $_imageForeColor; $_imageBackgroundColor; $_userHeight; $_userWidth
Methods: __construct; setHeight; getHeight; setWidth; getWidth; setResource; setImageType; getImageType; _initRenderer; _checkParams; _checkDimensions; render; _drawPolygon; _drawText

Description

Class for rendering the barcode as image

Properties

$_allowedImageType
jump to class

array $_allowedImageType = 'array'

List of authorized output format

Details

$_allowedImageType: array
visibility: protected
default: array
final: false
static: false

$_imageBackgroundColor
jump to class

integer $_imageBackgroundColor = 'null'

Resource for the background color of the image

Details

$_imageBackgroundColor: integer
visibility: protected
default: null
final: false
static: false

$_imageForeColor
jump to class

integer $_imageForeColor = 'null'

Resource for the font and bars color of the image

Details

$_imageForeColor: integer
visibility: protected
default: null
final: false
static: false

$_imageType
jump to class

string $_imageType = 'png'

Image format

Details

$_imageType: string
visibility: protected
default: png
final: false
static: false

$_resource
jump to class

resource $_resource = 'null'

Resource for the image

Details

$_resource: resource
visibility: protected
default: null
final: false
static: false

$_userHeight
jump to class

integer $_userHeight = '0'

Height of the rendered image wanted by user

Details

$_userHeight: integer
visibility: protected
default: 0
final: false
static: false

$_userWidth
jump to class

integer $_userWidth = '0'

Width of the rendered image wanted by user

Details

$_userWidth: integer
visibility: protected
default: 0
final: false
static: false

Methods

__construct
jump to class

__construct(
           $options
              =
              null
          )
        
        :

Arguments

$options

Details

visibility: public
final: false
static: false

_checkDimensions
jump to class

_checkDimensions(
          
          )
        
        :
        void

Check barcode dimensions

Details

visibility: protected
final: false
static: false

_checkParams
jump to class

_checkParams(
          
          )
        
        :
        void

Check barcode parameters

Details

visibility: protected
final: false
static: false

_drawPolygon
jump to class

_drawPolygon(
          array $points, integer $color, boolean $filled
              =
              true
          )
        
        :

Draw a polygon in the image resource

Arguments

$points: array
$color: integer
$filled: boolean

Details

visibility: protected
final: false
static: false

_drawText
jump to class

_drawText(
          string $text, float $size, array $position, string $font, integer $color, string $alignment
              =
              center, float $orientation
              =
              0
          )
        
        :

Draw a polygon in the image resource

Arguments

$text: string
$size: float
$position: array
$font: string
$color: integer
$alignment: string
$orientation: float

Details

visibility: protected
final: false
static: false

_initRenderer
jump to class

_initRenderer(
          
          )
        
        :
        void

Initialize the image resource

Details

visibility: protected
final: false
static: false

getHeight
jump to class

getHeight(
          
          )
        
        :
        int

Get barcode height

Output

int

Details

visibility: public
final: false
static: false

getImageType
jump to class

getImageType(
          
          )
        
        :
        string

Retrieve the image type to produce

Output

string

Details

visibility: public
final: false
static: false

getWidth
jump to class

getWidth(
          
          )
        
        :
        int

Get barcode width

Output

int

Details

visibility: public
final: false
static: false

render
jump to class

render(
          
          )
        
        :
        mixed

Draw and render the barcode with correct headers

Output

mixed

Details

visibility: public
final: false
static: false

setHeight
jump to class

setHeight(
          null|integer $value
          )
        
        :
        Zend_Image_Barcode_Abstract

Set height of the result image

Arguments

$value: nullinteger

Output

Zend_Image_Barcode_Abstract

Details

visibility: public
final: false
static: false
throw

setImageType
jump to class

setImageType(
          string $value
          )
        
        :
        Zend_Barcode_RendererAbstract

Set the image type to produce (png, jpeg, gif)

Arguments

$value: string

Output

Zend_Barcode_RendererAbstract

Details

visibility: public
final: false
static: false
throw

setResource
jump to class

setResource(
           $image
          )
        
        :
        Zend_Barcode_Renderer

Set an image resource to draw the barcode inside

Arguments

$image

Output

Zend_Barcode_Renderer

Details

visibility: public
final: false
static: false
throw

setWidth
jump to class

setWidth(
          mixed $value
          )
        
        :
        void

Set barcode width

Arguments

$value: mixed

Details

visibility: public
final: false
static: false

API Documentation

Barcode/Renderer/Image.php

Description

Zend_Barcode_Renderer_Imagejump to top

Description

Properties

$_allowedImageTypejump to class

Details

$_imageBackgroundColorjump to class

Details

$_imageForeColorjump to class

Details

$_imageTypejump to class

Details

$_resourcejump to class

Details

$_userHeightjump to class

Details

$_userWidthjump to class

Details

Methods

__constructjump to class

Arguments

Details

_checkDimensionsjump to class

Details

_checkParamsjump to class

Details

_drawPolygonjump to class

Arguments

Details

_drawTextjump to class

Arguments

Details

_initRendererjump to class

Details

getHeightjump to class

Output

Details

getImageTypejump to class

Output

Details

getWidthjump to class

Output

Details

renderjump to class

Output

Details

setHeightjump to class

Arguments

Output

Details

setImageTypejump to class

Arguments

Output

Details

setResourcejump to class

Arguments

Output

Details

setWidthjump to class

Arguments

Details

Zend_Barcode_Renderer_Image
jump to top

$_allowedImageType
jump to class

$_imageBackgroundColor
jump to class

$_imageForeColor
jump to class

$_imageType
jump to class

$_resource
jump to class

$_userHeight
jump to class

$_userWidth
jump to class

__construct
jump to class

_checkDimensions
jump to class

_checkParams
jump to class

_drawPolygon
jump to class

_drawText
jump to class

_initRenderer
jump to class

getHeight
jump to class

getImageType
jump to class

getWidth
jump to class

render
jump to class

setHeight
jump to class

setImageType
jump to class

setResource
jump to class

setWidth
jump to class