PHPExcel_Writer
[ class tree: PHPExcel_Writer ] [ index: PHPExcel_Writer ] [ all elements ]
Packages:
default
JAMA
Math_Stats
PHPExcel
PHPExcel_Calculation
PHPExcel_Cell
PHPExcel_Reader
PHPExcel_Reader_Excel5
PHPExcel_RichText
PHPExcel_Shared
PHPExcel_Shared_Escher
PHPExcel_Shared_OLE
PHPExcel_Style
PHPExcel_Worksheet
PHPExcel_Worksheet_Drawing
PHPExcel_Writer
PHPExcel_Writer_Excel5
PHPExcel_Writer_Excel2007


Files:
CSV.php
HTML.php
IWriter.php
PDF.php
Serialized.php

Interfaces:
PHPExcel_Writer_IWriter
Classes:
PHPExcel_Writer_CSV
PHPExcel_Writer_HTML
PHPExcel_Writer_PDF
PHPExcel_Writer_Serialized

Class: PHPExcel_Writer_CSV

Source Location: /PHPExcel/Writer/CSV.php

Class Overview




PHPExcel_Writer_CSV




Author(s):


    
        





      
  


Copyright:


    
  
  • Copyright (c) 2006 - 2009 PHPExcel (http://www.codeplex.com/PHPExcel)
    • 


                

            Implements interfaces:
            

        

        




Variables







Methods
























Class Details



[line 49]

PHPExcel_Writer_CSV

PHPExcel_Writer_CSV





Tags:





  

    copyright:  Copyright (c) 2006 - 2009 PHPExcel (http://www.codeplex.com/PHPExcel)
  










[ Top ]







Class Variables



	
	

	
$_delimiter = 

	
[line 62]

  Delimiter

Delimiter





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_enclosure = 

	
[line 69]

  Enclosure

Enclosure





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_lineEnding = 

	
[line 76]

  Line ending

Line ending





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_phpExcel = 

	
[line 55]

  PHPExcel object

PHPExcel object





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel
    

      

	



	
[ Top ]


	
	

	
$_preCalculateFormulas =  true

	
[line 90]

  Pre-calculate formulas

Pre-calculate formulas





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$_sheetIndex = 

	
[line 83]

  Sheet index to write

Sheet index to write





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
$_useBOM =  false

	
[line 97]

  Whether to write a BOM (for UTF8).

Whether to write a BOM (for UTF8).





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]










Class Methods




  

	
	
constructor __construct [line 104]

	

    

    

		PHPExcel_Writer_CSV __construct(

$phpExcel)
    

    


	
		Create a new PHPExcel_Writer_CSV

Create a new PHPExcel_Writer_CSV





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel  
        $phpExcel  
        PHPExcel object
      

        

    


        
[ Top ]

  

  

	
	
method getDelimiter [line 155]

	

    

    

		string getDelimiter(
)
    

    


	
		Get delimiter

Get delimiter





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getEnclosure [line 173]

	

    

    

		string getEnclosure(
)
    

    


	
		Get enclosure

Get enclosure





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getLineEnding [line 194]

	

    

    

		string getLineEnding(
)
    

    


	
		Get line ending

Get line ending





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getPreCalculateFormulas [line 288]

	

    

    

		boolean getPreCalculateFormulas(
)
    

    


	
		Get Pre-Calculate Formulas

Get Pre-Calculate Formulas





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getSheetIndex [line 230]

	

    

    

		int getSheetIndex(
)
    

    


	
		Get sheet index

Get sheet index





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getUseBOM [line 212]

	

    

    

		boolean getUseBOM(
)
    

    


	
		Get whether BOM should be used

Get whether BOM should be used





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method save [line 118]

	

    

    

		void save(
[
$pFilename = null], string
$pFileName)
    

    


	
		Save PHPExcel to file

Save PHPExcel to file





Tags:





  

    throws:  Exception
  

  

    access:  public
  









			

		
Implementation of:

			

			
PHPExcel_Writer_IWriter::save()

						
Save PHPExcel to file

					

		
        
Parameters:

    

    

          

        string  
        $pFileName  
        
      

          

          
        $pFilename  
        
      

        

    


        
[ Top ]

  

  

	
	
method setDelimiter [line 164]

	

    

    

		void setDelimiter(
[string
$pValue = ','])
    

    


	
		Set delimiter

Set delimiter





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pValue  
        Delimiter, defaults to ,
      

        

    


        
[ Top ]

  

  

	
	
method setEnclosure [line 182]

	

    

    

		void setEnclosure(
[string
$pValue = '"'])
    

    


	
		Set enclosure

Set enclosure





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pValue  
        Enclosure, defaults to "
      

        

    


        
[ Top ]

  

  

	
	
method setLineEnding [line 203]

	

    

    

		void setLineEnding(
[string
$pValue = PHP_EOL])
    

    


	
		Set line ending

Set line ending





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pValue  
        Line ending, defaults to OS line ending (PHP_EOL)
      

        

    


        
[ Top ]

  

  

	
	
method setPreCalculateFormulas [line 297]

	

    

    

		void setPreCalculateFormulas(
[boolean
$pValue = true])
    

    


	
		Set Pre-Calculate Formulas

Set Pre-Calculate Formulas





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $pValue  
        Pre-Calculate Formulas?
      

        

    


        
[ Top ]

  

  

	
	
method setSheetIndex [line 239]

	

    

    

		void setSheetIndex(
[int
$pValue = 0])
    

    


	
		Set sheet index

Set sheet index





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $pValue  
        Sheet index
      

        

    


        
[ Top ]

  

  

	
	
method setUseBOM [line 221]

	

    

    

		void setUseBOM(
[boolean
$pValue = false])
    

    


	
		Set whether BOM should be used

Set whether BOM should be used





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $pValue  
        Use UTF-8 byte-order mark? Defaults to false
      

        

    


        
[ Top ]

  

  

	
	
method _writeLine [line 250]

	

    

    

		void _writeLine(
[mixed
$pFileHandle = null], [array
$pValues = null])
    

    


	
		Write line to CSV file

Write line to CSV file





Tags:





  

    throws:  Exception
  

  

    access:  private
  









	
        
Parameters:

    

    

          

        mixed  
        $pFileHandle  
        PHP filehandle
      

          

        array  
        $pValues  
        Array containing values in a row
      

        

    


        
[ Top ]

  






        

		    

		    Documentation generated on Mon, 05 Jan 2009 20:36:45 +0100 by phpDocumentor 1.4.1