ILIAS  release_9 Revision v9.13-25-g2c18ec4c24f
ilUsersGalleryGroup Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

+ 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

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

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

Constructor & Destructor Documentation

◆ __construct()

ilUsersGalleryGroup::__construct ( protected array  $users)
Parameters
array<int,ilUsersGalleryUser>$users

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

29  {
30  }

Member Function Documentation

◆ count()

ilUsersGalleryGroup::count ( )

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

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

◆ current()

ilUsersGalleryGroup::current ( )

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

74  {
75  return current($this->users);
76  }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...

◆ getItems()

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

Implements ilUsersGalleryUserCollection.

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

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

◆ getLabel()

ilUsersGalleryGroup::getLabel ( )

Implements ilUsersGalleryUserCollection.

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

References $label.

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

◆ isHighlighted()

ilUsersGalleryGroup::isHighlighted ( )

Implements ilUsersGalleryUserCollection.

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

References $highlighted.

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

◆ key()

ilUsersGalleryGroup::key ( )

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

Referenced by valid().

83  : int
84  {
85  return key($this->users);
86  }
+ Here is the caller graph for this function:

◆ next()

ilUsersGalleryGroup::next ( )

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

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

◆ rewind()

ilUsersGalleryGroup::rewind ( )

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

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

◆ setHighlighted()

ilUsersGalleryGroup::setHighlighted ( bool  $status)

Implements ilUsersGalleryUserCollection.

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

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

◆ setItems()

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

Implements ilUsersGalleryUserCollection.

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

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

◆ setLabel()

ilUsersGalleryGroup::setLabel ( string  $label)

Implements ilUsersGalleryUserCollection.

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

References $label.

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

◆ valid()

ilUsersGalleryGroup::valid ( )

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

References key().

88  : bool
89  {
90  return key($this->users) !== null;
91  }
+ Here is the call graph for this function:

Field Documentation

◆ $highlighted

bool ilUsersGalleryGroup::$highlighted = false
protected

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

Referenced by isHighlighted().

◆ $label

string ilUsersGalleryGroup::$label = ''
protected

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

Referenced by getLabel(), and setLabel().


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