1. class
  2. ElKuKu
  3. \
  4. Crowdin
  5. \
  6. Package
  7. \
  8. Glossary

Glossary

class Glossary extends Package

Class Glossary

Methods

__construct(string $projectId, string $apiKey, Client $httpClient)

Constructor.

from Package
string
getProjectId()

Get the project ID.

from Package
string
getApiKey()

Get the API key.

from Package
Client
getHttpClient()

Get the HTTP client object.

from Package
string
getBasePath(string $action)

Get the base path for the command including an action.

from Package
ResponseInterface
download(bool $includeAssigned = true)

Download Crowdin project glossaries as TBX file.

ResponseInterface
upload(string $file)

Upload your Translation Memory for Crowdin Project in TMX file format.

Details

in Package at line 45
__construct(string $projectId, string $apiKey, Client $httpClient)

Constructor.

Parameters

string $projectId The project ID.
string $apiKey The API key
Client $httpClient The HTTP client object.

in Package at line 57
protected string getProjectId()

Get the project ID.

Return Value

string

in Package at line 67
protected string getApiKey()

Get the API key.

Return Value

string

in Package at line 77
protected Client getHttpClient()

Get the HTTP client object.

Return Value

Client

in Package at line 89
protected string getBasePath(string $action)

Get the base path for the command including an action.

Parameters

string $action The action to perform.

Return Value

string

at line 34
ResponseInterface download(bool $includeAssigned = true)

Download Crowdin project glossaries as TBX file.

Parameters

bool $includeAssigned Defines whether the assigned glossaries should be included in downloaded TBX file. Acceptable values are: 0, 1. Default is 1.

Return Value

ResponseInterface

See also

https://crowdin.com/page/api/download-glossary

at line 50
ResponseInterface upload(string $file)

Upload your Translation Memory for Crowdin Project in TMX file format.

Parameters

string $file Full path to file to upload.

Return Value

ResponseInterface

See also

https://crowdin.com/page/api/upload-glossary