Skip to content

Commit

Permalink
refactor(namespace): reorganize imports and make psr-4 conform
Browse files Browse the repository at this point in the history
  • Loading branch information
DumbergerL committed Jun 20, 2023
1 parent cd31281 commit e73b603
Show file tree
Hide file tree
Showing 199 changed files with 429 additions and 290 deletions.
12 changes: 8 additions & 4 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,14 @@
"description": "API-client for churchtools",
"type": "library",
"autoload": {
"classmap": [
"src/",
"tests/"
]
"psr-4": {
"CTApi\\": "src"
}
},
"autoload-dev": {
"psr-4": {
"CTApi\\Test\\": "tests"
}
},
"require": {
"guzzlehttp/guzzle": "^7",
Expand Down
2 changes: 1 addition & 1 deletion docs/Docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ extends and improves the unit-test suite. The Github CI executes these unit-test
code. To include a unit-test code-sample, use this template syntax:

```
{{ \Tests\Unit\Docs\EventRequestTest.testEventRequestDocExample }}
{{ \CTApi\Test\Unit\Docs\EventRequestTest.testEventRequestDocExample }}
```

The Doc-Generator takes the unit-test code and transforms the assertEquals statements to more readable code. All
Expand Down
4 changes: 4 additions & 0 deletions docs/out/AbsenceAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
```php
use CTApi\Models\Absence;
use CTApi\Requests\AbsenceRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$absences = AbsenceRequest::forPerson(118)
->where("from_date", "2022-01-01")
Expand Down Expand Up @@ -47,6 +48,7 @@
```php
use CTApi\Models\Absence;
use CTApi\Requests\AbsenceRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$absence = new Absence();
$absence->setStartDate("2020-09-13")->setEndDate("2020-09-14");
Expand Down Expand Up @@ -90,6 +92,7 @@
```php
use CTApi\Models\Absence;
use CTApi\Requests\AbsenceRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$absence = AbsenceRequest::findOrFail(118, 211); // for person with id 118 and absence with id 211

Expand All @@ -111,6 +114,7 @@
```php
use CTApi\Models\Absence;
use CTApi\Requests\AbsenceRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$absence = AbsenceRequest::findOrFail(118, 211); // for person with id 118 and absence with id 211

Expand Down
1 change: 1 addition & 0 deletions docs/out/CTConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,7 @@ CTConfig::setPaginationPageSize(400);

```php
use CTApi\Requests\CSRFTokenRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$nullableToken = CSRFTokenRequest::get(); // can be null|string
$notNullToken = CSRFTokenRequest::getOrFail(); // throws exception if null
Expand Down
3 changes: 3 additions & 0 deletions docs/out/CalendarAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Load all calendars:
```php
use CTApi\Requests\AppointmentRequest;
use CTApi\Requests\CalendarRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$allCalendars = CalendarRequest::all();
$lastCalendar = end($allCalendars);
Expand Down Expand Up @@ -38,6 +39,7 @@ Load appointments for calendar:
```php
use CTApi\Requests\AppointmentRequest;
use CTApi\Requests\CalendarRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$allCalendars = CalendarRequest::all();
$lastCalendar = end($allCalendars);
Expand Down Expand Up @@ -124,6 +126,7 @@ Load appointments for multiple calendars:
```php
use CTApi\Requests\AppointmentRequest;
use CTApi\Requests\CalendarRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$appointments = AppointmentRequest::forCalendar(21)->get();
$appointments = AppointmentRequest::forCalendars([21, 22])
Expand Down
17 changes: 13 additions & 4 deletions docs/out/DBFields.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,11 @@
## Retrieve all DB-fields:

```php
use CTApi\CTConfig;
use CTApi\Requests\GroupRequest;
use CTApi\Requests\PersonRequest;
use Requests\DBFieldRequest;
use CTApi\Requests\DBFieldRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$dbFields = DBFieldRequest::all();
$dbField5pmName = $dbFields[0];
Expand Down Expand Up @@ -82,9 +84,11 @@
## Retrieve single DB-field:

```php
use CTApi\CTConfig;
use CTApi\Requests\GroupRequest;
use CTApi\Requests\PersonRequest;
use Requests\DBFieldRequest;
use CTApi\Requests\DBFieldRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$dbField5pmName = DBFieldRequest::find(141);
// or
Expand All @@ -105,10 +109,13 @@
To access the custom DBFields, utilize the `getDBFieldData()` method. This will provide an array where the column name of the DBField serves as the key and holds the corresponding value. Alternatively, you can use the `requestDBFields()->get()` method to retrieve a list of DBFieldValueContainers. Each container includes the key, value, and additional details from the DBField model such as name, content-type, and other relevant information. Example for **GroupInformation**:

```php
use CTApi\CTConfig;
use CTApi\Requests\GroupRequest;
use CTApi\Requests\PersonRequest;
use Requests\DBFieldRequest;
use CTApi\Requests\DBFieldRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

CTConfig::enableDebugging();
$group = GroupRequest::findOrFail(9);
$groupInformation = $group->getInformation();

Expand Down Expand Up @@ -158,9 +165,11 @@ To access the custom DBFields, utilize the `getDBFieldData()` method. This will
DBFields are also existing for **Persons**:

```php
use CTApi\CTConfig;
use CTApi\Requests\GroupRequest;
use CTApi\Requests\PersonRequest;
use Requests\DBFieldRequest;
use CTApi\Requests\DBFieldRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$person = PersonRequest::findOrFail(12);
$dbFieldContainerList = $person->requestDBFields()->get();
Expand Down
3 changes: 3 additions & 0 deletions docs/out/EventAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
```php
use CTApi\Requests\EventAgendaRequest;
use CTApi\Requests\EventRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

// Retrieve all events
$allEvents = EventRequest::all();
Expand Down Expand Up @@ -67,6 +68,7 @@
```php
use CTApi\Requests\EventAgendaRequest;
use CTApi\Requests\EventRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$event = EventRequest::find(21);

Expand Down Expand Up @@ -113,6 +115,7 @@
```php
use CTApi\Requests\EventAgendaRequest;
use CTApi\Requests\EventRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$event = EventRequest::find(21);
$eventServices = $event?->getEventServices() ?? [];
Expand Down
7 changes: 7 additions & 0 deletions docs/out/FileAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ The FileRequestBuilder can be accessed via the FileRequest-Facade:
```php
use CTApi\Models\File;
use CTApi\Requests\FileRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

FileRequest::forAvatar(21);
FileRequest::forGroupImage(21);
Expand All @@ -26,6 +27,7 @@ Or you can call the builder direct in the model. E.q. in the events-model:
```php
use CTApi\Models\File;
use CTApi\Requests\FileRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$event = new \CTApi\Models\Event();
$event->requestFiles()?->get();
Expand All @@ -43,6 +45,7 @@ Returns an array with all available files. The Avatar-Route only contains one fi
```php
use CTApi\Models\File;
use CTApi\Requests\FileRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$files = FileRequest::forAvatar(21)->get();
$avatar = end($files);
Expand Down Expand Up @@ -93,6 +96,7 @@ Deletes all files that are attached to the domain-model.
```php
use CTApi\Models\File;
use CTApi\Requests\FileRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

FileRequest::forAvatar(23)->delete();

Expand All @@ -110,6 +114,7 @@ If you want to delete one specific file you can use the delete-method:
```php
use CTApi\Models\File;
use CTApi\Requests\FileRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$files = FileRequest::forEvent(21)->get();

Expand All @@ -126,6 +131,7 @@ If you want to delete one specific file you can use the delete-method:
```php
use CTApi\Models\File;
use CTApi\Requests\FileRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$files = FileRequest::forAvatar(22)->get();
$avatarFile = end($files);
Expand All @@ -146,6 +152,7 @@ uploaded image. The Event-model e.q. also accepts multiple file-attachements.
```php
use CTApi\Models\File;
use CTApi\Requests\FileRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$newFile = (new FileRequestBuilder("avatar", 22))->upload(__DIR__ . "/../../integration/Requests/resources/avatar-1.png");

Expand Down
7 changes: 6 additions & 1 deletion docs/out/GroupAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
```php
use CTApi\Requests\GroupRequest;
use CTApi\Requests\PersonRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

/**
* Group-Request
Expand Down Expand Up @@ -193,6 +194,7 @@

```php
use CTApi\Requests\GroupMemberRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$groupId = 21;
$personId = 221;
Expand Down Expand Up @@ -222,6 +224,7 @@
use CTApi\Models\Group;
use CTApi\Requests\GroupMeetingRequest;
use CTApi\Requests\GroupRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$meetings = $this->group->requestGroupMeetings()
?->where("start_date", "2022-11-01")
Expand Down Expand Up @@ -275,6 +278,7 @@
use CTApi\Models\Group;
use CTApi\Requests\GroupMeetingRequest;
use CTApi\Requests\GroupRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$meetings = GroupMeetingRequest::forGroup(21)->get();
$meeting = $meetings[0];
Expand All @@ -297,7 +301,8 @@
## GroupMemberFields

```php
use Requests\GroupMemberFieldsRequest;
use CTApi\Requests\GroupMemberFieldsRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$fields = GroupMemberFieldsRequest::forGroup(9)->get();

Expand Down
2 changes: 2 additions & 0 deletions docs/out/Models.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@ directly:
```php
use CTApi\Models\Event;
use CTApi\Models\EventAgenda;
use CTApi\Test\Unit\TestCaseHttpMocked;

$event = Event::createModelFromData(['id' => 21]);
$agenda = $event->requestAgenda();
Expand All @@ -125,6 +126,7 @@ the [Requests](Requests.md) methods and type:
```php
use CTApi\Models\Event;
use CTApi\Models\EventAgenda;
use CTApi\Test\Unit\TestCaseHttpMocked;

$eventAgenda = EventAgenda::createModelFromData(['id' => 21]);

Expand Down
3 changes: 3 additions & 0 deletions docs/out/PermissionAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

```php
use CTApi\Requests\PermissionRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$internalGroupPermission = PermissionRequest::forGroup(21)->get();

Expand All @@ -24,6 +25,7 @@

```php
use CTApi\Requests\PermissionRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$internalPersonPermission = PermissionRequest::forPerson(23)->get();

Expand All @@ -49,6 +51,7 @@

```php
use CTApi\Requests\PermissionRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$globalPermission = PermissionRequest::myPermissions()->get();

Expand Down
9 changes: 9 additions & 0 deletions docs/out/PersonAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
```php
use CTApi\Models\Person;
use CTApi\Requests\PersonRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

// logged in user
$myself = PersonRequest::whoami();
Expand Down Expand Up @@ -51,6 +52,7 @@
```php
use CTApi\Models\Person;
use CTApi\Requests\PersonRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$person = (new Person())->setId("21");

Expand Down Expand Up @@ -95,6 +97,7 @@
```php
use CTApi\Models\Person;
use CTApi\Requests\PersonRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$birthdayPersons = PersonRequest::birthdays()
->where("start_date", "2022-01-01")
Expand Down Expand Up @@ -131,6 +134,7 @@
```php
use CTApi\Models\Person;
use CTApi\Requests\PersonRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$newPerson = new Person();
$newPerson->setFirstName("John")
Expand All @@ -151,6 +155,7 @@ Therefore you can add the `force` parameter and set it to `true`.
```php
use CTApi\Models\Person;
use CTApi\Requests\PersonRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$newPerson = new Person();
$newPerson->setFirstName("John")
Expand All @@ -174,6 +179,7 @@ Follow this example:
```php
use CTApi\Models\Person;
use CTApi\Requests\PersonRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$person = PersonRequest::findOrFail(21);
$person->setEmail('new-mail@example.com');
Expand All @@ -190,6 +196,7 @@ data sent to the API, by adding a whitelist of attributes.
```php
use CTApi\Models\Person;
use CTApi\Requests\PersonRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$person = PersonRequest::findOrFail(21);
$person->setEmail('new-mail@example.com');
Expand All @@ -207,6 +214,7 @@ The following attributes can be updated:
```php
use CTApi\Models\Person;
use CTApi\Requests\PersonRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$person = PersonRequest::findOrFail(21);

Expand All @@ -225,6 +233,7 @@ Delete person via PersonRequest:
```php
use CTApi\Models\Person;
use CTApi\Requests\PersonRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$person = PersonRequest::findOrFail(21);

Expand Down
2 changes: 2 additions & 0 deletions docs/out/PublicGroupAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Load Data of Group Homepage with Hash-String. This route is public, so no authen

```php
use CTApi\Requests\PublicGroupRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$groupHomepage = PublicGroupRequest::get("wryawBH318GLHasgm27awB0c241aj");

Expand Down Expand Up @@ -35,6 +36,7 @@ Further the PublicGroup-Model contains the following Methods:

```php
use CTApi\Requests\PublicGroupRequest;
use CTApi\Test\Unit\TestCaseHttpMocked;

$groupHomepage = PublicGroupRequest::get("wryawBH318GLHasgm27awB0c241aj");
$group = $groupHomepage->getGroups()[0];
Expand Down
Loading

0 comments on commit e73b603

Please sign in to comment.