fluent-cart / vendor / openspout / openspout / src / Writer / Common / Manager / WorksheetManagerInterface.php

WorksheetManagerInterface.php in FluentCart A New Era of eCommerce – Faster, Lighter, and Simpler 1.3.23, at vendor/openspout/openspout/src/Writer/Common/Manager/WorksheetManagerInterface.php

54 lines 1.7 KB

Raw Download Zip

1	<?php
2
3	namespace FluentCart\OpenSpout\Writer\Common\Manager;
4
5	use FluentCart\OpenSpout\Common\Entity\Row;
6	use FluentCart\OpenSpout\Writer\Common\Entity\Worksheet;
7	/**
8	* Interface WorksheetManagerInterface
9	* Inteface for worksheet managers, providing the generic interfaces to work with worksheets.
10	*/
11	interface WorksheetManagerInterface
12	{
13	/**
14	* @param null\|float $width
15	*/
16	public function setDefaultColumnWidth($width);
17	/**
18	* @param null\|float $height
19	*/
20	public function setDefaultRowHeight($height);
21	/**
22	* @param int ...$columns One or more columns with this width
23	*/
24	public function setColumnWidth(float $width, ...$columns);
25	/**
26	* @param float $width The width to set
27	* @param int $start First column index of the range
28	* @param int $end Last column index of the range
29	*/
30	public function setColumnWidthForRange(float $width, int $start, int $end);
31	/**
32	* Adds a row to the worksheet.
33	*
34	* @param Worksheet $worksheet The worksheet to add the row to
35	* @param Row $row The row to be added
36	*
37	* @throws \OpenSpout\Common\Exception\IOException If the data cannot be written
38	* @throws \OpenSpout\Common\Exception\InvalidArgumentException If a cell value's type is not supported
39	*/
40	public function addRow(Worksheet $worksheet, Row $row);
41	/**
42	* Prepares the worksheet to accept data.
43	*
44	* @param Worksheet $worksheet The worksheet to start
45	*
46	* @throws \OpenSpout\Common\Exception\IOException If the sheet data file cannot be opened for writing
47	*/
48	public function startSheet(Worksheet $worksheet);
49	/**
50	* Closes the worksheet.
51	*/
52	public function close(Worksheet $worksheet);
53	}
54