PHPExcel_Writer_Excel2007_Rels Class Reference

Inheritance diagram for PHPExcel_Writer_Excel2007_Rels:

Collaboration diagram for PHPExcel_Writer_Excel2007_Rels:

Public Member Functions
	writeRelationships (PHPExcel $pPHPExcel=null)
	Write relationships to XML format.
	writeWorkbookRelationships (PHPExcel $pPHPExcel=null)
	Write workbook relationships to XML format.
	writeWorksheetRelationships (PHPExcel_Worksheet $pWorksheet=null, $pWorksheetId=1)
	Write worksheet relationships to XML format.
	writeDrawingRelationships (PHPExcel_Worksheet $pWorksheet=null)
	Write drawing relationships to XML format.
	writeHeaderFooterDrawingRelationships (PHPExcel_Worksheet $pWorksheet=null)
	Write header/footer drawing relationships to XML format.
Public Member Functions inherited from PHPExcel_Writer_Excel2007_WriterPart
	setParentWriter (PHPExcel_Writer_IWriter $pWriter=null)
	Set parent IWriter object.
	getParentWriter ()
	Get parent IWriter object.
	__construct (PHPExcel_Writer_IWriter $pWriter=null)
	Set parent IWriter object.

Private Member Functions
	_writeRelationship (PHPExcel_Shared_XMLWriter $objWriter=null, $pId=1, $pType= '', $pTarget= '', $pTargetMode= '')
	Write Override content type.

Detailed Description

Definition at line 36 of file Rels.php.

Member Function Documentation

PHPExcel_Writer_Excel2007_Rels::_writeRelationship ( PHPExcel_Shared_XMLWriter  $objWriter = null,   $pId = 1,   $pType = '',   $pTarget = '',   $pTargetMode = ''  )

private

Write Override content type.

Parameters

PHPExcel_Shared_XMLWriter	$objWriter	XML Writer
int	$pId	Relationship ID. rId will be prepended!
string	$pType	Relationship type
string	$pTarget	Relationship target
string	$pTargetMode	Relationship target mode

Exceptions

Exception

Definition at line 359 of file Rels.php.

Referenced by writeDrawingRelationships(), writeHeaderFooterDrawingRelationships(), writeRelationships(), writeWorkbookRelationships(), and writeWorksheetRelationships().

        {
                if ($pType != '' && $pTarget != '') {
                        // Write relationship
                        $objWriter->startElement('Relationship');
                        $objWriter->writeAttribute('Id',                'rId' . $pId);
                        $objWriter->writeAttribute('Type',              $pType);
                        $objWriter->writeAttribute('Target',    $pTarget);

                        if ($pTargetMode != '') {
                                $objWriter->writeAttribute('TargetMode',        $pTargetMode);
                        }

                        $objWriter->endElement();
                } else {
                        throw new Exception("Invalid parameters passed.");
                }
        }

Here is the caller graph for this function:

PHPExcel_Writer_Excel2007_Rels::writeDrawingRelationships

(

PHPExcel_Worksheet

$pWorksheet = null

)

Write drawing relationships to XML format.

Parameters

PHPExcel_Worksheet

$pWorksheet

Returns

string XML Output

Exceptions

Exception

Definition at line 266 of file Rels.php.

References _writeRelationship(), PHPExcel_Writer_Excel2007_WriterPart\getParentWriter(), PHPExcel_Shared_XMLWriter\STORAGE_DISK, and PHPExcel_Shared_XMLWriter\STORAGE_MEMORY.

        {
                // Create XML writer
                $objWriter = null;
                if ($this->getParentWriter()->getUseDiskCaching()) {
                        $objWriter = new PHPExcel_Shared_XMLWriter(PHPExcel_Shared_XMLWriter::STORAGE_DISK, $this->getParentWriter()->getDiskCachingDirectory());
                } else {
                        $objWriter = new PHPExcel_Shared_XMLWriter(PHPExcel_Shared_XMLWriter::STORAGE_MEMORY);
                }

                // XML header
                $objWriter->startDocument('1.0','UTF-8','yes');

                // Relationships
                $objWriter->startElement('Relationships');
                $objWriter->writeAttribute('xmlns', 'http://schemas.openxmlformats.org/package/2006/relationships');

                        // Loop through images and write relationships
                        $i = 1;
                        $iterator = $pWorksheet->getDrawingCollection()->getIterator();
                        while ($iterator->valid()) {
                                if ($iterator->current() instanceof PHPExcel_Worksheet_Drawing
                                        || $iterator->current() instanceof PHPExcel_Worksheet_MemoryDrawing) {
                                        // Write relationship for image drawing
                                        $this->_writeRelationship(
                                                $objWriter,
                                                $i,
                                                'http://schemas.openxmlformats.org/officeDocument/2006/relationships/image',
                                                '../media/' . str_replace(' ', '', $iterator->current()->getIndexedFilename())
                                        );
                                }

                                $iterator->next();
                                ++$i;
                        }

                $objWriter->endElement();

                // Return
                return $objWriter->getData();
        }

Here is the call graph for this function:

PHPExcel_Writer_Excel2007_Rels::writeHeaderFooterDrawingRelationships

(

PHPExcel_Worksheet

$pWorksheet = null

)

Write header/footer drawing relationships to XML format.

Parameters

PHPExcel_Worksheet

$pWorksheet

Returns

string XML Output

Exceptions

Exception

Definition at line 315 of file Rels.php.

References _writeRelationship(), PHPExcel_Writer_Excel2007_WriterPart\getParentWriter(), PHPExcel_Shared_XMLWriter\STORAGE_DISK, and PHPExcel_Shared_XMLWriter\STORAGE_MEMORY.

        {
                // Create XML writer
                $objWriter = null;
                if ($this->getParentWriter()->getUseDiskCaching()) {
                        $objWriter = new PHPExcel_Shared_XMLWriter(PHPExcel_Shared_XMLWriter::STORAGE_DISK, $this->getParentWriter()->getDiskCachingDirectory());
                } else {
                        $objWriter = new PHPExcel_Shared_XMLWriter(PHPExcel_Shared_XMLWriter::STORAGE_MEMORY);
                }

                // XML header
                $objWriter->startDocument('1.0','UTF-8','yes');

                // Relationships
                $objWriter->startElement('Relationships');
                $objWriter->writeAttribute('xmlns', 'http://schemas.openxmlformats.org/package/2006/relationships');

                        // Loop through images and write relationships
                        foreach ($pWorksheet->getHeaderFooter()->getImages() as $key => $value) {
                                // Write relationship for image drawing
                                $this->_writeRelationship(
                                        $objWriter,
                                        $key,
                                        'http://schemas.openxmlformats.org/officeDocument/2006/relationships/image',
                                        '../media/' . $value->getIndexedFilename()
                                );
                        }

                $objWriter->endElement();

                // Return
                return $objWriter->getData();
        }

Here is the call graph for this function:

PHPExcel_Writer_Excel2007_Rels::writeRelationships

(

PHPExcel

$pPHPExcel = null

)

Write relationships to XML format.

Parameters

PHPExcel

$pPHPExcel

Returns

string XML Output

Exceptions

Exception

Definition at line 45 of file Rels.php.

References _writeRelationship(), PHPExcel_Writer_Excel2007_WriterPart\getParentWriter(), PHPExcel_Shared_XMLWriter\STORAGE_DISK, and PHPExcel_Shared_XMLWriter\STORAGE_MEMORY.

        {
                // Create XML writer
                $objWriter = null;
                if ($this->getParentWriter()->getUseDiskCaching()) {
                        $objWriter = new PHPExcel_Shared_XMLWriter(PHPExcel_Shared_XMLWriter::STORAGE_DISK, $this->getParentWriter()->getDiskCachingDirectory());
                } else {
                        $objWriter = new PHPExcel_Shared_XMLWriter(PHPExcel_Shared_XMLWriter::STORAGE_MEMORY);
                }

                // XML header
                $objWriter->startDocument('1.0','UTF-8','yes');

                // Relationships
                $objWriter->startElement('Relationships');
                $objWriter->writeAttribute('xmlns', 'http://schemas.openxmlformats.org/package/2006/relationships');

                        $customPropertyList = $pPHPExcel->getProperties()->getCustomProperties();
                        if (count($customPropertyList) > 0) {
                                // Relationship docProps/app.xml
                                $this->_writeRelationship(
                                        $objWriter,
                                        4,
                                        'http://schemas.openxmlformats.org/officeDocument/2006/relationships/custom-properties',
                                        'docProps/custom.xml'
                                );

                        }

                        // Relationship docProps/app.xml
                        $this->_writeRelationship(
                                $objWriter,
                                3,
                                'http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties',
                                'docProps/app.xml'
                        );

                        // Relationship docProps/core.xml
                        $this->_writeRelationship(
                                $objWriter,
                                2,
                                'http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties',
                                'docProps/core.xml'
                        );

                        // Relationship xl/workbook.xml
                        $this->_writeRelationship(
                                $objWriter,
                                1,
                                'http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument',
                                'xl/workbook.xml'
                        );

                $objWriter->endElement();

                // Return
                return $objWriter->getData();
        }

Here is the call graph for this function:

PHPExcel_Writer_Excel2007_Rels::writeWorkbookRelationships

(

PHPExcel

$pPHPExcel = null

)

Write workbook relationships to XML format.

Parameters

PHPExcel

$pPHPExcel

Returns

string XML Output

Exceptions

Exception

Definition at line 111 of file Rels.php.

References _writeRelationship(), PHPExcel_Writer_Excel2007_WriterPart\getParentWriter(), PHPExcel_Shared_XMLWriter\STORAGE_DISK, and PHPExcel_Shared_XMLWriter\STORAGE_MEMORY.

        {
                // Create XML writer
                $objWriter = null;
                if ($this->getParentWriter()->getUseDiskCaching()) {
                        $objWriter = new PHPExcel_Shared_XMLWriter(PHPExcel_Shared_XMLWriter::STORAGE_DISK, $this->getParentWriter()->getDiskCachingDirectory());
                } else {
                        $objWriter = new PHPExcel_Shared_XMLWriter(PHPExcel_Shared_XMLWriter::STORAGE_MEMORY);
                }

                // XML header
                $objWriter->startDocument('1.0','UTF-8','yes');

                // Relationships
                $objWriter->startElement('Relationships');
                $objWriter->writeAttribute('xmlns', 'http://schemas.openxmlformats.org/package/2006/relationships');

                        // Relationship styles.xml
                        $this->_writeRelationship(
                                $objWriter,
                                1,
                                'http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles',
                                'styles.xml'
                        );

                        // Relationship theme/theme1.xml
                        $this->_writeRelationship(
                                $objWriter,
                                2,
                                'http://schemas.openxmlformats.org/officeDocument/2006/relationships/theme',
                                'theme/theme1.xml'
                        );

                        // Relationship sharedStrings.xml
                        $this->_writeRelationship(
                                $objWriter,
                                3,
                                'http://schemas.openxmlformats.org/officeDocument/2006/relationships/sharedStrings',
                                'sharedStrings.xml'
                        );

                        // Relationships with sheets
                        $sheetCount = $pPHPExcel->getSheetCount();
                        for ($i = 0; $i < $sheetCount; ++$i) {
                                $this->_writeRelationship(
                                        $objWriter,
                                        ($i + 1 + 3),
                                        'http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet',
                                        'worksheets/sheet' . ($i + 1) . '.xml'
                                );
                        }

                $objWriter->endElement();

                // Return
                return $objWriter->getData();
        }

Here is the call graph for this function:

PHPExcel_Writer_Excel2007_Rels::writeWorksheetRelationships	(	PHPExcel_Worksheet	$pWorksheet = null,
			$pWorksheetId = 1
	)

Write worksheet relationships to XML format.

Numbering is as follows: rId1 - Drawings rId_hyperlink_x - Hyperlinks

Parameters

PHPExcel_Worksheet	$pWorksheet
int	$pWorksheetId

Returns

string XML Output

Exceptions

Exception

Definition at line 181 of file Rels.php.

References _writeRelationship(), PHPExcel_Writer_Excel2007_WriterPart\getParentWriter(), PHPExcel_Shared_XMLWriter\STORAGE_DISK, and PHPExcel_Shared_XMLWriter\STORAGE_MEMORY.

        {
                // Create XML writer
                $objWriter = null;
                if ($this->getParentWriter()->getUseDiskCaching()) {
                        $objWriter = new PHPExcel_Shared_XMLWriter(PHPExcel_Shared_XMLWriter::STORAGE_DISK, $this->getParentWriter()->getDiskCachingDirectory());
                } else {
                        $objWriter = new PHPExcel_Shared_XMLWriter(PHPExcel_Shared_XMLWriter::STORAGE_MEMORY);
                }

                // XML header
                $objWriter->startDocument('1.0','UTF-8','yes');

                // Relationships
                $objWriter->startElement('Relationships');
                $objWriter->writeAttribute('xmlns', 'http://schemas.openxmlformats.org/package/2006/relationships');

                        // Write drawing relationships?
                        if ($pWorksheet->getDrawingCollection()->count() > 0) {
                                $this->_writeRelationship(
                                        $objWriter,
                                        1,
                                        'http://schemas.openxmlformats.org/officeDocument/2006/relationships/drawing',
                                        '../drawings/drawing' . $pWorksheetId . '.xml'
                                );
                        }

                        // Write hyperlink relationships?
                        $i = 1;
                        foreach ($pWorksheet->getHyperlinkCollection() as $hyperlink) {
                                if (!$hyperlink->isInternal()) {
                                        $this->_writeRelationship(
                                                $objWriter,
                                                '_hyperlink_' . $i,
                                                'http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink',
                                                $hyperlink->getUrl(),
                                                'External'
                                        );

                                        ++$i;
                                }
                        }

                        // Write comments relationship?
                        $i = 1;
                        if (count($pWorksheet->getComments()) > 0) {
                                $this->_writeRelationship(
                                        $objWriter,
                                        '_comments_vml' . $i,
                                        'http://schemas.openxmlformats.org/officeDocument/2006/relationships/vmlDrawing',
                                        '../drawings/vmlDrawing' . $pWorksheetId . '.vml'
                                );

                                $this->_writeRelationship(
                                        $objWriter,
                                        '_comments' . $i,
                                        'http://schemas.openxmlformats.org/officeDocument/2006/relationships/comments',
                                        '../comments' . $pWorksheetId . '.xml'
                                );
                        }

                        // Write header/footer relationship?
                        $i = 1;
                        if (count($pWorksheet->getHeaderFooter()->getImages()) > 0) {
                                $this->_writeRelationship(
                                        $objWriter,
                                        '_headerfooter_vml' . $i,
                                        'http://schemas.openxmlformats.org/officeDocument/2006/relationships/vmlDrawing',
                                        '../drawings/vmlDrawingHF' . $pWorksheetId . '.vml'
                                );
                        }

                $objWriter->endElement();

                // Return
                return $objWriter->getData();
        }

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• Services/Excel/PHPExcel/1.7.6/Classes/PHPExcel/Writer/Excel2007/Rels.php