Fonctions membres publiques
	__construct ($feed, $data)

	set_registry (SimplePie_Registry $registry)

	__toString ()

	__destruct ()

	get_item_tags ($namespace, $tag)

	get_base ($element=array())

	sanitize ($data, $type, $base='')

	get_feed ()

	get_id ($hash=false)

	get_title ()

	get_description ($description_only=false)

	get_content ($content_only=false)

	get_category ($key=0)

	get_categories ()

	get_author ($key=0)

	get_contributor ($key=0)

	get_contributors ()

	get_authors ()

	get_copyright ()

	get_date ($date_format='j F Y, g:i a')

	get_updated_date ($date_format='j F Y, g:i a')

	get_local_date ($date_format='%c')

	get_gmdate ($date_format='j F Y, g:i a')

	get_updated_gmdate ($date_format='j F Y, g:i a')

	get_permalink ()

	get_link ($key=0, $rel='alternate')

	get_links ($rel='alternate')

	get_enclosure ($key=0, $prefer=null)

	get_enclosures ()

	get_latitude ()

	get_longitude ()

	get_source ()

Champs de données
	$feed

	$data = array()

Attributs protégés
	$registry

Documentation des constructeurs et destructeur

◆ __construct()

__construct	(	$feed,
		$data
	)

Create a new item object

This is usually used by {

Voir également: SimplePie::get_items} and {; SimplePie::get_item}. Avoid creating this manually.

Paramètres

SimplePie	$feed	Parent feed
array	$data	Raw data

Références $data, et $feed.

◆ __destruct()

__destruct ( )

Remove items that link back to this before destroying this object

Documentation des fonctions membres

◆ __toString()

__toString ( )

Get a string representation of the item

Renvoie: string

◆ get_author()

get_author ( $key = 0 )

Get an author for the item

Depuis: Beta 2

Paramètres

int $key The author that you want to return. Remember that arrays begin with 0, not 1

Renvoie: SimplePie_Author|null

Références $key, get_authors(), et null.

◆ get_authors()

get_authors ( )

Get all authors for the item

Uses <atom:author>, <author>, <dc:creator> or <itunes:author>

Depuis: Beta 2

Renvoie: array|null List of {

Voir également: SimplePie_Author} objects

Références $author, $name, $uri, $url, elseif, get_base(), get_item_tags(), get_source(), null, sanitize(), SIMPLEPIE_CONSTRUCT_IRI, SIMPLEPIE_CONSTRUCT_TEXT, SIMPLEPIE_NAMESPACE_ATOM_03, SIMPLEPIE_NAMESPACE_ATOM_10, SIMPLEPIE_NAMESPACE_DC_10, SIMPLEPIE_NAMESPACE_DC_11, SIMPLEPIE_NAMESPACE_ITUNES, et SIMPLEPIE_NAMESPACE_RSS_20.

Référencé par get_author().

◆ get_base()

get_base ( $element = array() )

Get the base URL value from the parent feed

Uses <xml:base>

Paramètres

array $element

Renvoie: string

Référencé par get_authors(), get_content(), get_contributors(), get_copyright(), get_description(), get_enclosures(), get_links(), et get_title().

◆ get_categories()

get_categories ( )

Get all categories for the item

Uses <atom:category>, <category> or <dc:subject>

Depuis: Beta 3

Renvoie: array|null List of {

Voir également: SimplePie_Category} objects

Références $category, $label, get_item_tags(), null, sanitize(), SIMPLEPIE_CONSTRUCT_TEXT, SIMPLEPIE_NAMESPACE_ATOM_10, SIMPLEPIE_NAMESPACE_DC_10, SIMPLEPIE_NAMESPACE_DC_11, et SIMPLEPIE_NAMESPACE_RSS_20.

Référencé par get_category().

◆ get_category()

get_category ( $key = 0 )

Get a category for the item

Depuis: Beta 3 (previously called get_categories() since Beta 2)

Paramètres

int $key The category that you want to return. Remember that arrays begin with 0, not 1

Renvoie: SimplePie_Category|null

Références $key, get_categories(), et null.

◆ get_content()

get_content ( $content_only = false )

Get the content for the item

Prefers full content over summaries, but will return a summary if full content does not exist.

To prefer summaries instead, use {

Voir également: get_description}

Uses <atom:content> or <content:encoded> (RSS 1.0 Content Module)

Depuis: 1.0

Paramètres

boolean $content_only Should we avoid falling back to the description?

Renvoie: string|null

Références $return, elseif, get_base(), get_description(), get_item_tags(), null, sanitize(), SIMPLEPIE_CONSTRUCT_HTML, SIMPLEPIE_NAMESPACE_ATOM_03, SIMPLEPIE_NAMESPACE_ATOM_10, et SIMPLEPIE_NAMESPACE_RSS_10_MODULES_CONTENT.

Référencé par get_description().

◆ get_contributor()

get_contributor ( $key = 0 )

Get a contributor for the item

Depuis: 1.1

Paramètres

int $key The contrbutor that you want to return. Remember that arrays begin with 0, not 1

Renvoie: SimplePie_Author|null

Références $key, get_contributors(), et null.

◆ get_contributors()

get_contributors ( )

Get all contributors for the item

Uses <atom:contributor>

Depuis: 1.1

Renvoie: array|null List of {

Voir également: SimplePie_Author} objects

Références $name, $uri, $url, get_base(), get_item_tags(), null, sanitize(), SIMPLEPIE_CONSTRUCT_IRI, SIMPLEPIE_CONSTRUCT_TEXT, SIMPLEPIE_NAMESPACE_ATOM_03, et SIMPLEPIE_NAMESPACE_ATOM_10.

Référencé par get_contributor().

◆ get_copyright()

get_copyright ( )

Get the copyright info for the item

Uses <atom:rights> or <dc:rights>

Depuis: 1.1

Renvoie: string

Références $return, elseif, get_base(), get_item_tags(), null, sanitize(), SIMPLEPIE_CONSTRUCT_TEXT, SIMPLEPIE_NAMESPACE_ATOM_10, SIMPLEPIE_NAMESPACE_DC_10, et SIMPLEPIE_NAMESPACE_DC_11.

◆ get_date()

get_date	(		$date_format = `'j F Y`,
		g:i a'
	)

Get the posting date/time for the item

Uses <atom:published>, <atom:updated>, <atom:issued>, <atom:modified>, <pubDate> or <dc:date>

Note: obeys PHP's timezone setting. To get a UTC date/time, use {

Voir également: get_gmdate}

Depuis: Beta 2 (previously called get_item_date since 0.8)

Paramètres

string $date_format Supports any PHP date format from {

Voir également: http://php.net/date} (empty for the raw data)

Renvoie: int|string|null

Références $return, elseif, get_item_tags(), null, sanitize(), SIMPLEPIE_CONSTRUCT_TEXT, SIMPLEPIE_NAMESPACE_ATOM_03, SIMPLEPIE_NAMESPACE_ATOM_10, SIMPLEPIE_NAMESPACE_DC_10, SIMPLEPIE_NAMESPACE_DC_11, et SIMPLEPIE_NAMESPACE_RSS_20.

Référencé par get_gmdate(), et get_local_date().

◆ get_description()

get_description ( $description_only = false )

Get the content for the item

Prefers summaries over full content , but will return full content if a summary does not exist.

To prefer full content instead, use {

Voir également: get_content}

Uses <atom:summary>, <description>, <dc:description> or <itunes:subtitle>

Depuis: 0.8

Paramètres

boolean $description_only Should we avoid falling back to the content?

Renvoie: string|null

Références $return, elseif, get_base(), get_content(), get_item_tags(), null, sanitize(), SIMPLEPIE_CONSTRUCT_HTML, SIMPLEPIE_CONSTRUCT_MAYBE_HTML, SIMPLEPIE_CONSTRUCT_TEXT, SIMPLEPIE_NAMESPACE_ATOM_03, SIMPLEPIE_NAMESPACE_ATOM_10, SIMPLEPIE_NAMESPACE_DC_10, SIMPLEPIE_NAMESPACE_DC_11, SIMPLEPIE_NAMESPACE_ITUNES, SIMPLEPIE_NAMESPACE_RSS_090, SIMPLEPIE_NAMESPACE_RSS_10, et SIMPLEPIE_NAMESPACE_RSS_20.

Référencé par get_content().

◆ get_enclosure()

get_enclosure	(	$key = `0`,
		$prefer = `null`
	)

Get an enclosure from the item

Supports the <enclosure> RSS tag, as well as Media RSS and iTunes RSS.

Depuis: Beta 2

Paramètres

int $key The enclosure that you want to return. Remember that arrays begin with 0, not 1

Renvoie: SimplePie_Enclosure|null

Références $key, get_enclosures(), et null.

Référencé par get_permalink().

◆ get_enclosures()

get_enclosures ( )

Get all available enclosures (podcasts, etc.)

Supports the <enclosure> RSS tag, as well as Media RSS and iTunes RSS.

At this point, we're pretty much assuming that all enclosures for an item are the same content. Anything else is too complicated to properly support.

Depuis: Beta 2

Renvoie: array|null List of SimplePie_Enclosure items

Références $category, $content, $description, $hash, $height, $keywords, $label, $lang, $link, $rating, $title, $type, $url, $value, $width, elseif, get_base(), get_feed(), get_item_tags(), null, sanitize(), SIMPLEPIE_CONSTRUCT_IRI, SIMPLEPIE_CONSTRUCT_TEXT, SIMPLEPIE_NAMESPACE_ATOM_03, SIMPLEPIE_NAMESPACE_ATOM_10, SIMPLEPIE_NAMESPACE_ITUNES, SIMPLEPIE_NAMESPACE_MEDIARSS, et SIMPLEPIE_NAMESPACE_RSS_20.

Référencé par get_enclosure().

◆ get_feed()

get_feed ( )

Get the parent feed

Note: this may not work as you think for multifeeds!

1.0 SimplePie

Références $feed.

Référencé par get_enclosures().

◆ get_gmdate()

get_gmdate	(		$date_format = `'j F Y`,
		g:i a'
	)

Get the posting date/time for the item (UTC time)

Voir également: get_date

Paramètres

string $date_format Supports any PHP date format from {

Voir également: http://php.net/date}

Renvoie: int|string|null

Références $date, get_date(), et null.

◆ get_id()

get_id ( $hash = false )

Get the unique identifier for the item

This is usually used when writing code to check for new items in a feed.

Uses <atom:id>, <guid>, <dc:identifier> or the about attribute for RDF. If none of these are supplied (or $hash is true), creates an MD5 hash based on the permalink and title. If either of those are not supplied, creates a hash based on the full feed data.

Depuis: Beta 2

Paramètres

boolean $hash Should we force using a hash instead of the supplied ID?

Renvoie: string

Références $hash, $return, elseif, get_item_tags(), get_permalink(), get_title(), null, sanitize(), SIMPLEPIE_CONSTRUCT_TEXT, SIMPLEPIE_NAMESPACE_ATOM_03, SIMPLEPIE_NAMESPACE_ATOM_10, SIMPLEPIE_NAMESPACE_DC_10, SIMPLEPIE_NAMESPACE_DC_11, SIMPLEPIE_NAMESPACE_RDF, et SIMPLEPIE_NAMESPACE_RSS_20.

◆ get_item_tags()

get_item_tags	(	$namespace,
		$tag
	)

Get data for an item-level element

This method allows you to get access to ANY element/attribute that is a sub-element of the item/entry tag.

See {

Voir également: SimplePie::get_feed_tags()} for a description of the return value

Depuis: 1.0

Voir également: http://simplepie.org/wiki/faq/supported_xml_namespaces

Paramètres

string	$namespace	The URL of the XML namespace of the elements you're trying to access
string	$tag	Tag name

Renvoie: array

Références null.

Référencé par get_authors(), get_categories(), get_content(), get_contributors(), get_copyright(), get_date(), get_description(), get_enclosures(), get_id(), get_latitude(), get_links(), get_longitude(), get_source(), get_title(), et get_updated_date().

◆ get_latitude()

get_latitude ( )

Get the latitude coordinates for the item

Compatible with the W3C WGS84 Basic Geo and GeoRSS specifications

Uses <geo:lat> or <georss:point>

Depuis: 1.0 W3C WGS84 Basic Geo http://www.georss.org/ GeoRSS string|null

Références $return, elseif, get_item_tags(), null, SIMPLEPIE_NAMESPACE_GEORSS, et SIMPLEPIE_NAMESPACE_W3C_BASIC_GEO.

◆ get_link()

get_link	(	$key = `0`,
		$rel = `'alternate'`
	)

Get a single link for the item

Depuis: Beta 3

Paramètres

int	$key	The link that you want to return. Remember that arrays begin with 0, not 1
string	$rel	The relationship of the link to return

Renvoie: string|null Link URL

Références $key, $rel, get_links(), et null.

Référencé par get_permalink().

◆ get_links()

get_links ( $rel = 'alternate' )

Get all links for the item

Uses <atom:link>, <link> or <guid>

Depuis: Beta 2

Paramètres

string $rel The relationship of links to return

Renvoie: array|null Links found for the item (strings)

Références $key, $link, $rel, elseif, get_base(), get_item_tags(), null, sanitize(), SIMPLEPIE_CONSTRUCT_IRI, SIMPLEPIE_IANA_LINK_RELATIONS_REGISTRY, SIMPLEPIE_NAMESPACE_ATOM_03, SIMPLEPIE_NAMESPACE_ATOM_10, SIMPLEPIE_NAMESPACE_RSS_090, SIMPLEPIE_NAMESPACE_RSS_10, et SIMPLEPIE_NAMESPACE_RSS_20.

Référencé par get_link().

◆ get_local_date()

get_local_date ( $date_format = '%c' )

Get the localized posting date/time for the item

Returns the date formatted in the localized language. To display in languages other than the server's default, you need to change the locale with setlocale(). The available localizations depend on which ones are installed on your web server.

Depuis: 1.0

Paramètres

string $date_format Supports any PHP date format from {

Voir également: http://php.net/strftime} (empty for the raw data)

Renvoie: int|string|null

Références $date, elseif, get_date(), null, sanitize(), et SIMPLEPIE_CONSTRUCT_TEXT.

◆ get_longitude()

get_longitude ( )

Get the longitude coordinates for the item

Compatible with the W3C WGS84 Basic Geo and GeoRSS specifications

Uses <geo:long>, <geo:lon> or <georss:point>

Depuis: 1.0 W3C WGS84 Basic Geo http://www.georss.org/ GeoRSS string|null

Références $return, elseif, get_item_tags(), null, SIMPLEPIE_NAMESPACE_GEORSS, et SIMPLEPIE_NAMESPACE_W3C_BASIC_GEO.

◆ get_permalink()

get_permalink ( )

Get the permalink for the item

Returns the first link available with a relationship of "alternate". Identical to {

Voir également: get_link()} with key 0; get_link

Depuis: 0.8

Renvoie: string|null Permalink URL

Références $link, elseif, get_enclosure(), get_link(), et null.

Référencé par get_id().

◆ get_source()

get_source ( )

Get the <atom:source> for the item

Depuis: 1.1

Renvoie: SimplePie_Source|null

Références $return, get_item_tags(), null, et SIMPLEPIE_NAMESPACE_ATOM_10.

Référencé par get_authors().

◆ get_title()

get_title ( )

Get the title of the item

Uses <atom:title>, <title> or <dc:title>

Depuis: Beta 2 (previously called get_item_title since 0.8)

Renvoie: string|null

Références $return, elseif, get_base(), get_item_tags(), null, sanitize(), SIMPLEPIE_CONSTRUCT_MAYBE_HTML, SIMPLEPIE_CONSTRUCT_TEXT, SIMPLEPIE_NAMESPACE_ATOM_03, SIMPLEPIE_NAMESPACE_ATOM_10, SIMPLEPIE_NAMESPACE_DC_10, SIMPLEPIE_NAMESPACE_DC_11, SIMPLEPIE_NAMESPACE_RSS_090, SIMPLEPIE_NAMESPACE_RSS_10, et SIMPLEPIE_NAMESPACE_RSS_20.

Référencé par get_id().

◆ get_updated_date()

get_updated_date	(		$date_format = `'j F Y`,
		g:i a'
	)

Get the update date/time for the item

Uses <atom:updated>

Note: obeys PHP's timezone setting. To get a UTC date/time, use {

Voir également: get_gmdate}

Paramètres

string $date_format Supports any PHP date format from {

Voir également: http://php.net/date} (empty for the raw data)

Renvoie: int|string|null

Références $return, get_item_tags(), null, sanitize(), SIMPLEPIE_CONSTRUCT_TEXT, et SIMPLEPIE_NAMESPACE_ATOM_10.

Référencé par get_updated_gmdate().

◆ get_updated_gmdate()

get_updated_gmdate	(		$date_format = `'j F Y`,
		g:i a'
	)

Get the update date/time for the item (UTC time)

Voir également: get_updated_date

Paramètres

string $date_format Supports any PHP date format from {

Voir également: http://php.net/date}

Renvoie: int|string|null

Références $date, get_updated_date(), et null.

◆ sanitize()

sanitize	(	$data,
		$type,
		$base = `''`
	)

Sanitize feed data

private

Voir également: SimplePie::sanitize()

Paramètres

string	$data	Data to sanitize
int	$type	One of the SIMPLEPIE_CONSTRUCT_* constants
string	$base	Base URL to resolve URLs against

Renvoie: string Sanitized data

Références $base, $data, et $type.

Référencé par get_authors(), get_categories(), get_content(), get_contributors(), get_copyright(), get_date(), get_description(), get_enclosures(), get_id(), get_links(), get_local_date(), get_title(), et get_updated_date().

◆ set_registry()

set_registry ( SimplePie_Registry $registry )

Set the registry handler

This is usually used by {

Voir également: SimplePie_Registry::create}

Depuis: 1.3

Paramètres

SimplePie_Registry $registry

Références $registry.

Documentation des champs

◆ $data

$data = array()

Référencé par __construct(), et sanitize().

◆ $feed

$feed

Référencé par __construct(), et get_feed().

◆ $registry

$registry

protected

Référencé par set_registry().

La documentation de cette classe a été générée à partir du fichier suivant :

Item.php

Fonctions membres publiques

Champs de données

Attributs protégés

Documentation des constructeurs et destructeur

◆ __construct()

◆ __destruct()

Documentation des fonctions membres

◆ __toString()

◆ get_author()

◆ get_authors()

◆ get_base()

◆ get_categories()

◆ get_category()

◆ get_content()

◆ get_contributor()

◆ get_contributors()

◆ get_copyright()

◆ get_date()

◆ get_description()

◆ get_enclosure()

◆ get_enclosures()

◆ get_feed()

◆ get_gmdate()

◆ get_id()

◆ get_item_tags()

◆ get_latitude()

◆ get_link()

◆ get_links()

◆ get_local_date()

◆ get_longitude()

◆ get_permalink()

◆ get_source()

◆ get_title()

◆ get_updated_date()

◆ get_updated_gmdate()

◆ sanitize()

◆ set_registry()

Documentation des champs

◆ $data

◆ $feed

◆ $registry