Pdf/Cmap/SegmentToDelta.php

Show: PublicProtectedPrivateinherited
Table of Contents
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.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Pdf  
Subpackage
Fonts  
Version
$Id: SegmentToDelta.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Pdf_Cmap_SegmentToDelta

Package: Zend\Pdf\Fonts
Implements the "segment mapping to delta values" character map (type 4).

This is the Microsoft standard mapping table type for OpenType fonts. It provides the ability to cover multiple contiguous ranges of the Unicode character set, with the exception of Unicode Surrogates (U+D800 - U+DFFF).

Parent(s)
\Zend_Pdf_Cmap
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

>VConstant  TYPE_BYTE_ENCODING = 0
inherited
Byte Encoding character map table type.
Inherited from: \Zend_Pdf_Cmap::TYPE_BYTE_ENCODING
>VConstant  TYPE_HIGH_BYTE_MAPPING = 2
inherited
High Byte Mapping character map table type.
Inherited from: \Zend_Pdf_Cmap::TYPE_HIGH_BYTE_MAPPING
>VConstant  TYPE_SEGMENT_TO_DELTA = 4
inherited
Segment Value to Delta Mapping character map table type.
Inherited from: \Zend_Pdf_Cmap::TYPE_SEGMENT_TO_DELTA
>VConstant  TYPE_TRIMMED_TABLE = 6
inherited
Trimmed Table character map table type.
Inherited from: \Zend_Pdf_Cmap::TYPE_TRIMMED_TABLE
>VConstant  TYPE_MIXED_COVERAGE = 8
inherited
Mixed Coverage character map table type.
Inherited from: \Zend_Pdf_Cmap::TYPE_MIXED_COVERAGE
>VConstant  TYPE_TRIMMED_ARRAY = 10
inherited
Trimmed Array character map table type.
Inherited from: \Zend_Pdf_Cmap::TYPE_TRIMMED_ARRAY
>VConstant  TYPE_SEGMENTED_COVERAGE = 12
inherited
Segmented Coverage character map table type.
Inherited from: \Zend_Pdf_Cmap::TYPE_SEGMENTED_COVERAGE
>VConstant  TYPE_BYTE_ENCODING_STATIC = 241
inherited
Static Byte Encoding character map table type.
Inherited from: \Zend_Pdf_Cmap::TYPE_BYTE_ENCODING_STATIC
>VConstant  TYPE_UNKNOWN = 255
inherited
Unknown character map table type.
Inherited from: \Zend_Pdf_Cmap::TYPE_UNKNOWN
>VConstant  MISSING_CHARACTER_GLYPH = 0
inherited
Glyph representing missing characters.
Inherited from: \Zend_Pdf_Cmap::MISSING_CHARACTER_GLYPH

Properties

>VPropertyprotectedarray $_glyphIndexArray = array()
Glyph index array.

Stores glyph numbers, used with range offset.

Default valuearray()Details
Type
array
>VPropertyprotectedinteger $_searchIterations = 0
The number of binary search steps required to cover the entire search range.
Default value0Details
Type
integer
>VPropertyprotectedinteger $_searchRange = 0
The size of the binary search range for segments.
Default value0Details
Type
integer
>VPropertyprotectedinteger $_searchRangeEndCode = 0
The ending character code for the segment at the end of the low search range.
Default value0Details
Type
integer
>VPropertyprotectedinteger $_segmentCount = 0
The number of segments in the table.
Default value0Details
Type
integer
>VPropertyprotectedarray $_segmentTableEndCodes = array()
Array of ending character codes for each segment.
Default valuearray()Details
Type
array
>VPropertyprotectedarray $_segmentTableIdDeltas = array()
Array of character code to glyph delta values for each segment.
Default valuearray()Details
Type
array
>VPropertyprotectedarray $_segmentTableIdRangeOffsets = array()
Array of offsets into the glyph index array for each segment.
Default valuearray()Details
Type
array
>VPropertyprotectedarray $_segmentTableStartCodes = array()
Array of starting character codes for each segment.
Default valuearray()Details
Type
array

Methods

methodpublic__construct(string $cmapData) : void

Object constructor

Parses the raw binary table data. Throws an exception if the table is malformed.

Parameters
NameTypeDescription
$cmapDatastring

Raw binary cmap table data.

Throws
ExceptionDescription
\Zend_Pdf_Exception
methodprotected_extractInt2(string $data, integer $index) : integer
inherited

Extracts a signed 2-byte integer from a string.

Inherited from: \Zend_Pdf_Cmap::_extractInt2()

Integers are always big-endian. Throws an exception if the index is out of range.

Parameters
NameTypeDescription
$datastring

&$data

$indexinteger

Position in string of integer.

Returns
TypeDescription
integer
Throws
ExceptionDescription
\Zend_Pdf_Exception
methodprotected_extractUInt2(string $data, integer $index) : integer
inherited

Extracts an unsigned 2-byte integer from a string.

Inherited from: \Zend_Pdf_Cmap::_extractUInt2()

Integers are always big-endian. Throws an exception if the index is out of range.

Parameters
NameTypeDescription
$datastring

&$data

$indexinteger

Position in string of integer.

Returns
TypeDescription
integer
Throws
ExceptionDescription
\Zend_Pdf_Exception
methodprotected_extractUInt4(string $data, integer $index) : integer
inherited

Extracts an unsigned 4-byte integer from a string.

Inherited from: \Zend_Pdf_Cmap::_extractUInt4()

Integers are always big-endian. Throws an exception if the index is out of range.

NOTE: If you ask for a 4-byte unsigned integer on a 32-bit machine, the resulting value WILL BE SIGNED because PHP uses signed integers internally for everything. To guarantee portability, be sure to use bitwise or similar operators on large integers!

Parameters
NameTypeDescription
$datastring

&$data

$indexinteger

Position in string of integer.

Returns
TypeDescription
integer
Throws
ExceptionDescription
\Zend_Pdf_Exception
methodpubliccmapWithTypeData(integer $cmapType, mixed $cmapData) : \Zend_Pdf_Cmap
staticinherited

Instantiates the appropriate concrete subclass based on the type of cmap table and returns the instance.

Inherited from: \Zend_Pdf_Cmap::cmapWithTypeData()
Parameters
NameTypeDescription
$cmapTypeinteger

Type of cmap.

$cmapDatamixed

Cmap table data. Usually a string or array.

Returns
TypeDescription
\Zend_Pdf_Cmap
Throws
ExceptionDescription
\Zend_Pdf_Exception
methodpublicgetCoveredCharacters() : array

Returns an array containing the Unicode characters that have entries in this character map.

Returns
TypeDescription
arrayUnicode character codes.
methodpublicglyphNumberForCharacter(integer $characterCode) : integer

Returns the glyph number corresponding to the Unicode character.

If a particular character doesn't exist in this font, the special 'missing character glyph' will be substituted.

See also glyphNumbersForCharacters() which is optimized for bulk operations.

Parameters
NameTypeDescription
$characterCodeinteger

Unicode character code (code point).

Returns
TypeDescription
integerGlyph number.
methodpublicglyphNumbersForCharacters(array $characterCodes) : array

Returns an array of glyph numbers corresponding to the Unicode characters.

If a particular character doesn't exist in this font, the special 'missing character glyph' will be substituted.

See also glyphNumberForCharacter().

Parameters
NameTypeDescription
$characterCodesarray

Array of Unicode character codes (code points).

Returns
TypeDescription
arrayArray of glyph numbers.
Documentation was generated by phpDocumentor 2.0.0a12.