Presentation of ecs enrolment status. More...

Collaboration diagram for ilECSEnrolmentStatus:

Public Member Functions
	__construct ()

	setUrl (string $a_url)

	getUrl ()

	setId (string $a_id)

	getId ()

	setPersonId (string $a_person)

	getPersonId ()

	setPersonIdType (string $a_type)

	getPersonIdType ()

	setStatus (string $a_status)

	getStatus ()

	loadFromJson (object $json)

Data Fields
const	STATUS_ACTIVE = 'active'

const	STATUS_PENDING = 'pending'

const	STATUS_DENIED = 'denied'

const	STATUS_REJECTED = 'rejected'

const	STATUS_UNSUBSCRIBED = 'unsubscribed'

const	STATUS_ACCOUNT_DEACTIVATED = 'account_deactivated'

const	ID_EPPN = 'ecs_ePPN'

const	ID_LOGIN_UID = 'ecs_loginUID'

const	ID_LOGIN = 'ecs_login'

const	ID_UID = 'ecs_uid'

const	ID_EMAIL = 'ecs_email'

const	ID_PERSONAL_UNIQUE_CODE = 'ecs_PersonalUniqueCode'

const	ID_CUSTOM = 'ecs_custom'

string	$url = ''

string	$id = ''

string	$personID = ''

string	$personIDtype = ''

string	$status = ''

Detailed Description

Presentation of ecs enrolment status.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 25 of file class.ilECSEnrolmentStatus.php.

Constructor & Destructor Documentation

◆ __construct()

ilECSEnrolmentStatus::__construct ( )

Definition at line 51 of file class.ilECSEnrolmentStatus.php.

52 {

53 }

Member Function Documentation

◆ getId()

ilECSEnrolmentStatus::getId ( )

Definition at line 70 of file class.ilECSEnrolmentStatus.php.

References $id.

Referenced by ilECSEnrolmentStatusCommandQueueHandler\doUpdate().

                            : string
     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getPersonId()

ilECSEnrolmentStatus::getPersonId ( )

Definition at line 80 of file class.ilECSEnrolmentStatus.php.

References $personID.

                                  : string
     {
         return $this->personID;
     }

◆ getPersonIdType()

ilECSEnrolmentStatus::getPersonIdType ( )

Definition at line 90 of file class.ilECSEnrolmentStatus.php.

References $personIDtype.

                                      : string
     {
         return $this->personIDtype;
     }

◆ getStatus()

ilECSEnrolmentStatus::getStatus ( )

Definition at line 100 of file class.ilECSEnrolmentStatus.php.

References $status.

Referenced by ilECSEnrolmentStatusCommandQueueHandler\doUpdate().

                                : string
     {
         return $this->status;
     }

Here is the caller graph for this function:

◆ getUrl()

ilECSEnrolmentStatus::getUrl ( )

Definition at line 60 of file class.ilECSEnrolmentStatus.php.

References $url.

                             : string
     {
         return $this->url;
     }

◆ loadFromJson()

ilECSEnrolmentStatus::loadFromJson ( object $json )

Definition at line 105 of file class.ilECSEnrolmentStatus.php.

References setId(), setPersonId(), setPersonIdType(), setStatus(), and setUrl().

                                               : void
     {
         $this->setId($json->id);
         $this->setPersonId($json->personID);
         $this->setPersonIdType($json->personIDtype);
         $this->setUrl($json->url);
         $this->setStatus($json->status);
     }

Here is the call graph for this function:

◆ setId()

ilECSEnrolmentStatus::setId ( string $a_id )

Definition at line 65 of file class.ilECSEnrolmentStatus.php.

Referenced by loadFromJson().

                                        : void
     {
         $this->id = $a_id;
     }

Here is the caller graph for this function:

◆ setPersonId()

ilECSEnrolmentStatus::setPersonId ( string $a_person )

Definition at line 75 of file class.ilECSEnrolmentStatus.php.

Referenced by loadFromJson().

                                                  : void
     {
         $this->personID = $a_person;
     }

Here is the caller graph for this function:

◆ setPersonIdType()

ilECSEnrolmentStatus::setPersonIdType ( string $a_type )

Definition at line 85 of file class.ilECSEnrolmentStatus.php.

Referenced by loadFromJson().

                                                    : void
     {
         $this->personIDtype = $a_type;
     }

Here is the caller graph for this function:

◆ setStatus()

ilECSEnrolmentStatus::setStatus ( string $a_status )

Definition at line 95 of file class.ilECSEnrolmentStatus.php.

Referenced by loadFromJson().

                                                : void
     {
         $this->status = $a_status;
     }

Here is the caller graph for this function:

◆ setUrl()

ilECSEnrolmentStatus::setUrl ( string $a_url )

Definition at line 55 of file class.ilECSEnrolmentStatus.php.

Referenced by loadFromJson().

                                          : void
     {
         $this->url = $a_url;
     }

Here is the caller graph for this function:

Field Documentation

◆ $id

string ilECSEnrolmentStatus::$id = ''

Definition at line 45 of file class.ilECSEnrolmentStatus.php.

Referenced by getId().

◆ $personID

string ilECSEnrolmentStatus::$personID = ''

Definition at line 46 of file class.ilECSEnrolmentStatus.php.

Referenced by getPersonId().

◆ $personIDtype

string ilECSEnrolmentStatus::$personIDtype = ''

Definition at line 47 of file class.ilECSEnrolmentStatus.php.

Referenced by getPersonIdType().

◆ $status

string ilECSEnrolmentStatus::$status = ''

Definition at line 48 of file class.ilECSEnrolmentStatus.php.

Referenced by getStatus().

◆ $url

string ilECSEnrolmentStatus::$url = ''

Definition at line 44 of file class.ilECSEnrolmentStatus.php.

Referenced by getUrl().

◆ ID_CUSTOM

const ilECSEnrolmentStatus::ID_CUSTOM = 'ecs_custom'

Definition at line 40 of file class.ilECSEnrolmentStatus.php.

◆ ID_EMAIL

const ilECSEnrolmentStatus::ID_EMAIL = 'ecs_email'

Definition at line 38 of file class.ilECSEnrolmentStatus.php.

◆ ID_EPPN

const ilECSEnrolmentStatus::ID_EPPN = 'ecs_ePPN'

Definition at line 34 of file class.ilECSEnrolmentStatus.php.

◆ ID_LOGIN

const ilECSEnrolmentStatus::ID_LOGIN = 'ecs_login'

Definition at line 36 of file class.ilECSEnrolmentStatus.php.

◆ ID_LOGIN_UID

const ilECSEnrolmentStatus::ID_LOGIN_UID = 'ecs_loginUID'

Definition at line 35 of file class.ilECSEnrolmentStatus.php.

◆ ID_PERSONAL_UNIQUE_CODE

const ilECSEnrolmentStatus::ID_PERSONAL_UNIQUE_CODE = 'ecs_PersonalUniqueCode'

Definition at line 39 of file class.ilECSEnrolmentStatus.php.

◆ ID_UID

const ilECSEnrolmentStatus::ID_UID = 'ecs_uid'

Definition at line 37 of file class.ilECSEnrolmentStatus.php.

Referenced by ilECSEnrolmentStatusCommandQueueHandler\handleCreate(), and ilECSAppEventListener\updateEnrolmentStatus().

◆ STATUS_ACCOUNT_DEACTIVATED

const ilECSEnrolmentStatus::STATUS_ACCOUNT_DEACTIVATED = 'account_deactivated'

Definition at line 32 of file class.ilECSEnrolmentStatus.php.

Referenced by ilECSEnrolmentStatusCommandQueueHandler\doUpdate().

◆ STATUS_ACTIVE

const ilECSEnrolmentStatus::STATUS_ACTIVE = 'active'

Definition at line 27 of file class.ilECSEnrolmentStatus.php.

Referenced by ilECSEnrolmentStatusCommandQueueHandler\doUpdate(), and ilECSAppEventListener\handleEvent().

◆ STATUS_DENIED

const ilECSEnrolmentStatus::STATUS_DENIED = 'denied'

Definition at line 29 of file class.ilECSEnrolmentStatus.php.

Referenced by ilECSEnrolmentStatusCommandQueueHandler\doUpdate().

◆ STATUS_PENDING

const ilECSEnrolmentStatus::STATUS_PENDING = 'pending'

Definition at line 28 of file class.ilECSEnrolmentStatus.php.

Referenced by ilECSEnrolmentStatusCommandQueueHandler\doUpdate(), and ilECSAppEventListener\handleEvent().

◆ STATUS_REJECTED

const ilECSEnrolmentStatus::STATUS_REJECTED = 'rejected'

Definition at line 30 of file class.ilECSEnrolmentStatus.php.

Referenced by ilECSEnrolmentStatusCommandQueueHandler\doUpdate().

◆ STATUS_UNSUBSCRIBED

const ilECSEnrolmentStatus::STATUS_UNSUBSCRIBED = 'unsubscribed'

Definition at line 31 of file class.ilECSEnrolmentStatus.php.

Referenced by ilECSEnrolmentStatusCommandQueueHandler\doUpdate(), and ilECSAppEventListener\handleEvent().

The documentation for this class was generated from the following file:

components/ILIAS/WebServices/ECS/classes/Connectors/class.ilECSEnrolmentStatus.php

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getId()

◆ getPersonId()

◆ getPersonIdType()

◆ getStatus()

◆ getUrl()

◆ loadFromJson()

◆ setId()

◆ setPersonId()

◆ setPersonIdType()

◆ setStatus()

◆ setUrl()

Field Documentation

◆ $id

◆ $personID

◆ $personIDtype

◆ $status

◆ $url

◆ ID_CUSTOM

◆ ID_EMAIL

◆ ID_EPPN

◆ ID_LOGIN

◆ ID_LOGIN_UID

◆ ID_PERSONAL_UNIQUE_CODE

◆ ID_UID

◆ STATUS_ACCOUNT_DEACTIVATED

◆ STATUS_ACTIVE

◆ STATUS_DENIED

◆ STATUS_PENDING

◆ STATUS_REJECTED

◆ STATUS_UNSUBSCRIBED