Contact_AddressBook
[ class tree: Contact_AddressBook ] [ index: Contact_AddressBook ] [ all elements ]
Packages:
Contact_AddressBook
Contact_AddresBook
Contact_Address_Book


Classes:
Contact_AddressBook_Builder
Contact_AddressBook_Converter
Contact_AddressBook_Parser
Parser
   Contact_AddressBook_Parser_csv
   Contact_AddressBook_Parser_eudora
Builder
   Contact_AddressBook_Builder_csv
   Contact_AddressBook_Builder_csv_netscape
   Contact_AddressBook_Builder_csv_outlook_express
Files:
Builder.php
Converter.php
Parser.php

subpackage Builder
csv.php
netscape.php
outlook_express.php

subpackage Examples
export2browser.php
export2file.php
import.php

subpackage Parser
csv.php
eudora.php

Class: Contact_AddressBook_Parser

Source Location: /Contact_AddressBook-0.1.0dev1/Contact/AddressBook/Parser.php

Class Overview




An abstract class for address book parser.




Author(s):






        






Variables






Methods















Child classes:






Contact_AddressBook_Parser_csv

	
Class for handling CSV address book format parse.






Contact_AddressBook_Parser_eudora

	
Class for handling Eudora address book format parse.









Inherited Variables





Inherited Methods














Class Details



[line 77]

An abstract class for address book parser.
This class contains common methods for parse the address book.









[ Top ]







Class Variables



	
	

	
$file =  ''

	
[line 87]

  Input filename.


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$result = array()

	
[line 95]

  Parse result.


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]










Method Detail



	
	
__construct (Constructor)   [line 117]

	

    

    

		Contact_AddressBook_Parser __construct(
[string
$file = null])
    

    


	
		Constructor.








        
Parameters:

    

    

          

        string  
        $file  
        — 
        (optional) Input filename.
      

        

    


        
[ Top ]

  

  
  
	
	
Contact_AddressBook_Parser (Constructor)   [line 106]

	

    

    

		Contact_AddressBook_Parser Contact_AddressBook_Parser(
[string
$file = null])
    

    


	
		PHP4 compatible constructor.








        
Parameters:

    

    

          

        string  
        $file  
        — 
        (optional) Input filename.
      

        

    


        
[ Top ]

  

  
  
	
	
getFileContents   [line 170]

	

    

    

		string|PEAR_Error getFileContents(
)
    

    


	
		Read the input file to gets file contents.


    

  • Return: String file contents on succeed or                            PEAR_Error on failure.
    • 

  • See: File::read()
    • 

  • Access: protected
    • 








        
[ Top ]

  

  
  
	
	
getResult   [line 223]

	

    

    

		array getResult(
)
    

    


	
		Get the parse result.


    

  • Return: An array of address book parse result.
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
parse   [line 195]

	

    

    

		bool|PEAR_Error parse(
[array
$conf = null])
    

    


	
		Parse input file to gets address book data.


    

  • Return: TRUE on succeed or PEAR_Error on failure.
    • 

  • Access: public
    • 







	
Overridden in child classes as:

		

	
Contact_AddressBook_Parser_csv::parse()

		
Parse input file to gets address book data.

	

		

	
Contact_AddressBook_Parser_eudora::parse()

		
Parse input file to gets address book data.

	

	


        
Parameters:

    

    

          

        array  
        $conf  
        — 
        (optional) Parse configuration.
      

        

    


        
[ Top ]

  

  
  
	
	
reset   [line 209]

	

    

    

		void reset(
)
    

    


	
		Reset the parser.
This method set the result into empty array.


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
setInput   [line 149]

	

    

    

		bool|PEAR_Error setInput(
string
$file)
    

    


	
		Set the input file to parse.


    

  • Return: TRUE on succeed or PEAR_Error on failure.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $file  
        — 
        Input filename.
      

        

    


        
[ Top ]

  

  
  
	
	
__toString   [line 133]

	

    

    

		string __toString(
)
    

    


	
		PHP5 __toString magic method.


    

  • Access: public
    • 








        
[ Top ]

  

  
  



        

		    

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