Documentation

Crowdin
in package

Table of Contents

Properties

$branch  : BranchApi
$bundle  : BundleApi
$directory  : DirectoryApi
$distribution  : DistributionApi
$file  : FileApi|FileApi
$glossary  : GlossaryApi
$graphql  : GraphqlApi
$group  : GroupApi
$issue  : IssueApi
$label  : LabelApi
$language  : LanguageApi
$notification  : NotificationApi|NotificationApi
$organizationWebhook  : OrganizationWebhookApi
$project  : ProjectApi
$report  : ReportApi|ReportApi
$reportArchive  : ReportArchiveApi|ReportArchiveApi
$responseErrorHandler  : ResponseErrorHandlerInterface
$screenshot  : ScreenshotApi
$sourceString  : SourceStringApi
$storage  : StorageApi
$stringComment  : StringCommentApi
$stringsExporterSetting  : StringsExporterSettingApi
$stringTranslation  : StringTranslationApi
$task  : TaskApi
$team  : TeamApi
$teamMember  : TeamMemberApi
$translation  : TranslationApi
$translationMemory  : TranslationMemoryApi
$translationStatus  : TranslationStatusApi
$user  : UserApi|UserApi
$vendor  : VendorApi
$webhook  : WebhookApi
$workflowStep  : WorkflowStepApi
$workflowTemplate  : WorkflowTemplateApi
$accessToken  : string
$apis  : array<string|int, mixed>
$baseUri  : string
$client  : CrowdinHttpClientInterface
$isEnterprise  : bool
$organization  : string|null
$services  : array<string|int, mixed>
$servicesEnterprise  : mixed

Methods

__construct()  : mixed
__get()  : ApiInterface
apiRequest()  : mixed
getAccessToken()  : string
getBaseUri()  : string
getClient()  : CrowdinHttpClientInterface
getOrganization()  : string|null
getResponseErrorHandler()  : ResponseErrorHandlerInterface
isEnterprise()  : bool
setAccessToken()  : void
setBaseUri()  : void
setClient()  : void
setOrganization()  : void
setResponseErrorHandler()  : void
getApi()  : ApiInterface
getFullUrl()  : string
request()  : mixed

Properties

$responseErrorHandler

public ResponseErrorHandlerInterface $responseErrorHandler

$accessToken

protected string $accessToken

$apis

protected array<string|int, mixed> $apis = []

$baseUri

protected string $baseUri = 'https://api.crowdin.com/api/v2'

$client

protected CrowdinHttpClientInterface $client

$isEnterprise

protected bool $isEnterprise = false

$organization

protected string|null $organization

$services

protected array<string|int, mixed> $services = ['storage', 'language', 'project', 'task', 'issue', 'branch', 'glossary', 'stringsExporterSetting', 'stringTranslation', 'stringComment', 'directory', 'label', 'user', 'screenshot', 'file', 'machineTranslationEngine', 'report', 'sourceString', 'translationMemory', 'webhook', 'translation', 'translationStatus', 'distribution', 'bundle', 'notification', 'organizationWebhook', 'reportArchive', 'graphql']

$servicesEnterprise

protected mixed $servicesEnterprise = ['storage', 'language', 'group', 'project', 'task', 'issue', 'branch', 'glossary', 'stringsExporterSetting', 'stringTranslation', 'stringTranslationApproval', 'stringComment', 'directory', 'label', 'vendor', 'user', 'screenshot', 'workflowTemplate', 'workflowStep', 'file', 'machineTranslationEngine', 'report', 'sourceString', 'translationMemory', 'webhook', 'translation', 'translationStatus', 'distribution', 'team', 'teamMember', 'bundle', 'notification', 'organizationWebhook', 'reportArchive', 'graphql']

Methods

__construct()

public __construct(array<string|int, mixed> $config) : mixed
Parameters
$config : array<string|int, mixed>

__get()

public __get(string $name) : ApiInterface
Parameters
$name : string
Return values
ApiInterface

apiRequest()

public apiRequest(string $method, string $path[, ResponseDecoratorInterface|null $decorator = null ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$method : string
$path : string
$decorator : ResponseDecoratorInterface|null = null
$options : array<string|int, mixed> = []

getAccessToken()

public getAccessToken() : string
Return values
string

getBaseUri()

public getBaseUri() : string
Return values
string

getClient()

public getClient() : CrowdinHttpClientInterface
Return values
CrowdinHttpClientInterface

getOrganization()

public getOrganization() : string|null
Return values
string|null

getResponseErrorHandler()

public getResponseErrorHandler() : ResponseErrorHandlerInterface
Return values
ResponseErrorHandlerInterface

isEnterprise()

public isEnterprise() : bool
Return values
bool

setAccessToken()

public setAccessToken(string $accessToken) : void
Parameters
$accessToken : string

setBaseUri()

public setBaseUri(string $baseUri) : void
Parameters
$baseUri : string

setClient()

public setClient(CrowdinHttpClientInterface $client) : void
Parameters
$client : CrowdinHttpClientInterface

setOrganization()

public setOrganization(string|null $organization) : void
Parameters
$organization : string|null

setResponseErrorHandler()

public setResponseErrorHandler(ResponseErrorHandlerInterface $responseErrorHandler) : void
Parameters
$responseErrorHandler : ResponseErrorHandlerInterface

getApi()

protected getApi(string $name) : ApiInterface
Parameters
$name : string
Return values
ApiInterface

getFullUrl()

protected getFullUrl(string $path) : string
Parameters
$path : string
Return values
string

request()

protected request(string $method, string $uri[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$method : string
$uri : string
$options : array<string|int, mixed> = [] 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results