ilECSParticipant Class Reference

Collaboration diagram for ilECSParticipant:

Public Member Functions
	__construct ($json_obj, $a_cid)
	Constructor.
	getCommunityId ()
	get community id
	getMID ()
	get mid
	getEmail ()
	get email
	getCertId ()
	get cert id
	getDNS ()
	get dns
	getDescription ()
	get description
	getParticipantName ()
	get participant name
	getAbbreviation ()
	get abbreviation of participant
	isPublishable ()
	is publishable (enabled and mid with own cert id)
	isSelf ()
	is self
	isEnabled ()
	is Enabled

Protected Attributes
	$json_obj
	$cid
	$mid
	$email
	$certid
	$dns
	$description
	$participantname
	$abr
	$is_self
	$settings
	$part_settings

Private Member Functions
	read ()
	Read.

Detailed Description

Author

Stefan Meyer smeye.nosp@m.r@da.nosp@m.tabay.nosp@m..de

Version

$Id$

Definition at line 33 of file class.ilECSParticipant.php.

Constructor & Destructor Documentation

ilECSParticipant::__construct	(		$json_obj,
			$a_cid
	)

Constructor.

public

Parameters

Definition at line 57 of file class.ilECSParticipant.php.

References $json_obj, ilECSParticipantSettings\_getInstance(), ilECSSettings\_getInstance(), and read().

        {
                include_once('Services/WebServices/ECS/classes/class.ilECSSettings.php');
                include_once('Services/WebServices/ECS/classes/class.ilECSParticipantSettings.php');
                
                $this->settings = ilECSSettings::_getInstance();
                $this->part_settings = ilECSParticipantSettings::_getInstance();
                $this->json_obj = $json_obj;
                $this->cid = $a_cid;
                $this->read();                  
        }

Here is the call graph for this function:

Member Function Documentation

ilECSParticipant::getAbbreviation

(

)

get abbreviation of participant

public

Definition at line 155 of file class.ilECSParticipant.php.

References $abr.

        {
                return $this->abr;
        }

ilECSParticipant::getCertId

(

)

get cert id

public

Parameters

Definition at line 110 of file class.ilECSParticipant.php.

References $certid.

Referenced by isSelf().

        {
                return $this->certid;
        }

Here is the caller graph for this function:

ilECSParticipant::getCommunityId

(

)

get community id

public

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

References $cid.

        {
                return $this->cid;
        }

ilECSParticipant::getDescription

(

)

get description

public

Definition at line 133 of file class.ilECSParticipant.php.

References $description.

        {
                return $this->description;
        }

ilECSParticipant::getDNS

(

)

get dns

public

Parameters

Definition at line 122 of file class.ilECSParticipant.php.

References $dns.

        {
                return $this->dns;
        }

ilECSParticipant::getEmail

(

)

get email

public

Definition at line 98 of file class.ilECSParticipant.php.

References $email.

        {
                return $this->email;
        }

ilECSParticipant::getMID

(

)

get mid

public

Parameters

Definition at line 87 of file class.ilECSParticipant.php.

References $mid.

Referenced by isEnabled().

        {
                return $this->mid; 
        }

Here is the caller graph for this function:

ilECSParticipant::getParticipantName

(

)

get participant name

public

Definition at line 144 of file class.ilECSParticipant.php.

References $participantname.

Referenced by read().

        {
                return $this->participantname;
        }

Here is the caller graph for this function:

ilECSParticipant::isEnabled

(

)

is Enabled

public

Definition at line 191 of file class.ilECSParticipant.php.

References getMID().

        {
                return (bool) $this->part_settings->isEnabled($this->getMID());
        }

Here is the call graph for this function:

ilECSParticipant::isPublishable

(

)

is publishable (enabled and mid with own cert id)

public

Parameters

Definition at line 167 of file class.ilECSParticipant.php.

References isSelf().

        {
                return $this->isSelf();
        }

Here is the call graph for this function:

ilECSParticipant::isSelf

(

)

is self

public

Parameters

Definition at line 179 of file class.ilECSParticipant.php.

References getCertId().

Referenced by isPublishable().

        {
                return (int) $this->getCertId() == (int) $this->settings->getCertSerialNumber();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilECSParticipant::read ( )

private

Read.

private

Definition at line 201 of file class.ilECSParticipant.php.

References $ilLog, and getParticipantName().

Referenced by __construct().

        {
                global $ilLog;
                
                $this->mid = $this->json_obj->mid;
                $this->email = $this->json_obj->email;
                $this->certid = hexdec($this->json_obj->certid);
                $this->dns = $this->json_obj->dns;
                $this->description = $this->json_obj->description;
                $this->participantname = $this->json_obj->participantname;
                $this->abr = $this->json_obj->abr;
                $ilLog->write(__METHOD__.': Received certId '.$this->getCertId().' for '.$this->getParticipantName());
                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

ilECSParticipant::$abr

protected

Definition at line 43 of file class.ilECSParticipant.php.

Referenced by getAbbreviation().

ilECSParticipant::$certid

protected

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

Referenced by getCertId().

ilECSParticipant::$cid

protected

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

Referenced by getCommunityId().

ilECSParticipant::$description

protected

Definition at line 41 of file class.ilECSParticipant.php.

Referenced by getDescription().

ilECSParticipant::$dns

protected

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

Referenced by getDNS().

ilECSParticipant::$email

protected

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

Referenced by getEmail().

ilECSParticipant::$is_self

protected

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

ilECSParticipant::$json_obj

protected

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

Referenced by __construct().

ilECSParticipant::$mid

protected

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

Referenced by getMID().

ilECSParticipant::$part_settings

protected

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

ilECSParticipant::$participantname

protected

Definition at line 42 of file class.ilECSParticipant.php.

Referenced by getParticipantName().

ilECSParticipant::$settings

protected

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

---

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

• Services/WebServices/ECS/classes/class.ilECSParticipant.php