Skip to content

Commit 151d20e

Browse files
committed
Update docs
1 parent 62e54a3 commit 151d20e

File tree

4 files changed

+33
-33
lines changed

4 files changed

+33
-33
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ You can now use the `getApi()` method to create and get a specific Redmine API.
310310
```php
311311
<?php
312312

313-
$client->getApi('user')->all();
313+
$client->getApi('user')->list();
314314
$client->getApi('user')->listing();
315315

316316
$client->getApi('issue')->create([
@@ -319,7 +319,7 @@ $client->getApi('issue')->create([
319319
'description' => 'a long description blablabla',
320320
'assigned_to_id' => 123, // or 'assigned_to' => 'user1' OR 'groupXX'
321321
]);
322-
$client->getApi('issue')->all([
322+
$client->getApi('issue')->list([
323323
'limit' => 1000
324324
]);
325325
```

docs/usage.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -226,19 +226,19 @@ To check for failed requests you can afterwards check the status code via `$clie
226226
```php
227227
// ----------------------------
228228
// Trackers
229-
$client->getApi('tracker')->all();
229+
$client->getApi('tracker')->list();
230230
$client->getApi('tracker')->listing();
231231

232232
// ----------------------------
233233
// Issue statuses
234-
$client->getApi('issue_status')->all();
234+
$client->getApi('issue_status')->list();
235235
$client->getApi('issue_status')->listing();
236236
$client->getApi('issue_status')->getIdByName('New');
237237

238238
// ----------------------------
239239
// Project
240-
$client->getApi('project')->all();
241-
$client->getApi('project')->all([
240+
$client->getApi('project')->list();
241+
$client->getApi('project')->list([
242242
'limit' => 10,
243243
]);
244244
$client->getApi('project')->listing();
@@ -257,7 +257,7 @@ $client->getApi('project')->remove($projectId);
257257

258258
// ----------------------------
259259
// Users
260-
$client->getApi('user')->all();
260+
$client->getApi('user')->list();
261261
$client->getApi('user')->listing();
262262
$client->getApi('user')->getCurrentUser([
263263
'include' => [
@@ -290,15 +290,15 @@ $client->getApi('user')->create([
290290
// ----------------------------
291291
// Issues
292292
$client->getApi('issue')->show($issueId);
293-
$client->getApi('issue')->all([
293+
$client->getApi('issue')->list([
294294
'limit' => 100,
295295
]);
296-
$client->getApi('issue')->all(['category_id' => $categoryId]);
297-
$client->getApi('issue')->all(['tracker_id' => $trackerId]);
298-
$client->getApi('issue')->all(['status_id' => 'closed']);
299-
$client->getApi('issue')->all(['assigned_to_id' => $userId]);
300-
$client->getApi('issue')->all(['project_id' => 'test']);
301-
$client->getApi('issue')->all([
296+
$client->getApi('issue')->list(['category_id' => $categoryId]);
297+
$client->getApi('issue')->list(['tracker_id' => $trackerId]);
298+
$client->getApi('issue')->list(['status_id' => 'closed']);
299+
$client->getApi('issue')->list(['assigned_to_id' => $userId]);
300+
$client->getApi('issue')->list(['project_id' => 'test']);
301+
$client->getApi('issue')->list([
302302
'offset' => 100,
303303
'limit' => 100,
304304
'sort' => 'id',
@@ -375,7 +375,7 @@ $client->getApi('issue')->create([
375375

376376
// ----------------------------
377377
// Issue categories
378-
$client->getApi('issue_category')->all('project1');
378+
$client->getApi('issue_category')->listByProject('project1');
379379
$client->getApi('issue_category')->listing($projectId);
380380
$client->getApi('issue_category')->show($categoryId);
381381
$client->getApi('issue_category')->getIdByName($projectId, 'Administration');
@@ -392,7 +392,7 @@ $client->getApi('issue_category')->remove($categoryId, [
392392

393393
// ----------------------------
394394
// Versions
395-
$client->getApi('version')->all('test');
395+
$client->getApi('version')->listByProject('test');
396396
$client->getApi('version')->listing('test');
397397
$client->getApi('version')->show($versionId);
398398
$client->getApi('version')->getIdByName('test', 'v2');
@@ -413,24 +413,24 @@ file_put_contents('example.png', $file_content);
413413

414414
// ----------------------------
415415
// News
416-
$client->getApi('news')->all('test');
417-
$client->getApi('news')->all();
416+
$client->getApi('news')->list();
417+
$client->getApi('news')->listByProject('test');
418418

419419
// ----------------------------
420420
// Roles
421-
$client->getApi('role')->all();
421+
$client->getApi('role')->list();
422422
$client->getApi('role')->show(1);
423423
$client->getApi('role')->listing();
424424

425425
// ----------------------------
426426
// Queries
427-
$client->getApi('query')->all();
427+
$client->getApi('query')->list();
428428

429429
// ----------------------------
430430
// Time entries
431-
$client->getApi('time_entry')->all();
431+
$client->getApi('time_entry')->list();
432432
$client->getApi('time_entry')->show($timeEntryId);
433-
$client->getApi('time_entry')->all([
433+
$client->getApi('time_entry')->list([
434434
'issue_id' => 1234,
435435
'project_id' => 1234,
436436
'spent_on' => '2015-04-13',
@@ -470,17 +470,17 @@ $client->getApi('time_entry')->remove($timeEntryId);
470470

471471
// ----------------------------
472472
// Time entry activities
473-
$client->getApi('time_entry_activity')->all();
473+
$client->getApi('time_entry_activity')->list();
474474

475475
// ----------------------------
476476
// Issue relations
477-
$client->getApi('issue_relation')->all($issueId);
477+
$client->getApi('issue_relation')->listByIssueId($issueId);
478478
$client->getApi('issue_relation')->show($issueRelationId);
479479
$client->getApi('issue_relation')->remove($issueRelationId);
480480

481481
// ----------------------------
482482
// Group (of members)
483-
$client->getApi('group')->all();
483+
$client->getApi('group')->list();
484484
$client->getApi('group')->listing();
485485
$client->getApi('group')->show($groupId, ['include' => 'users,memberships']);
486486
$client->getApi('group')->remove($groupId);
@@ -493,7 +493,7 @@ $client->getApi('group')->create([
493493

494494
// ----------------------------
495495
// Project memberships
496-
$client->getApi('membership')->all($projectId);
496+
$client->getApi('membership')->listByProject($projectId);
497497
$client->getApi('membership')->create($projectId, [
498498
'user_id' => null,
499499
'role_ids' => [],
@@ -502,11 +502,11 @@ $client->getApi('membership')->remove($membershipId);
502502

503503
// ----------------------------
504504
// Issue priorities
505-
$client->getApi('issue_priority')->all();
505+
$client->getApi('issue_priority')->list();
506506

507507
// ----------------------------
508508
// Wiki
509-
$client->getApi('wiki')->all('testProject');
509+
$client->getApi('wiki')->listByProject('testProject');
510510
$client->getApi('wiki')->show('testProject', 'about');
511511
$client->getApi('wiki')->show('testProject', 'about', $version);
512512
$client->getApi('wiki')->create('testProject', 'about', [
@@ -523,19 +523,19 @@ $client->getApi('wiki')->remove('testProject', 'about');
523523

524524
// ----------------------------
525525
// Issues' stats (see https://github.com/kbsali/php-redmine-api/issues/44)
526-
$issues['all'] = $client->getApi('issue')->all([
526+
$issues['all'] = $client->getApi('issue')->list([
527527
'limit' => 1,
528528
'tracker_id' => 1,
529529
'status_id' => '*',
530530
])['total_count'];
531531

532-
$issues['opened'] = $client->getApi('issue')->all([
532+
$issues['opened'] = $client->getApi('issue')->list([
533533
'limit' => 1,
534534
'tracker_id' => 1,
535535
'status_id' => 'open',
536536
])['total_count'];
537537

538-
$issues['closed'] = $client->getApi('issue')->all([
538+
$issues['closed'] = $client->getApi('issue')->list([
539539
'limit' => 1,
540540
'tracker_id' => 1,
541541
'status_id' => 'closed',

src/Redmine/Api/User.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ public function all(array $params = [])
6262
public function listing($forceUpdate = false, array $params = [])
6363
{
6464
if (empty($this->users) || $forceUpdate) {
65-
$this->all($params);
65+
$this->list($params);
6666
}
6767
$ret = [];
6868
if (is_array($this->users) && isset($this->users['users'])) {

src/Redmine/Api/Version.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ public function all($project, array $params = [])
7373
public function listing($project, $forceUpdate = false, $reverse = true, array $params = [])
7474
{
7575
if (true === $forceUpdate || empty($this->versions)) {
76-
$this->all($project, $params);
76+
$this->listByProject($project, $params);
7777
}
7878
$ret = [];
7979
foreach ($this->versions['versions'] as $e) {

0 commit comments

Comments
 (0)