Gitee
\
app
admin
controller
model
validate
chengji
controller
model
validate
common
controller
model
validate
home
controller
http
middleware
index
controller
kaoshi
controller
model
validate
Keti
model
keti
controller
model
validate
login
controller
validate
member
controller
renshi
controller
model
validate
rongyu
controller
model
validate
system
controller
model
validate
teach
controller
model
validate
BaconQrCode
Common
Encoder
Exception
Renderer
Color
Image
Decorator
Text
Common
Tests
Adapter
Zip
Complex
Composer
Autoload
Endroid
Installer
Tests
QrCode
Exception
Factory
Response
Tests
Writer
Khanamiryan
QrCodeTests
MyCLabs
Enum
Phinx
Db
Adapter
Table
Migration
Seed
Util
php4world
PhpOffice
Common
Adapter
Zip
Microsoft
Tests
Microsoft
PhpPowerpoint
Tests
PhpSpreadsheet
Calculation
Engine
Token
Cell
Chart
Renderer
Collection
Document
Helper
Reader
Xls
Color
Style
Xlsx
RichText
Shared
Escher
DgContainer
SpgrContainer
DggContainer
BstoreContainer
BSE
JAMA
OLE
PPS
Trend
Style
Worksheet
AutoFilter
Column
Drawing
Writer
Ods
Cell
Pdf
Xls
Xlsx
PhpWord
Collection
ComplexType
Element
Escaper
Exception
Metadata
Reader
ODText
RTF
Word2007
Shared
SimpleType
Style
Writer
HTML
Element
Part
Style
ODText
Element
Part
Style
PDF
RTF
Element
Part
Style
Word2007
Element
Part
Style
Psr
SimpleCache
Samples
Sample09
Sample10
Sample12
Sample14
Symfony
Component
Inflector
Tests
OptionsResolver
Debug
Exception
Tests
Debug
PropertyAccess
Exception
Tests
Fixtures
Polyfill
Ctype
think
cache
driver
captcha
composer
config
driver
console
command
make
optimize
input
output
descriptor
driver
formatter
question
db
builder
connector
exception
debug
exception
facade
helper
hash
log
driver
migration
command
migrate
seed
db
model
concern
relation
paginator
driver
process
exception
pipes
response
route
dispatch
session
driver
template
driver
taglib
validate
view
driver
traits
controller
WhiteHat101
Crypt
Zend
Escaper
Exception
Zxing
Common
CharacterSetEci
AbstractEnum
Detector
Reedsolomon
Qrcode
Decoder
Detector

\PhpOffice\PhpWord\Writer\PDFAbstractRenderer

Abstract PDF renderer

Not supported: PreserveText, PageBreak, Object

Summary

Methods
Properties
Constants
__construct()
save()
getContent()
isPdf()
getNotes()
addNote()
writeDocument()
getPhpWord()
setPhpWord()
getWriterPart()
isUseDiskCaching()
setUseDiskCaching()
getDiskCachingDirectory()
getTempDir()
setTempDir()
getUseDiskCaching()
getFont()
setFont()
getPaperSize()
setPaperSize()
getOrientation()
setOrientation()
No public properties found
No constants found
getTempFile()
cleanupTempFile()
clearTempDir()
getZipArchive()
openFile()
writeFile()
addFilesToPackage()
addFileToPackage()
prepareForSave()
restoreStateAfterSave()
$isPdf
$notes
$phpWord
$parts
$writerParts
$mediaPaths
$tempDir
$includeFile
$font
$paperSize
$orientation
$paperSizes
N/A
deleteDir()
$useDiskCaching
$diskCachingDirectory
$originalFilename
$tempFilename
N/A

Properties

$isPdf

$isPdf : boolean

Is the current writer creating PDF?

Type

boolean

$notes

$notes : array

Footnotes and endnotes collection

Type

array

$parts

$parts : array

Part name and file name pairs

Type

array

$writerParts

$writerParts : array

Individual writers

Type

array

$mediaPaths

$mediaPaths : array

Paths to store media files

Type

array

$tempDir

$tempDir : string

Temporary storage directory

Type

string

$includeFile

$includeFile : string

Name of renderer include file

Type

string

$font

$font : string

Font

Type

string

$paperSize

$paperSize : integer

Paper size

Type

integer

$orientation

$orientation : string

Orientation

Type

string

$paperSizes

$paperSizes : array

Paper Sizes xRef List

Type

array

$useDiskCaching

$useDiskCaching : boolean

Use disk caching

Type

boolean

$diskCachingDirectory

$diskCachingDirectory : string

Disk caching directory

Type

string

$originalFilename

$originalFilename : string

Original file name

Type

string

$tempFilename

$tempFilename : string

Temporary file name

Type

string

Methods

__construct()

__construct(\PhpOffice\PhpWord\PhpWord  $phpWord)

Create new instance

Parameters

\PhpOffice\PhpWord\PhpWord $phpWord

PhpWord object

Throws

\PhpOffice\PhpWord\Exception\Exception

save()

save(string  $filename = null)

Save PhpWord to file.

Parameters

string $filename

Throws

\PhpOffice\PhpWord\Exception\Exception

getContent()

getContent() : string

Get content

Returns

string

isPdf()

isPdf() : boolean

Get is PDF

Returns

boolean

getNotes()

getNotes() : array

Get notes

Returns

array

addNote()

addNote(integer  $noteId, string  $noteMark)

Add note.

Parameters

integer $noteId
string $noteMark

writeDocument()

writeDocument() : string

Write document

Returns

string

getPhpWord()

getPhpWord() : \PhpOffice\PhpWord\PhpWord

Get PhpWord object

Throws

\PhpOffice\PhpWord\Exception\Exception

Returns

\PhpOffice\PhpWord\PhpWord

setPhpWord()

setPhpWord(\PhpOffice\PhpWord\PhpWord  $phpWord = null) : self

Set PhpWord object

Parameters

\PhpOffice\PhpWord\PhpWord $phpWord

Returns

self

getWriterPart()

getWriterPart(string  $partName = '') : mixed

Get writer part

Parameters

string $partName

Writer part name

Returns

mixed

isUseDiskCaching()

isUseDiskCaching() : boolean

Get use disk caching status

Returns

boolean

setUseDiskCaching()

setUseDiskCaching(boolean  $value = false, string  $directory = null) : self

Set use disk caching status

Parameters

boolean $value
string $directory

Throws

\PhpOffice\PhpWord\Exception\Exception

Returns

self

getDiskCachingDirectory()

getDiskCachingDirectory() : string

Get disk caching directory

Returns

string

getTempDir()

getTempDir() : string

Get temporary directory

Returns

string

setTempDir()

setTempDir(string  $value) : self

Set temporary directory

Parameters

string $value

Returns

self

getUseDiskCaching()

getUseDiskCaching()

Get use disk caching status

getFont()

getFont() : string

Get Font

Returns

string

setFont()

setFont(string  $fontName) : self

Set font. Examples: 'arialunicid0-chinese-simplified' 'arialunicid0-chinese-traditional' 'arialunicid0-korean' 'arialunicid0-japanese'

Parameters

string $fontName

Returns

self

getPaperSize()

getPaperSize() : integer

Get Paper Size

Returns

integer

setPaperSize()

setPaperSize(integer  $value = 9) : self

Set Paper Size

Parameters

integer $value

Paper size = PAPERSIZE_A4

Returns

self

getOrientation()

getOrientation() : string

Get Orientation

Returns

string

setOrientation()

setOrientation(string  $value = 'default') : self

Set Orientation

Parameters

string $value

Page orientation ORIENTATION_DEFAULT

Returns

self

getTempFile()

getTempFile(string  $filename) : string

Get temporary file name

If $filename is php://output or php://stdout, make it a temporary file

Parameters

string $filename

Returns

string

cleanupTempFile()

cleanupTempFile()

Cleanup temporary file.

Throws

\PhpOffice\PhpWord\Exception\CopyFileException

clearTempDir()

clearTempDir()

Clear temporary directory.

getZipArchive()

getZipArchive(string  $filename) : \PhpOffice\PhpWord\Shared\ZipArchive

Get ZipArchive object

Parameters

string $filename

Throws

\Exception

Returns

\PhpOffice\PhpWord\Shared\ZipArchive

openFile()

openFile(string  $filename) : resource

Open file for writing

Parameters

string $filename

Throws

\Exception

Returns

resource

writeFile()

writeFile(resource  $fileHandle, string  $content)

Write content to file.

Parameters

resource $fileHandle
string $content

addFilesToPackage()

addFilesToPackage(\PhpOffice\PhpWord\Shared\ZipArchive  $zip, mixed  $elements)

Add files to package.

Parameters

\PhpOffice\PhpWord\Shared\ZipArchive $zip
mixed $elements

addFileToPackage()

addFileToPackage(\PhpOffice\PhpWord\Shared\ZipArchive  $zipPackage, string  $source, string  $target)

Add file to package.

Get the actual source from an archive image.

Parameters

\PhpOffice\PhpWord\Shared\ZipArchive $zipPackage
string $source
string $target

prepareForSave()

prepareForSave(string  $filename = null) : resource

Save PhpWord to PDF file, pre-save

Parameters

string $filename

Name of the file to save as

Throws

\PhpOffice\PhpWord\Exception\Exception

Returns

resource

restoreStateAfterSave()

restoreStateAfterSave(resource  $fileHandle)

Save PhpWord to PDF file, post-save

Parameters

resource $fileHandle

Throws

\PhpOffice\PhpWord\Exception\Exception

deleteDir()

deleteDir(string  $dir)

Delete directory.

Parameters

string $dir