Semantic MediaWiki and related extensions
Public Member Functions | Protected Attributes | List of all members
SMW\Notifications\Iterators\RecursiveMembersIterator Class Reference
Inheritance diagram for SMW\Notifications\Iterators\RecursiveMembersIterator:
Inheritance graph
[legend]
Collaboration diagram for SMW\Notifications\Iterators\RecursiveMembersIterator:
Collaboration graph
[legend]

Public Member Functions

 __construct ( $groups, Store $store)
 
 setAgentName ( $agentName)
 
 notifyAgent ( $notifyAgent)
 
 setSubject (DIWikiPage $subject=null)
 
 current ()
 
 key ()
 
 rewind ()
 
 valid ()
 
 hasChildren ()
 
 getChildren ()
 
 next ()
 

Protected Attributes

 $groups
 

Detailed Description

Lazy load members from a Notifications group member of or Notifications to assignment.

GNU GPL v2+

Since
1.0
Author
mwjames

Constructor & Destructor Documentation

◆ __construct()

SMW\Notifications\Iterators\RecursiveMembersIterator::__construct (   $groups,
Store  $store 
)
Since
1.0
Parameters
Iterator | array$groups
Store$store

Member Function Documentation

◆ current()

SMW\Notifications\Iterators\RecursiveMembersIterator::current ( )
Since
1.0
Returns
array The most recently fetched set of rows from the database

◆ getChildren()

SMW\Notifications\Iterators\RecursiveMembersIterator::getChildren ( )
Since
1.0
Returns
RecursiveIterator

◆ hasChildren()

SMW\Notifications\Iterators\RecursiveMembersIterator::hasChildren ( )
Since
1.0
Returns
bool True when this result set has rows

◆ key()

array $primaryKey The name of the primary SMW\Notifications\Iterators\RecursiveMembersIterator::key ( )
Since
1.0
Returns
integer 0-indexed count of the page number fetched

◆ next()

SMW\Notifications\Iterators\RecursiveMembersIterator::next ( )

Fetch the next set of rows from the database.

Since
1.0

◆ notifyAgent()

SMW\Notifications\Iterators\RecursiveMembersIterator::notifyAgent (   $notifyAgent)
Since
1.0
Parameters
boolean$notifyAgent

◆ rewind()

SMW\Notifications\Iterators\RecursiveMembersIterator::rewind ( )
Since
1.0

Reset the iterator to the beginning of the table.

◆ setAgentName()

SMW\Notifications\Iterators\RecursiveMembersIterator::setAgentName (   $agentName)
Since
1.0
Parameters
string$agentName

◆ setSubject()

SMW\Notifications\Iterators\RecursiveMembersIterator::setSubject ( DIWikiPage  $subject = null)
Since
1.0
Parameters
DIWikiPage | null$subject

◆ valid()

SMW\Notifications\Iterators\RecursiveMembersIterator::valid ( )
Since
1.0
Returns
bool True when the iterator is in a valid state

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

About | General disclaimer | Privacy policy