PEAR Manual
Prev |  | Next

# 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.

Warning
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`.

## See

Net_NNTP::selectGroup()

## Example

Example 48-1. Using getGroups()
    ...
    $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>';
     }
    }

Prev | Home | Next
Net_NNTP::getDate() | Up | Net_NNTP::getHeaderRaw()