Text_TeXHyphen
[ class tree: Text_TeXHyphen ] [ index: Text_TeXHyphen ] [ all elements ]

Class: Text_TeXHyphen_PatternDB

Source Location: /Text_TeXHyphen-0.1.0/Text/TeXHyphen/PatternDB.php

Class Overview


The abstract of the pattern database class for the TeX hyphenation algorithm.


Author(s):

Version:

  • $Id$

Methods


Child classes:

Text_TeXHyphen_PatternDB_ObjectHash
A Text_TeXHyphen_Pattern object hash class for the TeX hyphenation algorithm.

Inherited Variables

Inherited Methods


Class Details

[line 44]
The abstract of the pattern database class for the TeX hyphenation algorithm.


[ Top ]


Method Detail

Text_TeXHyphen_PatternDB (Constructor)   [line 76]

Text_TeXHyphen_PatternDB Text_TeXHyphen_PatternDB( )

Constructor of a Text_TeXHyphen_PatternDB object.

At contruction of a Text_TeXHyphen_PatternDB object the error stack will referenced to the 'Text_TeXHyphen' error stack.

  • Access: public

[ Top ]

factory   [line 93]

Text_TeXHyphen_PatternDB|false &factory( string $type, [array $options = array()])

Factory for creating a pattern database.
  • Return: Reference to an object of type Text_TeXHyphen_PatternDB or a subclass of it, if successful or false on error.
  • Access: public

Overridden in child classes as:

Text_TeXHyphen_PatternDB_ObjectHash::factory()
Factory for creating a Text_TeXHyphen_Pattern object hash as pattern database.

Parameters:

string   $type   —  Name of the pattern database implementation.
array   $options   —  Options for pattern database implementation.

[ Top ]

getPattern   [line 132]

Text_TeXHyphen_Pattern|false &getPattern( string $key)

Gets the Text_TeXHyphen_Pattern object specified by the $key, if it exists in the pattern database.
  • Return: Reference to a Text_TeXHyphen_Pattern object if successful or false if the pattern isn't found.
  • See: Text_TeXHyphen_Pattern
  • Access: public

Overridden in child classes as:

Text_TeXHyphen_PatternDB_ObjectHash::getPattern()
Gets the Text_TeXHyphen_Pattern object specified by the $key, if it exists in the pattern database.

Parameters:

string   $key   —  Key by which the pattern should be identified.

[ Top ]


Documentation generated on Mon, 11 Mar 2019 13:51:35 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.