interface LinkRelationTypeInterface (View source)

Defines a single link relation type.

An example of a link relation type is 'canonical'. It represents a canonical, definite representation of a resource.

Methods

bool
isRegistered()

Indicates whether this link relation type is of the 'registered' kind.

bool
isExtension()

Indicates whether this link relation type is of the 'extension' kind.

string|null
getRegisteredName()

Returns the registered link relation type name.

string
getExtensionUri()

Returns the extension link relation type URI.

string
getDescription()

Returns the link relation type description.

string
getReference()

Returns the URL pointing to the reference of the link relation type.

string
getNotes()

Returns some extra notes/comments about this link relation type.

Details

bool isRegistered()

Indicates whether this link relation type is of the 'registered' kind.

bool isExtension()

Indicates whether this link relation type is of the 'extension' kind.

string|null getRegisteredName()

Returns the registered link relation type name.

Only available for link relation types of the KIND_REGISTERED kind.

Return Value

string|null

The name of the registered relation type.

See also

https://tools.ietf.org/html/rfc5988#section-4.1

string getExtensionUri()

Returns the extension link relation type URI.

Only available for link relation types of the KIND_EXTENSION kind.

Return Value

string

The URI of the extension relation type.

See also

https://tools.ietf.org/html/rfc5988#section-4.2

string getDescription()

Returns the link relation type description.

Return Value

string

The link relation type description.

See also

https://tools.ietf.org/html/rfc5988#section-6.2.1

string getReference()

Returns the URL pointing to the reference of the link relation type.

Return Value

string

The URL pointing to the reference.

See also

https://tools.ietf.org/html/rfc5988#section-6.2.1

string getNotes()

Returns some extra notes/comments about this link relation type.

Return Value

string

The notes about the link relation.

See also

https://tools.ietf.org/html/rfc5988#section-6.2.1