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
Responsecode.php

Class: Net_NNTP_Header

Source Location: /Net_NNTP-1.2.5/NNTP/Header.php

Class Overview




The Net_NNTP_Header class




Author(s):






        
                

Version:


    
  
  • $Id: Header.php,v 1.11.6.2 2005/05/13 21:24:55 heino Exp $
    • 








Variables






Methods
















Inherited Variables





Inherited Methods














Class Details



[line 91]

The Net_NNTP_Header class


    

  • Author: Heino H. Gehlsen <heino@gehlsen.dk>
    • 

  • Version: $Id: Header.php,v 1.11.6.2 2005/05/13 21:24:55 heino Exp $
    • 

  • See: Net_NNTP_Message
    • 

  • Since: Class available since Release 0.10.0
    • 

  • Access: public
    • 









[ Top ]







Class Variables



	
	

	
$fields = 

	
[line 101]

  Container for the header fields


    

  • Access: public
    • 





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]










Method Detail



	
	
Net_NNTP_Header (Constructor)   [line 112]

	

    

    

		Net_NNTP_Header Net_NNTP_Header(
[
$input = null])
    

    


	
		Constructor


    

  • Since: 0.1
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

          
        $input  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
add   [line 213]

	

    

    

		void add(
string
$tag, string
$value, [optional
$index = null])
    

    


	
		Add a new field


    

  • Since: 0.1
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $tag  
        — 
        
      

          

        string  
        $value  
        — 
        
      

          

        optional  
        $index  
        — 
        int $index
      

        

    


        
[ Top ]

  

  
  
	
	
clean   [line 395]

	

    

    

		void clean(
)
    

    


	
		Remove any header field that only contains whitespace.


    

  • Since: 0.1
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
cleanArray   [line 988]

	

    

    

		array cleanArray(
array
$input)
    

    


	
		Removes CRLF and misplaced empty lines before and after actual headerlines.


    

  • Since: 0.1
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        array  
        $input  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
cleanString   [line 964]

	

    

    

		string cleanString(

$string, string
$string.)
    

    


	
		Removes CRLF and misplaced empty lines before and after actual headerlines.


    

  • Since: 0.1
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $string.  
        — 
        
      

          

          
        $string  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
count   [line 357]

	

    

    

		int count(
string
$tag)
    

    


	
		Returns the number of times the given field tag appears in the header.


    

  • Since: 0.1
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $tag  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
create   [line 149]

	

    

    

		object Net_NNTP_Header &create(
[optional
$input = null])
    

    


	
		Create a new instance of Net_NNTP_Header


    

  • Return: object
    • 

  • Since: 0.1
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        optional  
        $input  
        — 
        mixed $input Can be any of the following:                                 (string) RFC2822 style header lines (CRLF included)                               (array)  RFC2822 style header lines (CRLF not included)                               (object) Net_NNTP_Header object                               (object) Net_NNTP_Message object
      

        

    


        
[ Top ]

  

  
  
	
	
decodeString   [line 892]

	

    

    

		string decodeString(
string
$input)
    

    


	
		Given a header/string, this function will decode it according to RFC2047.
Probably not *exactly* conformant, but it does pass all the given  examples (in RFC2047).


    

  • Return: Decoded header value
    • 

  • Since: 0.1
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $input  
        — 
        Input header value to decode
      

        

    


        
[ Top ]

  

  
  
	
	
delete   [line 271]

	

    

    

		void delete(
string
$tag, [optional
$index = null])
    

    


	
		Delete a field


    

  • Since: 0.1
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $tag  
        — 
        
      

          

        optional  
        $index  
        — 
        int $index
      

        

    


        
[ Top ]

  

  
  
	
	
encodeString   [line 937]

	

    

    

		string encodeString(
string
$string)
    

    


	
		Encodes the string given in $string as per RFC2047


    

  • Return: Encoded string
    • 

  • Since: 0.1
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $string  
        — 
        The string to encode
      

        

    


        
[ Top ]

  

  
  
	
	
foldArray   [line 785]

	

    

    

		array foldArray(
array
$array, [optional
$maxlen = 78])
    

    


	
		Folds an array of RFC2822 style header lines.


    

  • Since: 0.1
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        array  
        $array  
        — 
        
      

          

        optional  
        $maxlen  
        — 
        int $maxlen
      

        

    


        
[ Top ]

  

  
  
	
	
foldString   [line 814]

	

    

    

		string foldString(
string
$string, [optional
$maxlen = 78])
    

    


	
		Folds a string by inserting CRLF's and TAB's where allowed


    

  • Since: 0.1
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $string  
        — 
        
      

          

        optional  
        $maxlen  
        — 
        int $maxlen
      

        

    


        
[ Top ]

  

  
  
	
	
get   [line 301]

	

    

    

		string get(
string
$tag, [optional
$index = 0])
    

    


	
		Gets the value of a header field


    

  • Since: 0.1
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $tag  
        — 
        
      

          

        optional  
        $index  
        — 
        int $index (defaults to 0)
      

        

    


        
[ Top ]

  

  
  
	
	
getAll   [line 331]

	

    

    

		array getAll(
string
$tag, optional
1)
    

    


	
		Gets the values of a all occurences of a field


    

  • Since: 0.1
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $tag  
        — 
        
      

          

        optional  
        1  
        — 
        int $index
      

        

    


        
[ Top ]

  

  
  
	
	
getFields   [line 479]

	

    

    

		array getFields(
optional
$flags)
    

    


	
		Get the array of header fields.


    

  • Since: 0.1
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        optional  
        $flags  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
getFieldsArray   [line 513]

	

    

    

		array getFieldsArray(
[optional
$flags = NET_NNTP_HEADER_GET_DEFAULT])
    

    


	
		Export an array of RFC2822 style header style lines from the object.


    

  • Return: RFC2822 style header lines (CRLF not included)
    • 

  • Since: 0.1
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        optional  
        $flags  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
getFieldsString   [line 496]

	

    

    

		string getFieldsString(
[optional
$flags = NET_NNTP_HEADER_GET_DEFAULT])
    

    


	
		Export a string of RFC2822 style header style lines from the object.


    

  • Return: RFC2822 style header lines (CRLF included)
    • 

  • Since: 0.1
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        optional  
        $flags  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
replace   [line 241]

	

    

    

		void replace(
string
$tag, string
$value, [optional
$index = null])
    

    


	
		Replace a field's value


    

  • Since: 0.1
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $tag  
        — 
        
      

          

        string  
        $value  
        — 
        
      

          

        optional  
        $index  
        — 
        int $index
      

        

    


        
[ Top ]

  

  
  
	
	
reset   [line 128]

	

    

    

		void reset(
)
    

    


	
		Reset the field container


    

  • Since: 0.1
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
setFields   [line 428]

	

    

    

		void setFields(

&$input, [optional
$flags = NET_NNTP_HEADER_SET_DEFAULT], mixed
$input)
    

    


	
		Import RFC2822 style header lines given in $input into the object


    

  • Since: 0.1
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        mixed  
        $input  
        — 
        Can be any of the following:                      (string) RFC2822 style header lines (CRLF included)                      (array)  RFC2822 style header lines (CRLF not included)                      (object) Net_NNTP_Header object                      (object) Net_NNTP_Message object
      

          

        optional  
        $flags  
        — 
        
      

          

          
        &$input  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
tags   [line 381]

	

    

    

		array tags(
)
    

    


	
		Returns an array of all the tags that exist in the header.
Each tag will only appear in the list once.


    

  • Since: 0.1
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
unfoldArray   [line 748]

	

    

    

		array unfoldArray(
array
$array)
    

    


	
		Do the (RFC822 3.1.1) header unfolding to an array of RFC2822 header lines.


    

  • Return: Unfolded RFC2822 header lines (CRLF not included)
    • 

  • Since: 0.1
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        array  
        $array  
        — 
        RFC2822 header lines to unfolded (CRLF not included)
      

        

    


        
[ Top ]

  

  
  
	
	
unfoldString   [line 725]

	

    

    

		string unfoldString(
string
$string)
    

    


	
		Do the (RFC822 3.1.1) header unfolding to a string of RFC2822 header lines.


    

  • Return: Unfolded RFC2822 header lines (CRLF included)
    • 

  • Since: 0.1
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $string  
        — 
        RFC2822 header lines to unfolded (CRLF included)
      

        

    


        
[ Top ]

  

  
  



        

		    

		    Documentation generated on Mon, 11 Mar 2019 14:05:50 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright ©  PHP Group 2004.