ilECSCommunity Class Reference

Collaboration diagram for ilECSCommunity:

Public Member Functions
	__construct ($json_obj)
	Constructor. More...
	getTitle ()
	get title More...
	getDescription ()
	getDescription More...
	getParticipants ()
	get participants More...
	getMids ()
	Get array of mids of all participants. More...
	getOwnId ()
	Get own mid of community. More...
	getId ()
	get id More...

Protected Attributes
	$json_obj = null
	$title = ''
	$description = ''
	$id = 0
	$participants = array()
	$position = 0

Private Member Functions
	read ()
	Read community entries and participants. More...

Detailed Description

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilECSCommunity::__construct

(

$json_obj

)

Constructor.

@access public

Parameters

object

json object

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

    {
        $this->json_obj = $json_obj;
        $this->read();
    }

References $json_obj, and read().

Here is the call graph for this function:

Member Function Documentation

getDescription()

ilECSCommunity::getDescription

(

)

getDescription

@access public

Definition at line 72 of file class.ilECSCommunity.php.

    {
        return $this->description;
    }

References $description.

getId()

ilECSCommunity::getId

(

)

get id

@access public

Definition at line 120 of file class.ilECSCommunity.php.

    {
        return $this->id;
    }

References $id.

Referenced by read().

Here is the caller graph for this function:

getMids()

ilECSCommunity::getMids

(

)

Get array of mids of all participants.

Definition at line 91 of file class.ilECSCommunity.php.

    {
        $mids = array();
        foreach ($this->getParticipants() as $part) {
            $mids[] = $part->getMID();
        }
        return $mids;
    }

References getParticipants().

Here is the call graph for this function:

getOwnId()

ilECSCommunity::getOwnId

(

)

Get own mid of community.

Definition at line 103 of file class.ilECSCommunity.php.

    {
        foreach ($this->getParticipants() as $part) {
            if ($part->isSelf()) {
                return $part->getMID();
            }
        }
        return 0;
    }

References getParticipants().

Here is the call graph for this function:

getParticipants()

ilECSCommunity::getParticipants

(

)

get participants

@access public

Returns

\ilECSParticipant

Definition at line 83 of file class.ilECSCommunity.php.

    {
        return $this->participants ? $this->participants : array();
    }

Referenced by getMids(), and getOwnId().

Here is the caller graph for this function:

getTitle()

ilECSCommunity::getTitle

(

)

get title

@access public

Definition at line 61 of file class.ilECSCommunity.php.

    {
        return $this->title;
    }

References $title.

read()

ilECSCommunity::read ( )

private

Read community entries and participants.

@access private

Definition at line 132 of file class.ilECSCommunity.php.

    {
        $this->title = $this->json_obj->community->name;
        $this->description = $this->json_obj->community->description;
        $this->id = $this->json_obj->community->cid;
        
        foreach ($this->json_obj->participants as $participant) {
            include_once('./Services/WebServices/ECS/classes/class.ilECSParticipant.php');
            $this->participants[] = new ilECSParticipant($participant, $this->getId());
        }
    }

References getId().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$description

ilECSCommunity::$description = ''

protected

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

Referenced by getDescription().

$id

ilECSCommunity::$id = 0

protected

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

Referenced by getId().

$json_obj

ilECSCommunity::$json_obj = null

protected

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

Referenced by __construct().

$participants

ilECSCommunity::$participants = array()

protected

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

$position

ilECSCommunity::$position = 0

protected

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

$title

ilECSCommunity::$title = ''

protected

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

Referenced by getTitle().

---

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

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