ilECSParticipant Class Reference

Collaboration diagram for ilECSParticipant:

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

Protected Attributes
	$json_obj
	$cid
	$pid
	$mid
	$email
	$certid
	$dns
	$description
	$participantname
	$is_self

Private Member Functions
	read ()
	Read. More...

Private Attributes
	$logger = null

Detailed Description

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

@ilCtrl_Calls

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

Constructor & Destructor Documentation

__construct()

ilECSParticipant::__construct	(		$json_obj,
			$a_cid
	)

Constructor.

@access public

Parameters

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

    {
        global $DIC;
 
        $this->logger = $DIC->logger()->wsrv();
 
        $this->json_obj = $json_obj;
        $this->cid = $a_cid;
        $this->read();
    }

References $DIC, $json_obj, and read().

Here is the call graph for this function:

Member Function Documentation

getAbbreviation()

ilECSParticipant::getAbbreviation

(

)

get abbreviation of participant

@access public

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

    {
        return $this->abr;
    }

getCommunityId()

ilECSParticipant::getCommunityId

(

)

get community id

@access public

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

    {
        return $this->cid;
    }

References $cid.

getDescription()

ilECSParticipant::getDescription

(

)

get description

@access public

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

    {
        return $this->description;
    }

References $description.

getDNS()

ilECSParticipant::getDNS

(

)

get dns

@access public

Parameters

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

    {
        return $this->dns;
    }

References $dns.

getEmail()

ilECSParticipant::getEmail

(

)

get email

@access public

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

    {
        return $this->email;
    }

References $email.

getMID()

ilECSParticipant::getMID

(

)

get mid

@access public

Parameters

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

    {
        return $this->mid;
    }

References $mid.

getOrganisation()

ilECSParticipant::getOrganisation

(

)

Get organisation.

Returns

ilECSOrganisation $org

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

    {
        return $this->org;
    }

getParticipantName()

ilECSParticipant::getParticipantName

(

)

get participant name

@access public

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

    {
        return $this->participantname;
    }

References $participantname.

getPid()

ilECSParticipant::getPid

(

)

Get pid.

Returns

int

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

    {
        return $this->pid;
    }

References $pid.

isEnabled()

ilECSParticipant::isEnabled

(

)

is Enabled

@access public

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

    {
        $GLOBALS['DIC']['ilLog']->write(__METHOD__ . ': Using deprecated call');
        $GLOBALS['DIC']['ilLog']->logStack();
        return false;
    }

References $GLOBALS.

isPublishable()

ilECSParticipant::isPublishable

(

)

is publishable (enabled and mid with own cert id)

@access public

Parameters

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

    {
        return $this->isSelf();
    }

References isSelf().

Here is the call graph for this function:

isSelf()

ilECSParticipant::isSelf

(

)

is self

@access public

Parameters

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

    {
        return (bool) $this->is_self;
    }

References $is_self.

Referenced by isPublishable().

Here is the caller graph for this function:

read()

ilECSParticipant::read ( )

private

Read.

@access private

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

    {
        $this->pid = $this->json_obj->pid;
        $this->mid = $this->json_obj->mid;
        $this->email = $this->json_obj->email;
        $this->dns = $this->json_obj->dns;
        $this->description = $this->json_obj->description;
 
        $this->participantname = $this->json_obj->name;
        $this->is_self = $this->json_obj->itsyou;
 
        include_once './Services/WebServices/ECS/classes/class.ilECSOrganisation.php';
        $this->org = new ilECSOrganisation();
        if (is_object($this->json_obj->org)) {
            $this->org->loadFromJson($this->json_obj->org);
        }
        return true;
    }

Referenced by __construct().

Here is the caller graph for this function:

Field Documentation

$certid

ilECSParticipant::$certid

protected

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

$cid

ilECSParticipant::$cid

protected

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

Referenced by getCommunityId().

$description

ilECSParticipant::$description

protected

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

Referenced by getDescription().

$dns

ilECSParticipant::$dns

protected

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

Referenced by getDNS().

$email

ilECSParticipant::$email

protected

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

Referenced by getEmail().

$is_self

ilECSParticipant::$is_self

protected

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

Referenced by isSelf().

$json_obj

ilECSParticipant::$json_obj

protected

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

Referenced by __construct().

$logger

ilECSParticipant::$logger = null

private

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

$mid

ilECSParticipant::$mid

protected

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

Referenced by getMID().

$participantname

ilECSParticipant::$participantname

protected

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

Referenced by getParticipantName().

$pid

ilECSParticipant::$pid

protected

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

Referenced by getPid().

---

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

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