Zend_Pdf_Element_Name Class Reference

Inheritance diagram for Zend_Pdf_Element_Name:

Public Member Functions
	__construct ($val)
	getType ()
	toString ($factory=null)
Public Member Functions inherited from Zend_Pdf_Element
	getType ()
	toString ($factory=null)
	makeClone (Zend_Pdf_ElementFactory $factory, array &$processed, $mode)
	setParentObject (Zend_Pdf_Element_Object $parent)
	getParentObject ()
	touch ()
	cleanUp ()
	toPhp ()

Static Public Member Functions
static	escape ($inStr)
static	unescape ($inStr)
Static Public Member Functions inherited from Zend_Pdf_Element
static	phpToPdf ($input)

Data Fields
	$value
Data Fields inherited from Zend_Pdf_Element
const	TYPE_BOOL = 1
const	TYPE_NUMERIC = 2
const	TYPE_STRING = 3
const	TYPE_NAME = 4
const	TYPE_ARRAY = 5
const	TYPE_DICTIONARY = 6
const	TYPE_STREAM = 7
const	TYPE_NULL = 11
const	CLONE_MODE_SKIP_PAGES = 1
const	CLONE_MODE_FORCE_CLONING = 2

Detailed Description

Definition at line 35 of file Name.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$val

)

Object constructor

Parameters

string

$val

Exceptions

Zend_Pdf_Exception

Definition at line 51 of file Name.php.

    {
        settype($val, 'string');
        if (strpos($val,"\x00") !== false) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Null character is not allowed in PDF Names');
        }
        $this->value   = (string)$val;
    }

Member Function Documentation

escape()

static escape (   $inStr )

static

Escape string according to the PDF rules

Parameters

string

$inStr

Returns

string

Definition at line 79 of file Name.php.

    {
        $outStr = '';

        for ($count = 0; $count < strlen($inStr); $count++) {
            $nextCode = ord($inStr[$count]);

            switch ($inStr[$count]) {
                case '(':
                // fall through to next case
                case ')':
                // fall through to next case
                case '<':
                // fall through to next case
                case '>':
                // fall through to next case
                case '[':
                // fall through to next case
                case ']':
                // fall through to next case
                case '{':
                // fall through to next case
                case '}':
                // fall through to next case
                case '/':
                // fall through to next case
                case '%':
                // fall through to next case
                case '\\':
                // fall through to next case
                case '#':
                    $outStr .= sprintf('#%02X', $nextCode);
                    break;

                default:
                    if ($nextCode >= 33 && $nextCode <= 126 ) {
                        // Visible ASCII symbol
                        $outStr .= $inStr[$count];
                    } else {
                        $outStr .= sprintf('#%02X', $nextCode);
                    }
            }

        }

        return $outStr;
    }

getType()

getType

(

)

Return type of the element.

Returns

integer

Definition at line 67 of file Name.php.

    {
        return Zend_Pdf_Element::TYPE_NAME;
    }

toString()

toString

(

$factory = null

)

Return object as string

Parameters

Zend_Pdf_Factory

$factory

Returns

string

Definition at line 157 of file Name.php.

    {
        return '/' . self::escape((string)$this->value);
    }

unescape()

static unescape (   $inStr )

static

Unescape string according to the PDF rules

Parameters

string

$inStr

Returns

string

Definition at line 134 of file Name.php.

    {
        $outStr = '';

        for ($count = 0; $count < strlen($inStr); $count++) {
            if ($inStr[$count] != '#' )  {
                $outStr .= $inStr[$count];
            } else {
                // Escape sequence
                $outStr .= chr(base_convert(substr($inStr, $count+1, 2), 16, 10 ));
                $count +=2;
            }
        }
        return $outStr;
    }

Field Documentation

$value

$value

Definition at line 42 of file Name.php.

---

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

• vendor/magento/zendframework1/library/Zend/Pdf/Element/Name.php