ilUsersGalleryGroup Class Reference

Inheritance diagram for ilUsersGalleryGroup:

Collaboration diagram for ilUsersGalleryGroup:

Public Member Functions
	__construct (protected array $users)
	setHighlighted (bool $status)
	isHighlighted ()
	setLabel (string $label)
	getLabel ()
	setItems (array $items)
	getItems ()
	count ()
	current ()
	next ()
	key ()
	valid ()
	rewind ()

Protected Attributes
bool	$highlighted = false
string	$label = ''

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilUsersGalleryGroup::__construct

(

protected array

$users

)

Parameters

array<int,ilUsersGalleryUser>

$users

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

    {
    }

Member Function Documentation

count()

ilUsersGalleryGroup::count

(

)

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

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

current()

ilUsersGalleryGroup::current

(

)

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

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

getItems()

ilUsersGalleryGroup::getItems

(

)

Returns

array<int, ilUsersGalleryUser>

Implements ilUsersGalleryUserCollection.

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

                              : array
    {
        return $this->users;
    }

getLabel()

ilUsersGalleryGroup::getLabel

(

)

Implements ilUsersGalleryUserCollection.

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

References $label.

                              : string
    {
        return $this->label;
    }

isHighlighted()

ilUsersGalleryGroup::isHighlighted

(

)

Implements ilUsersGalleryUserCollection.

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

References $highlighted.

                                   : bool
    {
        return $this->highlighted;
    }

key()

ilUsersGalleryGroup::key

(

)

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

Referenced by valid().

                         : int
    {
        return key($this->users);
    }

Here is the caller graph for this function:

next()

ilUsersGalleryGroup::next

(

)

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

                          : void
    {
        next($this->users);
    }

rewind()

ilUsersGalleryGroup::rewind

(

)

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

                            : void
    {
        reset($this->users);
    }

setHighlighted()

ilUsersGalleryGroup::setHighlighted

(

bool

$status

)

Implements ilUsersGalleryUserCollection.

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

                                                : void
    {
        $this->highlighted = $status;
    }

setItems()

ilUsersGalleryGroup::setItems

(

array

$items

)

Parameters

array<int,ilUsersGalleryUser>

$items

Implements ilUsersGalleryUserCollection.

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

                                          : void
    {
        $this->users = $items;
    }

setLabel()

ilUsersGalleryGroup::setLabel

(

string

$label

)

Implements ilUsersGalleryUserCollection.

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

References $label.

                                           : void
    {
        $this->label = $label;
    }

valid()

ilUsersGalleryGroup::valid

(

)

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

References key(), and null.

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

Here is the call graph for this function:

Field Documentation

$highlighted

bool ilUsersGalleryGroup::$highlighted = false

protected

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

Referenced by isHighlighted().

$label

string ilUsersGalleryGroup::$label = ''

protected

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

Referenced by getLabel(), and setLabel().

---

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

• components/ILIAS/User/classes/Gallery/class.ilUsersGalleryGroup.php