PHPExcel_Writer
[ class tree: PHPExcel_Writer ] [ index: PHPExcel_Writer ] [ all elements ]
Packages:
default
com-tecnick-tcpdf
JAMA
Math_Stats
PHPExcel
PHPExcel_Calculation
PHPExcel_Cell
PHPExcel_Reader
PHPExcel_Reader_Excel5
PHPExcel_RichText
PHPExcel_Shared
PHPExcel_Shared_Best_Fit
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_HTML

Source Location: /PHPExcel/Writer/HTML.php

Class Overview




PHPExcel_Writer_HTML




Author(s):


    
        





      
  


Copyright:


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


                

            Implements interfaces:
            

        

        




Variables







Methods















Child classes:






PHPExcel_Writer_PDF

	
PHPExcel_Writer_PDF

















Class Details



[line 63]

PHPExcel_Writer_HTML

PHPExcel_Writer_HTML





Tags:





  

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










[ Top ]







Class Variables



	
	

	
$_columnWidths =  null

	
[line 111]

  Array of column widths in points

Array of column widths in points





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$_cssStyles =  null

	
[line 104]

  Array of CSS styles

Array of CSS styles





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$_defaultFont = 

	
[line 118]

  Default font

Default font





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      PHPExcel_Style_Font
    

      

	



	
[ Top ]


	
	

	
$_imagesRoot =  '.'

	
[line 90]

  Images root

Images root





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_isBaseCell = 

	
[line 139]

  Excel cells that are upper-left corner in a cell merge

Excel cells that are upper-left corner in a cell merge





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$_isPdf =  false

	
[line 153]

  Is the current writer creating PDF?

Is the current writer creating PDF?





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$_isSpannedCell = 

	
[line 132]

  Excel cells that should not be written as HTML cells

Excel cells that should not be written as HTML cells





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$_isSpannedRow = 

	
[line 146]

  Excel rows that should not be written as HTML rows

Excel rows that should not be written as HTML rows





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$_phpExcel = 

	
[line 69]

  PHPExcel object

PHPExcel object





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      PHPExcel
    

      

	



	
[ Top ]


	
	

	
$_preCalculateFormulas =  true

	
[line 83]

  Pre-calculate formulas

Pre-calculate formulas





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$_sheetIndex = 

	
[line 76]

  Sheet index to write

Sheet index to write





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
$_spansAreCalculated = 

	
[line 125]

  Flag whether spans have been calculated

Flag whether spans have been calculated





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$_useInlineCss =  false

	
[line 97]

  Use inline CSS?

Use inline CSS?





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]










Class Methods




  

	
	
constructor __construct [line 160]

	

    

    

		PHPExcel_Writer_HTML __construct(

$phpExcel)
    

    


	
		Create a new PHPExcel_Writer_HTML

Create a new PHPExcel_Writer_HTML





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
PHPExcel_Writer_PDF::__construct()

		
Create a new PHPExcel_Writer_PDF

	

	

	
        
Parameters:

    

    

          

        PHPExcel  
        $phpExcel  
        PHPExcel object
      

        

    


        
[ Top ]

  

  

	
	
method buildCSS [line 485]

	

    

    

		array buildCSS(
[boolean
$generateSurroundingHTML = true])
    

    


	
		Build CSS styles

Build CSS styles





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $generateSurroundingHTML  
        Generate surrounding HTML style? (html { })
      

        

    


        
[ Top ]

  

  

	
	
method formatColor [line 1143]

	

    

    

		string formatColor(
string
$pValue, string
$pFormat)
    

    


	
		Add color to formatted string as inline style

Add color to formatted string as inline style





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pValue  
        Plain formatted value without color
      

          

        string  
        $pFormat  
        Format code
      

        

    


        
[ Top ]

  

  

	
	
method generateHTMLFooter [line 762]

	

    

    

		void generateHTMLFooter(
)
    

    


	
		Generate HTML footer

Generate HTML footer





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method generateHTMLHeader [line 286]

	

    

    

		string generateHTMLHeader(
[boolean
$pIncludeStyles = false])
    

    


	
		Generate HTML header

Generate HTML header





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $pIncludeStyles  
        Include styles?
      

        

    


        
[ Top ]

  

  

	
	
method generateSheetData [line 317]

	

    

    

		string generateSheetData(
)
    

    


	
		Generate sheet data

Generate sheet data





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method generateStyles [line 444]

	

    

    

		string generateStyles(
[boolean
$generateSurroundingHTML = true])
    

    


	
		Generate CSS styles

Generate CSS styles





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $generateSurroundingHTML  
        Generate surrounding HTML tags? (<style> and </style>)
      

        

    


        
[ Top ]

  

  

	
	
method getImagesRoot [line 1079]

	

    

    

		string getImagesRoot(
)
    

    


	
		Get images root

Get images root





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getPreCalculateFormulas [line 1059]

	

    

    

		boolean getPreCalculateFormulas(
)
    

    


	
		Get Pre-Calculate Formulas

Get Pre-Calculate Formulas





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getSheetIndex [line 257]

	

    

    

		int getSheetIndex(
)
    

    


	
		Get sheet index

Get sheet index





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getUseInlineCss [line 1099]

	

    

    

		boolean getUseInlineCss(
)
    

    


	
		Get use inline CSS?

Get use inline CSS?





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method save [line 178]

	

    

    

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

    


	
		Save PHPExcel to file

Save PHPExcel to file





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
Overridden in child classes as:

		

	
PHPExcel_Writer_PDF::save()

		
Save PHPExcel to file

	

	

			

		
Implementation of:

			

			
PHPExcel_Writer_IWriter::save()

						
Save PHPExcel to file

					

		
        
Parameters:

    

    

          

        string  
        $pFileName  
        
      

          

          
        $pFilename  
        
      

        

    


        
[ Top ]

  

  

	
	
method setImagesRoot [line 1089]

	

    

    

		PHPExcel_Writer_HTML setImagesRoot(
[string
$pValue = '.'])
    

    


	
		Set images root

Set images root





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setPreCalculateFormulas [line 1069]

	

    

    

		PHPExcel_Writer_HTML 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 267]

	

    

    

		PHPExcel_Writer_HTML setSheetIndex(
[int
$pValue = 0])
    

    


	
		Set sheet index

Set sheet index





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $pValue  
        Sheet index
      

        

    


        
[ Top ]

  

  

	
	
method setUseInlineCss [line 1109]

	

    

    

		PHPExcel_Writer_HTML setUseInlineCss(
[boolean
$pValue = false])
    

    


	
		Set use inline CSS?

Set use inline CSS?





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method writeAllSheets [line 275]

	

    

    

		void writeAllSheets(
)
    

    


	
		Write all sheets (resets sheetIndex to NULL)

Write all sheets (resets sheetIndex to NULL)





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method _assembleCSS [line 1043]

	

    

    

		string _assembleCSS(
[array
$pValue = array()])
    

    


	
		Takes array where of CSS properties / values and converts to CSS string

Takes array where of CSS properties / values and converts to CSS string





Tags:





  

    access:  private
  









	
        
Parameters:

    

    

          

        array  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method _calculateSpans [line 1170]

	

    

    

		void _calculateSpans(
)
    

    


	
		Calculate information about HTML colspan and rowspan which is not always the same as Excel's

Calculate information about HTML colspan and rowspan which is not always the same as Excel's





Tags:





  

    access:  private
  









	
        
[ Top ]

  

  

	
	
method _convertNbsp [line 1121]

	

    

    

		string _convertNbsp(
[string
$pValue = ''])
    

    


	
		Converts a string so that spaces occuring at beginning of each new line are replaced by &nbsp;

Converts a string so that spaces occuring at beginning of each new line are replaced by &nbsp; Example: "  Hello\n to the world" is converted to "&nbsp;&nbsp;Hello\n&nbsp;to the world"





Tags:





  

    access:  private
  









	
        
Parameters:

    

    

          

        string  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method _createCSSStyle [line 634]

	

    

    

		array _createCSSStyle(

$pStyle)
    

    


	
		Create CSS style

Create CSS style





Tags:





  

    access:  private
  









	
        
Parameters:

    

    

          

        PHPExcel_Style  
        $pStyle  
        PHPExcel_Style
      

        

    


        
[ Top ]

  

  

	
	
method _createCSSStyleAlignment [line 656]

	

    

    

		array _createCSSStyleAlignment(

$pStyle)
    

    


	
		Create CSS style (PHPExcel_Style_Alignment)

Create CSS style (PHPExcel_Style_Alignment)





Tags:





  

    access:  private
  









	
        
Parameters:

    

    

          

        PHPExcel_Style_Alignment  
        $pStyle  
        PHPExcel_Style_Alignment
      

        

    


        
[ Top ]

  

  

	
	
method _createCSSStyleBorder [line 729]

	

    

    

		string _createCSSStyleBorder(

$pStyle)
    

    


	
		Create CSS style (PHPExcel_Style_Border)

Create CSS style (PHPExcel_Style_Border)





Tags:





  

    access:  private
  









	
        
Parameters:

    

    

          

        PHPExcel_Style_Border  
        $pStyle  
        PHPExcel_Style_Border
      

        

    


        
[ Top ]

  

  

	
	
method _createCSSStyleBorders [line 709]

	

    

    

		array _createCSSStyleBorders(

$pStyle)
    

    


	
		Create CSS style (PHPExcel_Style_Borders)

Create CSS style (PHPExcel_Style_Borders)





Tags:





  

    access:  private
  









	
        
Parameters:

    

    

          

        PHPExcel_Style_Borders  
        $pStyle  
        PHPExcel_Style_Borders
      

        

    


        
[ Top ]

  

  

	
	
method _createCSSStyleFill [line 746]

	

    

    

		array _createCSSStyleFill(

$pStyle)
    

    


	
		Create CSS style (PHPExcel_Style_Fill)

Create CSS style (PHPExcel_Style_Fill)





Tags:





  

    access:  private
  









	
        
Parameters:

    

    

          

        PHPExcel_Style_Fill  
        $pStyle  
        PHPExcel_Style_Fill
      

        

    


        
[ Top ]

  

  

	
	
method _createCSSStyleFont [line 676]

	

    

    

		array _createCSSStyleFont(

$pStyle)
    

    


	
		Create CSS style (PHPExcel_Style_Font)

Create CSS style (PHPExcel_Style_Font)





Tags:





  

    access:  private
  









	
        
Parameters:

    

    

          

        PHPExcel_Style_Font  
        $pStyle  
        PHPExcel_Style_Font
      

        

    


        
[ Top ]

  

  

	
	
method _generateRow [line 834]

	

    

    

		string _generateRow(

$pSheet, [array
$pValues = null], [int
$pRow = 0])
    

    


	
		Generate row

Generate row





Tags:





  

    throws:  Exception
  

  

    access:  private
  









	
        
Parameters:

    

    

          

        PHPExcel_Worksheet  
        $pSheet  
        PHPExcel_Worksheet
      

          

        array  
        $pValues  
        Array containing cells in a row
      

          

        int  
        $pRow  
        Row number
      

        

    


        
[ Top ]

  

  

	
	
method _generateTableFooter [line 816]

	

    

    

		void _generateTableFooter(
)
    

    


	
		Generate table footer

Generate table footer





Tags:





  

    throws:  Exception
  

  

    access:  private
  









	
        
[ Top ]

  

  

	
	
method _generateTableHeader [line 779]

	

    

    

		string _generateTableHeader(
PHPExcel_Worksheet
$pSheet)
    

    


	
		Generate table header

Generate table header





Tags:





  

    throws:  Exception
  

  

    access:  private
  









	
        
Parameters:

    

    

          

        PHPExcel_Worksheet  
        $pSheet  
        The worksheet for the table we are writing
      

        

    


        
[ Top ]

  

  

	
	
method _mapBorderStyle [line 241]

	

    

    

		void _mapBorderStyle(

$borderStyle)
    

    


	
		Map border style

Map border style





Tags:





  

    access:  private
  









	
        
Parameters:

    

    

          

          
        $borderStyle  
        
      

        

    


        
[ Top ]

  

  

	
	
method _mapHAlign [line 227]

	

    

    

		string|false _mapHAlign(

$hAlign)
    

    


	
		Map HAlign

Map HAlign





Tags:





  

    access:  private
  









	
        
Parameters:

    

    

          

          
        $hAlign  
        
      

        

    


        
[ Top ]

  

  

	
	
method _mapVAlign [line 212]

	

    

    

		void _mapVAlign(

$vAlign)
    

    


	
		Map VAlign

Map VAlign





Tags:





  

    access:  private
  









	
        
Parameters:

    

    

          

          
        $vAlign  
        
      

        

    


        
[ Top ]

  

  

	
	
method _writeImageTagInCell [line 401]

	

    

    

		string _writeImageTagInCell(

$pSheet, string
$coordinates)
    

    


	
		Generate image tag in cell

Generate image tag in cell





Tags:





  

    throws:  Exception
  

  

    access:  private
  









	
        
Parameters:

    

    

          

        PHPExcel_Worksheet  
        $pSheet  
        PHPExcel_Worksheet
      

          

        string  
        $coordinates  
        Cell coordinates
      

        

    


        
[ Top ]

  






        

		    

		    Documentation generated on Mon, 11 Jan 2010 08:11:26 +0100 by phpDocumentor 1.4.1