ilECSCommunity Class Reference

Collaboration diagram for ilECSCommunity:

Public Member Functions
	__construct (object $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
object	$json_obj
string	$title = ''
string	$description = ''
int	$id = 0
array	$participants = array()
int	$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

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

Constructor & Destructor Documentation

__construct()

ilECSCommunity::__construct

(

object

$json_obj

)

Constructor.

Parameters

object

json object

Definition at line 39 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

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

                                    : string
    {
        return $this->description;
    }

References $description.

getId()

ilECSCommunity::getId

(

)

get id

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

                           : int
    {
        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 74 of file class.ilECSCommunity.php.

                             : array
    {
        $mids = [];
        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 86 of file class.ilECSCommunity.php.

                              : int
    {
        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

Returns

ilECSParticipant[]

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

                                     : array
    {
        return $this->participants ?: [];
    }

Referenced by getMids(), and getOwnId().

Here is the caller graph for this function:

getTitle()

ilECSCommunity::getTitle

(

)

get title

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

                              : string
    {
        return $this->title;
    }

References $title.

read()

ilECSCommunity::read ( )

private

Read community entries and participants.

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

                           : void
    {
        $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) {
            $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

string ilECSCommunity::$description = ''

protected

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

Referenced by getDescription().

$id

int ilECSCommunity::$id = 0

protected

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

Referenced by getId().

$json_obj

object ilECSCommunity::$json_obj

protected

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

Referenced by __construct().

$participants

array ilECSCommunity::$participants = array()

protected

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

$position

int ilECSCommunity::$position = 0

protected

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

$title

string ilECSCommunity::$title = ''

protected

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

Referenced by getTitle().

---

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

• components/ILIAS/WebServices/ECS/classes/class.ilECSCommunity.php