Overview

Packages

  • JAMA
  • None
  • PHP
  • PHPExcel
    • CachedObjectStorage
    • Calculation
    • Cell
    • Chart
      • Renderer
    • Reader
      • Excel2007
      • Excel5
    • RichText
    • Settings
    • Shared
      • Escher
      • OLE
      • Trend
      • ZipArchive
    • Style
    • Worksheet
      • Drawing
    • Writer
      • 2007
      • CSV
      • Excel2007
      • Excel5
      • HTML
      • PDF

Classes

  • PHPExcel_Writer_HTML
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo
  • Download

Class PHPExcel_Writer_HTML

PHPExcel_Writer_HTML

PHPExcel_Writer_Abstract implements PHPExcel_Writer_IWriter
Extended by PHPExcel_Writer_HTML implements PHPExcel_Writer_IWriter

Direct known subclasses

PHPExcel_Writer_PDF_Core

Indirect known subclasses

PHPExcel_Writer_PDF_DomPDF, PHPExcel_Writer_PDF_mPDF, PHPExcel_Writer_PDF_tcPDF
Package: PHPExcel\Writer\HTML
Category: PHPExcel
Copyright: Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)
License: LGPL
Located at controlador/include/phpexcel/PHPExcel/Writer/HTML.php
Methods summary
public
# __construct( PHPExcel $phpExcel )

Create a new PHPExcel_Writer_HTML

Create a new PHPExcel_Writer_HTML

Parameters

$phpExcel
PHPExcel object
public
# save( string $pFilename = null )

Save PHPExcel to file

Save PHPExcel to file

Parameters

$pFilename

Throws

PHPExcel_Writer_Exception

Implementation of

PHPExcel_Writer_IWriter::save()
private string
# _mapVAlign( string $vAlign )

Map VAlign

Map VAlign

Parameters

$vAlign
Vertical alignment

Returns

string
private string|false
# _mapHAlign( string $hAlign )

Map HAlign

Map HAlign

Parameters

$hAlign
Horizontal alignment

Returns

string|false
private string
# _mapBorderStyle( integer $borderStyle )

Map border style

Map border style

Parameters

$borderStyle
Sheet index

Returns

string
public integer
# getSheetIndex( )

Get sheet index

Get sheet index

Returns

integer
public PHPExcel_Writer_HTML
# setSheetIndex( integer $pValue = 0 )

Set sheet index

Set sheet index

Parameters

$pValue
Sheet index

Returns

PHPExcel_Writer_HTML
public boolean
# getGenerateSheetNavigationBlock( )

Get sheet index

Get sheet index

Returns

boolean
public PHPExcel_Writer_HTML
# setGenerateSheetNavigationBlock( boolean $pValue = true )

Set sheet index

Set sheet index

Parameters

$pValue
Flag indicating whether the sheet navigation block should be generated or not

Returns

PHPExcel_Writer_HTML
public
# writeAllSheets( )

Write all sheets (resets sheetIndex to NULL)

Write all sheets (resets sheetIndex to NULL)
public string
# generateHTMLHeader( boolean $pIncludeStyles = false )

Generate HTML header

Generate HTML header

Parameters

$pIncludeStyles
Include styles?

Returns

string

Throws

PHPExcel_Writer_Exception
public string
# generateSheetData( )

Generate sheet data

Generate sheet data

Returns

string

Throws

PHPExcel_Writer_Exception
public string
# generateNavigation( )

Generate sheet tabs

Generate sheet tabs

Returns

string

Throws

PHPExcel_Writer_Exception
private
# _extendRowsForChartsAndImages( PHPExcel_Worksheet $pSheet, $row )
private string
# _writeImageInCell( PHPExcel_Worksheet $pSheet, string $coordinates )

Generate image tag in cell

Generate image tag in cell

Parameters

$pSheet
PHPExcel_Worksheet
$coordinates
Cell coordinates

Returns

string

Throws

PHPExcel_Writer_Exception
private string
# _writeChartInCell( PHPExcel_Worksheet $pSheet, string $coordinates )

Generate chart tag in cell

Generate chart tag in cell

Parameters

$pSheet
PHPExcel_Worksheet
$coordinates
Cell coordinates

Returns

string

Throws

PHPExcel_Writer_Exception
public string
# generateStyles( boolean $generateSurroundingHTML = true )

Generate CSS styles

Generate CSS styles

Parameters

$generateSurroundingHTML
Generate surrounding HTML tags? ()

Returns

string

Throws

PHPExcel_Writer_Exception
public array
# buildCSS( boolean $generateSurroundingHTML = true )

Build CSS styles

Build CSS styles

Parameters

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

Returns

array

Throws

PHPExcel_Writer_Exception
private array
# _createCSSStyle( PHPExcel_Style $pStyle )

Create CSS style

Create CSS style

Parameters

$pStyle
PHPExcel_Style

Returns

array
private array
# _createCSSStyleAlignment( PHPExcel_Style_Alignment $pStyle )

Create CSS style (PHPExcel_Style_Alignment)

Create CSS style (PHPExcel_Style_Alignment)

Parameters

$pStyle
PHPExcel_Style_Alignment

Returns

array
private array
# _createCSSStyleFont( PHPExcel_Style_Font $pStyle )

Create CSS style (PHPExcel_Style_Font)

Create CSS style (PHPExcel_Style_Font)

Parameters

$pStyle
PHPExcel_Style_Font

Returns

array
private array
# _createCSSStyleBorders( PHPExcel_Style_Borders $pStyle )

Create CSS style (PHPExcel_Style_Borders)

Create CSS style (PHPExcel_Style_Borders)

Parameters

$pStyle
PHPExcel_Style_Borders

Returns

array
private string
# _createCSSStyleBorder( PHPExcel_Style_Border $pStyle )

Create CSS style (PHPExcel_Style_Border)

Create CSS style (PHPExcel_Style_Border)

Parameters

$pStyle
PHPExcel_Style_Border

Returns

string
private array
# _createCSSStyleFill( PHPExcel_Style_Fill $pStyle )

Create CSS style (PHPExcel_Style_Fill)

Create CSS style (PHPExcel_Style_Fill)

Parameters

$pStyle
PHPExcel_Style_Fill

Returns

array
public
# generateHTMLFooter( )

Generate HTML footer

Generate HTML footer
private string
# _generateTableHeader( PHPExcel_Worksheet $pSheet )

Generate table header

Generate table header

Parameters

$pSheet
The worksheet for the table we are writing

Returns

string

Throws

PHPExcel_Writer_Exception
private
# _generateTableFooter( )

Generate table footer

Generate table footer

Throws

PHPExcel_Writer_Exception
private string
# _generateRow( PHPExcel_Worksheet $pSheet, array $pValues = null, integer $pRow = 0 )

Generate row

Generate row

Parameters

$pSheet
PHPExcel_Worksheet
$pValues
Array containing cells in a row
$pRow
Row number (0-based)

Returns

string

Throws

PHPExcel_Writer_Exception
private 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

Parameters

$pValue

Returns

string
public string
# getImagesRoot( )

Get images root

Get images root

Returns

string
public PHPExcel_Writer_HTML
# setImagesRoot( string $pValue = '.' )

Set images root

Set images root

Parameters

$pValue

Returns

PHPExcel_Writer_HTML
public boolean
# getEmbedImages( )

Get embed images

Get embed images

Returns

boolean
public PHPExcel_Writer_HTML
# setEmbedImages( boolean $pValue = '.' )

Set embed images

Set embed images

Parameters

$pValue

Returns

PHPExcel_Writer_HTML
public boolean
# getUseInlineCss( )

Get use inline CSS?

Get use inline CSS?

Returns

boolean
public PHPExcel_Writer_HTML
# setUseInlineCss( boolean $pValue = false )

Set use inline CSS?

Set use inline CSS?

Parameters

$pValue

Returns

PHPExcel_Writer_HTML
public string
# formatColor( string $pValue, string $pFormat )

Add color to formatted string as inline style

Add color to formatted string as inline style

Parameters

$pValue
Plain formatted value without color
$pFormat
Format code

Returns

string
private
# _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
private
# _setMargins( PHPExcel_Worksheet $pSheet )
Methods inherited from PHPExcel_Writer_Abstract
getDiskCachingDirectory(), getIncludeCharts(), getPreCalculateFormulas(), getUseDiskCaching(), setIncludeCharts(), setPreCalculateFormulas(), setUseDiskCaching()
Properties summary
protected PHPExcel $_phpExcel

PHPExcel object

PHPExcel object
#
private integer $_sheetIndex

Sheet index to write

Sheet index to write
# 0
private string $_imagesRoot

Images root

Images root
# '.'
private boolean $_embedImages

embed images, or link to images

embed images, or link to images
# FALSE
private boolean $_useInlineCss

Use inline CSS?

Use inline CSS?
# false
private array $_cssStyles

Array of CSS styles

Array of CSS styles
# null
private array $_columnWidths

Array of column widths in points

Array of column widths in points
# null
private PHPExcel_Style_Font $_defaultFont

Default font

Default font
#
private boolean $_spansAreCalculated

Flag whether spans have been calculated

Flag whether spans have been calculated
# false
private array $_isSpannedCell

Excel cells that should not be written as HTML cells

Excel cells that should not be written as HTML cells
# array()
private array $_isBaseCell

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

Excel cells that are upper-left corner in a cell merge
# array()
private array $_isSpannedRow

Excel rows that should not be written as HTML rows

Excel rows that should not be written as HTML rows
# array()
protected boolean $_isPdf

Is the current writer creating PDF?

Is the current writer creating PDF?
# false
private boolean $_generateSheetNavigationBlock

Generate the Navigation block

Generate the Navigation block
# true
Properties inherited from PHPExcel_Writer_Abstract
$_diskCachingDirectory, $_includeCharts, $_preCalculateFormulas, $_useDiskCaching
Autene API documentation generated by ApiGen