Net_NNTP
[ class tree: Net_NNTP ] [ index: Net_NNTP ] [ all elements ]
Packages:
Net_NNTP


Classes:
Net_NNTP_Client
Net_NNTP_Header
Net_NNTP_Message
Files:
Client.php
Client.php
group.php
Header.php
index.php
Message.php
read.php

Class: Net_NNTP_Client

Source Location: /Net_NNTP-1.2.3/NNTP/Client.php

Class Overview

Net_NNTP_Protocol_Client
   |
   --Net_NNTP_Client

Implementation of the client side of NNTP (Network News Transfer Protocol)


Author(s):

Version:

  • $Id: Client.php,v 1.5.2.2 2005/05/13 21:08:57 heino Exp $

Methods

Inherited Variables

Inherited Methods

Class Details

[line 91]
Implementation of the client side of NNTP (Network News Transfer Protocol)

The Net_NNTP_Client class is a frontend class to the Net_NNTP_Protocol_Client class.

  • Author: Heino H. Gehlsen <heino@gehlsen.dk>
  • Version: $Id: Client.php,v 1.5.2.2 2005/05/13 21:08:57 heino Exp $
  • See: Net_NNTP_Protocol_Client
  • Since: Class available since Release 0.11.0
  • Access: public


[ Top ]

Method Detail

Net_NNTP_Client (Constructor)   [line 112]

Net_NNTP_Client Net_NNTP_Client( )

Constructor
  • Access: public

[ Top ]

authenticate   [line 212]

mixed authenticate( string $user, optional $pass, [optional $mode = NET_NNTP_CLIENT_AUTH_ORIGINAL])

Authenticate

Auth process (not yet standarized but used any way) http://www.mibsoftware.com/userkt/nntpext/index.html


Parameters:

string   $user   —  The username
optional   $pass   —  string $pass The password
optional   $mode   —  string $mode The authentication mode (original, simple, generic).

[ Top ]

connect   [line 132]

mixed connect( [optional $host = NET_NNTP_PROTOCOL_CLIENT_DEFAULT_HOST], [optional $port = NET_NNTP_PROTOCOL_CLIENT_DEFAULT_PORT])

Connect to the NNTP-server.

Parameters:

optional   $host   —  string $host The adress of the NNTP-server to connect to.
optional   $port   —  int $port The port to connect to.

[ Top ]

connectAuthenticated   [line 158]

mixed connectAuthenticated( [optional $user = null], [optional $pass = null], [optional $host = NET_NNTP_PROTOCOL_CLIENT_DEFAULT_HOST], [optional $port = NET_NNTP_PROTOCOL_CLIENT_DEFAULT_PORT], [optional $authmode = NET_NNTP_CLIENT_AUTH_ORIGINAL])

Connect to the NNTP-server, and authenticate using given username and password.

Parameters:

optional   $user   —  string $user The username.
optional   $pass   —  string $pass The password.
optional   $host   —  string $host The IP-address of the NNTP-server to connect to.
optional   $port   —  int $port The port to connect to.
optional   $authmode   —  string $authmode The authentication mode.

[ Top ]

count   [line 813]

integer count( )

Number of articles in currently selected group

[ Top ]

first   [line 851]

integer first( )

Minimum article number in currently selected group

[ Top ]

getArticle   [line 521]

mixed getArticle( mixed $article, [ $class = 'Net_NNTP_Message'], [ $implode = false])

Get an article

Experimental

The v0.2 version of the this function (which returned the article as a string) has been renamed to getArticleRaw().


Parameters:

mixed   $article   —  Either the message-id or the message-number on the server of the article to fetch.
   $class   — 
   $implode   — 

[ Top ]

getArticleRaw   [line 556]

mixed getArticleRaw( mixed $article, [optional $implode = false])

Get a article (raw data)

Parameters:

mixed   $article   —  Either the message-id or the message-number on the server of the article to fetch.
optional   $implode   —  bool $implode When true the result array is imploded to a string, defaults to false.

[ Top ]

getBody   [line 651]

mixed getBody( mixed $article, $class, [ $implode = false])

Get the body of an article

Experimental


Parameters:

mixed   $article   —  Either the (string) message-id or the (int) message-number on the server of the article to fetch.
   $class   — 
   $implode   — 

[ Top ]

getBodyRaw   [line 686]

mixed getBodyRaw( mixed $article, [optional $implode = false])

Get the body of an article (raw data)

Parameters:

mixed   $article   —  Either the message-id or the message-number on the server of the article to fetch.
optional   $implode   —  bool $implode When true the result array is imploded to a string, defaults to false.

[ Top ]

getDate   [line 780]

mixed getDate( [optional $format = 1])

Get the NNTP-server's internal date

Get the date from the newsserver format of returned date:

  • Return: (mixed) date on success or (object) pear_error on failure
  • Since: 0.3
  • Access: public

Parameters:

optional   $format   —  int $format
  • 0: $date - timestamp
  • 1: $date['y'] - year $date['m'] - month $date['d'] - day

[ Top ]

getDescriptions   [line 312]

mixed getDescriptions( )

Fetches a list of all avaible newsgroup descriptions.
  • Return: (array) nested array with description of existing newsgroups on success or (object) pear_error on failure
  • See: Net_NNTP_Client::getGroups()
  • Access: public

[ Top ]

getGroupArticles   [line 709]

void getGroupArticles( $newsgroup)

Experimental
  • Since: 0.3
  • Access: public

Parameters:

   $newsgroup   — 

[ Top ]

getGroups   [line 291]

mixed getGroups( )

Fetches a list of all avaible newsgroups

[ Top ]

getHeader   [line 586]

mixed getHeader( mixed $article, [ $class = 'Net_NNTP_Header'], [ $implode = false])

Get the header of an article

Experimental


Parameters:

mixed   $article   —  Either the (string) message-id or the (int) message-number on the server of the article to fetch.
   $class   — 
   $implode   — 

[ Top ]

getHeaderRaw   [line 621]

mixed getHeaderRaw( mixed $article, [optional $implode = false])

Get the header of an article (raw data)

Parameters:

mixed   $article   —  Either the (string) message-id or the (int) message-number on the server of the article to fetch.
optional   $implode   —  bool $implode When true the result array is imploded to a string, defaults to false.

[ Top ]

getNewGroups   [line 723]

void getNewGroups( $time, [ $distributions = null])

Experimental
  • Since: 0.3
  • Access: public

Parameters:

   $time   — 
   $distributions   — 

[ Top ]

getNewNews   [line 747]

void getNewNews( $time, [ $newsgroups = '*'])

Experimental
  • Since: 0.3
  • Access: public

Parameters:

   $time   — 
   $newsgroups   — 

[ Top ]

getOverview   [line 340]

mixed getOverview( integer $first, integer $last)

Fetch message header fields from message number $first to $last

The format of the returned array is: $messages[message_id][header_name]


Parameters:

integer   $first   —  first article to fetch
integer   $last   —  last article to fetch

[ Top ]

getOverviewFormat   [line 360]

mixed getOverviewFormat( )

Returns a list of avaible headers which are send from NNTP-server to the client for every news message

[ Top ]

getReferencesOverview   [line 378]

mixed getReferencesOverview( integer $first, integer $last)

Fetch a list of each message's reference header.

Parameters:

integer   $first   —  first article to fetch
integer   $last   —  last article to fetch

[ Top ]

group   [line 870]

string group( )

Currently selected group

[ Top ]

isConnected   [line 246]

bool isConnected( )

Test whether a connection is currently open.

[ Top ]

last   [line 832]

integer last( )

Maximum article number in currently selected group

[ Top ]

post   [line 409]

mixed post( string $newsgroups, string $subject, string $body, string $from, [optional $aditional = null])

Post an article to a number of newsgroups.

(Among the aditional headers you might think of adding could be: "NNTP-Posting-Host: <ip-of-author>", which should contain the IP-address of the author of the post, so the message can be traced back to him. Or "Organization: <org>" which contain the name of the organization the post originates from)

  • Return: (string) server response on success or (object) pear_error on failure
  • Access: public

Parameters:

string   $newsgroups   —  The newsgroup to post to.
string   $subject   —  The subject of the post.
string   $body   —  The body of the post itself.
string   $from   —  Name + email-adress of sender.
optional   $aditional   —  string $aditional Aditional headers to send.

[ Top ]

quit   [line 189]

void quit( )

Close connection to the newsserver

[ Top ]

selectArticle   [line 427]

mixed selectArticle( int $article)

Selects an article by article message-number

Parameters:

int   $article   —  The message-number (on the server) of the article to select as current article.

[ Top ]

selectGroup   [line 267]

mixed selectGroup( string $newsgroup)

Selects a newsgroup

Parameters:

string   $newsgroup   —  Newsgroup name

[ Top ]

selectNextArticle   [line 456]

mixed selectNextArticle( )

Select the next article in current group

[ Top ]

selectPreviousArticle   [line 485]

mixed selectPreviousArticle( )

Select the previous article in current group

[ Top ]
Documentation generated on Mon, 11 Mar 2019 14:20:38 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.