• Главная
• API

PHP Класс API, glpi

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$api_url

Защищенные свойства (Protected)

Свойство	Тип	Описание
$apiclients_id
$app_tokens
$format
$ipnum
$iptxt
$session_write		permit writing to $_SESSION

Открытые методы

Метод	Описание
__construct ( )
call ( )	first function used on api call
getHatoasClasses ( $itemtype ) : array	retrieve all child class for itemtype parameter
inlineDocumentation ( $file )	Display the API Documentation in Html (parsed from markdown)
messageBadArrayError ( $return_error = true )	Send 400 error to client
messageLostError ( $return_error = true )	Send 405 error to client
messageNotfoundError ( $return_error = true )	Send 404 error to client
messageRightError ( $return_error = true )	Send 401 error to client
messageSessionError ( $return_error = true )	Session Token KO
messageSessionTokenMissing ( $return_error = true )	Session Token missing
returnError ( $message = "Bad Request", $httpcode = 400, $statuscode = "ERROR", $docmessage = true, $return_response = true )	Generic function to send a error message and an error code to client

Защищенные методы

Метод	Описание
arrayRightError ( )	Fill a sub array with a right error
changeActiveEntities ( $params = [] ) : boolean	Change active entity to the entities_id one.
changeActiveProfile ( $params = [] ) : boolean	set a profile to active
checkSessionToken ( ) : boolean	Check that the session_token is provided and match to a valid php session
cors ( $verb = 'GET' )
createItems ( $itemtype, $params = [] ) : array	Add an object to GLPI
deleteItems ( $itemtype, $params = [] ) : boolean	delete one or more objects in GLPI
getActiveEntities ( ) : array	return active entities of current logged user
getActiveProfile ( ) : integer	return the current active profile
getFullSession ( ) : array	return the current php $_SESSION
getGlpiConfig ( ) : array	return the current $CFG_GLPI
getItem ( $itemtype, $id, $params = [] ) : array	Return the instance fields of itemtype identified by id
getItems ( $itemtype, $params = [], &$totalcount ) : array	Return a collection of rows of the desired itemtype
getMultipleItems ( $params = [] ) : array	Return a collection of items queried in input ($items)
getMyEntities ( ) : array	return all the possible entity of the current logged user (and for current active profile)
getMyProfiles ( ) : array	Return all the profiles associated to logged user
header ( $html = false, $title = "" )	Show API header in debug, it add body and some libs (essentialy to colorise markdown) otherwise, it change only Content-Type of the page
initSession ( $params = [] ) : array	Init GLPI Session
killSession ( ) : boolean	Kill GLPI Session Use 'session_token' param in $this->parameters
listSearchOptions ( $itemtype, $params = [] ) : array	List the searchoptions of provided itemtype. To use with searchItems function
parseDropdowns ( $fields, $params = [] ) : array	transform array of fields passed in parameter : change value from integer id to string name of foreign key You can pass an array of array, this method is recursive.
parseIncomingParams ( )	needed to transform params of called api in $this->parameters attribute
retrieveSession ( )	Retrieve GLPI Session initialised by initSession function Use 'session_token' param in $this->parameters
returnResponse ( $response, $code, $additionalheaders )	generic messages
searchItems ( $itemtype, $params = [] ) : Array	Expose the GLPI searchEngine
showDebug ( )	Show API Debug
updateItems ( $itemtype, $params = [] ) : array	update an object to GLPI

Приватные методы

Метод	Описание
checkAppToken ( )	check if the app_toke in case of config ask to
getGlpiLastMessage ( ) : array	Get last message added in $_SESSION by Session::addMessageAfterRedirect
getSearchOptionUniqID ( $itemtype, $option = [] ) : string	Generate an unique id of a searchoption based on: - itemtype - linkfield - joinparams - field
getSearchOptionUniqIDJoins ( $option ) : array	Generate subpart of a unique id of a search option with parsing joinparams recursively
initEndpoint ( $unlock_session = true, $endpoint = "" )	Function called by each commun function of the api.
inputObjectToArray ( mixed $input ) : array	Transform all stdobject retrieved from a json_decode into arrays
logEndpointUsage ( $endpoint = "" )	Log usage of the api into glpi historical or log files (defined by api config) It stores the ip and the username of the current session.
unlockSessionIfPossible ( )	Unlock the current session (readonly) to permit concurrent call

Описание методов

Описание свойств