$
$ :mixed|null
alias
ToPlainObject(string $language = null,boolean $withparent = true): Object
Convert to plain data set
Translate and expose the current data attribute as plain resolved object
string | $language | A system language code or empty for raw setup |
boolean | $withparent | When set to true the attributes will be resolved witch parent attributes included |
A simple attribute based php object
UpdateAttributeAlias(object $attr,string $value): \FAA\Obj\Result
Called on update the alias attribute
Does a check if the alias is in use already and denies update when it is
object | $attr | The attribute definition |
string | $value | The new alias |
A system result object
UpdateAttributeEmailaddress(object $attr,string $value): \FAA\Obj\Result
Called on update the email attribute
Does a check if the alias is in use already and denies update when it is
object | $attr | The attribute definition |
string | $value | The new email address |
A system result object
UpdateAttributeGroups(object $attr,array $value): \FAA\Obj\Result
Called on update the groups attribute
Does a check if the current user is allowed to do this change
object | $attr | The attribute definition |
array | $value | The new set of groups |
A system result object
AddSubscription(integer $id,string $type,null $date = null): \FAA\Obj\Result
Add a certain subscription item
When the subscription is present already, do not add but reactivate at current date
integer | $id | The id of the lesson |
string | $type | The type of lesson |
null | $date | When given, the registration date |
A system result
SetExternalReference(string $type,string $ext_id,string $ext_account_id = null): \FAA\Obj\Result
Add or update existing external reference
string | $type | The provider type |
string | $ext_id | The external id |
string | $ext_account_id | Additional external id |
A system result
MarkSubscriptionForTermination(): \FAA\Obj\Result
Set an subscription to expire in teh future
Depending on the included subscription article the basket will be processed and the transition will be defined in the extra field of the users assignment context
A result object
ActiveSubscriptions(boolean $resolved = false): array<mixed,string>|array<mixed,\FAA\Obj\Generic\BaseLesson>
Load list of active subscriptions
Fetches all currently valid and active subscription ids
boolean | $resolved |
AddMobileDevice(array $data,boolean $update_existing = false): \FAA\Obj\Result
Add mobile device
This function adds a mobile device to the profile When defined it can update existing device with the new data
array | $data | The new device data |
boolean | $update_existing | When true an existing device will be replaced |
A system result object
CheckPermissionChangeAssignedGroups(array $groups): \FAA\Obj\Result
Check permission for groups
test if the given groups have a level lower the admins level and deny access when level exceeded
array | $groups | A list of user group id's |
True or false when level exceeded
Save(boolean $force_new_id = false): \FAA\Obj\Result
save object entry in file system and git repository store the current payload inside the system storage and commit the changes to the local repository
boolean | $force_new_id | Indicate force new id on demand (local id empty) |
A default system result set