ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
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 ()
 
 setHighlighted (bool $status)
 
 isHighlighted ()
 
 getLabel ()
 
 setLabel (string $label)
 
 setItems (array $items)
 
 getItems ()
 

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.

30 {
31 }

Member Function Documentation

◆ count()

ilUsersGalleryGroup::count ( )

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

69 : int
70 {
71 return count($this->users);
72 }

References count().

Referenced by count().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ current()

ilUsersGalleryGroup::current ( )

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

References current().

Referenced by current().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getItems()

ilUsersGalleryGroup::getItems ( )
Returns
array<int, ilUsersGalleryUser>

Implements ilUsersGalleryUserCollection.

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

64 : array
65 {
66 return $this->users;
67 }

◆ getLabel()

ilUsersGalleryGroup::getLabel ( )

Implements ilUsersGalleryUserCollection.

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

48 : string
49 {
50 return $this->label;
51 }

References $label.

◆ isHighlighted()

ilUsersGalleryGroup::isHighlighted ( )

Implements ilUsersGalleryUserCollection.

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

38 : bool
39 {
40 return $this->highlighted;
41 }

References $highlighted.

◆ key()

ilUsersGalleryGroup::key ( )

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

84 : int
85 {
86 return key($this->users);
87 }

References key().

Referenced by key(), and valid().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ next()

ilUsersGalleryGroup::next ( )

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

79 : void
80 {
81 next($this->users);
82 }

References next().

Referenced by next().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ rewind()

ilUsersGalleryGroup::rewind ( )

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

94 : void
95 {
96 reset($this->users);
97 }

◆ setHighlighted()

ilUsersGalleryGroup::setHighlighted ( bool  $status)

Implements ilUsersGalleryUserCollection.

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

33 : void
34 {
35 $this->highlighted = $status;
36 }

◆ setItems()

ilUsersGalleryGroup::setItems ( array  $items)
Parameters
array<int,ilUsersGalleryUser>$items

Implements ilUsersGalleryUserCollection.

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

56 : void
57 {
58 $this->users = $items;
59 }

◆ setLabel()

ilUsersGalleryGroup::setLabel ( string  $label)

Implements ilUsersGalleryUserCollection.

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

43 : void
44 {
45 $this->label = $label;
46 }

References $label.

◆ valid()

ilUsersGalleryGroup::valid ( )

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

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

References key().

+ 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: