Class Socialveo\WebApi\Controllers\TagAssociationsController

InheritanceSocialveo\WebApi\Controllers\TagAssociationsController » Socialveo\WebApi\Controllers\RestApiController » Phalcon\Mvc\Controller
Uses TraitsSocialveo\Core\Translatable

Class TagAssociationsController

Public Methods

Hide inherited methods

MethodDescriptionDefined By
_handleException() Handle exceptions Socialveo\WebApi\Controllers\RestApiController
_t() Gets translations Socialveo\Core\Translatable
afterExecuteRoute() After execute route, change return value to json Socialveo\WebApi\Controllers\RestApiController
beforeExecuteRoute() Before execute route, remove extra params Socialveo\WebApi\Controllers\RestApiController
checkClientCredentials() Checks client credentials Socialveo\WebApi\Controllers\RestApiController
createAction() Creates a tag association Socialveo\WebApi\Controllers\TagAssociationsController
decrypt() Decrypt value Socialveo\WebApi\Controllers\RestApiController
deleteAction() Removes a tag association Socialveo\WebApi\Controllers\TagAssociationsController
encrypt() Encrypt value Socialveo\WebApi\Controllers\RestApiController
getAction() Returns a tag association Socialveo\WebApi\Controllers\TagAssociationsController
getArrayFromParam() Returns array from params Socialveo\WebApi\Controllers\RestApiController
getLanguage() Gets language code Socialveo\WebApi\Controllers\RestApiController
getParams() Gets request params for Socialveo::filteredFind() Socialveo\WebApi\Controllers\RestApiController
getRequestData() Returns request data Socialveo\WebApi\Controllers\RestApiController
getRequiredParam() Get required param Socialveo\WebApi\Controllers\RestApiController
getToken() Get token Socialveo\WebApi\Controllers\RestApiController
getTranslation() Gets translations Socialveo\WebApi\Controllers\RestApiController
handleError() Handle errors Socialveo\WebApi\Controllers\RestApiController
handleException() Handle exceptions Socialveo\WebApi\Controllers\RestApiController
initialize() Initialize controller Socialveo\WebApi\Controllers\RestApiController
invalidMethodAction() Action trigger when invalid action tried run Socialveo\WebApi\Controllers\RestApiController
listAction() Returns a list of tag associations Socialveo\WebApi\Controllers\TagAssociationsController
notFoundAction() Not found action Socialveo\WebApi\Controllers\RestApiController
posts() Gets posts Socialveo\WebApi\Controllers\RestApiController
replaceParam() Replace param Socialveo\WebApi\Controllers\RestApiController
respondWithItem() Response with item // * @deprecated Socialveo\WebApi\Controllers\RestApiController
sendJsonContent() Send response as json content and exit Socialveo\WebApi\Controllers\RestApiController
sendJsonContentRaw() Send json content Socialveo\WebApi\Controllers\RestApiController
sendJsonContentRawStatic() Send json content static Socialveo\WebApi\Controllers\RestApiController
setDefaultParam() Set default option Socialveo\WebApi\Controllers\RestApiController
t() Gets translations Socialveo\Core\Translatable
unsetParam() Unset get param Socialveo\WebApi\Controllers\RestApiController
updateAction() Updates a tag association Socialveo\WebApi\Controllers\TagAssociationsController

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
checkAccess() Checks during the init of controller whether user is a guest. Socialveo\WebApi\Controllers\RestApiController
log() Log full request data for debug Socialveo\WebApi\Controllers\RestApiController
objectsToArray() Convert objects to arrays Socialveo\WebApi\Controllers\RestApiController

Method Details

createAction() public method

Creates a tag association

Notice. This action is disabled, the reasons can be: not implemented, unsafe, duplicated or deprecated (autodetect: disabled in the router)
/tag-association

Method: POST

Access: Public

Parameters:

tag_uuid required string the UUID of tag to be associated
target_uuid required string the UUID of target item (eg. post)
target_type required string the type of target item (eg. post, comment, etc.)

Returns: TagAssociation

Sample response:

{
    "status": "OK",
    "data":{
        "type": "tag_association",
        "uuid": "0aa7a1f8-b5f9-11e4-8cf7-b88d1200a92c",
        "tag_uuid": "9a4f3e6d-580e-3d0f-abea-756129e11939",
        "user_uuid": "f8b2c84b-aa4e-3d63-9fa8-95206dbd8b5e",
        "target_uuid": "e2730224-a1bd-3ec3-88b9-f0a73d6d1a0f",
        "target_type": "post",
        ...
    }
    "timestamp": 1234567890
}

public mixed createAction ( )
deleteAction() public method

Removes a tag association

Notice. This action is disabled, the reasons can be: not implemented, unsafe, duplicated or deprecated (autodetect: disabled in the router)
/tag-associations/{tag_association_uuid}

Method: POST

Access: Public

Parameters:

{tag_association_uuid} required string tag association uuid

Affects: TagAssociation

Sample response:

{
    "status": "OK",
    "timestamp": 1234567890
}

public mixed deleteAction ( $tag_association_uuid )
$tag_association_uuid
getAction() public method

Returns a tag association

/tag-associations/{tag_association_uuid}

Method: GET

Access: Public

Parameters:

{tag_association_uuid} required string tag association uuid

Returns: TagAssociation

Sample response:

{
    "status": "OK",
    "data":{
        "type": "tag_association",
        "uuid": "0aa7a1f8-b5f9-11e4-8cf7-b88d1200a92c",
        "tag_uuid": "9a4f3e6d-580e-3d0f-abea-756129e11939",
        "user_uuid": "f8b2c84b-aa4e-3d63-9fa8-95206dbd8b5e",
        "target_uuid": "e2730224-a1bd-3ec3-88b9-f0a73d6d1a0f",
        "target_type": "post",
        ...
    }
    "timestamp": 1234567890
}

public mixed getAction ( $tag_association_uuid )
$tag_association_uuid string

Tag UUID is passed in the request URI

listAction() public method

Returns a list of tag associations

/tag-associations

Method: GET

Access: Public

Parameters:

page or offset optional integer page start or offset
limit optional integer page limit
sortby[property]=order optional array sort by property value, order either desc or asc
filterby[property][operator]=value optional array filter (limit results) by given property, operator eq (=), gt (>), ge(>=), lt(<), le(<=), ne(<>), like
uuids optional string or array list of item UUIDs to fetch, array or string separated by commas, when it used other parameters will be ignored
language optional string language code

Filter by: TagAssociation

Returns: TagAssociation []

Sample response:

{
    "status": "OK",
    "data":[
        {"type": "tag_association", "uuid": "a479b438-14a8-11e6-ac83-54bef75c7a3f", "tag_uuid": "a66b8654-14a8-11e6-af87-54bef75c7a3f",…},
        {"type": "tag_association", "uuid": "5a15e760-27ed-11e6-8d4a-54bef75c7a3f", "tag_uuid": "5ac94e9a-27ed-11e6-9916-54bef75c7a3f",…},
        {"type": "tag_association", "uuid": "0449c1f2-27f8-11e6-be68-54bef75c7a3f", "tag_uuid": "04577e6e-27f8-11e6-b0cf-54bef75c7a3f",…},
        {"type": "tag_association", "uuid": "4622f77e-27f8-11e6-98d1-54bef75c7a3f", "tag_uuid": "4631a06c-27f8-11e6-94b3-54bef75c7a3f",…},
        ...
    ],
    "count":{"offset": 0, "limit": 10, "total": 12},
    "timestamp": 1234567890
}

public mixed listAction ( )
updateAction() public method

Updates a tag association

Notice. This action is disabled, the reasons can be: not implemented, unsafe, duplicated or deprecated (autodetect: disabled in the router)
/tag-associations/{tag_association_uuid}

Method: POST

Access: Public

Parameters:

{tag_association_uuid} required string tag association uuid

Affects: TagAssociation

Returns: TagAssociation

Sample response:

{
    "status": "OK",
    "data":{
        "type": "tag_association",
        "uuid": "0aa7a1f8-b5f9-11e4-8cf7-b88d1200a92c",
        "tag_uuid": "9a4f3e6d-580e-3d0f-abea-756129e11939",
        "user_uuid": "f8b2c84b-aa4e-3d63-9fa8-95206dbd8b5e",
        "target_uuid": "e2730224-a1bd-3ec3-88b9-f0a73d6d1a0f",
        "target_type": "post",
        ...
    }
    "timestamp": 1234567890
}

public mixed updateAction ( $tag_association_uuid )
$tag_association_uuid string
throws Exception