Net_NNTP::getGroups()

Net_NNTP::getGroups() – fetch list of avaible newsgroups

Synopsis

require_once 'Net/NNTP.php';

array Net_NNTP::getGroups ( string $fetch = true )

Description

Returns a list of all avaible newsgroups from the connected news server

Parameter

  • $fetch - can be irgnored, unused

Return value

array - a two dimensional, nested array indicated by the name of the newsgroup, every entry contains information about the newsgroup:

  • $groups[newsgroup_name]['group'] name of the newsgroup

  • $groups[newsgroup_name]['last'] message number of the last message

  • $groups[newsgroup_name]['first'] message number of the first message

  • $groups[newsgroup_name]['posting_allowed'] values: y - yes, n - no, m - moderated)

  • $groups[newsgroup_name]['desc'] newsgroup description

Note

This function can not be called statically.

Especially public news server can provide more then 30.000 newsgroup. So this function may runs longer then the maximum execution time set in the php.ini.

Example

Using getGroups()

<?php
...
$ret $nntp->connect("news.php.net");
if( 
PEAR::isError($ret)) {
 
// handle error
} else {
 
// success
 
$groups $nntp->getGroups();
 
// Print a list of avaible newsgroups
 
foreach($groups as $group) {
    echo 
$group['group'].': '.$group['desc'].'<br>';
 }
}
?>
get date from news server (Previous) fetch message header (Next)
Last updated: Fri, 22 Aug 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:

There are no user contributed notes for this page.