Index | API

A

$Languageproject — Property in class Languageproject: Untranslated strings of dialect will be translated automatically in exported file, leveraging translations from main language.
Directory::add() — Method in class Directory: Add directory to Crowdin project.
File::add() — Method in class File: Add new file to Crowdin project.

C

Crowdin — Class in namespace ElKuKu\Crowdin: Class for interacting with Crowdin.
$Languagefile — Property in class Languagefile: The path at crowdin.
$Languageproject — Property in class Languageproject: Custom domain name for Crowdin project.
Project::create() — Method in class Project: Create Crowdin project.

D

$Languageproject — Property in class Languageproject: Project description.
Directory — Class in namespace ElKuKu\Crowdin\Package: Class Directory
Directory::delete() — Method in class Directory: Delete Crowdin project directory.
File::delete() — Method in class File: Delete file from Crowdin project. All the translations will be lost without ability to restore them.
Glossary::download() — Method in class Glossary: Download Crowdin project glossaries as TBX file.
Memory::download() — Method in class Memory: Download Crowdin project Translation Memory as TMX file.
Project::delete() — Method in class Project: Delete Crowdin project with all translations.
Translation::download() — Method in class Translation: Download ZIP file with translations. You can choose the language of translation you need or download all of them at once.

E

$Languagefile — Property in class Languagefile: The export pattern.
$Languageproject — Property in class Languageproject: Defines whether only translated strings will be exported to the final file. We do not recommend to set this option if you have text (*.html, *.txt, *.docx etc.) documents in your project since it may damage resulted files.
$Languageproject — Property in class Languageproject: If set to 1 only approved translations will be exported in resulted ZIP file.
File::export() — Method in class File: This method exports single translated files from Crowdin.
Project::edit() — Method in class Project: Edit Crowdin project.
Translation::export() — Method in class Translation: Build ZIP archive with the latest translations. Please note that this method can be invoked only once per 30 minutes (there is no such restriction for organization plans). Also API call will be ignored if there were no changes in the project since previous export. You can see whether ZIP archive with latest translations was actually build by status attribute ("built" or "skipped") returned in response.

F

File — Class in namespace ElKuKu\Crowdin\Package: Class File

G

Languagefile::getLocalPath() — Method in class Languagefile: Get the local path.
Languagefile::getCrowdinPath() — Method in class Languagefile: Get the Crowdin path.
Languagefile::getExportPattern() — Method in class Languagefile: Get the export pattern.
Languagefile::getTitle() — Method in class Languagefile: Get the title.
Package::getProjectId() — Method in class Package: Get the project ID.
Package::getApiKey() — Method in class Package: Get the API key.
Package::getHttpClient() — Method in class Package: Get the HTTP client object.
Package::getBasePath() — Method in class Package: Get the base path for the command including an action.
Glossary — Class in namespace ElKuKu\Crowdin\Package: Class Glossary
Language::getSupported() — Method in class Language: Get supported languages list with Crowdin codes mapped to locale name and standardized codes.
Language::getStatus() — Method in class Language: Get the detailed translation progress for specified language.
Project::getList() — Method in class Project: Get Crowdin Project details.
Project::getInfo() — Method in class Project: Get Crowdin Project details.
Translation::getStatus() — Method in class Translation: Track overall translation and proofreading progresses of each target language.

H

$Languageproject — Property in class Languageproject: Defines whether duplicated strings should be displayed to translators or should be hidden and translated automatically.

I

$Languageproject — Property in class Languageproject: Project identifier. Should be unique among other Crowdin projects.
$Languageproject — Property in class Languageproject: Defines whether the In-Context should be active in the project.

J

$Languageproject — Property in class Languageproject: Project join policy. Acceptable values are: open, private

L

Languagefile — Class in namespace ElKuKu\Crowdin: Language file class.
$Languagefile — Property in class Languagefile: The path on the local file system.
Languageproject — Class in namespace ElKuKu\Crowdin: Project class.
$Languageproject — Property in class Languageproject: An array of language codes project should be translate to.
$Languageproject — Property in class Languageproject: Defines how project members can access target languages. Acceptable values are: - "open" - any translator can access any language. (default) - "moderate" - translator should be granted with access to certain language.
$Languageproject — Property in class Languageproject: Project logo at Crowdin.
Language — Class in namespace ElKuKu\Crowdin\Package: Class Language

M

Memory — Class in namespace ElKuKu\Crowdin\Package: Class Memory

N

$Languageproject — Property in class Languageproject: Project name.

P

$Languageproject — Property in class Languageproject: Defines whether "Download" button visible to everyone on Crowdin webpages.
$Languageproject — Property in class Languageproject: Specify the language code for the In-Context's pseudo-language that will store some operational data.
Package — Class in namespace ElKuKu\Crowdin: Class Package
Project — Class in namespace ElKuKu\Crowdin\Package: Class Project

S

Languagefile::setExportPattern() — Method in class Languagefile: Set the export pattern.
Languagefile::setTitle() — Method in class Languagefile: Set the title.
$Languageproject — Property in class Languageproject: Source files language. Should be a two letters language code.

T

$Languagefile — Property in class Languagefile: The language file title.
Languageproject::toQuery() — Method in class Languageproject: Convert tye object to query string.
Translation — Class in namespace ElKuKu\Crowdin\Package: Class Translation

U

$Languageproject — Property in class Languageproject: Defines if translations would be leveraged from Crowdin Global Translation Memory.
Directory::update() — Method in class Directory: Rename directory or modify its attributes.
File::update() — Method in class File: Upload latest version of your localization file to Crowdin.
Glossary::upload() — Method in class Glossary: Upload your Translation Memory for Crowdin Project in TMX file format.
Memory::upload() — Method in class Memory: Upload your Translation Memory for Crowdin Project in TMX file format.
Translation::upload() — Method in class Translation: Upload existing translations to your Crowdin project.

W

$Languageproject — Property in class Languageproject: Open this URL when one of the project files is translated.
$Languageproject — Property in class Languageproject: Open this URL when one of the project files is proofread.
$Languageproject — Property in class Languageproject: Open this URL when project translation is complete. URL will be opened with "project" - project identifier and "language" - language code.
$Languageproject — Property in class Languageproject: Open this URL when project proofreading is complete. URL will be opened with "project" - project identifier and "language" - language code.

_

Crowdin::__construct() — Method in class Crowdin: Constructor.
Crowdin::__get() — Method in class Crowdin: Magic method to lazily create API objects.
Languagefile::__construct() — Method in class Languagefile: Constructor.
Package::__construct() — Method in class Package: Constructor.