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 JFeedEntry

Liste de tous les membres

Fonctions membres publiques

 __get ($name)
 __set ($name, $value)
 addCategory ($name, $uri= '')
 addContributor ($name, $email, $uri=null, $type=null)
 addLink (JFeedLink $link)
 removeCategory ($name)
 removeContributor (JFeedPerson $contributor)
 removeLink (JFeedLink $link)
 setAuthor ($name, $email, $uri=null, $type=null)

Attributs protégés

 $properties

Description détaillée

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

Documentation des fonctions membres

JFeedEntry::__get (   $name)

Magic method to return values for feed entry properties.

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

Définition à la ligne 56 du fichier entry.php.

{
return (isset($this->properties[$name])) ? $this->properties[$name] : null;
}
JFeedEntry::__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 71 du fichier entry.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('JFeedEntry "author" must be of type JFeedPerson. ' . gettype($value) . 'given.');
}
// Validate that any sources that are set are instances of JFeed or null.
if (($name == 'source') && (!($value instanceof JFeed) || ($value === null)))
{
throw new InvalidArgumentException('JFeedEntry "source" must be of type JFeed. ' . gettype($value) . 'given.');
}
// Disallow setting categories, contributors, or links directly.
if (($name == 'categories') || ($name == 'contributors') || ($name == 'links'))
{
throw new InvalidArgumentException('Cannot directly set JFeedEntry property "' . $name . '".');
}
$this->properties[$name] = $value;
}
JFeedEntry::addCategory (   $name,
  $uri = '' 
)

Method to add a category to the feed entry object.

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

Définition à la ligne 110 du fichier entry.php.

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

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

+ Voici le graphe des appelants de cette fonction :

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

Method to add a contributor to the feed entry 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:
JFeedEntry
Depuis:
12.3

Définition à la ligne 129 du fichier entry.php.

{
$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;
}
JFeedEntry::addLink ( JFeedLink  $link)

Method to add a link to the feed entry object.

Paramètres:
JFeedLink$linkThe link object to add.
Renvoie:
JFeedEntry
Depuis:
12.3

Définition à la ligne 157 du fichier entry.php.

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

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

+ Voici le graphe des appelants de cette fonction :

JFeedEntry::removeCategory (   $name)

Method to remove a category from the feed entry object.

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

Définition à la ligne 183 du fichier entry.php.

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

Method to remove a contributor from the feed entry object.

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

Définition à la ligne 199 du fichier entry.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;
}
JFeedEntry::removeLink ( JFeedLink  $link)

Method to remove a link from the feed entry object.

Paramètres:
JFeedLink$linkThe link object to remove.
Renvoie:
JFeedEntry
Depuis:
12.3

Définition à la ligne 225 du fichier entry.php.

{
// If the link exists remove it.
foreach ($this->properties['links'] as $k => $l)
{
if ($l == $link)
{
unset($this->properties['links'][$k]);
$this->properties['links'] = array_values($this->properties['links']);
return $this;
}
}
return $this;
}
JFeedEntry::setAuthor (   $name,
  $email,
  $uri = null,
  $type = null 
)

Shortcut method to set the author for the feed entry 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:
JFeedEntry
Depuis:
12.3

Définition à la ligne 254 du fichier entry.php.

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

Documentation des données membres

JFeedEntry::$properties
protected
Valeur initiale :
array(
'uri' => '',
'title' => '',
'updatedDate' => '',
'content' => '',
'categories' => array(),
'contributors' => array(),
'links' => array()
)

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

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