Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions src/CrowdinApiClient/Api/BranchApi.php
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,24 @@ public function list(int $projectId, array $params = []): ModelCollection
return $this->_list($path, Branch::class, $params);
}

/**
* Search Branches
* @link https://developer.crowdin.com/api/v2/#operation/api.branches.getMany API Documentation
* @link https://developer.crowdin.com/enterprise/api/v2/#operation/api.branches.getMany API Documentation Enterprise
*
* @param array $params
* string $params[filter] required, max 128 characters<br>
* string $params[projectIds] Comma-separated project identifiers, max 50 projects<br>
* integer $params[userId] Crowdin API only<br>
* integer $params[limit]<br>
* integer $params[offset]
* @return ModelCollection
*/
public function search(array $params = []): ModelCollection
{
return $this->_list('branches', Branch::class, $params);
}

/**
* Get Branch Info
* @link https://developer.crowdin.com/api/v2/#operation/api.projects.branches.get API Documentation
Expand Down
18 changes: 18 additions & 0 deletions src/CrowdinApiClient/Api/DirectoryApi.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,24 @@ public function list(int $projectId, array $params = []): ModelCollection
return $this->_list($path, Directory::class, $params);
}

/**
* Search Directories
* @link https://developer.crowdin.com/api/v2/#operation/api.directories.getMany API Documentation
* @link https://developer.crowdin.com/enterprise/api/v2/#operation/api.directories.getMany API Documentation Enterprise
*
* @param array $params
* string $params[filter] required, max 128 characters<br>
* string $params[projectIds] Comma-separated project identifiers, max 50 projects<br>
* integer $params[userId] Crowdin API only<br>
* integer $params[limit]<br>
* integer $params[offset]
* @return ModelCollection
*/
public function search(array $params = []): ModelCollection
{
return $this->_list('directories', Directory::class, $params);
}

/**
* Get Directory Info
* @link https://developer.crowdin.com/api/v2/#operation/api.projects.directories.get API Documentation
Expand Down
18 changes: 18 additions & 0 deletions src/CrowdinApiClient/Api/FileApi.php
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,24 @@ public function list(int $projectId, array $params = []): ModelCollection
return $this->_list($path, File::class, $params);
}

/**
* Search Files
* @link https://developer.crowdin.com/api/v2/#operation/api.files.getMany API Documentation
* @link https://developer.crowdin.com/enterprise/api/v2/#operation/api.files.getMany API Documentation Enterprise
*
* @param array $params
* string $params[filter] required, max 128 characters<br>
* string $params[projectIds] Comma-separated project identifiers, max 50 projects<br>
* integer $params[userId] Crowdin API only<br>
* integer $params[limit]<br>
* integer $params[offset]
* @return ModelCollection
*/
public function search(array $params = []): ModelCollection
{
return $this->_list('files', File::class, $params);
}

/**
* Add File
* @link https://developer.crowdin.com/api/v2/#operation/api.projects.files.post API Documentation
Expand Down
20 changes: 20 additions & 0 deletions src/CrowdinApiClient/Api/SourceStringApi.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,26 @@ public function list(int $projectId, array $params = []): ModelCollection
return $this->_list($path, SourceString::class, $params);
}

/**
* Search Strings
* @link https://developer.crowdin.com/api/v2/#operation/api.strings.getMany API Documentation
* @link https://developer.crowdin.com/enterprise/api/v2/#operation/api.strings.getMany API Documentation Enterprise
*
* @param array $params
* string $params[filter] required, max 128 characters<br>
* string $params[projectIds] Comma-separated project identifiers, max 50 projects<br>
* integer $params[userId] Crowdin API only<br>
* string $params[scope] Enum: "all" "text" "context" "key", default: "all"<br>
* integer $params[denormalizePlaceholders] Enum: 0 1<br>
* integer $params[limit]<br>
* integer $params[offset]
* @return ModelCollection
*/
public function search(array $params = []): ModelCollection
{
return $this->_list('strings', SourceString::class, $params);
}

/**
* Get String
* @link https://developer.crowdin.com/api/v2/#operation/api.projects.strings.get API Documentation
Expand Down
20 changes: 20 additions & 0 deletions src/CrowdinApiClient/Api/StringTranslationApi.php
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,26 @@ public function list(int $projectId, array $params = []): ModelCollection
return $this->_list($path, StringTranslation::class, $params);
}

/**
* Search Translations
* @link https://developer.crowdin.com/api/v2/#operation/api.translations.getMany API Documentation
* @link https://developer.crowdin.com/enterprise/api/v2/#operation/api.translations.getMany API Documentation Enterprise
*
* @param array $params
* string $params[filter] required, max 128 characters<br>
* string $params[projectIds] Comma-separated project identifiers, max 50 projects<br>
* integer $params[userId] Crowdin API only<br>
* string $params[languageIds] Comma-separated language identifiers<br>
* integer $params[denormalizePlaceholders] Enum: 0 1<br>
* integer $params[limit]<br>
* integer $params[offset]
* @return ModelCollection
*/
public function search(array $params = []): ModelCollection
{
return $this->_list('translations', StringTranslation::class, $params);
}

/**
* Add Translation
* @link https://developer.crowdin.com/api/v2/#operation/api.projects.translations.add API Documentation
Expand Down
48 changes: 48 additions & 0 deletions src/CrowdinApiClient/Model/StringTranslation.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,21 @@ class StringTranslation extends BaseModel
*/
protected $id;

/**
* @var integer|null
*/
protected $projectId;

/**
* @var integer|null
*/
protected $stringId;

/**
* @var string|null
*/
protected $languageId;

/**
* @var string
*/
Expand Down Expand Up @@ -42,6 +57,15 @@ public function __construct(array $data = [])
parent::__construct($data);

$this->id = (int)$this->getDataProperty('id');
$this->projectId = $this->getDataProperty('projectId') !== null
? (int)$this->getDataProperty('projectId')
: null;
$this->stringId = $this->getDataProperty('stringId') !== null
? (int)$this->getDataProperty('stringId')
: null;
$this->languageId = $this->getDataProperty('languageId') !== null
? (string)$this->getDataProperty('languageId')
: null;
$this->text = (string)$this->getDataProperty('text');
$this->pluralCategoryName = (string)$this->getDataProperty('pluralCategoryName');
$this->user = (array)$this->getDataProperty('user');
Expand All @@ -64,6 +88,30 @@ public function setId(int $id): void
$this->id = $id;
}

/**
* @return int|null
*/
public function getProjectId(): ?int
{
return $this->projectId;
}

/**
* @return int|null
*/
public function getStringId(): ?int
{
return $this->stringId;
}

/**
* @return string|null
*/
public function getLanguageId(): ?string
{
return $this->languageId;
}

/**
* @return string
*/
Expand Down
40 changes: 40 additions & 0 deletions tests/CrowdinApiClient/Api/BranchApiTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,46 @@ public function testList()
$this->assertEquals('2019-09-19T13:25:27+00:00', $branchModel->getUpdatedAt());
}

public function testSearch(): void
{
$this->mockRequest([
'path' => '/branches?filter=master&projectIds=2%2C3&userId=6&limit=10&offset=20',
'method' => 'get',
'response' => json_encode([
'data' => [
[
'data' => [
'id' => 34,
'projectId' => 2,
'name' => 'develop-master',
'title' => 'Master branch',
],
],
],
'pagination' => [
[
'offset' => 20,
'limit' => 10,
],
],
]),
]);

$branches = $this->crowdin->branch->search([
'filter' => 'master',
'projectIds' => '2,3',
'userId' => 6,
'limit' => 10,
'offset' => 20,
]);

$this->assertInstanceOf(ModelCollection::class, $branches);
$this->assertCount(1, $branches);
$this->assertInstanceOf(Branch::class, $branches[0]);
$this->assertEquals(34, $branches[0]->getId());
$this->assertEquals(2, $branches[0]->getProjectId());
}

public function testGet()
{
$this->mockRequestGet('/projects/2/branches/34',
Expand Down
42 changes: 42 additions & 0 deletions tests/CrowdinApiClient/Api/DirectoryApiTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,48 @@ public function testList()
$this->assertEquals(4, $directories[0]->getId());
}

public function testSearch(): void
{
$this->mockRequest([
'path' => '/directories?filter=main&projectIds=2%2C3&userId=6&limit=10&offset=20',
'method' => 'get',
'response' => json_encode([
'data' => [
[
'data' => [
'id' => 4,
'projectId' => 2,
'branchId' => 34,
'directoryId' => 0,
'name' => 'main',
'title' => '<Description materials>',
],
],
],
'pagination' => [
[
'offset' => 20,
'limit' => 10,
],
],
]),
]);

$directories = $this->crowdin->directory->search([
'filter' => 'main',
'projectIds' => '2,3',
'userId' => 6,
'limit' => 10,
'offset' => 20,
]);

$this->assertInstanceOf(ModelCollection::class, $directories);
$this->assertCount(1, $directories);
$this->assertInstanceOf(Directory::class, $directories[0]);
$this->assertEquals(4, $directories[0]->getId());
$this->assertEquals(2, $directories[0]->getProjectId());
}

public function testGetAndUpdate()
{
$this->mockRequestGet('/projects/2/directories/34', '{
Expand Down
Loading
Loading