Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
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$nameThe name of the property.
Renvoie
mixed
Depuis
12.3

Références $name, et null.

◆ __set()

__set (   $name,
  $value 
)

Magic method to set values for feed properties.

Paramètres
string$nameThe name of the property.
mixed$valueThe value to set for the property.
Renvoie
void
Depuis
12.3

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

◆ addCategory()

addCategory (   $name,
  $uri = '' 
)

Method to add a category to the feed object.

Paramètres
string$nameThe name of the category to add.
string$uriThe optional URI for the category to add.
Renvoie
Feed
Depuis
12.3

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

◆ addContributor()

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

Method to add a contributor to the feed object.

Paramètres
string$nameThe full name of the person to add.
string$emailThe email address of the person to add.
string$uriThe optional URI for the person to add.
string$typeThe optional type of person to add.
Renvoie
Feed
Depuis
12.3

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

◆ addEntry()

addEntry ( FeedEntry  $entry)

Method to add an entry to the feed object.

Paramètres
FeedEntry$entryThe entry object to add.
Renvoie
Feed
Depuis
12.3

◆ 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$offsetAn offset to check for.
Renvoie
boolean
Voir également
ArrayAccess::offsetExists()
Depuis
12.3

Références $offset.

◆ offsetGet()

offsetGet (   $offset)

Returns the value at specified offset.

Paramètres
mixed$offsetThe offset to retrieve.
Renvoie
mixed The value at the offset.
Voir également
ArrayAccess::offsetGet()
Depuis
12.3

Références $offset.

◆ offsetSet()

offsetSet (   $offset,
  $value 
)

Assigns a value to the specified offset.

Paramètres
mixed$offsetThe offset to assign the value to.
FeedEntry$valueThe JFeedEntry to set.
Renvoie
boolean
Voir également
ArrayAccess::offsetSet()
Depuis
12.3
Exceptions

Références $offset, et $value.

◆ offsetUnset()

offsetUnset (   $offset)

Unsets an offset.

Paramètres
mixed$offsetThe offset to unset.
Renvoie
void
Voir également
ArrayAccess::offsetUnset()
Depuis
12.3

Références $offset.

◆ removeCategory()

removeCategory (   $name)

Method to remove a category from the feed object.

Paramètres
string$nameThe name of the category to remove.
Renvoie
Feed
Depuis
12.3

Références $name.

◆ removeContributor()

removeContributor ( FeedPerson  $contributor)

Method to remove a contributor from the feed object.

Paramètres
FeedPerson$contributorThe person object to remove.
Renvoie
Feed
Depuis
12.3

◆ removeEntry()

removeEntry ( FeedEntry  $entry)

Method to remove an entry from the feed object.

Paramètres
FeedEntry$entryThe entry object to remove.
Renvoie
Feed
Depuis
12.3

◆ reverseItems()

reverseItems ( )

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

Renvoie
Feed
Depuis
12.3

◆ setAuthor()

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

Shortcut method to set the author for the feed object.

Paramètres
string$nameThe full name of the person to set.
string$emailThe email address of the person to set.
string$uriThe optional URI for the person to set.
string$typeThe optional type of person to set.
Renvoie
Feed
Depuis
12.3

Références $author, $name, $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 :