OXO/Memsource-API
5
0
Fork 0
mirror of https://github.com/brunofontes/Memsource-API.git synced 2024-11-23 19:00:50 +00:00
Code Issues Projects Releases Wiki Activity

Refactoring function names as no one is using it yet

Browse Source
This commit is contained in:
Bruno F. Fontes 2019-06-25 10:47:05 -03:00
parent 6f19522c52
commit 13fadfe9ae
Signed by: brunofontes
GPG Key ID: EE3447CE80048495
4 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -96,13 +96,13 @@ $projectList = $memsource->project()->listProjects;
To use filters, add the API filter as parameter:
```php
$projectList = $memsource->project()->listProjects(['name' => 'Project X']);
$projectList = $memsource->project()->list(['name' => 'Project X']);
```
#### Get Project
```php
$projectList = $memsource->project()->getProject($projectUid);
$projectList = $memsource->project()->get($projectUid);
```
### Jobs
@ -112,7 +112,7 @@ $projectList = $memsource->project()->getProject($projectUid);
Only projectUid is essencial:
```php
$jobs = $memsource->jobs()->listJobs($projectUid, ['count' => true, 'filename' => 'my_file.html']);
$jobs = $memsource->jobs()->list($projectUid, ['count' => true, 'filename' => 'my_file.html']);
```
### Bilingual Files
@ -120,12 +120,12 @@ $jobs = $memsource->jobs()->listJobs($projectUid, ['count' => true, 'filename' =
#### Download Bilingual File
```php
$memsource->BilingualFile()->downloadBilingualFile($projectUid, ['JobUid1', 'jobUid2'], 'download.mxliff');
$memsource->BilingualFile()->download($projectUid, ['JobUid1', 'jobUid2'], 'download.mxliff');
```
#### Upload Bilingual File
```php
$parameters = ['format' => 'MXLF', 'saveToTransMemory' => 'None', 'setCompleted' => 'false'];
$result = $api->bilingualFile()->uploadBilingualFile('upload.mxliff', $parameters);
$result = $api->bilingualFile()->upload('upload.mxliff', $parameters);
```

5
src/BilingualFile.php
View File

@ -5,6 +5,7 @@
* @author Bruno Fontes <developer@brunofontes.net>
* @link https://github.com/brunofontes
*/
namespace BrunoFontes\Memsource;
class BilingualFile extends \BrunoFontes\Memsource\BaseApi
@ -27,7 +28,7 @@ class BilingualFile extends \BrunoFontes\Memsource\BaseApi
*
* @return array A list of the downloaded files
*/
public function downloadBilingualFile(string $projectUid, array $jobUids, string $filename): array
public function download(string $projectUid, array $jobUids, string $filename): array
{
$url = "/api2/v1/projects/{$projectUid}/jobs/bilingualFile";
@ -76,7 +77,7 @@ class BilingualFile extends \BrunoFontes\Memsource\BaseApi
*
* @return string The http request responde from API in json format
*/
public function uploadBilingualFile(string $filename, array $params): string
public function upload(string $filename, array $params): string
{
$urlParams = http_build_query($params);
$fileContent = file_get_contents($filename);

3
src/Jobs.php
View File

@ -10,7 +10,6 @@ namespace BrunoFontes\Memsource;
class Jobs extends \BrunoFontes\Memsource\BaseApi
{
/**
* List jobs of a project
* The API request returns a MAX of 50 Jobs.
@ -21,7 +20,7 @@ class Jobs extends \BrunoFontes\Memsource\BaseApi
*
* @return string The JSON answer from Memsource
*/
public function listJobs(string $projectUid, array $parameters = []): string
public function list(string $projectUid, array $parameters = []): string
{
$url = "/api2/v2/projects/{$projectUid}/jobs";
return $this->fetchApi->fetch('get', $url, $parameters);

4
src/Project.php
View File

@ -19,7 +19,7 @@ class Project extends \BrunoFontes\Memsource\BaseApi
*
* @return string The JSON answer from Memsource
*/
public function listProjects(array $queryParams = []): string
public function list(array $queryParams = []): string
{
return $this->fetchApi->fetch('get', $this->_url, $queryParams);
}
@ -31,7 +31,7 @@ class Project extends \BrunoFontes\Memsource\BaseApi
*
* @return string A json string with all project info
*/
public function getProject(string $projectUid): string
public function get(string $projectUid): string
{
return $this->fetchApi->fetch('get', "{$this->_url}/{$projectUid}");
}