1. class
  2. SimplePie
  3. \
  4. Type
  5. \
  6. Link

Link

class Link extends AbstractType implements NodeInterface, TypeInterface, SetLoggerInterface (View source)

A type model for a Link element.

Traits

LoggerTrait
Shared code for working with the logger.

Properties

protected LoggerInterface $logger A PSR-3 logger. from LoggerTrait
protected DOMNode $node The DOMNode element to parse.
protected string $href The link's remote location.
protected string $rel The link's relationship to the current document.
protected string $type The link's media type.
protected string $hreflang The language of the link's remote location.
protected string $title The link's title.
protected int $length The link's length, in bytes (e.g., if it is a large file or direct download).

Methods

__call(string $nodeName, array $args)

Proxy method which forwards requests to an underlying handler.

from AbstractType
string
getUnresolvableMessage(string $nodeName)

Gets the standard, pre-formatted message for unresolvable method calls.

from AbstractType
LoggerTrait
setLogger(LoggerInterface $logger)

Sets the PSR-3 logger.

from LoggerTrait
LoggerInterface
getLogger()

Retrieves the PSR-3 logger.

from LoggerTrait
__construct(DOMNode|null $node = null, LoggerInterface $logger = null)

Constructs a new instance of this class.

string
__toString()

Converts this object into a string representation.

DOMNode|null
getNode()

Gets the DOMNode element.

string
getAlias(string $nodeName)

Finds the common internal alias for a given method name.

Node
getHandler(string $nodeName, array $args = [])

Get the correct handler for a whitelisted method name.

Node
getHref()

Alias for getUrl().

Node
getHrefLang()

Alias for getLanguage().

Node
getLang()

Alias for getLanguage().

Node
getLanguage()

Returns the language of the Link.

Node
getLength()

Returns the length of the Link, in bytes.

Node
getMediaType()

Returns the media type (née mime type) of the Link.

Node
getRel()

Alias for getRelationship().

Node
getRelationship()

Returns the relationship of the Link.

Node
getTitle()

Returns the title of the Link.

Node
getType()

Alias for getMediaType().

Node
getUri()

Alias for getUrl().

Node
getUrl()

Returns the URL of the Link.

Details

in AbstractType at line 27
__call(string $nodeName, array $args)

Proxy method which forwards requests to an underlying handler.

Parameters

string $nodeName The name of the method being called.
array $args Any arguments passed into that method.

in AbstractType at line 52
protected string getUnresolvableMessage(string $nodeName)

Gets the standard, pre-formatted message for unresolvable method calls.

Parameters

string $nodeName The short version of the call (without the get).

Return Value

string

in LoggerTrait at line 35
LoggerTrait setLogger(LoggerInterface $logger)

Sets the PSR-3 logger.

Parameters

LoggerInterface $logger A PSR-3 compatible logger.

Return Value

LoggerTrait

in LoggerTrait at line 52
LoggerInterface getLogger()

Retrieves the PSR-3 logger.

Return Value

LoggerInterface

at line 104
__construct(DOMNode|null $node = null, LoggerInterface $logger = null)

Constructs a new instance of this class.

Parameters

DOMNode|null $node The DOMNode element to parse.
LoggerInterface $logger The PSR-3 logger.

at line 122
string __toString()

Converts this object into a string representation.

Return Value

string

at line 130
DOMNode|null getNode()

Gets the DOMNode element.

Return Value

DOMNode|null

at line 138
string getAlias(string $nodeName)

Finds the common internal alias for a given method name.

Parameters

string $nodeName The name of the method being called.

Return Value

string

at line 163
Node getHandler(string $nodeName, array $args = [])

Get the correct handler for a whitelisted method name.

Parameters

string $nodeName The name of the method being called.
array $args The parameters which are passed to the method.

Return Value

Node

Exceptions

SimplePieException

at line 45
Node getHref()

Alias for getUrl().

Return Value

Node

at line 45
Node getHrefLang()

Alias for getLanguage().

Return Value

Node

at line 45
Node getLang()

Alias for getLanguage().

Return Value

Node

at line 45
Node getLanguage()

Returns the language of the Link.

Return Value

Node

at line 45
Node getLength()

Returns the length of the Link, in bytes.

Return Value

Node

at line 45
Node getMediaType()

Returns the media type (née mime type) of the Link.

Return Value

Node

at line 45
Node getRel()

Alias for getRelationship().

Return Value

Node

at line 45
Node getRelationship()

Returns the relationship of the Link.

Return Value

Node

at line 45
Node getTitle()

Returns the title of the Link.

Return Value

Node

at line 45
Node getType()

Alias for getMediaType().

Return Value

Node

at line 45
Node getUri()

Alias for getUrl().

Return Value

Node

at line 45
Node getUrl()

Returns the URL of the Link.

Return Value

Node