ContentunitGroup WSDL
ContentunitGroup ModelThis service is stateful.
Examples +
- create
- create
addtop
Deprecated 2011-01-01
This method will be removed in upcoming releases.
Use save() to persist a new entity
Description
Saves changes made to the ContentunitGroup
int add()
Return Values
| int | The ID of the ContentunitGroup (unique) |
clearObjectDatatop
Description
Clears the current object state.
This method will unload possibly loaded objects. Unsaved changes will be lost.
boolean clearObjectData()
Return Values
| boolean |
copytop
Description
Copy a contentunit group
int copy(int $website, boolean $with_units, int $parent, string $with_groups)
Parameters
| int | $website | Website to copy the contentunit group into |
| boolean | $with_units | True to copy also units, otherwise false |
| int | $parent | Parent contentunit group ID or 0 for direct website parent |
| string | $with_groups | Backward compatible string values: empty string or "0" to skip child groups, anything else: copy also child groups |
Return Values
| int | groupId contentunit group copy ID |
doComplexCalltop
Description
Execute a complex call.
For further information read the API-User documentation.
string doComplexCall(string $xmlstr)
Parameters
| string | $xmlstr | XML of Complex Statements |
Return Values
| string | The output produced by the statements |
edittop
Deprecated 2011-01-01
This method will be removed in upcoming releases.
Use save() to persist changes made to an entity
Description
Saves changes made to the ContentunitGroup
boolean edit()
Return Values
| boolean | TRUE on succes, FALSE on fail |
getExternalIdtop
Description
Gets the ContentunitGroup External ID
string getExternalId()
Return Values
| string | $this->externalId |
getIdtop
Description
Gets the ContentunitGroup ID
int getId()
Return Values
| int | $this->id |
getNametop
Description
Gets the ContentunitGroup Name
string getName()
Return Values
| string | $this->name |
getNetworktop
Description
Returns the current network id
int getNetwork()
Return Values
| int | Network ID |
getNetworkIdtop
Description
Gets the ContentunitGroup NetworkId
int getNetworkId()
Return Values
| int | $this->networkId |
getParentIdtop
Description
Gets the ContentunitGroup ParentId
int getParentId()
Return Values
| int | $this->parentId |
getTokentop
Description
Gets the session token. Can be used for single-sign-on.
string getToken()
Return Values
| string |
getUpdatedAttop
Description
Gets the ContentunitGroup updatedAt
string getUpdatedAt()
Return Values
| string | $this->updatetAt |
getUserIdtop
Description
Gets the ContentunitGroup UserId
int getUserId()
Return Values
| int | $this->userId |
getWebsiteIdtop
Description
Gets the ContentunitGroup WebsiteId
int getWebsiteId()
Return Values
| int | $this->websiteId |
loadtop
Description
Load a contentunitgroup
boolean load(int $id)
Parameters
| int | $id |
Return Values
| boolean | True on success, otherwise false |
logintop
Description
Initializes a new session with given information
boolean login(string $user, string $pass, int $network)
Parameters
| string | $user | Username |
| string | $pass | Password |
| int | $network | $network Network ID |
Return Values
| boolean | true on success, false on fail |
loginSmartPhonetop
Deprecated 2014-12-22
This method will be removed in upcoming releases.
Was only useful for the mobile app, which is not supported anymore.
Description
Login method
boolean loginSmartPhone(string $user, string $pass, int $network, string $client)
Parameters
| string | $user | Username |
| string | $pass | Password |
| int | $network | $network Network ID |
| string | $client | Client token e.g. "apn" token of iPhone |
Return Values
| boolean | TRUE on success, FALSE on fail |
logouttop
Description
Destroys the active session, logging out the user.
boolean logout()
Return Values
| boolean | true on success, false on fail |
removetop
Description
Delete a contentunitgroup - no contenunits deleted
boolean remove()
Return Values
| boolean |
removeByIdtop
Description
Removes a ContentunitGroupModel with the given id
boolean removeById(int $id)
Parameters
| int | $id | ID of object to remove. |
Return Values
| boolean |
savetop
Description
Persists current object state
boolean save()
Return Values
| boolean | True on success, otherwise false |
setExternalIdtop
Description
Sets the ContentunitGroup ExternalID
boolean setExternalId(string $external_id)
Parameters
| string | $external_id |
Return Values
| boolean |
setNametop
Description
Sets the ContentunitGroup Name
boolean setName(string $name)
Parameters
| string | $name |
Return Values
| boolean |
setParentIdtop
Description
Sets the ContentunitGroup Parent ID
boolean setParentId(int $parent_id)
Parameters
| int | $parent_id |
Return Values
| boolean |
setWebsiteIdtop
Description
Sets the ContentunitGroup WebsiteID
boolean setWebsiteId(int $website_id)
Parameters
| int | $website_id |
Return Values
| boolean |
validatetop
Description
Validates the object and returns an error stack.
string validate()
Return Values
| string |