#Html

Phuture\Coherence\Type\Html

class Html extends FluentClass implements Htmlable

A fluent wrapper around the Html utility class for chainable HTML manipulation.

Each method delegates to the corresponding static method on \Phuture\Coherence\Html, stores the result internally, and returns $this to enable method chaining. Retrieve the final value by calling get(), toString(), or invoking the object directly.

The wrapped value is always HTML. To build HTML from plain text or Markdown first, use the static \Phuture\Coherence\Html::toHtml() and wrap the result, since on this class toHtml() hands back the markup being held rather than converting anything.

Example:

 1use Phuture\Coherence\Html;
 2
 3$result = Html::of('<p onclick="steal()">Hello <script>alert(1)</script>world</p>')
 4    ->sanitize()
 5    ->truncate(8)
 6    ->toString();
 7// '<p>Hello wo...</p>'
 8
 9$text = Html::of('<p>Hello <b>world</b></p>')->toText();
10// 'Hello world'

#Methods

#__toString()

public function __toString(): string

Returns the string representation of the wrapped HTML.

Returns string — The wrapped HTML markup

#decode()

public function decode(EncodingMode $mode = EncodingMode::All, int $flags = ENT_QUOTES, string $encoding = 'UTF-8'): self

Decodes HTML entities in the wrapped value back to their characters.

Returns self — Returns the current instance for method chaining

See also

• \Phuture\Coherence\Html::decode()

#encode()

public function encode(EncodingMode $mode = EncodingMode::All, int $flags = ENT_QUOTES, string $encoding = 'UTF-8'): self

Encodes characters in the wrapped value as HTML entities.

Returns self — Returns the current instance for method chaining

See also

• \Phuture\Coherence\Html::encode()

#images()

public function images(): array

Lists the addresses of every image in the wrapped HTML.

Returns array — The image addresses in the order they appear, without repeats

See also

• \Phuture\Coherence\Html::images()

#isSanitized()

public function isSanitized(array $allowedTags = [], array $allowedSchemes = ['http', 'https', 'mailto', 'tel'], int $maxLength = 20000): bool

Checks whether the wrapped HTML is already exactly what cleaning would produce.

Returns bool — True when cleaning would change nothing, false when it would change something

See also

• \Phuture\Coherence\Html::isSanitized()

#links()

public function links(): array

Lists the addresses of every link in the wrapped HTML.

Returns array — The link addresses in the order they appear, without repeats

See also

• \Phuture\Coherence\Html::links()

#minify()

public function minify(): self

Makes the wrapped HTML smaller without changing how it looks.

Returns self — Returns the current instance for method chaining

See also

• \Phuture\Coherence\Html::minify()

#sanitize()

public function sanitize(array $allowedTags = [], array $allowedSchemes = ['http', 'https', 'mailto', 'tel'], int $maxLength = 20000): self

Removes dangerous code from the wrapped HTML.

Returns self — Returns the current instance for method chaining

See also

• \Phuture\Coherence\Html::sanitize()

#secureLinks()

public function secureLinks(string $rel = 'noopener noreferrer', bool $forceHttps = false): self

Cleans the wrapped HTML and hardens every link it contains.

Returns self — Returns the current instance for method chaining

See also

• \Phuture\Coherence\Html::secureLinks()

#stripComments()

public function stripComments(): self

Removes comments from the wrapped HTML, leaving the rest of the markup alone.

Returns self — Returns the current instance for method chaining

See also

• \Phuture\Coherence\Html::stripComments()

#stripTags()

public function stripTags(array $allowedTags = []): self

Removes tags from the wrapped HTML, optionally keeping some of them.

Returns self — Returns the current instance for method chaining

See also

• \Phuture\Coherence\Html::stripTags()

#tags()

public function tags(): array

Lists the tag names used in the wrapped HTML.

Returns array — The tag names in the order they appear, without repeats

See also

• \Phuture\Coherence\Html::tags()

#toHtml()

public function toHtml(): string

Returns the wrapped HTML markup.

This method hands back the markup itself, unchanged. It returns the same value as toString(); both exist so that code reading HTML can say so by name, while anything expecting a plain string still works.

Returns string — The wrapped HTML markup

See also

• \Phuture\Coherence\Type\Html::toString()

#toMarkdown()

public function toMarkdown(): string

Returns the wrapped HTML converted to Markdown.

Returns string — The content written as Markdown

See also

• \Phuture\Coherence\Html::toMarkdown()

#toString()

public function toString(): string

Returns the wrapped HTML as a string.

Returns string — The wrapped HTML markup

#toText()

public function toText(): string

Returns just the readable text of the wrapped HTML, with the markup removed.

Returns string — The readable text without any markup

See also

• \Phuture\Coherence\Html::toText()

#truncate()

public function truncate(int $limit, string $end = '...'): self

Shortens the wrapped HTML to a number of visible characters.

Returns self — Returns the current instance for method chaining

See also

• \Phuture\Coherence\Html::truncate()

#truncateWords()

public function truncateWords(int $limit, string $end = '...'): self

Shortens the wrapped HTML to a number of visible words.

Returns self — Returns the current instance for method chaining

See also

• \Phuture\Coherence\Html::truncateWords()