API Documentation

Pdf/Cmap/ByteEncoding.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Pdf
subpackage
Fonts
version
$Id: ByteEncoding.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Pdf_Cmap_ByteEncoding

Description

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.

Zend_Pdf_Cmap_ByteEncoding
jump to top

Extends from
Zend_Pdf_Cmap
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Pdf
subpackage
Fonts
Properties
$_glyphIndexArray
Methods
glyphNumbersForCharacters
glyphNumberForCharacter
getCoveredCharacters
getCoveredCharactersGlyphs
__construct

Description

Implements the "byte encoding" character map (type 0).

This is the (legacy) Apple standard encoding mechanism and provides coverage for characters in the Mac Roman character set only. Consequently, this cmap type should be used only as a last resort.

The mapping from Mac Roman to Unicode can be found at {@link http://www.unicode.org/Public/MAPPINGS/VENDORS/APPLE/ROMAN.TXT}.

Properties

$_glyphIndexArray
jump to class

array $_glyphIndexArray = 'array'

Glyph index array. Stores the actual glyph numbers. The array keys are the translated Unicode code points.

Details

$_glyphIndexArray
array
visibility
protected
default
array
final
false
static
false

Methods

__construct
jump to class

__construct( string $cmapData ) :

Object constructor

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

Arguments
$cmapData
string
Raw binary cmap table data.
Details
visibility
public
final
false
static
false
throws

getCoveredCharacters
jump to class

getCoveredCharacters( ) : array

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

Output
array
Unicode character codes.
Details
visibility
public
final
false
static
false

getCoveredCharactersGlyphs
jump to class

getCoveredCharactersGlyphs( ) : array

Returns an array containing the glyphs numbers that have entries in this character map.

Keys are Unicode character codes (integers)

This functionality is partially covered by glyphNumbersForCharacters(getCoveredCharacters()) call, but this method do it in more effective way (prepare complete list instead of searching glyph for each character code).

Output
array
Array representing <Unicode character code> => <glyph number> pairs.
Details
visibility
public
final
false
static
false
internal

glyphNumberForCharacter
jump to class

glyphNumberForCharacter( 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 {@link glyphNumbersForCharacters()} which is optimized for bulk operations.

Arguments
$characterCode
integer
Unicode character code (code point).
Output
integer
Glyph number.
Details
visibility
public
final
false
static
false

glyphNumbersForCharacters
jump to class

glyphNumbersForCharacters( 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 {@link glyphNumberForCharacter()}.

Arguments
$characterCodes
array
Array of Unicode character codes (code points).
Output
array
Array of glyph numbers.
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.