ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
ilUsersGallerySortedUserGroup Class Reference

Class ilUsersGallerySortedUserGroup. More...

+ Inheritance diagram for ilUsersGallerySortedUserGroup:
+ Collaboration diagram for ilUsersGallerySortedUserGroup:

Public Member Functions

 __construct (ilUsersGalleryUserCollection $collection, ilUsersGalleryUserCollectionSorter $sorter)
 ilUsersGallerySortedUserCollection constructor. More...
 
 setItems (array $items)
 
Parameters
array$items
More...
 
 getItems ()
 
Returns
array
More...
 
 current ()
 
 next ()
 
 key ()
 
 valid ()
 
 rewind ()
 
 count ()
 
 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
$labelstring
More...
 
 getLabel ()
 
Returns
string
More...
 

Protected Attributes

 $collection
 
 $sorter
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

ilUsersGallerySortedUserGroup::__construct ( ilUsersGalleryUserCollection  $collection,
ilUsersGalleryUserCollectionSorter  $sorter 
)

ilUsersGallerySortedUserCollection constructor.

Parameters
ilUsersGalleryUserCollection$collection
ilUsersGalleryUserCollectionSorter$sorter

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

References $collection, and $sorter.

Member Function Documentation

◆ count()

ilUsersGallerySortedUserGroup::count ( )

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

94  {
95  return $this->collection->count();
96  }

◆ current()

ilUsersGallerySortedUserGroup::current ( )

Returns
ilUsersGalleryUser

Definition at line 52 of file class.ilUsersGallerySortedUserGroup.php.

53  {
54  return $this->collection->current();
55  }

◆ getItems()

ilUsersGallerySortedUserGroup::getItems ( )

Returns
array

Implements ilUsersGalleryUserCollection.

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

44  {
45  return $this->collection->getItems();
46  }

◆ getLabel()

ilUsersGallerySortedUserGroup::getLabel ( )

Returns
string

Implements ilUsersGalleryUserCollection.

Definition at line 125 of file class.ilUsersGallerySortedUserGroup.php.

126  {
127  return $this->collection->getLabel();
128  }

◆ isHighlighted()

ilUsersGallerySortedUserGroup::isHighlighted ( )

Returns whether or not it is a highlighted group.

Returns
boolean

Implements ilUsersGalleryUserCollection.

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

110  {
111  return $this->collection->isHighlighted();
112  }

◆ key()

ilUsersGallerySortedUserGroup::key ( )

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

69  {
70  return $this->collection->key();
71  }

◆ next()

ilUsersGallerySortedUserGroup::next ( )

Definition at line 60 of file class.ilUsersGallerySortedUserGroup.php.

61  {
62  $this->collection->next();
63  }

◆ rewind()

ilUsersGallerySortedUserGroup::rewind ( )

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

85  {
86  $this->collection->setItems($this->sorter->sort($this->collection->getItems()));
87  $this->collection->rewind();
88  }

◆ setHighlighted()

ilUsersGallerySortedUserGroup::setHighlighted (   $status)

Set whether or not this group is highlighted.

Parameters
boolean$status

Implements ilUsersGalleryUserCollection.

Definition at line 101 of file class.ilUsersGallerySortedUserGroup.php.

102  {
103  $this->collection->setHighlighted($status);
104  }

◆ setItems()

ilUsersGallerySortedUserGroup::setItems ( array  $items)

Parameters
array$items

Implements ilUsersGalleryUserCollection.

Definition at line 35 of file class.ilUsersGallerySortedUserGroup.php.

36  {
37  $this->collection->setItems($items);
38  }

◆ setLabel()

ilUsersGallerySortedUserGroup::setLabel (   $label)

Parameters
$labelstring

Implements ilUsersGalleryUserCollection.

Definition at line 117 of file class.ilUsersGallerySortedUserGroup.php.

118  {
119  $this->collection->setLabel($label);
120  }

◆ valid()

ilUsersGallerySortedUserGroup::valid ( )

Definition at line 76 of file class.ilUsersGallerySortedUserGroup.php.

77  {
78  return $this->collection->valid();
79  }

Field Documentation

◆ $collection

ilUsersGallerySortedUserGroup::$collection
protected

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

Referenced by __construct().

◆ $sorter

ilUsersGallerySortedUserGroup::$sorter
protected

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

Referenced by __construct().


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