Net_NNTP_Client::getOverview()

Net_NNTP_Client::getOverview() – Fetch newsgroup overview

Synopsis

require_once 'Net/NNTP/Client.php';

array Net_NNTP_Client::getOverview ( string $first , string $last )

Description

Returns (a certain range of) the overview of the currently selected newsgroup. selected newsgroup

Parameter

  • $first - first article number, start of the range

  • $last - last article number, end of the range

Return value

array - a nested array indicated by the message id of the article, every entry contains the header as array

<?php
$msgs
[message_id][headername] = headercontent
?>

Note

This function can not be called statically.

Be careful with choosing the range. It could requires some time to get a huge number of message headers.

Example

Using getOverview()

<?php
...
$ret $nntp->connect('news.php.net');
if( 
PEAR::isError($ret)) {
 
// handle error
} else {
 
// print the last 10 messages
 
$data $nntp->selectGroup('php.pear.dev');
 
$msgs $nntp->getOverview$data['last'] - 10$data[last]);

 foreach(
$msgs as $msg) {
    
// print subjects
    
echo $msg['subject'].'<br>';
 }
}
?>
Net_NNTP_Client::getNewNews() (Previous) Net_NNTP_Client::getReferencesOverview() (Next)
Last updated: Fri, 31 Oct 2014 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report or add a note.
View this page in:

User Notes:

Note by: cweiske
The end user manual documents a deprecated version of the getOverview method. The correct version (as described in the API documentation) is as follows:

mixed getOverview(
[mixed
$range = null], [boolean
$_names = true], [boolean
$_forceNames = true])