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 JObject
+ Graphe d'héritage de JObject:

Liste de tous les membres

Fonctions membres publiques

 __construct ($properties=null)
 __toString ()
 def ($property, $default=null)
 get ($property, $default=null)
 getProperties ($public=true)
 getError ($i=null, $toString=true)
 getErrors ()
 set ($property, $value=null)
 setProperties ($properties)
 setError ($error)

Attributs protégés

 $_errors = array()

Description détaillée

Définition à la ligne 22 du fichier object.php.

Documentation des constructeurs et destructeur

JObject::__construct (   $properties = null)

Class constructor, overridden in descendant classes.

Paramètres:
mixed$propertiesEither and associative array or another object to set the initial properties of the object.
Depuis:
11.1

Réimplémentée dans JControllerLegacy, JUser, JModelLegacy, JViewLegacy, JModelAdmin, JModelList, JControllerForm, et JControllerAdmin.

Définition à la ligne 42 du fichier object.php.

{
if ($properties !== null)
{
$this->setProperties($properties);
}
}

Documentation des fonctions membres

JObject::__toString ( )

Magic method to convert the object to a string gracefully.

Renvoie:
string The classname.
Depuis:
11.1
Obsolète:
12.3 Classes should provide their own __toString() implementation.

Définition à la ligne 58 du fichier object.php.

{
return get_class($this);
}
JObject::def (   $property,
  $default = null 
)

Sets a default value if not alreay assigned

Paramètres:
string$propertyThe name of the property.
mixed$defaultThe default value.
Renvoie:
mixed
Depuis:
11.1

Définition à la ligne 73 du fichier object.php.

{
$value = $this->get($property, $default);
return $this->set($property, $value);
}
JObject::get (   $property,
  $default = null 
)

Returns a property of the object or the default value if the property is not set.

Paramètres:
string$propertyThe name of the property.
mixed$defaultThe default value.
Renvoie:
mixed The value of the property.
Depuis:
11.1
Voir également:
JObject::getProperties()

Réimplémentée dans JViewLegacy.

Définition à la ligne 91 du fichier object.php.

{
if (isset($this->$property))
{
return $this->$property;
}
return $default;
}
JObject::getError (   $i = null,
  $toString = true 
)

Get the most recent error message.

Paramètres:
integer$iOption error index.
boolean$toStringIndicates if JError objects should return their error message.
Renvoie:
string Error message
Depuis:
11.1
Voir également:
JError
Obsolète:
12.3 JError has been deprecated

Définition à la ligne 140 du fichier object.php.

Référencé par JControllerForm\loadhistory(), et JControllerForm\save().

{
// Find the error
if ($i === null)
{
// Default, return the last message
$error = end($this->_errors);
}
elseif (!array_key_exists($i, $this->_errors))
{
// If $i has been specified but does not exist, return false
return false;
}
else
{
$error = $this->_errors[$i];
}
// Check if only the string is requested
if ($error instanceof Exception && $toString)
{
return (string) $error;
}
return $error;
}

+ Voici le graphe des appelants de cette fonction :

JObject::getErrors ( )

Return all errors, if any.

Renvoie:
array Array of error messages or JErrors.
Depuis:
11.1
Voir également:
JError
Obsolète:
12.3 JError has been deprecated

Définition à la ligne 176 du fichier object.php.

Référencé par JControllerForm\save().

{
return $this->_errors;
}

+ Voici le graphe des appelants de cette fonction :

JObject::getProperties (   $public = true)

Returns an associative array of object properties.

Paramètres:
boolean$publicIf true, returns only the public properties.
Renvoie:
array
Depuis:
11.1
Voir également:
JObject::get()

Définition à la ligne 111 du fichier object.php.

{
$vars = get_object_vars($this);
if ($public)
{
foreach ($vars as $key => $value)
{
if ('_' == substr($key, 0, 1))
{
unset($vars[$key]);
}
}
}
return $vars;
}
JObject::set (   $property,
  $value = null 
)

Modifies a property of the object, creating it if it does not already exist.

Paramètres:
string$propertyThe name of the property.
mixed$valueThe value of the property to set.
Renvoie:
mixed Previous value of the property.
Depuis:
11.1

Définition à la ligne 191 du fichier object.php.

Référencé par JAccessRules\getAllowed().

{
$previous = isset($this->$property) ? $this->$property : null;
$this->$property = $value;
return $previous;
}

+ Voici le graphe des appelants de cette fonction :

JObject::setError (   $error)

Add an error message.

Paramètres:
string$errorError message.
Renvoie:
void
Depuis:
11.1
Voir également:
JError
Obsolète:
12.3 JError has been deprecated

Définition à la ligne 235 du fichier object.php.

{
array_push($this->_errors, $error);
}
JObject::setProperties (   $properties)

Set the object properties based on a named array/hash.

Paramètres:
mixed$propertiesEither an associative array or another object.
Renvoie:
boolean
Depuis:
11.1
Voir également:
JObject::set()

Définition à la ligne 209 du fichier object.php.

Référencé par JCategoryNode\__construct().

{
if (is_array($properties) || is_object($properties))
{
foreach ((array) $properties as $k => $v)
{
// Use the set function which might be overridden.
$this->set($k, $v);
}
return true;
}
return false;
}

+ Voici le graphe des appelants de cette fonction :

Documentation des données membres

JObject::$_errors = array()
protected

Définition à la ligne 32 du fichier object.php.

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