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

Generator

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

A type model for a Generator 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 $name The generator name.
protected string $uri The generator URI.
protected string $version The generator version.

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
getName()

Returns the name of the Generator.

Node
getUri()

Alias for getUrl().

Node
getUrl()

Returns the URL of the Generator.

Node
getVersion()

Returns the version of the Generator.

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 69
__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 85
string __toString()

Converts this object into a string representation.

Return Value

string

at line 93
DOMNode|null getNode()

Gets the DOMNode element.

Return Value

DOMNode|null

at line 101
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 115
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 31
Node getName()

Returns the name of the Generator.

Return Value

Node

at line 31
Node getUri()

Alias for getUrl().

Return Value

Node

at line 31
Node getUrl()

Returns the URL of the Generator.

Return Value

Node

at line 31
Node getVersion()

Returns the version of the Generator.

Return Value

Node