fluent-cart / vendor / openspout / openspout / src / Reader / XLSX / Sheet.php

Sheet.php in FluentCart A New Era of eCommerce – Faster, Lighter, and Simpler 1.5.2, at vendor/openspout/openspout/src/Reader/XLSX/Sheet.php

72 lines 2.0 KB

Raw Download Zip

1	<?php
2
3	namespace FluentCart\OpenSpout\Reader\XLSX;
4
5	use FluentCart\OpenSpout\Reader\SheetInterface;
6	/**
7	* Represents a sheet within a XLSX file.
8	*/
9	class Sheet implements SheetInterface
10	{
11	/** @var \OpenSpout\Reader\XLSX\RowIterator To iterate over sheet's rows */
12	protected $rowIterator;
13	/** @var int Index of the sheet, based on order in the workbook (zero-based) */
14	protected $index;
15	/** @var string Name of the sheet */
16	protected $name;
17	/** @var bool Whether the sheet was the active one */
18	protected $isActive;
19	/** @var bool Whether the sheet is visible */
20	protected $isVisible;
21	/**
22	* @param RowIterator $rowIterator The corresponding row iterator
23	* @param int $sheetIndex Index of the sheet, based on order in the workbook (zero-based)
24	* @param string $sheetName Name of the sheet
25	* @param bool $isSheetActive Whether the sheet was defined as active
26	* @param bool $isSheetVisible Whether the sheet is visible
27	*/
28	public function __construct($rowIterator, $sheetIndex, $sheetName, $isSheetActive, $isSheetVisible)
29	{
30	$this->rowIterator = $rowIterator;
31	$this->index = $sheetIndex;
32	$this->name = $sheetName;
33	$this->isActive = $isSheetActive;
34	$this->isVisible = $isSheetVisible;
35	}
36	/**
37	* @return \OpenSpout\Reader\XLSX\RowIterator
38	*/
39	public function getRowIterator()
40	{
41	return $this->rowIterator;
42	}
43	/**
44	* @return int Index of the sheet, based on order in the workbook (zero-based)
45	*/
46	public function getIndex()
47	{
48	return $this->index;
49	}
50	/**
51	* @return string Name of the sheet
52	*/
53	public function getName()
54	{
55	return $this->name;
56	}
57	/**
58	* @return bool Whether the sheet was defined as active
59	*/
60	public function isActive()
61	{
62	return $this->isActive;
63	}
64	/**
65	* @return bool Whether the sheet is visible
66	*/
67	public function isVisible()
68	{
69	return $this->isVisible;
70	}
71	}
72