|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace Box\Spout\Reader\XLSX\Manager; |
|
4
|
|
|
|
|
5
|
|
|
use Box\Spout\Common\Exception\IOException; |
|
6
|
|
|
use Box\Spout\Reader\Exception\XMLProcessingException; |
|
7
|
|
|
use Box\Spout\Reader\Wrapper\XMLReader; |
|
8
|
|
|
use Box\Spout\Reader\XLSX\Creator\EntityFactory; |
|
9
|
|
|
|
|
10
|
|
|
/** |
|
11
|
|
|
* Class WorkbookRelationshipsManager |
|
12
|
|
|
* This class manages the workbook relationships defined in the associated XML file |
|
13
|
|
|
*/ |
|
14
|
|
|
class WorkbookRelationshipsManager |
|
15
|
|
|
{ |
|
16
|
|
|
const BASE_PATH = 'xl/'; |
|
17
|
|
|
|
|
18
|
|
|
/** Path of workbook relationships XML file inside the XLSX file */ |
|
19
|
|
|
const WORKBOOK_RELS_XML_FILE_PATH = 'xl/_rels/workbook.xml.rels'; |
|
20
|
|
|
|
|
21
|
|
|
/** Relationships types */ |
|
22
|
|
|
const RELATIONSHIP_TYPE_SHARED_STRINGS = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/sharedStrings'; |
|
23
|
|
|
const RELATIONSHIP_TYPE_STYLES = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles'; |
|
24
|
|
|
const RELATIONSHIP_TYPE_WORKSHEET = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet'; |
|
25
|
|
|
|
|
26
|
|
|
/** Nodes and attributes used to find relevant information in the workbook relationships XML file */ |
|
27
|
|
|
const XML_NODE_RELATIONSHIP = 'Relationship'; |
|
28
|
|
|
const XML_ATTRIBUTE_TYPE = 'Type'; |
|
29
|
|
|
const XML_ATTRIBUTE_TARGET = 'Target'; |
|
30
|
|
|
|
|
31
|
|
|
/** @var string Path of the XLSX file being read */ |
|
32
|
|
|
private $filePath; |
|
33
|
|
|
|
|
34
|
|
|
/** @var EntityFactory Factory to create entities */ |
|
35
|
|
|
private $entityFactory; |
|
36
|
|
|
|
|
37
|
|
|
/** @var array Cache of the already read workbook relationships: [TYPE] => [FILE_NAME] */ |
|
38
|
|
|
private $cachedWorkbookRelationships; |
|
39
|
|
|
|
|
40
|
|
|
/** |
|
41
|
|
|
* @param string $filePath Path of the XLSX file being read |
|
42
|
|
|
* @param EntityFactory $entityFactory Factory to create entities |
|
43
|
|
|
*/ |
|
44
|
46 |
|
public function __construct($filePath, $entityFactory) |
|
45
|
|
|
{ |
|
46
|
46 |
|
$this->filePath = $filePath; |
|
47
|
46 |
|
$this->entityFactory = $entityFactory; |
|
48
|
46 |
|
} |
|
49
|
|
|
|
|
50
|
|
|
/** |
|
51
|
|
|
* @return string The path of the shared string XML file |
|
52
|
|
|
*/ |
|
53
|
39 |
|
public function getSharedStringsXMLFilePath() |
|
54
|
|
|
{ |
|
55
|
39 |
|
$workbookRelationships = $this->getWorkbookRelationships(); |
|
56
|
39 |
|
$sharedStringsXMLFilePath = $workbookRelationships[self::RELATIONSHIP_TYPE_SHARED_STRINGS]; |
|
57
|
|
|
|
|
58
|
|
|
// the file path can be relative (e.g. "styles.xml") or absolute (e.g. "/xl/styles.xml") |
|
59
|
39 |
|
$doesContainBasePath = (strpos($sharedStringsXMLFilePath, self::BASE_PATH) !== false); |
|
60
|
39 |
|
if (!$doesContainBasePath) { |
|
61
|
|
|
// make sure we return an absolute file path |
|
62
|
39 |
|
$sharedStringsXMLFilePath = self::BASE_PATH . $sharedStringsXMLFilePath; |
|
63
|
|
|
} |
|
64
|
|
|
|
|
65
|
39 |
|
return $sharedStringsXMLFilePath; |
|
66
|
|
|
} |
|
67
|
|
|
|
|
68
|
|
|
/** |
|
69
|
|
|
* @return bool Whether the XLSX file contains a shared string XML file |
|
70
|
|
|
*/ |
|
71
|
40 |
|
public function hasSharedStringsXMLFile() |
|
72
|
|
|
{ |
|
73
|
40 |
|
$workbookRelationships = $this->getWorkbookRelationships(); |
|
74
|
|
|
|
|
75
|
40 |
|
return isset($workbookRelationships[self::RELATIONSHIP_TYPE_SHARED_STRINGS]); |
|
76
|
|
|
} |
|
77
|
|
|
|
|
78
|
|
|
/** |
|
79
|
|
|
* @return string|null The path of the styles XML file |
|
80
|
|
|
*/ |
|
81
|
38 |
|
public function getStylesXMLFilePath() |
|
82
|
|
|
{ |
|
83
|
38 |
|
$workbookRelationships = $this->getWorkbookRelationships(); |
|
84
|
38 |
|
$stylesXMLFilePath = $workbookRelationships[self::RELATIONSHIP_TYPE_STYLES]; |
|
85
|
|
|
|
|
86
|
|
|
// the file path can be relative (e.g. "styles.xml") or absolute (e.g. "/xl/styles.xml") |
|
87
|
38 |
|
$doesContainBasePath = (strpos($stylesXMLFilePath, self::BASE_PATH) !== false); |
|
88
|
38 |
|
if (!$doesContainBasePath) { |
|
89
|
|
|
// make sure we return a full path |
|
90
|
37 |
|
$stylesXMLFilePath = self::BASE_PATH . $stylesXMLFilePath; |
|
91
|
|
|
} |
|
92
|
|
|
|
|
93
|
38 |
|
return $stylesXMLFilePath; |
|
94
|
|
|
} |
|
95
|
|
|
|
|
96
|
|
|
/** |
|
97
|
|
|
* Reads the workbook.xml.rels and extracts the filename associated to the different types. |
|
98
|
|
|
* It caches the result so that the file is read only once. |
|
99
|
|
|
* |
|
100
|
|
|
* @throws \Box\Spout\Common\Exception\IOException If workbook.xml.rels can't be read |
|
101
|
|
|
* @return array |
|
102
|
|
|
*/ |
|
103
|
46 |
|
private function getWorkbookRelationships() |
|
104
|
|
|
{ |
|
105
|
46 |
|
if (!isset($this->cachedWorkbookRelationships)) { |
|
106
|
46 |
|
$xmlReader = $this->entityFactory->createXMLReader(); |
|
107
|
|
|
|
|
108
|
46 |
|
if ($xmlReader->openFileInZip($this->filePath, self::WORKBOOK_RELS_XML_FILE_PATH) === false) { |
|
109
|
|
|
throw new IOException('Could not open "' . self::WORKBOOK_RELS_XML_FILE_PATH . '".'); |
|
110
|
|
|
} |
|
111
|
|
|
|
|
112
|
|
|
try { |
|
113
|
46 |
|
$this->cachedWorkbookRelationships = []; |
|
114
|
|
|
|
|
115
|
46 |
|
while ($xmlReader->readUntilNodeFound(self::XML_NODE_RELATIONSHIP)) { |
|
116
|
46 |
|
$this->processWorkbookRelationship($xmlReader); |
|
117
|
|
|
} |
|
118
|
|
|
} catch (XMLProcessingException $exception) { |
|
119
|
|
|
throw new IOException("The workbook.xml.rels file is invalid and cannot be read. [{$exception->getMessage()}]"); |
|
120
|
|
|
} |
|
121
|
|
|
} |
|
122
|
|
|
|
|
123
|
46 |
|
return $this->cachedWorkbookRelationships; |
|
124
|
|
|
} |
|
125
|
|
|
|
|
126
|
|
|
/** |
|
127
|
|
|
* Extracts and store the data of the current workbook relationship. |
|
128
|
|
|
* |
|
129
|
|
|
* @param XMLReader $xmlReader |
|
130
|
|
|
* @return void |
|
131
|
|
|
*/ |
|
132
|
46 |
|
private function processWorkbookRelationship($xmlReader) |
|
133
|
|
|
{ |
|
134
|
46 |
|
$type = $xmlReader->getAttribute(self::XML_ATTRIBUTE_TYPE); |
|
135
|
46 |
|
$target = $xmlReader->getAttribute(self::XML_ATTRIBUTE_TARGET); |
|
136
|
|
|
|
|
137
|
|
|
// @NOTE: if a type is defined more than once, we overwrite the previous value |
|
138
|
|
|
// To be changed if we want to get the file paths of sheet XML files for instance. |
|
139
|
46 |
|
$this->cachedWorkbookRelationships[$type] = $target; |
|
140
|
46 |
|
} |
|
141
|
|
|
} |
|
142
|
|
|
|
box /
spout
