Stack.PHP
A simple and easy to use PHP library for the Stack Exchange API.
Public Member Functions | List of all members
PagedSiteResponse Class Reference

Represents a response that contains a list of sites. More...

Inheritance diagram for PagedSiteResponse:
PagedResponse

Public Member Functions

 __construct ($base_url)
 Constructor for a paged site response. More...
 
 Fetch ($fetch_next=TRUE)
 Returns the next site in the set. More...
 
- Public Member Functions inherited from PagedResponse
 __construct ($base_url, $return_object)
 Constructor for a response. More...
 
 Fetch ($fetch_next=TRUE)
 Returns the next item in the set. More...
 
 Reset ($reset_all=TRUE)
 Resets the internal index. More...
 
 Page ($page=null, $include_total=FALSE)
 Fetches the specified page and resets the index. More...
 
 Pagesize ($pagesize)
 Sets the pagesize to the specified value. More...
 
 Total ($all_pages=TRUE)
 Returns the total number of items. More...
 

Additional Inherited Members

- Protected Member Functions inherited from PagedResponse
 RetrieveDataFromURL ($include_total)
 Retrieves the data from the URL and verifies the type of items returned. More...
 

Detailed Description

Represents a response that contains a list of sites.

Constructor & Destructor Documentation

◆ __construct()

PagedSiteResponse::__construct (   $base_url)

Constructor for a paged site response.

Parameters
$base_urlan instance of the URL class

Member Function Documentation

◆ Fetch()

PagedSiteResponse::Fetch (   $fetch_next = TRUE)

Returns the next site in the set.

Parameters
$fetch_nextwhether to fetch the next page if there are no more sites in the current page
Returns
the next site in the set or FALSE if none

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