visualizer / vendor / phpoffice / phpspreadsheet / src / PhpSpreadsheet / Reader / IReader.php

IReader.php in Visualizer – Tables & Charts Manager with Built-in AI Generator 3.10.7, at vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Reader/IReader.php

138 lines 3.9 KB

Raw Download Zip

1	<?php
2
3	namespace PhpOffice\PhpSpreadsheet\Reader;
4
5	interface IReader
6	{
7	/**
8	* IReader constructor.
9	*/
10	public function __construct();
11
12	/**
13	* Can the current IReader read the file?
14	*
15	* @param string $pFilename
16	*
17	* @return bool
18	*/
19	public function canRead($pFilename);
20
21	/**
22	* Read data only?
23	* If this is true, then the Reader will only read data values for cells, it will not read any formatting information.
24	* If false (the default) it will read data and formatting.
25	*
26	* @return bool
27	*/
28	public function getReadDataOnly();
29
30	/**
31	* Set read data only
32	* Set to true, to advise the Reader only to read data values for cells, and to ignore any formatting information.
33	* Set to false (the default) to advise the Reader to read both data and formatting for cells.
34	*
35	* @param bool $pValue
36	*
37	* @return IReader
38	*/
39	public function setReadDataOnly($pValue);
40
41	/**
42	* Read empty cells?
43	* If this is true (the default), then the Reader will read data values for all cells, irrespective of value.
44	* If false it will not read data for cells containing a null value or an empty string.
45	*
46	* @return bool
47	*/
48	public function getReadEmptyCells();
49
50	/**
51	* Set read empty cells
52	* Set to true (the default) to advise the Reader read data values for all cells, irrespective of value.
53	* Set to false to advise the Reader to ignore cells containing a null value or an empty string.
54	*
55	* @param bool $pValue
56	*
57	* @return IReader
58	*/
59	public function setReadEmptyCells($pValue);
60
61	/**
62	* Read charts in workbook?
63	* If this is true, then the Reader will include any charts that exist in the workbook.
64	* Note that a ReadDataOnly value of false overrides, and charts won't be read regardless of the IncludeCharts value.
65	* If false (the default) it will ignore any charts defined in the workbook file.
66	*
67	* @return bool
68	*/
69	public function getIncludeCharts();
70
71	/**
72	* Set read charts in workbook
73	* Set to true, to advise the Reader to include any charts that exist in the workbook.
74	* Note that a ReadDataOnly value of false overrides, and charts won't be read regardless of the IncludeCharts value.
75	* Set to false (the default) to discard charts.
76	*
77	* @param bool $pValue
78	*
79	* @return IReader
80	*/
81	public function setIncludeCharts($pValue);
82
83	/**
84	* Get which sheets to load
85	* Returns either an array of worksheet names (the list of worksheets that should be loaded), or a null
86	* indicating that all worksheets in the workbook should be loaded.
87	*
88	* @return mixed
89	*/
90	public function getLoadSheetsOnly();
91
92	/**
93	* Set which sheets to load.
94	*
95	* @param mixed $value
96	* This should be either an array of worksheet names to be loaded, or a string containing a single worksheet name.
97	* If NULL, then it tells the Reader to read all worksheets in the workbook
98	*
99	* @return IReader
100	*/
101	public function setLoadSheetsOnly($value);
102
103	/**
104	* Set all sheets to load
105	* Tells the Reader to load all worksheets from the workbook.
106	*
107	* @return IReader
108	*/
109	public function setLoadAllSheets();
110
111	/**
112	* Read filter.
113	*
114	* @return IReadFilter
115	*/
116	public function getReadFilter();
117
118	/**
119	* Set read filter.
120	*
121	* @param IReadFilter $pValue
122	*
123	* @return IReader
124	*/
125	public function setReadFilter(IReadFilter $pValue);
126
127	/**
128	* Loads PhpSpreadsheet from file.
129	*
130	* @param string $pFilename
131	*
132	* @throws Exception
133	*
134	* @return \PhpOffice\PhpSpreadsheet\Spreadsheet
135	*/
136	public function load($pFilename);
137	}
138