Class APIFacade

Namespace: JRA\Facades
Located at Facades/APIFacade.php

Methods summary

Namespaces

Classes

Class APIFacade

Methods summary

Parameters

Returns

Returns

Returns

Throws

Throws

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

`public`	# `__construct( JRA\Interfaces\ConfigInterface $pConfig, JRA\Factories\InternalFactory $pInternalFactory )` APIFacade constructor. APIFacade constructor. Parameters `$pConfig` The configuration of the request. `$pInternalFactory` The factory which is used internal for creating objects.
`public boolean\|stdClass`	# `login( )` Login on the website, without depending on an authentication method. Login on the website, without depending on an authentication method. Returns boolean\|stdClass Returns false on failure or json decoded response object as stdClass.
`public boolean\|stdClass`	# `logout( )` Logout on the website, without depending on an authentication method. Logout on the website, without depending on an authentication method. Returns boolean\|stdClass Returns false on failure or json decoded response object as stdClass.
`public JRA\Objects\Response\SessionResponseObject`	# `getSessions( )` Get all active sessions. Get all active sessions. Returns `JRA\Objects\Response\SessionResponseObject` Returns the response in an functionality providing object.
`public`	# `updateProfile( )` Update the own user profile. Update the own user profile. Throws `JRA\Exceptions\UserAPIException` This functionality is not supported yet.
`public`	# `updateProfileById( )` Update user profile of other users by id. Update user profile of other users by id. Throws `JRA\Exceptions\UserAPIException` This functionality is not supported yet.
`public JRA\Objects\Response\CategoryListResponseObject`	# `getAllCategories( )` Get all categories from joomla. Get all categories from joomla. Returns `JRA\Objects\Response\CategoryListResponseObject` Returns the response in an functionality providing object.
`public JRA\Objects\Response\CategoryListResponseObject`	# `getAllSubCategoriesByParentId( integer $pId )` Get all categories which are a subcategory an parent category, which is selected by id. Get all categories which are a subcategory an parent category, which is selected by id. Parameters `$pId` The parent id if for selecting all child categories. Returns `JRA\Objects\Response\CategoryListResponseObject` Returns the response in an functionality providing object.
`public JRA\Objects\Response\ContentListResponseObject`	# `getAllContents( )` Get all content from joomla. Get all content from joomla. Returns `JRA\Objects\Response\ContentListResponseObject` Returns the response in an functionality providing object.
`public JRA\Objects\Response\CategoryFieldsResponseObject`	# `getAllCategoryFields( )` Get all database fields with the field configuration from an category. Get all database fields with the field configuration from an category. Returns `JRA\Objects\Response\CategoryFieldsResponseObject` Returns the response in an functionality providing object.
`public JRA\Objects\Response\ContentListResponseObject`	# `getAllContentsByCategoryId( integer $pId )` Get all content which is under one category by id. Get all content which is under one category by id. Parameters `$pId` The category id for selecting all contents under this category. Returns `JRA\Objects\Response\ContentListResponseObject` Returns the response in an functionality providing object.
`public JRA\Objects\Response\CategoryListResponseObject`	# `getCategoryById( integer $pId )` Get an single category by id. Get an single category by id. Parameters `$pId` The category id to select this record. Returns `JRA\Objects\Response\CategoryListResponseObject` Returns the response in an functionality providing object.
`public JRA\Objects\Response\ContentFieldsResponseObject`	# `getAllContentFields( )` Get all database fields with the field configuration from an content. Get all database fields with the field configuration from an content. Returns `JRA\Objects\Response\ContentFieldsResponseObject` Returns the response in an functionality providing object.
`public JRA\Objects\Response\ContentResponseObject`	# `deleteContentById( integer $pId )` Delete an content by id. Delete an content by id. Parameters `$pId` The content id to delete this record. Returns `JRA\Objects\Response\ContentResponseObject` Returns the response in an functionality providing object.
`public JRA\Objects\Response\ContentResponseObject`	# `getContentById( integer $pId )` Get an single content by id. Get an single content by id. Parameters `$pId` The content id to select this record. Returns `JRA\Objects\Response\ContentResponseObject` Returns the response in an functionality providing object.
`public JRA\Objects\Response\MsgResponseObject`	# `createContent( JRA\Objects\CreateContentObject $pContent )` Create an content from an create content object. Create an content from an create content object. Parameters `$pContent` The object with all information in it to create a content. Returns `JRA\Objects\Response\MsgResponseObject` Returns the response in an functionality providing object.
`public JRA\Objects\Response\MsgResponseObject`	# `updateContentById( JRA\Objects\UpdateContentObject $pContent, integer $pId )` Update an content by an update content object. The id for updating the right content is inside the update content object. Update an content by an update content object. The id for updating the right content is inside the update content object. Parameters `$pContent` The object with all information in it to update a content. `$pId` The content id of the content which should be updated. Returns `JRA\Objects\Response\MsgResponseObject` Returns the response in an functionality providing object.
`public JRA\Objects\Response\JResponseObject`	# `loginToken( string $pToken )` Make an login request with an token. Make an login request with an token. Parameters `$pToken` The token for login at the cAPI. Returns `JRA\Objects\Response\JResponseObject` Returns the response in an functionality providing object.
`public JRA\Objects\Response\UserLoginResponseObject`	# `loginUserCredentials( string $pUsername, string $pPassword )` Login with the user credentials. Login with the user credentials. Parameters `$pUsername` The username which is used to login at the cAPI. `$pPassword` The password which is used to login at the cAPI. Returns `JRA\Objects\Response\UserLoginResponseObject` Returns the response in an functionality providing object.
`public JRA\Objects\Response\UserLogoutResponseObject`	# `logoutUserSession( string $pUsername, string $pSession )` Logout an specified user session. Logout an specified user session. Parameters `$pUsername` The username which is used to get the correct session. `$pSession` The password which is used to get the correct session. Returns `JRA\Objects\Response\UserLogoutResponseObject` Returns the response in an functionality providing object.
`public JRA\Objects\Response\UserLogoutResponseObject`	# `getCurrentUser( )` Get the current logged in user. Get the current logged in user. Returns `JRA\Objects\Response\UserLogoutResponseObject` Returns the response in an functionality providing object.