Class Textformatter

ProcessWire Textformatter

Provides the base class for Textformatting Modules

ProcessWire 2.x Copyright (C) 2010 by Ryan Cramer Licensed under GNU/GPL v2, see LICENSE.TXT

http://www.processwire.com http://www.ryancramer.com

Wire implements TrackChanges

Extended by

Textformatter implements Module

Abstract
Located at core/Textformatter.php

Methods summary
`public static array`	# `getModuleInfo( )` Return an array of module information Return an array of module information Array is associative with the following fields: title: An alternate title, if you don't want to use the class name. version: an integer that indicates the version number, 101 = 1.0.1 summary: a summary of the module (1 paragraph max) Returns `array` Implementation of `Module::getModuleInfo`
`public`	# `formatValue( Page $page, Field $field, & $value )` Format the given text string. Format the given text string. Newer version with Page and Field provided. Override this function completely when providing your own text formatter. No need to call the parent. Parameters `$page` `string` $str `$field` `$value`
`public`	# `init( )` Optional method to initialize the module. Optional method to initialize the module. This is called after ProcessWire's API is fully ready for use and hooks Implementation of `Module::init`
`public`	# `___install( )` Perform any installation procedures specific to this module, if needed. Perform any installation procedures specific to this module, if needed.
`public`	# `___uninstall( )` Perform any uninstall procedures specific to this module, if needed. Perform any uninstall procedures specific to this module, if needed.
`public`	# `isSingular( )` Only one instatance of a textformatter is loaded at runtime Only one instatance of a textformatter is loaded at runtime
`public`	# `isAutoload( )` Textformatters are not autoload, in that they don't load until requested by the api. Textformatters are not autoload, in that they don't load until requested by the api.

Methods inherited from Wire
`_(), ___changed(), __call(), __get(), __toString(), _n(), _x(), addHook(), addHookAfter(), addHookBefore(), addHookProperty(), className(), error(), fuel(), getAllFuel(), getChanges(), getFuel(), getHooks(), isChanged(), isHooked(), message(), removeHook(), resetTrackChanges(), runHooks(), setFuel(), setTrackChanges(), trackChange(), trackChanges(), untrackChange(), useFuel()`

Properties inherited from Wire
`$changes, $defaultHookOptions, $fuel, $hookMethodCache, $localHooks, $staticHooks, $trackChanges, $useFuel`