Documentation

Rels extends WriterPart
in package

Table of Contents

Properties

$parentWriter  : Xlsx
Parent Xlsx object.

Methods

__construct()  : mixed
Set parent Xlsx object.
getParentWriter()  : Xlsx
Get parent Xlsx object.
writeDrawingRelationships()  : string
Write drawing relationships to XML format.
writeHeaderFooterDrawingRelationships()  : string
Write header/footer drawing relationships to XML format.
writeRelationships()  : string
Write relationships to XML format.
writeVMLDrawingRelationships()  : string
writeWorkbookRelationships()  : string
Write workbook relationships to XML format.
writeWorksheetRelationships()  : string
Write worksheet relationships to XML format.
writeDrawingHyperLink()  : int
writeRelationship()  : void
Write Override content type.
writeUnparsedRelationship()  : void

Properties

Methods

__construct()

Set parent Xlsx object.

public __construct(Xlsx $writer) : mixed
Parameters
$writer : Xlsx

getParentWriter()

Get parent Xlsx object.

public getParentWriter() : Xlsx
Return values
Xlsx

writeDrawingRelationships()

Write drawing relationships to XML format.

public writeDrawingRelationships(Worksheet $worksheet, int &$chartRef[, bool $includeCharts = false ]) : string
Parameters
$worksheet : Worksheet
$chartRef : int

Chart ID

$includeCharts : bool = false

Flag indicating if we should write charts

Return values
string —

XML Output

writeHeaderFooterDrawingRelationships()

Write header/footer drawing relationships to XML format.

public writeHeaderFooterDrawingRelationships(Worksheet $worksheet) : string
Parameters
$worksheet : Worksheet
Return values
string —

XML Output

writeRelationships()

Write relationships to XML format.

public writeRelationships(Spreadsheet $spreadsheet) : string
Parameters
$spreadsheet : Spreadsheet
Return values
string —

XML Output

writeVMLDrawingRelationships()

public writeVMLDrawingRelationships(Worksheet $worksheet) : string
Parameters
$worksheet : Worksheet
Return values
string

writeWorkbookRelationships()

Write workbook relationships to XML format.

public writeWorkbookRelationships(Spreadsheet $spreadsheet) : string
Parameters
$spreadsheet : Spreadsheet
Return values
string —

XML Output

writeWorksheetRelationships()

Write worksheet relationships to XML format.

public writeWorksheetRelationships(Worksheet $worksheet[, int $worksheetId = 1 ][, bool $includeCharts = false ][, int $tableRef = 1 ][, array<string|int, string> &$zipContent = [] ]) : string

Numbering is as follows: rId1 - Drawings rId_hyperlink_x - Hyperlinks

Parameters
$worksheet : Worksheet
$worksheetId : int = 1
$includeCharts : bool = false

Flag indicating if we should write charts

$tableRef : int = 1

Table ID

$zipContent : array<string|int, string> = []
Return values
string —

XML Output

writeRelationship()

Write Override content type.

private writeRelationship(XMLWriter $objWriter, int|string $id, string $type, string $target[, string $targetMode = '' ]) : void
Parameters
$objWriter : XMLWriter
$id : int|string

Relationship ID. rId will be prepended!

$type : string

Relationship type

$target : string

Relationship target

$targetMode : string = ''

Relationship target mode

writeUnparsedRelationship()

private writeUnparsedRelationship(Worksheet $worksheet, XMLWriter $objWriter, string $relationship, string $type) : void
Parameters
$worksheet : Worksheet
$objWriter : XMLWriter
$relationship : string
$type : string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results