Открытые члены
	__construct ($html, Uri $uri)

	getUri ()

	getHtml ()

	checkMetadata ()

	getMetadata ()

	getTitle ()

	setTitle ($title)

	getDescription ()

	setDescription ($description)

	getImage ()

	setImage ($image)

	getEmdbed ()

	setEmbed ($embed)

	setExtraField ($fieldName, $fieldValue)

	getExtraField ($fieldName)

	setDateExpire (DateTime $dateExpire)

	getDateExpire ()

	setEncoding ($encoding)

	getEncoding ()

	detectEncoding ()

	extractElementAttributes ($tagName)

	getMetaContent ($name)

	getLinkHref ($rel)

Открытые атрибуты
const	MAX_IMAGES = 4

const	MAX_IMAGE_URL_LENGTH = 2000

const	MAX_HTML_LENGTH = 1048576

Защищенные члены
	filterString ($str)

	convertRelativeUriToAbsolute ($uri)

	normalizeImageUrl ($url)

	validateImage ($url, $skipForPrivateIp=false)

	isEmbeddingAllowed ()

Защищенные данные
	$uri

	$html

	$htmlEncoding

	$metadata

	$metaElements = array()

	$linkElements = array()

Подробное описание

См. определение в файле htmldocument.php строка 12

Конструктор(ы)

◆ __construct()

__construct	(		$html,
		Uri	$uri )

HtmlDocument constructor.

Аргументы

string	$html	Document HTML code.
Uri	$uri	Document's URL.

См. определение в файле htmldocument.php строка 50

Методы

◆ checkMetadata()

checkMetadata ( )

Returns true if metadata is complete

Возвращает: bool

См. определение в файле htmldocument.php строка 81

◆ convertRelativeUriToAbsolute()

convertRelativeUriToAbsolute ( $uri )

protected

Converts relative url to the absolute, considering document's url.

Аргументы

string $uri Relative url.

Возвращает: null|string Absolute url or null if relative url contains errors.

См. определение в файле htmldocument.php строка 437

◆ detectEncoding()

detectEncoding ( )

Auto-detect and set HTML document encoding

Возвращает: string Detected encoding.

См. определение в файле htmldocument.php строка 305

◆ extractElementAttributes()

extractElementAttributes ( $tagName )

Parses html content for attributes of the specified elements and fills $destination array with found attributes

Аргументы

string $tagName Name of the tag.

Возвращает: array

См. определение в файле htmldocument.php строка 339

◆ filterString()

filterString ( $str )

protected

Sanitizes string and converts it to the site's charset.

Аргументы

string $str Input string.

Возвращает: string

См. определение в файле htmldocument.php строка 422

◆ getDateExpire()

getDateExpire ( )

Returns expire date for the metadata.

Возвращает: DateTime|null

См. определение в файле htmldocument.php строка 269

◆ getDescription()

getDescription ( )

Возвращает: string

См. определение в файле htmldocument.php строка 133

◆ getEmdbed()

getEmdbed ( )

Возвращает: string HTML code to embed url to the page.

См. определение в файле htmldocument.php строка 181

◆ getEncoding()

getEncoding ( )

Возвращает: string Document encoding.

См. определение в файле htmldocument.php строка 289

◆ getExtraField()

getExtraField ( $fieldName )

Returns value of the additional metadata field

Аргументы

string $fieldName Name of the field.

Возвращает: string|null Value of the additional metadata field.

См. определение в файле htmldocument.php строка 246

◆ getHtml()

getHtml ( )

Returns full html code of the document

Возвращает: string

См. определение в файле htmldocument.php строка 71

◆ getImage()

getImage ( )

Возвращает: string Main image's url.

См. определение в файле htmldocument.php строка 155

◆ getLinkHref()

getLinkHref ( $rel )

Returns value of the href attribute.

Аргументы

string $rel Value of the rel attribute.

Возвращает: string

См. определение в файле htmldocument.php строка 395

◆ getMetaContent()

getMetaContent ( $name )

Returns value of the content attribute

Аргументы

string $name Value of a name or property attribute.

Возвращает: string

См. определение в файле htmldocument.php строка 368

◆ getMetadata()

getMetadata ( )

Returns metadata, extracted from the page. Should return an array with required key TITLE and optional keys DESCRIPTION and URL

Возвращает: array|false

См. определение в файле htmldocument.php строка 101

◆ getTitle()

getTitle ( )

Returns document's TITLE metadata

Возвращает: string

См. определение в файле htmldocument.php строка 111

◆ getUri()

getUri ( )

Returns Uri of the document

Возвращает: Uri

См. определение в файле htmldocument.php строка 61

◆ isEmbeddingAllowed()

isEmbeddingAllowed ( )

protected

Returns true if document's site is allowed to be embedded.

Возвращает: bool

См. определение в файле htmldocument.php строка 537

◆ normalizeImageUrl()

normalizeImageUrl ( $url )

protected

Transforms image's URL from relative to absolute and checks length of the resulting URL.

Аргументы

string $url Image's URL.

Возвращает: string|null Absolute image's URL, or null if URL is incorrect or too long.

См. определение в файле htmldocument.php строка 494

◆ setDateExpire()

setDateExpire ( DateTime $dateExpire )

Sets Expire date for the metadata.

Аргументы

DateTime $dateExpire

См. определение в файле htmldocument.php строка 256

◆ setDescription()

setDescription ( $description )

Sets document's DESCRIPTION metadata

Аргументы

string $description Description.

Возвращает: void

См. определение в файле htmldocument.php строка 144

◆ setEmbed()

setEmbed ( $embed )

Sets document's EMBED metadata, if site is allowed to be embedded.

Аргументы

string $embed HTML code for embedding object to the page.

Возвращает: void

См. определение в файле htmldocument.php строка 192

◆ setEncoding()

setEncoding ( $encoding )

Set HTML document encoding

Аргументы

string $encoding Document's encoding.

Возвращает: void

См. определение в файле htmldocument.php строка 280

◆ setExtraField()

setExtraField	(		$fieldName,
			$fieldValue )

Sets additional metadata field.

Аргументы

string	$fieldName	Name of the field. Expected values: FAVICON: $fieldValue must contain the url of document's favicon IMAGES: $fieldValue must be the array of urls of images, detected in the document In other cases, $fieldValue must contain plain text.
string	$fieldValue	Field value.

Возвращает: void

См. определение в файле htmldocument.php строка 209

◆ setImage()

setImage ( $image )

Sets document's IMAGE metadata

Аргументы

string $image Main image's url.

Возвращает: void

См. определение в файле htmldocument.php строка 166

◆ setTitle()

setTitle ( $title )

Sets document's TITLE metadata

Аргументы

string $title Title.

Возвращает: void

См. определение в файле htmldocument.php строка 122

◆ validateImage()

validateImage	(		$url,
			$skipForPrivateIp = false )

protected

Validates mime-type of the image

Аргументы

string $url Absolute image's URL.

Возвращает: bool

См. определение в файле htmldocument.php строка 509

Данные класса

◆ $html

$html

protected

См. определение в файле htmldocument.php строка 22

◆ $htmlEncoding

$htmlEncoding

protected

См. определение в файле htmldocument.php строка 25

◆ $linkElements

$linkElements = array()

protected

См. определение в файле htmldocument.php строка 42

◆ $metadata

$metadata

protected

Инициализатор

= array(
        "TITLE" => null,
        "DESCRIPTION" => null,
        "IMAGE" => null,
        "EMBED" => null,
        "DATE_EXPIRE" => null,
    )

См. определение в файле htmldocument.php строка 30

◆ $metaElements

$metaElements = array()

protected

См. определение в файле htmldocument.php строка 39

◆ $uri

$uri

protected

См. определение в файле htmldocument.php строка 19

◆ MAX_HTML_LENGTH

const MAX_HTML_LENGTH = 1048576

См. определение в файле htmldocument.php строка 16

◆ MAX_IMAGE_URL_LENGTH

const MAX_IMAGE_URL_LENGTH = 2000

См. определение в файле htmldocument.php строка 15

◆ MAX_IMAGES

const MAX_IMAGES = 4

См. определение в файле htmldocument.php строка 14

Bitrix-D7 23.9

Открытые члены

Открытые атрибуты

Защищенные члены

Защищенные данные

Подробное описание

Конструктор(ы)

◆ __construct()

Методы

◆ checkMetadata()

◆ convertRelativeUriToAbsolute()

◆ detectEncoding()

◆ extractElementAttributes()

◆ filterString()

◆ getDateExpire()

◆ getDescription()

◆ getEmdbed()

◆ getEncoding()

◆ getExtraField()

◆ getHtml()

◆ getImage()

◆ getLinkHref()

◆ getMetaContent()

◆ getMetadata()

◆ getTitle()

◆ getUri()

◆ isEmbeddingAllowed()

◆ normalizeImageUrl()

◆ setDateExpire()

◆ setDescription()

◆ setEmbed()

◆ setEncoding()

◆ setExtraField()

◆ setImage()

◆ setTitle()

◆ validateImage()

Данные класса

◆ $html

◆ $htmlEncoding

◆ $linkElements

◆ $metadata

◆ $metaElements

◆ $uri

◆ MAX_HTML_LENGTH

◆ MAX_IMAGE_URL_LENGTH

◆ MAX_IMAGES