Overview

Packages

  • PHP
  • PHPWord

Classes

  • PHPWord
  • PHPWord_Autoloader
  • PHPWord_DocumentProperties
  • PHPWord_HashTable
  • PHPWord_IOFactory
  • PHPWord_Media
  • PHPWord_Section
  • PHPWord_Section_Footer
  • PHPWord_Section_Footer_PreserveText
  • PHPWord_Section_Header
  • PHPWord_Section_Image
  • PHPWord_Section_Link
  • PHPWord_Section_ListItem
  • PHPWord_Section_MemoryImage
  • PHPWord_Section_Object
  • PHPWord_Section_PageBreak
  • PHPWord_Section_Settings
  • PHPWord_Section_Table
  • PHPWord_Section_Table_Cell
  • PHPWord_Section_Table_Row
  • PHPWord_Section_Text
  • PHPWord_Section_TextBreak
  • PHPWord_Section_TextRun
  • PHPWord_Section_Title
  • PHPWord_Shared_Drawing
  • PHPWord_Shared_File
  • PHPWord_Shared_Font
  • PHPWord_Shared_String
  • PHPWord_Shared_XMLWriter
  • PHPWord_Shared_ZipStreamWrapper
  • PHPWord_Style
  • PHPWord_Style_Cell
  • PHPWord_Style_Font
  • PHPWord_Style_Image
  • PHPWord_Style_ListItem
  • PHPWord_Style_Paragraph
  • PHPWord_Style_Row
  • PHPWord_Style_Tab
  • PHPWord_Style_Table
  • PHPWord_Style_TableFull
  • PHPWord_Style_Tabs
  • PHPWord_Style_TOC
  • PHPWord_Template
  • PHPWord_TOC
  • PHPWord_Writer_ODText
  • PHPWord_Writer_ODText_Content
  • PHPWord_Writer_ODText_Manifest
  • PHPWord_Writer_ODText_Meta
  • PHPWord_Writer_ODText_Mimetype
  • PHPWord_Writer_ODText_Styles
  • PHPWord_Writer_ODText_WriterPart
  • PHPWord_Writer_RTF
  • PHPWord_Writer_Word2007
  • PHPWord_Writer_Word2007_Base
  • PHPWord_Writer_Word2007_ContentTypes
  • PHPWord_Writer_Word2007_DocProps
  • PHPWord_Writer_Word2007_Document
  • PHPWord_Writer_Word2007_DocumentRels
  • PHPWord_Writer_Word2007_Footer
  • PHPWord_Writer_Word2007_Header
  • PHPWord_Writer_Word2007_Rels
  • PHPWord_Writer_Word2007_Styles
  • PHPWord_Writer_Word2007_WriterPart

Interfaces

  • PHPWord_Writer_IWriter

Exceptions

  • PHPWord_Exception
  • Overview
  • Package
  • Class
  • Tree

Class PHPWord_Section

Class PHPWord_Section

Package: PHPWord
Copyright: Copyright (c) 2013 PHPWord
License: LGPL
Located at PHPWord/Section.php
Methods summary
public
# __construct( integer $sectionCount, mixed $settings = null )

Create a new Section

Create a new Section

Parameters

$sectionCount
integer
$sectionCount
$settings
mixed
$settings
public PHPWord_Section_Settings
# getSettings( )

Get Section Settings

Get Section Settings

Returns

PHPWord_Section_Settings
public PHPWord_Section_Text
# addText( string $text, mixed $styleFont = null, mixed $styleParagraph = null )

Add a Text Element

Add a Text Element

Parameters

$text
string
$text
$styleFont
mixed
$styleFont
$styleParagraph
mixed
$styleParagraph

Returns

PHPWord_Section_Text
public PHPWord_Section_Link
# addLink( string $linkSrc, string $linkName = null, mixed $styleFont = null, mixed $styleParagraph = null )

Add a Link Element

Add a Link Element

Parameters

$linkSrc
string
$linkSrc
$linkName
string
$linkName
$styleFont
mixed
$styleFont
$styleParagraph
mixed
$styleParagraph

Returns

PHPWord_Section_Link
public
# addTextBreak( integer $count = 1 )

Add a TextBreak Element

Add a TextBreak Element

Parameters

$count
integer
$count
public
# addPageBreak( )

Add a PageBreak Element

Add a PageBreak Element

public PHPWord_Section_Table
# addTable( mixed $style = null )

Add a Table Element

Add a Table Element

Parameters

$style
mixed
$style

Returns

PHPWord_Section_Table
public PHPWord_Section_ListItem
# addListItem( string $text, integer $depth = 0, mixed $styleFont = null, mixed $styleList = null, mixed $styleParagraph = null )

Add a ListItem Element

Add a ListItem Element

Parameters

$text
string
$text
$depth
integer
$depth
$styleFont
mixed
$styleFont
$styleList
mixed
$styleList
$styleParagraph
mixed
$styleParagraph

Returns

PHPWord_Section_ListItem
public PHPWord_Section_Object
# addObject( string $src, mixed $style = null )

Add a OLE-Object Element

Add a OLE-Object Element

Parameters

$src
string
$src
$style
mixed
$style

Returns

PHPWord_Section_Object
public PHPWord_Section_Image
# addImage( string $src, mixed $style = null )

Add a Image Element

Add a Image Element

Parameters

$src
string
$src
$style
mixed
$style

Returns

PHPWord_Section_Image
public PHPWord_Section_MemoryImage
# addMemoryImage( string $link, mixed $style = null )

Add a by PHP created Image Element

Add a by PHP created Image Element

Parameters

$link
string
$link
$style
mixed
$style

Returns

PHPWord_Section_MemoryImage
public PHPWord_TOC
# addTOC( mixed $styleFont = null, mixed $styleTOC = null )

Add a Table-of-Contents Element

Add a Table-of-Contents Element

Parameters

$styleFont
mixed
$styleFont
$styleTOC
mixed
$styleTOC

Returns

PHPWord_TOC
public PHPWord_Section_Title
# addTitle( string $text, integer $depth = 1 )

Add a Title Element

Add a Title Element

Parameters

$text
string
$text
$depth
integer
$depth

Returns

PHPWord_Section_Title
public PHPWord_Section_TextRun
# createTextRun( mixed $styleParagraph = null )

Create a new TextRun

Create a new TextRun

Returns

PHPWord_Section_TextRun
public array
# getElements( )

Get all Elements

Get all Elements

Returns

array
public PHPWord_Section_Header
# createHeader( )

Create a new Header

Create a new Header

Returns

PHPWord_Section_Header
public array
# getHeaders( )

Get Headers

Get Headers

Returns

array
public Boolean
# hasDifferentFirstPage( )

Is there a header for this section that is for the first page only?

Is there a header for this section that is for the first page only?

If any of the PHPWord_Section_Header instances have a type of PHPWord_Section_Header::FIRST then this method returns true. False otherwise.

Returns

Boolean
public PHPWord_Section_Footer
# createFooter( )

Create a new Footer

Create a new Footer

Returns

PHPWord_Section_Footer
public PHPWord_Section_Footer
# getFooter( )

Get Footer

Get Footer

Returns

PHPWord_Section_Footer
PHPWord API Docs API documentation generated by ApiGen 2.8.0