Group of events within given date range e.g. today's agenda.
Methods¶
                 __construct()
            ¶
__construct()
            ¶
    
        
        EventList.php
                :
        36
                 
    
        |  |  | 
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $query | EventQuery | - | Query used to fetch events. | 
| $events | EventCollection | - | List of events. | 
| $totalCount | int | 0 | Total number of events matching query. | 
                 createEmpty()
            ¶
createEmpty()
            ¶
    
        
        EventList.php
                :
        93
                 
    
        Creates empty event list.
|  |  | 
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $query | EventQuery | - | - | 
Return values
self
                 fromEventList()
            ¶
fromEventList()
            ¶
    
        
        EventGroup.php
                :
        21
                 
    
        |  |  | 
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $eventList | EventList | - | - | 
Return values
self
                 getEvents()
            ¶
getEvents()
            ¶
    
        
        EventList.php
                :
        43
                 
    
        |  |  | 
Return values
                 getGroupKey()
            ¶
getGroupKey()
            ¶
    
        
        EventGroup.php
                :
        16
                 
    
        |  |  | 
Return values
                 getIterator()
            ¶
getIterator()
            ¶
    
        
        EventList.php
                :
        64
                 
    
        |  |  | 
Return values
Iterator
                 getNextPageQuery()
            ¶
getNextPageQuery()
            ¶
    
        
        EventList.php
                :
        72
                 
    
        Returns next page query or null if no more events.
|  |  | 
Return values
EventQuery|null
                 getQuery()
            ¶
getQuery()
            ¶
    
        
        EventList.php
                :
        59
                 
    
        Returns query used to fetch events.
|  |  | 
Return values
                 getTotalCount()
            ¶
getTotalCount()
            ¶
    
        
        EventList.php
                :
        51
                 
    
        Returns total number of events matching query.
|  |  | 
Return values
int