Versioning
Handle the versioning of content items
| since |
4.0.0 |
|---|---|
| deprecated |
6.0.0 will be removed in 8.0 without direct replacement, use the new versioning concept (LINK TO DOCUMENTATION) |
| package |
Joomla CMS |
Methods
delete
Method to delete the history for an item.
delete( typeAlias, id) :
| since |
4.0.0 |
|---|
Arguments
- typeAlias
stringTypealias of the component- id
intID of the content item to delete
Response
booltrue on success, otherwise false.
get
Method to get a list of available versions of this item.
get( typeAlias, id) : object||string|int
| since |
4.0.0 |
|---|
Arguments
- typeAlias
stringTypealias of the component- id
intID of the content item to get
Response
array<string|int, object>A list of history items
store
Method to save a version snapshot to the content history table.
store( typeAlias, id, data, note = '') :
| since |
4.0.0 |
|---|
Arguments
- typeAlias
stringTypealias of the content type- id
intID of the content item- data
mixedArray or object of data that can be en- and decoded into JSON- note
stringNote for the version to store
Response
boolTrue on success, otherwise false.