Joomla Platform  13.1
Documentation des API du framework Joomla Platform
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Fonctions membres publiques | Attributs protégés
Référence de la classe JFeed

Liste de tous les membres

Fonctions membres publiques

 __get ($name)
 __set ($name, $value)
 addCategory ($name, $uri= '')
 addContributor ($name, $email, $uri=null, $type=null)
 addEntry (JFeedEntry $entry)
 offsetExists ($offset)
 offsetGet ($offset)
 offsetSet ($offset, $value)
 offsetUnset ($offset)
 removeCategory ($name)
 removeContributor (JFeedPerson $contributor)
 removeEntry (JFeedEntry $entry)
 setAuthor ($name, $email, $uri=null, $type=null)

Attributs protégés

 $properties
 $entries = array()

Description détaillée

Définition à la ligne 31 du fichier feed.php.

Documentation des fonctions membres

JFeed::__get (   $name)

Magic method to return values for feed properties.

Paramètres:
string$nameThe name of the property.
Renvoie:
mixed
Depuis:
12.3

Définition à la ligne 61 du fichier feed.php.

{
return isset($this->properties[$name]) ? $this->properties[$name] : null;
}
JFeed::__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

Définition à la ligne 76 du fichier feed.php.

{
// Ensure that setting a date always sets a JDate instance.
if ((($name == 'updatedDate') || ($name == 'publishedDate')) && !($value instanceof JDate))
{
$value = new JDate($value);
}
// Validate that any authors that are set are instances of JFeedPerson or null.
if (($name == 'author') && (!($value instanceof JFeedPerson) || ($value === null)))
{
throw new InvalidArgumentException('JFeed "author" must be of type JFeedPerson. ' . gettype($value) . 'given.');
}
// Disallow setting categories or contributors directly.
if (($name == 'categories') || ($name == 'contributors'))
{
throw new InvalidArgumentException('Cannot directly set JFeed property "' . $name . '".');
}
$this->properties[$name] = $value;
}
JFeed::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:
JFeed
Depuis:
12.3

Définition à la ligne 109 du fichier feed.php.

Référencé par JFeedParserRss\handleCategory().

{
$this->properties['categories'][$name] = $uri;
return $this;
}

+ Voici le graphe des appelants de cette fonction :

JFeed::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:
JFeed
Depuis:
12.3

Définition à la ligne 128 du fichier feed.php.

Référencé par JFeedParserAtom\handleContributor(), et JFeedParserRss\handleWebmaster().

{
$contributor = new JFeedPerson($name, $email, $uri, $type);
// If the new contributor already exists then there is nothing to do, so just return.
foreach ($this->properties['contributors'] as $c)
{
if ($c == $contributor)
{
return $this;
}
}
// Add the new contributor.
$this->properties['contributors'][] = $contributor;
return $this;
}

+ Voici le graphe des appelants de cette fonction :

JFeed::addEntry ( JFeedEntry  $entry)

Method to add an entry to the feed object.

Paramètres:
JFeedEntry$entryThe entry object to add.
Renvoie:
JFeed
Depuis:
12.3

Définition à la ligne 156 du fichier feed.php.

Référencé par JFeedParser\processElement().

{
// If the new entry already exists then there is nothing to do, so just return.
foreach ($this->entries as $e)
{
if ($e == $entry)
{
return $this;
}
}
// Add the new entry.
$this->entries[] = $entry;
return $this;
}

+ Voici le graphe des appelants de cette fonction :

JFeed::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

Définition à la ligne 184 du fichier feed.php.

{
return isset($this->entries[$offset]);
}
JFeed::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

Définition à la ligne 199 du fichier feed.php.

{
return $this->entries[$offset];
}
JFeed::offsetSet (   $offset,
  $value 
)

Assigns a value to the specified offset.

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

Définition à la ligne 216 du fichier feed.php.

{
if (!($value instanceof JFeedEntry))
{
throw new InvalidArgumentException('Cannot set value of type "' . gettype($value) . '".');
}
$this->entries[$offset] = $value;
return true;
}
JFeed::offsetUnset (   $offset)

Unsets an offset.

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

Définition à la ligne 238 du fichier feed.php.

{
unset($this->entries[$offset]);
}
JFeed::removeCategory (   $name)

Method to remove a category from the feed object.

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

Définition à la ligne 252 du fichier feed.php.

{
unset($this->properties['categories'][$name]);
return $this;
}
JFeed::removeContributor ( JFeedPerson  $contributor)

Method to remove a contributor from the feed object.

Paramètres:
JFeedPerson$contributorThe person object to remove.
Renvoie:
JFeed
Depuis:
12.3

Définition à la ligne 268 du fichier feed.php.

{
// If the contributor exists remove it.
foreach ($this->properties['contributors'] as $k => $c)
{
if ($c == $contributor)
{
unset($this->properties['contributors'][$k]);
$this->properties['contributors'] = array_values($this->properties['contributors']);
return $this;
}
}
return $this;
}
JFeed::removeEntry ( JFeedEntry  $entry)

Method to remove an entry from the feed object.

Paramètres:
JFeedEntry$entryThe entry object to remove.
Renvoie:
JFeed
Depuis:
12.3

Définition à la ligne 294 du fichier feed.php.

{
// If the entry exists remove it.
foreach ($this->entries as $k => $e)
{
if ($e == $entry)
{
unset($this->entries[$k]);
$this->entries = array_values($this->entries);
return $this;
}
}
return $this;
}
JFeed::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:
JFeed
Depuis:
12.3

Définition à la ligne 323 du fichier feed.php.

Référencé par JFeedParserAtom\handleAuthor().

{
$author = new JFeedPerson($name, $email, $uri, $type);
$this->properties['author'] = $author;
return $this;
}

+ Voici le graphe des appelants de cette fonction :

Documentation des données membres

JFeed::$entries = array()
protected

Définition à la ligne 50 du fichier feed.php.

JFeed::$properties
protected
Valeur initiale :
array(
'uri' => '',
'title' => '',
'updatedDate' => '',
'description' => '',
'categories' => array(),
'contributors' => array()
)

Définition à la ligne 37 du fichier feed.php.

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