Zend_Pdf_Element_String Class Reference

Inheritance diagram for Zend_Pdf_Element_String:

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 ($str)
static	unescape ($str)
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 34 of file String.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$val

)

Object constructor

Parameters

string

$val

Definition at line 48 of file String.php.

    {
        $this->value   = (string)$val;
    }

Member Function Documentation

escape()

static escape (   $str )

static

Escape string according to the PDF rules

Parameters

string

$str

Returns

string

Definition at line 83 of file String.php.

    {
        $outEntries = array();

        foreach (str_split($str, 128) as $chunk) {
            // Collect sequence of unescaped characters
            $offset = strcspn($chunk, "\n\r\t\x08\x0C()\\");
            $chunkOut = substr($chunk, 0, $offset);

            while ($offset < strlen($chunk)) {
                $nextCode = ord($chunk[$offset++]);
                switch ($nextCode) {
                    // "\n" - line feed (LF)
                    case 10:
                        $chunkOut .= '\\n';
                        break;

                    // "\r" - carriage return (CR)
                    case 13:
                        $chunkOut .= '\\r';
                        break;

                    // "\t" - horizontal tab (HT)
                    case 9:
                        $chunkOut .= '\\t';
                        break;

                    // "\b" - backspace (BS)
                    case 8:
                        $chunkOut .= '\\b';
                        break;

                    // "\f" - form feed (FF)
                    case 12:
                        $chunkOut .= '\\f';
                        break;

                    // '(' - left paranthesis
                    case 40:
                        $chunkOut .= '\\(';
                        break;

                    // ')' - right paranthesis
                    case 41:
                        $chunkOut .= '\\)';
                        break;

                    // '\' - backslash
                    case 92:
                        $chunkOut .= '\\\\';
                        break;

                    default:
                        // This code is never executed extually
                        //
                        // Don't use non-ASCII characters escaping
                        // if ($nextCode >= 32 && $nextCode <= 126 ) {
                        //     // Visible ASCII symbol
                        //     $chunkEntries[] = chr($nextCode);
                        // } else {
                        //     $chunkEntries[] = sprintf('\\%03o', $nextCode);
                        // }

                        break;
                }

                // Collect sequence of unescaped characters
                $start = $offset;
                $offset += strcspn($chunk, "\n\r\t\x08\x0C()\\", $offset);
                $chunkOut .= substr($chunk, $start, $offset - $start);
            }

            $outEntries[] = $chunkOut;
        }

        return implode("\\\n", $outEntries);
    }

getType()

getType

(

)

Return type of the element.

Returns

integer

Definition at line 59 of file String.php.

    {
        return Zend_Pdf_Element::TYPE_STRING;
    }

toString()

toString

(

$factory = null

)

Return object as string

Parameters

Zend_Pdf_Factory

$factory

Returns

string

Definition at line 71 of file String.php.

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

unescape()

static unescape (   $str )

static

Unescape string according to the PDF rules

Parameters

string

$str

Returns

string

Definition at line 168 of file String.php.

    {
        $outEntries = array();

        $offset = 0;
        while ($offset < strlen($str)) {
            // Searche for the next escaped character/sequence
            $escapeCharOffset = strpos($str, '\\', $offset);
            if ($escapeCharOffset === false  ||  $escapeCharOffset == strlen($str) - 1) {
                // There are no escaped characters or '\' char has came at the end of string
                $outEntries[] = substr($str, $offset);
                break;
            } else {
                // Collect unescaped characters sequence
                $outEntries[] = substr($str, $offset, $escapeCharOffset - $offset);
                // Go to the escaped character
                $offset = $escapeCharOffset + 1;

                switch ($str[$offset]) {
                    // '\\n' - line feed (LF)
                    case 'n':
                        $outEntries[] = "\n";
                        break;

                    // '\\r' - carriage return (CR)
                    case 'r':
                        $outEntries[] = "\r";
                        break;

                    // '\\t' - horizontal tab (HT)
                    case 't':
                        $outEntries[] = "\t";
                        break;

                    // '\\b' - backspace (BS)
                    case 'b':
                        $outEntries[] = "\x08";
                        break;

                    // '\\f' - form feed (FF)
                    case 'f':
                        $outEntries[] = "\x0C";
                        break;

                    // '\\(' - left paranthesis
                    case '(':
                        $outEntries[] = '(';
                        break;

                    // '\\)' - right paranthesis
                    case ')':
                        $outEntries[] = ')';
                        break;

                    // '\\\\' - backslash
                    case '\\':
                        $outEntries[] = '\\';
                        break;

                    // "\\\n" or "\\\n\r"
                    case "\n":
                        // skip new line symbol
                        if ($str[$offset + 1] == "\r") {
                            $offset++;
                        }
                        break;

                    default:
                        if (strpos('0123456789', $str[$offset]) !== false) {
                            // Character in octal representation
                            // '\\xxx'
                            $nextCode = '0' . $str[$offset];

                            if (strpos('0123456789', $str[$offset + 1]) !== false) {
                                $nextCode .= $str[++$offset];

                                if (strpos('0123456789', $str[$offset + 1]) !== false) {
                                    $nextCode .= $str[++$offset];
                                }
                            }

                            $outEntries[] = chr(octdec($nextCode));
                        } else {
                            $outEntries[] = $str[$offset];
                        }
                        break;
                }

                $offset++;
            }
        }

        return implode($outEntries);
    }

Field Documentation

$value

$value

Definition at line 41 of file String.php.

---

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

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