Zend_Pdf_Resource_GraphicsState Class Reference

Inheritance diagram for Zend_Pdf_Resource_GraphicsState:

Public Member Functions
	__construct (Zend_Pdf_Element_Object $extGStateObject=null)
	setAlpha ($alpha, $mode='Normal')
Public Member Functions inherited from Zend_Pdf_Resource
	__construct ($resource)
	__clone ()
	cloneResource ($factory, &$processed)
	getResource ()
	getFactory ()

Additional Inherited Members
Protected Attributes inherited from Zend_Pdf_Resource
	$_objectFactory
	$_resource

Detailed Description

Definition at line 45 of file GraphicsState.php.

Constructor & Destructor Documentation

__construct()

__construct

(

Zend_Pdf_Element_Object

$extGStateObject = null

)

Object constructor.

Parameters

Zend_Pdf_Element_Object

$extGStateObject

Exceptions

Zend_Pdf_Exception

Definition at line 53 of file GraphicsState.php.

    {
        if ($extGStateObject == null) {
            // Create new Graphics State object
            #require_once 'Zend/Pdf/ElementFactory.php';
            $factory = Zend_Pdf_ElementFactory::createFactory(1);

            $gsDictionary = new Zend_Pdf_Element_Dictionary();
            $gsDictionary->Type = new Zend_Pdf_Element_Name('ExtGState');

            $extGStateObject = $factory->newObject($gsDictionary);
        }

        if ($extGStateObject->getType() != Zend_Pdf_Element::TYPE_DICTIONARY) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Graphics state PDF object must be a dictionary');
        }

        parent::__construct($gsDictionary);
    }

Member Function Documentation

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

Exceptions

Zend_Pdf_Exception

Returns

Zend_Pdf_Canvas_Interface

Definition at line 89 of file GraphicsState.php.

    {
        if (!in_array($mode, array('Normal', 'Multiply', 'Screen', 'Overlay', 'Darken', 'Lighten', 'ColorDodge',
                                   'ColorBurn', 'HardLight', 'SoftLight', 'Difference', 'Exclusion'))) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Unsupported transparency mode.');
        }
        if (!is_numeric($alpha)  ||  $alpha < 0  ||  $alpha > 1) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Alpha value must be numeric between 0 (transparent) and 1 (opaque).');
        }

        $this->_resource->BM   = new Zend_Pdf_Element_Name($mode);
        $this->_resource->CA   = new Zend_Pdf_Element_Numeric($alpha);
        $this->_resource->ca   = new Zend_Pdf_Element_Numeric($alpha);
    }

---

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

• vendor/magento/zendframework1/library/Zend/Pdf/Resource/GraphicsState.php