ilUsersGalleryGroup Class Reference

Class ilUsersGalleryGroup. More...

Inheritance diagram for ilUsersGalleryGroup:

Collaboration diagram for ilUsersGalleryGroup:

Public Member Functions
	__construct (array $users)
	ilUsersGalleryGroupImpl constructor. More...
	setHighlighted ($status)
	Set whether or not this group is highlighted. Parameters boolean $status More...
	isHighlighted ()
	Returns whether or not it is a highlighted group. Returns boolean More...
	setLabel ($label)
	Parameters $label string More...
	getLabel ()
	Returns string More...
	setItems (array $items)
	Parameters array $items More...
	getItems ()
	Returns array More...
	count ()
	current ()
	next ()
	key ()
	valid ()
	rewind ()

Protected Attributes
	$users = []
	$highlighted = false
	$label = ''

Detailed Description

Class ilUsersGalleryGroup.

Definition at line 9 of file class.ilUsersGalleryGroup.php.

Constructor & Destructor Documentation

__construct()

ilUsersGalleryGroup::__construct

(

array

$users

)

ilUsersGalleryGroupImpl constructor.

Parameters

ilUsersGalleryUser[]

$users

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

References $users.

    {
        $this->users = $users;
    }

Member Function Documentation

count()

ilUsersGalleryGroup::count

(

)

Definition at line 86 of file class.ilUsersGalleryGroup.php.

    {
        return count($this->users);
    }

current()

ilUsersGalleryGroup::current

(

)

Returns

ilUsersGalleryUser

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

    {
        return current($this->users);
    }

getItems()

ilUsersGalleryGroup::getItems

(

)

Returns

array

Implements ilUsersGalleryUserCollection.

Definition at line 78 of file class.ilUsersGalleryGroup.php.

References $users.

    {
        return $this->users;
    }

getLabel()

ilUsersGalleryGroup::getLabel

(

)

Returns

string

Implements ilUsersGalleryUserCollection.

Definition at line 62 of file class.ilUsersGalleryGroup.php.

References $label.

    {
        return $this->label;
    }

isHighlighted()

ilUsersGalleryGroup::isHighlighted

(

)

Returns whether or not it is a highlighted group.

Returns

boolean

Implements ilUsersGalleryUserCollection.

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

References $highlighted.

Referenced by ilUsersGalleryGUI\populateTemplate().

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

Here is the caller graph for this function:

key()

ilUsersGalleryGroup::key

(

)

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

Referenced by valid().

    {
        key($this->users);
    }

Here is the caller graph for this function:

next()

ilUsersGalleryGroup::next

(

)

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

    {
        next($this->users);
    }

rewind()

ilUsersGalleryGroup::rewind

(

)

Definition at line 127 of file class.ilUsersGalleryGroup.php.

    {
        reset($this->users);
    }

setHighlighted()

ilUsersGalleryGroup::setHighlighted

(

$status

)

Set whether or not this group is highlighted.

Parameters

boolean

$status

Implements ilUsersGalleryUserCollection.

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

    {
        $this->highlighted = (bool) $status;
    }

setItems()

ilUsersGalleryGroup::setItems

(

array

$items

)

Parameters

array

$items

Implements ilUsersGalleryUserCollection.

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

    {
        $this->users = $items;
    }

setLabel()

ilUsersGalleryGroup::setLabel

(

$label

)

Parameters

$label

string

Implements ilUsersGalleryUserCollection.

Definition at line 54 of file class.ilUsersGalleryGroup.php.

References $label.

    {
        $this->label = $label;
    }

valid()

ilUsersGalleryGroup::valid

(

)

Definition at line 119 of file class.ilUsersGalleryGroup.php.

References key().

    {
        return key($this->users) !== null;
    }

Here is the call graph for this function:

Field Documentation

$highlighted

ilUsersGalleryGroup::$highlighted = false

protected

Definition at line 19 of file class.ilUsersGalleryGroup.php.

Referenced by isHighlighted().

$label

ilUsersGalleryGroup::$label = ''

protected

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

Referenced by getLabel(), and setLabel().

$users

ilUsersGalleryGroup::$users = []

protected

Definition at line 14 of file class.ilUsersGalleryGroup.php.

Referenced by __construct(), and getItems().

---

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

• Services/User/Gallery/classes/class.ilUsersGalleryGroup.php