Class: AbbreviationHandler

Source Location: /_includes/lib_abbreviations.php

Class Overview

A class for handling abbreviations that are entered into the site's abbrevation database. This class should be concidered singelton and should only be used using the one and only globally defined instance. Implements the singleton pattern.

Author(s):

Andreas Launila

Variables

Methods

Class Details

[line 28]
A class for handling abbreviations that are entered into the site's abbrevation database. This class should be concidered singelton and should only be used using the one and only globally defined instance. Implements the singleton pattern.

Tags:

author:

Andreas Launila

[ Top ]

Class Variables

$abbrMap =

[line 34]

An array where they keys are abbreviations and the corresponding values are the meanings of those keys.

Tags:

access:

private

Type:

array

[ Top ]

$instance =

[line 39]

The one and only instance of the class.

Tags:

access:	private
static:

Type:

AbbreviationHandler

[ Top ]

Class Methods

constructor __construct [line 55]

AbbreviationHandler __construct(
)

Constructor for AbbreviationHandler.

Tags:

access:

private

[ Top ]

method formatAbbreviation [line 88]

string formatAbbreviation(
string
$abbreviated, string
$expanded)

Formats an abbreviation into XHTML compliant code.

Tags:

return:	XHTML compliant code that represents the abbreviation explaination.
access:	public

Parameters:

string	$abbreviated	The abbreviated form.
string	$expanded	The expanded form of the abbreviation.

[ Top ]

method getInstance [line 45]

CssTemplateConverter getInstance(
)

Gets the one and only instance of the class.

Tags:

return:	The one and only instance.
access:	public
static:

[ Top ]

method handleAbbreviations [line 73]

string handleAbbreviations(
string
$text)

Handles all abbreviations in a text by appending XHTML compliant explainations to each recognised abbreviation.

Tags:

return:	XHTML compliant code with all recognised abbriviations explained.
access:	public

Parameters:

string

$text

The text in which all abbrevaitions should be handled.

[ Top ]

Documentation generated on Sun, 16 Apr 2006 21:03:04 +0200 by phpDocumentor 1.3.0RC4