ezcontentobject
Date de publication: le jeudi 31 mars 2011 à 17h03
Dernière modification: par Pascal BOYER le jeudi 31 mars 2011 à 17h03
versions 3.9, 3.10, 4.x
Summary / Résumé
Contains information about a content object.
Contient des informations sur l'objet de contenu.
Persistent / Persistant
Yes / Oui
Attributes / Attributs
|
Attribute Attribut | Type | Static* | Description |
|---|---|---|---|
| id |
string chaîne de caractères |
Yes Oui |
The ID number of the object. Le numéro de ID de l'objet. |
| section_id |
string chaîne de caractères |
Yes Oui |
The ID number of the section that the object belongs to. Le numéro de ID de la section à laquelle appartient l'objet. |
| owner_id |
string chaîne de caractères |
Yes Oui |
The ID number of the object representing the user who initially created the object. Le numéro de ID de l'objet représentant l'utilisateur qui a initialement créé l'objet. |
| contentclass_id |
string chaîne de caractères |
Yes Oui |
The ID number of the content class which the object is an instance of. Le numéro de ID de la mcasse de contenu dont l'objet est une instance. |
| is_published |
string chaîne de caractères |
Yes Oui |
Either 1 or 0. 1 means that the object has been published. 0 means that the object has not yet been published. 1 ou 0. 1 signifie que l'objet a été publié alors que 0 signifie qu'il ne l'a pas encore été. |
| published |
string chaîne de caractères |
Yes Oui |
A UNIX timestamp pinpointing the exact date/time when the object was published for the first time. Un temps UNIX indiquant exactement la date et l'heure de première publication de l'objet. |
| modified |
string chaîne de caractères |
Yes Oui |
A UNIX timestamp pinpointing the exact date/time when the object was last modified. Un temps UNIX indiquant exactement la date et l'heure de la dernière modification apportée à l'objet. |
| current_version |
string chaîne de caractères |
Yes Oui |
The number of the currently published version. Le numéro de la version actuellement publiée. |
| status |
string chaîne de caractères |
Yes Oui |
The status of the object (0=Draft, 1=Published, 2=Archived). Le statut de l'objet (0=brouillon, 1=publié, 2=archivé) |
| remote_id |
string chaîne de caractères |
Yes Oui |
A global unique ID for the object. The remote ID is an MD5 hash of the time when the object was created plus a random value. Remote IDs are used in order to avoid collisions of identical objects during an import. Un numero de ID global unique pour l'objet. Le ID distant est le code crypté par l'algorithme de hachage MD5 du temps depuis lequel l'objet est créé incrémenté d'une valeur alléatoire. Les ID distants sont utilisés pour prévenir les collisions d'objets identiques au cours d'une importation. |
| language_mask |
string chaîne de caractères |
Yes Oui |
The sum of the ID numbers of the languages in which the last published version of the object exists. Please note that the ID numbers are powers of 2. 1 (2^0) is reserved for marking objects that should always be available. Objects that are always available will be fetched even if they do not exist in any of the site/prioritized languages (the initial/main language of the object will be used). La somme des numéros de ID des langues dans lesquelles existe la dernière version publiée d'un objet. Retenez que les numéros de ID sont des puissances de 2. 1 (2^0) est réservé au marquage des objets toujours disponibles. Ces objets seront recherchés même s'ils n'existent dans aucun des sites ou dans aucune des langues prioritaires (la langue initiale/principale de l'objet sera utilsée). |
| initial_language_id |
string chaîne de caractères |
Yes Oui |
The ID number of the initial/main language. Le numéro de ID de la langue initiale/principale. |
| current |
object objet |
No Non |
The current version (as ezcontentobjectversion ) of the object. La version courante (en tant que ezcontentobjectversion ) de l'objet. |
| versions |
array tableau |
No Non |
The object's versions (as ezcontentobjectversion objects). Les versions de l'objet (en tant qu'objets ezcontentobjectversion ). |
| author_array |
array tableau |
No Non |
Array of ezuser objects representing the different creators of the content object's versions. Un tableau d'objets ezuser représentant les différents créateurs des versions du contenu d'un objet. |
| class_name |
string chaîne de caractères |
No Non |
The name of the class which the content object is an instance of (for example "Consumer product"). Le nom de la classe dont l'objet est une instance (par exemple Consumer product). |
| content_class |
object objet |
No Non |
The content class (as ezcontentclass) which the content object is an instance of. La classe de contenu (en tant que ezcontentclass ) dont l'objet de contenu est une instance. |
| contentobject_attributes |
array tableau |
No Non |
Array of ezcontentobjectattribute objects representing the attributes of the content object. Un tableau d'objets ezcontentobjectattribute représentant les attributs de l'objet de contenu. |
| owner |
object objet |
No Non |
An ezcontentobject that represents the user who initially created the object. Un objet ezcontentobject représentant l'utilisateur ayant initialement créé l'objet. |
| related_contentobject_array |
array tableau |
No Non |
An array of ezcontentobject objects that are related to this object. This attribute is deprecated. It is recommended to use the related_objects fetch function instead. Un tableau d'objets ezcontentobject liés à cet objet. Cet attribut étant déprécié il est recommandé d'utiliser à sa place la fonction de recherche related_objects . |
| related_contentobject_count |
string chaîne de caractères |
No Non |
The number of objects that are related to this object. This attribute is deprecated. It is recommended to use the related_objects_count fetch function instead. Le nombre d'objets liés à cet objet. Cet attribut étant déprécié il est recommandé d'utiliser à sa place la fonction de recherche related_objects_count . |
| reverse_related_contentobject_array |
array tableau |
No Non | An array of ezcontentobject objects that make use of this object (reverse relations). This attribute is deprecated. It is recommended to use the reverse_related_objects fetch function instead.Un tableau d'objets ezcontentobject qui utilisent cet objet (relations inverses). Cet attribut étant déprécié il est recommandé d'utiliser à sa place la fonction de recherche reverse_related_objects . |
| reverse_related_contentobject_count |
string chaîne de caractères |
No Non |
The number of objects that are using this object. This attribute is deprecated. It is recommended to use the reverse_related_objects_count fetch function instead. Le nombre d'objets qui utilisent cet objet. Cet attribut étant déprécié il est recommandé d'utiliser à sa place la fonction de recherche reverse_related_objects_count . |
| linked_contentobject_array |
array tableau |
No Non | An array of ezcontentobject objects that are related to this object by means of the XML linked object relation.Un tableau d'objets ezcontentobject liés à cet objet au moyen d'une relation d'objet de type XML linked . |
| linked_contentobject_count |
string chaîne de caractères |
No Non |
The number of objects that are related to this object by means of the "XML linked" object relation. Le nombre d'objets liés à cet objet au moyen d'une relation d'objet de type XML linked. |
| reverse_linked_contentobject_array |
array tableau |
No Non |
An array of ezcontentobject objects that make use of this object by means of the XML linked object relation. Un tableau d'objets ezcontentobject utilisant cet objet au moyen d'une relation d'objet de type XML linked . |
| reverse_linked_contentobject_count |
string chaîne de caractères |
No Non |
The number of objects that are using this object by means of the XML linked object relation. Le nombre d'objets utilisant cet objet au moyen d'une relation d'objet de type XML linked . |
| embedded_contentobject_array |
array tableau |
No Non |
An array of ezcontentobject objects that are related to this object by means of the XML embedded object relation. Un tableau d'objets ezcontentobject liés à cet objet au moyen d'une relation d'objet de type XML embedded . |
| embedded_contentobject_count |
string chaîne de caractères |
No Non |
The number of objects that are related to this object by means of the "XML embedded" object relation. Le nombre d'objets liés à cet objet au moyen d'une relation de type XML embedded . |
| reverse_embedded_contentobject_array |
array tableau |
No Non |
An array of ezcontentobject objects that make use of this object by means of the XML embedded object relation. Un tableau d'objets ezcontentobject utilisant cet objet au moyen d'une relation de type XML embedded . |
| reverse_embedded_contentobject_count |
string chaîne de caractères |
No Non |
The number of objects that are using this object by means of the XML embedded object relation. Le nombre d'objets utilisant cet objet au moyen d'une relation de type XML embedded . |
| can_read |
boolean booléen |
No Non |
Returns TRUE if the current user has read access to the object, FALSE otherwise. Renvoie TRUE si l'utilisateur courant a des droits d'accès en lecture sur l'objet, sinon FALSE. |
| can_pdf |
boolean booléen |
No Non |
Not documented yet. Pas encore documenté. |
| can_diff |
boolean booléen |
No Non |
Not documented yet. Pas encore documenté. |
| can_create |
boolean booléen |
No Non |
Not documented yet. Pas encore documenté. |
| can_create_class_list |
array tableau |
No Non |
Not documented yet. Pas encore documenté. |
| can_edit |
boolean booléen |
No Non |
Returns TRUE if the current user has edit access to the object, FALSE otherwise. Renvoie TRUE si l'utilisateur courant a des droits d'accès d'édition sur l'objet, sinon FALSE. |
| can_translate |
boolean booléen |
No Non |
Returns TRUE if the current user has permissions to translate the contents of the object, FALSE otherwise. Renvoie TRUE si l'utilisateur courant a la permission de traduire le contenu de l'objet, sinon FALSE. |
| can_remove |
boolean booléen |
No Non |
Returns TRUE if the current user has permissions to remove the object, FALSE otherwise. Renvoie TRUE si l'utilisateur courant a la permission de supprimer l'objet, sinon FALSE. |
| can_move |
boolean booléen |
No Non |
Not documented yet. Pas encore documenté. |
| can_move_from |
boolean booléen |
No Non |
Returns TRUE if the current user has permissions to move the main node of the object, FALSE otherwise. Renvoie TRUE si l'utilisateur courant a la permission de modifier le noeud principal de l'objet, sinon FALSE. |
| can_view_embed |
boolean booléen |
No Non |
Not documented yet. Pas encore documenté. |
| data_map |
array tableau |
No Non |
Array of ezcontentobjectattribute objects representing the actual attributes of the content object. Un tableau d'objets ezcontentobjectattribute représentant les vrais attributs du contenu de l'objet. |
| main_parent_node_id |
string chaîne de caractères |
No Non |
The ID number of the main node of the object encapsulated by the parent node. Le numéro de ID du noeud principal de l'objet encapsulé par le noeud parent. |
| assigned_nodes |
array tableau |
No Non |
Array of nodes (as ezcontentobjecttreenode objects) that encapsulate the object. Tableau des noeuds (en tant qu'objets ezcontentobjecttreenode ) qui encapsulent l'objet. |
| parent_nodes |
array tableau |
No Non |
An array of ID numbers of the parent nodes (as strings). Un tableau des numéros de ID des noeuds parents (en tant que chaînes de caractères). |
| main_node_id |
string chaîne de caractères |
No Non |
The ID number of the object's main node. Le numéro de ID du noeud principal de l'objet. |
| main_node |
object objet |
No Non |
The object's main node (as ezcontentobjecttreenode). Le noeud principal de l'objet (en tant que ezcontentobjecttreenode ). |
| default_language |
string chaîne de caractères |
No Non |
The default language for content objects (see ContentObjectLocale ) if it is set or the most prioritized language (i.e. the first element of the SiteLanguageList array). La langue par défaut des objets de contenus (voir ContentObjectLocale ) si elle est paramétrée ou la langue de plus haute priorité (i.e. le premier élément du tableau SiteLanguageList ). |
| content_action_list |
array tableau |
No Non |
An array of hashes revealing information about the content actions that can be performed on the object. The keys "name" and "action" contain the actual name (for example "Add to basket" - which should be value of the HTML input tag) and the action itself (for example "ActionAddToBasket" - which should be the name of the HTML input tag). The array is generated by a function that examines the object's attributes. If a datatype used to represent an attribute provides support for content actions or if the attribute is an information collector, the supported actions will be added to the "content_action_list" array. This array can be used to automatically generate action buttons (standard HTML buttons) for content objects that either make use of special datatypes or have attributes that are marked as information collectors. Un tableau des hash révélant des informations sur les actions de contenus pouvant être appliquées à l'objet. Les clefs name (nom) et action contiennent le vrai nom (par exemple Ajouter au panier - qui devrait être la valeur dans la balise d'entrée HTML) et l'action elle-même (par exemple ActionAddToBasket qui devrait être le nom de la balise d'entrée HTML). Le tableau est généré par une fonction qui examine les attributs de l'objets. Si un datatype utilisé pour représenter un attribut fournit le support des actions de contenu ou si l'attribut est collecteur d'information, l'action supportée sera ajoutée au tableau content_action_list. Ce tableau peut- être utilisé pour générer automatiquement des boutons d'action (boutons HTML standards) pour les objets de contenus utilisant des datatypes spéciaux ou ayant des attributs collecteurs d'information. |
| class_identifier |
string chaîne de caractères |
No Non |
The identifier of the class which the object is an instance of (for example "consumer_product"). L'identifiant de la classe dont l'objet est une instance (par exemple consumer_product). |
| class_group_id_list |
array tableau |
No Non |
An array of ID numbers of the class groups which the class (that the object is an instance of) belongs to. Un tableau de numéros de ID des groupes de classes auxquels la classe (dont l'objet est une instance) appartient. |
| name |
string chaîne de caractères |
No Non |
The actual name of the object in the current language (for example "Liver sandwich"). Le vrai nom de l'objet dans la langue courante (par exemple Sandwich au foie). |
| match_ingroup_id_list |
array tableau |
No Non |
The ID numbers of the class groups that the class (which the object is an instance of) belongs to. This variable is connected with a feature that makes it possible to create template overrides based on class groups.
By default the "match_ingroup_id_list" always returns a boolean FALSE value because the class group override feature is turned off. It can be turned on by setting the "EnableClassGroupOverride" directive in the [ContentOverrideSettings] block of a configuration override for "content.ini" to "true". |
| current_language |
string chaîne de caractères |
No Non |
Not documented yet. Pas encore documenté. |
| current_language_object |
object objet |
No Non |
Not documented yet. Pas encore documenté. |
| initial_language |
object objet |
No Non |
The initial/main language as a ezcontentlanguage object. La langue initiale/principale en tant qu'objet ezcontentlanguage . |
| initial_language_code |
string chaîne de caractères |
No Non |
The code of the initial/main language (for example "eng-GB"). Le code de la langue initiale/principale (par exemple eng-GB). |
| available_languages |
array tableau |
No Non |
The languages in which the last published version of the object exists (as an array of locale codes). Les langues dans lesquelles existe la dernière version publiée de l'objet (en tant que tableau de codes de locales). |
| language_codes |
array tableau |
No Non |
Not documented yet. Pas encore documenté. |
| language_js_array |
string chaîne de caractères |
No Non |
Not documented yet. Pas encore documenté. |
| languages |
array tableau |
No Non |
The list of languages the object exists in, ordered by their priority (as an array of ezcontentlanguage objects). La liste des langues, triées en fonction de leur priorité, dans lesquelles l'objet existe (en tant que tableau d'objets ezcontentlanguage ). |
| can_edit_languages |
array tableau |
No Non |
Not documented yet. Pas encore documenté. |
| can_create_languages |
array tableau |
No Non |
Not documented yet. Pas encore documenté. |
| always_available |
boolean booléen |
No Non |
Returns TRUE if the object is marked as always available (i.e. the object will be fetched even if it does not exist in any of the site languages), FALSE otherwise. Renvoie TRUE si l'objet est marqué comme toujours disponible (i.e l'objet sera recherché même s'il n'existe dans aucune des langues du site), sinon FALSE. |
* Indicates whether the attribute provides a pre-fetched value or if it needs to be computed upon request.
* Indique si l'attribut fournit une valeur pré-recherchée ou s'il est nécessaire de la calculer à chaque requête.