Inheritance diagram for Zend_Pdf_Canvas_Abstract:

Public Member Functions
	drawCanvas (Zend_Pdf_Canvas_Interface $canvas, $x1, $y1, $x2=null, $y2=null)

	setFillColor (Zend_Pdf_Color $color)

	setLineColor (Zend_Pdf_Color $color)

	setLineWidth ($width)

	setLineDashingPattern ($pattern, $phase=0)

	setFont (Zend_Pdf_Resource_Font $font, $fontSize)

	setStyle (Zend_Pdf_Style $style)

	getFont ()

	getFontSize ()

	getStyle ()

	saveGS ()

	restoreGS ()

	setAlpha ($alpha, $mode='Normal')

	clipCircle ($x, $y, $radius, $startAngle=null, $endAngle=null)

	clipEllipse ($x1, $y1, $x2, $y2, $startAngle=null, $endAngle=null)

	clipPolygon ($x, $y, $fillMethod=Zend_Pdf_Page::FILL_METHOD_NON_ZERO_WINDING)

	clipRectangle ($x1, $y1, $x2, $y2)

	drawCircle ($x, $y, $radius, $param4=null, $param5=null, $param6=null)

	drawEllipse ($x1, $y1, $x2, $y2, $param5=null, $param6=null, $param7=null)

	drawImage (Zend_Pdf_Resource_Image $image, $x1, $y1, $x2, $y2)

	drawLayoutBox ($box, $x, $y)

	drawLine ($x1, $y1, $x2, $y2)

	drawPolygon ($x, $y, $fillType=Zend_Pdf_Page::SHAPE_DRAW_FILL_AND_STROKE, $fillMethod=Zend_Pdf_Page::FILL_METHOD_NON_ZERO_WINDING)

	drawRectangle ($x1, $y1, $x2, $y2, $fillType=Zend_Pdf_Page::SHAPE_DRAW_FILL_AND_STROKE)

	drawRoundedRectangle ($x1, $y1, $x2, $y2, $radius, $fillType=Zend_Pdf_Page::SHAPE_DRAW_FILL_AND_STROKE)

	drawText ($text, $x, $y, $charEncoding='')

	pathClose ()

	pathLine ($x, $y)

	pathMove ($x, $y)

	rotate ($x, $y, $angle)

	scale ($xScale, $yScale)

	translate ($xShift, $yShift)

	skew ($x, $y, $xAngle, $yAngle)

	rawWrite ($data, $procSet=null)

Public Member Functions inherited from Zend_Pdf_Canvas_Interface
	getResources ()

	getContents ()

	getHeight ()

	getWidth ()

Protected Member Functions
	_addProcSet ($procSetName)

	_attachResource ($type, Zend_Pdf_Resource $resource)

Protected Attributes
	$_contents = ''

	$_font = null

	$_fontSize

	$_style = null

	$_saveCount = 0

Detailed Description

Definition at line 47 of file Abstract.php.

Member Function Documentation

◆ _addProcSet()

_addProcSet ( $procSetName )

abstractprotected

Add procedureSet to the Page description

Parameters

string $procSetName

◆ _attachResource()

_attachResource	(		$type,
		Zend_Pdf_Resource	$resource
	)

abstractprotected

Attach resource to the canvas

Method returns a name of the resource which can be used as a resource reference within drawing instructions stream Allowed types: 'ExtGState', 'ColorSpace', 'Pattern', 'Shading', 'XObject', 'Font', 'Properties'

Parameters

string	$type
Zend_Pdf_Resource	$resource

Returns: string

◆ clipCircle()

clipCircle	(	$x,
		$y,
		$radius,
		$startAngle = `null`,
		$endAngle = `null`
	)

Intersect current clipping area with a circle.

Parameters

float	$x
float	$y
float	$radius
float	$startAngle
float	$endAngle

Returns: Zend_Pdf_Canvas_Interface

Implements Zend_Pdf_Canvas_Interface.

Definition at line 390 of file Abstract.php.

     {
         $this->clipEllipse($x - $radius, $y - $radius,
                            $x + $radius, $y + $radius,
                            $startAngle, $endAngle);
 
         return $this;
     }

◆ clipEllipse()

clipEllipse	(	$x1,
		$y1,
		$x2,
		$y2,
		$startAngle = `null`,
		$endAngle = `null`
	)

Intersect current clipping area with a polygon.

Method signatures: drawEllipse($x1, $y1, $x2, $y2); drawEllipse($x1, $y1, $x2, $y2, $startAngle, $endAngle);

Todo:: process special cases with $x2-$x1 == 0 or $y2-$y1 == 0

Parameters

float	$x1
float	$y1
float	$x2
float	$y2
float	$startAngle
float	$endAngle

Returns: Zend_Pdf_Canvas_Interface

Implements Zend_Pdf_Canvas_Interface.

Definition at line 416 of file Abstract.php.

     {
         $this->_addProcSet('PDF');
 
         if ($x2 < $x1) {
             $temp = $x1;
             $x1   = $x2;
             $x2   = $temp;
         }
         if ($y2 < $y1) {
             $temp = $y1;
             $y1   = $y2;
             $y2   = $temp;
         }
 
         $x = ($x1 + $x2)/2.;
         $y = ($y1 + $y2)/2.;
 
         $xC = new Zend_Pdf_Element_Numeric($x);
         $yC = new Zend_Pdf_Element_Numeric($y);
 
         if ($startAngle !== null) {
             if ($startAngle != 0) { $startAngle = fmod($startAngle, M_PI*2); }
             if ($endAngle   != 0) { $endAngle   = fmod($endAngle,   M_PI*2); }
 
             if ($startAngle > $endAngle) {
                 $endAngle += M_PI*2;
             }
 
             $clipPath    = $xC->toString() . ' ' . $yC->toString() . " m\n";
             $clipSectors = (int)ceil(($endAngle - $startAngle)/M_PI_4);
             $clipRadius  = max($x2 - $x1, $y2 - $y1);
 
             for($count = 0; $count <= $clipSectors; $count++) {
                 $pAngle = $startAngle + ($endAngle - $startAngle)*$count/(float)$clipSectors;
 
                 $pX = new Zend_Pdf_Element_Numeric($x + cos($pAngle)*$clipRadius);
                 $pY = new Zend_Pdf_Element_Numeric($y + sin($pAngle)*$clipRadius);
                 $clipPath .= $pX->toString() . ' ' . $pY->toString() . " l\n";
             }
 
             $this->_contents .= $clipPath . "h\nW\nn\n";
         }
 
         $xLeft  = new Zend_Pdf_Element_Numeric($x1);
         $xRight = new Zend_Pdf_Element_Numeric($x2);
         $yUp    = new Zend_Pdf_Element_Numeric($y2);
         $yDown  = new Zend_Pdf_Element_Numeric($y1);
 
         $xDelta  = 2*(M_SQRT2 - 1)*($x2 - $x1)/3.;
         $yDelta  = 2*(M_SQRT2 - 1)*($y2 - $y1)/3.;
         $xr = new Zend_Pdf_Element_Numeric($x + $xDelta);
         $xl = new Zend_Pdf_Element_Numeric($x - $xDelta);
         $yu = new Zend_Pdf_Element_Numeric($y + $yDelta);
         $yd = new Zend_Pdf_Element_Numeric($y - $yDelta);
 
         $this->_contents .= $xC->toString() . ' ' . $yUp->toString() . " m\n"
                          .  $xr->toString() . ' ' . $yUp->toString() . ' '
                          .    $xRight->toString() . ' ' . $yu->toString() . ' '
                          .      $xRight->toString() . ' ' . $yC->toString() . " c\n"
                          .  $xRight->toString() . ' ' . $yd->toString() . ' '
                          .    $xr->toString() . ' ' . $yDown->toString() . ' '
                          .      $xC->toString() . ' ' . $yDown->toString() . " c\n"
                          .  $xl->toString() . ' ' . $yDown->toString() . ' '
                          .    $xLeft->toString() . ' ' . $yd->toString() . ' '
                          .      $xLeft->toString() . ' ' . $yC->toString() . " c\n"
                          .  $xLeft->toString() . ' ' . $yu->toString() . ' '
                          .    $xl->toString() . ' ' . $yUp->toString() . ' '
                          .      $xC->toString() . ' ' . $yUp->toString() . " c\n"
                          .  "h\nW\nn\n";
 
         return $this;
     }

◆ clipPolygon()

clipPolygon	(	$x,
		$y,
		$fillMethod = `Zend_Pdf_Page::FILL_METHOD_NON_ZERO_WINDING`
	)

Intersect current clipping area with a polygon.

Parameters

array	$x	- array of float (the X co-ordinates of the vertices)
array	$y	- array of float (the Y co-ordinates of the vertices)
integer	$fillMethod

Returns: Zend_Pdf_Canvas_Interface

Implements Zend_Pdf_Canvas_Interface.

Definition at line 498 of file Abstract.php.

     {
         $this->_addProcSet('PDF');
 
         $firstPoint = true;
         foreach ($x as $id => $xVal) {
             $xObj = new Zend_Pdf_Element_Numeric($xVal);
             $yObj = new Zend_Pdf_Element_Numeric($y[$id]);
 
             if ($firstPoint) {
                 $path = $xObj->toString() . ' ' . $yObj->toString() . " m\n";
                 $firstPoint = false;
             } else {
                 $path .= $xObj->toString() . ' ' . $yObj->toString() . " l\n";
             }
         }
 
         $this->_contents .= $path;
 
         if ($fillMethod == Zend_Pdf_Page::FILL_METHOD_NON_ZERO_WINDING) {
             $this->_contents .= " h\n W\nn\n";
         } else {
             // Even-Odd fill method.
             $this->_contents .= " h\n W*\nn\n";
         }
 
         return $this;
     }

◆ clipRectangle()

clipRectangle	(	$x1,
		$y1,
		$x2,
		$y2
	)

Intersect current clipping area with a rectangle.

Parameters

float	$x1
float	$y1
float	$x2
float	$y2

Returns: Zend_Pdf_Canvas_Interface

Implements Zend_Pdf_Canvas_Interface.

Definition at line 536 of file Abstract.php.

     {
         $this->_addProcSet('PDF');
 
         $x1Obj      = new Zend_Pdf_Element_Numeric($x1);
         $y1Obj      = new Zend_Pdf_Element_Numeric($y1);
         $widthObj   = new Zend_Pdf_Element_Numeric($x2 - $x1);
         $height2Obj = new Zend_Pdf_Element_Numeric($y2 - $y1);
 
         $this->_contents .= $x1Obj->toString() . ' ' . $y1Obj->toString() . ' '
                          .      $widthObj->toString() . ' ' . $height2Obj->toString() . " re\n"
                          .  " W\nn\n";
 
         return $this;
     }

◆ drawCanvas()

drawCanvas	(	Zend_Pdf_Canvas_Interface	$canvas,
			$x1,
			$y1,
			$x2 = `null`,
			$y2 = `null`
	)

Draw a canvas at the specified location

If upper right corner is not specified then canvas heght and width are used.

Parameters

Zend_Pdf_Canvas_Interface	$canvas
float	$x1
float	$y1
float	$x2
float	$y2

Returns: Zend_Pdf_Canvas_Interface

Todo:: implementation

Implements Zend_Pdf_Canvas_Interface.

Definition at line 120 of file Abstract.php.

     {
         $this->saveGS();
 
         $this->translate($x1, $y1);
 
         if ($x2 === null) {
             $with = $canvas->getWidth();
         } else {
             $with = $x2 - $x1;
         }
         if ($y2 === null) {
             $height = $canvas->getHeight();
         } else {
             $height = $y2 - $y1;
         }
 
         $this->clipRectangle(0, 0, $with, $height);
 
         if ($x2 !== null  ||  $y2 !== null) {
             // Drawn canvas has to be scaled.
             if ($x2 !== null) {
                 $xScale = $with/$canvas->getWidth();
             } else {
                 $xScale = 1;
             }
 
             if ($y2 !== null) {
                 $yScale = $height/$canvas->getHeight();
             } else {
                 $yScale = 1;
             }
 
             $this->scale($xScale, $yScale);
         }
 
         $contentsToDraw = $canvas->getContents();
         $this->restoreGS();
 
         return $this;
     }

◆ drawCircle()

drawCircle	(	$x,
		$y,
		$radius,
		$param4 = `null`,
		$param5 = `null`,
		$param6 = `null`
	)

Draw a circle centered on x, y with a radius of radius.

Method signatures: drawCircle($x, $y, $radius); drawCircle($x, $y, $radius, $fillType); drawCircle($x, $y, $radius, $startAngle, $endAngle); drawCircle($x, $y, $radius, $startAngle, $endAngle, $fillType);

It's not a really circle, because PDF supports only cubic Bezier curves. But very good approximation. It differs from a real circle on a maximum 0.00026 radiuses (at PI/8, 3*PI/8, 5*PI/8, 7*PI/8, 9*PI/8, 11*PI/8, 13*PI/8 and 15*PI/8 angles). At 0, PI/4, PI/2, 3*PI/4, PI, 5*PI/4, 3*PI/2 and 7*PI/4 it's exactly a tangent to a circle.

Parameters

float	$x
float	$y
float	$radius
mixed	$param4
mixed	$param5
mixed	$param6

Returns: Zend_Pdf_Canvas_Interface

Implements Zend_Pdf_Canvas_Interface.

Definition at line 577 of file Abstract.php.

     {
         $this->drawEllipse($x - $radius, $y - $radius,
                            $x + $radius, $y + $radius,
                            $param4, $param5, $param6);
 
         return $this;
     }

◆ drawEllipse()

drawEllipse	(	$x1,
		$y1,
		$x2,
		$y2,
		$param5 = `null`,
		$param6 = `null`,
		$param7 = `null`
	)

Draw an ellipse inside the specified rectangle.

Method signatures: drawEllipse($x1, $y1, $x2, $y2); drawEllipse($x1, $y1, $x2, $y2, $fillType); drawEllipse($x1, $y1, $x2, $y2, $startAngle, $endAngle); drawEllipse($x1, $y1, $x2, $y2, $startAngle, $endAngle, $fillType);

Todo:: process special cases with $x2-$x1 == 0 or $y2-$y1 == 0

Parameters

float	$x1
float	$y1
float	$x2
float	$y2
mixed	$param5
mixed	$param6
mixed	$param7

Returns: Zend_Pdf_Canvas_Interface

Implements Zend_Pdf_Canvas_Interface.

Definition at line 606 of file Abstract.php.

     {
         if ($param5 === null) {
             // drawEllipse($x1, $y1, $x2, $y2);
             $startAngle = null;
             $fillType = Zend_Pdf_Page::SHAPE_DRAW_FILL_AND_STROKE;
         } else if ($param6 === null) {
             // drawEllipse($x1, $y1, $x2, $y2, $fillType);
             $startAngle = null;
             $fillType = $param5;
         } else {
             // drawEllipse($x1, $y1, $x2, $y2, $startAngle, $endAngle);
             // drawEllipse($x1, $y1, $x2, $y2, $startAngle, $endAngle, $fillType);
             $startAngle = $param5;
             $endAngle   = $param6;
 
             if ($param7 === null) {
                 $fillType = Zend_Pdf_Page::SHAPE_DRAW_FILL_AND_STROKE;
             } else {
                 $fillType = $param7;
             }
         }
 
         $this->_addProcSet('PDF');
 
         if ($x2 < $x1) {
             $temp = $x1;
             $x1   = $x2;
             $x2   = $temp;
         }
         if ($y2 < $y1) {
             $temp = $y1;
             $y1   = $y2;
             $y2   = $temp;
         }
 
         $x = ($x1 + $x2)/2.;
         $y = ($y1 + $y2)/2.;
 
         $xC = new Zend_Pdf_Element_Numeric($x);
         $yC = new Zend_Pdf_Element_Numeric($y);
 
         if ($startAngle !== null) {
             if ($startAngle != 0) { $startAngle = fmod($startAngle, M_PI*2); }
             if ($endAngle   != 0) { $endAngle   = fmod($endAngle,   M_PI*2); }
 
             if ($startAngle > $endAngle) {
                 $endAngle += M_PI*2;
             }
 
             $clipPath    = $xC->toString() . ' ' . $yC->toString() . " m\n";
             $clipSectors = (int)ceil(($endAngle - $startAngle)/M_PI_4);
             $clipRadius  = max($x2 - $x1, $y2 - $y1);
 
             for($count = 0; $count <= $clipSectors; $count++) {
                 $pAngle = $startAngle + ($endAngle - $startAngle)*$count/(float)$clipSectors;
 
                 $pX = new Zend_Pdf_Element_Numeric($x + cos($pAngle)*$clipRadius);
                 $pY = new Zend_Pdf_Element_Numeric($y + sin($pAngle)*$clipRadius);
                 $clipPath .= $pX->toString() . ' ' . $pY->toString() . " l\n";
             }
 
             $this->_contents .= "q\n" . $clipPath . "h\nW\nn\n";
         }
 
         $xLeft  = new Zend_Pdf_Element_Numeric($x1);
         $xRight = new Zend_Pdf_Element_Numeric($x2);
         $yUp    = new Zend_Pdf_Element_Numeric($y2);
         $yDown  = new Zend_Pdf_Element_Numeric($y1);
 
         $xDelta  = 2*(M_SQRT2 - 1)*($x2 - $x1)/3.;
         $yDelta  = 2*(M_SQRT2 - 1)*($y2 - $y1)/3.;
         $xr = new Zend_Pdf_Element_Numeric($x + $xDelta);
         $xl = new Zend_Pdf_Element_Numeric($x - $xDelta);
         $yu = new Zend_Pdf_Element_Numeric($y + $yDelta);
         $yd = new Zend_Pdf_Element_Numeric($y - $yDelta);
 
         $this->_contents .= $xC->toString() . ' ' . $yUp->toString() . " m\n"
                          .  $xr->toString() . ' ' . $yUp->toString() . ' '
                          .    $xRight->toString() . ' ' . $yu->toString() . ' '
                          .      $xRight->toString() . ' ' . $yC->toString() . " c\n"
                          .  $xRight->toString() . ' ' . $yd->toString() . ' '
                          .    $xr->toString() . ' ' . $yDown->toString() . ' '
                          .      $xC->toString() . ' ' . $yDown->toString() . " c\n"
                          .  $xl->toString() . ' ' . $yDown->toString() . ' '
                          .    $xLeft->toString() . ' ' . $yd->toString() . ' '
                          .      $xLeft->toString() . ' ' . $yC->toString() . " c\n"
                          .  $xLeft->toString() . ' ' . $yu->toString() . ' '
                          .    $xl->toString() . ' ' . $yUp->toString() . ' '
                          .      $xC->toString() . ' ' . $yUp->toString() . " c\n";
 
         switch ($fillType) {
             case Zend_Pdf_Page::SHAPE_DRAW_FILL_AND_STROKE:
                 $this->_contents .= " B*\n";
                 break;
             case Zend_Pdf_Page::SHAPE_DRAW_FILL:
                 $this->_contents .= " f*\n";
                 break;
             case Zend_Pdf_Page::SHAPE_DRAW_STROKE:
                 $this->_contents .= " S\n";
                 break;
         }
 
         if ($startAngle !== null) {
             $this->_contents .= "Q\n";
         }
 
         return $this;
     }

◆ drawImage()

drawImage	(	Zend_Pdf_Resource_Image	$image,
			$x1,
			$y1,
			$x2,
			$y2
	)

Draw an image at the specified position on the page.

Parameters

Zend_Pdf_Image	$image
float	$x1
float	$y1
float	$x2
float	$y2

Returns: Zend_Pdf_Canvas_Interface

Implements Zend_Pdf_Canvas_Interface.

Definition at line 726 of file Abstract.php.

     {
         $this->_addProcSet('PDF');
 
         $imageName    = $this->_attachResource('XObject', $image);
         $imageNameObj = new Zend_Pdf_Element_Name($imageName);
 
         $x1Obj     = new Zend_Pdf_Element_Numeric($x1);
         $y1Obj     = new Zend_Pdf_Element_Numeric($y1);
         $widthObj  = new Zend_Pdf_Element_Numeric($x2 - $x1);
         $heightObj = new Zend_Pdf_Element_Numeric($y2 - $y1);
 
         $this->_contents .= "q\n"
                          .  '1 0 0 1 ' . $x1Obj->toString() . ' ' . $y1Obj->toString() . " cm\n"
                          .  $widthObj->toString() . ' 0 0 ' . $heightObj->toString() . " 0 0 cm\n"
                          .  $imageNameObj->toString() . " Do\n"
                          .  "Q\n";
 
         return $this;
     }

◆ drawLayoutBox()

drawLayoutBox	(	$box,
		$x,
		$y
	)

Draw a LayoutBox at the specified position on the page.

Todo:: implementation

Implements Zend_Pdf_Canvas_Interface.

Definition at line 757 of file Abstract.php.

     {
         return $this;
     }

◆ drawLine()

drawLine	(	$x1,
		$y1,
		$x2,
		$y2
	)

Draw a line from x1,y1 to x2,y2.

Parameters

float	$x1
float	$y1
float	$x2
float	$y2

Returns: Zend_Pdf_Canvas_Interface

Implements Zend_Pdf_Canvas_Interface.

Definition at line 772 of file Abstract.php.

     {
         $this->_addProcSet('PDF');
 
         $x1Obj = new Zend_Pdf_Element_Numeric($x1);
         $y1Obj = new Zend_Pdf_Element_Numeric($y1);
         $x2Obj = new Zend_Pdf_Element_Numeric($x2);
         $y2Obj = new Zend_Pdf_Element_Numeric($y2);
 
         $this->_contents .= $x1Obj->toString() . ' ' . $y1Obj->toString() . " m\n"
                          .  $x2Obj->toString() . ' ' . $y2Obj->toString() . " l\n S\n";
 
         return $this;
     }

◆ drawPolygon()

drawPolygon	(	$x,
		$y,
		$fillType = `Zend_Pdf_Page::SHAPE_DRAW_FILL_AND_STROKE`,
		$fillMethod = `Zend_Pdf_Page::FILL_METHOD_NON_ZERO_WINDING`
	)

Draw a polygon.

If $fillType is Zend_Pdf_Page::SHAPE_DRAW_FILL_AND_STROKE or Zend_Pdf_Page::SHAPE_DRAW_FILL, then polygon is automatically closed. See detailed description of these methods in a PDF documentation (section 4.4.2 Path painting Operators, Filling)

Parameters

array	$x	- array of float (the X co-ordinates of the vertices)
array	$y	- array of float (the Y co-ordinates of the vertices)
integer	$fillType
integer	$fillMethod

Returns: Zend_Pdf_Canvas_Interface

Implements Zend_Pdf_Canvas_Interface.

Definition at line 801 of file Abstract.php.

     {
         $this->_addProcSet('PDF');
 
         $firstPoint = true;
         foreach ($x as $id => $xVal) {
             $xObj = new Zend_Pdf_Element_Numeric($xVal);
             $yObj = new Zend_Pdf_Element_Numeric($y[$id]);
 
             if ($firstPoint) {
                 $path = $xObj->toString() . ' ' . $yObj->toString() . " m\n";
                 $firstPoint = false;
             } else {
                 $path .= $xObj->toString() . ' ' . $yObj->toString() . " l\n";
             }
         }
 
         $this->_contents .= $path;
 
         switch ($fillType) {
             case Zend_Pdf_Page::SHAPE_DRAW_FILL_AND_STROKE:
                 if ($fillMethod == Zend_Pdf_Page::FILL_METHOD_NON_ZERO_WINDING) {
                     $this->_contents .= " b\n";
                 } else {
                     // Even-Odd fill method.
                     $this->_contents .= " b*\n";
                 }
                 break;
             case Zend_Pdf_Page::SHAPE_DRAW_FILL:
                 if ($fillMethod == Zend_Pdf_Page::FILL_METHOD_NON_ZERO_WINDING) {
                     $this->_contents .= " h\n f\n";
                 } else {
                     // Even-Odd fill method.
                     $this->_contents .= " h\n f*\n";
                 }
                 break;
             case Zend_Pdf_Page::SHAPE_DRAW_STROKE:
                 $this->_contents .= " S\n";
                 break;
         }
 
         return $this;
     }

◆ drawRectangle()

drawRectangle	(	$x1,
		$y1,
		$x2,
		$y2,
		$fillType = `Zend_Pdf_Page::SHAPE_DRAW_FILL_AND_STROKE`
	)

Draw a rectangle.

Fill types: Zend_Pdf_Page::SHAPE_DRAW_FILL_AND_STROKE - fill rectangle and stroke (default) Zend_Pdf_Page::SHAPE_DRAW_STROKE - stroke rectangle Zend_Pdf_Page::SHAPE_DRAW_FILL - fill rectangle

Parameters

float	$x1
float	$y1
float	$x2
float	$y2
integer	$fillType

Returns: Zend_Pdf_Canvas_Interface

Implements Zend_Pdf_Canvas_Interface.

Definition at line 862 of file Abstract.php.

     {
         $this->_addProcSet('PDF');
 
         $x1Obj      = new Zend_Pdf_Element_Numeric($x1);
         $y1Obj      = new Zend_Pdf_Element_Numeric($y1);
         $widthObj   = new Zend_Pdf_Element_Numeric($x2 - $x1);
         $height2Obj = new Zend_Pdf_Element_Numeric($y2 - $y1);
 
         $this->_contents .= $x1Obj->toString() . ' ' . $y1Obj->toString() . ' '
                              .  $widthObj->toString() . ' ' . $height2Obj->toString() . " re\n";
 
         switch ($fillType) {
             case Zend_Pdf_Page::SHAPE_DRAW_FILL_AND_STROKE:
                 $this->_contents .= " B*\n";
                 break;
             case Zend_Pdf_Page::SHAPE_DRAW_FILL:
                 $this->_contents .= " f*\n";
                 break;
             case Zend_Pdf_Page::SHAPE_DRAW_STROKE:
                 $this->_contents .= " S\n";
                 break;
         }
 
         return $this;
     }

◆ drawRoundedRectangle()

drawRoundedRectangle	(	$x1,
		$y1,
		$x2,
		$y2,
		$radius,
		$fillType = `Zend_Pdf_Page::SHAPE_DRAW_FILL_AND_STROKE`
	)

Draw a rounded rectangle.

Fill types: Zend_Pdf_Page::SHAPE_DRAW_FILL_AND_STROKE - fill rectangle and stroke (default) Zend_Pdf_Page::SHAPE_DRAW_STROKE - stroke rectangle Zend_Pdf_Page::SHAPE_DRAW_FILL - fill rectangle

radius is an integer representing radius of the four corners, or an array of four integers representing the radius starting at top left, going clockwise

Parameters

float	$x1
float	$y1
float	$x2
float	$y2
integer \| array	$radius
integer	$fillType

Returns: Zend_Pdf_Canvas_Interface

Implements Zend_Pdf_Canvas_Interface.

Definition at line 909 of file Abstract.php.

     {
 
         $this->_addProcSet('PDF');
 
         if(!is_array($radius)) {
             $radius = array($radius, $radius, $radius, $radius);
         } else {
             for ($i = 0; $i < 4; $i++) {
                 if(!isset($radius[$i])) {
                     $radius[$i] = 0;
                 }
             }
         }
 
         $topLeftX      = $x1;
         $topLeftY      = $y2;
         $topRightX     = $x2;
         $topRightY     = $y2;
         $bottomRightX  = $x2;
         $bottomRightY  = $y1;
         $bottomLeftX   = $x1;
         $bottomLeftY   = $y1;
 
         //draw top side
         $x1Obj = new Zend_Pdf_Element_Numeric($topLeftX + $radius[0]);
         $y1Obj = new Zend_Pdf_Element_Numeric($topLeftY);
         $this->_contents .= $x1Obj->toString() . ' ' . $y1Obj->toString() . " m\n";
         $x1Obj = new Zend_Pdf_Element_Numeric($topRightX - $radius[1]);
         $y1Obj = new Zend_Pdf_Element_Numeric($topRightY);
         $this->_contents .= $x1Obj->toString() . ' ' . $y1Obj->toString() . " l\n";
 
         //draw top right corner if needed
         if ($radius[1] != 0) {
             $x1Obj = new Zend_Pdf_Element_Numeric($topRightX);
             $y1Obj = new Zend_Pdf_Element_Numeric($topRightY);
             $x2Obj = new Zend_Pdf_Element_Numeric($topRightX);
             $y2Obj = new Zend_Pdf_Element_Numeric($topRightY);
             $x3Obj = new Zend_Pdf_Element_Numeric($topRightX);
             $y3Obj = new Zend_Pdf_Element_Numeric($topRightY - $radius[1]);
             $this->_contents .= $x1Obj->toString() . ' ' . $y1Obj->toString() . ' '
                               . $x2Obj->toString() . ' ' . $y2Obj->toString() . ' '
                               . $x3Obj->toString() . ' ' . $y3Obj->toString() . ' '
                               . " c\n";
         }
 
         //draw right side
         $x1Obj = new Zend_Pdf_Element_Numeric($bottomRightX);
         $y1Obj = new Zend_Pdf_Element_Numeric($bottomRightY + $radius[2]);
         $this->_contents .= $x1Obj->toString() . ' ' . $y1Obj->toString() . " l\n";
 
         //draw bottom right corner if needed
         if ($radius[2] != 0) {
             $x1Obj = new Zend_Pdf_Element_Numeric($bottomRightX);
             $y1Obj = new Zend_Pdf_Element_Numeric($bottomRightY);
             $x2Obj = new Zend_Pdf_Element_Numeric($bottomRightX);
             $y2Obj = new Zend_Pdf_Element_Numeric($bottomRightY);
             $x3Obj = new Zend_Pdf_Element_Numeric($bottomRightX - $radius[2]);
             $y3Obj = new Zend_Pdf_Element_Numeric($bottomRightY);
             $this->_contents .= $x1Obj->toString() . ' ' . $y1Obj->toString() . ' '
                               . $x2Obj->toString() . ' ' . $y2Obj->toString() . ' '
                               . $x3Obj->toString() . ' ' . $y3Obj->toString() . ' '
                               . " c\n";
         }
 
         //draw bottom side
         $x1Obj = new Zend_Pdf_Element_Numeric($bottomLeftX + $radius[3]);
         $y1Obj = new Zend_Pdf_Element_Numeric($bottomLeftY);
         $this->_contents .= $x1Obj->toString() . ' ' . $y1Obj->toString() . " l\n";
 
         //draw bottom left corner if needed
         if ($radius[3] != 0) {
             $x1Obj = new Zend_Pdf_Element_Numeric($bottomLeftX);
             $y1Obj = new Zend_Pdf_Element_Numeric($bottomLeftY);
             $x2Obj = new Zend_Pdf_Element_Numeric($bottomLeftX);
             $y2Obj = new Zend_Pdf_Element_Numeric($bottomLeftY);
             $x3Obj = new Zend_Pdf_Element_Numeric($bottomLeftX);
             $y3Obj = new Zend_Pdf_Element_Numeric($bottomLeftY + $radius[3]);
             $this->_contents .= $x1Obj->toString() . ' ' . $y1Obj->toString() . ' '
                               . $x2Obj->toString() . ' ' . $y2Obj->toString() . ' '
                               . $x3Obj->toString() . ' ' . $y3Obj->toString() . ' '
                               . " c\n";
         }
 
         //draw left side
         $x1Obj = new Zend_Pdf_Element_Numeric($topLeftX);
         $y1Obj = new Zend_Pdf_Element_Numeric($topLeftY - $radius[0]);
         $this->_contents .= $x1Obj->toString() . ' ' . $y1Obj->toString() . " l\n";
 
         //draw top left corner if needed
         if ($radius[0] != 0) {
             $x1Obj = new Zend_Pdf_Element_Numeric($topLeftX);
             $y1Obj = new Zend_Pdf_Element_Numeric($topLeftY);
             $x2Obj = new Zend_Pdf_Element_Numeric($topLeftX);
             $y2Obj = new Zend_Pdf_Element_Numeric($topLeftY);
             $x3Obj = new Zend_Pdf_Element_Numeric($topLeftX + $radius[0]);
             $y3Obj = new Zend_Pdf_Element_Numeric($topLeftY);
             $this->_contents .= $x1Obj->toString() . ' ' . $y1Obj->toString() . ' '
                               . $x2Obj->toString() . ' ' . $y2Obj->toString() . ' '
                               . $x3Obj->toString() . ' ' . $y3Obj->toString() . ' '
                               . " c\n";
         }
 
         switch ($fillType) {
             case Zend_Pdf_Page::SHAPE_DRAW_FILL_AND_STROKE:
                 $this->_contents .= " B*\n";
                 break;
             case Zend_Pdf_Page::SHAPE_DRAW_FILL:
                 $this->_contents .= " f*\n";
                 break;
             case Zend_Pdf_Page::SHAPE_DRAW_STROKE:
                 $this->_contents .= " S\n";
                 break;
         }
 
         return $this;
     }

◆ drawText()

drawText	(	$text,
		$x,
		$y,
		$charEncoding = `''`
	)

Draw a line of text at the specified position.

Parameters

string	$text
float	$x
float	$y
string	$charEncoding	(optional) Character encoding of source text. Defaults to current locale.

Exceptions

Zend_Pdf_Exception

Returns: Zend_Pdf_Canvas_Interface

Implements Zend_Pdf_Canvas_Interface.

Definition at line 1039 of file Abstract.php.

     {
         if ($this->_font === null) {
             #require_once 'Zend/Pdf/Exception.php';
             throw new Zend_Pdf_Exception('Font has not been set');
         }
 
         $this->_addProcSet('Text');
 
         $textObj = new Zend_Pdf_Element_String($this->_font->encodeString($text, $charEncoding));
         $xObj    = new Zend_Pdf_Element_Numeric($x);
         $yObj    = new Zend_Pdf_Element_Numeric($y);
 
         $this->_contents .= "BT\n"
                          .  $xObj->toString() . ' ' . $yObj->toString() . " Td\n"
                          .  $textObj->toString() . " Tj\n"
                          .  "ET\n";
 
         return $this;
     }

◆ getFont()

getFont ( )

Get current font.

Returns: Zend_Pdf_Resource_Font $font

Implements Zend_Pdf_Canvas_Interface.

Definition at line 289 of file Abstract.php.

     {
         return $this->_font;
     }

◆ getFontSize()

getFontSize ( )

Get current font size

Returns: float $fontSize

Implements Zend_Pdf_Canvas_Interface.

Definition at line 299 of file Abstract.php.

     {
         return $this->_fontSize;
     }

◆ getStyle()

getStyle ( )

Return the style, applied to the page.

Returns: Zend_Pdf_Style

Implements Zend_Pdf_Canvas_Interface.

Definition at line 309 of file Abstract.php.

     {
         return $this->_style;
     }

◆ pathClose()

pathClose ( )

Close the path by drawing a straight line back to it's beginning.

Todo:: implementation

Implements Zend_Pdf_Canvas_Interface.

Definition at line 1068 of file Abstract.php.

     {
         return $this;
     }

◆ pathLine()

pathLine	(	$x,
		$y
	)

Continue the open path in a straight line to the specified position.

Todo:: implementation

Implements Zend_Pdf_Canvas_Interface.

Definition at line 1083 of file Abstract.php.

     {
         return $this;
     }

◆ pathMove()

pathMove	(	$x,
		$y
	)

Start a new path at the specified position. If a path has already been started, move the cursor without drawing a line.

Todo:: implementation

Implements Zend_Pdf_Canvas_Interface.

Definition at line 1099 of file Abstract.php.

     {
         return $this;
     }

◆ rawWrite()

rawWrite	(	$data,
		$procSet = `null`
	)

Writes the raw data to the page's content stream.

Be sure to consult the PDF reference to ensure your syntax is correct. No attempt is made to ensure the validity of the stream data.

Parameters

string	$data
string	$procSet	(optional) Name of ProcSet to add.

Returns: Zend_Pdf_Canvas_Interface

Implements Zend_Pdf_Canvas_Interface.

Definition at line 1208 of file Abstract.php.

     {
         if (! empty($procSet)) {
             $this->_addProcSet($procSet);
         }
         $this->_contents .= $data;
 
         return $this;
     }

◆ restoreGS()

restoreGS ( )

Restore the graphics state that was saved with the last call to saveGS().

Exceptions

Zend_Pdf_Exception - if there is no previously saved state

Returns: Zend_Pdf_Canvas_Interface

Definition at line 339 of file Abstract.php.

     {
         if ($this->_saveCount-- <= 0) {
             #require_once 'Zend/Pdf/Exception.php';
             throw new Zend_Pdf_Exception('Restoring graphics state which is not saved');
         }
         $this->_contents .= " Q\n";
 
         return $this;
     }

◆ rotate()

rotate	(	$x,
		$y,
		$angle
	)

Rotate the page.

Parameters

float	$x	- the X co-ordinate of rotation point
float	$y	- the Y co-ordinate of rotation point
float	$angle	- rotation angle

Returns: Zend_Pdf_Canvas_Interface

Implements Zend_Pdf_Canvas_Interface.

Definition at line 1113 of file Abstract.php.

     {
         $cos  = new Zend_Pdf_Element_Numeric(cos($angle));
         $sin  = new Zend_Pdf_Element_Numeric(sin($angle));
         $mSin = new Zend_Pdf_Element_Numeric(-$sin->value);
 
         $xObj = new Zend_Pdf_Element_Numeric($x);
         $yObj = new Zend_Pdf_Element_Numeric($y);
 
         $mXObj = new Zend_Pdf_Element_Numeric(-$x);
         $mYObj = new Zend_Pdf_Element_Numeric(-$y);
 
 
         $this->_addProcSet('PDF');
         $this->_contents .= '1 0 0 1 ' . $xObj->toString() . ' ' . $yObj->toString() . " cm\n"
                          .  $cos->toString() . ' ' . $sin->toString() . ' ' . $mSin->toString() . ' ' . $cos->toString() . " 0 0 cm\n"
                          .  '1 0 0 1 ' . $mXObj->toString() . ' ' . $mYObj->toString() . " cm\n";
 
         return $this;
     }

◆ saveGS()

saveGS ( )

Save the graphics state of this page. This takes a snapshot of the currently applied style, position, clipping area and any rotation/translation/scaling that has been applied.

Todo:: check for the open paths

Exceptions

Zend_Pdf_Exception - if a save is performed with an open path

Returns: Zend_Pdf_Canvas_Interface

Implements Zend_Pdf_Canvas_Interface.

Definition at line 323 of file Abstract.php.

     {
         $this->_saveCount++;
 
         $this->_addProcSet('PDF');
         $this->_contents .= " q\n";
 
         return $this;
     }

◆ scale()

scale	(	$xScale,
		$yScale
	)

Scale coordination system.

Parameters

float	$xScale	- X dimention scale factor
float	$yScale	- Y dimention scale factor

Returns: Zend_Pdf_Canvas_Interface

Implements Zend_Pdf_Canvas_Interface.

Definition at line 1141 of file Abstract.php.

     {
         $xScaleObj = new Zend_Pdf_Element_Numeric($xScale);
         $yScaleObj = new Zend_Pdf_Element_Numeric($yScale);
 
         $this->_addProcSet('PDF');
         $this->_contents .= $xScaleObj->toString() . ' 0 0 ' . $yScaleObj->toString() . " 0 0 cm\n";
 
         return $this;
     }

◆ setAlpha()

setAlpha	(	$alpha,
		$mode = `'Normal'`
	)

Set the transparancy

$alpha == 0 - transparent $alpha == 1 - opaque

Transparency modes, supported by PDF: Normal (default), Multiply, Screen, Overlay, Darken, Lighten, ColorDodge, ColorBurn, HardLight, SoftLight, Difference, Exclusion

Parameters

float	$alpha
string	$mode

Returns: Zend_Pdf_Canvas_Interface

Implements Zend_Pdf_Canvas_Interface.

Definition at line 364 of file Abstract.php.

     {
         $this->_addProcSet('Text');
         $this->_addProcSet('PDF');
 
         $graphicsState = new Zend_Pdf_Resource_GraphicsState();
 
         $graphicsState->setAlpha($alpha, $mode);
         $gStateName = $this->_attachResource('ExtGState', $graphicsState);
 
         $gStateNameObject = new Zend_Pdf_Element_Name($gStateName);
         $this->_contents .= $gStateNameObject->toString() . " gs\n";
 
         return $this;
     }

◆ setFillColor()

setFillColor ( Zend_Pdf_Color $color )

Set fill color.

Parameters

Zend_Pdf_Color $color

Returns: Zend_Pdf_Canvas_Interface

Implements Zend_Pdf_Canvas_Interface.

Definition at line 170 of file Abstract.php.

     {
         $this->_addProcSet('PDF');
         $this->_contents .= $color->instructions(false);
 
         return $this;
     }

◆ setFont()

setFont	(	Zend_Pdf_Resource_Font	$font,
			$fontSize
	)

Set current font.

Parameters

Zend_Pdf_Resource_Font	$font
float	$fontSize

Returns: Zend_Pdf_Canvas_Interface

Implements Zend_Pdf_Canvas_Interface.

Definition at line 249 of file Abstract.php.

     {
         $this->_addProcSet('Text');
         $fontName = $this->_attachResource('Font', $font);
 
         $this->_font     = $font;
         $this->_fontSize = $fontSize;
 
         $fontNameObj = new Zend_Pdf_Element_Name($fontName);
         $fontSizeObj = new Zend_Pdf_Element_Numeric($fontSize);
         $this->_contents .= $fontNameObj->toString() . ' ' . $fontSizeObj->toString() . " Tf\n";
 
         return $this;
     }

◆ setLineColor()

setLineColor ( Zend_Pdf_Color $color )

Set line color.

Parameters

Zend_Pdf_Color $color

Returns: Zend_Pdf_Canvas_Interface

Implements Zend_Pdf_Canvas_Interface.

Definition at line 184 of file Abstract.php.

     {
         $this->_addProcSet('PDF');
         $this->_contents .= $color->instructions(true);
 
         return $this;
     }

◆ setLineDashingPattern()

setLineDashingPattern	(	$pattern,
		$phase = `0`
	)

Set line dashing pattern

Pattern is an array of floats: array(on_length, off_length, on_length, off_length, ...) or Zend_Pdf_Page::LINE_DASHING_SOLID constant Phase is shift from the beginning of line.

Parameters

mixed	$pattern
array	$phase

Returns: Zend_Pdf_Canvas_Interface

Implements Zend_Pdf_Canvas_Interface.

Definition at line 218 of file Abstract.php.

     {
         $this->_addProcSet('PDF');
 
         #require_once 'Zend/Pdf/Page.php';
         if ($pattern === Zend_Pdf_Page::LINE_DASHING_SOLID) {
             $pattern = array();
             $phase   = 0;
         }
 
         $dashPattern  = new Zend_Pdf_Element_Array();
         $phaseEleemnt = new Zend_Pdf_Element_Numeric($phase);
 
         foreach ($pattern as $dashItem) {
             $dashElement = new Zend_Pdf_Element_Numeric($dashItem);
             $dashPattern->items[] = $dashElement;
         }
 
         $this->_contents .= $dashPattern->toString() . ' '
                          . $phaseEleemnt->toString() . " d\n";
 
         return $this;
     }

◆ setLineWidth()

setLineWidth ( $width )

Set line width.

Parameters

float $width

Returns: Zend_Pdf_Canvas_Interface

Implements Zend_Pdf_Canvas_Interface.

Definition at line 198 of file Abstract.php.

     {
         $this->_addProcSet('PDF');
         $widthObj = new Zend_Pdf_Element_Numeric($width);
         $this->_contents .= $widthObj->toString() . " w\n";
 
         return $this;
     }

◆ setStyle()

setStyle ( Zend_Pdf_Style $style )

Set the style to use for future drawing operations on this page

Parameters

Zend_Pdf_Style $style

Returns: Zend_Pdf_Canvas_Interface

Implements Zend_Pdf_Canvas_Interface.

Definition at line 270 of file Abstract.php.

     {
         $this->_addProcSet('Text');
         $this->_addProcSet('PDF');
         if ($style->getFont() !== null) {
             $this->setFont($style->getFont(), $style->getFontSize());
         }
         $this->_contents .= $style->instructions($this->_dictionary->Resources);
 
         $this->_style = $style;
 
         return $this;
     }

◆ skew()

skew	(	$x,
		$y,
		$xAngle,
		$yAngle
	)

Translate coordination system.

Parameters

float	$x	- the X co-ordinate of axis skew point
float	$y	- the Y co-ordinate of axis skew point
float	$xAngle	- X axis skew angle
float	$yAngle	- Y axis skew angle

Returns: Zend_Pdf_Canvas_Interface

Implements Zend_Pdf_Canvas_Interface.

Definition at line 1179 of file Abstract.php.

     {
         $tanXObj = new Zend_Pdf_Element_Numeric(tan($xAngle));
         $tanYObj = new Zend_Pdf_Element_Numeric(-tan($yAngle));
 
         $xObj = new Zend_Pdf_Element_Numeric($x);
         $yObj = new Zend_Pdf_Element_Numeric($y);
 
         $mXObj = new Zend_Pdf_Element_Numeric(-$x);
         $mYObj = new Zend_Pdf_Element_Numeric(-$y);
 
         $this->_addProcSet('PDF');
         $this->_contents .= '1 0 0 1 ' . $xObj->toString() . ' ' . $yObj->toString() . " cm\n"
                          .  '1 ' . $tanXObj->toString() . ' ' . $tanYObj->toString() . " 1 0 0 cm\n"
                          .  '1 0 0 1 ' . $mXObj->toString() . ' ' . $mYObj->toString() . " cm\n";
 
         return $this;
     }

◆ translate()

translate	(	$xShift,
		$yShift
	)

Translate coordination system.

Parameters

float	$xShift	- X coordinate shift
float	$yShift	- Y coordinate shift

Returns: Zend_Pdf_Canvas_Interface

Implements Zend_Pdf_Canvas_Interface.

Definition at line 1159 of file Abstract.php.

     {
         $xShiftObj = new Zend_Pdf_Element_Numeric($xShift);
         $yShiftObj = new Zend_Pdf_Element_Numeric($yShift);
 
         $this->_addProcSet('PDF');
         $this->_contents .= '1 0 0 1 ' . $xShiftObj->toString() . ' ' . $yShiftObj->toString() . " cm\n";
 
         return $this;
     }

Field Documentation

◆ $_contents

$_contents = ''

protected

Definition at line 54 of file Abstract.php.

◆ $_font

$_font = null

protected

Definition at line 61 of file Abstract.php.

◆ $_fontSize

$_fontSize

protected

Definition at line 68 of file Abstract.php.

◆ $_saveCount

$_saveCount = 0

protected

Definition at line 83 of file Abstract.php.

◆ $_style

$_style = null

protected

Definition at line 75 of file Abstract.php.

The documentation for this class was generated from the following file:

vendor/magento/zendframework1/library/Zend/Pdf/Canvas/Abstract.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ _addProcSet()

◆ _attachResource()

◆ clipCircle()

◆ clipEllipse()

◆ clipPolygon()

◆ clipRectangle()

◆ drawCanvas()

◆ drawCircle()

◆ drawEllipse()

◆ drawImage()

◆ drawLayoutBox()

◆ drawLine()

◆ drawPolygon()

◆ drawRectangle()

◆ drawRoundedRectangle()

◆ drawText()

◆ getFont()

◆ getFontSize()

◆ getStyle()

◆ pathClose()

◆ pathLine()

◆ pathMove()

◆ rawWrite()

◆ restoreGS()

◆ rotate()

◆ saveGS()

◆ scale()

◆ setAlpha()

◆ setFillColor()

◆ setFont()

◆ setLineColor()

◆ setLineDashingPattern()

◆ setLineWidth()

◆ setStyle()

◆ skew()

◆ translate()

Field Documentation

◆ $_contents

◆ $_font

◆ $_fontSize

◆ $_saveCount

◆ $_style