PHP Класс Pop\Feed\Reader

Автор: Nick Sagona, III ([email protected])
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$adapter Pop\Feed\Format\AbstractFormat Feed adapter
$dateFormat string Feed date format
$template string Feed item template

Открытые методы

Метод Описание
__construct ( AbstractFormat $adapter ) : Reader Constructor
__get ( string $name ) : mixed Get method to return the value of feed[$name].
__toString ( ) : string Render feed reader object to string
adapter ( ) : AbstractFormat Method to get the adapter object
factory ( AbstractFormat $adapter ) : Reader Static method to instantiate the data object and return itself to facilitate chaining methods together.
feed ( ) : array Method to get the adapter object feed
getByAccountId ( string $service, string $id, integer $limit, string $prefix = 'Pop\Feed\Format\' ) : Reader Static method to create a Feed Reader object from an account ID
getByAccountName ( string $service, string $name, integer $limit, string $prefix = 'Pop\Feed\Format\' ) : Reader Static method to create a Feed Reader object from an account name
getByUrl ( string $url, integer $limit, string $prefix = 'Pop\Feed\Format\' ) : Reader Static method to create a Feed Reader object from a URL
getDateFormat ( ) : string Method to get feed date format
getTemplate ( ) : string Method to get feed template
isAtom ( ) : boolean Method to determine if the feed type is Atom
isFacebook ( ) : boolean Method to determine if the feed type is Facebook
isJson ( ) : boolean Method to determine if the feed type is JSON
isPhp ( ) : boolean Method to determine if the feed type is PHP
isPlaylist ( ) : boolean Method to determine if the feed type is a playlist
isRss ( ) : boolean Method to determine if the feed type is RSS
isTwitter ( ) : boolean Method to determine if the feed type is Twitter
isVimeo ( ) : boolean Method to determine if the feed type is Twitter
isYoutube ( ) : boolean Method to determine if the feed type is YouTube
render ( boolean $ret = false ) : mixed Method to render the feed
setDateFormat ( string $date ) : Reader Method to set date format
setTemplate ( string $tmpl ) : Reader Method to set item template

Защищенные методы

Метод Описание
getSource ( string $url ) : array Static method to create a Feed Reader object from a URL

Описание методов

__construct() публичный Метод

Instantiate the feed object.
public __construct ( AbstractFormat $adapter ) : Reader
$adapter Pop\Feed\Format\AbstractFormat
Результат Reader

__get() публичный Метод

Get method to return the value of feed[$name].
public __get ( string $name ) : mixed
$name string
Результат mixed

__toString() публичный Метод

Render feed reader object to string
public __toString ( ) : string
Результат string

adapter() публичный Метод

Method to get the adapter object
public adapter ( ) : AbstractFormat
Результат Pop\Feed\Format\AbstractFormat

factory() публичный статический Метод

Static method to instantiate the data object and return itself to facilitate chaining methods together.
public static factory ( AbstractFormat $adapter ) : Reader
$adapter Pop\Feed\Format\AbstractFormat
Результат Reader

feed() публичный Метод

Method to get the adapter object feed
public feed ( ) : array
Результат array

getByAccountId() публичный статический Метод

Static method to create a Feed Reader object from an account ID
public static getByAccountId ( string $service, string $id, integer $limit, string $prefix = 'Pop\Feed\Format\' ) : Reader
$service string
$id string
$limit integer
$prefix string
Результат Reader

getByAccountName() публичный статический Метод

Static method to create a Feed Reader object from an account name
public static getByAccountName ( string $service, string $name, integer $limit, string $prefix = 'Pop\Feed\Format\' ) : Reader
$service string
$name string
$limit integer
$prefix string
Результат Reader

getByUrl() публичный статический Метод

Static method to create a Feed Reader object from a URL
public static getByUrl ( string $url, integer $limit, string $prefix = 'Pop\Feed\Format\' ) : Reader
$url string
$limit integer
$prefix string
Результат Reader

getDateFormat() публичный Метод

Method to get feed date format
public getDateFormat ( ) : string
Результат string

getSource() защищенный статический Метод

Static method to create a Feed Reader object from a URL
protected static getSource ( string $url ) : array
$url string
Результат array

getTemplate() публичный Метод

Method to get feed template
public getTemplate ( ) : string
Результат string

isAtom() публичный Метод

Method to determine if the feed type is Atom
public isAtom ( ) : boolean
Результат boolean

isFacebook() публичный Метод

Method to determine if the feed type is Facebook
public isFacebook ( ) : boolean
Результат boolean

isJson() публичный Метод

Method to determine if the feed type is JSON
public isJson ( ) : boolean
Результат boolean

isPhp() публичный Метод

Method to determine if the feed type is PHP
public isPhp ( ) : boolean
Результат boolean

isPlaylist() публичный Метод

Method to determine if the feed type is a playlist
public isPlaylist ( ) : boolean
Результат boolean

isRss() публичный Метод

Method to determine if the feed type is RSS
public isRss ( ) : boolean
Результат boolean

isTwitter() публичный Метод

Method to determine if the feed type is Twitter
public isTwitter ( ) : boolean
Результат boolean

isVimeo() публичный Метод

Method to determine if the feed type is Twitter
public isVimeo ( ) : boolean
Результат boolean

isYoutube() публичный Метод

Method to determine if the feed type is YouTube
public isYoutube ( ) : boolean
Результат boolean

render() публичный Метод

Method to render the feed
public render ( boolean $ret = false ) : mixed
$ret boolean
Результат mixed

setDateFormat() публичный Метод

Method to set date format
public setDateFormat ( string $date ) : Reader
$date string
Результат Reader

setTemplate() публичный Метод

Method to set item template
public setTemplate ( string $tmpl ) : Reader
$tmpl string
Результат Reader

Описание свойств

$adapter защищенное свойство

Feed adapter
protected AbstractFormat,Pop\Feed\Format $adapter
Результат Pop\Feed\Format\AbstractFormat

$dateFormat защищенное свойство

Feed date format
protected string $dateFormat
Результат string

$template защищенное свойство

Feed item template
protected string $template
Результат string