LogicInterface
interface LogicInterface implements PostsLogicInterface, UsersLogicInterface, GroupsLogicInterface, TagsLogicInterface
LogicInterface – main Interface for RESTClient
Methods
No description
Returns details to a post. A post is uniquely identified by a hash of the corresponding resource and a username.
Removes the given post - identified by the connected resource's hash - from the user.
Updates the post(s) in the database.
Adds a document to a post.
Adds a document to a post.
No description
Deletes an existing document. If the resourceHash is given, the document is assumed to be connected to the corresponding resource (identified by the user name in the document). Otherwise the document is independent of any post.
We create a UserRelation of the form (sourceUser, targetUser)\in relation sourceUser should be logged in for this
GET /groups/[groupName]/users
/tags ?filter=[regex] ?(user|group|viewable)=[username/groupname] ?order=(frequency|alph)
No description
/concepts
GET /users/[userName]/concepts/[conceptName] GET /concepts/[conceptName]
POST /users/[userName]/concepts/[conceptName]
PUT /users/[username]/concepts/[conceptname]
DELETE /users/[username]/concepts/[conceptName]
Details
in PostsLogicInterface at line 65
RESTClient
getPosts(string $resourceType = Config\Resourcetype::BIBTEX, string $grouping = Config\Grouping::USER, string $groupingName = '', array $tags = array(), string $resourceHash = '', string $search = '', string $format = 'xml', int $start, int $end = 20)
in PostsLogicInterface at line 77
RESTClient
getPostDetails($userName, $resourceHash)
Returns details to a post. A post is uniquely identified by a hash of the corresponding resource and a username.
in PostsLogicInterface at line 88
RESTClient
deletePosts(string $userName, string $resourceHash)
Removes the given post - identified by the connected resource's hash - from the user.
in PostsLogicInterface at line 100
RESTClient
createPosts(Post|Posts $posts, string $userName)
POST /api/users/[username]/posts
Add post(s) to an user's collection.
in PostsLogicInterface at line 112
RESTClient
updatePosts(ModelObject $posts, string $userName, string $resourceHash)
Updates the post(s) in the database.
in PostsLogicInterface at line 124
RESTClient
createDocument(string $filePath, string $resourceHash, string $userName)
Adds a document to a post.
in PostsLogicInterface at line 137
RESTClient
changeDocumentName(string $filePath, string $resourceHash, string $userName, Document $document)
Adds a document to a post.
in PostsLogicInterface at line 149
RESTClient
getDocumentFile(string $userName, string $resourceHash, string $fileName, string $type = Config\DocumentType::FILE)
in PostsLogicInterface at line 164
RESTClient
deleteDocument(string $userName, string $resourceHash, string $fileName)
Deletes an existing document. If the resourceHash is given, the document is assumed to be connected to the corresponding resource (identified by the user name in the document). Otherwise the document is independent of any post.
in UsersLogicInterface at line 55
RESTClient
getUsers(int $start, int $end)
URL: /users
Generic method to retrieve lists of users
in UsersLogicInterface at line 67
RESTClient
getUserDetails(string $userName)
/users/[username]
Returns details about a specified user
in UsersLogicInterface at line 79
RESTClient
createUserRelationship(User $sourceUser, User $targetUser)
We create a UserRelation of the form (sourceUser, targetUser)\in relation sourceUser should be logged in for this
in GroupsLogicInterface at line 55
RESTClient
getGroups(int $start, int $end)
/groups
Returns all groups of the system.
in GroupsLogicInterface at line 67
RESTClient
getGroupDetails(string $groupName)
/groups/[groupName]
Returns details of one group.
in GroupsLogicInterface at line 79
RESTClient
getUserListOfGroup(string $groupName, int $start, int $end)
GET /groups/[groupName]/users
in TagsLogicInterface at line 64
RESTClient
getTags(string $grouping, string $groupingName, string $regex, string $order, int $start, int $end)
/tags ?filter=[regex] ?(user|group|viewable)=[username/groupname] ?order=(frequency|alph)
Returns a list of tags which can be filtered.
in TagsLogicInterface at line 82
RESTClient
getTagDetails(string $tagName)
/tags/[tag]
Returns details about a tag. Those details are:
- details about the tag itself, like number of occurrences etc
- list of subtags
- list of supertags
- list of correlated tags
in TagsLogicInterface at line 93
RESTClient
getTagRelation(int $start, int $end, string $relation, string $tagName)
in TagsLogicInterface at line 111
RESTClient
getConcepts(string $resourceType, string $grouping, string $groupingName, string $regex, array $tags, string $status, int $start, int $end)
/concepts
Retrieve relations
in TagsLogicInterface at line 126
RESTClient
getConceptDetails(string $conceptName, string $userName)
GET /users/[userName]/concepts/[conceptName] GET /concepts/[conceptName]
Retrieve Details for a concept, containing the belonging subTags.
in TagsLogicInterface at line 142
RESTClient
createConcept(Tag $concept, string $conceptName, string $userName)
POST /users/[userName]/concepts/[conceptName]
Create a new relation/concept note: if a concept already exists with the given name it will be replaced
in TagsLogicInterface at line 155
RESTClient
updateConcept(Tag $concept, string $userName, string $operation)
PUT /users/[username]/concepts/[conceptname]
Update an existing relation/concept
in TagsLogicInterface at line 168
RESTClient
deleteConcept(string $conceptName, string $userName)
DELETE /users/[username]/concepts/[conceptName]
Delete an existing concept