A non-atomic fragment comprised of a wikitext string and a strip state. More...

Inheritance diagram for Wikimedia\Parsoid\Fragments\WikitextPFragment:

Collaboration diagram for Wikimedia\Parsoid\Fragments\WikitextPFragment:

Public Member Functions

isEmpty ()

Returns true if this fragment is empty.This enables optimizations if implemented, but returns false by default.

isAtomic ()

asDom (ParsoidExtensionAPI $extApi, bool $release=false)

Return the fragment as a (prepared and loaded) DOM DocumentFragment belonging to the Parsoid top-level document.If $release is true, then this PFragment will become invalid after this method returns.

Note: The default implementation of asDom() calls asHtmlString(). Subclassses must implement either asDom() or asHtmlString() to avoid infinite mutual recursion.

asMarkedWikitext (StripState $stripState)

This method returns a "wikitext string" in the legacy format.Wikitext constructs will be parsed in the result. Constructs which are not representable in wikitext will be replaced with strip markers, and you will get a strip state which maps those markers back to PFragment objects. When you (for example) compose two marked strings and then ask for the result asDom, the strip markers in the marked strings will first be conceptually replaced with the PFragment from the StripState, and then the resulting interleaved strings and fragments will be composed.

containsMarker ()

Returns true if this fragment contains some non-wikitext content.

split ()

Split this fragment at its strip markers and return an array which alternates between string items and PFragment items.

killMarkers ()

Return a version of this wikitext fragment with all strip markers removed.

markerSkipCallback (callable $callback)

Call a callback function on all regions of the given text that are wikitext content, replacing them with the return value of the callback.Non-wikitext content is skipped but included in their proper places.

Parameters

callable(string):string $callback

Returns: PFragment

trim ()

Trim leading and trailing whitespace from this fragment.

toJsonArray ()

Public Member Functions inherited from Wikimedia\Parsoid\Fragments\PFragment

isValid ()

As an optimization to avoid unnecessary copying, certain operations on fragments may be destructive or lead to aliasing.

getSrcOffsets ()

Return the region of the source document that corresponds to this fragment.

asHtmlString (ParsoidExtensionAPI $extApi)

Return the fragment as a string of HTML.

expand (ParsoidExtensionAPI $extApi, ?bool &$error=null)

Expand templates, extension tags, and parser functions in a fragment.

toRawText (ParsoidExtensionAPI $extApi)

Return the 'raw text' of this fragment.

Static Public Member Functions

static newFromWt (string $wikitext, ?DomSourceRange $srcOffsets)

Return a new WikitextPFragment consisting of the given fragment of wikitext, and an optional source string for it.

static newFromSplitWt (array $pieces, ?DomSourceRange $srcOffsets=null, bool $unsafeConcat=false)

Return a new WikitextPFragment consisting of the given array of pieces concatenated together.

static newFromLiteral (string $value, ?DomSourceRange $srcOffsets)

Returns a new WikitextPFragment from the given literal string and optional source offsets.

static castFromPFragment (PFragment $fragment)

Return a WikitextPFragment corresponding to the given PFragment.

static concat (PFragment ... $fragments)

Return a WikitextPFragment representing the concatenation of the given fragments, as wikitext.

static newFromJsonArray (array $json)

Exceptions

JsonException

static jsonClassHintFor (string $keyName)

Static Public Member Functions inherited from Wikimedia\Parsoid\Fragments\PFragment

static fromSplitWt (array $pieces, ?DomSourceRange $srcOffset=null)

Helper function to create a new fragment from a mixed array of strings and fragments.

static registerFragmentClass (string $className)

Register a fragment type with the JSON deserialization code.

static hint ()

Public Attributes
const	TYPE_HINT = 'wt'

Additional Inherited Members
Protected Member Functions inherited from Wikimedia\Parsoid\Fragments\PFragment
	__construct (?DomSourceRange $srcOffsets)

Static Protected Member Functions inherited from Wikimedia\Parsoid\Fragments\PFragment
static	joinSourceRange (?DomSourceRange $first, ?DomSourceRange $second)
	Helper function to append two source ranges.

Protected Attributes inherited from Wikimedia\Parsoid\Fragments\PFragment
DomSourceRange	$srcOffsets
	The original wikitext source range for this fragment, or `null` for synthetic content that corresponds to no part of the original authored text.

Static Protected Attributes inherited from Wikimedia\Parsoid\Fragments\PFragment
static array	$FRAGMENT_TYPES

Detailed Description

A non-atomic fragment comprised of a wikitext string and a strip state.

The wikitext string may contain strip markers, which are placeholders corresponding to other atomic fragments. The internal StripState holds the mapping between placeholders and the corresponding atomic fragments.

WikitextPFragments are not atomic, and so a WikitextPFragment should never contain strip markers corresponding to other WikitextPFragments.

Member Function Documentation

◆ asDom()

Wikimedia\Parsoid\Fragments\WikitextPFragment::asDom	(	ParsoidExtensionAPI	$extApi,
		bool	$release = false )

Return the fragment as a (prepared and loaded) DOM DocumentFragment belonging to the Parsoid top-level document.If $release is true, then this PFragment will become invalid after this method returns.

Note: The default implementation of asDom() calls asHtmlString(). Subclassses must implement either asDom() or asHtmlString() to avoid infinite mutual recursion.

Reimplemented from Wikimedia\Parsoid\Fragments\PFragment.

◆ asMarkedWikitext()

Wikimedia\Parsoid\Fragments\WikitextPFragment::asMarkedWikitext ( StripState $stripState )

This method returns a "wikitext string" in the legacy format.Wikitext constructs will be parsed in the result. Constructs which are not representable in wikitext will be replaced with strip markers, and you will get a strip state which maps those markers back to PFragment objects. When you (for example) compose two marked strings and then ask for the result asDom, the strip markers in the marked strings will first be conceptually replaced with the PFragment from the StripState, and then the resulting interleaved strings and fragments will be composed.

Reimplemented from Wikimedia\Parsoid\Fragments\PFragment.

◆ castFromPFragment()

static Wikimedia\Parsoid\Fragments\WikitextPFragment::castFromPFragment ( PFragment $fragment )

static

Return a WikitextPFragment corresponding to the given PFragment.

If the fragment is not already a WikitextPFragment, this will convert it using PFragment::asMarkedWikitext().

◆ containsMarker()

Wikimedia\Parsoid\Fragments\WikitextPFragment::containsMarker ( )

Returns true if this fragment contains some non-wikitext content.

Reimplemented from Wikimedia\Parsoid\Fragments\PFragment.

◆ isAtomic()

Wikimedia\Parsoid\Fragments\WikitextPFragment::isAtomic ( )

Returns: false

Reimplemented from Wikimedia\Parsoid\Fragments\PFragment.

◆ isEmpty()

Wikimedia\Parsoid\Fragments\WikitextPFragment::isEmpty ( )

Returns true if this fragment is empty.This enables optimizations if implemented, but returns false by default.

Reimplemented from Wikimedia\Parsoid\Fragments\PFragment.

◆ jsonClassHintFor()

static Wikimedia\Parsoid\Fragments\WikitextPFragment::jsonClassHintFor ( string $keyName )

static

Reimplemented from Wikimedia\Parsoid\Fragments\PFragment.

◆ killMarkers()

Wikimedia\Parsoid\Fragments\WikitextPFragment::killMarkers ( )

Return a version of this wikitext fragment with all strip markers removed.

Returns: string

Reimplemented from Wikimedia\Parsoid\Fragments\PFragment.

◆ markerSkipCallback()

Wikimedia\Parsoid\Fragments\WikitextPFragment::markerSkipCallback ( callable $callback )

Call a callback function on all regions of the given text that are wikitext content, replacing them with the return value of the callback.Non-wikitext content is skipped but included in their proper places.

Parameters

callable(string):string $callback

Returns: PFragment

Reimplemented from Wikimedia\Parsoid\Fragments\PFragment.

◆ newFromJsonArray()

static Wikimedia\Parsoid\Fragments\WikitextPFragment::newFromJsonArray ( array $json )

static

Exceptions

JsonException

Reimplemented from Wikimedia\Parsoid\Fragments\PFragment.

◆ newFromLiteral()

static Wikimedia\Parsoid\Fragments\WikitextPFragment::newFromLiteral	(	string	$value,
		?DomSourceRange	$srcOffsets )

static

Returns a new WikitextPFragment from the given literal string and optional source offsets.

Unlike LiteralStringPFragment, the resulting fragment is non-atomic – it will not be an opaque strip marker but instead will consists of escaped wikitext that will evaluate to the desired string value.

See also: LiteralStringPFragment::newFromLiteral() for an atomic fragment equivalent.

Parameters

string	$value	The literal string
?DomSourceRange	$srcOffsets	The source range corresponding to this literal string, if there is one

◆ newFromSplitWt()

static Wikimedia\Parsoid\Fragments\WikitextPFragment::newFromSplitWt	(	array	$pieces,
		?DomSourceRange	$srcOffsets = null,
		bool	$unsafeConcat = false )

static

Return a new WikitextPFragment consisting of the given array of pieces concatenated together.

Each piece can contain either a string of wikitext (without strip markers) or a PFragment.

Parameters

	array<string\|PFragment>	$pieces
?DomSourceRange	$srcOffsets
bool	$unsafeConcat	False by default; when true suppresses the addition of <nowiki> markers used to ensure adjacent wikitext strings do not interfere with each other.

◆ split()

Wikimedia\Parsoid\Fragments\WikitextPFragment::split ( )

Split this fragment at its strip markers and return an array which alternates between string items and PFragment items.

The first and last items are guaranteed to be strings, and the array length is guaranteed to be odd and at least 1.

Returns: list<string|PFragment>

Reimplemented from Wikimedia\Parsoid\Fragments\PFragment.

◆ toJsonArray()

Wikimedia\Parsoid\Fragments\WikitextPFragment::toJsonArray ( )

Reimplemented from Wikimedia\Parsoid\Fragments\PFragment.

◆ trim()

Wikimedia\Parsoid\Fragments\WikitextPFragment::trim ( )

Trim leading and trailing whitespace from this fragment.

If the result is just a strip marker, will return the fragment corresponding to that strip marker; that is, this method is not guaranteed to return a WikitextPFragment.

Returns: PFragment

Reimplemented from Wikimedia\Parsoid\Fragments\PFragment.

The documentation for this class was generated from the following file:

src/Fragments/WikitextPFragment.php

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ asDom()

◆ asMarkedWikitext()

◆ castFromPFragment()

◆ containsMarker()

◆ isAtomic()

◆ isEmpty()

◆ jsonClassHintFor()

◆ killMarkers()

◆ markerSkipCallback()

◆ newFromJsonArray()

◆ newFromLiteral()

◆ newFromSplitWt()

◆ split()

◆ toJsonArray()

◆ trim()