PreXslWriterEvent

Extends \phpDocumentor\Event\EventAbstract

Event launched during the Xsl Transformation of an individual output file.

If the XSL Writer loops through a resultset then this event will be thrown for each result.

author

Mike van Riel [email protected]

copyright

2010-2012 Mike van Riel / Naenius (http://www.naenius.com)

license

http://www.opensource.org/licenses/mit-license.php MIT

package

Default

Methods

Initializes this event with the given subject.

__construct(object $subject) 
inherited

Arguments

$subject

object

Creates a new instance of a derived object and return that.

createInstance(object $subject) : static
inherited static

Used as convenience method for fluent interfaces.

Arguments

$subject

object

Response

static

Returns the event that is currently being parsed.

getElement() : \DOMElement

Response

\DOMElement

Returns the current step and tot number of steps as progress.

getProgress() : array<mixed,integer>
see \phpDocumentor\Transformer\Event\PreXslWriterEvent::setProgress()

for a complete description of this array.

Response

array<mixed,integer>

Returns the object that is the subject of this event.

getSubject() : object
inherited

Response

object

Sets the currently parsed element in this event.

setElement(\DOMElement $element) : \phpDocumentor\Transformer\Event\PreXslWriterEvent

Arguments

$element

\DOMElement

Response

\phpDocumentor\Transformer\Event\PreXslWriterEvent

Sets a progress indication for this XSL Writer session.

setProgress(array<mixed,integer> $progress) : \phpDocumentor\Transformer\Event\PreXslWriterEvent

Arguments

$progress

array<mixed,integer>

Array containing 2 integer values, the current step in the process and the total number of steps involved.

Response

\phpDocumentor\Transformer\Event\PreXslWriterEvent

Properties

element

element : \DOMElement
var

Type(s)

\DOMElement

progress

progress : array<mixed,integer>
var

Type(s)

array<mixed,integer>

Represents an object that is the subject of this event

subject : object
inherited
var

Represents an object that is the subject of this event

Type(s)

object