MarkupQA class

HTML Markup Quality Assurance

Provides runtime quality assurance for markup stored in [textarea] field values.

Ensures URLs referenced in and tags are relative to actual site root.
Ensures local page URLs referenced in tags up-to-date with current $page URL.
Identifies and logs tags that point to non-existing files in PW's file system.
Re-creates image variations that don't exist, when the original still exists.
Populates blank 'alt' attributes with actual file description.

For #1 use the wakeupUrls($value) and sleepUrls($value) methods.
For #2 use the wakeupHrefs($value) and sleepHrefs($value) methods.
For #3-5 use the checkImgTags($value, $options) method, where $options specifies 3-5.

Runtime errors are logged to: /site/assets/logs/markup-qa-errors.txt

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the MarkupQA class also inherits all the methods and properties of: Wire.

Common

Name	Return	Summary
MarkupQA::checkImgTags() MarkupQA::checkImgTags(string $value) MarkupQA::checkImgTags(string $value, array $options = [])	None	Quality assurance for <img> tags
MarkupQA::debug() MarkupQA::debug() MarkupQA::debug($set = null)	`bool`	Get or set debug status
MarkupQA::error() MarkupQA::error(string $text) MarkupQA::error(string $text, int $flags = 0)	`$this`	Record error message to image-errors log
MarkupQA::findLinks() MarkupQA::findLinks() MarkupQA::findLinks($page = null, array $fieldNames = [], string $selector = '', array $options = [])	`PageArray` `array` `int`	Find pages linking to another
MarkupQA::ignorePaths() MarkupQA::ignorePaths() MarkupQA::ignorePaths($paths = null, bool $replace = false)	`array`	Get or set paths to ignore for link abstraction
MarkupQA::setField() MarkupQA::setField(Field $field) MarkupQA::setField(Field $field)	None	Set the current Field
MarkupQA::setPage() MarkupQA::setPage(Page $page) MarkupQA::setPage(Page $page)	None	Set the current Page
MarkupQA::sleepLinks() MarkupQA::sleepLinks(string $value) MarkupQA::sleepLinks(string $value)	None	Sleep href attributes, adding a data-pwid attribute to <a> tags that resolve to a Page
MarkupQA::sleepUrls() MarkupQA::sleepUrls($value) MarkupQA::sleepUrls($value)	None	Sleep URLs in href or src attributes for storage
MarkupQA::verbose() MarkupQA::verbose() MarkupQA::verbose($set = null)	`bool`	Get or set verbose state
MarkupQA::wakeupLinks() MarkupQA::wakeupLinks($value) MarkupQA::wakeupLinks($value)	`array`	Wakeup href attributes, using the data-pwid attribute to update the href attribute as necessary
MarkupQA::wakeupUrls() MarkupQA::wakeupUrls($value) MarkupQA::wakeupUrls($value)	None	Wakeup URLs in href or src attributes for presentation

Additional methods and properties

In addition to the methods and properties above, MarkupQA also inherits the methods and properties of these classes:

Wire

API reference based on ProcessWire core version 3.0.252