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


Classes:
Net_NNTP_Header
Net_NNTP_Message
Files:
group.php
Header.php
index.php
Message.php
NNTP.php
Protocol.php
read.php
Realtime.php

Class: Net_NNTP_Message

Source Location: /Net_NNTP-0.10.2/NNTP/Message.php

Class Overview




The Net_NNTP_Message class




Author(s):






        
    

Version:


    
  
  • $Revision: 1.7.2.1 $
    • 








Variables






Methods
















Inherited Variables





Inherited Methods














Class Details



[line 73]

The Net_NNTP_Message class









[ Top ]







Class Variables



	
	

	
$body = 

	
[line 91]

  Contains the body part of the message


    

  • Access: public
    • 





  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$header = 

	
[line 83]

  
  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]










Method Detail



	
	
Net_NNTP_Message (Constructor)   [line 101]

	

    

    

		Net_NNTP_Message Net_NNTP_Message(
)
    

    


	
		Constructor.


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
create   [line 138]

	

    

    

		void &create(
[optional
$input = null], [optional
$input2 = null])
    

    


	
		Create a new instance of Net_NNTP_Message


    

  • Since: 0.1
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

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

          

        optional  
        $input2  
        — 
        mixed $input2 If given, $input will only be use for the message's                                header, while $input2 will be used for the body.                                (Disallowed when $input is a Net_NNTP_Message)
      

        

    


        
[ Top ]

  

  
  
	
	
getBody   [line 369]

	

    

    

		string getBody(
)
    

    


	
		Gets the body


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
getHeader   [line 336]

	

    

    

		object getHeader(
)
    

    


	
		Gets the header object


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
getMessageArray   [line 271]

	

    

    

		string getMessageArray(
)
    

    


	
		Get the complete transport-ready message as an array


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
getMessageString   [line 257]

	

    

    

		string getMessageString(
)
    

    


	
		Get the complete transport-ready message as a string


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
reset   [line 114]

	

    

    

		void reset(
)
    

    


	
		Resets the message object


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
setBody   [line 351]

	

    

    

		void setBody(
mixed
$body)
    

    


	
		Sets the body


    

  • Access: public
    • 








        
Parameters:

    

    

          

        mixed  
        $body  
        — 
        Array or string
      

        

    


        
[ Top ]

  

  
  
	
	
setHeader   [line 296]

	

    

    

		void setHeader(
mixed
$input)
    

    


	
		Sets the header's fields from the given $input


    

  • Access: public
    • 








        
Parameters:

    

    

          

        mixed  
        $input  
        — 
        Can be any of the following:                      (string) RFC2822 message lines (RCLF included)                      (array)  RFC2822 message lines (RCLF not included)                      (object) Net_NNTP_Header object
      

        

    


        
[ Top ]

  

  
  
	
	
setMessage   [line 214]

	

    

    

		void setMessage(
mixed
$message)
    

    


	
		Sets the header and body grom the given $message


    

  • Access: public
    • 








        
Parameters:

    

    

          

        mixed  
        $message  
        — 
        Can be any of the following:                        (string) RFC2822 message lines (RCLF included)                        (array)  RFC2822 message lines (RCLF not included)                        (object) Net_NNTP_Message object
      

        

    


        
[ Top ]

  

  
  
	
	
splitMessage   [line 386]

	

    

    

		array splitMessage(
mixed
$input)
    

    


	
		Splits the header and body given in $input apart (at the first  blank line) and return them (in an array) with the same type as $input.


    

  • Return: Contains separated header and body sections in same type as $input
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        mixed  
        $input  
        — 
        Message in form of eiter string or array
      

        

    


        
[ Top ]

  

  
  



        

		    

		    Documentation generated on Mon, 11 Mar 2019 13:52:40 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright ©  PHP Group 2004.