Gitee
\
Cilex
Provider
phpDocumentor
Command
Helper
Phar
Project
Compiler
Linker
Pass
Configuration
Merger
Annotation
Console
Input
Output
Descriptor
Builder
Reflector
Tags
Cache
Example
Exception
Filter
Interfaces
ProjectDescriptor
Tag
BaseTypes
Type
Validator
Event
Parser
Command
Project
Configuration
Event
Exception
Util
Partials
Exception
Plugin
Core
Descriptor
Validator
Constraints
Classes
Functions
Property
Functions
Transformer
Behaviour
Tag
Writer
Xml
Xslt
Graphs
Writer
LegacyNamespaceConverter
Tests
Scrybe
Command
Manual
Converter
Definition
Exception
Format
Exception
Metadata
TableOfContents
RestructuredText
Directives
Roles
Visitors
Template
Twig
Writer
Transformer
Behaviour
Command
Project
Template
Configuration
Transformations
Event
Exception
Router
Matcher
UrlGenerator
Standard
Template
Writer
Exception
Translator

\phpDocumentor\Transformer\EventPreXslWriterEvent

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.

Summary

Methods
Properties
Constants
__construct()
getSubject()
createInstance()
setElement()
getElement()
setProgress()
getProgress()
No public properties found
No constants found
No protected methods found
$subject
$element
$progress
N/A
No private methods found
No private properties found
N/A

Properties

$subject

$subject : object

Type

object — Represents an object that is the subject of this event

$element

$element : \DOMElement

Type

\DOMElement

$progress

$progress : array<mixed,integer>

Type

array<mixed,integer>

Methods

__construct()

__construct(object  $subject)

Initializes this event with the given subject.

Parameters

object $subject

getSubject()

getSubject() : object

Returns the object that is the subject of this event.

Returns

object

createInstance()

createInstance(object  $subject) : static

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

Used as convenience method for fluent interfaces.

Parameters

object $subject

Returns

static

getElement()

getElement() : \DOMElement

Returns the event that is currently being parsed.

Returns

\DOMElement

setProgress()

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

Sets a progress indication for this XSL Writer session.

Parameters

array<mixed,integer> $progress

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

Returns

\phpDocumentor\Transformer\Event\PreXslWriterEvent

getProgress()

getProgress() : array<mixed,integer>

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

Returns

array<mixed,integer>