xm_tools apidoc
\
Xima
XmTools
Classes
API
REST
Model
Repository
Extensions
KeSearch
Hooks
VO
Helper
Typo3
Cache
Controller
Domain
Repository
Extension
Helper
Model
Query
Service
ViewHelpers
Control
Form
Object
Security
Typo3
Handler
Security
Utilities
ViewHelpers

\Xima\XmTools\Classes\API\REST\RepositorySortableRepository

Repository to retrieve a list of sortable values of the API. Set your apiRoute.

The name of the inheriting repository class will be used for creating the API URL and instantiating model classes. This behaviour can be changed by overriding the function getApiTarget().

Summary

Methods
Properties
Constants
initializeObject()
findByUid()
findAll()
findAllByQuery()
createQuery()
persist()
getApiKey()
setApiKey()
getApiUrl()
setApiUrl()
getApiSchema()
setApiSchema()
getApiRouteFindById()
setApiRouteFindById()
getApiRouteFindByQuery()
setApiRouteFindByQuery()
getObjectType()
getLastReponse()
setLastReponse()
getApiRouteCreate()
setApiRouteCreate()
getApiRouteUpdate()
setApiRouteUpdate()
findBy()
No public properties found
PLACEHOLDER_API_URL
PLACEHOLDER_API_ROUTE
PLACEHOLDER_API_KEY
PLACEHOLDER_TARGET
No protected methods found
$extensionManager
$connector
$typo3Services
$apiKey
$apiUrl
$apiSchema
$apiRouteFindById
$apiRouteFindByQuery
$apiRouteCreate
$apiRouteUpdate
$lastReponse
$apiRoute
N/A
buildUrl()
getApiTarget()
No private properties found
N/A

Constants

PLACEHOLDER_API_URL

PLACEHOLDER_API_URL

PLACEHOLDER_API_ROUTE

PLACEHOLDER_API_ROUTE

PLACEHOLDER_API_KEY

PLACEHOLDER_API_KEY

PLACEHOLDER_TARGET

PLACEHOLDER_TARGET

Properties

$apiKey

$apiKey :

Type

$apiUrl

$apiUrl :

Type

$apiSchema

$apiSchema :

Type

$apiRouteFindById

$apiRouteFindById :

Type

$apiRouteFindByQuery

$apiRouteFindByQuery :

Type

$apiRouteCreate

$apiRouteCreate :

Type

$apiRouteUpdate

$apiRouteUpdate :

Type

$lastReponse

$lastReponse :

Type

$apiRoute

$apiRoute : string

apiRoute.

Type

string

Methods

initializeObject()

initializeObject()

Retrieves the calling extension through the package name of the inheriting repository class. Configures the repository with the extensions' settings.

findAll()

findAll() : Array

findAll.

Returns

Array —

of model objects according the repository class name, if existing, otherwise array of arrays. Indexed by id.

createQuery()

createQuery() : \Xima\XmTools\Classes\API\REST\Query

Create a Xima\XmTools\Classes\API\REST\Query object. Overrides TYPO3 default behavivour.

Returns

\Xima\XmTools\Classes\API\REST\Query

getApiKey()

getApiKey()

setApiKey()

setApiKey(  $apiKey)

Parameters

$apiKey

getApiUrl()

getApiUrl()

setApiUrl()

setApiUrl(  $apiUrl)

Parameters

$apiUrl

getApiSchema()

getApiSchema()

setApiSchema()

setApiSchema(  $apiSchema)

Parameters

$apiSchema

getApiRouteFindById()

getApiRouteFindById()

setApiRouteFindById()

setApiRouteFindById(  $apiRouteFindById)

Parameters

$apiRouteFindById

getApiRouteFindByQuery()

getApiRouteFindByQuery()

setApiRouteFindByQuery()

setApiRouteFindByQuery(  $apiRouteFindByQuery)

Parameters

$apiRouteFindByQuery

getObjectType()

getObjectType()

To make it compatible with Typo3.

getLastReponse()

getLastReponse()

setLastReponse()

setLastReponse(  $lastReponse)

Parameters

$lastReponse

getApiRouteCreate()

getApiRouteCreate()

setApiRouteCreate()

setApiRouteCreate(  $apiRouteCreate)

Parameters

$apiRouteCreate

getApiRouteUpdate()

getApiRouteUpdate()

setApiRouteUpdate()

setApiRouteUpdate(  $apiRouteUpdate)

Parameters

$apiRouteUpdate

findBy()

findBy(array  $criteria, array|null  $orderBy = null, integer|null  $limit = null, integer|null  $offset = null) : array

Finds entities by a set of criteria.

Parameters

array $criteria
array|null $orderBy
integer|null $limit
integer|null $offset

Returns

array —

The objects.

buildUrl()

buildUrl(  $route,   $params = array()) : string

Builds the URL to API. The API schema must be definedin the TYPO3 constant editor to something like: -[Api-URL]/[Api-Key][Api-Route] -[Api-URL][Api-Route]?[Api-Key] -.

..

Parameters

$route

string
$params

array

Returns

string

getApiTarget()

getApiTarget()