phpDocumentor
Back to top  

Search writer responsible for building the search index.

category phpDocumentor
package Transformer
subpackage Writers
author Mike van Riel
license MIT
link http://phpdoc.org

 Methods

Helper method to create the actual index.

createXmlIndex(DOMDocument $xml, string $target_path) : void

todo refactor this method to be smaller and less complex.

Parameters

$xml

\DOMDocument

Structure source use as basis for the transformation.

$target_path

string

The path where to generate the index.

Dispatches a logging request to log a debug message.

debug(string $message) : void
Inherited

inherited_from \phpDocumentor_Transformer_Abstract::debug()
inherited_from \phpDocumentor_Transformer_Writer_Abstract::debug()

Parameters

$message

string

The message to log.

Dispatches an event to the Event Dispatcher.

dispatch(string $name, \string[] $arguments) : mixed | null
Inherited

This method tries to dispatch an event; if no Event Dispatcher has been set than this method will explicitly not fail and return null. By not failing we make the Event Dispatcher optional and is it easier for people to re-use this component in their own application.

inherited_from \phpDocumentor_Transformer_Abstract::dispatch()
inherited_from \phpDocumentor_Transformer_Writer_Abstract::dispatch()

Parameters

$name

string

Name of the event to dispatch.

$arguments

\string[]

Arguments for this event.

Exceptions

\phpDocumentor_Parser_Exception if there is a dispatcher but it is not of type sfEventDispatcher

Returns

mixednull

Returns an instance of a writer and caches it; a single writer instance is capable of transforming multiple times.

getInstanceOf(string $writer) : \phpDocumentor_Transformer_Writer_Abstract
Inherited

inherited_from \phpDocumentor_Transformer_Writer_Abstract::getInstanceOf()

Parameters

$writer

string

Name of thr writer to get.

Returns

\phpDocumentor_Transformer_Writer_Abstract

Dispatches a logging request.

log(string $message, int $priority) : void
Inherited

inherited_from \phpDocumentor_Transformer_Abstract::log()
inherited_from \phpDocumentor_Transformer_Writer_Abstract::log()

Parameters

$message

string

The message to log.

$priority

int

The logging priority, the lower, the more important. Ranges from 1 to 7

Creates the search index at the artifact location.

transform(DOMDocument $structure, phpDocumentor_Transformer_Transformation $transformation) : void

Parameters

$structure

\DOMDocument

Structure source use as basis for the transformation.

$transformation

\phpDocumentor_Transformer_Transformation

Transformation that supplies the meta-data for this writer.

Checks whether the given classname is valid for use as writer.

isValidWriterClassname(string $class_name) : bool
Inherited

inherited_from \phpDocumentor_Transformer_Writer_Abstract::isValidWriterClassname()

Parameters

$class_name

string

Class name of the writer to check.

Returns

bool

 Properties

 

The event dispatcher object, may be null to not dispatch events.

$event_dispatcher : \sfEventDispatcher | null
Inherited

inherited_from \phpDocumentor_Transformer_Abstract::$$event_dispatcher
inherited_from \phpDocumentor_Transformer_Writer_Abstract::$$event_dispatcher