use CTApi\Models\Groups\Group\GroupRequest;
use CTApi\Models\Groups\Person\PersonRequest;
use Tests\Unit\TestCaseDocExampleCode;
/**
* Group-Request
*/
// Retrieve all groups
$allGroups = GroupRequest::all();
$allGroups = GroupRequest::orderBy('name')->get();
$myGroups = PersonRequest::whoami()->requestGroups();
// Get specific Group
$group = GroupRequest::find(21); // returns "null" if id is invalid
$group = GroupRequest::findOrFail(21); // throws exception if id is invalid
/**
* Group-Data
*/
var_dump( $group->getId());
// Output: 21
var_dump( $group->getGuid());
// Output: "g21"
var_dump( $group->getName());
// Output: "Sermon Group"
var_dump( $group->getSecurityLevelForGroup());
// Output: "High"
var_dump( $group->getPermissions());
// Output: []
var_dump( $group->getFollowUp());
// Output: []
var_dump( $group->getRoles()[0]->getName());
// Output: "Admin"
// GroupHierarchie
$childGroups = $group->requestGroupChildren()?->get();
$parentGroups = $group->requestGroupParents()?->get();
// GroupInformation
$groupInformation = $group->getInformation();
var_dump( $groupInformation?->getImageUrl());
// Output: null
var_dump( $groupInformation?->getGroupHomepageUrl());
// Output: null
var_dump( $groupInformation?->getGroupStatusId());
// Output: 1
var_dump( $groupInformation?->getGroupTypeId());
// Output: 2
var_dump( $groupInformation?->getDateOfFoundation());
// Output: "1903-02-12"
var_dump( $groupInformation?->getDateOfFoundationAsDateTime()?->format("Y-m-d H:i:s"));
// Output: "1903-02-12 00:00:00"
var_dump( $groupInformation?->getEndDate());
// Output: null
var_dump( $groupInformation?->getEndDateAsDateTime()?->format("Y-m-d H:i:s"));
// Output: null
var_dump( $groupInformation?->getMeetingTime());
// Output: "17:00"
var_dump( $groupInformation?->getGroupCategoryId());
// Output: 3
$ageGroupIdList = implode("/", $groupInformation?->getAgeGroupIds());
var_dump( $ageGroupIdList);
// Output: "1/8"
var_dump( $groupInformation?->getTargetGroupId());
// Output: 2
var_dump( $groupInformation?->getMaxMembers());
// Output: 200
var_dump( $groupInformation?->getNote());
// Output: "Hello World Note"
var_dump( $groupInformation?->getCampusId());
// Output: null
var_dump( $groupInformation?->getChatStatus());
// Output: "NOT_STARTED"
var_dump( $groupInformation?->getSignUpOverrideRoleId());
// Output: null
// GroupSettings;
var_dump( $group->getSettings()?->getIsHidden());
// Output: false
var_dump( $group->getSettings()?->getIsOpenForMembers());
// Output: true
var_dump( $group->getSettings()?->getAllowSpouseRegistration());
// Output: true
var_dump( $group->getSettings()?->getAllowChildRegistration());
// Output: true
var_dump( $group->getSettings()?->getAllowSameEmailRegistration());
// Output: true
var_dump( $group->getSettings()?->getAutoAccept());
// Output: true
var_dump( $group->getSettings()?->getAllowWaitinglist());
// Output: true
var_dump( $group->getSettings()?->getWaitinglistMaxPersons());
// Output: 21
var_dump( $group->getSettings()?->getAutomaticMoveUp());
// Output: true
var_dump( $group->getSettings()?->getIsPublic());
// Output: false
var_dump( $group->getSettings()?->getGroupMeeting());
// Output: []
var_dump( $group->getSettings()?->getQrCodeCheckin());
// Output: false
var_dump( $group->getSettings()?->getNewMember());
// Output: []
// GroupRoles
$groupRole = $group->getRoles()[0];
var_dump( $groupRole->getId());
// Output: "21"
var_dump( $groupRole->getGroupTypeId());
// Output: "21"
var_dump( $groupRole->getName());
// Output: "Admin"
var_dump( $groupRole->getShorty());
// Output: "Adm"
var_dump( $groupRole->getSortKey());
// Output: "name"
var_dump( $groupRole->getToDelete());
// Output: true
var_dump( $groupRole->getHasRequested());
// Output: false
var_dump( $groupRole->getIsLeader());
// Output: false
var_dump( $groupRole->getIsDefault());
// Output: false
var_dump( $groupRole->getIsHidden());
// Output: false
var_dump( $groupRole->getGrowPathId());
// Output: false
var_dump( $groupRole->getGroupTypeRoleId());
// Output: false
var_dump( $groupRole->getForceTwoFactorAuth());
// Output: false
var_dump( $groupRole->getIsActive());
// Output: true
var_dump( $groupRole->getCanReadChat());
// Output: true
var_dump( $groupRole->getCanWriteChat());
// Output: true
// GroupMembers
$groupMember = $group->requestMembers()?->get()[0];
var_dump( $groupMember?->getPersonId());
// Output: 12
var_dump( $groupMember?->getGroupTypeRoleId());
// Output: 16
var_dump( $groupMember?->getGroupMemberStatus());
// Output: "active"
var_dump( $groupMember?->getMemberStartDate());
// Output: "2023-05-04"
var_dump( $groupMember?->getMemberEndDate());
// Output: "2023-06-01"
var_dump( $groupMember?->getMemberStartDateAsDateTime()?->format("Y-m-d H:i:s"));
// Output: "2023-05-04 00:00:00"
var_dump( $groupMember?->getMemberEndDateAsDateTime()?->format("Y-m-d H:i:s"));
// Output: "2023-06-01 00:00:00"
var_dump( $groupMember?->getFollowUpStep());
// Output: null
var_dump( $groupMember?->getFollowUpDiffDays());
// Output: null
var_dump( $groupMember?->getFollowUpUnsuccessfulBackGroupId());
// Output: null
var_dump( $groupMember?->getComment());
// Output: null
var_dump( $groupMember?->getWaitinglistPosition());
// Output: null
var_dump( $groupMember?->getFields());
// Output: []
var_dump( $groupMember?->getPersonFields());
// Output: []
$personGroupMember = $groupMember?->getPerson();
$personGroupMember = $groupMember?->requestPerson();
// Retrieve Group-Tags
$tags = $group->requestTags()?->get();
$tag = end($tags);
var_dump( $tag->getName());
// Output: "Leader"
var_dump( $tag->getId());
// Output: 8
/**
* Upadate Group-Image: See FileAPI
*/
$files = $group->requestGroupImage()?->get() ?? [];
$groupImage = end($files);
var_dump( $groupImage->getName());
// Output: "image-1.png"
//$group->requestGroupImage()?->upload("new-group-image.png"); use CTApi\Models\Groups\GroupMember\GroupMemberRequest;
$groupId = 21;
$personId = 221;
// Create Group-Membership
$groupMember = GroupMemberRequest::addMember($groupId, $personId);
// Update Group-Membership
$groupMember->setComment("Add User via CT-Api.");
$groupMember->setFields([]);
$groupMember->setGroupTypeRoleId("21");
$groupMember->setMemberEndDate("2040-01-01");
$groupMember->setMemberStartDate("2020-01-01");
$groupMember->setWaitinglistPosition("22");
GroupMemberRequest::updateMember($groupId, $groupMember);
// Delete Group-Membership
GroupMemberRequest::removeMember($groupId, $personId); use CTApi\Models\Groups\Group\Group;
use CTApi\Models\Groups\Group\GroupRequest;
use CTApi\Models\Groups\GroupMeeting\GroupMeetingRequest;
$meetings = $this->group->requestGroupMeetings()
?->where("start_date", "2022-11-01")
->where("end_date", "2022-11-15")
->get();
$meeting = $meetings[0];
var_dump( $meeting->getId());
// Output: 2652
var_dump( $meeting->getGroupId());
// Output: 21
var_dump( $meeting->getDateFrom());
// Output: "2022-11-09T18:30:00Z"
var_dump( $meeting->getDateTo());
// Output: "2022-11-09T18:30:00Z"
var_dump( $meeting->getDateFromAsDateTime()?->format("Y-m-d H:i:s"));
// Output: "2022-11-09 18:30:00"
var_dump( $meeting->getDateToAsDateTime()?->format("Y-m-d H:i:s"));
// Output: "2022-11-09 18:30:00"
var_dump( $meeting->getIsCompleted());
// Output: true
var_dump( $meeting->getIsCanceled());
// Output: false
var_dump( $meeting->getHasEditingStarted());
// Output: true
var_dump( $meeting->getNumGuests());
// Output: 5
var_dump( $meeting->getComment());
// Output: "Hello World"
var_dump( $meeting?->getStatistics()->getPresent());
// Output: 2
var_dump( $meeting?->getStatistics()->getAbsent());
// Output: 1
var_dump( $meeting?->getStatistics()->getUnsure());
// Output: 0
use CTApi\Models\Groups\Group\Group;
use CTApi\Models\Groups\Group\GroupRequest;
use CTApi\Models\Groups\GroupMeeting\GroupMeetingRequest;
$meetings = GroupMeetingRequest::forGroup(21)->get();
$meeting = $meetings[0];
$meetingMembers = $meeting->requestMembers()->get();
$meetingMember = $meetingMembers[0];
var_dump( $meetingMember->getIsCheckedIn());
// Output: true
var_dump( $meetingMember->getStatus());
// Output: "present"
$groupMember = $meetingMember->getMember();
// see GroupMember-Model use CTApi\Models\Groups\GroupMember\GroupMemberFieldsRequest;
$fields = GroupMemberFieldsRequest::forGroup(9)->get();
/**
* Array of GroupMemberFieldContainer. A GroupMemberFieldContainer can contain in either contain a Person-Field or a GroupMember-Field in its field-property (type: null|GroupMemberField|DBFieldContainer).
*/
$personField = $fields[0];
$memberField = $fields[1];
// $thirdField = $fields[3];
// ... = $fields[...];
/**
* Person Field (DB-Field)
*/
// type can be "person" (Person-Fields) or "group" (Group-Member-Fields)
var_dump( $personField->getType());
// Output: "person"
// GroupMemberFieldContainer->getField() can contain DBField or GroupMemberField.
$dbField = $personField->getDBFieldIfExists();
$unknownField = $personField->getGroupMemberFieldIfExists();
var_dump( $unknownField);
// Output: null
var_dump( $dbField->getId());
// Output: "54"
var_dump( $dbField->getIdAsInteger());
// Output: 54
var_dump( $dbField->getName());
// Output: "nickname"
var_dump( $dbField->getNameTranslated());
// Output: "Spitzname"
var_dump( $dbField->getColumn());
// Output: "spitzname"
var_dump( $dbField->getFieldCategory()?->getInternCode());
// Output: "f_address"
var_dump( $dbField->getFieldType()?->getInternCode());
// Output: "text"
var_dump( $dbField->getFieldType()?->getId());
// Output: 1
var_dump( $dbField->getLineEnding());
// Output: "(%) "
var_dump( $dbField->getSecurityLevel());
// Output: 1
var_dump( $dbField->getLength());
// Output: 30
var_dump( $dbField->getSortKey());
// Output: 3
var_dump( $dbField->getIsActive());
// Output: true
var_dump( $dbField->getIsNewPersonField());
// Output: false
var_dump( $dbField->getDeleteOnArchive());
// Output: false
var_dump( $dbField->getNullable());
// Output: false
var_dump( $dbField->getHideInFrontend());
// Output: false
var_dump( $dbField->getIsBasicInfo());
// Output: false
var_dump( $dbField->getOptions());
// Output: []
/**
* GroupMemberField
*/
var_dump( $memberField->getType());
// Output: "group"
$vocalRangeField = $memberField->getGroupMemberFieldIfExists();
var_dump( $vocalRangeField->getFieldName());
// Output: "vocal range"
var_dump( $vocalRangeField->getNote());
// Output: "vocal range of person from key to key"
var_dump( $vocalRangeField->getSortKey());
// Output: 1
var_dump( $vocalRangeField->getFieldTypeId());
// Output: 1
var_dump( $vocalRangeField->getFieldTypeCode());
// Output: "text"
var_dump( $vocalRangeField->getSecurityLevel());
// Output: 1
var_dump( $vocalRangeField->getDefaultValue());
// Output: null
var_dump( $vocalRangeField->getOptions());
// Output: []
use CTApi\Models\Groups\GroupType\GroupType;
use CTApi\Models\Groups\GroupType\GroupTypeRequest;
$groupTypes = GroupTypeRequest::all();
$groupTypeNames = array_map(function (GroupType $groupType) {
return $groupType->getName();
}, $groupTypes);
$groupTypeNameList = implode("/", $groupTypeNames);
var_dump( $groupTypeNameList);
// Output: "Dienst/Kleingruppe/Maßnahme/Merkmal"
use CTApi\Models\Groups\GroupType\GroupType;
use CTApi\Models\Groups\GroupType\GroupTypeRequest;
$groupType = GroupTypeRequest::find(2);
var_dump( $groupType?->getName());
// Output: "Dienst"
var_dump( $groupType?->getNameTranslated());
// Output: "Dienst"
var_dump( $groupType?->getNamePlural());
// Output: "Dienste"
var_dump( $groupType?->getNamePluralTranslated());
// Output: "Dienste"
var_dump( $groupType?->getShorty());
// Output: "DT"
var_dump( $groupType?->getDescription());
// Output: ""
var_dump( $groupType?->getIsLeaderNecessary());
// Output: false
var_dump( $groupType?->getAvailableForNewPerson());
// Output: false
var_dump( $groupType?->getPermissionDepth());
// Output: 1
var_dump( $groupType?->getSortKey());
// Output: 0
use CTApi\Models\Groups\GroupTypeRole\GroupTypeRoleRequest;
$roles = GroupTypeRoleRequest::all();
$role = $roles[0];
var_dump( $role->getId());
// Output: 15
var_dump( $role->getGroupTypeId());
// Output: 2
$groupType = $role->requestGroupType();
var_dump( $role->getGrowPathId());
// Output: null
var_dump( $role->getName());
// Output: "Mitarbeiter"
var_dump( $role->getShorty());
// Output: "MA"
var_dump( $role->getType());
// Output: "participant"
var_dump( $role->getIsDefault());
// Output: true
var_dump( $role->getIsHidden());
// Output: false
var_dump( $role->getIsLeader());
// Output: false
var_dump( $role->getSortKey());
// Output: 0
Retrieve all notes:
use CTApi\Models\Common\Note\NoteRequest;
$notes = NoteRequest::forGroup(212)->get();
var_dump( $notes[0]->getText());
// Output: "Hello new comment!"
var_dump( $notes[0]->getDomainId());
// Output: "17"
var_dump( $notes[0]->getDomainType());
// Output: "group"
var_dump( $notes[0]->getId());
// Output: "212"
Create new note:
use CTApi\Models\Common\Note\NoteRequest;
$note = NoteRequest::forGroup(52)->create("Add new comment.");
var_dump( $note->getText());
// Output: "Add new comment."
Update note:
use CTApi\Models\Common\Note\NoteRequest;
$note = NoteRequest::forGroup(52)->update(25, "Updated comment.");
var_dump( $note->getText());
// Output: "Updated comment."
Delete note:
use CTApi\Models\Common\Note\NoteRequest;
NoteRequest::forGroup(52)->delete(25);