Skip to content

Serialization groups

Roadiz CMS uses symfony/serializer to perform JSON serialization over any objects, especially Doctrine entities.

GroupDescription
idSerialize every entity id.
timestampsSerialize every date-timed entity createdAt and updatedAt fields.
positionSerialize every entity position fields.
colorSerialize every entity color fields.
nodes_sourcesSerialize entities in a NodesSources context (all fields).
nodes_sources_baseSerialize entities in a NodesSources context, but with essential information.
nodes_sources_documentsSerialize documents linked to a NodesSources for each virtual field.
nodes_sources_defaultSerialize NodesSources fields not contained in any group.
nodes_sources_groupCustom serialization groups are created according to your node-type fields groups.
For example, if you set a field to a link group, nodes_sources_link serialization group will be automatically generated for this field.
Be careful, Roadiz will use groups canonical names to generate serialization groups, it can mix _ and -.
nodeSerialize entities in a Node context.
node_childrenSerialize Nodes with their children.
node_attributesSerialize Nodes with their attribute values.
node_listingSerialize Nodes and NodesSources with their listing children options.
Adds listingSortOptions field to node-sources, with for example { "node.position": "ASC" } to be able to fetch children nodes in a the same order as in the back-office.
If the current serialized node-source parent is hiding its children, listingSortOptions will be contain parent's listingSortOptions instead.
tagSerialize Tag.
tag_baseSerialize Tags with minimum information.
tag_parentSerialize Tags with their parent.
tag_childrenSerialize Tags with their children, do not use with tag_parent group.
tag_documentsSerialize Tags with their documents.
tag_colorSerialize Tags with their color field.
tag_children_orderSerialize Tags with their children_order fields.
node_typeSerialize entities in a NodeType context.
attributeSerialize entities in a Attribute context.
attribute_documentsSerialize documents linked to a Attribute for each virtual field.
custom_formSerialize entities in a CustomForm context.
documentSerialize entities in a Document context.
document_displaySerialize Document information required for displaying them.
document_privateSerialize Document privacy information.
document_display_sourcesSerialize Document information required for displaying alternative sources (audio, video).
document_thumbnailsSerialize Document first available thumbnail.
document_raw_relative_pathSerialize rawRelativePath when document has a RAW version and make it downloadable
document_foldersSerialize Document information required for displaying attached visible folders.
document_folders_allSerialize all Document attached folders, even not visible ones.
folderSerialize entities in a Folder context.
translationSerialize entities in a Translation context.
translation_baseSerialize Translation information required for displaying them.
settingSerialize entities in a Setting context.
setting_groupSerialize entities in a SettingGroup context.
userSerialize entities in a User context.
user_groupSerialize User entity with its groups.
user_roleSerialize User entity with its roles.
user_personalSerialize User entity with its personal information.
user_identifierSerialize User entity with its identifier (may be a personal information).