Référence de la classe Feed

Graphe d'héritage de Feed:

Fonctions membres publiques
	__get ($name)
	__set ($name, $value)
	addCategory ($name, $uri='')
	addContributor ($name, $email, $uri=null, $type=null)
	addEntry (FeedEntry $entry)
	count ()
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	removeCategory ($name)
	removeContributor (FeedPerson $contributor)
	removeEntry (FeedEntry $entry)
	setAuthor ($name, $email, $uri=null, $type=null)
	reverseItems ()

Attributs protégés
	$properties
	$entries = array()

Documentation des fonctions membres

__get()

__get

(

$name

)

Magic method to return values for feed properties.

Paramètres

string

$name

The name of the property.

Renvoie

mixed

Depuis

3.1.4

Références $name, et null.

__set()

__set	(		$name,
			$value
	)

Magic method to set values for feed properties.

Paramètres

string	$name	The name of the property.
mixed	$value	The value to set for the property.

Renvoie

void

Depuis

3.1.4

Références $name, $this, $value, et null.

addCategory()

addCategory	(		$name,
			$uri = ''
	)

Method to add a category to the feed object.

Paramètres

string	$name	The name of the category to add.
string	$uri	The optional URI for the category to add.

Renvoie

Feed

Depuis

3.1.4

Références $name, $this, et $uri.

addContributor()

addContributor	(		$name,
			$email,
			$uri = null,
			$type = null
	)

Method to add a contributor to the feed object.

Paramètres

string	$name	The full name of the person to add.
string	$email	The email address of the person to add.
string	$uri	The optional URI for the person to add.
string	$type	The optional type of person to add.

Renvoie

Feed

Depuis

3.1.4

Références $c, $name, $this, $type, et $uri.

addEntry()

addEntry

(

FeedEntry

$entry

)

Method to add an entry to the feed object.

Paramètres

FeedEntry

$entry

The entry object to add.

Renvoie

Feed

Depuis

3.1.4

Références $this.

count()

count

(

)

Returns a count of the number of entries in the feed.

This method is here to implement the Countable interface. You can call it by doing count($feed) rather than $feed->count();

Renvoie

integer number of entries in the feed.

offsetExists()

offsetExists

(

$offset

)

Whether or not an offset exists. This method is executed when using isset() or empty() on objects implementing ArrayAccess.

Paramètres

mixed

$offset

An offset to check for.

Renvoie

boolean

Voir également

ArrayAccess::offsetExists()

Depuis

3.1.4

Références Joomla\Database\Query\$offset.

offsetGet()

offsetGet

(

$offset

)

Returns the value at specified offset.

Paramètres

mixed

$offset

The offset to retrieve.

Renvoie

mixed The value at the offset.

Voir également

ArrayAccess::offsetGet()

Depuis

3.1.4

Références Joomla\Database\Query\$offset.

offsetSet()

offsetSet	(		$offset,
			$value
	)

Assigns a value to the specified offset.

Paramètres

mixed	$offset	The offset to assign the value to.
FeedEntry	$value	The JFeedEntry to set.

Renvoie

boolean

Voir également

ArrayAccess::offsetSet()

Depuis

3.1.4

Exceptions

Références Joomla\Database\Query\$offset, $this, et $value.

offsetUnset()

offsetUnset

(

$offset

)

Unsets an offset.

Paramètres

mixed

$offset

The offset to unset.

Renvoie

void

Voir également

ArrayAccess::offsetUnset()

Depuis

3.1.4

Références Joomla\Database\Query\$offset.

removeCategory()

removeCategory

(

$name

)

Method to remove a category from the feed object.

Paramètres

string

$name

The name of the category to remove.

Renvoie

Feed

Depuis

3.1.4

Références $name, et $this.

removeContributor()

removeContributor

(

FeedPerson

$contributor

)

Method to remove a contributor from the feed object.

Paramètres

FeedPerson

$contributor

The person object to remove.

Renvoie

Feed

Depuis

3.1.4

Références $c, et $this.

removeEntry()

removeEntry

(

FeedEntry

$entry

)

Method to remove an entry from the feed object.

Paramètres

FeedEntry

$entry

The entry object to remove.

Renvoie

Feed

Depuis

3.1.4

Références $this.

reverseItems()

reverseItems

(

)

Method to reverse the items if display is set to 'oldest first'

Renvoie

Feed

Depuis

3.1.4

Références $this.

setAuthor()

setAuthor	(		$name,
			$email,
			$uri = null,
			$type = null
	)

Shortcut method to set the author for the feed object.

Paramètres

string	$name	The full name of the person to set.
string	$email	The email address of the person to set.
string	$uri	The optional URI for the person to set.
string	$type	The optional type of person to set.

Renvoie

Feed

Depuis

3.1.4

Références $author, $name, $this, $type, et $uri.

Documentation des champs

$entries

$entries = array()

protected

$properties

$properties

protected

Valeur initiale :

= array(
        'uri' => '',
        'title' => '',
        'updatedDate' => '',
        'description' => '',
        'categories' => array(),
        'contributors' => array(),
    )

---

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

• Feed.php