OpenEstate-PHP-Export 2.0.0-SNAPSHOT API
\
Gettext
Extractors
Generators
Languages
Exporter
Utils
OpenEstate
PhpExport
Action
Filter
Html
Order
Provider
Session
Theme
View
PHPMailer
PHPMailer
TrueBV
Exception

\OpenEstate\PhpExport\HtmlMeta

A HTML element for meta tags.

Summary

Methods
Properties
Constants
__construct()
__destruct()
isBody()
isHeader()
generate()
newAuthor()
newCharset()
newCopyright()
newDescription()
newHttpEquiv()
newGenerator()
newKeywords()
newName()
newRefresh()
newRobots()
newViewport()
$id
$class
$title
$name
$content
$httpEquiv
$charset
No constants found
generateAttributes()
getAttributes()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$id

$id : string

Specifies a unique id for an element.

Type

string

$class

$class : string

Specifies one or more class names for an element (refers to a class in a style sheet).

Type

string

$title

$title : string

Specifies extra information about an element.

Type

string

$name

$name : string

Name attribute.

Type

string

$content

$content : string

Content attribute.

Type

string

$httpEquiv

$httpEquiv : string

HTTP-Equiv attribute.

Type

string

$charset

$charset : string

Charset attribute.

Type

string

Methods

__construct()

__construct(string|null  $id = null, string|null  $class = null, string|null  $title = null)

Meta constructor.

Parameters

string|null $id

id attribute
string|null $class

class attribute
string|null $title

title attribute

__destruct()

__destruct()

AbstractHtmlElement destructor.

isBody()

isBody() : boolean

Determine, if the element is placed within the HTML body.

Returns

boolean —

true, if it is a HTML body element

isHeader()

isHeader() : boolean

Determine, if the element is placed within the HTML header.

Returns

boolean —

true, if it is a HTML header element

generate()

generate()

newAuthor()

newAuthor(string  $author) : \OpenEstate\PhpExport\Html\Meta

Create meta element for the page author.

Parameters

string $author

author name

Returns

\OpenEstate\PhpExport\Html\Meta —

created meta element

newCharset()

newCharset(string  $charset) : \OpenEstate\PhpExport\Html\Meta

Create meta element for the document charset.

Parameters

string $charset

charset

Returns

\OpenEstate\PhpExport\Html\Meta —

created meta element

newCopyright()

newCopyright(string  $copyright) : \OpenEstate\PhpExport\Html\Meta

Create meta element for the page copyright.

Parameters

string $copyright

copyright information

Returns

\OpenEstate\PhpExport\Html\Meta —

created meta element

newDescription()

newDescription(string  $description) : \OpenEstate\PhpExport\Html\Meta

Create meta element for the page description.

Parameters

string $description

description

Returns

\OpenEstate\PhpExport\Html\Meta —

created meta element

newHttpEquiv()

newHttpEquiv(string  $id, string  $httpEquiv, string|null  $content = null) : \OpenEstate\PhpExport\Html\Meta

Create meta element with http-equiv.

Parameters

string $id

id attribute
string $httpEquiv

http-equiv attribute
string|null $content

content attribute

Returns

\OpenEstate\PhpExport\Html\Meta —

created meta element

newGenerator()

newGenerator(string  $generator) : \OpenEstate\PhpExport\Html\Meta

Create meta element for the generator.

Parameters

string $generator

generator

Returns

\OpenEstate\PhpExport\Html\Meta —

created meta element

newKeywords()

newKeywords(string  $keywords) : \OpenEstate\PhpExport\Html\Meta

Create meta element for page keywords.

Parameters

string $keywords

keywords

Returns

\OpenEstate\PhpExport\Html\Meta —

created meta element

newName()

newName(string  $id, string  $name, string|null  $content = null) : \OpenEstate\PhpExport\Html\Meta

Create meta element with name.

Parameters

string $id

id attribute
string $name

name attribute
string|null $content

content attribute

Returns

\OpenEstate\PhpExport\Html\Meta —

created meta element

newRefresh()

newRefresh(string  $url, integer|null  $delay) : \OpenEstate\PhpExport\Html\Meta

Create meta element for page refresh.

Parameters

string $url

URL, that is called for refresh
integer|null $delay

duration to wait for refresh in seconds

Returns

\OpenEstate\PhpExport\Html\Meta —

created meta element

newRobots()

newRobots(string  $robots) : \OpenEstate\PhpExport\Html\Meta

Create meta element for robots.

Parameters

string $robots

robots declaration (e.g. "noindex,follow")

Returns

\OpenEstate\PhpExport\Html\Meta —

created meta element

newViewport()

newViewport(string  $viewport) : \OpenEstate\PhpExport\Html\Meta

Create meta element for viewport.

Parameters

string $viewport

viewport declaration (e.g. "width=device-width, initial-scale=1")

Returns

\OpenEstate\PhpExport\Html\Meta —

created meta element

generateAttributes()

generateAttributes() : string

Generate attributes of the HTML element.

Returns

string —

generated attributes in HTML syntax

getAttributes()

getAttributes()