alex
/
PhpSpreadsheet
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Unalign docblock 

Because alignment was all broken and becaues it doesn't improve much
the code readability, but potentially create more complicated diff, we
prefer to unlaign all docblocks.
This commit is contained in:
Adrien Crivelli 2017-01-23 11:25:02 +09:00
parent 031af1e9d2
commit 152d39bd42
No known key found for this signature in database
GPG Key ID: B182FD79DC6DE92E
237 changed files with 3927 additions and 3927 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/Bootstrap.php
View File

@ -12,12 +12,12 @@
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *

44
src/PhpSpreadsheet/CachedObjectStorage/APC.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\CachedObjectStorage;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -42,9 +42,9 @@ class APC extends CacheBase implements ICache
/** /**
* Store cell data in cache for the current cell object if it's "dirty", * Store cell data in cache for the current cell object if it's "dirty",
* and the 'nullify' the current cell object. * and the 'nullify' the current cell object.
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
*/ */
protected function storeData() protected function storeData()
{ {
@ -67,12 +67,12 @@ class APC extends CacheBase implements ICache
/** /**
* Add or Update a cell in cache identified by coordinate address. * Add or Update a cell in cache identified by coordinate address.
* *
* @param string $pCoord Coordinate address of the cell to update * @param string $pCoord Coordinate address of the cell to update
* @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Cell * @return \PhpOffice\PhpSpreadsheet\Cell
*/ */
public function addCacheData($pCoord, \PhpOffice\PhpSpreadsheet\Cell $cell) public function addCacheData($pCoord, \PhpOffice\PhpSpreadsheet\Cell $cell)
{ {
@ -91,11 +91,11 @@ class APC extends CacheBase implements ICache
/** /**
* Is a value set in the current \PhpOffice\PhpSpreadsheet\CachedObjectStorage\ICache for an indexed cell? * Is a value set in the current \PhpOffice\PhpSpreadsheet\CachedObjectStorage\ICache for an indexed cell?
* *
* @param string $pCoord Coordinate address of the cell to check * @param string $pCoord Coordinate address of the cell to check
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return bool * @return bool
*/ */
public function isDataSet($pCoord) public function isDataSet($pCoord)
{ {
@ -121,11 +121,11 @@ class APC extends CacheBase implements ICache
/** /**
* Get cell at a specific coordinate. * Get cell at a specific coordinate.
* *
* @param string $pCoord Coordinate of the cell * @param string $pCoord Coordinate of the cell
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Cell Cell that was found, or null if not found * @return \PhpOffice\PhpSpreadsheet\Cell Cell that was found, or null if not found
*/ */
public function getCacheData($pCoord) public function getCacheData($pCoord)
{ {
@ -160,7 +160,7 @@ class APC extends CacheBase implements ICache
/** /**
* Get a list of all cell addresses currently held in cache. * Get a list of all cell addresses currently held in cache.
* *
* @return string[] * @return string[]
*/ */
public function getCellList() public function getCellList()
{ {
@ -174,9 +174,9 @@ class APC extends CacheBase implements ICache
/** /**
* Delete a cell in cache identified by coordinate address. * Delete a cell in cache identified by coordinate address.
* *
* @param string $pCoord Coordinate address of the cell to delete * @param string $pCoord Coordinate address of the cell to delete
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
*/ */
public function deleteCacheData($pCoord) public function deleteCacheData($pCoord)
{ {
@ -190,9 +190,9 @@ class APC extends CacheBase implements ICache
/** /**
* Clone the cell collection. * Clone the cell collection.
* *
* @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The new worksheet that we're copying to * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The new worksheet that we're copying to
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
*/ */
public function copyCellCollection(\PhpOffice\PhpSpreadsheet\Worksheet $parent) public function copyCellCollection(\PhpOffice\PhpSpreadsheet\Worksheet $parent)
{ {
@ -240,8 +240,8 @@ class APC extends CacheBase implements ICache
/** /**
* Initialise this new cell collection. * Initialise this new cell collection.
* *
* @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The worksheet for this cell collection * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The worksheet for this cell collection
* @param array of mixed $arguments Additional initialisation arguments * @param array $arguments Additional initialisation arguments
*/ */
public function __construct(\PhpOffice\PhpSpreadsheet\Worksheet $parent, $arguments) public function __construct(\PhpOffice\PhpSpreadsheet\Worksheet $parent, $arguments)
{ {
@ -271,7 +271,7 @@ class APC extends CacheBase implements ICache
* Identify whether the caching method is currently available * Identify whether the caching method is currently available
* Some methods are dependent on the availability of certain extensions being enabled in the PHP build. * Some methods are dependent on the availability of certain extensions being enabled in the PHP build.
* *
* @return bool * @return bool
*/ */
public static function cacheMethodIsAvailable() public static function cacheMethodIsAvailable()
{ {

60
src/PhpSpreadsheet/CachedObjectStorage/CacheBase.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\CachedObjectStorage;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -56,7 +56,7 @@ abstract class CacheBase
/** /**
* An array of cells or cell pointers for the worksheet cells held in this cache, * An array of cells or cell pointers for the worksheet cells held in this cache,
* and indexed by their coordinate address within the worksheet. * and indexed by their coordinate address within the worksheet.
* *
* @var array of mixed * @var array of mixed
*/ */
@ -65,7 +65,7 @@ abstract class CacheBase
/** /**
* Initialise this new cell collection. * Initialise this new cell collection.
* *
* @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The worksheet for this cell collection * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The worksheet for this cell collection
*/ */
public function __construct(\PhpOffice\PhpSpreadsheet\Worksheet $parent) public function __construct(\PhpOffice\PhpSpreadsheet\Worksheet $parent)
{ {
@ -78,7 +78,7 @@ abstract class CacheBase
/** /**
* Return the parent worksheet for this cell collection. * Return the parent worksheet for this cell collection.
* *
* @return \PhpOffice\PhpSpreadsheet\Worksheet * @return \PhpOffice\PhpSpreadsheet\Worksheet
*/ */
public function getParent() public function getParent()
{ {
@ -88,9 +88,9 @@ abstract class CacheBase
/** /**
* Is a value set in the current \PhpOffice\PhpSpreadsheet\CachedObjectStorage\ICache for an indexed cell? * Is a value set in the current \PhpOffice\PhpSpreadsheet\CachedObjectStorage\ICache for an indexed cell?
* *
* @param string $pCoord Coordinate address of the cell to check * @param string $pCoord Coordinate address of the cell to check
* *
* @return bool * @return bool
*/ */
public function isDataSet($pCoord) public function isDataSet($pCoord)
{ {
@ -104,10 +104,10 @@ abstract class CacheBase
/** /**
* Move a cell object from one address to another. * Move a cell object from one address to another.
* *
* @param string $fromAddress Current address of the cell to move * @param string $fromAddress Current address of the cell to move
* @param string $toAddress Destination address of the cell to move * @param string $toAddress Destination address of the cell to move
* *
* @return bool * @return bool
*/ */
public function moveCell($fromAddress, $toAddress) public function moveCell($fromAddress, $toAddress)
{ {
@ -126,11 +126,11 @@ abstract class CacheBase
/** /**
* Add or Update a cell in cache. * Add or Update a cell in cache.
* *
* @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Cell * @return \PhpOffice\PhpSpreadsheet\Cell
*/ */
public function updateCacheData(\PhpOffice\PhpSpreadsheet\Cell $cell) public function updateCacheData(\PhpOffice\PhpSpreadsheet\Cell $cell)
{ {
@ -140,9 +140,9 @@ abstract class CacheBase
/** /**
* Delete a cell in cache identified by coordinate address. * Delete a cell in cache identified by coordinate address.
* *
* @param string $pCoord Coordinate address of the cell to delete * @param string $pCoord Coordinate address of the cell to delete
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
*/ */
public function deleteCacheData($pCoord) public function deleteCacheData($pCoord)
{ {
@ -161,7 +161,7 @@ abstract class CacheBase
/** /**
* Get a list of all cell addresses currently held in cache. * Get a list of all cell addresses currently held in cache.
* *
* @return string[] * @return string[]
*/ */
public function getCellList() public function getCellList()
{ {
@ -171,7 +171,7 @@ abstract class CacheBase
/** /**
* Sort the list of all cell addresses currently held in cache by row and column. * Sort the list of all cell addresses currently held in cache by row and column.
* *
* @return string[] * @return string[]
*/ */
public function getSortedCellList() public function getSortedCellList()
{ {
@ -215,7 +215,7 @@ abstract class CacheBase
/** /**
* Return the cell address of the currently active cell object. * Return the cell address of the currently active cell object.
* *
* @return string * @return string
*/ */
public function getCurrentAddress() public function getCurrentAddress()
{ {
@ -225,7 +225,7 @@ abstract class CacheBase
/** /**
* Return the column address of the currently active cell object. * Return the column address of the currently active cell object.
* *
* @return string * @return string
*/ */
public function getCurrentColumn() public function getCurrentColumn()
{ {
@ -237,7 +237,7 @@ abstract class CacheBase
/** /**
* Return the row address of the currently active cell object. * Return the row address of the currently active cell object.
* *
* @return int * @return int
*/ */
public function getCurrentRow() public function getCurrentRow()
{ {
@ -249,10 +249,10 @@ abstract class CacheBase
/** /**
* Get highest worksheet column. * Get highest worksheet column.
* *
* @param string $row Return the highest column for the specified row, * @param string $row Return the highest column for the specified row,
* or the highest column of any row if no row number is passed * or the highest column of any row if no row number is passed
* *
* @return string Highest column name * @return string Highest column name
*/ */
public function getHighestColumn($row = null) public function getHighestColumn($row = null)
{ {
@ -277,10 +277,10 @@ abstract class CacheBase
/** /**
* Get highest worksheet row. * Get highest worksheet row.
* *
* @param string $column Return the highest row for the specified column, * @param string $column Return the highest row for the specified column,
* or the highest row of any column if no column letter is passed * or the highest row of any column if no column letter is passed
* *
* @return int Highest row number * @return int Highest row number
*/ */
public function getHighestRow($column = null) public function getHighestRow($column = null)
{ {
@ -321,7 +321,7 @@ abstract class CacheBase
/** /**
* Clone the cell collection. * Clone the cell collection.
* *
* @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The new worksheet that we're copying to * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The new worksheet that we're copying to
*/ */
public function copyCellCollection(\PhpOffice\PhpSpreadsheet\Worksheet $parent) public function copyCellCollection(\PhpOffice\PhpSpreadsheet\Worksheet $parent)
{ {
@ -337,7 +337,7 @@ abstract class CacheBase
/** /**
* Remove a row, deleting all cells in that row. * Remove a row, deleting all cells in that row.
* *
* @param string $row Row number to remove * @param string $row Row number to remove
*/ */
public function removeRow($row) public function removeRow($row)
{ {
@ -352,7 +352,7 @@ abstract class CacheBase
/** /**
* Remove a column, deleting all cells in that column. * Remove a column, deleting all cells in that column.
* *
* @param string $column Column ID to remove * @param string $column Column ID to remove
*/ */
public function removeColumn($column) public function removeColumn($column)
{ {
@ -368,7 +368,7 @@ abstract class CacheBase
* Identify whether the caching method is currently available * Identify whether the caching method is currently available
* Some methods are dependent on the availability of certain extensions being enabled in the PHP build. * Some methods are dependent on the availability of certain extensions being enabled in the PHP build.
* *
* @return bool * @return bool
*/ */
public static function cacheMethodIsAvailable() public static function cacheMethodIsAvailable()
{ {

30
src/PhpSpreadsheet/CachedObjectStorage/DiscISAM.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\CachedObjectStorage;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -49,9 +49,9 @@ class DiscISAM extends CacheBase implements ICache
/** /**
* Store cell data in cache for the current cell object if it's "dirty", * Store cell data in cache for the current cell object if it's "dirty",
* and the 'nullify' the current cell object. * and the 'nullify' the current cell object.
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
*/ */
protected function storeData() protected function storeData()
{ {
@ -72,12 +72,12 @@ class DiscISAM extends CacheBase implements ICache
/** /**
* Add or Update a cell in cache identified by coordinate address. * Add or Update a cell in cache identified by coordinate address.
* *
* @param string $pCoord Coordinate address of the cell to update * @param string $pCoord Coordinate address of the cell to update
* @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Cell * @return \PhpOffice\PhpSpreadsheet\Cell
*/ */
public function addCacheData($pCoord, \PhpOffice\PhpSpreadsheet\Cell $cell) public function addCacheData($pCoord, \PhpOffice\PhpSpreadsheet\Cell $cell)
{ {
@ -95,11 +95,11 @@ class DiscISAM extends CacheBase implements ICache
/** /**
* Get cell at a specific coordinate. * Get cell at a specific coordinate.
* *
* @param string $pCoord Coordinate of the cell * @param string $pCoord Coordinate of the cell
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Cell Cell that was found, or null if not found * @return \PhpOffice\PhpSpreadsheet\Cell Cell that was found, or null if not found
*/ */
public function getCacheData($pCoord) public function getCacheData($pCoord)
{ {
@ -128,7 +128,7 @@ class DiscISAM extends CacheBase implements ICache
/** /**
* Get a list of all cell addresses currently held in cache. * Get a list of all cell addresses currently held in cache.
* *
* @return string[] * @return string[]
*/ */
public function getCellList() public function getCellList()
{ {
@ -142,7 +142,7 @@ class DiscISAM extends CacheBase implements ICache
/** /**
* Clone the cell collection. * Clone the cell collection.
* *
* @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The new worksheet that we're copying to * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The new worksheet that we're copying to
*/ */
public function copyCellCollection(\PhpOffice\PhpSpreadsheet\Worksheet $parent) public function copyCellCollection(\PhpOffice\PhpSpreadsheet\Worksheet $parent)
{ {
@ -178,8 +178,8 @@ class DiscISAM extends CacheBase implements ICache
/** /**
* Initialise this new cell collection. * Initialise this new cell collection.
* *
* @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The worksheet for this cell collection * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The worksheet for this cell collection
* @param array of mixed $arguments Additional initialisation arguments * @param array of mixed $arguments Additional initialisation arguments
*/ */
public function __construct(\PhpOffice\PhpSpreadsheet\Worksheet $parent, $arguments) public function __construct(\PhpOffice\PhpSpreadsheet\Worksheet $parent, $arguments)
{ {

40
src/PhpSpreadsheet/CachedObjectStorage/ICache.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\CachedObjectStorage;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -29,73 +29,73 @@ interface ICache
/** /**
* Add or Update a cell in cache identified by coordinate address. * Add or Update a cell in cache identified by coordinate address.
* *
* @param string $pCoord Coordinate address of the cell to update * @param string $pCoord Coordinate address of the cell to update
* @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Cell * @return \PhpOffice\PhpSpreadsheet\Cell
*/ */
public function addCacheData($pCoord, \PhpOffice\PhpSpreadsheet\Cell $cell); public function addCacheData($pCoord, \PhpOffice\PhpSpreadsheet\Cell $cell);
/** /**
* Add or Update a cell in cache. * Add or Update a cell in cache.
* *
* @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Cell * @return \PhpOffice\PhpSpreadsheet\Cell
*/ */
public function updateCacheData(\PhpOffice\PhpSpreadsheet\Cell $cell); public function updateCacheData(\PhpOffice\PhpSpreadsheet\Cell $cell);
/** /**
* Fetch a cell from cache identified by coordinate address. * Fetch a cell from cache identified by coordinate address.
* *
* @param string $pCoord Coordinate address of the cell to retrieve * @param string $pCoord Coordinate address of the cell to retrieve
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Cell Cell that was found, or null if not found * @return \PhpOffice\PhpSpreadsheet\Cell Cell that was found, or null if not found
*/ */
public function getCacheData($pCoord); public function getCacheData($pCoord);
/** /**
* Delete a cell in cache identified by coordinate address. * Delete a cell in cache identified by coordinate address.
* *
* @param string $pCoord Coordinate address of the cell to delete * @param string $pCoord Coordinate address of the cell to delete
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
*/ */
public function deleteCacheData($pCoord); public function deleteCacheData($pCoord);
/** /**
* Is a value set in the current \PhpOffice\PhpSpreadsheet\CachedObjectStorage\ICache for an indexed cell? * Is a value set in the current \PhpOffice\PhpSpreadsheet\CachedObjectStorage\ICache for an indexed cell?
* *
* @param string $pCoord Coordinate address of the cell to check * @param string $pCoord Coordinate address of the cell to check
* *
* @return bool * @return bool
*/ */
public function isDataSet($pCoord); public function isDataSet($pCoord);
/** /**
* Get a list of all cell addresses currently held in cache. * Get a list of all cell addresses currently held in cache.
* *
* @return string[] * @return string[]
*/ */
public function getCellList(); public function getCellList();
/** /**
* Get the list of all cell addresses currently held in cache sorted by column and row. * Get the list of all cell addresses currently held in cache sorted by column and row.
* *
* @return string[] * @return string[]
*/ */
public function getSortedCellList(); public function getSortedCellList();
/** /**
* Clone the cell collection. * Clone the cell collection.
* *
* @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The new worksheet that we're copying to * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The new worksheet that we're copying to
*/ */
public function copyCellCollection(\PhpOffice\PhpSpreadsheet\Worksheet $parent); public function copyCellCollection(\PhpOffice\PhpSpreadsheet\Worksheet $parent);
@ -103,7 +103,7 @@ interface ICache
* Identify whether the caching method is currently available * Identify whether the caching method is currently available
* Some methods are dependent on the availability of certain extensions being enabled in the PHP build. * Some methods are dependent on the availability of certain extensions being enabled in the PHP build.
* *
* @return bool * @return bool
*/ */
public static function cacheMethodIsAvailable(); public static function cacheMethodIsAvailable();
} }

26
src/PhpSpreadsheet/CachedObjectStorage/Igbinary.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\CachedObjectStorage;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -28,9 +28,9 @@ class Igbinary extends CacheBase implements ICache
{ {
/** /**
* Store cell data in cache for the current cell object if it's "dirty", * Store cell data in cache for the current cell object if it's "dirty",
* and the 'nullify' the current cell object. * and the 'nullify' the current cell object.
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
*/ */
protected function storeData() protected function storeData()
{ {
@ -48,12 +48,12 @@ class Igbinary extends CacheBase implements ICache
/** /**
* Add or Update a cell in cache identified by coordinate address. * Add or Update a cell in cache identified by coordinate address.
* *
* @param string $pCoord Coordinate address of the cell to update * @param string $pCoord Coordinate address of the cell to update
* @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Cell * @return \PhpOffice\PhpSpreadsheet\Cell
*/ */
public function addCacheData($pCoord, \PhpOffice\PhpSpreadsheet\Cell $cell) public function addCacheData($pCoord, \PhpOffice\PhpSpreadsheet\Cell $cell)
{ {
@ -71,11 +71,11 @@ class Igbinary extends CacheBase implements ICache
/** /**
* Get cell at a specific coordinate. * Get cell at a specific coordinate.
* *
* @param string $pCoord Coordinate of the cell * @param string $pCoord Coordinate of the cell
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Cell Cell that was found, or null if not found * @return \PhpOffice\PhpSpreadsheet\Cell Cell that was found, or null if not found
*/ */
public function getCacheData($pCoord) public function getCacheData($pCoord)
{ {
@ -105,7 +105,7 @@ class Igbinary extends CacheBase implements ICache
/** /**
* Get a list of all cell addresses currently held in cache. * Get a list of all cell addresses currently held in cache.
* *
* @return string[] * @return string[]
*/ */
public function getCellList() public function getCellList()
{ {
@ -137,7 +137,7 @@ class Igbinary extends CacheBase implements ICache
* Identify whether the caching method is currently available * Identify whether the caching method is currently available
* Some methods are dependent on the availability of certain extensions being enabled in the PHP build. * Some methods are dependent on the availability of certain extensions being enabled in the PHP build.
* *
* @return bool * @return bool
*/ */
public static function cacheMethodIsAvailable() public static function cacheMethodIsAvailable()
{ {

52
src/PhpSpreadsheet/CachedObjectStorage/Memcache.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\CachedObjectStorage;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -49,9 +49,9 @@ class Memcache extends CacheBase implements ICache
/** /**
* Store cell data in cache for the current cell object if it's "dirty", * Store cell data in cache for the current cell object if it's "dirty",
* and the 'nullify' the current cell object. * and the 'nullify' the current cell object.
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
*/ */
protected function storeData() protected function storeData()
{ {
@ -73,12 +73,12 @@ class Memcache extends CacheBase implements ICache
/** /**
* Add or Update a cell in cache identified by coordinate address. * Add or Update a cell in cache identified by coordinate address.
* *
* @param string $pCoord Coordinate address of the cell to update * @param string $pCoord Coordinate address of the cell to update
* @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Cell * @return \PhpOffice\PhpSpreadsheet\Cell
*/ */
public function addCacheData($pCoord, \PhpOffice\PhpSpreadsheet\Cell $cell) public function addCacheData($pCoord, \PhpOffice\PhpSpreadsheet\Cell $cell)
{ {
@ -97,11 +97,11 @@ class Memcache extends CacheBase implements ICache
/** /**
* Is a value set in the current \PhpOffice\PhpSpreadsheet\CachedObjectStorage\ICache for an indexed cell? * Is a value set in the current \PhpOffice\PhpSpreadsheet\CachedObjectStorage\ICache for an indexed cell?
* *
* @param string $pCoord Coordinate address of the cell to check * @param string $pCoord Coordinate address of the cell to check
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return bool * @return bool
*/ */
public function isDataSet($pCoord) public function isDataSet($pCoord)
{ {
@ -127,11 +127,11 @@ class Memcache extends CacheBase implements ICache
/** /**
* Get cell at a specific coordinate. * Get cell at a specific coordinate.
* *
* @param string $pCoord Coordinate of the cell * @param string $pCoord Coordinate of the cell
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Cell Cell that was found, or null if not found * @return \PhpOffice\PhpSpreadsheet\Cell Cell that was found, or null if not found
*/ */
public function getCacheData($pCoord) public function getCacheData($pCoord)
{ {
@ -166,7 +166,7 @@ class Memcache extends CacheBase implements ICache
/** /**
* Get a list of all cell addresses currently held in cache. * Get a list of all cell addresses currently held in cache.
* *
* @return string[] * @return string[]
*/ */
public function getCellList() public function getCellList()
{ {
@ -180,9 +180,9 @@ class Memcache extends CacheBase implements ICache
/** /**
* Delete a cell in cache identified by coordinate address. * Delete a cell in cache identified by coordinate address.
* *
* @param string $pCoord Coordinate address of the cell to delete * @param string $pCoord Coordinate address of the cell to delete
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
*/ */
public function deleteCacheData($pCoord) public function deleteCacheData($pCoord)
{ {
@ -196,9 +196,9 @@ class Memcache extends CacheBase implements ICache
/** /**
* Clone the cell collection. * Clone the cell collection.
* *
* @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The new worksheet that we're copying to * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The new worksheet that we're copying to
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
*/ */
public function copyCellCollection(\PhpOffice\PhpSpreadsheet\Worksheet $parent) public function copyCellCollection(\PhpOffice\PhpSpreadsheet\Worksheet $parent)
{ {
@ -246,10 +246,10 @@ class Memcache extends CacheBase implements ICache
/** /**
* Initialise this new cell collection. * Initialise this new cell collection.
* *
* @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The worksheet for this cell collection * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The worksheet for this cell collection
* @param mixed[] $arguments Additional initialisation arguments * @param mixed[] $arguments Additional initialisation arguments
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
*/ */
public function __construct(\PhpOffice\PhpSpreadsheet\Worksheet $parent, $arguments) public function __construct(\PhpOffice\PhpSpreadsheet\Worksheet $parent, $arguments)
{ {
@ -275,10 +275,10 @@ class Memcache extends CacheBase implements ICache
/** /**
* Memcache error handler. * Memcache error handler.
* *
* @param string $host Memcache server * @param string $host Memcache server
* @param int $port Memcache port * @param int $port Memcache port
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
*/ */
public function failureCallback($host, $port) public function failureCallback($host, $port)
{ {
@ -300,7 +300,7 @@ class Memcache extends CacheBase implements ICache
* Identify whether the caching method is currently available * Identify whether the caching method is currently available
* Some methods are dependent on the availability of certain extensions being enabled in the PHP build. * Some methods are dependent on the availability of certain extensions being enabled in the PHP build.
* *
* @return bool * @return bool
*/ */
public static function cacheMethodIsAvailable() public static function cacheMethodIsAvailable()
{ {

20
src/PhpSpreadsheet/CachedObjectStorage/Memory.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\CachedObjectStorage;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -36,12 +36,12 @@ class Memory extends CacheBase implements ICache
/** /**
* Add or Update a cell in cache identified by coordinate address. * Add or Update a cell in cache identified by coordinate address.
* *
* @param string $pCoord Coordinate address of the cell to update * @param string $pCoord Coordinate address of the cell to update
* @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Cell * @return \PhpOffice\PhpSpreadsheet\Cell
*/ */
public function addCacheData($pCoord, \PhpOffice\PhpSpreadsheet\Cell $cell) public function addCacheData($pCoord, \PhpOffice\PhpSpreadsheet\Cell $cell)
{ {
@ -56,11 +56,11 @@ class Memory extends CacheBase implements ICache
/** /**
* Get cell at a specific coordinate. * Get cell at a specific coordinate.
* *
* @param string $pCoord Coordinate of the cell * @param string $pCoord Coordinate of the cell
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Cell Cell that was found, or null if not found * @return \PhpOffice\PhpSpreadsheet\Cell Cell that was found, or null if not found
*/ */
public function getCacheData($pCoord) public function getCacheData($pCoord)
{ {
@ -81,7 +81,7 @@ class Memory extends CacheBase implements ICache
/** /**
* Clone the cell collection. * Clone the cell collection.
* *
* @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The new worksheet that we're copying to * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The new worksheet that we're copying to
*/ */
public function copyCellCollection(\PhpOffice\PhpSpreadsheet\Worksheet $parent) public function copyCellCollection(\PhpOffice\PhpSpreadsheet\Worksheet $parent)
{ {

24
src/PhpSpreadsheet/CachedObjectStorage/MemoryGZip.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\CachedObjectStorage;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -28,9 +28,9 @@ class MemoryGZip extends CacheBase implements ICache
{ {
/** /**
* Store cell data in cache for the current cell object if it's "dirty", * Store cell data in cache for the current cell object if it's "dirty",
* and the 'nullify' the current cell object. * and the 'nullify' the current cell object.
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
*/ */
protected function storeData() protected function storeData()
{ {
@ -46,12 +46,12 @@ class MemoryGZip extends CacheBase implements ICache
/** /**
* Add or Update a cell in cache identified by coordinate address. * Add or Update a cell in cache identified by coordinate address.
* *
* @param string $pCoord Coordinate address of the cell to update * @param string $pCoord Coordinate address of the cell to update
* @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Cell * @return \PhpOffice\PhpSpreadsheet\Cell
*/ */
public function addCacheData($pCoord, \PhpOffice\PhpSpreadsheet\Cell $cell) public function addCacheData($pCoord, \PhpOffice\PhpSpreadsheet\Cell $cell)
{ {
@ -69,11 +69,11 @@ class MemoryGZip extends CacheBase implements ICache
/** /**
* Get cell at a specific coordinate. * Get cell at a specific coordinate.
* *
* @param string $pCoord Coordinate of the cell * @param string $pCoord Coordinate of the cell
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Cell Cell that was found, or null if not found * @return \PhpOffice\PhpSpreadsheet\Cell Cell that was found, or null if not found
*/ */
public function getCacheData($pCoord) public function getCacheData($pCoord)
{ {
@ -101,7 +101,7 @@ class MemoryGZip extends CacheBase implements ICache
/** /**
* Get a list of all cell addresses currently held in cache. * Get a list of all cell addresses currently held in cache.
* *
* @return string[] * @return string[]
*/ */
public function getCellList() public function getCellList()
{ {

24
src/PhpSpreadsheet/CachedObjectStorage/MemorySerialized.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\CachedObjectStorage;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -28,9 +28,9 @@ class MemorySerialized extends CacheBase implements ICache
{ {
/** /**
* Store cell data in cache for the current cell object if it's "dirty", * Store cell data in cache for the current cell object if it's "dirty",
* and the 'nullify' the current cell object. * and the 'nullify' the current cell object.
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
*/ */
protected function storeData() protected function storeData()
{ {
@ -46,12 +46,12 @@ class MemorySerialized extends CacheBase implements ICache
/** /**
* Add or Update a cell in cache identified by coordinate address. * Add or Update a cell in cache identified by coordinate address.
* *
* @param string $pCoord Coordinate address of the cell to update * @param string $pCoord Coordinate address of the cell to update
* @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Cell * @return \PhpOffice\PhpSpreadsheet\Cell
*/ */
public function addCacheData($pCoord, \PhpOffice\PhpSpreadsheet\Cell $cell) public function addCacheData($pCoord, \PhpOffice\PhpSpreadsheet\Cell $cell)
{ {
@ -69,11 +69,11 @@ class MemorySerialized extends CacheBase implements ICache
/** /**
* Get cell at a specific coordinate. * Get cell at a specific coordinate.
* *
* @param string $pCoord Coordinate of the cell * @param string $pCoord Coordinate of the cell
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Cell Cell that was found, or null if not found * @return \PhpOffice\PhpSpreadsheet\Cell Cell that was found, or null if not found
*/ */
public function getCacheData($pCoord) public function getCacheData($pCoord)
{ {
@ -101,7 +101,7 @@ class MemorySerialized extends CacheBase implements ICache
/** /**
* Get a list of all cell addresses currently held in cache. * Get a list of all cell addresses currently held in cache.
* *
* @return string[] * @return string[]
*/ */
public function getCellList() public function getCellList()
{ {

30
src/PhpSpreadsheet/CachedObjectStorage/PHPTemp.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\CachedObjectStorage;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -42,9 +42,9 @@ class PHPTemp extends CacheBase implements ICache
/** /**
* Store cell data in cache for the current cell object if it's "dirty", * Store cell data in cache for the current cell object if it's "dirty",
* and the 'nullify' the current cell object. * and the 'nullify' the current cell object.
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
*/ */
protected function storeData() protected function storeData()
{ {
@ -65,12 +65,12 @@ class PHPTemp extends CacheBase implements ICache
/** /**
* Add or Update a cell in cache identified by coordinate address. * Add or Update a cell in cache identified by coordinate address.
* *
* @param string $pCoord Coordinate address of the cell to update * @param string $pCoord Coordinate address of the cell to update
* @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Cell * @return \PhpOffice\PhpSpreadsheet\Cell
*/ */
public function addCacheData($pCoord, \PhpOffice\PhpSpreadsheet\Cell $cell) public function addCacheData($pCoord, \PhpOffice\PhpSpreadsheet\Cell $cell)
{ {
@ -88,11 +88,11 @@ class PHPTemp extends CacheBase implements ICache
/** /**
* Get cell at a specific coordinate. * Get cell at a specific coordinate.
* *
* @param string $pCoord Coordinate of the cell * @param string $pCoord Coordinate of the cell
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Cell Cell that was found, or null if not found * @return \PhpOffice\PhpSpreadsheet\Cell Cell that was found, or null if not found
*/ */
public function getCacheData($pCoord) public function getCacheData($pCoord)
{ {
@ -121,7 +121,7 @@ class PHPTemp extends CacheBase implements ICache
/** /**
* Get a list of all cell addresses currently held in cache. * Get a list of all cell addresses currently held in cache.
* *
* @return string[] * @return string[]
*/ */
public function getCellList() public function getCellList()
{ {
@ -135,7 +135,7 @@ class PHPTemp extends CacheBase implements ICache
/** /**
* Clone the cell collection. * Clone the cell collection.
* *
* @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The new worksheet that we're copying to * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The new worksheet that we're copying to
*/ */
public function copyCellCollection(\PhpOffice\PhpSpreadsheet\Worksheet $parent) public function copyCellCollection(\PhpOffice\PhpSpreadsheet\Worksheet $parent)
{ {
@ -171,8 +171,8 @@ class PHPTemp extends CacheBase implements ICache
/** /**
* Initialise this new cell collection. * Initialise this new cell collection.
* *
* @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The worksheet for this cell collection * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The worksheet for this cell collection
* @param mixed[] $arguments Additional initialisation arguments * @param mixed[] $arguments Additional initialisation arguments
*/ */
public function __construct(\PhpOffice\PhpSpreadsheet\Worksheet $parent, $arguments) public function __construct(\PhpOffice\PhpSpreadsheet\Worksheet $parent, $arguments)
{ {

54
src/PhpSpreadsheet/CachedObjectStorage/SQLite.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\CachedObjectStorage;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -42,9 +42,9 @@ class SQLite extends CacheBase implements ICache
/** /**
* Store cell data in cache for the current cell object if it's "dirty", * Store cell data in cache for the current cell object if it's "dirty",
* and the 'nullify' the current cell object. * and the 'nullify' the current cell object.
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
*/ */
protected function storeData() protected function storeData()
{ {
@ -62,12 +62,12 @@ class SQLite extends CacheBase implements ICache
/** /**
* Add or Update a cell in cache identified by coordinate address. * Add or Update a cell in cache identified by coordinate address.
* *
* @param string $pCoord Coordinate address of the cell to update * @param string $pCoord Coordinate address of the cell to update
* @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Cell * @return \PhpOffice\PhpSpreadsheet\Cell
*/ */
public function addCacheData($pCoord, \PhpOffice\PhpSpreadsheet\Cell $cell) public function addCacheData($pCoord, \PhpOffice\PhpSpreadsheet\Cell $cell)
{ {
@ -85,11 +85,11 @@ class SQLite extends CacheBase implements ICache
/** /**
* Get cell at a specific coordinate. * Get cell at a specific coordinate.
* *
* @param string $pCoord Coordinate of the cell * @param string $pCoord Coordinate of the cell
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Cell Cell that was found, or null if not found * @return \PhpOffice\PhpSpreadsheet\Cell Cell that was found, or null if not found
*/ */
public function getCacheData($pCoord) public function getCacheData($pCoord)
{ {
@ -122,11 +122,11 @@ class SQLite extends CacheBase implements ICache
/** /**
* Is a value set for an indexed cell? * Is a value set for an indexed cell?
* *
* @param string $pCoord Coordinate address of the cell to check * @param string $pCoord Coordinate address of the cell to check
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return bool * @return bool
*/ */
public function isDataSet($pCoord) public function isDataSet($pCoord)
{ {
@ -150,9 +150,9 @@ class SQLite extends CacheBase implements ICache
/** /**
* Delete a cell in cache identified by coordinate address. * Delete a cell in cache identified by coordinate address.
* *
* @param string $pCoord Coordinate address of the cell to delete * @param string $pCoord Coordinate address of the cell to delete
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
*/ */
public function deleteCacheData($pCoord) public function deleteCacheData($pCoord)
{ {
@ -173,12 +173,12 @@ class SQLite extends CacheBase implements ICache
/** /**
* Move a cell object from one address to another. * Move a cell object from one address to another.
* *
* @param string $fromAddress Current address of the cell to move * @param string $fromAddress Current address of the cell to move
* @param string $toAddress Destination address of the cell to move * @param string $toAddress Destination address of the cell to move
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return bool * @return bool
*/ */
public function moveCell($fromAddress, $toAddress) public function moveCell($fromAddress, $toAddress)
{ {
@ -204,9 +204,9 @@ class SQLite extends CacheBase implements ICache
/** /**
* Get a list of all cell addresses currently held in cache. * Get a list of all cell addresses currently held in cache.
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return string[] * @return string[]
*/ */
public function getCellList() public function getCellList()
{ {
@ -231,9 +231,9 @@ class SQLite extends CacheBase implements ICache
/** /**
* Clone the cell collection. * Clone the cell collection.
* *
* @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The new worksheet that we're copying to * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The new worksheet that we're copying to
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
*/ */
public function copyCellCollection(\PhpOffice\PhpSpreadsheet\Worksheet $parent) public function copyCellCollection(\PhpOffice\PhpSpreadsheet\Worksheet $parent)
{ {
@ -271,9 +271,9 @@ class SQLite extends CacheBase implements ICache
/** /**
* Initialise this new cell collection. * Initialise this new cell collection.
* *
* @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The worksheet for this cell collection * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The worksheet for this cell collection
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
*/ */
public function __construct(\PhpOffice\PhpSpreadsheet\Worksheet $parent) public function __construct(\PhpOffice\PhpSpreadsheet\Worksheet $parent)
{ {
@ -307,7 +307,7 @@ class SQLite extends CacheBase implements ICache
* Identify whether the caching method is currently available * Identify whether the caching method is currently available
* Some methods are dependent on the availability of certain extensions being enabled in the PHP build. * Some methods are dependent on the availability of certain extensions being enabled in the PHP build.
* *
* @return bool * @return bool
*/ */
public static function cacheMethodIsAvailable() public static function cacheMethodIsAvailable()
{ {

58
src/PhpSpreadsheet/CachedObjectStorage/SQLite3.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\CachedObjectStorage;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -70,9 +70,9 @@ class SQLite3 extends CacheBase implements ICache
/** /**
* Store cell data in cache for the current cell object if it's "dirty", * Store cell data in cache for the current cell object if it's "dirty",
* and the 'nullify' the current cell object. * and the 'nullify' the current cell object.
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
*/ */
protected function storeData() protected function storeData()
{ {
@ -93,12 +93,12 @@ class SQLite3 extends CacheBase implements ICache
/** /**
* Add or Update a cell in cache identified by coordinate address. * Add or Update a cell in cache identified by coordinate address.
* *
* @param string $pCoord Coordinate address of the cell to update * @param string $pCoord Coordinate address of the cell to update
* @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Cell * @return \PhpOffice\PhpSpreadsheet\Cell
*/ */
public function addCacheData($pCoord, \PhpOffice\PhpSpreadsheet\Cell $cell) public function addCacheData($pCoord, \PhpOffice\PhpSpreadsheet\Cell $cell)
{ {
@ -116,12 +116,12 @@ class SQLite3 extends CacheBase implements ICache
/** /**
* Get cell at a specific coordinate. * Get cell at a specific coordinate.
* *
* @param string $pCoord Coordinate of the cell * @param string $pCoord Coordinate of the cell
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Cell Cell that was found, or null if not found * @return \PhpOffice\PhpSpreadsheet\Cell Cell that was found, or null if not found
*/ */
public function getCacheData($pCoord) public function getCacheData($pCoord)
{ {
@ -155,11 +155,11 @@ class SQLite3 extends CacheBase implements ICache
/** /**
* Is a value set for an indexed cell? * Is a value set for an indexed cell?
* *
* @param string $pCoord Coordinate address of the cell to check * @param string $pCoord Coordinate address of the cell to check
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return bool * @return bool
*/ */
public function isDataSet($pCoord) public function isDataSet($pCoord)
{ {
@ -179,11 +179,11 @@ class SQLite3 extends CacheBase implements ICache
} }
/** /**
* Delete a cell in cache identified by coordinate address. * Delete a cell in cache identified by coordinate address.
* *
* @param string $pCoord Coordinate address of the cell to delete * @param string $pCoord Coordinate address of the cell to delete
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
*/ */
public function deleteCacheData($pCoord) public function deleteCacheData($pCoord)
{ {
@ -205,12 +205,12 @@ class SQLite3 extends CacheBase implements ICache
/** /**
* Move a cell object from one address to another. * Move a cell object from one address to another.
* *
* @param string $fromAddress Current address of the cell to move * @param string $fromAddress Current address of the cell to move
* @param string $toAddress Destination address of the cell to move * @param string $toAddress Destination address of the cell to move
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return bool * @return bool
*/ */
public function moveCell($fromAddress, $toAddress) public function moveCell($fromAddress, $toAddress)
{ {
@ -237,9 +237,9 @@ class SQLite3 extends CacheBase implements ICache
/** /**
* Get a list of all cell addresses currently held in cache. * Get a list of all cell addresses currently held in cache.
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return string[] * @return string[]
*/ */
public function getCellList() public function getCellList()
{ {
@ -264,9 +264,9 @@ class SQLite3 extends CacheBase implements ICache
/** /**
* Clone the cell collection. * Clone the cell collection.
* *
* @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The new worksheet that we're copying to * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The new worksheet that we're copying to
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
*/ */
public function copyCellCollection(\PhpOffice\PhpSpreadsheet\Worksheet $parent) public function copyCellCollection(\PhpOffice\PhpSpreadsheet\Worksheet $parent)
{ {
@ -304,9 +304,9 @@ class SQLite3 extends CacheBase implements ICache
/** /**
* Initialise this new cell collection. * Initialise this new cell collection.
* *
* @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The worksheet for this cell collection * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The worksheet for this cell collection
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
*/ */
public function __construct(\PhpOffice\PhpSpreadsheet\Worksheet $parent) public function __construct(\PhpOffice\PhpSpreadsheet\Worksheet $parent)
{ {
@ -346,7 +346,7 @@ class SQLite3 extends CacheBase implements ICache
* Identify whether the caching method is currently available * Identify whether the caching method is currently available
* Some methods are dependent on the availability of certain extensions being enabled in the PHP build. * Some methods are dependent on the availability of certain extensions being enabled in the PHP build.
* *
* @return bool * @return bool
*/ */
public static function cacheMethodIsAvailable() public static function cacheMethodIsAvailable()
{ {

44
src/PhpSpreadsheet/CachedObjectStorage/Wincache.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\CachedObjectStorage;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -42,9 +42,9 @@ class Wincache extends CacheBase implements ICache
/** /**
* Store cell data in cache for the current cell object if it's "dirty", * Store cell data in cache for the current cell object if it's "dirty",
* and the 'nullify' the current cell object. * and the 'nullify' the current cell object.
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
*/ */
protected function storeData() protected function storeData()
{ {
@ -72,12 +72,12 @@ class Wincache extends CacheBase implements ICache
/** /**
* Add or Update a cell in cache identified by coordinate address. * Add or Update a cell in cache identified by coordinate address.
* *
* @param string $pCoord Coordinate address of the cell to update * @param string $pCoord Coordinate address of the cell to update
* @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Cell * @return \PhpOffice\PhpSpreadsheet\Cell
*/ */
public function addCacheData($pCoord, \PhpOffice\PhpSpreadsheet\Cell $cell) public function addCacheData($pCoord, \PhpOffice\PhpSpreadsheet\Cell $cell)
{ {
@ -96,11 +96,11 @@ class Wincache extends CacheBase implements ICache
/** /**
* Is a value set in the current \PhpOffice\PhpSpreadsheet\CachedObjectStorage\ICache for an indexed cell? * Is a value set in the current \PhpOffice\PhpSpreadsheet\CachedObjectStorage\ICache for an indexed cell?
* *
* @param string $pCoord Coordinate address of the cell to check * @param string $pCoord Coordinate address of the cell to check
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return bool * @return bool
*/ */
public function isDataSet($pCoord) public function isDataSet($pCoord)
{ {
@ -126,11 +126,11 @@ class Wincache extends CacheBase implements ICache
/** /**
* Get cell at a specific coordinate. * Get cell at a specific coordinate.
* *
* @param string $pCoord Coordinate of the cell * @param string $pCoord Coordinate of the cell
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Cell Cell that was found, or null if not found * @return \PhpOffice\PhpSpreadsheet\Cell Cell that was found, or null if not found
*/ */
public function getCacheData($pCoord) public function getCacheData($pCoord)
{ {
@ -167,7 +167,7 @@ class Wincache extends CacheBase implements ICache
/** /**
* Get a list of all cell addresses currently held in cache. * Get a list of all cell addresses currently held in cache.
* *
* @return string[] * @return string[]
*/ */
public function getCellList() public function getCellList()
{ {
@ -181,9 +181,9 @@ class Wincache extends CacheBase implements ICache
/** /**
* Delete a cell in cache identified by coordinate address. * Delete a cell in cache identified by coordinate address.
* *
* @param string $pCoord Coordinate address of the cell to delete * @param string $pCoord Coordinate address of the cell to delete
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
*/ */
public function deleteCacheData($pCoord) public function deleteCacheData($pCoord)
{ {
@ -197,9 +197,9 @@ class Wincache extends CacheBase implements ICache
/** /**
* Clone the cell collection. * Clone the cell collection.
* *
* @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The new worksheet that we're copying to * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The new worksheet that we're copying to
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
*/ */
public function copyCellCollection(\PhpOffice\PhpSpreadsheet\Worksheet $parent) public function copyCellCollection(\PhpOffice\PhpSpreadsheet\Worksheet $parent)
{ {
@ -248,8 +248,8 @@ class Wincache extends CacheBase implements ICache
/** /**
* Initialise this new cell collection. * Initialise this new cell collection.
* *
* @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The worksheet for this cell collection * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The worksheet for this cell collection
* @param mixed[] $arguments Additional initialisation arguments * @param mixed[] $arguments Additional initialisation arguments
*/ */
public function __construct(\PhpOffice\PhpSpreadsheet\Worksheet $parent, $arguments) public function __construct(\PhpOffice\PhpSpreadsheet\Worksheet $parent, $arguments)
{ {
@ -279,7 +279,7 @@ class Wincache extends CacheBase implements ICache
* Identify whether the caching method is currently available * Identify whether the caching method is currently available
* Some methods are dependent on the availability of certain extensions being enabled in the PHP build. * Some methods are dependent on the availability of certain extensions being enabled in the PHP build.
* *
* @return bool * @return bool
*/ */
public static function cacheMethodIsAvailable() public static function cacheMethodIsAvailable()
{ {

12
src/PhpSpreadsheet/CachedObjectStorageFactory.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -160,8 +160,8 @@ class CachedObjectStorageFactory
/** /**
* Identify the cache storage method to use. * Identify the cache storage method to use.
* *
* @param string $method Name of the method to use for cell cacheing * @param string $method Name of the method to use for cell cacheing
* @param mixed[] $arguments Additional arguments to pass to the cell caching class * @param mixed[] $arguments Additional arguments to pass to the cell caching class
* when instantiating * when instantiating
* *
* @return bool * @return bool
@ -195,9 +195,9 @@ class CachedObjectStorageFactory
/** /**
* Initialise the cache storage. * Initialise the cache storage.
* *
* @param Worksheet $parent Enable cell caching for this worksheet * @param Worksheet $parent Enable cell caching for this worksheet
* *
* @return CachedObjectStorage\ICache * @return CachedObjectStorage\ICache
**/ **/
public static function getInstance(Worksheet $parent) public static function getInstance(Worksheet $parent)
{ {

18
src/PhpSpreadsheet/CalcEngine/CyclicReferenceStack.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\CalcEngine;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -27,16 +27,16 @@ namespace PhpOffice\PhpSpreadsheet\CalcEngine;
class CyclicReferenceStack class CyclicReferenceStack
{ {
/** /**
* The call stack for calculated cells. * The call stack for calculated cells.
* *
* @var mixed[] * @var mixed[]
*/ */
private $stack = []; private $stack = [];
/** /**
* Return the number of entries on the stack. * Return the number of entries on the stack.
* *
* @return int * @return int
*/ */
public function count() public function count()
{ {
@ -46,7 +46,7 @@ class CyclicReferenceStack
/** /**
* Push a new entry onto the stack. * Push a new entry onto the stack.
* *
* @param mixed $value * @param mixed $value
*/ */
public function push($value) public function push($value)
{ {
@ -56,7 +56,7 @@ class CyclicReferenceStack
/** /**
* Pop the last entry from the stack. * Pop the last entry from the stack.
* *
* @return mixed * @return mixed
*/ */
public function pop() public function pop()
{ {
@ -66,7 +66,7 @@ class CyclicReferenceStack
/** /**
* Test to see if a specified entry exists on the stack. * Test to see if a specified entry exists on the stack.
* *
* @param mixed $value The value to test * @param mixed $value The value to test
*/ */
public function onStack($value) public function onStack($value)
{ {
@ -84,7 +84,7 @@ class CyclicReferenceStack
/** /**
* Return an array of all entries on the stack. * Return an array of all entries on the stack.
* *
* @return mixed[] * @return mixed[]
*/ */
public function showStack() public function showStack()
{ {

16
src/PhpSpreadsheet/CalcEngine/Logger.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\CalcEngine;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -62,7 +62,7 @@ class Logger
/** /**
* Instantiate a Calculation engine logger. * Instantiate a Calculation engine logger.
* *
* @param CyclicReferenceStack $stack * @param CyclicReferenceStack $stack
*/ */
public function __construct(CyclicReferenceStack $stack) public function __construct(CyclicReferenceStack $stack)
{ {
@ -72,7 +72,7 @@ class Logger
/** /**
* Enable/Disable Calculation engine logging. * Enable/Disable Calculation engine logging.
* *
* @param bool $pValue * @param bool $pValue
*/ */
public function setWriteDebugLog($pValue = false) public function setWriteDebugLog($pValue = false)
{ {
@ -82,7 +82,7 @@ class Logger
/** /**
* Return whether calculation engine logging is enabled or disabled. * Return whether calculation engine logging is enabled or disabled.
* *
* @return bool * @return bool
*/ */
public function getWriteDebugLog() public function getWriteDebugLog()
{ {
@ -92,7 +92,7 @@ class Logger
/** /**
* Enable/Disable echoing of debug log information. * Enable/Disable echoing of debug log information.
* *
* @param bool $pValue * @param bool $pValue
*/ */
public function setEchoDebugLog($pValue = false) public function setEchoDebugLog($pValue = false)
{ {
@ -102,7 +102,7 @@ class Logger
/** /**
* Return whether echoing of debug log information is enabled or disabled. * Return whether echoing of debug log information is enabled or disabled.
* *
* @return bool * @return bool
*/ */
public function getEchoDebugLog() public function getEchoDebugLog()
{ {
@ -141,7 +141,7 @@ class Logger
/** /**
* Return the calculation engine debug log. * Return the calculation engine debug log.
* *
* @return string[] * @return string[]
*/ */
public function getLog() public function getLog()
{ {

140
src/PhpSpreadsheet/Calculation.php
View File

@ -39,12 +39,12 @@ if (!defined('CALCULATION_REGEXP_CELLREF')) {
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -165,7 +165,7 @@ class Calculation
/** /**
* Current iteration counter for cyclic formulae * Current iteration counter for cyclic formulae
* If the value is 0 (or less) then cyclic formulae will throw an exception, * If the value is 0 (or less) then cyclic formulae will throw an exception,
* otherwise they will iterate to the limit defined here before returning a result. * otherwise they will iterate to the limit defined here before returning a result.
* *
* @var int * @var int
*/ */
@ -2051,7 +2051,7 @@ class Calculation
/** /**
* Get an instance of this class. * Get an instance of this class.
* *
* @param Spreadsheet $spreadsheet Injected spreadsheet for working with a PhpSpreadsheet Spreadsheet object, * @param Spreadsheet $spreadsheet Injected spreadsheet for working with a PhpSpreadsheet Spreadsheet object,
* or NULL to create a standalone claculation engine * or NULL to create a standalone claculation engine
* *
* @return Calculation * @return Calculation
@ -2075,7 +2075,7 @@ class Calculation
/** /**
* Unset an instance of this class. * Unset an instance of this class.
* *
* @param Spreadsheet $spreadsheet Injected spreadsheet identifying the instance to unset * @param Spreadsheet $spreadsheet Injected spreadsheet identifying the instance to unset
*/ */
public function __destruct() public function __destruct()
{ {
@ -2104,7 +2104,7 @@ class Calculation
/** /**
* __clone implementation. Cloning should not be allowed in a Singleton! * __clone implementation. Cloning should not be allowed in a Singleton!
* *
* @throws Calculation\Exception * @throws Calculation\Exception
*/ */
final public function __clone() final public function __clone()
{ {
@ -2114,7 +2114,7 @@ class Calculation
/** /**
* Return the locale-specific translation of TRUE. * Return the locale-specific translation of TRUE.
* *
* @return string locale-specific translation of TRUE * @return string locale-specific translation of TRUE
*/ */
public static function getTRUE() public static function getTRUE()
{ {
@ -2124,7 +2124,7 @@ class Calculation
/** /**
* Return the locale-specific translation of FALSE. * Return the locale-specific translation of FALSE.
* *
* @return string locale-specific translation of FALSE * @return string locale-specific translation of FALSE
*/ */
public static function getFALSE() public static function getFALSE()
{ {
@ -2134,9 +2134,9 @@ class Calculation
/** /**
* Set the Array Return Type (Array or Value of first element in the array). * Set the Array Return Type (Array or Value of first element in the array).
* *
* @param string $returnType Array return type * @param string $returnType Array return type
* *
* @return bool Success or failure * @return bool Success or failure
*/ */
public static function setArrayReturnType($returnType) public static function setArrayReturnType($returnType)
{ {
@ -2154,7 +2154,7 @@ class Calculation
/** /**
* Return the Array Return Type (Array or Value of first element in the array). * Return the Array Return Type (Array or Value of first element in the array).
* *
* @return string $returnType Array return type * @return string $returnType Array return type
*/ */
public static function getArrayReturnType() public static function getArrayReturnType()
{ {
@ -2245,7 +2245,7 @@ class Calculation
/** /**
* Set the locale code. * Set the locale code.
* *
* @param string $locale The locale to use for formula translation * @param string $locale The locale to use for formula translation
* *
* @return bool * @return bool
*/ */
@ -2511,11 +2511,11 @@ class Calculation
* Calculate cell value (using formula from a cell ID) * Calculate cell value (using formula from a cell ID)
* Retained for backward compatibility. * Retained for backward compatibility.
* *
* @param Cell $pCell Cell to calculate * @param Cell $pCell Cell to calculate
* *
* @throws Calculation\Exception * @throws Calculation\Exception
* *
* @return mixed * @return mixed
*/ */
public function calculate(Cell $pCell = null) public function calculate(Cell $pCell = null)
{ {
@ -2529,12 +2529,12 @@ class Calculation
/** /**
* Calculate the value of a cell formula. * Calculate the value of a cell formula.
* *
* @param Cell $pCell Cell to calculate * @param Cell $pCell Cell to calculate
* @param bool $resetLog Flag indicating whether the debug log should be reset or not * @param bool $resetLog Flag indicating whether the debug log should be reset or not
* *
* @throws Calculation\Exception * @throws Calculation\Exception
* *
* @return mixed * @return mixed
*/ */
public function calculateCellValue(Cell $pCell = null, $resetLog = true) public function calculateCellValue(Cell $pCell = null, $resetLog = true)
{ {
@ -2606,11 +2606,11 @@ class Calculation
/** /**
* Validate and parse a formula string. * Validate and parse a formula string.
* *
* @param string $formula Formula to parse * @param string $formula Formula to parse
* *
* @throws Calculation\Exception * @throws Calculation\Exception
* *
* @return array * @return array
*/ */
public function parseFormula($formula) public function parseFormula($formula)
{ {
@ -2632,13 +2632,13 @@ class Calculation
/** /**
* Calculate the value of a formula. * Calculate the value of a formula.
* *
* @param string $formula Formula to parse * @param string $formula Formula to parse
* @param string $cellID Address of the cell to calculate * @param string $cellID Address of the cell to calculate
* @param Cell $pCell Cell to calculate * @param Cell $pCell Cell to calculate
* *
* @throws Calculation\Exception * @throws Calculation\Exception
* *
* @return mixed * @return mixed
*/ */
public function calculateFormula($formula, $cellID = null, Cell $pCell = null) public function calculateFormula($formula, $cellID = null, Cell $pCell = null)
{ {
@ -2702,13 +2702,13 @@ class Calculation
/** /**
* Parse a cell formula and calculate its value. * Parse a cell formula and calculate its value.
* *
* @param string $formula The formula to parse and calculate * @param string $formula The formula to parse and calculate
* @param string $cellID The ID (e.g. A3) of the cell that we are calculating * @param string $cellID The ID (e.g. A3) of the cell that we are calculating
* @param Cell $pCell Cell to calculate * @param Cell $pCell Cell to calculate
* *
* @throws Calculation\Exception * @throws Calculation\Exception
* *
* @return mixed * @return mixed
*/ */
public function _calculateFormulaValue($formula, $cellID = null, Cell $pCell = null) public function _calculateFormulaValue($formula, $cellID = null, Cell $pCell = null)
{ {
@ -2770,9 +2770,9 @@ class Calculation
/** /**
* Ensure that paired matrix operands are both matrices and of the same size. * Ensure that paired matrix operands are both matrices and of the same size.
* *
* @param mixed &$operand1 First matrix operand * @param mixed &$operand1 First matrix operand
* @param mixed &$operand2 Second matrix operand * @param mixed &$operand2 Second matrix operand
* @param int $resize Flag indicating whether the matrices should be resized to match * @param int $resize Flag indicating whether the matrices should be resized to match
* and (if so), whether the smaller dimension should grow or the * and (if so), whether the smaller dimension should grow or the
* larger should shrink. * larger should shrink.
* 0 = no resize * 0 = no resize
@ -2813,9 +2813,9 @@ class Calculation
/** /**
* Read the dimensions of a matrix, and re-index it with straight numeric keys starting from row 0, column 0. * Read the dimensions of a matrix, and re-index it with straight numeric keys starting from row 0, column 0.
* *
* @param mixed &$matrix matrix operand * @param mixed &$matrix matrix operand
* *
* @return int[] An array comprising the number of rows, and number of columns * @return int[] An array comprising the number of rows, and number of columns
*/ */
private static function getMatrixDimensions(&$matrix) private static function getMatrixDimensions(&$matrix)
{ {
@ -2837,12 +2837,12 @@ class Calculation
/** /**
* Ensure that paired matrix operands are both matrices of the same size. * Ensure that paired matrix operands are both matrices of the same size.
* *
* @param mixed &$matrix1 First matrix operand * @param mixed &$matrix1 First matrix operand
* @param mixed &$matrix2 Second matrix operand * @param mixed &$matrix2 Second matrix operand
* @param int $matrix1Rows Row size of first matrix operand * @param int $matrix1Rows Row size of first matrix operand
* @param int $matrix1Columns Column size of first matrix operand * @param int $matrix1Columns Column size of first matrix operand
* @param int $matrix2Rows Row size of second matrix operand * @param int $matrix2Rows Row size of second matrix operand
* @param int $matrix2Columns Column size of second matrix operand * @param int $matrix2Columns Column size of second matrix operand
*/ */
private static function resizeMatricesShrink(&$matrix1, &$matrix2, $matrix1Rows, $matrix1Columns, $matrix2Rows, $matrix2Columns) private static function resizeMatricesShrink(&$matrix1, &$matrix2, $matrix1Rows, $matrix1Columns, $matrix2Rows, $matrix2Columns)
{ {
@ -2880,12 +2880,12 @@ class Calculation
/** /**
* Ensure that paired matrix operands are both matrices of the same size. * Ensure that paired matrix operands are both matrices of the same size.
* *
* @param mixed &$matrix1 First matrix operand * @param mixed &$matrix1 First matrix operand
* @param mixed &$matrix2 Second matrix operand * @param mixed &$matrix2 Second matrix operand
* @param int $matrix1Rows Row size of first matrix operand * @param int $matrix1Rows Row size of first matrix operand
* @param int $matrix1Columns Column size of first matrix operand * @param int $matrix1Columns Column size of first matrix operand
* @param int $matrix2Rows Row size of second matrix operand * @param int $matrix2Rows Row size of second matrix operand
* @param int $matrix2Columns Column size of second matrix operand * @param int $matrix2Columns Column size of second matrix operand
*/ */
private static function resizeMatricesExtend(&$matrix1, &$matrix2, $matrix1Rows, $matrix1Columns, $matrix2Rows, $matrix2Columns) private static function resizeMatricesExtend(&$matrix1, &$matrix2, $matrix1Rows, $matrix1Columns, $matrix2Rows, $matrix2Columns)
{ {
@ -2927,9 +2927,9 @@ class Calculation
/** /**
* Format details of an operand for display in the log (based on operand type). * Format details of an operand for display in the log (based on operand type).
* *
* @param mixed $value First matrix operand * @param mixed $value First matrix operand
* *
* @return mixed * @return mixed
*/ */
private function showValue($value) private function showValue($value)
{ {
@ -2965,9 +2965,9 @@ class Calculation
/** /**
* Format type and details of an operand for display in the log (based on operand type). * Format type and details of an operand for display in the log (based on operand type).
* *
* @param mixed $value First matrix operand * @param mixed $value First matrix operand
* *
* @return string|null * @return string|null
*/ */
private function showTypeDetails($value) private function showTypeDetails($value)
{ {
@ -3949,10 +3949,10 @@ class Calculation
/** /**
* Compare two strings in the same way as strcmp() except that lowercase come before uppercase letters. * Compare two strings in the same way as strcmp() except that lowercase come before uppercase letters.
* *
* @param string $str1 First string value for the comparison * @param string $str1 First string value for the comparison
* @param string $str2 Second string value for the comparison * @param string $str2 Second string value for the comparison
* *
* @return int * @return int
*/ */
private function strcmpLowercaseFirst($str1, $str2) private function strcmpLowercaseFirst($str1, $str2)
{ {
@ -4058,13 +4058,13 @@ class Calculation
/** /**
* Extract range values. * Extract range values.
* *
* @param string &$pRange String based range representation * @param string &$pRange String based range representation
* @param Worksheet $pSheet Worksheet * @param Worksheet $pSheet Worksheet
* @param bool $resetLog Flag indicating whether calculation log should be reset or not * @param bool $resetLog Flag indicating whether calculation log should be reset or not
* *
* @throws Calculation\Exception * @throws Calculation\Exception
* *
* @return mixed Array of values in range if range contains more than one element. Otherwise, a single value is returned. * @return mixed Array of values in range if range contains more than one element. Otherwise, a single value is returned.
*/ */
public function extractCellRange(&$pRange = 'A1', Worksheet $pSheet = null, $resetLog = true) public function extractCellRange(&$pRange = 'A1', Worksheet $pSheet = null, $resetLog = true)
{ {
@ -4109,13 +4109,13 @@ class Calculation
/** /**
* Extract range values. * Extract range values.
* *
* @param string &$pRange String based range representation * @param string &$pRange String based range representation
* @param Worksheet $pSheet Worksheet * @param Worksheet $pSheet Worksheet
* @param bool $resetLog Flag indicating whether calculation log should be reset or not * @param bool $resetLog Flag indicating whether calculation log should be reset or not
* *
* @throws Calculation\Exception * @throws Calculation\Exception
* *
* @return mixed Array of values in range if range contains more than one element. Otherwise, a single value is returned. * @return mixed Array of values in range if range contains more than one element. Otherwise, a single value is returned.
*/ */
public function extractNamedRange(&$pRange = 'A1', Worksheet $pSheet = null, $resetLog = true) public function extractNamedRange(&$pRange = 'A1', Worksheet $pSheet = null, $resetLog = true)
{ {
@ -4175,9 +4175,9 @@ class Calculation
/** /**
* Is a specific function implemented? * Is a specific function implemented?
* *
* @param string $pFunction Function Name * @param string $pFunction Function Name
* *
* @return bool * @return bool
*/ */
public function isImplemented($pFunction) public function isImplemented($pFunction)
{ {
@ -4190,7 +4190,7 @@ class Calculation
/** /**
* Get a list of all implemented functions as an array of function objects. * Get a list of all implemented functions as an array of function objects.
* *
* @return array of Calculation\Category * @return array of Calculation\Category
*/ */
public function getFunctions() public function getFunctions()
{ {
@ -4200,7 +4200,7 @@ class Calculation
/** /**
* Get a list of implemented Excel function names. * Get a list of implemented Excel function names.
* *
* @return array * @return array
*/ */
public function getImplementedFunctionNames() public function getImplementedFunctionNames()
{ {

4
src/PhpSpreadsheet/Calculation/Category.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Calculation;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *

108
src/PhpSpreadsheet/Calculation/Database.php
View File

@ -31,17 +31,17 @@ class Database
* *
* Extracts the column ID to use for the data field. * Extracts the column ID to use for the data field.
* *
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
* first row of the list contains labels for each column. * first row of the list contains labels for each column.
* @param mixed $field Indicates which column is used in the function. Enter the * @param mixed $field Indicates which column is used in the function. Enter the
* column label enclosed between double quotation marks, such as * column label enclosed between double quotation marks, such as
* "Age" or "Yield," or a number (without quotation marks) that * "Age" or "Yield," or a number (without quotation marks) that
* represents the position of the column within the list: 1 for * represents the position of the column within the list: 1 for
* the first column, 2 for the second column, and so on. * the first column, 2 for the second column, and so on.
* *
* @return string|null * @return string|null
*/ */
private static function fieldExtract($database, $field) private static function fieldExtract($database, $field)
{ {
@ -64,17 +64,17 @@ class Database
* Parses the selection criteria, extracts the database rows that match those criteria, and * Parses the selection criteria, extracts the database rows that match those criteria, and
* returns that subset of rows. * returns that subset of rows.
* *
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
* first row of the list contains labels for each column. * first row of the list contains labels for each column.
* @param mixed[] $criteria The range of cells that contains the conditions you specify. * @param mixed[] $criteria The range of cells that contains the conditions you specify.
* You can use any range for the criteria argument, as long as it * You can use any range for the criteria argument, as long as it
* includes at least one column label and at least one cell below * includes at least one column label and at least one cell below
* the column label in which you specify a condition for the * the column label in which you specify a condition for the
* column. * column.
* *
* @return array of mixed * @return array of mixed
*/ */
private static function filter($database, $criteria) private static function filter($database, $criteria)
{ {
@ -154,22 +154,22 @@ class Database
* *
* @category Database Functions * @category Database Functions
* *
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
* first row of the list contains labels for each column. * first row of the list contains labels for each column.
* @param string|int $field Indicates which column is used in the function. Enter the * @param string|int $field Indicates which column is used in the function. Enter the
* column label enclosed between double quotation marks, such as * column label enclosed between double quotation marks, such as
* "Age" or "Yield," or a number (without quotation marks) that * "Age" or "Yield," or a number (without quotation marks) that
* represents the position of the column within the list: 1 for * represents the position of the column within the list: 1 for
* the first column, 2 for the second column, and so on. * the first column, 2 for the second column, and so on.
* @param mixed[] $criteria The range of cells that contains the conditions you specify. * @param mixed[] $criteria The range of cells that contains the conditions you specify.
* You can use any range for the criteria argument, as long as it * You can use any range for the criteria argument, as long as it
* includes at least one column label and at least one cell below * includes at least one column label and at least one cell below
* the column label in which you specify a condition for the * the column label in which you specify a condition for the
* column. * column.
* *
* @return float * @return float
*/ */
public static function DAVERAGE($database, $field, $criteria) public static function DAVERAGE($database, $field, $criteria)
{ {
@ -198,22 +198,22 @@ class Database
* *
* @category Database Functions * @category Database Functions
* *
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
* first row of the list contains labels for each column. * first row of the list contains labels for each column.
* @param string|int $field Indicates which column is used in the function. Enter the * @param string|int $field Indicates which column is used in the function. Enter the
* column label enclosed between double quotation marks, such as * column label enclosed between double quotation marks, such as
* "Age" or "Yield," or a number (without quotation marks) that * "Age" or "Yield," or a number (without quotation marks) that
* represents the position of the column within the list: 1 for * represents the position of the column within the list: 1 for
* the first column, 2 for the second column, and so on. * the first column, 2 for the second column, and so on.
* @param mixed[] $criteria The range of cells that contains the conditions you specify. * @param mixed[] $criteria The range of cells that contains the conditions you specify.
* You can use any range for the criteria argument, as long as it * You can use any range for the criteria argument, as long as it
* includes at least one column label and at least one cell below * includes at least one column label and at least one cell below
* the column label in which you specify a condition for the * the column label in which you specify a condition for the
* column. * column.
* *
* @return int * @return int
* *
* @TODO The field argument is optional. If field is omitted, DCOUNT counts all records in the * @TODO The field argument is optional. If field is omitted, DCOUNT counts all records in the
* database that match the criteria. * database that match the criteria.
@ -241,22 +241,22 @@ class Database
* *
* @category Database Functions * @category Database Functions
* *
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
* first row of the list contains labels for each column. * first row of the list contains labels for each column.
* @param string|int $field Indicates which column is used in the function. Enter the * @param string|int $field Indicates which column is used in the function. Enter the
* column label enclosed between double quotation marks, such as * column label enclosed between double quotation marks, such as
* "Age" or "Yield," or a number (without quotation marks) that * "Age" or "Yield," or a number (without quotation marks) that
* represents the position of the column within the list: 1 for * represents the position of the column within the list: 1 for
* the first column, 2 for the second column, and so on. * the first column, 2 for the second column, and so on.
* @param mixed[] $criteria The range of cells that contains the conditions you specify. * @param mixed[] $criteria The range of cells that contains the conditions you specify.
* You can use any range for the criteria argument, as long as it * You can use any range for the criteria argument, as long as it
* includes at least one column label and at least one cell below * includes at least one column label and at least one cell below
* the column label in which you specify a condition for the * the column label in which you specify a condition for the
* column. * column.
* *
* @return int * @return int
* *
* @TODO The field argument is optional. If field is omitted, DCOUNTA counts all records in the * @TODO The field argument is optional. If field is omitted, DCOUNTA counts all records in the
* database that match the criteria. * database that match the criteria.
@ -293,22 +293,22 @@ class Database
* *
* @category Database Functions * @category Database Functions
* *
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
* first row of the list contains labels for each column. * first row of the list contains labels for each column.
* @param string|int $field Indicates which column is used in the function. Enter the * @param string|int $field Indicates which column is used in the function. Enter the
* column label enclosed between double quotation marks, such as * column label enclosed between double quotation marks, such as
* "Age" or "Yield," or a number (without quotation marks) that * "Age" or "Yield," or a number (without quotation marks) that
* represents the position of the column within the list: 1 for * represents the position of the column within the list: 1 for
* the first column, 2 for the second column, and so on. * the first column, 2 for the second column, and so on.
* @param mixed[] $criteria The range of cells that contains the conditions you specify. * @param mixed[] $criteria The range of cells that contains the conditions you specify.
* You can use any range for the criteria argument, as long as it * You can use any range for the criteria argument, as long as it
* includes at least one column label and at least one cell below * includes at least one column label and at least one cell below
* the column label in which you specify a condition for the * the column label in which you specify a condition for the
* column. * column.
* *
* @return mixed * @return mixed
*/ */
public static function DGET($database, $field, $criteria) public static function DGET($database, $field, $criteria)
{ {
@ -337,22 +337,22 @@ class Database
* *
* @category Database Functions * @category Database Functions
* *
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
* first row of the list contains labels for each column. * first row of the list contains labels for each column.
* @param string|int $field Indicates which column is used in the function. Enter the * @param string|int $field Indicates which column is used in the function. Enter the
* column label enclosed between double quotation marks, such as * column label enclosed between double quotation marks, such as
* "Age" or "Yield," or a number (without quotation marks) that * "Age" or "Yield," or a number (without quotation marks) that
* represents the position of the column within the list: 1 for * represents the position of the column within the list: 1 for
* the first column, 2 for the second column, and so on. * the first column, 2 for the second column, and so on.
* @param mixed[] $criteria The range of cells that contains the conditions you specify. * @param mixed[] $criteria The range of cells that contains the conditions you specify.
* You can use any range for the criteria argument, as long as it * You can use any range for the criteria argument, as long as it
* includes at least one column label and at least one cell below * includes at least one column label and at least one cell below
* the column label in which you specify a condition for the * the column label in which you specify a condition for the
* column. * column.
* *
* @return float * @return float
*/ */
public static function DMAX($database, $field, $criteria) public static function DMAX($database, $field, $criteria)
{ {
@ -378,22 +378,22 @@ class Database
* *
* @category Database Functions * @category Database Functions
* *
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
* first row of the list contains labels for each column. * first row of the list contains labels for each column.
* @param string|int $field Indicates which column is used in the function. Enter the * @param string|int $field Indicates which column is used in the function. Enter the
* column label enclosed between double quotation marks, such as * column label enclosed between double quotation marks, such as
* "Age" or "Yield," or a number (without quotation marks) that * "Age" or "Yield," or a number (without quotation marks) that
* represents the position of the column within the list: 1 for * represents the position of the column within the list: 1 for
* the first column, 2 for the second column, and so on. * the first column, 2 for the second column, and so on.
* @param mixed[] $criteria The range of cells that contains the conditions you specify. * @param mixed[] $criteria The range of cells that contains the conditions you specify.
* You can use any range for the criteria argument, as long as it * You can use any range for the criteria argument, as long as it
* includes at least one column label and at least one cell below * includes at least one column label and at least one cell below
* the column label in which you specify a condition for the * the column label in which you specify a condition for the
* column. * column.
* *
* @return float * @return float
*/ */
public static function DMIN($database, $field, $criteria) public static function DMIN($database, $field, $criteria)
{ {
@ -418,22 +418,22 @@ class Database
* *
* @category Database Functions * @category Database Functions
* *
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
* first row of the list contains labels for each column. * first row of the list contains labels for each column.
* @param string|int $field Indicates which column is used in the function. Enter the * @param string|int $field Indicates which column is used in the function. Enter the
* column label enclosed between double quotation marks, such as * column label enclosed between double quotation marks, such as
* "Age" or "Yield," or a number (without quotation marks) that * "Age" or "Yield," or a number (without quotation marks) that
* represents the position of the column within the list: 1 for * represents the position of the column within the list: 1 for
* the first column, 2 for the second column, and so on. * the first column, 2 for the second column, and so on.
* @param mixed[] $criteria The range of cells that contains the conditions you specify. * @param mixed[] $criteria The range of cells that contains the conditions you specify.
* You can use any range for the criteria argument, as long as it * You can use any range for the criteria argument, as long as it
* includes at least one column label and at least one cell below * includes at least one column label and at least one cell below
* the column label in which you specify a condition for the * the column label in which you specify a condition for the
* column. * column.
* *
* @return float * @return float
*/ */
public static function DPRODUCT($database, $field, $criteria) public static function DPRODUCT($database, $field, $criteria)
{ {
@ -459,22 +459,22 @@ class Database
* *
* @category Database Functions * @category Database Functions
* *
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
* first row of the list contains labels for each column. * first row of the list contains labels for each column.
* @param string|int $field Indicates which column is used in the function. Enter the * @param string|int $field Indicates which column is used in the function. Enter the
* column label enclosed between double quotation marks, such as * column label enclosed between double quotation marks, such as
* "Age" or "Yield," or a number (without quotation marks) that * "Age" or "Yield," or a number (without quotation marks) that
* represents the position of the column within the list: 1 for * represents the position of the column within the list: 1 for
* the first column, 2 for the second column, and so on. * the first column, 2 for the second column, and so on.
* @param mixed[] $criteria The range of cells that contains the conditions you specify. * @param mixed[] $criteria The range of cells that contains the conditions you specify.
* You can use any range for the criteria argument, as long as it * You can use any range for the criteria argument, as long as it
* includes at least one column label and at least one cell below * includes at least one column label and at least one cell below
* the column label in which you specify a condition for the * the column label in which you specify a condition for the
* column. * column.
* *
* @return float * @return float
*/ */
public static function DSTDEV($database, $field, $criteria) public static function DSTDEV($database, $field, $criteria)
{ {
@ -500,22 +500,22 @@ class Database
* *
* @category Database Functions * @category Database Functions
* *
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
* first row of the list contains labels for each column. * first row of the list contains labels for each column.
* @param string|int $field Indicates which column is used in the function. Enter the * @param string|int $field Indicates which column is used in the function. Enter the
* column label enclosed between double quotation marks, such as * column label enclosed between double quotation marks, such as
* "Age" or "Yield," or a number (without quotation marks) that * "Age" or "Yield," or a number (without quotation marks) that
* represents the position of the column within the list: 1 for * represents the position of the column within the list: 1 for
* the first column, 2 for the second column, and so on. * the first column, 2 for the second column, and so on.
* @param mixed[] $criteria The range of cells that contains the conditions you specify. * @param mixed[] $criteria The range of cells that contains the conditions you specify.
* You can use any range for the criteria argument, as long as it * You can use any range for the criteria argument, as long as it
* includes at least one column label and at least one cell below * includes at least one column label and at least one cell below
* the column label in which you specify a condition for the * the column label in which you specify a condition for the
* column. * column.
* *
* @return float * @return float
*/ */
public static function DSTDEVP($database, $field, $criteria) public static function DSTDEVP($database, $field, $criteria)
{ {
@ -540,22 +540,22 @@ class Database
* *
* @category Database Functions * @category Database Functions
* *
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
* first row of the list contains labels for each column. * first row of the list contains labels for each column.
* @param string|int $field Indicates which column is used in the function. Enter the * @param string|int $field Indicates which column is used in the function. Enter the
* column label enclosed between double quotation marks, such as * column label enclosed between double quotation marks, such as
* "Age" or "Yield," or a number (without quotation marks) that * "Age" or "Yield," or a number (without quotation marks) that
* represents the position of the column within the list: 1 for * represents the position of the column within the list: 1 for
* the first column, 2 for the second column, and so on. * the first column, 2 for the second column, and so on.
* @param mixed[] $criteria The range of cells that contains the conditions you specify. * @param mixed[] $criteria The range of cells that contains the conditions you specify.
* You can use any range for the criteria argument, as long as it * You can use any range for the criteria argument, as long as it
* includes at least one column label and at least one cell below * includes at least one column label and at least one cell below
* the column label in which you specify a condition for the * the column label in which you specify a condition for the
* column. * column.
* *
* @return float * @return float
*/ */
public static function DSUM($database, $field, $criteria) public static function DSUM($database, $field, $criteria)
{ {
@ -581,22 +581,22 @@ class Database
* *
* @category Database Functions * @category Database Functions
* *
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
* first row of the list contains labels for each column. * first row of the list contains labels for each column.
* @param string|int $field Indicates which column is used in the function. Enter the * @param string|int $field Indicates which column is used in the function. Enter the
* column label enclosed between double quotation marks, such as * column label enclosed between double quotation marks, such as
* "Age" or "Yield," or a number (without quotation marks) that * "Age" or "Yield," or a number (without quotation marks) that
* represents the position of the column within the list: 1 for * represents the position of the column within the list: 1 for
* the first column, 2 for the second column, and so on. * the first column, 2 for the second column, and so on.
* @param mixed[] $criteria The range of cells that contains the conditions you specify. * @param mixed[] $criteria The range of cells that contains the conditions you specify.
* You can use any range for the criteria argument, as long as it * You can use any range for the criteria argument, as long as it
* includes at least one column label and at least one cell below * includes at least one column label and at least one cell below
* the column label in which you specify a condition for the * the column label in which you specify a condition for the
* column. * column.
* *
* @return float * @return float
*/ */
public static function DVAR($database, $field, $criteria) public static function DVAR($database, $field, $criteria)
{ {
@ -622,22 +622,22 @@ class Database
* *
* @category Database Functions * @category Database Functions
* *
* @param mixed[] $database The range of cells that makes up the list or database. * @param mixed[] $database The range of cells that makes up the list or database.
* A database is a list of related data in which rows of related * A database is a list of related data in which rows of related
* information are records, and columns of data are fields. The * information are records, and columns of data are fields. The
* first row of the list contains labels for each column. * first row of the list contains labels for each column.
* @param string|int $field Indicates which column is used in the function. Enter the * @param string|int $field Indicates which column is used in the function. Enter the
* column label enclosed between double quotation marks, such as * column label enclosed between double quotation marks, such as
* "Age" or "Yield," or a number (without quotation marks) that * "Age" or "Yield," or a number (without quotation marks) that
* represents the position of the column within the list: 1 for * represents the position of the column within the list: 1 for
* the first column, 2 for the second column, and so on. * the first column, 2 for the second column, and so on.
* @param mixed[] $criteria The range of cells that contains the conditions you specify. * @param mixed[] $criteria The range of cells that contains the conditions you specify.
* You can use any range for the criteria argument, as long as it * You can use any range for the criteria argument, as long as it
* includes at least one column label and at least one cell below * includes at least one column label and at least one cell below
* the column label in which you specify a condition for the * the column label in which you specify a condition for the
* column. * column.
* *
* @return float * @return float
*/ */
public static function DVARP($database, $field, $criteria) public static function DVARP($database, $field, $criteria)
{ {

140
src/PhpSpreadsheet/Calculation/DateTime.php
View File

@ -29,9 +29,9 @@ class DateTime
/** /**
* Identify if a year is a leap year or not. * Identify if a year is a leap year or not.
* *
* @param int $year The year to test * @param int $year The year to test
* *
* @return bool TRUE if the year is a leap year, otherwise FALSE * @return bool TRUE if the year is a leap year, otherwise FALSE
*/ */
public static function isLeapYear($year) public static function isLeapYear($year)
{ {
@ -41,15 +41,15 @@ class DateTime
/** /**
* Return the number of days between two dates based on a 360 day calendar. * Return the number of days between two dates based on a 360 day calendar.
* *
* @param int $startDay Day of month of the start date * @param int $startDay Day of month of the start date
* @param int $startMonth Month of the start date * @param int $startMonth Month of the start date
* @param int $startYear Year of the start date * @param int $startYear Year of the start date
* @param int $endDay Day of month of the start date * @param int $endDay Day of month of the start date
* @param int $endMonth Month of the start date * @param int $endMonth Month of the start date
* @param int $endYear Year of the start date * @param int $endYear Year of the start date
* @param bool $methodUS Whether to use the US method or the European method of calculation * @param bool $methodUS Whether to use the US method or the European method of calculation
* *
* @return int Number of days between the start date and the end date * @return int Number of days between the start date and the end date
*/ */
private static function dateDiff360($startDay, $startMonth, $startYear, $endDay, $endMonth, $endYear, $methodUS) private static function dateDiff360($startDay, $startMonth, $startYear, $endDay, $endMonth, $endYear, $methodUS)
{ {
@ -78,9 +78,9 @@ class DateTime
/** /**
* getDateValue. * getDateValue.
* *
* @param string $dateValue * @param string $dateValue
* *
* @return mixed Excel date/time serial value, or string if error * @return mixed Excel date/time serial value, or string if error
*/ */
public static function getDateValue($dateValue) public static function getDateValue($dateValue)
{ {
@ -105,9 +105,9 @@ class DateTime
/** /**
* getTimeValue. * getTimeValue.
* *
* @param string $timeValue * @param string $timeValue
* *
* @return mixed Excel date/time serial value, or string if error * @return mixed Excel date/time serial value, or string if error
*/ */
private static function getTimeValue($timeValue) private static function getTimeValue($timeValue)
{ {
@ -162,7 +162,7 @@ class DateTime
* *
* @category Date/Time Functions * @category Date/Time Functions
* *
* @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object, * @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object,
* depending on the value of the ReturnDateType flag * depending on the value of the ReturnDateType flag
*/ */
public static function DATETIMENOW() public static function DATETIMENOW()
@ -202,7 +202,7 @@ class DateTime
* *
* @category Date/Time Functions * @category Date/Time Functions
* *
* @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object, * @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object,
* depending on the value of the ReturnDateType flag * depending on the value of the ReturnDateType flag
*/ */
public static function DATENOW() public static function DATENOW()
@ -244,7 +244,7 @@ class DateTime
* *
* @category Date/Time Functions * @category Date/Time Functions
* *
* @param int $year The value of the year argument can include one to four digits. * @param int $year The value of the year argument can include one to four digits.
* Excel interprets the year argument according to the configured * Excel interprets the year argument according to the configured
* date system: 1900 or 1904. * date system: 1900 or 1904.
* If year is between 0 (zero) and 1899 (inclusive), Excel adds that * If year is between 0 (zero) and 1899 (inclusive), Excel adds that
@ -255,7 +255,7 @@ class DateTime
* 2008. * 2008.
* If year is less than 0 or is 10000 or greater, Excel returns the * If year is less than 0 or is 10000 or greater, Excel returns the
* #NUM! error value. * #NUM! error value.
* @param int $month A positive or negative integer representing the month of the year * @param int $month A positive or negative integer representing the month of the year
* from 1 to 12 (January to December). * from 1 to 12 (January to December).
* If month is greater than 12, month adds that number of months to * If month is greater than 12, month adds that number of months to
* the first month in the year specified. For example, DATE(2008,14,2) * the first month in the year specified. For example, DATE(2008,14,2)
@ -264,7 +264,7 @@ class DateTime
* number of months, plus 1, from the first month in the year * number of months, plus 1, from the first month in the year
* specified. For example, DATE(2008,-3,2) returns the serial number * specified. For example, DATE(2008,-3,2) returns the serial number
* representing September 2, 2007. * representing September 2, 2007.
* @param int $day A positive or negative integer representing the day of the month * @param int $day A positive or negative integer representing the day of the month
* from 1 to 31. * from 1 to 31.
* If day is greater than the number of days in the month specified, * If day is greater than the number of days in the month specified,
* day adds that number of days to the first day in the month. For * day adds that number of days to the first day in the month. For
@ -275,7 +275,7 @@ class DateTime
* example, DATE(2008,1,-15) returns the serial number representing * example, DATE(2008,1,-15) returns the serial number representing
* December 16, 2007. * December 16, 2007.
* *
* @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object, * @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object,
* depending on the value of the ReturnDateType flag * depending on the value of the ReturnDateType flag
*/ */
public static function DATE($year = 0, $month = 1, $day = 1) public static function DATE($year = 0, $month = 1, $day = 1)
@ -358,19 +358,19 @@ class DateTime
* *
* @category Date/Time Functions * @category Date/Time Functions
* *
* @param int $hour A number from 0 (zero) to 32767 representing the hour. * @param int $hour A number from 0 (zero) to 32767 representing the hour.
* Any value greater than 23 will be divided by 24 and the remainder * Any value greater than 23 will be divided by 24 and the remainder
* will be treated as the hour value. For example, TIME(27,0,0) = * will be treated as the hour value. For example, TIME(27,0,0) =
* TIME(3,0,0) = .125 or 3:00 AM. * TIME(3,0,0) = .125 or 3:00 AM.
* @param int $minute A number from 0 to 32767 representing the minute. * @param int $minute A number from 0 to 32767 representing the minute.
* Any value greater than 59 will be converted to hours and minutes. * Any value greater than 59 will be converted to hours and minutes.
* For example, TIME(0,750,0) = TIME(12,30,0) = .520833 or 12:30 PM. * For example, TIME(0,750,0) = TIME(12,30,0) = .520833 or 12:30 PM.
* @param int $second A number from 0 to 32767 representing the second. * @param int $second A number from 0 to 32767 representing the second.
* Any value greater than 59 will be converted to hours, minutes, * Any value greater than 59 will be converted to hours, minutes,
* and seconds. For example, TIME(0,0,2000) = TIME(0,33,22) = .023148 * and seconds. For example, TIME(0,0,2000) = TIME(0,33,22) = .023148
* or 12:33:20 AM * or 12:33:20 AM
* *
* @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object, * @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object,
* depending on the value of the ReturnDateType flag * depending on the value of the ReturnDateType flag
*/ */
public static function TIME($hour = 0, $minute = 0, $second = 0) public static function TIME($hour = 0, $minute = 0, $second = 0)
@ -471,7 +471,7 @@ class DateTime
* *
* @category Date/Time Functions * @category Date/Time Functions
* *
* @param string $dateValue Text that represents a date in a Microsoft Excel date format. * @param string $dateValue Text that represents a date in a Microsoft Excel date format.
* For example, "1/30/2008" or "30-Jan-2008" are text strings within * For example, "1/30/2008" or "30-Jan-2008" are text strings within
* quotation marks that represent dates. Using the default date * quotation marks that represent dates. Using the default date
* system in Excel for Windows, date_text must represent a date from * system in Excel for Windows, date_text must represent a date from
@ -480,7 +480,7 @@ class DateTime
* from January 1, 1904, to December 31, 9999. DATEVALUE returns the * from January 1, 1904, to December 31, 9999. DATEVALUE returns the
* #VALUE! error value if date_text is out of this range. * #VALUE! error value if date_text is out of this range.
* *
* @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object, * @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object,
* depending on the value of the ReturnDateType flag * depending on the value of the ReturnDateType flag
*/ */
public static function DATEVALUE($dateValue = 1) public static function DATEVALUE($dateValue = 1)
@ -607,12 +607,12 @@ class DateTime
* *
* @category Date/Time Functions * @category Date/Time Functions
* *
* @param string $timeValue A text string that represents a time in any one of the Microsoft * @param string $timeValue A text string that represents a time in any one of the Microsoft
* Excel time formats; for example, "6:45 PM" and "18:45" text strings * Excel time formats; for example, "6:45 PM" and "18:45" text strings
* within quotation marks that represent time. * within quotation marks that represent time.
* Date information in time_text is ignored. * Date information in time_text is ignored.
* *
* @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object, * @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object,
* depending on the value of the ReturnDateType flag * depending on the value of the ReturnDateType flag
*/ */
public static function TIMEVALUE($timeValue) public static function TIMEVALUE($timeValue)
@ -657,13 +657,13 @@ class DateTime
/** /**
* DATEDIF. * DATEDIF.
* *
* @param mixed $startDate Excel date serial value, PHP date/time stamp, PHP DateTime object * @param mixed $startDate Excel date serial value, PHP date/time stamp, PHP DateTime object
* or a standard date string * or a standard date string
* @param mixed $endDate Excel date serial value, PHP date/time stamp, PHP DateTime object * @param mixed $endDate Excel date serial value, PHP date/time stamp, PHP DateTime object
* or a standard date string * or a standard date string
* @param string $unit * @param string $unit
* *
* @return int Interval between the dates * @return int Interval between the dates
*/ */
public static function DATEDIF($startDate = 0, $endDate = 0, $unit = 'D') public static function DATEDIF($startDate = 0, $endDate = 0, $unit = 'D')
{ {
@ -783,11 +783,11 @@ class DateTime
* *
* @category Date/Time Functions * @category Date/Time Functions
* *
* @param mixed $startDate Excel date serial value (float), PHP date timestamp (integer), * @param mixed $startDate Excel date serial value (float), PHP date timestamp (integer),
* PHP DateTime object, or a standard date string * PHP DateTime object, or a standard date string
* @param mixed $endDate Excel date serial value (float), PHP date timestamp (integer), * @param mixed $endDate Excel date serial value (float), PHP date timestamp (integer),
* PHP DateTime object, or a standard date string * PHP DateTime object, or a standard date string
* @param bool $method US or European Method * @param bool $method US or European Method
* FALSE or omitted: U.S. (NASD) method. If the starting date is * FALSE or omitted: U.S. (NASD) method. If the starting date is
* the last day of a month, it becomes equal to the 30th of the * the last day of a month, it becomes equal to the 30th of the
* same month. If the ending date is the last day of a month and * same month. If the ending date is the last day of a month and
@ -799,7 +799,7 @@ class DateTime
* occur on the 31st of a month become equal to the 30th of the * occur on the 31st of a month become equal to the 30th of the
* same month. * same month.
* *
* @return int Number of days between start date and end date * @return int Number of days between start date and end date
*/ */
public static function DAYS360($startDate = 0, $endDate = 0, $method = false) public static function DAYS360($startDate = 0, $endDate = 0, $method = false)
{ {
@ -844,18 +844,18 @@ class DateTime
* *
* @category Date/Time Functions * @category Date/Time Functions
* *
* @param mixed $startDate Excel date serial value (float), PHP date timestamp (integer), * @param mixed $startDate Excel date serial value (float), PHP date timestamp (integer),
* PHP DateTime object, or a standard date string * PHP DateTime object, or a standard date string
* @param mixed $endDate Excel date serial value (float), PHP date timestamp (integer), * @param mixed $endDate Excel date serial value (float), PHP date timestamp (integer),
* PHP DateTime object, or a standard date string * PHP DateTime object, or a standard date string
* @param int $method Method used for the calculation * @param int $method Method used for the calculation
* 0 or omitted US (NASD) 30/360 * 0 or omitted US (NASD) 30/360
* 1 Actual/actual * 1 Actual/actual
* 2 Actual/360 * 2 Actual/360
* 3 Actual/365 * 3 Actual/365
* 4 European 30/360 * 4 European 30/360
* *
* @return float fraction of the year * @return float fraction of the year
*/ */
public static function YEARFRAC($startDate = 0, $endDate = 0, $method = 0) public static function YEARFRAC($startDate = 0, $endDate = 0, $method = 0)
{ {
@ -944,12 +944,12 @@ class DateTime
* *
* @category Date/Time Functions * @category Date/Time Functions
* *
* @param mixed $startDate Excel date serial value (float), PHP date timestamp (integer), * @param mixed $startDate Excel date serial value (float), PHP date timestamp (integer),
* PHP DateTime object, or a standard date string * PHP DateTime object, or a standard date string
* @param mixed $endDate Excel date serial value (float), PHP date timestamp (integer), * @param mixed $endDate Excel date serial value (float), PHP date timestamp (integer),
* PHP DateTime object, or a standard date string * PHP DateTime object, or a standard date string
* *
* @return int Interval between the dates * @return int Interval between the dates
*/ */
public static function NETWORKDAYS($startDate, $endDate) public static function NETWORKDAYS($startDate, $endDate)
{ {
@ -1026,13 +1026,13 @@ class DateTime
* *
* @category Date/Time Functions * @category Date/Time Functions
* *
* @param mixed $startDate Excel date serial value (float), PHP date timestamp (integer), * @param mixed $startDate Excel date serial value (float), PHP date timestamp (integer),
* PHP DateTime object, or a standard date string * PHP DateTime object, or a standard date string
* @param int $endDays The number of nonweekend and nonholiday days before or after * @param int $endDays The number of nonweekend and nonholiday days before or after
* startDate. A positive value for days yields a future date; a * startDate. A positive value for days yields a future date; a
* negative value yields a past date. * negative value yields a past date.
* *
* @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object, * @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object,
* depending on the value of the ReturnDateType flag * depending on the value of the ReturnDateType flag
*/ */
public static function WORKDAY($startDate, $endDays) public static function WORKDAY($startDate, $endDays)
@ -1135,10 +1135,10 @@ class DateTime
* Excel Function: * Excel Function:
* DAY(dateValue) * DAY(dateValue)
* *
* @param mixed $dateValue Excel date serial value (float), PHP date timestamp (integer), * @param mixed $dateValue Excel date serial value (float), PHP date timestamp (integer),
* PHP DateTime object, or a standard date string * PHP DateTime object, or a standard date string
* *
* @return int Day of the month * @return int Day of the month
*/ */
public static function DAYOFMONTH($dateValue = 1) public static function DAYOFMONTH($dateValue = 1)
{ {
@ -1169,14 +1169,14 @@ class DateTime
* Excel Function: * Excel Function:
* WEEKDAY(dateValue[,style]) * WEEKDAY(dateValue[,style])
* *
* @param int $dateValue Excel date serial value (float), PHP date timestamp (integer), * @param int $dateValue Excel date serial value (float), PHP date timestamp (integer),
* PHP DateTime object, or a standard date string * PHP DateTime object, or a standard date string
* @param int $style A number that determines the type of return value * @param int $style A number that determines the type of return value
* 1 or omitted Numbers 1 (Sunday) through 7 (Saturday). * 1 or omitted Numbers 1 (Sunday) through 7 (Saturday).
* 2 Numbers 1 (Monday) through 7 (Sunday). * 2 Numbers 1 (Monday) through 7 (Sunday).
* 3 Numbers 0 (Monday) through 6 (Sunday). * 3 Numbers 0 (Monday) through 6 (Sunday).
* *
* @return int Day of the week value * @return int Day of the week value
*/ */
public static function WEEKDAY($dateValue = 1, $style = 1) public static function WEEKDAY($dateValue = 1, $style = 1)
{ {
@ -1246,13 +1246,13 @@ class DateTime
* Excel Function: * Excel Function:
* WEEKNUM(dateValue[,style]) * WEEKNUM(dateValue[,style])
* *
* @param mixed $dateValue Excel date serial value (float), PHP date timestamp (integer), * @param mixed $dateValue Excel date serial value (float), PHP date timestamp (integer),
* PHP DateTime object, or a standard date string * PHP DateTime object, or a standard date string
* @param int $method Week begins on Sunday or Monday * @param int $method Week begins on Sunday or Monday
* 1 or omitted Week begins on Sunday. * 1 or omitted Week begins on Sunday.
* 2 Week begins on Monday. * 2 Week begins on Monday.
* *
* @return int Week Number * @return int Week Number
*/ */
public static function WEEKNUM($dateValue = 1, $method = 1) public static function WEEKNUM($dateValue = 1, $method = 1)
{ {
@ -1299,10 +1299,10 @@ class DateTime
* Excel Function: * Excel Function:
* MONTH(dateValue) * MONTH(dateValue)
* *
* @param mixed $dateValue Excel date serial value (float), PHP date timestamp (integer), * @param mixed $dateValue Excel date serial value (float), PHP date timestamp (integer),
* PHP DateTime object, or a standard date string * PHP DateTime object, or a standard date string
* *
* @return int Month of the year * @return int Month of the year
*/ */
public static function MONTHOFYEAR($dateValue = 1) public static function MONTHOFYEAR($dateValue = 1)
{ {
@ -1332,10 +1332,10 @@ class DateTime
* Excel Function: * Excel Function:
* YEAR(dateValue) * YEAR(dateValue)
* *
* @param mixed $dateValue Excel date serial value (float), PHP date timestamp (integer), * @param mixed $dateValue Excel date serial value (float), PHP date timestamp (integer),
* PHP DateTime object, or a standard date string * PHP DateTime object, or a standard date string
* *
* @return int Year * @return int Year
*/ */
public static function YEAR($dateValue = 1) public static function YEAR($dateValue = 1)
{ {
@ -1364,10 +1364,10 @@ class DateTime
* Excel Function: * Excel Function:
* HOUR(timeValue) * HOUR(timeValue)
* *
* @param mixed $timeValue Excel date serial value (float), PHP date timestamp (integer), * @param mixed $timeValue Excel date serial value (float), PHP date timestamp (integer),
* PHP DateTime object, or a standard time string * PHP DateTime object, or a standard time string
* *
* @return int Hour * @return int Hour
*/ */
public static function HOUROFDAY($timeValue = 0) public static function HOUROFDAY($timeValue = 0)
{ {
@ -1405,10 +1405,10 @@ class DateTime
* Excel Function: * Excel Function:
* MINUTE(timeValue) * MINUTE(timeValue)
* *
* @param mixed $timeValue Excel date serial value (float), PHP date timestamp (integer), * @param mixed $timeValue Excel date serial value (float), PHP date timestamp (integer),
* PHP DateTime object, or a standard time string * PHP DateTime object, or a standard time string
* *
* @return int Minute * @return int Minute
*/ */
public static function MINUTE($timeValue = 0) public static function MINUTE($timeValue = 0)
{ {
@ -1446,10 +1446,10 @@ class DateTime
* Excel Function: * Excel Function:
* SECOND(timeValue) * SECOND(timeValue)
* *
* @param mixed $timeValue Excel date serial value (float), PHP date timestamp (integer), * @param mixed $timeValue Excel date serial value (float), PHP date timestamp (integer),
* PHP DateTime object, or a standard time string * PHP DateTime object, or a standard time string
* *
* @return int Second * @return int Second
*/ */
public static function SECOND($timeValue = 0) public static function SECOND($timeValue = 0)
{ {
@ -1489,13 +1489,13 @@ class DateTime
* Excel Function: * Excel Function:
* EDATE(dateValue,adjustmentMonths) * EDATE(dateValue,adjustmentMonths)
* *
* @param mixed $dateValue Excel date serial value (float), PHP date timestamp (integer), * @param mixed $dateValue Excel date serial value (float), PHP date timestamp (integer),
* PHP DateTime object, or a standard date string * PHP DateTime object, or a standard date string
* @param int $adjustmentMonths The number of months before or after start_date. * @param int $adjustmentMonths The number of months before or after start_date.
* A positive value for months yields a future date; * A positive value for months yields a future date;
* a negative value yields a past date. * a negative value yields a past date.
* *
* @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object, * @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object,
* depending on the value of the ReturnDateType flag * depending on the value of the ReturnDateType flag
*/ */
public static function EDATE($dateValue = 1, $adjustmentMonths = 0) public static function EDATE($dateValue = 1, $adjustmentMonths = 0)
@ -1535,13 +1535,13 @@ class DateTime
* Excel Function: * Excel Function:
* EOMONTH(dateValue,adjustmentMonths) * EOMONTH(dateValue,adjustmentMonths)
* *
* @param mixed $dateValue Excel date serial value (float), PHP date timestamp (integer), * @param mixed $dateValue Excel date serial value (float), PHP date timestamp (integer),
* PHP DateTime object, or a standard date string * PHP DateTime object, or a standard date string
* @param int $adjustmentMonths The number of months before or after start_date. * @param int $adjustmentMonths The number of months before or after start_date.
* A positive value for months yields a future date; * A positive value for months yields a future date;
* a negative value yields a past date. * a negative value yields a past date.
* *
* @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object, * @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object,
* depending on the value of the ReturnDateType flag * depending on the value of the ReturnDateType flag
*/ */
public static function EOMONTH($dateValue = 1, $adjustmentMonths = 0) public static function EOMONTH($dateValue = 1, $adjustmentMonths = 0)

268
src/PhpSpreadsheet/Calculation/Engineering.php
View File

@ -738,9 +738,9 @@ class Engineering
* *
* Parses a complex number into its real and imaginary parts, and an I or J suffix * Parses a complex number into its real and imaginary parts, and an I or J suffix
* *
* @param string $complexNumber The complex number * @param string $complexNumber The complex number
* *
* @return string[] Indexed on "real", "imaginary" and "suffix" * @return string[] Indexed on "real", "imaginary" and "suffix"
*/ */
public static function parseComplex($complexNumber) public static function parseComplex($complexNumber)
{ {
@ -793,9 +793,9 @@ class Engineering
/** /**
* Cleans the leading characters in a complex number string. * Cleans the leading characters in a complex number string.
* *
* @param string $complexNumber The complex number to clean * @param string $complexNumber The complex number to clean
* *
* @return string The "cleaned" complex number * @return string The "cleaned" complex number
*/ */
private static function cleanComplex($complexNumber) private static function cleanComplex($complexNumber)
{ {
@ -818,10 +818,10 @@ class Engineering
/** /**
* Formats a number base string value with leading zeroes. * Formats a number base string value with leading zeroes.
* *
* @param string $xVal The "number" to pad * @param string $xVal The "number" to pad
* @param int $places The length that we want to pad this value * @param int $places The length that we want to pad this value
* *
* @return string The padded "number" * @return string The padded "number"
*/ */
private static function nbrConversionFormat($xVal, $places) private static function nbrConversionFormat($xVal, $places)
{ {
@ -845,7 +845,7 @@ class Engineering
} }
/** /**
* BESSELI. * BESSELI.
* *
* Returns the modified Bessel function In(x), which is equivalent to the Bessel function evaluated * Returns the modified Bessel function In(x), which is equivalent to the Bessel function evaluated
* for purely imaginary arguments * for purely imaginary arguments
@ -855,14 +855,14 @@ class Engineering
* *
* @category Engineering Functions * @category Engineering Functions
* *
* @param float $x The value at which to evaluate the function. * @param float $x The value at which to evaluate the function.
* If x is nonnumeric, BESSELI returns the #VALUE! error value. * If x is nonnumeric, BESSELI returns the #VALUE! error value.
* @param int $ord The order of the Bessel function. * @param int $ord The order of the Bessel function.
* If ord is not an integer, it is truncated. * If ord is not an integer, it is truncated.
* If $ord is nonnumeric, BESSELI returns the #VALUE! error value. * If $ord is nonnumeric, BESSELI returns the #VALUE! error value.
* If $ord < 0, BESSELI returns the #NUM! error value. * If $ord < 0, BESSELI returns the #NUM! error value.
* *
* @return float * @return float
*/ */
public static function BESSELI($x, $ord) public static function BESSELI($x, $ord)
{ {
@ -901,7 +901,7 @@ class Engineering
} }
/** /**
* BESSELJ. * BESSELJ.
* *
* Returns the Bessel function * Returns the Bessel function
* *
@ -910,13 +910,13 @@ class Engineering
* *
* @category Engineering Functions * @category Engineering Functions
* *
* @param float $x The value at which to evaluate the function. * @param float $x The value at which to evaluate the function.
* If x is nonnumeric, BESSELJ returns the #VALUE! error value. * If x is nonnumeric, BESSELJ returns the #VALUE! error value.
* @param int $ord The order of the Bessel function. If n is not an integer, it is truncated. * @param int $ord The order of the Bessel function. If n is not an integer, it is truncated.
* If $ord is nonnumeric, BESSELJ returns the #VALUE! error value. * If $ord is nonnumeric, BESSELJ returns the #VALUE! error value.
* If $ord < 0, BESSELJ returns the #NUM! error value. * If $ord < 0, BESSELJ returns the #NUM! error value.
* *
* @return float * @return float
*/ */
public static function BESSELJ($x, $ord) public static function BESSELJ($x, $ord)
{ {
@ -993,7 +993,7 @@ class Engineering
} }
/** /**
* BESSELK. * BESSELK.
* *
* Returns the modified Bessel function Kn(x), which is equivalent to the Bessel functions evaluated * Returns the modified Bessel function Kn(x), which is equivalent to the Bessel functions evaluated
* for purely imaginary arguments. * for purely imaginary arguments.
@ -1003,13 +1003,13 @@ class Engineering
* *
* @category Engineering Functions * @category Engineering Functions
* *
* @param float $x The value at which to evaluate the function. * @param float $x The value at which to evaluate the function.
* If x is nonnumeric, BESSELK returns the #VALUE! error value. * If x is nonnumeric, BESSELK returns the #VALUE! error value.
* @param int $ord The order of the Bessel function. If n is not an integer, it is truncated. * @param int $ord The order of the Bessel function. If n is not an integer, it is truncated.
* If $ord is nonnumeric, BESSELK returns the #VALUE! error value. * If $ord is nonnumeric, BESSELK returns the #VALUE! error value.
* If $ord < 0, BESSELK returns the #NUM! error value. * If $ord < 0, BESSELK returns the #NUM! error value.
* *
* @return float * @return float
*/ */
public static function BESSELK($x, $ord) public static function BESSELK($x, $ord)
{ {
@ -1081,22 +1081,22 @@ class Engineering
} }
/** /**
* BESSELY. * BESSELY.
* *
* Returns the Bessel function, which is also called the Weber function or the Neumann function. * Returns the Bessel function, which is also called the Weber function or the Neumann function.
* *
* Excel Function: * Excel Function:
* BESSELY(x,ord) * BESSELY(x,ord)
* *
* @category Engineering Functions * @category Engineering Functions
* *
* @param float $x The value at which to evaluate the function. * @param float $x The value at which to evaluate the function.
* If x is nonnumeric, BESSELK returns the #VALUE! error value. * If x is nonnumeric, BESSELK returns the #VALUE! error value.
* @param int $ord The order of the Bessel function. If n is not an integer, it is truncated. * @param int $ord The order of the Bessel function. If n is not an integer, it is truncated.
* If $ord is nonnumeric, BESSELK returns the #VALUE! error value. * If $ord is nonnumeric, BESSELK returns the #VALUE! error value.
* If $ord < 0, BESSELK returns the #NUM! error value. * If $ord < 0, BESSELK returns the #NUM! error value.
* *
* @return float * @return float
*/ */
public static function BESSELY($x, $ord) public static function BESSELY($x, $ord)
{ {
@ -1142,14 +1142,14 @@ class Engineering
* *
* @category Engineering Functions * @category Engineering Functions
* *
* @param string $x The binary number (as a string) that you want to convert. The number * @param string $x The binary number (as a string) that you want to convert. The number
* cannot contain more than 10 characters (10 bits). The most significant * cannot contain more than 10 characters (10 bits). The most significant
* bit of number is the sign bit. The remaining 9 bits are magnitude bits. * bit of number is the sign bit. The remaining 9 bits are magnitude bits.
* Negative numbers are represented using two's-complement notation. * Negative numbers are represented using two's-complement notation.
* If number is not a valid binary number, or if number contains more than * If number is not a valid binary number, or if number contains more than
* 10 characters (10 bits), BIN2DEC returns the #NUM! error value. * 10 characters (10 bits), BIN2DEC returns the #NUM! error value.
* *
* @return string * @return string
*/ */
public static function BINTODEC($x) public static function BINTODEC($x)
{ {
@ -1191,20 +1191,20 @@ class Engineering
* *
* @category Engineering Functions * @category Engineering Functions
* *
* @param string $x The binary number (as a string) that you want to convert. The number * @param string $x The binary number (as a string) that you want to convert. The number
* cannot contain more than 10 characters (10 bits). The most significant * cannot contain more than 10 characters (10 bits). The most significant
* bit of number is the sign bit. The remaining 9 bits are magnitude bits. * bit of number is the sign bit. The remaining 9 bits are magnitude bits.
* Negative numbers are represented using two's-complement notation. * Negative numbers are represented using two's-complement notation.
* If number is not a valid binary number, or if number contains more than * If number is not a valid binary number, or if number contains more than
* 10 characters (10 bits), BIN2HEX returns the #NUM! error value. * 10 characters (10 bits), BIN2HEX returns the #NUM! error value.
* @param int $places The number of characters to use. If places is omitted, BIN2HEX uses the * @param int $places The number of characters to use. If places is omitted, BIN2HEX uses the
* minimum number of characters necessary. Places is useful for padding the * minimum number of characters necessary. Places is useful for padding the
* return value with leading 0s (zeros). * return value with leading 0s (zeros).
* If places is not an integer, it is truncated. * If places is not an integer, it is truncated.
* If places is nonnumeric, BIN2HEX returns the #VALUE! error value. * If places is nonnumeric, BIN2HEX returns the #VALUE! error value.
* If places is negative, BIN2HEX returns the #NUM! error value. * If places is negative, BIN2HEX returns the #NUM! error value.
* *
* @return string * @return string
*/ */
public static function BINTOHEX($x, $places = null) public static function BINTOHEX($x, $places = null)
{ {
@ -1247,20 +1247,20 @@ class Engineering
* *
* @category Engineering Functions * @category Engineering Functions
* *
* @param string $x The binary number (as a string) that you want to convert. The number * @param string $x The binary number (as a string) that you want to convert. The number
* cannot contain more than 10 characters (10 bits). The most significant * cannot contain more than 10 characters (10 bits). The most significant
* bit of number is the sign bit. The remaining 9 bits are magnitude bits. * bit of number is the sign bit. The remaining 9 bits are magnitude bits.
* Negative numbers are represented using two's-complement notation. * Negative numbers are represented using two's-complement notation.
* If number is not a valid binary number, or if number contains more than * If number is not a valid binary number, or if number contains more than
* 10 characters (10 bits), BIN2OCT returns the #NUM! error value. * 10 characters (10 bits), BIN2OCT returns the #NUM! error value.
* @param int $places The number of characters to use. If places is omitted, BIN2OCT uses the * @param int $places The number of characters to use. If places is omitted, BIN2OCT uses the
* minimum number of characters necessary. Places is useful for padding the * minimum number of characters necessary. Places is useful for padding the
* return value with leading 0s (zeros). * return value with leading 0s (zeros).
* If places is not an integer, it is truncated. * If places is not an integer, it is truncated.
* If places is nonnumeric, BIN2OCT returns the #VALUE! error value. * If places is nonnumeric, BIN2OCT returns the #VALUE! error value.
* If places is negative, BIN2OCT returns the #NUM! error value. * If places is negative, BIN2OCT returns the #NUM! error value.
* *
* @return string * @return string
*/ */
public static function BINTOOCT($x, $places = null) public static function BINTOOCT($x, $places = null)
{ {
@ -1302,7 +1302,7 @@ class Engineering
* *
* @category Engineering Functions * @category Engineering Functions
* *
* @param string $x The decimal integer you want to convert. If number is negative, * @param string $x The decimal integer you want to convert. If number is negative,
* valid place values are ignored and DEC2BIN returns a 10-character * valid place values are ignored and DEC2BIN returns a 10-character
* (10-bit) binary number in which the most significant bit is the sign * (10-bit) binary number in which the most significant bit is the sign
* bit. The remaining 9 bits are magnitude bits. Negative numbers are * bit. The remaining 9 bits are magnitude bits. Negative numbers are
@ -1312,14 +1312,14 @@ class Engineering
* If number is nonnumeric, DEC2BIN returns the #VALUE! error value. * If number is nonnumeric, DEC2BIN returns the #VALUE! error value.
* If DEC2BIN requires more than places characters, it returns the #NUM! * If DEC2BIN requires more than places characters, it returns the #NUM!
* error value. * error value.
* @param int $places The number of characters to use. If places is omitted, DEC2BIN uses * @param int $places The number of characters to use. If places is omitted, DEC2BIN uses
* the minimum number of characters necessary. Places is useful for * the minimum number of characters necessary. Places is useful for
* padding the return value with leading 0s (zeros). * padding the return value with leading 0s (zeros).
* If places is not an integer, it is truncated. * If places is not an integer, it is truncated.
* If places is nonnumeric, DEC2BIN returns the #VALUE! error value. * If places is nonnumeric, DEC2BIN returns the #VALUE! error value.
* If places is zero or negative, DEC2BIN returns the #NUM! error value. * If places is zero or negative, DEC2BIN returns the #NUM! error value.
* *
* @return string * @return string
*/ */
public static function DECTOBIN($x, $places = null) public static function DECTOBIN($x, $places = null)
{ {
@ -1363,7 +1363,7 @@ class Engineering
* *
* @category Engineering Functions * @category Engineering Functions
* *
* @param string $x The decimal integer you want to convert. If number is negative, * @param string $x The decimal integer you want to convert. If number is negative,
* places is ignored and DEC2HEX returns a 10-character (40-bit) * places is ignored and DEC2HEX returns a 10-character (40-bit)
* hexadecimal number in which the most significant bit is the sign * hexadecimal number in which the most significant bit is the sign
* bit. The remaining 39 bits are magnitude bits. Negative numbers * bit. The remaining 39 bits are magnitude bits. Negative numbers
@ -1373,14 +1373,14 @@ class Engineering
* If number is nonnumeric, DEC2HEX returns the #VALUE! error value. * If number is nonnumeric, DEC2HEX returns the #VALUE! error value.
* If DEC2HEX requires more than places characters, it returns the * If DEC2HEX requires more than places characters, it returns the
* #NUM! error value. * #NUM! error value.
* @param int $places The number of characters to use. If places is omitted, DEC2HEX uses * @param int $places The number of characters to use. If places is omitted, DEC2HEX uses
* the minimum number of characters necessary. Places is useful for * the minimum number of characters necessary. Places is useful for
* padding the return value with leading 0s (zeros). * padding the return value with leading 0s (zeros).
* If places is not an integer, it is truncated. * If places is not an integer, it is truncated.
* If places is nonnumeric, DEC2HEX returns the #VALUE! error value. * If places is nonnumeric, DEC2HEX returns the #VALUE! error value.
* If places is zero or negative, DEC2HEX returns the #NUM! error value. * If places is zero or negative, DEC2HEX returns the #NUM! error value.
* *
* @return string * @return string
*/ */
public static function DECTOHEX($x, $places = null) public static function DECTOHEX($x, $places = null)
{ {
@ -1418,7 +1418,7 @@ class Engineering
* *
* @category Engineering Functions * @category Engineering Functions
* *
* @param string $x The decimal integer you want to convert. If number is negative, * @param string $x The decimal integer you want to convert. If number is negative,
* places is ignored and DEC2OCT returns a 10-character (30-bit) * places is ignored and DEC2OCT returns a 10-character (30-bit)
* octal number in which the most significant bit is the sign bit. * octal number in which the most significant bit is the sign bit.
* The remaining 29 bits are magnitude bits. Negative numbers are * The remaining 29 bits are magnitude bits. Negative numbers are
@ -1428,14 +1428,14 @@ class Engineering
* If number is nonnumeric, DEC2OCT returns the #VALUE! error value. * If number is nonnumeric, DEC2OCT returns the #VALUE! error value.
* If DEC2OCT requires more than places characters, it returns the * If DEC2OCT requires more than places characters, it returns the
* #NUM! error value. * #NUM! error value.
* @param int $places The number of characters to use. If places is omitted, DEC2OCT uses * @param int $places The number of characters to use. If places is omitted, DEC2OCT uses
* the minimum number of characters necessary. Places is useful for * the minimum number of characters necessary. Places is useful for
* padding the return value with leading 0s (zeros). * padding the return value with leading 0s (zeros).
* If places is not an integer, it is truncated. * If places is not an integer, it is truncated.
* If places is nonnumeric, DEC2OCT returns the #VALUE! error value. * If places is nonnumeric, DEC2OCT returns the #VALUE! error value.
* If places is zero or negative, DEC2OCT returns the #NUM! error value. * If places is zero or negative, DEC2OCT returns the #NUM! error value.
* *
* @return string * @return string
*/ */
public static function DECTOOCT($x, $places = null) public static function DECTOOCT($x, $places = null)
{ {
@ -1474,7 +1474,7 @@ class Engineering
* *
* @category Engineering Functions * @category Engineering Functions
* *
* @param string $x the hexadecimal number you want to convert. * @param string $x the hexadecimal number you want to convert.
* Number cannot contain more than 10 characters. * Number cannot contain more than 10 characters.
* The most significant bit of number is the sign bit (40th bit from the right). * The most significant bit of number is the sign bit (40th bit from the right).
* The remaining 9 bits are magnitude bits. * The remaining 9 bits are magnitude bits.
@ -1484,14 +1484,14 @@ class Engineering
* and if number is positive, it cannot be greater than 1FF. * and if number is positive, it cannot be greater than 1FF.
* If number is not a valid hexadecimal number, HEX2BIN returns the #NUM! error value. * If number is not a valid hexadecimal number, HEX2BIN returns the #NUM! error value.
* If HEX2BIN requires more than places characters, it returns the #NUM! error value. * If HEX2BIN requires more than places characters, it returns the #NUM! error value.
* @param int $places The number of characters to use. If places is omitted, * @param int $places The number of characters to use. If places is omitted,
* HEX2BIN uses the minimum number of characters necessary. Places * HEX2BIN uses the minimum number of characters necessary. Places
* is useful for padding the return value with leading 0s (zeros). * is useful for padding the return value with leading 0s (zeros).
* If places is not an integer, it is truncated. * If places is not an integer, it is truncated.
* If places is nonnumeric, HEX2BIN returns the #VALUE! error value. * If places is nonnumeric, HEX2BIN returns the #VALUE! error value.
* If places is negative, HEX2BIN returns the #NUM! error value. * If places is negative, HEX2BIN returns the #NUM! error value.
* *
* @return string * @return string
*/ */
public static function HEXTOBIN($x, $places = null) public static function HEXTOBIN($x, $places = null)
{ {
@ -1519,7 +1519,7 @@ class Engineering
* *
* @category Engineering Functions * @category Engineering Functions
* *
* @param string $x The hexadecimal number you want to convert. This number cannot * @param string $x The hexadecimal number you want to convert. This number cannot
* contain more than 10 characters (40 bits). The most significant * contain more than 10 characters (40 bits). The most significant
* bit of number is the sign bit. The remaining 39 bits are magnitude * bit of number is the sign bit. The remaining 39 bits are magnitude
* bits. Negative numbers are represented using two's-complement * bits. Negative numbers are represented using two's-complement
@ -1527,7 +1527,7 @@ class Engineering
* If number is not a valid hexadecimal number, HEX2DEC returns the * If number is not a valid hexadecimal number, HEX2DEC returns the
* #NUM! error value. * #NUM! error value.
* *
* @return string * @return string
*/ */
public static function HEXTODEC($x) public static function HEXTODEC($x)
{ {
@ -1570,7 +1570,7 @@ class Engineering
* *
* @category Engineering Functions * @category Engineering Functions
* *
* @param string $x The hexadecimal number you want to convert. Number cannot * @param string $x The hexadecimal number you want to convert. Number cannot
* contain more than 10 characters. The most significant bit of * contain more than 10 characters. The most significant bit of
* number is the sign bit. The remaining 39 bits are magnitude * number is the sign bit. The remaining 39 bits are magnitude
* bits. Negative numbers are represented using two's-complement * bits. Negative numbers are represented using two's-complement
@ -1583,7 +1583,7 @@ class Engineering
* the #NUM! error value. * the #NUM! error value.
* If HEX2OCT requires more than places characters, it returns * If HEX2OCT requires more than places characters, it returns
* the #NUM! error value. * the #NUM! error value.
* @param int $places The number of characters to use. If places is omitted, HEX2OCT * @param int $places The number of characters to use. If places is omitted, HEX2OCT
* uses the minimum number of characters necessary. Places is * uses the minimum number of characters necessary. Places is
* useful for padding the return value with leading 0s (zeros). * useful for padding the return value with leading 0s (zeros).
* If places is not an integer, it is truncated. * If places is not an integer, it is truncated.
@ -1591,7 +1591,7 @@ class Engineering
* value. * value.
* If places is negative, HEX2OCT returns the #NUM! error value. * If places is negative, HEX2OCT returns the #NUM! error value.
* *
* @return string * @return string
*/ */
public static function HEXTOOCT($x, $places = null) public static function HEXTOOCT($x, $places = null)
{ {
@ -1624,7 +1624,7 @@ class Engineering
* *
* @category Engineering Functions * @category Engineering Functions
* *
* @param string $x The octal number you want to convert. Number may not * @param string $x The octal number you want to convert. Number may not
* contain more than 10 characters. The most significant * contain more than 10 characters. The most significant
* bit of number is the sign bit. The remaining 29 bits * bit of number is the sign bit. The remaining 29 bits
* are magnitude bits. Negative numbers are represented * are magnitude bits. Negative numbers are represented
@ -1637,7 +1637,7 @@ class Engineering
* the #NUM! error value. * the #NUM! error value.
* If OCT2BIN requires more than places characters, it * If OCT2BIN requires more than places characters, it
* returns the #NUM! error value. * returns the #NUM! error value.
* @param int $places The number of characters to use. If places is omitted, * @param int $places The number of characters to use. If places is omitted,
* OCT2BIN uses the minimum number of characters necessary. * OCT2BIN uses the minimum number of characters necessary.
* Places is useful for padding the return value with * Places is useful for padding the return value with
* leading 0s (zeros). * leading 0s (zeros).
@ -1647,7 +1647,7 @@ class Engineering
* If places is negative, OCT2BIN returns the #NUM! error * If places is negative, OCT2BIN returns the #NUM! error
* value. * value.
* *
* @return string * @return string
*/ */
public static function OCTTOBIN($x, $places = null) public static function OCTTOBIN($x, $places = null)
{ {
@ -1675,7 +1675,7 @@ class Engineering
* *
* @category Engineering Functions * @category Engineering Functions
* *
* @param string $x The octal number you want to convert. Number may not contain * @param string $x The octal number you want to convert. Number may not contain
* more than 10 octal characters (30 bits). The most significant * more than 10 octal characters (30 bits). The most significant
* bit of number is the sign bit. The remaining 29 bits are * bit of number is the sign bit. The remaining 29 bits are
* magnitude bits. Negative numbers are represented using * magnitude bits. Negative numbers are represented using
@ -1683,7 +1683,7 @@ class Engineering
* If number is not a valid octal number, OCT2DEC returns the * If number is not a valid octal number, OCT2DEC returns the
* #NUM! error value. * #NUM! error value.
* *
* @return string * @return string
*/ */
public static function OCTTODEC($x) public static function OCTTODEC($x)
{ {
@ -1721,7 +1721,7 @@ class Engineering
* *
* @category Engineering Functions * @category Engineering Functions
* *
* @param string $x The octal number you want to convert. Number may not contain * @param string $x The octal number you want to convert. Number may not contain
* more than 10 octal characters (30 bits). The most significant * more than 10 octal characters (30 bits). The most significant
* bit of number is the sign bit. The remaining 29 bits are * bit of number is the sign bit. The remaining 29 bits are
* magnitude bits. Negative numbers are represented using * magnitude bits. Negative numbers are represented using
@ -1732,14 +1732,14 @@ class Engineering
* #NUM! error value. * #NUM! error value.
* If OCT2HEX requires more than places characters, it returns * If OCT2HEX requires more than places characters, it returns
* the #NUM! error value. * the #NUM! error value.
* @param int $places The number of characters to use. If places is omitted, OCT2HEX * @param int $places The number of characters to use. If places is omitted, OCT2HEX
* uses the minimum number of characters necessary. Places is useful * uses the minimum number of characters necessary. Places is useful
* for padding the return value with leading 0s (zeros). * for padding the return value with leading 0s (zeros).
* If places is not an integer, it is truncated. * If places is not an integer, it is truncated.
* If places is nonnumeric, OCT2HEX returns the #VALUE! error value. * If places is nonnumeric, OCT2HEX returns the #VALUE! error value.
* If places is negative, OCT2HEX returns the #NUM! error value. * If places is negative, OCT2HEX returns the #NUM! error value.
* *
* @return string * @return string
*/ */
public static function OCTTOHEX($x, $places = null) public static function OCTTOHEX($x, $places = null)
{ {
@ -1768,12 +1768,12 @@ class Engineering
* *
* @category Engineering Functions * @category Engineering Functions
* *
* @param float $realNumber the real coefficient of the complex number * @param float $realNumber the real coefficient of the complex number
* @param float $imaginary the imaginary coefficient of the complex number * @param float $imaginary the imaginary coefficient of the complex number
* @param string $suffix The suffix for the imaginary component of the complex number. * @param string $suffix The suffix for the imaginary component of the complex number.
* If omitted, the suffix is assumed to be "i". * If omitted, the suffix is assumed to be "i".
* *
* @return string * @return string
*/ */
public static function COMPLEX($realNumber = 0.0, $imaginary = 0.0, $suffix = 'i') public static function COMPLEX($realNumber = 0.0, $imaginary = 0.0, $suffix = 'i')
{ {
@ -1827,10 +1827,10 @@ class Engineering
* *
* @category Engineering Functions * @category Engineering Functions
* *
* @param string $complexNumber the complex number for which you want the imaginary * @param string $complexNumber the complex number for which you want the imaginary
* coefficient * coefficient
* *
* @return float * @return float
*/ */
public static function IMAGINARY($complexNumber) public static function IMAGINARY($complexNumber)
{ {
@ -1851,9 +1851,9 @@ class Engineering
* *
* @category Engineering Functions * @category Engineering Functions
* *
* @param string $complexNumber the complex number for which you want the real coefficient * @param string $complexNumber the complex number for which you want the real coefficient
* *
* @return float * @return float
*/ */
public static function IMREAL($complexNumber) public static function IMREAL($complexNumber)
{ {
@ -1872,9 +1872,9 @@ class Engineering
* Excel Function: * Excel Function:
* IMABS(complexNumber) * IMABS(complexNumber)
* *
* @param string $complexNumber the complex number for which you want the absolute value * @param string $complexNumber the complex number for which you want the absolute value
* *
* @return float * @return float
*/ */
public static function IMABS($complexNumber) public static function IMABS($complexNumber)
{ {
@ -1897,9 +1897,9 @@ class Engineering
* Excel Function: * Excel Function:
* IMARGUMENT(complexNumber) * IMARGUMENT(complexNumber)
* *
* @param string $complexNumber the complex number for which you want the argument theta * @param string $complexNumber the complex number for which you want the argument theta
* *
* @return float * @return float
*/ */
public static function IMARGUMENT($complexNumber) public static function IMARGUMENT($complexNumber)
{ {
@ -1930,9 +1930,9 @@ class Engineering
* Excel Function: * Excel Function:
* IMCONJUGATE(complexNumber) * IMCONJUGATE(complexNumber)
* *
* @param string $complexNumber the complex number for which you want the conjugate * @param string $complexNumber the complex number for which you want the conjugate
* *
* @return string * @return string
*/ */
public static function IMCONJUGATE($complexNumber) public static function IMCONJUGATE($complexNumber)
{ {
@ -1961,9 +1961,9 @@ class Engineering
* Excel Function: * Excel Function:
* IMCOS(complexNumber) * IMCOS(complexNumber)
* *
* @param string $complexNumber the complex number for which you want the cosine * @param string $complexNumber the complex number for which you want the cosine
* *
* @return string|float * @return string|float
*/ */
public static function IMCOS($complexNumber) public static function IMCOS($complexNumber)
{ {
@ -1992,9 +1992,9 @@ class Engineering
* Excel Function: * Excel Function:
* IMSIN(complexNumber) * IMSIN(complexNumber)
* *
* @param string $complexNumber the complex number for which you want the sine * @param string $complexNumber the complex number for which you want the sine
* *
* @return string|float * @return string|float
*/ */
public static function IMSIN($complexNumber) public static function IMSIN($complexNumber)
{ {
@ -2021,9 +2021,9 @@ class Engineering
* Excel Function: * Excel Function:
* IMSQRT(complexNumber) * IMSQRT(complexNumber)
* *
* @param string $complexNumber the complex number for which you want the square root * @param string $complexNumber the complex number for which you want the square root
* *
* @return string * @return string
*/ */
public static function IMSQRT($complexNumber) public static function IMSQRT($complexNumber)
{ {
@ -2055,9 +2055,9 @@ class Engineering
* Excel Function: * Excel Function:
* IMLN(complexNumber) * IMLN(complexNumber)
* *
* @param string $complexNumber the complex number for which you want the natural logarithm * @param string $complexNumber the complex number for which you want the natural logarithm
* *
* @return string * @return string
*/ */
public static function IMLN($complexNumber) public static function IMLN($complexNumber)
{ {
@ -2087,9 +2087,9 @@ class Engineering
* Excel Function: * Excel Function:
* IMLOG10(complexNumber) * IMLOG10(complexNumber)
* *
* @param string $complexNumber the complex number for which you want the common logarithm * @param string $complexNumber the complex number for which you want the common logarithm
* *
* @return string * @return string
*/ */
public static function IMLOG10($complexNumber) public static function IMLOG10($complexNumber)
{ {
@ -2114,9 +2114,9 @@ class Engineering
* Excel Function: * Excel Function:
* IMLOG2(complexNumber) * IMLOG2(complexNumber)
* *
* @param string $complexNumber the complex number for which you want the base-2 logarithm * @param string $complexNumber the complex number for which you want the base-2 logarithm
* *
* @return string * @return string
*/ */
public static function IMLOG2($complexNumber) public static function IMLOG2($complexNumber)
{ {
@ -2141,9 +2141,9 @@ class Engineering
* Excel Function: * Excel Function:
* IMEXP(complexNumber) * IMEXP(complexNumber)
* *
* @param string $complexNumber the complex number for which you want the exponential * @param string $complexNumber the complex number for which you want the exponential
* *
* @return string * @return string
*/ */
public static function IMEXP($complexNumber) public static function IMEXP($complexNumber)
{ {
@ -2174,10 +2174,10 @@ class Engineering
* Excel Function: * Excel Function:
* IMPOWER(complexNumber,realNumber) * IMPOWER(complexNumber,realNumber)
* *
* @param string $complexNumber the complex number you want to raise to a power * @param string $complexNumber the complex number you want to raise to a power
* @param float $realNumber the power to which you want to raise the complex number * @param float $realNumber the power to which you want to raise the complex number
* *
* @return string * @return string
*/ */
public static function IMPOWER($complexNumber, $realNumber) public static function IMPOWER($complexNumber, $realNumber)
{ {
@ -2210,10 +2210,10 @@ class Engineering
* Excel Function: * Excel Function:
* IMDIV(complexDividend,complexDivisor) * IMDIV(complexDividend,complexDivisor)
* *
* @param string $complexDividend the complex numerator or dividend * @param string $complexDividend the complex numerator or dividend
* @param string $complexDivisor the complex denominator or divisor * @param string $complexDivisor the complex denominator or divisor
* *
* @return string * @return string
*/ */
public static function IMDIV($complexDividend, $complexDivisor) public static function IMDIV($complexDividend, $complexDivisor)
{ {
@ -2256,10 +2256,10 @@ class Engineering
* Excel Function: * Excel Function:
* IMSUB(complexNumber1,complexNumber2) * IMSUB(complexNumber1,complexNumber2)
* *
* @param string $complexNumber1 the complex number from which to subtract complexNumber2 * @param string $complexNumber1 the complex number from which to subtract complexNumber2
* @param string $complexNumber2 the complex number to subtract from complexNumber1 * @param string $complexNumber2 the complex number to subtract from complexNumber1
* *
* @return string * @return string
*/ */
public static function IMSUB($complexNumber1, $complexNumber2) public static function IMSUB($complexNumber1, $complexNumber2)
{ {
@ -2291,9 +2291,9 @@ class Engineering
* Excel Function: * Excel Function:
* IMSUM(complexNumber[,complexNumber[,...]]) * IMSUM(complexNumber[,complexNumber[,...]])
* *
* @param string $complexNumber,... Series of complex numbers to add * @param string $complexNumber,... Series of complex numbers to add
* *
* @return string * @return string
*/ */
public static function IMSUM() public static function IMSUM()
{ {
@ -2331,9 +2331,9 @@ class Engineering
* Excel Function: * Excel Function:
* IMPRODUCT(complexNumber[,complexNumber[,...]]) * IMPRODUCT(complexNumber[,complexNumber[,...]])
* *
* @param string $complexNumber,... Series of complex numbers to multiply * @param string $complexNumber,... Series of complex numbers to multiply
* *
* @return string * @return string
*/ */
public static function IMPRODUCT() public static function IMPRODUCT()
{ {
@ -2364,20 +2364,20 @@ class Engineering
} }
/** /**
* DELTA. * DELTA.
* *
* Tests whether two values are equal. Returns 1 if number1 = number2; returns 0 otherwise. * Tests whether two values are equal. Returns 1 if number1 = number2; returns 0 otherwise.
* Use this function to filter a set of values. For example, by summing several DELTA * Use this function to filter a set of values. For example, by summing several DELTA
* functions you calculate the count of equal pairs. This function is also known as the * functions you calculate the count of equal pairs. This function is also known as the
* Kronecker Delta function. * Kronecker Delta function.
* *
* Excel Function: * Excel Function:
* DELTA(a[,b]) * DELTA(a[,b])
* *
* @param float $a the first number * @param float $a the first number
* @param float $b The second number. If omitted, b is assumed to be zero. * @param float $b The second number. If omitted, b is assumed to be zero.
* *
* @return int * @return int
*/ */
public static function DELTA($a, $b = 0) public static function DELTA($a, $b = 0)
{ {
@ -2388,20 +2388,20 @@ class Engineering
} }
/** /**
* GESTEP. * GESTEP.
* *
* Excel Function: * Excel Function:
* GESTEP(number[,step]) * GESTEP(number[,step])
* *
* Returns 1 if number >= step; returns 0 (zero) otherwise * Returns 1 if number >= step; returns 0 (zero) otherwise
* Use this function to filter a set of values. For example, by summing several GESTEP * Use this function to filter a set of values. For example, by summing several GESTEP
* functions you calculate the count of values that exceed a threshold. * functions you calculate the count of values that exceed a threshold.
* *
* @param float $number the value to test against step * @param float $number the value to test against step
* @param float $step The threshold value. * @param float $step The threshold value.
* If you omit a value for step, GESTEP uses zero. * If you omit a value for step, GESTEP uses zero.
* *
* @return int * @return int
*/ */
public static function GESTEP($number, $step = 0) public static function GESTEP($number, $step = 0)
{ {
@ -2440,9 +2440,9 @@ class Engineering
} }
/** /**
* ERF. * ERF.
* *
* Returns the error function integrated between the lower and upper bound arguments. * Returns the error function integrated between the lower and upper bound arguments.
* *
* Note: In Excel 2007 or earlier, if you input a negative value for the upper or lower bound arguments, * Note: In Excel 2007 or earlier, if you input a negative value for the upper or lower bound arguments,
* the function would return a #NUM! error. However, in Excel 2010, the function algorithm was * the function would return a #NUM! error. However, in Excel 2010, the function algorithm was
@ -2452,11 +2452,11 @@ class Engineering
* Excel Function: * Excel Function:
* ERF(lower[,upper]) * ERF(lower[,upper])
* *
* @param float $lower lower bound for integrating ERF * @param float $lower lower bound for integrating ERF
* @param float $upper upper bound for integrating ERF. * @param float $upper upper bound for integrating ERF.
* If omitted, ERF integrates between zero and lower_limit * If omitted, ERF integrates between zero and lower_limit
* *
* @return float * @return float
*/ */
public static function ERF($lower, $upper = null) public static function ERF($lower, $upper = null)
{ {
@ -2509,7 +2509,7 @@ class Engineering
} }
/** /**
* ERFC. * ERFC.
* *
* Returns the complementary ERF function integrated between x and infinity * Returns the complementary ERF function integrated between x and infinity
* *
@ -2521,9 +2521,9 @@ class Engineering
* Excel Function: * Excel Function:
* ERFC(x) * ERFC(x)
* *
* @param float $x The lower bound for integrating ERFC * @param float $x The lower bound for integrating ERFC
* *
* @return float * @return float
*/ */
public static function ERFC($x) public static function ERFC($x)
{ {
@ -2538,9 +2538,9 @@ class Engineering
/** /**
* getConversionGroups * getConversionGroups
* Returns a list of the different conversion groups for UOM conversions. * Returns a list of the different conversion groups for UOM conversions.
* *
* @return array * @return array
*/ */
public static function getConversionGroups() public static function getConversionGroups()
{ {
@ -2554,11 +2554,11 @@ class Engineering
/** /**
* getConversionGroupUnits * getConversionGroupUnits
* Returns an array of units of measure, for a specified conversion group, or for all groups. * Returns an array of units of measure, for a specified conversion group, or for all groups.
* *
* @param string $group The group whose units of measure you want to retrieve * @param string $group The group whose units of measure you want to retrieve
* *
* @return array * @return array
*/ */
public static function getConversionGroupUnits($group = null) public static function getConversionGroupUnits($group = null)
{ {
@ -2573,11 +2573,11 @@ class Engineering
} }
/** /**
* getConversionGroupUnitDetails. * getConversionGroupUnitDetails.
* *
* @param string $group The group whose units of measure you want to retrieve * @param string $group The group whose units of measure you want to retrieve
* *
* @return array * @return array
*/ */
public static function getConversionGroupUnitDetails($group = null) public static function getConversionGroupUnitDetails($group = null)
{ {
@ -2596,9 +2596,9 @@ class Engineering
/** /**
* getConversionMultipliers * getConversionMultipliers
* Returns an array of the Multiplier prefixes that can be used with Units of Measure in CONVERTUOM(). * Returns an array of the Multiplier prefixes that can be used with Units of Measure in CONVERTUOM().
* *
* @return array of mixed * @return array of mixed
*/ */
public static function getConversionMultipliers() public static function getConversionMultipliers()
{ {
@ -2606,20 +2606,20 @@ class Engineering
} }
/** /**
* CONVERTUOM. * CONVERTUOM.
* *
* Converts a number from one measurement system to another. * Converts a number from one measurement system to another.
* For example, CONVERT can translate a table of distances in miles to a table of distances * For example, CONVERT can translate a table of distances in miles to a table of distances
* in kilometers. * in kilometers.
* *
* Excel Function: * Excel Function:
* CONVERT(value,fromUOM,toUOM) * CONVERT(value,fromUOM,toUOM)
* *
* @param float $value the value in fromUOM to convert * @param float $value the value in fromUOM to convert
* @param string $fromUOM the units for value * @param string $fromUOM the units for value
* @param string $toUOM the units for the result * @param string $toUOM the units for the result
* *
* @return float * @return float
*/ */
public static function CONVERTUOM($value, $fromUOM, $toUOM) public static function CONVERTUOM($value, $fromUOM, $toUOM)
{ {

4
src/PhpSpreadsheet/Calculation/Exception.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Calculation;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *

4
src/PhpSpreadsheet/Calculation/ExceptionHandler.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Calculation;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *

460
src/PhpSpreadsheet/Calculation/Financial.php
View File

File diff suppressed because it is too large Load Diff

14
src/PhpSpreadsheet/Calculation/FormulaParser.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Calculation;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -83,9 +83,9 @@ class FormulaParser
/** /**
* Create a new FormulaParser. * Create a new FormulaParser.
* *
* @param string $pFormula Formula to parse * @param string $pFormula Formula to parse
* *
* @throws Exception * @throws Exception
*/ */
public function __construct($pFormula = '') public function __construct($pFormula = '')
{ {
@ -113,11 +113,11 @@ class FormulaParser
/** /**
* Get Token. * Get Token.
* *
* @param int $pId Token id * @param int $pId Token id
* *
* @throws Exception * @throws Exception
* *
* @return string * @return string
*/ */
public function getToken($pId = 0) public function getToken($pId = 0)
{ {

16
src/PhpSpreadsheet/Calculation/FormulaToken.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Calculation;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -99,9 +99,9 @@ class FormulaToken
/** /**
* Create a new FormulaToken. * Create a new FormulaToken.
* *
* @param string $pValue * @param string $pValue
* @param string $pTokenType Token type (represented by TOKEN_TYPE_*) * @param string $pTokenType Token type (represented by TOKEN_TYPE_*)
* @param string $pTokenSubType Token Subtype (represented by TOKEN_SUBTYPE_*) * @param string $pTokenSubType Token Subtype (represented by TOKEN_SUBTYPE_*)
*/ */
public function __construct($pValue, $pTokenType = self::TOKEN_TYPE_UNKNOWN, $pTokenSubType = self::TOKEN_SUBTYPE_NOTHING) public function __construct($pValue, $pTokenType = self::TOKEN_TYPE_UNKNOWN, $pTokenSubType = self::TOKEN_SUBTYPE_NOTHING)
{ {
@ -124,7 +124,7 @@ class FormulaToken
/** /**
* Set Value. * Set Value.
* *
* @param string $value * @param string $value
*/ */
public function setValue($value) public function setValue($value)
{ {
@ -144,7 +144,7 @@ class FormulaToken
/** /**
* Set Token Type. * Set Token Type.
* *
* @param string $value * @param string $value
*/ */
public function setTokenType($value = self::TOKEN_TYPE_UNKNOWN) public function setTokenType($value = self::TOKEN_TYPE_UNKNOWN)
{ {
@ -164,7 +164,7 @@ class FormulaToken
/** /**
* Set Token SubType. * Set Token SubType.
* *
* @param string $value * @param string $value
*/ */
public function setTokenSubType($value = self::TOKEN_SUBTYPE_NOTHING) public function setTokenSubType($value = self::TOKEN_SUBTYPE_NOTHING)
{ {

92
src/PhpSpreadsheet/Calculation/Functions.php
View File

@ -82,13 +82,13 @@ class Functions
* *
* @category Function Configuration * @category Function Configuration
* *
* @param string $compatibilityMode Compatibility Mode * @param string $compatibilityMode Compatibility Mode
* Permitted values are: * Permitted values are:
* Functions::COMPATIBILITY_EXCEL 'Excel' * Functions::COMPATIBILITY_EXCEL 'Excel'
* Functions::COMPATIBILITY_GNUMERIC 'Gnumeric' * Functions::COMPATIBILITY_GNUMERIC 'Gnumeric'
* Functions::COMPATIBILITY_OPENOFFICE 'OpenOfficeCalc' * Functions::COMPATIBILITY_OPENOFFICE 'OpenOfficeCalc'
* *
* @return bool (Success or Failure) * @return bool (Success or Failure)
*/ */
public static function setCompatibilityMode($compatibilityMode) public static function setCompatibilityMode($compatibilityMode)
{ {
@ -109,7 +109,7 @@ class Functions
* *
* @category Function Configuration * @category Function Configuration
* *
* @return string Compatibility Mode * @return string Compatibility Mode
* Possible Return values are: * Possible Return values are:
* Functions::COMPATIBILITY_EXCEL 'Excel' * Functions::COMPATIBILITY_EXCEL 'Excel'
* Functions::COMPATIBILITY_GNUMERIC 'Gnumeric' * Functions::COMPATIBILITY_GNUMERIC 'Gnumeric'
@ -125,13 +125,13 @@ class Functions
* *
* @category Function Configuration * @category Function Configuration
* *
* @param string $returnDateType Return Date Format * @param string $returnDateType Return Date Format
* Permitted values are: * Permitted values are:
* Functions::RETURNDATE_PHP_NUMERIC 'P' * Functions::RETURNDATE_PHP_NUMERIC 'P'
* Functions::RETURNDATE_PHP_OBJECT 'O' * Functions::RETURNDATE_PHP_OBJECT 'O'
* Functions::RETURNDATE_EXCEL 'E' * Functions::RETURNDATE_EXCEL 'E'
* *
* @return bool Success or failure * @return bool Success or failure
*/ */
public static function setReturnDateType($returnDateType) public static function setReturnDateType($returnDateType)
{ {
@ -152,7 +152,7 @@ class Functions
* *
* @category Function Configuration * @category Function Configuration
* *
* @return string Return Date Format * @return string Return Date Format
* Possible Return values are: * Possible Return values are:
* Functions::RETURNDATE_PHP_NUMERIC 'P' * Functions::RETURNDATE_PHP_NUMERIC 'P'
* Functions::RETURNDATE_PHP_OBJECT 'O' * Functions::RETURNDATE_PHP_OBJECT 'O'
@ -168,7 +168,7 @@ class Functions
* *
* @category Error Returns * @category Error Returns
* *
* @return string #Not Yet Implemented * @return string #Not Yet Implemented
*/ */
public static function DUMMY() public static function DUMMY()
{ {
@ -180,7 +180,7 @@ class Functions
* *
* @category Error Returns * @category Error Returns
* *
* @return string #Not Yet Implemented * @return string #Not Yet Implemented
*/ */
public static function DIV0() public static function DIV0()
{ {
@ -198,7 +198,7 @@ class Functions
* *
* @category Logical Functions * @category Logical Functions
* *
* @return string #N/A! * @return string #N/A!
*/ */
public static function NA() public static function NA()
{ {
@ -212,7 +212,7 @@ class Functions
* *
* @category Error Returns * @category Error Returns
* *
* @return string #NUM! * @return string #NUM!
*/ */
public static function NAN() public static function NAN()
{ {
@ -226,7 +226,7 @@ class Functions
* *
* @category Error Returns * @category Error Returns
* *
* @return string #NAME? * @return string #NAME?
*/ */
public static function NAME() public static function NAME()
{ {
@ -240,7 +240,7 @@ class Functions
* *
* @category Error Returns * @category Error Returns
* *
* @return string #REF! * @return string #REF!
*/ */
public static function REF() public static function REF()
{ {
@ -254,7 +254,7 @@ class Functions
* *
* @category Error Returns * @category Error Returns
* *
* @return string #NULL! * @return string #NULL!
*/ */
public static function null() public static function null()
{ {
@ -268,7 +268,7 @@ class Functions
* *
* @category Error Returns * @category Error Returns
* *
* @return string #VALUE! * @return string #VALUE!
*/ */
public static function VALUE() public static function VALUE()
{ {
@ -317,9 +317,9 @@ class Functions
/** /**
* ERROR_TYPE. * ERROR_TYPE.
* *
* @param mixed $value Value to check * @param mixed $value Value to check
* *
* @return bool * @return bool
*/ */
public static function errorType($value = '') public static function errorType($value = '')
{ {
@ -339,9 +339,9 @@ class Functions
/** /**
* IS_BLANK. * IS_BLANK.
* *
* @param mixed $value Value to check * @param mixed $value Value to check
* *
* @return bool * @return bool
*/ */
public static function isBlank($value = null) public static function isBlank($value = null)
{ {
@ -355,9 +355,9 @@ class Functions
/** /**
* IS_ERR. * IS_ERR.
* *
* @param mixed $value Value to check * @param mixed $value Value to check
* *
* @return bool * @return bool
*/ */
public static function isErr($value = '') public static function isErr($value = '')
{ {
@ -369,9 +369,9 @@ class Functions
/** /**
* IS_ERROR. * IS_ERROR.
* *
* @param mixed $value Value to check * @param mixed $value Value to check
* *
* @return bool * @return bool
*/ */
public static function isError($value = '') public static function isError($value = '')
{ {
@ -387,9 +387,9 @@ class Functions
/** /**
* IS_NA. * IS_NA.
* *
* @param mixed $value Value to check * @param mixed $value Value to check
* *
* @return bool * @return bool
*/ */
public static function isNa($value = '') public static function isNa($value = '')
{ {
@ -401,9 +401,9 @@ class Functions
/** /**
* IS_EVEN. * IS_EVEN.
* *
* @param mixed $value Value to check * @param mixed $value Value to check
* *
* @return string|bool * @return string|bool
*/ */
public static function isEven($value = null) public static function isEven($value = null)
{ {
@ -421,9 +421,9 @@ class Functions
/** /**
* IS_ODD. * IS_ODD.
* *
* @param mixed $value Value to check * @param mixed $value Value to check
* *
* @return string|bool * @return string|bool
*/ */
public static function isOdd($value = null) public static function isOdd($value = null)
{ {
@ -441,9 +441,9 @@ class Functions
/** /**
* IS_NUMBER. * IS_NUMBER.
* *
* @param mixed $value Value to check * @param mixed $value Value to check
* *
* @return bool * @return bool
*/ */
public static function isNumber($value = null) public static function isNumber($value = null)
{ {
@ -459,9 +459,9 @@ class Functions
/** /**
* IS_LOGICAL. * IS_LOGICAL.
* *
* @param mixed $value Value to check * @param mixed $value Value to check
* *
* @return bool * @return bool
*/ */
public static function isLogical($value = null) public static function isLogical($value = null)
{ {
@ -473,9 +473,9 @@ class Functions
/** /**
* IS_TEXT. * IS_TEXT.
* *
* @param mixed $value Value to check * @param mixed $value Value to check
* *
* @return bool * @return bool
*/ */
public static function isText($value = null) public static function isText($value = null)
{ {
@ -487,9 +487,9 @@ class Functions
/** /**
* IS_NONTEXT. * IS_NONTEXT.
* *
* @param mixed $value Value to check * @param mixed $value Value to check
* *
* @return bool * @return bool
*/ */
public static function isNonText($value = null) public static function isNonText($value = null)
{ {
@ -501,10 +501,10 @@ class Functions
* *
* Returns a value converted to a number * Returns a value converted to a number
* *
* @param value The value you want converted * @param value The value you want converted
* @param null|mixed $value * @param null|mixed $value
* *
* @return number N converts values listed in the following table * @return number N converts values listed in the following table
* If value is or refers to N returns * If value is or refers to N returns
* A number That number * A number That number
* A date The serial number of that date * A date The serial number of that date
@ -542,10 +542,10 @@ class Functions
* *
* Returns a number that identifies the type of a value * Returns a number that identifies the type of a value
* *
* @param value The value you want tested * @param value The value you want tested
* @param null|mixed $value * @param null|mixed $value
* *
* @return number N converts values listed in the following table * @return number N converts values listed in the following table
* If value is or refers to N returns * If value is or refers to N returns
* A number 1 * A number 1
* Text 2 * Text 2
@ -593,9 +593,9 @@ class Functions
/** /**
* Convert a multi-dimensional array to a simple 1-dimensional array. * Convert a multi-dimensional array to a simple 1-dimensional array.
* *
* @param array $array Array to be flattened * @param array $array Array to be flattened
* *
* @return array Flattened array * @return array Flattened array
*/ */
public static function flattenArray($array) public static function flattenArray($array)
{ {
@ -626,9 +626,9 @@ class Functions
/** /**
* Convert a multi-dimensional array to a simple 1-dimensional array, but retain an element of indexing. * Convert a multi-dimensional array to a simple 1-dimensional array, but retain an element of indexing.
* *
* @param array $array Array to be flattened * @param array $array Array to be flattened
* *
* @return array Flattened array * @return array Flattened array
*/ */
public static function flattenArrayIndexed($array) public static function flattenArrayIndexed($array)
{ {
@ -659,9 +659,9 @@ class Functions
/** /**
* Convert an array to a single scalar value by extracting the first element. * Convert an array to a single scalar value by extracting the first element.
* *
* @param mixed $value Array or scalar value * @param mixed $value Array or scalar value
* *
* @return mixed * @return mixed
*/ */
public static function flattenSingleValue($value = '') public static function flattenSingleValue($value = '')
{ {

30
src/PhpSpreadsheet/Calculation/Logical.php
View File

@ -36,7 +36,7 @@ class Logical
* *
* @category Logical Functions * @category Logical Functions
* *
* @return bool True * @return bool True
*/ */
public static function true() public static function true()
{ {
@ -53,7 +53,7 @@ class Logical
* *
* @category Logical Functions * @category Logical Functions
* *
* @return bool False * @return bool False
*/ */
public static function false() public static function false()
{ {
@ -78,9 +78,9 @@ class Logical
* *
* @category Logical Functions * @category Logical Functions
* *
* @param mixed $arg,... Data values * @param mixed $arg,... Data values
* *
* @return string|bool the logical AND of the arguments * @return string|bool the logical AND of the arguments
*/ */
public static function logicalAnd() public static function logicalAnd()
{ {
@ -135,9 +135,9 @@ class Logical
* *
* @category Logical Functions * @category Logical Functions
* *
* @param mixed $arg,... Data values * @param mixed $arg,... Data values
* *
* @return string|bool the logical OR of the arguments * @return string|bool the logical OR of the arguments
*/ */
public static function logicalOr() public static function logicalOr()
{ {
@ -191,9 +191,9 @@ class Logical
* *
* @category Logical Functions * @category Logical Functions
* *
* @param mixed $logical A value or expression that can be evaluated to TRUE or FALSE * @param mixed $logical A value or expression that can be evaluated to TRUE or FALSE
* *
* @return bool|string the boolean inverse of the argument * @return bool|string the boolean inverse of the argument
*/ */
public static function NOT($logical = false) public static function NOT($logical = false)
{ {
@ -239,11 +239,11 @@ class Logical
* *
* @category Logical Functions * @category Logical Functions
* *
* @param mixed $condition Condition to evaluate * @param mixed $condition Condition to evaluate
* @param mixed $returnIfTrue Value to return when condition is true * @param mixed $returnIfTrue Value to return when condition is true
* @param mixed $returnIfFalse Optional value to return when condition is false * @param mixed $returnIfFalse Optional value to return when condition is false
* *
* @return mixed The value of returnIfTrue or returnIfFalse determined by condition * @return mixed The value of returnIfTrue or returnIfFalse determined by condition
*/ */
public static function statementIf($condition = true, $returnIfTrue = 0, $returnIfFalse = false) public static function statementIf($condition = true, $returnIfTrue = 0, $returnIfFalse = false)
{ {
@ -262,10 +262,10 @@ class Logical
* *
* @category Logical Functions * @category Logical Functions
* *
* @param mixed $testValue Value to check, is also the value returned when no error * @param mixed $testValue Value to check, is also the value returned when no error
* @param mixed $errorpart Value to return when testValue is an error condition * @param mixed $errorpart Value to return when testValue is an error condition
* *
* @return mixed The value of errorpart or testValue determined by error condition * @return mixed The value of errorpart or testValue determined by error condition
*/ */
public static function IFERROR($testValue = '', $errorpart = '') public static function IFERROR($testValue = '', $errorpart = '')
{ {

108
src/PhpSpreadsheet/Calculation/LookupRef.php
View File

@ -34,24 +34,24 @@ class LookupRef
* Excel Function: * Excel Function:
* =ADDRESS(row, column, [relativity], [referenceStyle], [sheetText]) * =ADDRESS(row, column, [relativity], [referenceStyle], [sheetText])
* *
* @param row Row number to use in the cell reference * @param row Row number to use in the cell reference
* @param column Column number to use in the cell reference * @param column Column number to use in the cell reference
* @param relativity Flag indicating the type of reference to return * @param relativity Flag indicating the type of reference to return
* 1 or omitted Absolute * 1 or omitted Absolute
* 2 Absolute row; relative column * 2 Absolute row; relative column
* 3 Relative row; absolute column * 3 Relative row; absolute column
* 4 Relative * 4 Relative
* @param referenceStyle A logical value that specifies the A1 or R1C1 reference style. * @param referenceStyle A logical value that specifies the A1 or R1C1 reference style.
* TRUE or omitted CELL_ADDRESS returns an A1-style reference * TRUE or omitted CELL_ADDRESS returns an A1-style reference
* FALSE CELL_ADDRESS returns an R1C1-style reference * FALSE CELL_ADDRESS returns an R1C1-style reference
* @param sheetText Optional Name of worksheet to use * @param sheetText Optional Name of worksheet to use
* @param mixed $row * @param mixed $row
* @param mixed $column * @param mixed $column
* @param mixed $relativity * @param mixed $relativity
* @param mixed $referenceStyle * @param mixed $referenceStyle
* @param mixed $sheetText * @param mixed $sheetText
* *
* @return string * @return string
*/ */
public static function cellAddress($row, $column, $relativity = 1, $referenceStyle = true, $sheetText = '') public static function cellAddress($row, $column, $relativity = 1, $referenceStyle = true, $sheetText = '')
{ {
@ -103,10 +103,10 @@ class LookupRef
* Excel Function: * Excel Function:
* =COLUMN([cellAddress]) * =COLUMN([cellAddress])
* *
* @param cellAddress A reference to a range of cells for which you want the column numbers * @param cellAddress A reference to a range of cells for which you want the column numbers
* @param null|mixed $cellAddress * @param null|mixed $cellAddress
* *
* @return int or array of integer * @return int or array of integer
*/ */
public static function COLUMN($cellAddress = null) public static function COLUMN($cellAddress = null)
{ {
@ -149,10 +149,10 @@ class LookupRef
* Excel Function: * Excel Function:
* =COLUMNS(cellAddress) * =COLUMNS(cellAddress)
* *
* @param cellAddress An array or array formula, or a reference to a range of cells for which you want the number of columns * @param cellAddress An array or array formula, or a reference to a range of cells for which you want the number of columns
* @param null|mixed $cellAddress * @param null|mixed $cellAddress
* *
* @return int The number of columns in cellAddress * @return int The number of columns in cellAddress
*/ */
public static function COLUMNS($cellAddress = null) public static function COLUMNS($cellAddress = null)
{ {
@ -184,10 +184,10 @@ class LookupRef
* Excel Function: * Excel Function:
* =ROW([cellAddress]) * =ROW([cellAddress])
* *
* @param cellAddress A reference to a range of cells for which you want the row numbers * @param cellAddress A reference to a range of cells for which you want the row numbers
* @param null|mixed $cellAddress * @param null|mixed $cellAddress
* *
* @return int or array of integer * @return int or array of integer
*/ */
public static function ROW($cellAddress = null) public static function ROW($cellAddress = null)
{ {
@ -230,10 +230,10 @@ class LookupRef
* Excel Function: * Excel Function:
* =ROWS(cellAddress) * =ROWS(cellAddress)
* *
* @param cellAddress An array or array formula, or a reference to a range of cells for which you want the number of rows * @param cellAddress An array or array formula, or a reference to a range of cells for which you want the number of rows
* @param null|mixed $cellAddress * @param null|mixed $cellAddress
* *
* @return int The number of rows in cellAddress * @return int The number of rows in cellAddress
*/ */
public static function ROWS($cellAddress = null) public static function ROWS($cellAddress = null)
{ {
@ -262,11 +262,11 @@ class LookupRef
* *
* @category Logical Functions * @category Logical Functions
* *
* @param string $linkURL Value to check, is also the value returned when no error * @param string $linkURL Value to check, is also the value returned when no error
* @param string $displayName Value to return when testValue is an error condition * @param string $displayName Value to return when testValue is an error condition
* @param \PhpOffice\PhpSpreadsheet\Cell $pCell The cell to set the hyperlink in * @param \PhpOffice\PhpSpreadsheet\Cell $pCell The cell to set the hyperlink in
* *
* @return mixed The value of $displayName (or $linkURL if $displayName was blank) * @return mixed The value of $displayName (or $linkURL if $displayName was blank)
*/ */
public static function HYPERLINK($linkURL = '', $displayName = null, \PhpOffice\PhpSpreadsheet\Cell $pCell = null) public static function HYPERLINK($linkURL = '', $displayName = null, \PhpOffice\PhpSpreadsheet\Cell $pCell = null)
{ {
@ -301,10 +301,10 @@ class LookupRef
* *
* NOTE - INDIRECT() does not yet support the optional a1 parameter introduced in Excel 2010 * NOTE - INDIRECT() does not yet support the optional a1 parameter introduced in Excel 2010
* *
* @param cellAddress $cellAddress The cell address of the current cell (containing this formula) * @param cellAddress $cellAddress The cell address of the current cell (containing this formula)
* @param \PhpOffice\PhpSpreadsheet\Cell $pCell The current cell (containing this formula) * @param \PhpOffice\PhpSpreadsheet\Cell $pCell The current cell (containing this formula)
* *
* @return mixed The cells referenced by cellAddress * @return mixed The cells referenced by cellAddress
* *
* @todo Support for the optional a1 parameter introduced in Excel 2010 * @todo Support for the optional a1 parameter introduced in Excel 2010
*/ */
@ -359,26 +359,26 @@ class LookupRef
* Excel Function: * Excel Function:
* =OFFSET(cellAddress, rows, cols, [height], [width]) * =OFFSET(cellAddress, rows, cols, [height], [width])
* *
* @param cellAddress The reference from which you want to base the offset. Reference must refer to a cell or * @param cellAddress The reference from which you want to base the offset. Reference must refer to a cell or
* range of adjacent cells; otherwise, OFFSET returns the #VALUE! error value. * range of adjacent cells; otherwise, OFFSET returns the #VALUE! error value.
* @param rows The number of rows, up or down, that you want the upper-left cell to refer to. * @param rows The number of rows, up or down, that you want the upper-left cell to refer to.
* Using 5 as the rows argument specifies that the upper-left cell in the reference is * Using 5 as the rows argument specifies that the upper-left cell in the reference is
* five rows below reference. Rows can be positive (which means below the starting reference) * five rows below reference. Rows can be positive (which means below the starting reference)
* or negative (which means above the starting reference). * or negative (which means above the starting reference).
* @param cols The number of columns, to the left or right, that you want the upper-left cell of the result * @param cols The number of columns, to the left or right, that you want the upper-left cell of the result
* to refer to. Using 5 as the cols argument specifies that the upper-left cell in the * to refer to. Using 5 as the cols argument specifies that the upper-left cell in the
* reference is five columns to the right of reference. Cols can be positive (which means * reference is five columns to the right of reference. Cols can be positive (which means
* to the right of the starting reference) or negative (which means to the left of the * to the right of the starting reference) or negative (which means to the left of the
* starting reference). * starting reference).
* @param height The height, in number of rows, that you want the returned reference to be. Height must be a positive number. * @param height The height, in number of rows, that you want the returned reference to be. Height must be a positive number.
* @param width The width, in number of columns, that you want the returned reference to be. Width must be a positive number. * @param width The width, in number of columns, that you want the returned reference to be. Width must be a positive number.
* @param null|mixed $cellAddress * @param null|mixed $cellAddress
* @param mixed $rows * @param mixed $rows
* @param mixed $columns * @param mixed $columns
* @param null|mixed $height * @param null|mixed $height
* @param null|mixed $width * @param null|mixed $width
* *
* @return string A reference to a cell or range of cells * @return string A reference to a cell or range of cells
*/ */
public static function OFFSET($cellAddress = null, $rows = 0, $columns = 0, $height = null, $width = null) public static function OFFSET($cellAddress = null, $rows = 0, $columns = 0, $height = null, $width = null)
{ {
@ -458,15 +458,15 @@ class LookupRef
* Excel Function: * Excel Function:
* =CHOOSE(index_num, value1, [value2], ...) * =CHOOSE(index_num, value1, [value2], ...)
* *
* @param index_num Specifies which value argument is selected. * @param index_num Specifies which value argument is selected.
* Index_num must be a number between 1 and 254, or a formula or reference to a cell containing a number * Index_num must be a number between 1 and 254, or a formula or reference to a cell containing a number
* between 1 and 254. * between 1 and 254.
* @param value1... Value1 is required, subsequent values are optional. * @param value1... Value1 is required, subsequent values are optional.
* Between 1 to 254 value arguments from which CHOOSE selects a value or an action to perform based on * Between 1 to 254 value arguments from which CHOOSE selects a value or an action to perform based on
* index_num. The arguments can be numbers, cell references, defined names, formulas, functions, or * index_num. The arguments can be numbers, cell references, defined names, formulas, functions, or
* text. * text.
* *
* @return mixed The selected value * @return mixed The selected value
*/ */
public static function CHOOSE() public static function CHOOSE()
{ {
@ -502,14 +502,14 @@ class LookupRef
* Excel Function: * Excel Function:
* =MATCH(lookup_value, lookup_array, [match_type]) * =MATCH(lookup_value, lookup_array, [match_type])
* *
* @param lookup_value The value that you want to match in lookup_array * @param lookup_value The value that you want to match in lookup_array
* @param lookup_array The range of cells being searched * @param lookup_array The range of cells being searched
* @param match_type The number -1, 0, or 1. -1 means above, 0 means exact match, 1 means below. If match_type is 1 or -1, the list has to be ordered. * @param match_type The number -1, 0, or 1. -1 means above, 0 means exact match, 1 means below. If match_type is 1 or -1, the list has to be ordered.
* @param mixed $lookup_value * @param mixed $lookup_value
* @param mixed $lookup_array * @param mixed $lookup_array
* @param mixed $match_type * @param mixed $match_type
* *
* @return int The relative position of the found item * @return int The relative position of the found item
*/ */
public static function MATCH($lookup_value, $lookup_array, $match_type = 1) public static function MATCH($lookup_value, $lookup_array, $match_type = 1)
{ {
@ -600,14 +600,14 @@ class LookupRef
* Excel Function: * Excel Function:
* =INDEX(range_array, row_num, [column_num]) * =INDEX(range_array, row_num, [column_num])
* *
* @param range_array A range of cells or an array constant * @param range_array A range of cells or an array constant
* @param row_num The row in array from which to return a value. If row_num is omitted, column_num is required. * @param row_num The row in array from which to return a value. If row_num is omitted, column_num is required.
* @param column_num The column in array from which to return a value. If column_num is omitted, row_num is required. * @param column_num The column in array from which to return a value. If column_num is omitted, row_num is required.
* @param mixed $arrayValues * @param mixed $arrayValues
* @param mixed $rowNum * @param mixed $rowNum
* @param mixed $columnNum * @param mixed $columnNum
* *
* @return mixed the value of a specified cell or array of cells * @return mixed the value of a specified cell or array of cells
*/ */
public static function INDEX($arrayValues, $rowNum = 0, $columnNum = 0) public static function INDEX($arrayValues, $rowNum = 0, $columnNum = 0)
{ {
@ -658,9 +658,9 @@ class LookupRef
/** /**
* TRANSPOSE. * TRANSPOSE.
* *
* @param array $matrixData A matrix of values * @param array $matrixData A matrix of values
* *
* @return array * @return array
* *
* Unlike the Excel TRANSPOSE function, which will only work on a single row or column, this function will transpose a full matrix * Unlike the Excel TRANSPOSE function, which will only work on a single row or column, this function will transpose a full matrix
*/ */
@ -699,16 +699,16 @@ class LookupRef
* VLOOKUP * VLOOKUP
* The VLOOKUP function searches for value in the left-most column of lookup_array and returns the value in the same row based on the index_number. * The VLOOKUP function searches for value in the left-most column of lookup_array and returns the value in the same row based on the index_number.
* *
* @param lookup_value The value that you want to match in lookup_array * @param lookup_value The value that you want to match in lookup_array
* @param lookup_array The range of cells being searched * @param lookup_array The range of cells being searched
* @param index_number The column number in table_array from which the matching value must be returned. The first column is 1. * @param index_number The column number in table_array from which the matching value must be returned. The first column is 1.
* @param not_exact_match determines if you are looking for an exact match based on lookup_value * @param not_exact_match determines if you are looking for an exact match based on lookup_value
* @param mixed $lookup_value * @param mixed $lookup_value
* @param mixed $lookup_array * @param mixed $lookup_array
* @param mixed $index_number * @param mixed $index_number
* @param mixed $not_exact_match * @param mixed $not_exact_match
* *
* @return mixed The value of the found cell * @return mixed The value of the found cell
*/ */
public static function VLOOKUP($lookup_value, $lookup_array, $index_number, $not_exact_match = true) public static function VLOOKUP($lookup_value, $lookup_array, $index_number, $not_exact_match = true)
{ {
@ -768,16 +768,16 @@ class LookupRef
* HLOOKUP * HLOOKUP
* The HLOOKUP function searches for value in the top-most row of lookup_array and returns the value in the same column based on the index_number. * The HLOOKUP function searches for value in the top-most row of lookup_array and returns the value in the same column based on the index_number.
* *
* @param lookup_value The value that you want to match in lookup_array * @param lookup_value The value that you want to match in lookup_array
* @param lookup_array The range of cells being searched * @param lookup_array The range of cells being searched
* @param index_number The row number in table_array from which the matching value must be returned. The first row is 1. * @param index_number The row number in table_array from which the matching value must be returned. The first row is 1.
* @param not_exact_match determines if you are looking for an exact match based on lookup_value * @param not_exact_match determines if you are looking for an exact match based on lookup_value
* @param mixed $lookup_value * @param mixed $lookup_value
* @param mixed $lookup_array * @param mixed $lookup_array
* @param mixed $index_number * @param mixed $index_number
* @param mixed $not_exact_match * @param mixed $not_exact_match
* *
* @return mixed The value of the found cell * @return mixed The value of the found cell
*/ */
public static function HLOOKUP($lookup_value, $lookup_array, $index_number, $not_exact_match = true) public static function HLOOKUP($lookup_value, $lookup_array, $index_number, $not_exact_match = true)
{ {
@ -833,14 +833,14 @@ class LookupRef
* LOOKUP * LOOKUP
* The LOOKUP function searches for value either from a one-row or one-column range or from an array. * The LOOKUP function searches for value either from a one-row or one-column range or from an array.
* *
* @param lookup_value The value that you want to match in lookup_array * @param lookup_value The value that you want to match in lookup_array
* @param lookup_vector The range of cells being searched * @param lookup_vector The range of cells being searched
* @param result_vector The column from which the matching value must be returned * @param result_vector The column from which the matching value must be returned
* @param mixed $lookup_value * @param mixed $lookup_value
* @param mixed $lookup_vector * @param mixed $lookup_vector
* @param null|mixed $result_vector * @param null|mixed $result_vector
* *
* @return mixed The value of the found cell * @return mixed The value of the found cell
*/ */
public static function LOOKUP($lookup_value, $lookup_vector, $result_vector = null) public static function LOOKUP($lookup_value, $lookup_vector, $result_vector = null)
{ {

194
src/PhpSpreadsheet/Calculation/MathTrig.php
View File

@ -75,10 +75,10 @@ class MathTrig
* *
* @category Mathematical and Trigonometric Functions * @category Mathematical and Trigonometric Functions
* *
* @param float $xCoordinate the x-coordinate of the point * @param float $xCoordinate the x-coordinate of the point
* @param float $yCoordinate the y-coordinate of the point * @param float $yCoordinate the y-coordinate of the point
* *
* @return float the inverse tangent of the specified x- and y-coordinates * @return float the inverse tangent of the specified x- and y-coordinates
*/ */
public static function ATAN2($xCoordinate = null, $yCoordinate = null) public static function ATAN2($xCoordinate = null, $yCoordinate = null)
{ {
@ -116,10 +116,10 @@ class MathTrig
* *
* @category Mathematical and Trigonometric Functions * @category Mathematical and Trigonometric Functions
* *
* @param float $number the number you want to round * @param float $number the number you want to round
* @param float $significance the multiple to which you want to round * @param float $significance the multiple to which you want to round
* *
* @return float Rounded Number * @return float Rounded Number
*/ */
public static function CEILING($number, $significance = null) public static function CEILING($number, $significance = null)
{ {
@ -155,10 +155,10 @@ class MathTrig
* *
* @category Mathematical and Trigonometric Functions * @category Mathematical and Trigonometric Functions
* *
* @param int $numObjs Number of different objects * @param int $numObjs Number of different objects
* @param int $numInSet Number of objects in each combination * @param int $numInSet Number of objects in each combination
* *
* @return int Number of combinations * @return int Number of combinations
*/ */
public static function COMBIN($numObjs, $numInSet) public static function COMBIN($numObjs, $numInSet)
{ {
@ -192,9 +192,9 @@ class MathTrig
* *
* @category Mathematical and Trigonometric Functions * @category Mathematical and Trigonometric Functions
* *
* @param float $number Number to round * @param float $number Number to round
* *
* @return int Rounded Number * @return int Rounded Number
*/ */
public static function EVEN($number) public static function EVEN($number)
{ {
@ -226,9 +226,9 @@ class MathTrig
* *
* @category Mathematical and Trigonometric Functions * @category Mathematical and Trigonometric Functions
* *
* @param float $factVal Factorial Value * @param float $factVal Factorial Value
* *
* @return int Factorial * @return int Factorial
*/ */
public static function FACT($factVal) public static function FACT($factVal)
{ {
@ -266,9 +266,9 @@ class MathTrig
* *
* @category Mathematical and Trigonometric Functions * @category Mathematical and Trigonometric Functions
* *
* @param float $factVal Factorial Value * @param float $factVal Factorial Value
* *
* @return int Double Factorial * @return int Double Factorial
*/ */
public static function FACTDOUBLE($factVal) public static function FACTDOUBLE($factVal)
{ {
@ -301,10 +301,10 @@ class MathTrig
* *
* @category Mathematical and Trigonometric Functions * @category Mathematical and Trigonometric Functions
* *
* @param float $number Number to round * @param float $number Number to round
* @param float $significance Significance * @param float $significance Significance
* *
* @return float Rounded Number * @return float Rounded Number
*/ */
public static function FLOOR($number, $significance = null) public static function FLOOR($number, $significance = null)
{ {
@ -343,9 +343,9 @@ class MathTrig
* *
* @category Mathematical and Trigonometric Functions * @category Mathematical and Trigonometric Functions
* *
* @param mixed $arg,... Data values * @param mixed $arg,... Data values
* *
* @return int Greatest Common Divisor * @return int Greatest Common Divisor
*/ */
public static function GCD() public static function GCD()
{ {
@ -419,9 +419,9 @@ class MathTrig
* *
* @category Mathematical and Trigonometric Functions * @category Mathematical and Trigonometric Functions
* *
* @param float $number Number to cast to an integer * @param float $number Number to cast to an integer
* *
* @return int Integer value * @return int Integer value
*/ */
public static function INT($number) public static function INT($number)
{ {
@ -452,9 +452,9 @@ class MathTrig
* *
* @category Mathematical and Trigonometric Functions * @category Mathematical and Trigonometric Functions
* *
* @param mixed $arg,... Data values * @param mixed $arg,... Data values
* *
* @return int Lowest Common Multiplier * @return int Lowest Common Multiplier
*/ */
public static function LCM() public static function LCM()
{ {
@ -503,10 +503,10 @@ class MathTrig
* *
* @category Mathematical and Trigonometric Functions * @category Mathematical and Trigonometric Functions
* *
* @param float $number The positive real number for which you want the logarithm * @param float $number The positive real number for which you want the logarithm
* @param float $base The base of the logarithm. If base is omitted, it is assumed to be 10. * @param float $base The base of the logarithm. If base is omitted, it is assumed to be 10.
* *
* @return float * @return float
*/ */
public static function logBase($number = null, $base = 10) public static function logBase($number = null, $base = 10)
{ {
@ -533,9 +533,9 @@ class MathTrig
* *
* @category Mathematical and Trigonometric Functions * @category Mathematical and Trigonometric Functions
* *
* @param array $matrixValues A matrix of values * @param array $matrixValues A matrix of values
* *
* @return float * @return float
*/ */
public static function MDETERM($matrixValues) public static function MDETERM($matrixValues)
{ {
@ -585,9 +585,9 @@ class MathTrig
* *
* @category Mathematical and Trigonometric Functions * @category Mathematical and Trigonometric Functions
* *
* @param array $matrixValues A matrix of values * @param array $matrixValues A matrix of values
* *
* @return array * @return array
*/ */
public static function MINVERSE($matrixValues) public static function MINVERSE($matrixValues)
{ {
@ -632,10 +632,10 @@ class MathTrig
/** /**
* MMULT. * MMULT.
* *
* @param array $matrixData1 A matrix of values * @param array $matrixData1 A matrix of values
* @param array $matrixData2 A matrix of values * @param array $matrixData2 A matrix of values
* *
* @return array * @return array
*/ */
public static function MMULT($matrixData1, $matrixData2) public static function MMULT($matrixData1, $matrixData2)
{ {
@ -694,10 +694,10 @@ class MathTrig
/** /**
* MOD. * MOD.
* *
* @param int $a Dividend * @param int $a Dividend
* @param int $b Divisor * @param int $b Divisor
* *
* @return int Remainder * @return int Remainder
*/ */
public static function MOD($a = 1, $b = 1) public static function MOD($a = 1, $b = 1)
{ {
@ -720,10 +720,10 @@ class MathTrig
* *
* Rounds a number to the nearest multiple of a specified value * Rounds a number to the nearest multiple of a specified value
* *
* @param float $number Number to round * @param float $number Number to round
* @param int $multiple Multiple to which you want to round $number * @param int $multiple Multiple to which you want to round $number
* *
* @return float Rounded Number * @return float Rounded Number
*/ */
public static function MROUND($number, $multiple) public static function MROUND($number, $multiple)
{ {
@ -751,9 +751,9 @@ class MathTrig
* *
* Returns the ratio of the factorial of a sum of values to the product of factorials. * Returns the ratio of the factorial of a sum of values to the product of factorials.
* *
* @param array of mixed Data Series * @param array of mixed Data Series
* *
* @return float * @return float
*/ */
public static function MULTINOMIAL() public static function MULTINOMIAL()
{ {
@ -788,9 +788,9 @@ class MathTrig
* *
* Returns number rounded up to the nearest odd integer. * Returns number rounded up to the nearest odd integer.
* *
* @param float $number Number to round * @param float $number Number to round
* *
* @return int Rounded Number * @return int Rounded Number
*/ */
public static function ODD($number) public static function ODD($number)
{ {
@ -822,10 +822,10 @@ class MathTrig
* *
* Computes x raised to the power y. * Computes x raised to the power y.
* *
* @param float $x * @param float $x
* @param float $y * @param float $y
* *
* @return float * @return float
*/ */
public static function POWER($x = 0, $y = 2) public static function POWER($x = 0, $y = 2)
{ {
@ -855,9 +855,9 @@ class MathTrig
* *
* @category Mathematical and Trigonometric Functions * @category Mathematical and Trigonometric Functions
* *
* @param mixed $arg,... Data values * @param mixed $arg,... Data values
* *
* @return float * @return float
*/ */
public static function PRODUCT() public static function PRODUCT()
{ {
@ -895,9 +895,9 @@ class MathTrig
* *
* @category Mathematical and Trigonometric Functions * @category Mathematical and Trigonometric Functions
* *
* @param mixed $arg,... Data values * @param mixed $arg,... Data values
* *
* @return float * @return float
*/ */
public static function QUOTIENT() public static function QUOTIENT()
{ {
@ -927,10 +927,10 @@ class MathTrig
/** /**
* RAND. * RAND.
* *
* @param int $min Minimal value * @param int $min Minimal value
* @param int $max Maximal value * @param int $max Maximal value
* *
* @return int Random number * @return int Random number
*/ */
public static function RAND($min = 0, $max = 0) public static function RAND($min = 0, $max = 0)
{ {
@ -981,10 +981,10 @@ class MathTrig
* *
* Rounds a number up to a specified number of decimal places * Rounds a number up to a specified number of decimal places
* *
* @param float $number Number to round * @param float $number Number to round
* @param int $digits Number of digits to which you want to round $number * @param int $digits Number of digits to which you want to round $number
* *
* @return float Rounded Number * @return float Rounded Number
*/ */
public static function ROUNDUP($number, $digits) public static function ROUNDUP($number, $digits)
{ {
@ -1008,10 +1008,10 @@ class MathTrig
* *
* Rounds a number down to a specified number of decimal places * Rounds a number down to a specified number of decimal places
* *
* @param float $number Number to round * @param float $number Number to round
* @param int $digits Number of digits to which you want to round $number * @param int $digits Number of digits to which you want to round $number
* *
* @return float Rounded Number * @return float Rounded Number
*/ */
public static function ROUNDDOWN($number, $digits) public static function ROUNDDOWN($number, $digits)
{ {
@ -1035,12 +1035,12 @@ class MathTrig
* *
* Returns the sum of a power series * Returns the sum of a power series
* *
* @param float $x Input value to the power series * @param float $x Input value to the power series
* @param float $n Initial power to which you want to raise $x * @param float $n Initial power to which you want to raise $x
* @param float $m Step by which to increase $n for each term in the series * @param float $m Step by which to increase $n for each term in the series
* @param array of mixed Data Series * @param array of mixed Data Series
* *
* @return float * @return float
*/ */
public static function SERIESSUM() public static function SERIESSUM()
{ {
@ -1077,9 +1077,9 @@ class MathTrig
* Determines the sign of a number. Returns 1 if the number is positive, zero (0) * Determines the sign of a number. Returns 1 if the number is positive, zero (0)
* if the number is 0, and -1 if the number is negative. * if the number is 0, and -1 if the number is negative.
* *
* @param float $number Number to round * @param float $number Number to round
* *
* @return int sign value * @return int sign value
*/ */
public static function SIGN($number) public static function SIGN($number)
{ {
@ -1104,9 +1104,9 @@ class MathTrig
* *
* Returns the square root of (number * pi). * Returns the square root of (number * pi).
* *
* @param float $number Number * @param float $number Number
* *
* @return float Square Root of Number * Pi * @return float Square Root of Number * Pi
*/ */
public static function SQRTPI($number) public static function SQRTPI($number)
{ {
@ -1128,11 +1128,11 @@ class MathTrig
* *
* Returns a subtotal in a list or database. * Returns a subtotal in a list or database.
* *
* @param int the number 1 to 11 that specifies which function to * @param int the number 1 to 11 that specifies which function to
* use in calculating subtotals within a list * use in calculating subtotals within a list
* @param array of mixed Data Series * @param array of mixed Data Series
* *
* @return float * @return float
*/ */
public static function SUBTOTAL() public static function SUBTOTAL()
{ {
@ -1181,9 +1181,9 @@ class MathTrig
* *
* @category Mathematical and Trigonometric Functions * @category Mathematical and Trigonometric Functions
* *
* @param mixed $arg,... Data values * @param mixed $arg,... Data values
* *
* @return float * @return float
*/ */
public static function SUM() public static function SUM()
{ {
@ -1210,12 +1210,12 @@ class MathTrig
* *
* @category Mathematical and Trigonometric Functions * @category Mathematical and Trigonometric Functions
* *
* @param mixed $arg,... Data values * @param mixed $arg,... Data values
* @param string $condition the criteria that defines which cells will be summed * @param string $condition the criteria that defines which cells will be summed
* @param mixed $aArgs * @param mixed $aArgs
* @param mixed $sumArgs * @param mixed $sumArgs
* *
* @return float * @return float
*/ */
public static function SUMIF($aArgs, $condition, $sumArgs = []) public static function SUMIF($aArgs, $condition, $sumArgs = [])
{ {
@ -1245,7 +1245,7 @@ class MathTrig
} }
/** /**
* SUMIFS. * SUMIFS.
* *
* Counts the number of cells that contain numbers within the list of arguments * Counts the number of cells that contain numbers within the list of arguments
* *
@ -1254,10 +1254,10 @@ class MathTrig
* *
* @category Mathematical and Trigonometric Functions * @category Mathematical and Trigonometric Functions
* *
* @param mixed $arg,... Data values * @param mixed $arg,... Data values
* @param string $condition the criteria that defines which cells will be summed * @param string $condition the criteria that defines which cells will be summed
* *
* @return float * @return float
*/ */
public static function SUMIFS() public static function SUMIFS()
{ {
@ -1302,9 +1302,9 @@ class MathTrig
* *
* @category Mathematical and Trigonometric Functions * @category Mathematical and Trigonometric Functions
* *
* @param mixed $arg,... Data values * @param mixed $arg,... Data values
* *
* @return float * @return float
*/ */
public static function SUMPRODUCT() public static function SUMPRODUCT()
{ {
@ -1347,9 +1347,9 @@ class MathTrig
* *
* @category Mathematical and Trigonometric Functions * @category Mathematical and Trigonometric Functions
* *
* @param mixed $arg,... Data values * @param mixed $arg,... Data values
* *
* @return float * @return float
*/ */
public static function SUMSQ() public static function SUMSQ()
{ {
@ -1369,10 +1369,10 @@ class MathTrig
/** /**
* SUMX2MY2. * SUMX2MY2.
* *
* @param mixed[] $matrixData1 Matrix #1 * @param mixed[] $matrixData1 Matrix #1
* @param mixed[] $matrixData2 Matrix #2 * @param mixed[] $matrixData2 Matrix #2
* *
* @return float * @return float
*/ */
public static function SUMX2MY2($matrixData1, $matrixData2) public static function SUMX2MY2($matrixData1, $matrixData2)
{ {
@ -1394,10 +1394,10 @@ class MathTrig
/** /**
* SUMX2PY2. * SUMX2PY2.
* *
* @param mixed[] $matrixData1 Matrix #1 * @param mixed[] $matrixData1 Matrix #1
* @param mixed[] $matrixData2 Matrix #2 * @param mixed[] $matrixData2 Matrix #2
* *
* @return float * @return float
*/ */
public static function SUMX2PY2($matrixData1, $matrixData2) public static function SUMX2PY2($matrixData1, $matrixData2)
{ {
@ -1419,10 +1419,10 @@ class MathTrig
/** /**
* SUMXMY2. * SUMXMY2.
* *
* @param mixed[] $matrixData1 Matrix #1 * @param mixed[] $matrixData1 Matrix #1
* @param mixed[] $matrixData2 Matrix #2 * @param mixed[] $matrixData2 Matrix #2
* *
* @return float * @return float
*/ */
public static function SUMXMY2($matrixData1, $matrixData2) public static function SUMXMY2($matrixData1, $matrixData2)
{ {
@ -1446,10 +1446,10 @@ class MathTrig
* *
* Truncates value to the number of fractional digits by number_digits. * Truncates value to the number of fractional digits by number_digits.
* *
* @param float $value * @param float $value
* @param int $digits * @param int $digits
* *
* @return float Truncated value * @return float Truncated value
*/ */
public static function TRUNC($value = 0, $digits = 0) public static function TRUNC($value = 0, $digits = 0)
{ {

466
src/PhpSpreadsheet/Calculation/Statistical.php
View File

File diff suppressed because it is too large Load Diff

118
src/PhpSpreadsheet/Calculation/TextData.php
View File

@ -36,9 +36,9 @@ class TextData
/** /**
* CHARACTER. * CHARACTER.
* *
* @param string $character Value * @param string $character Value
* *
* @return string * @return string
*/ */
public static function CHARACTER($character) public static function CHARACTER($character)
{ {
@ -58,9 +58,9 @@ class TextData
/** /**
* TRIMNONPRINTABLE. * TRIMNONPRINTABLE.
* *
* @param mixed $stringValue Value to check * @param mixed $stringValue Value to check
* *
* @return string * @return string
*/ */
public static function TRIMNONPRINTABLE($stringValue = '') public static function TRIMNONPRINTABLE($stringValue = '')
{ {
@ -84,9 +84,9 @@ class TextData
/** /**
* TRIMSPACES. * TRIMSPACES.
* *
* @param mixed $stringValue Value to check * @param mixed $stringValue Value to check
* *
* @return string * @return string
*/ */
public static function TRIMSPACES($stringValue = '') public static function TRIMSPACES($stringValue = '')
{ {
@ -105,9 +105,9 @@ class TextData
/** /**
* ASCIICODE. * ASCIICODE.
* *
* @param string $characters Value * @param string $characters Value
* *
* @return int * @return int
*/ */
public static function ASCIICODE($characters) public static function ASCIICODE($characters)
{ {
@ -141,7 +141,7 @@ class TextData
/** /**
* CONCATENATE. * CONCATENATE.
* *
* @return string * @return string
*/ */
public static function CONCATENATE() public static function CONCATENATE()
{ {
@ -169,12 +169,12 @@ class TextData
* This function converts a number to text using currency format, with the decimals rounded to the specified place. * This function converts a number to text using currency format, with the decimals rounded to the specified place.
* The format used is $#,##0.00_);($#,##0.00).. * The format used is $#,##0.00_);($#,##0.00)..
* *
* @param float $value The value to format * @param float $value The value to format
* @param int $decimals The number of digits to display to the right of the decimal point. * @param int $decimals The number of digits to display to the right of the decimal point.
* If decimals is negative, number is rounded to the left of the decimal point. * If decimals is negative, number is rounded to the left of the decimal point.
* If you omit decimals, it is assumed to be 2 * If you omit decimals, it is assumed to be 2
* *
* @return string * @return string
*/ */
public static function DOLLAR($value = 0, $decimals = 2) public static function DOLLAR($value = 0, $decimals = 2)
{ {
@ -204,11 +204,11 @@ class TextData
/** /**
* SEARCHSENSITIVE. * SEARCHSENSITIVE.
* *
* @param string $needle The string to look for * @param string $needle The string to look for
* @param string $haystack The string in which to look * @param string $haystack The string in which to look
* @param int $offset Offset within $haystack * @param int $offset Offset within $haystack
* *
* @return string * @return string
*/ */
public static function SEARCHSENSITIVE($needle, $haystack, $offset = 1) public static function SEARCHSENSITIVE($needle, $haystack, $offset = 1)
{ {
@ -242,11 +242,11 @@ class TextData
/** /**
* SEARCHINSENSITIVE. * SEARCHINSENSITIVE.
* *
* @param string $needle The string to look for * @param string $needle The string to look for
* @param string $haystack The string in which to look * @param string $haystack The string in which to look
* @param int $offset Offset within $haystack * @param int $offset Offset within $haystack
* *
* @return string * @return string
*/ */
public static function SEARCHINSENSITIVE($needle, $haystack, $offset = 1) public static function SEARCHINSENSITIVE($needle, $haystack, $offset = 1)
{ {
@ -280,11 +280,11 @@ class TextData
/** /**
* FIXEDFORMAT. * FIXEDFORMAT.
* *
* @param mixed $value Value to check * @param mixed $value Value to check
* @param int $decimals * @param int $decimals
* @param bool $no_commas * @param bool $no_commas
* *
* @return string * @return string
*/ */
public static function FIXEDFORMAT($value, $decimals = 2, $no_commas = false) public static function FIXEDFORMAT($value, $decimals = 2, $no_commas = false)
{ {
@ -312,10 +312,10 @@ class TextData
/** /**
* LEFT. * LEFT.
* *
* @param string $value Value * @param string $value Value
* @param int $chars Number of characters * @param int $chars Number of characters
* *
* @return string * @return string
*/ */
public static function LEFT($value = '', $chars = 1) public static function LEFT($value = '', $chars = 1)
{ {
@ -340,11 +340,11 @@ class TextData
/** /**
* MID. * MID.
* *
* @param string $value Value * @param string $value Value
* @param int $start Start character * @param int $start Start character
* @param int $chars Number of characters * @param int $chars Number of characters
* *
* @return string * @return string
*/ */
public static function MID($value = '', $start = 1, $chars = null) public static function MID($value = '', $start = 1, $chars = null)
{ {
@ -373,10 +373,10 @@ class TextData
/** /**
* RIGHT. * RIGHT.
* *
* @param string $value Value * @param string $value Value
* @param int $chars Number of characters * @param int $chars Number of characters
* *
* @return string * @return string
*/ */
public static function RIGHT($value = '', $chars = 1) public static function RIGHT($value = '', $chars = 1)
{ {
@ -401,9 +401,9 @@ class TextData
/** /**
* STRINGLENGTH. * STRINGLENGTH.
* *
* @param string $value Value * @param string $value Value
* *
* @return int * @return int
*/ */
public static function STRINGLENGTH($value = '') public static function STRINGLENGTH($value = '')
{ {
@ -425,9 +425,9 @@ class TextData
* *
* Converts a string value to upper case. * Converts a string value to upper case.
* *
* @param string $mixedCaseString * @param string $mixedCaseString
* *
* @return string * @return string
*/ */
public static function LOWERCASE($mixedCaseString) public static function LOWERCASE($mixedCaseString)
{ {
@ -445,9 +445,9 @@ class TextData
* *
* Converts a string value to upper case. * Converts a string value to upper case.
* *
* @param string $mixedCaseString * @param string $mixedCaseString
* *
* @return string * @return string
*/ */
public static function UPPERCASE($mixedCaseString) public static function UPPERCASE($mixedCaseString)
{ {
@ -465,9 +465,9 @@ class TextData
* *
* Converts a string value to upper case. * Converts a string value to upper case.
* *
* @param string $mixedCaseString * @param string $mixedCaseString
* *
* @return string * @return string
*/ */
public static function PROPERCASE($mixedCaseString) public static function PROPERCASE($mixedCaseString)
{ {
@ -483,12 +483,12 @@ class TextData
/** /**
* REPLACE. * REPLACE.
* *
* @param string $oldText String to modify * @param string $oldText String to modify
* @param int $start Start character * @param int $start Start character
* @param int $chars Number of characters * @param int $chars Number of characters
* @param string $newText String to replace in defined position * @param string $newText String to replace in defined position
* *
* @return string * @return string
*/ */
public static function REPLACE($oldText, $start, $chars, $newText) public static function REPLACE($oldText, $start, $chars, $newText)
{ {
@ -506,12 +506,12 @@ class TextData
/** /**
* SUBSTITUTE. * SUBSTITUTE.
* *
* @param string $text Value * @param string $text Value
* @param string $fromText From Value * @param string $fromText From Value
* @param string $toText To Value * @param string $toText To Value
* @param int $instance Instance Number * @param int $instance Instance Number
* *
* @return string * @return string
*/ */
public static function SUBSTITUTE($text = '', $fromText = '', $toText = '', $instance = 0) public static function SUBSTITUTE($text = '', $fromText = '', $toText = '', $instance = 0)
{ {
@ -553,9 +553,9 @@ class TextData
/** /**
* RETURNSTRING. * RETURNSTRING.
* *
* @param mixed $testValue Value to check * @param mixed $testValue Value to check
* *
* @return string|null * @return string|null
*/ */
public static function RETURNSTRING($testValue = '') public static function RETURNSTRING($testValue = '')
{ {
@ -571,10 +571,10 @@ class TextData
/** /**
* TEXTFORMAT. * TEXTFORMAT.
* *
* @param mixed $value Value to check * @param mixed $value Value to check
* @param string $format Format mask to use * @param string $format Format mask to use
* *
* @return string * @return string
*/ */
public static function TEXTFORMAT($value, $format) public static function TEXTFORMAT($value, $format)
{ {
@ -591,9 +591,9 @@ class TextData
/** /**
* VALUE. * VALUE.
* *
* @param mixed $value Value to check * @param mixed $value Value to check
* *
* @return bool * @return bool
*/ */
public static function VALUE($value = '') public static function VALUE($value = '')
{ {

26
src/PhpSpreadsheet/Calculation/Token/Stack.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Calculation\Token;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -27,23 +27,23 @@ namespace PhpOffice\PhpSpreadsheet\Calculation\Token;
class Stack class Stack
{ {
/** /**
* The parser stack for formulae. * The parser stack for formulae.
* *
* @var mixed[] * @var mixed[]
*/ */
private $stack = []; private $stack = [];
/** /**
* Count of entries in the parser stack. * Count of entries in the parser stack.
* *
* @var int * @var int
*/ */
private $count = 0; private $count = 0;
/** /**
* Return the number of entries on the stack. * Return the number of entries on the stack.
* *
* @return int * @return int
*/ */
public function count() public function count()
{ {
@ -53,9 +53,9 @@ class Stack
/** /**
* Push a new entry onto the stack. * Push a new entry onto the stack.
* *
* @param mixed $type * @param mixed $type
* @param mixed $value * @param mixed $value
* @param mixed $reference * @param mixed $reference
*/ */
public function push($type, $value, $reference = null) public function push($type, $value, $reference = null)
{ {
@ -75,7 +75,7 @@ class Stack
/** /**
* Pop the last entry from the stack. * Pop the last entry from the stack.
* *
* @return mixed * @return mixed
*/ */
public function pop() public function pop()
{ {
@ -89,9 +89,9 @@ class Stack
/** /**
* Return an entry from the stack without removing it. * Return an entry from the stack without removing it.
* *
* @param int $n number indicating how far back in the stack we want to look * @param int $n number indicating how far back in the stack we want to look
* *
* @return mixed * @return mixed
*/ */
public function last($n = 1) public function last($n = 1)
{ {

262
src/PhpSpreadsheet/Cell.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -27,23 +27,23 @@ namespace PhpOffice\PhpSpreadsheet;
class Cell class Cell
{ {
/** /**
* Default range variable constant. * Default range variable constant.
* *
* @var string * @var string
*/ */
const DEFAULT_RANGE = 'A1:A1'; const DEFAULT_RANGE = 'A1:A1';
/** /**
* Value binder to use. * Value binder to use.
* *
* @var Cell\IValueBinder * @var Cell\IValueBinder
*/ */
private static $valueBinder; private static $valueBinder;
/** /**
* Value of the cell. * Value of the cell.
* *
* @var mixed * @var mixed
*/ */
private $value; private $value;
@ -55,38 +55,38 @@ class Cell
* possible that auto-calculation was disabled in the original spreadsheet, and underlying data * possible that auto-calculation was disabled in the original spreadsheet, and underlying data
* values used by the formula have changed since it was last calculated. * values used by the formula have changed since it was last calculated.
* *
* @var mixed * @var mixed
*/ */
private $calculatedValue; private $calculatedValue;
/** /**
* Type of the cell data. * Type of the cell data.
* *
* @var string * @var string
*/ */
private $dataType; private $dataType;
/** /**
* Parent worksheet. * Parent worksheet.
* *
* @var CachedObjectStorage\CacheBase * @var CachedObjectStorage\CacheBase
*/ */
private $parent; private $parent;
/** /**
* Index to cellXf. * Index to cellXf.
* *
* @var int * @var int
*/ */
private $xfIndex = 0; private $xfIndex = 0;
/** /**
* Attributes of the formula. * Attributes of the formula.
*/ */
private $formulaAttributes; private $formulaAttributes;
/** /**
* Send notification to the cache controller. * Send notification to the cache controller.
**/ **/
public function notifyCacheController() public function notifyCacheController()
{ {
@ -106,13 +106,13 @@ class Cell
} }
/** /**
* Create a new Cell. * Create a new Cell.
* *
* @param mixed $pValue * @param mixed $pValue
* @param string $pDataType * @param string $pDataType
* @param Worksheet $pSheet * @param Worksheet $pSheet
* *
* @throws Exception * @throws Exception
*/ */
public function __construct($pValue = null, $pDataType = null, Worksheet $pSheet = null) public function __construct($pValue = null, $pDataType = null, Worksheet $pSheet = null)
{ {
@ -134,9 +134,9 @@ class Cell
} }
/** /**
* Get cell coordinate column. * Get cell coordinate column.
* *
* @return string * @return string
*/ */
public function getColumn() public function getColumn()
{ {
@ -144,9 +144,9 @@ class Cell
} }
/** /**
* Get cell coordinate row. * Get cell coordinate row.
* *
* @return int * @return int
*/ */
public function getRow() public function getRow()
{ {
@ -154,9 +154,9 @@ class Cell
} }
/** /**
* Get cell coordinate. * Get cell coordinate.
* *
* @return string * @return string
*/ */
public function getCoordinate() public function getCoordinate()
{ {
@ -164,9 +164,9 @@ class Cell
} }
/** /**
* Get cell value. * Get cell value.
* *
* @return mixed * @return mixed
*/ */
public function getValue() public function getValue()
{ {
@ -174,9 +174,9 @@ class Cell
} }
/** /**
* Get cell value with formatting. * Get cell value with formatting.
* *
* @return string * @return string
*/ */
public function getFormattedValue() public function getFormattedValue()
{ {
@ -188,15 +188,15 @@ class Cell
} }
/** /**
* Set cell value. * Set cell value.
* *
* Sets the value for a cell, automatically determining the datatype using the value binder * Sets the value for a cell, automatically determining the datatype using the value binder
* *
* @param mixed $pValue Value * @param mixed $pValue Value
* *
* @throws Exception * @throws Exception
* *
* @return Cell * @return Cell
*/ */
public function setValue($pValue = null) public function setValue($pValue = null)
{ {
@ -208,14 +208,14 @@ class Cell
} }
/** /**
* Set the value for a cell, with the explicit data type passed to the method (bypassing any use of the value binder). * Set the value for a cell, with the explicit data type passed to the method (bypassing any use of the value binder).
* *
* @param mixed $pValue Value * @param mixed $pValue Value
* @param string $pDataType Explicit data type * @param string $pDataType Explicit data type
* *
* @throws Exception * @throws Exception
* *
* @return Cell * @return Cell
*/ */
public function setValueExplicit($pValue = null, $pDataType = Cell\DataType::TYPE_STRING) public function setValueExplicit($pValue = null, $pDataType = Cell\DataType::TYPE_STRING)
{ {
@ -257,15 +257,15 @@ class Cell
} }
/** /**
* Get calculated cell value. * Get calculated cell value.
* *
* @deprecated Since version 1.7.8 for planned changes to cell for array formula handling * @deprecated Since version 1.7.8 for planned changes to cell for array formula handling
* *
* @param bool $resetLog Whether the calculation engine logger should be reset or not * @param bool $resetLog Whether the calculation engine logger should be reset or not
* *
* @throws Exception * @throws Exception
* *
* @return mixed * @return mixed
*/ */
public function getCalculatedValue($resetLog = true) public function getCalculatedValue($resetLog = true)
{ {
@ -303,11 +303,11 @@ class Cell
} }
/** /**
* Set old calculated value (cached). * Set old calculated value (cached).
* *
* @param mixed $pValue Value * @param mixed $pValue Value
* *
* @return Cell * @return Cell
*/ */
public function setCalculatedValue($pValue = null) public function setCalculatedValue($pValue = null)
{ {
@ -326,7 +326,7 @@ class Cell
* possible that auto-calculation was disabled in the original spreadsheet, and underlying data * possible that auto-calculation was disabled in the original spreadsheet, and underlying data
* values used by the formula have changed since it was last calculated. * values used by the formula have changed since it was last calculated.
* *
* @return mixed * @return mixed
*/ */
public function getOldCalculatedValue() public function getOldCalculatedValue()
{ {
@ -334,9 +334,9 @@ class Cell
} }
/** /**
* Get cell data type. * Get cell data type.
* *
* @return string * @return string
*/ */
public function getDataType() public function getDataType()
{ {
@ -344,11 +344,11 @@ class Cell
} }
/** /**
* Set cell data type. * Set cell data type.
* *
* @param string $pDataType * @param string $pDataType
* *
* @return Cell * @return Cell
*/ */
public function setDataType($pDataType = Cell\DataType::TYPE_STRING) public function setDataType($pDataType = Cell\DataType::TYPE_STRING)
{ {
@ -361,9 +361,9 @@ class Cell
} }
/** /**
* Identify if the cell contains a formula. * Identify if the cell contains a formula.
* *
* @return bool * @return bool
*/ */
public function isFormula() public function isFormula()
{ {
@ -373,9 +373,9 @@ class Cell
/** /**
* Does this cell contain Data validation rules? * Does this cell contain Data validation rules?
* *
* @throws Exception * @throws Exception
* *
* @return bool * @return bool
*/ */
public function hasDataValidation() public function hasDataValidation()
{ {
@ -387,11 +387,11 @@ class Cell
} }
/** /**
* Get Data validation rules. * Get Data validation rules.
* *
* @throws Exception * @throws Exception
* *
* @return Cell\DataValidation * @return Cell\DataValidation
*/ */
public function getDataValidation() public function getDataValidation()
{ {
@ -403,13 +403,13 @@ class Cell
} }
/** /**
* Set Data validation rules. * Set Data validation rules.
* *
* @param Cell\DataValidation $pDataValidation * @param Cell\DataValidation $pDataValidation
* *
* @throws Exception * @throws Exception
* *
* @return Cell * @return Cell
*/ */
public function setDataValidation(Cell\DataValidation $pDataValidation = null) public function setDataValidation(Cell\DataValidation $pDataValidation = null)
{ {
@ -425,9 +425,9 @@ class Cell
/** /**
* Does this cell contain a Hyperlink? * Does this cell contain a Hyperlink?
* *
* @throws Exception * @throws Exception
* *
* @return bool * @return bool
*/ */
public function hasHyperlink() public function hasHyperlink()
{ {
@ -439,11 +439,11 @@ class Cell
} }
/** /**
* Get Hyperlink. * Get Hyperlink.
* *
* @throws Exception * @throws Exception
* *
* @return Cell\Hyperlink * @return Cell\Hyperlink
*/ */
public function getHyperlink() public function getHyperlink()
{ {
@ -455,13 +455,13 @@ class Cell
} }
/** /**
* Set Hyperlink. * Set Hyperlink.
* *
* @param Cell\Hyperlink $pHyperlink * @param Cell\Hyperlink $pHyperlink
* *
* @throws Exception * @throws Exception
* *
* @return Cell * @return Cell
*/ */
public function setHyperlink(Cell\Hyperlink $pHyperlink = null) public function setHyperlink(Cell\Hyperlink $pHyperlink = null)
{ {
@ -475,9 +475,9 @@ class Cell
} }
/** /**
* Get parent worksheet. * Get parent worksheet.
* *
* @return CachedObjectStorage\CacheBase * @return CachedObjectStorage\CacheBase
*/ */
public function getParent() public function getParent()
{ {
@ -485,9 +485,9 @@ class Cell
} }
/** /**
* Get parent worksheet. * Get parent worksheet.
* *
* @return Worksheet * @return Worksheet
*/ */
public function getWorksheet() public function getWorksheet()
{ {
@ -495,9 +495,9 @@ class Cell
} }
/** /**
* Is this cell in a merge range. * Is this cell in a merge range.
* *
* @return bool * @return bool
*/ */
public function isInMergeRange() public function isInMergeRange()
{ {
@ -505,9 +505,9 @@ class Cell
} }
/** /**
* Is this cell the master (top left cell) in a merge range (that holds the actual data value). * Is this cell the master (top left cell) in a merge range (that holds the actual data value).
* *
* @return bool * @return bool
*/ */
public function isMergeRangeValueCell() public function isMergeRangeValueCell()
{ {
@ -523,9 +523,9 @@ class Cell
} }
/** /**
* If this cell is in a merge range, then return the range. * If this cell is in a merge range, then return the range.
* *
* @return string * @return string
*/ */
public function getMergeRange() public function getMergeRange()
{ {
@ -539,9 +539,9 @@ class Cell
} }
/** /**
* Get cell style. * Get cell style.
* *
* @return Style * @return Style
*/ */
public function getStyle() public function getStyle()
{ {
@ -549,11 +549,11 @@ class Cell
} }
/** /**
* Re-bind parent. * Re-bind parent.
* *
* @param Worksheet $parent * @param Worksheet $parent
* *
* @return Cell * @return Cell
*/ */
public function rebindParent(Worksheet $parent) public function rebindParent(Worksheet $parent)
{ {
@ -565,9 +565,9 @@ class Cell
/** /**
* Is cell in a specific range? * Is cell in a specific range?
* *
* @param string $pRange Cell range (e.g. A1:A1) * @param string $pRange Cell range (e.g. A1:A1)
* *
* @return bool * @return bool
*/ */
public function isInRange($pRange = 'A1:A1') public function isInRange($pRange = 'A1:A1')
{ {
@ -583,13 +583,13 @@ class Cell
} }
/** /**
* Coordinate from string. * Coordinate from string.
* *
* @param string $pCoordinateString * @param string $pCoordinateString
* *
* @throws Exception * @throws Exception
* *
* @return string[] Array containing column and row (indexes 0 and 1) * @return string[] Array containing column and row (indexes 0 and 1)
*/ */
public static function coordinateFromString($pCoordinateString = 'A1') public static function coordinateFromString($pCoordinateString = 'A1')
{ {
@ -605,14 +605,14 @@ class Cell
} }
/** /**
* Make string row, column or cell coordinate absolute. * Make string row, column or cell coordinate absolute.
* *
* @param string $pCoordinateString e.g. 'A' or '1' or 'A1' * @param string $pCoordinateString e.g. 'A' or '1' or 'A1'
* Note that this value can be a row or column reference as well as a cell reference * Note that this value can be a row or column reference as well as a cell reference
* *
* @throws Exception * @throws Exception
* *
* @return string Absolute coordinate e.g. '$A' or '$1' or '$A$1' * @return string Absolute coordinate e.g. '$A' or '$1' or '$A$1'
*/ */
public static function absoluteReference($pCoordinateString = 'A1') public static function absoluteReference($pCoordinateString = 'A1')
{ {
@ -641,13 +641,13 @@ class Cell
} }
/** /**
* Make string coordinate absolute. * Make string coordinate absolute.
* *
* @param string $pCoordinateString e.g. 'A1' * @param string $pCoordinateString e.g. 'A1'
* *
* @throws Exception * @throws Exception
* *
* @return string Absolute coordinate e.g. '$A$1' * @return string Absolute coordinate e.g. '$A$1'
*/ */
public static function absoluteCoordinate($pCoordinateString = 'A1') public static function absoluteCoordinate($pCoordinateString = 'A1')
{ {
@ -674,11 +674,11 @@ class Cell
} }
/** /**
* Split range into coordinate strings. * Split range into coordinate strings.
* *
* @param string $pRange e.g. 'B4:D9' or 'B4:D9,H2:O11' or 'B4' * @param string $pRange e.g. 'B4:D9' or 'B4:D9,H2:O11' or 'B4'
* *
* @return array Array containg one or more arrays containing one or two coordinate strings * @return array Array containg one or more arrays containing one or two coordinate strings
* e.g. array('B4','D9') or array(array('B4','D9'),array('H2','O11')) * e.g. array('B4','D9') or array(array('B4','D9'),array('H2','O11'))
* or array('B4') * or array('B4')
*/ */
@ -699,13 +699,13 @@ class Cell
} }
/** /**
* Build range from coordinate strings. * Build range from coordinate strings.
* *
* @param array $pRange Array containg one or more arrays containing one or two coordinate strings * @param array $pRange Array containg one or more arrays containing one or two coordinate strings
* *
* @throws Exception * @throws Exception
* *
* @return string String representation of $pRange * @return string String representation of $pRange
*/ */
public static function buildRange($pRange) public static function buildRange($pRange)
{ {
@ -726,11 +726,11 @@ class Cell
} }
/** /**
* Calculate range boundaries. * Calculate range boundaries.
* *
* @param string $pRange Cell range (e.g. A1:A1) * @param string $pRange Cell range (e.g. A1:A1)
* *
* @return array Range coordinates array(Start Cell, End Cell) * @return array Range coordinates array(Start Cell, End Cell)
* where Start Cell and End Cell are arrays (Column Number, Row Number) * where Start Cell and End Cell are arrays (Column Number, Row Number)
*/ */
public static function rangeBoundaries($pRange = 'A1:A1') public static function rangeBoundaries($pRange = 'A1:A1')
@ -762,11 +762,11 @@ class Cell
} }
/** /**
* Calculate range dimension. * Calculate range dimension.
* *
* @param string $pRange Cell range (e.g. A1:A1) * @param string $pRange Cell range (e.g. A1:A1)
* *
* @return array Range dimension (width, height) * @return array Range dimension (width, height)
*/ */
public static function rangeDimension($pRange = 'A1:A1') public static function rangeDimension($pRange = 'A1:A1')
{ {
@ -777,11 +777,11 @@ class Cell
} }
/** /**
* Calculate range boundaries. * Calculate range boundaries.
* *
* @param string $pRange Cell range (e.g. A1:A1) * @param string $pRange Cell range (e.g. A1:A1)
* *
* @return array Range coordinates array(Start Cell, End Cell) * @return array Range coordinates array(Start Cell, End Cell)
* where Start Cell and End Cell are arrays (Column ID, Row Number) * where Start Cell and End Cell are arrays (Column ID, Row Number)
*/ */
public static function getRangeBoundaries($pRange = 'A1:A1') public static function getRangeBoundaries($pRange = 'A1:A1')
@ -805,11 +805,11 @@ class Cell
} }
/** /**
* Column index from string. * Column index from string.
* *
* @param string $pString * @param string $pString
* *
* @return int Column index (base 1 !!!) * @return int Column index (base 1 !!!)
*/ */
public static function columnIndexFromString($pString = 'A') public static function columnIndexFromString($pString = 'A')
{ {
@ -852,11 +852,11 @@ class Cell
} }
/** /**
* String from columnindex. * String from columnindex.
* *
* @param int $pColumnIndex Column index (base 0 !!!) * @param int $pColumnIndex Column index (base 0 !!!)
* *
* @return string * @return string
*/ */
public static function stringFromColumnIndex($pColumnIndex = 0) public static function stringFromColumnIndex($pColumnIndex = 0)
{ {
@ -883,11 +883,11 @@ class Cell
} }
/** /**
* Extract all cell references in range. * Extract all cell references in range.
* *
* @param string $pRange Range (e.g. A1 or A1:C10 or A1:E10 A20:E25) * @param string $pRange Range (e.g. A1 or A1:C10 or A1:E10 A20:E25)
* *
* @return array Array containing single cell references * @return array Array containing single cell references
*/ */
public static function extractAllCellReferencesInRange($pRange = 'A1') public static function extractAllCellReferencesInRange($pRange = 'A1')
{ {
@ -949,10 +949,10 @@ class Cell
/** /**
* Compare 2 cells. * Compare 2 cells.
* *
* @param Cell $a Cell a * @param Cell $a Cell a
* @param Cell $b Cell b * @param Cell $b Cell b
* *
* @return int Result of comparison (always -1 or 1, never zero!) * @return int Result of comparison (always -1 or 1, never zero!)
*/ */
public static function compareCells(Cell $a, Cell $b) public static function compareCells(Cell $a, Cell $b)
{ {

8
src/PhpSpreadsheet/Cell/AdvancedValueBinder.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Cell;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -29,8 +29,8 @@ class AdvancedValueBinder extends DefaultValueBinder implements IValueBinder
/** /**
* Bind value to a cell. * Bind value to a cell.
* *
* @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to bind value to * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to bind value to
* @param mixed $value Value to bind in cell * @param mixed $value Value to bind in cell
* *
* @return bool * @return bool
*/ */

12
src/PhpSpreadsheet/Cell/DataType.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Cell;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -64,10 +64,10 @@ class DataType
/** /**
* Check a string that it satisfies Excel requirements. * Check a string that it satisfies Excel requirements.
* *
* @param mixed Value to sanitize to an Excel string * @param mixed Value to sanitize to an Excel string
* @param null|mixed $pValue * @param null|mixed $pValue
* *
* @return mixed Sanitized value * @return mixed Sanitized value
*/ */
public static function checkString($pValue = null) public static function checkString($pValue = null)
{ {
@ -88,10 +88,10 @@ class DataType
/** /**
* Check a value that it is a valid error code. * Check a value that it is a valid error code.
* *
* @param mixed Value to sanitize to an Excel error code * @param mixed Value to sanitize to an Excel error code
* @param null|mixed $pValue * @param null|mixed $pValue
* *
* @return string Sanitized value * @return string Sanitized value
*/ */
public static function checkErrorCode($pValue = null) public static function checkErrorCode($pValue = null)
{ {

32
src/PhpSpreadsheet/Cell/DataValidation.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Cell;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -162,7 +162,7 @@ class DataValidation
/** /**
* Set Formula 1. * Set Formula 1.
* *
* @param string $value * @param string $value
* *
* @return DataValidation * @return DataValidation
*/ */
@ -186,7 +186,7 @@ class DataValidation
/** /**
* Set Formula 2. * Set Formula 2.
* *
* @param string $value * @param string $value
* *
* @return DataValidation * @return DataValidation
*/ */
@ -210,7 +210,7 @@ class DataValidation
/** /**
* Set Type. * Set Type.
* *
* @param string $value * @param string $value
* *
* @return DataValidation * @return DataValidation
*/ */
@ -234,7 +234,7 @@ class DataValidation
/** /**
* Set Error style. * Set Error style.
* *
* @param string $value * @param string $value
* *
* @return DataValidation * @return DataValidation
*/ */
@ -258,7 +258,7 @@ class DataValidation
/** /**
* Set Operator. * Set Operator.
* *
* @param string $value * @param string $value
* *
* @return DataValidation * @return DataValidation
*/ */
@ -282,7 +282,7 @@ class DataValidation
/** /**
* Set Allow Blank. * Set Allow Blank.
* *
* @param bool $value * @param bool $value
* *
* @return DataValidation * @return DataValidation
*/ */
@ -306,7 +306,7 @@ class DataValidation
/** /**
* Set Show DropDown. * Set Show DropDown.
* *
* @param bool $value * @param bool $value
* *
* @return DataValidation * @return DataValidation
*/ */
@ -330,7 +330,7 @@ class DataValidation
/** /**
* Set Show InputMessage. * Set Show InputMessage.
* *
* @param bool $value * @param bool $value
* *
* @return DataValidation * @return DataValidation
*/ */
@ -354,7 +354,7 @@ class DataValidation
/** /**
* Set Show ErrorMessage. * Set Show ErrorMessage.
* *
* @param bool $value * @param bool $value
* *
* @return DataValidation * @return DataValidation
*/ */
@ -378,7 +378,7 @@ class DataValidation
/** /**
* Set Error title. * Set Error title.
* *
* @param string $value * @param string $value
* *
* @return DataValidation * @return DataValidation
*/ */
@ -402,7 +402,7 @@ class DataValidation
/** /**
* Set Error. * Set Error.
* *
* @param string $value * @param string $value
* *
* @return DataValidation * @return DataValidation
*/ */
@ -426,7 +426,7 @@ class DataValidation
/** /**
* Set Prompt title. * Set Prompt title.
* *
* @param string $value * @param string $value
* *
* @return DataValidation * @return DataValidation
*/ */
@ -450,7 +450,7 @@ class DataValidation
/** /**
* Set Prompt. * Set Prompt.
* *
* @param string $value * @param string $value
* *
* @return DataValidation * @return DataValidation
*/ */
@ -464,7 +464,7 @@ class DataValidation
/** /**
* Get hash code. * Get hash code.
* *
* @return string Hash code * @return string Hash code
*/ */
public function getHashCode() public function getHashCode()
{ {

12
src/PhpSpreadsheet/Cell/DefaultValueBinder.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Cell;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -29,8 +29,8 @@ class DefaultValueBinder implements IValueBinder
/** /**
* Bind value to a cell. * Bind value to a cell.
* *
* @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to bind value to * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to bind value to
* @param mixed $value Value to bind in cell * @param mixed $value Value to bind in cell
* *
* @return bool * @return bool
*/ */
@ -58,9 +58,9 @@ class DefaultValueBinder implements IValueBinder
/** /**
* DataType for value. * DataType for value.
* *
* @param mixed $pValue * @param mixed $pValue
* *
* @return string * @return string
*/ */
public static function dataTypeForValue($pValue = null) public static function dataTypeForValue($pValue = null)
{ {

14
src/PhpSpreadsheet/Cell/Hyperlink.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Cell;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -43,8 +43,8 @@ class Hyperlink
/** /**
* Create a new Hyperlink. * Create a new Hyperlink.
* *
* @param string $pUrl Url to link the cell to * @param string $pUrl Url to link the cell to
* @param string $pTooltip Tooltip to display on the hyperlink * @param string $pTooltip Tooltip to display on the hyperlink
*/ */
public function __construct($pUrl = '', $pTooltip = '') public function __construct($pUrl = '', $pTooltip = '')
{ {
@ -66,7 +66,7 @@ class Hyperlink
/** /**
* Set URL. * Set URL.
* *
* @param string $value * @param string $value
* *
* @return Hyperlink * @return Hyperlink
*/ */
@ -90,7 +90,7 @@ class Hyperlink
/** /**
* Set tooltip. * Set tooltip.
* *
* @param string $value * @param string $value
* *
* @return Hyperlink * @return Hyperlink
*/ */
@ -114,7 +114,7 @@ class Hyperlink
/** /**
* Get hash code. * Get hash code.
* *
* @return string Hash code * @return string Hash code
*/ */
public function getHashCode() public function getHashCode()
{ {

8
src/PhpSpreadsheet/Cell/IValueBinder.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Cell;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -29,8 +29,8 @@ interface IValueBinder
/** /**
* Bind value to a cell. * Bind value to a cell.
* *
* @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to bind value to * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to bind value to
* @param mixed $value Value to bind in cell * @param mixed $value Value to bind in cell
* *
* @return bool * @return bool
*/ */

52
src/PhpSpreadsheet/Chart.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -205,11 +205,11 @@ class Chart
/** /**
* Set Worksheet. * Set Worksheet.
* *
* @param Worksheet $pValue * @param Worksheet $pValue
* *
* @throws Chart\Exception * @throws Chart\Exception
* *
* @return Chart * @return Chart
*/ */
public function setWorksheet(Worksheet $pValue = null) public function setWorksheet(Worksheet $pValue = null)
{ {
@ -231,9 +231,9 @@ class Chart
/** /**
* Set Title. * Set Title.
* *
* @param Chart\Title $title * @param Chart\Title $title
* *
* @return Chart * @return Chart
*/ */
public function setTitle(Chart\Title $title) public function setTitle(Chart\Title $title)
{ {
@ -255,9 +255,9 @@ class Chart
/** /**
* Set Legend. * Set Legend.
* *
* @param Chart\Legend $legend * @param Chart\Legend $legend
* *
* @return Chart * @return Chart
*/ */
public function setLegend(Chart\Legend $legend) public function setLegend(Chart\Legend $legend)
{ {
@ -279,9 +279,9 @@ class Chart
/** /**
* Set X-Axis Label. * Set X-Axis Label.
* *
* @param Chart\Title $label * @param Chart\Title $label
* *
* @return Chart * @return Chart
*/ */
public function setXAxisLabel(Chart\Title $label) public function setXAxisLabel(Chart\Title $label)
{ {
@ -303,9 +303,9 @@ class Chart
/** /**
* Set Y-Axis Label. * Set Y-Axis Label.
* *
* @param Chart\Title $label * @param Chart\Title $label
* *
* @return Chart * @return Chart
*/ */
public function setYAxisLabel(Chart\Title $label) public function setYAxisLabel(Chart\Title $label)
{ {
@ -429,9 +429,9 @@ class Chart
/** /**
* Set the Top Left position for the chart. * Set the Top Left position for the chart.
* *
* @param string $cell * @param string $cell
* @param int $xOffset * @param int $xOffset
* @param int $yOffset * @param int $yOffset
* *
* @return Chart * @return Chart
*/ */
@ -451,7 +451,7 @@ class Chart
/** /**
* Get the top left position of the chart. * Get the top left position of the chart.
* *
* @return array an associative array containing the cell address, X-Offset and Y-Offset from the top left of that cell * @return array an associative array containing the cell address, X-Offset and Y-Offset from the top left of that cell
*/ */
public function getTopLeftPosition() public function getTopLeftPosition()
{ {
@ -475,7 +475,7 @@ class Chart
/** /**
* Set the Top Left cell position for the chart. * Set the Top Left cell position for the chart.
* *
* @param string $cell * @param string $cell
* *
* @return Chart * @return Chart
*/ */
@ -489,8 +489,8 @@ class Chart
/** /**
* Set the offset position within the Top Left cell for the chart. * Set the offset position within the Top Left cell for the chart.
* *
* @param int $xOffset * @param int $xOffset
* @param int $yOffset * @param int $yOffset
* *
* @return Chart * @return Chart
*/ */
@ -546,9 +546,9 @@ class Chart
/** /**
* Set the Bottom Right position of the chart. * Set the Bottom Right position of the chart.
* *
* @param string $cell * @param string $cell
* @param int $xOffset * @param int $xOffset
* @param int $yOffset * @param int $yOffset
* *
* @return Chart * @return Chart
*/ */
@ -568,7 +568,7 @@ class Chart
/** /**
* Get the bottom right position of the chart. * Get the bottom right position of the chart.
* *
* @return array an associative array containing the cell address, X-Offset and Y-Offset from the top left of that cell * @return array an associative array containing the cell address, X-Offset and Y-Offset from the top left of that cell
*/ */
public function getBottomRightPosition() public function getBottomRightPosition()
{ {
@ -599,8 +599,8 @@ class Chart
/** /**
* Set the offset position within the Bottom Right cell for the chart. * Set the offset position within the Bottom Right cell for the chart.
* *
* @param int $xOffset * @param int $xOffset
* @param int $yOffset * @param int $yOffset
* *
* @return Chart * @return Chart
*/ */

22
src/PhpSpreadsheet/Chart/Axis.php
View File

@ -13,7 +13,7 @@ class Axis extends Properties
/** /**
* Axis Number. * Axis Number.
* *
* @var array of mixed * @var array of mixed
*/ */
private $axisNumber = [ private $axisNumber = [
'format' => self::FORMAT_CODE_GENERAL, 'format' => self::FORMAT_CODE_GENERAL,
@ -23,7 +23,7 @@ class Axis extends Properties
/** /**
* Axis Options. * Axis Options.
* *
* @var array of mixed * @var array of mixed
*/ */
private $axisOptions = [ private $axisOptions = [
'minimum' => null, 'minimum' => null,
@ -41,7 +41,7 @@ class Axis extends Properties
/** /**
* Fill Properties. * Fill Properties.
* *
* @var array of mixed * @var array of mixed
*/ */
private $fillProperties = [ private $fillProperties = [
'type' => self::EXCEL_COLOR_TYPE_ARGB, 'type' => self::EXCEL_COLOR_TYPE_ARGB,
@ -52,7 +52,7 @@ class Axis extends Properties
/** /**
* Line Properties. * Line Properties.
* *
* @var array of mixed * @var array of mixed
*/ */
private $lineProperties = [ private $lineProperties = [
'type' => self::EXCEL_COLOR_TYPE_ARGB, 'type' => self::EXCEL_COLOR_TYPE_ARGB,
@ -63,7 +63,7 @@ class Axis extends Properties
/** /**
* Line Style Properties. * Line Style Properties.
* *
* @var array of mixed * @var array of mixed
*/ */
private $lineStyleProperties = [ private $lineStyleProperties = [
'width' => '9525', 'width' => '9525',
@ -86,7 +86,7 @@ class Axis extends Properties
/** /**
* Shadow Properties. * Shadow Properties.
* *
* @var array of mixed * @var array of mixed
*/ */
private $shadowProperties = [ private $shadowProperties = [
'presets' => self::SHADOW_PRESETS_NOSHADOW, 'presets' => self::SHADOW_PRESETS_NOSHADOW,
@ -111,7 +111,7 @@ class Axis extends Properties
/** /**
* Glow Properties. * Glow Properties.
* *
* @var array of mixed * @var array of mixed
*/ */
private $glowProperties = [ private $glowProperties = [
'size' => null, 'size' => null,
@ -125,7 +125,7 @@ class Axis extends Properties
/** /**
* Soft Edge Properties. * Soft Edge Properties.
* *
* @var array of mixed * @var array of mixed
*/ */
private $softEdges = [ private $softEdges = [
'size' => null, 'size' => null,
@ -136,7 +136,7 @@ class Axis extends Properties
* *
* @param mixed $format_code * @param mixed $format_code
* *
* @return string * @return string
*/ */
public function setAxisNumberProperties($format_code) public function setAxisNumberProperties($format_code)
{ {
@ -147,7 +147,7 @@ class Axis extends Properties
/** /**
* Get Axis Number Format Data Type. * Get Axis Number Format Data Type.
* *
* @return string * @return string
*/ */
public function getAxisNumberFormat() public function getAxisNumberFormat()
{ {
@ -157,7 +157,7 @@ class Axis extends Properties
/** /**
* Get Axis Number Source Linked. * Get Axis Number Source Linked.
* *
* @return string * @return string
*/ */
public function getAxisNumberSourceLinked() public function getAxisNumberSourceLinked()
{ {

4
src/PhpSpreadsheet/Chart/DataSeries.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Chart;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *

56
src/PhpSpreadsheet/Chart/DataSeriesValues.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Chart;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -37,42 +37,42 @@ class DataSeriesValues
/** /**
* Series Data Type. * Series Data Type.
* *
* @var string * @var string
*/ */
private $dataType; private $dataType;
/** /**
* Series Data Source. * Series Data Source.
* *
* @var string * @var string
*/ */
private $dataSource; private $dataSource;
/** /**
* Format Code. * Format Code.
* *
* @var string * @var string
*/ */
private $formatCode; private $formatCode;
/** /**
* Series Point Marker. * Series Point Marker.
* *
* @var string * @var string
*/ */
private $pointMarker; private $pointMarker;
/** /**
* Point Count (The number of datapoints in the dataseries). * Point Count (The number of datapoints in the dataseries).
* *
* @var int * @var int
*/ */
private $pointCount = 0; private $pointCount = 0;
/** /**
* Data Values. * Data Values.
* *
* @var array of mixed * @var array of mixed
*/ */
private $dataValues = []; private $dataValues = [];
@ -99,7 +99,7 @@ class DataSeriesValues
/** /**
* Get Series Data Type. * Get Series Data Type.
* *
* @return string * @return string
*/ */
public function getDataType() public function getDataType()
{ {
@ -109,16 +109,16 @@ class DataSeriesValues
/** /**
* Set Series Data Type. * Set Series Data Type.
* *
* @param string $dataType Datatype of this data series * @param string $dataType Datatype of this data series
* Typical values are: * Typical values are:
* \PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::DATASERIES_TYPE_STRING * \PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::DATASERIES_TYPE_STRING
* Normally used for axis point values * Normally used for axis point values
* \PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::DATASERIES_TYPE_NUMBER * \PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::DATASERIES_TYPE_NUMBER
* Normally used for chart data values * Normally used for chart data values
* *
* @throws Exception * @throws Exception
* *
* @return DataSeriesValues * @return DataSeriesValues
*/ */
public function setDataType($dataType = self::DATASERIES_TYPE_NUMBER) public function setDataType($dataType = self::DATASERIES_TYPE_NUMBER)
{ {
@ -133,7 +133,7 @@ class DataSeriesValues
/** /**
* Get Series Data Source (formula). * Get Series Data Source (formula).
* *
* @return string * @return string
*/ */
public function getDataSource() public function getDataSource()
{ {
@ -143,10 +143,10 @@ class DataSeriesValues
/** /**
* Set Series Data Source (formula). * Set Series Data Source (formula).
* *
* @param string $dataSource * @param string $dataSource
* @param mixed $refreshDataValues * @param mixed $refreshDataValues
* *
* @return DataSeriesValues * @return DataSeriesValues
*/ */
public function setDataSource($dataSource = null, $refreshDataValues = true) public function setDataSource($dataSource = null, $refreshDataValues = true)
{ {
@ -172,9 +172,9 @@ class DataSeriesValues
/** /**
* Set Point Marker. * Set Point Marker.
* *
* @param string $marker * @param string $marker
* *
* @return DataSeriesValues * @return DataSeriesValues
*/ */
public function setPointMarker($marker = null) public function setPointMarker($marker = null)
{ {
@ -186,7 +186,7 @@ class DataSeriesValues
/** /**
* Get Series Format Code. * Get Series Format Code.
* *
* @return string * @return string
*/ */
public function getFormatCode() public function getFormatCode()
{ {
@ -196,9 +196,9 @@ class DataSeriesValues
/** /**
* Set Series Format Code. * Set Series Format Code.
* *
* @param string $formatCode * @param string $formatCode
* *
* @return DataSeriesValues * @return DataSeriesValues
*/ */
public function setFormatCode($formatCode = null) public function setFormatCode($formatCode = null)
{ {
@ -210,7 +210,7 @@ class DataSeriesValues
/** /**
* Get Series Point Count. * Get Series Point Count.
* *
* @return int * @return int
*/ */
public function getPointCount() public function getPointCount()
{ {
@ -220,7 +220,7 @@ class DataSeriesValues
/** /**
* Identify if the Data Series is a multi-level or a simple series. * Identify if the Data Series is a multi-level or a simple series.
* *
* @return bool|null * @return bool|null
*/ */
public function isMultiLevelSeries() public function isMultiLevelSeries()
{ {
@ -234,7 +234,7 @@ class DataSeriesValues
/** /**
* Return the level count of a multi-level Data Series. * Return the level count of a multi-level Data Series.
* *
* @return int * @return int
*/ */
public function multiLevelCount() public function multiLevelCount()
{ {
@ -249,7 +249,7 @@ class DataSeriesValues
/** /**
* Get Series Data Values. * Get Series Data Values.
* *
* @return array of mixed * @return array of mixed
*/ */
public function getDataValues() public function getDataValues()
{ {
@ -259,7 +259,7 @@ class DataSeriesValues
/** /**
* Get the first Series Data value. * Get the first Series Data value.
* *
* @return mixed * @return mixed
*/ */
public function getDataValue() public function getDataValue()
{ {
@ -276,12 +276,12 @@ class DataSeriesValues
/** /**
* Set Series Data Values. * Set Series Data Values.
* *
* @param array $dataValues * @param array $dataValues
* @param bool $refreshDataSource * @param bool $refreshDataSource
* TRUE - refresh the value of dataSource based on the values of $dataValues * TRUE - refresh the value of dataSource based on the values of $dataValues
* FALSE - don't change the value of dataSource * FALSE - don't change the value of dataSource
* *
* @return DataSeriesValues * @return DataSeriesValues
*/ */
public function setDataValues($dataValues = [], $refreshDataSource = true) public function setDataValues($dataValues = [], $refreshDataSource = true)
{ {

4
src/PhpSpreadsheet/Chart/Exception.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Chart;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *

10
src/PhpSpreadsheet/Chart/GridLines.php
View File

@ -177,7 +177,7 @@ class GridLines extends Properties
/** /**
* Get Line Style Property. * Get Line Style Property.
* *
* @param array|string $elements * @param array|string $elements
* *
* @return string * @return string
*/ */
@ -189,10 +189,10 @@ class GridLines extends Properties
/** /**
* Set Glow Properties. * Set Glow Properties.
* *
* @param float $size * @param float $size
* @param string $color_value * @param string $color_value
* @param int $color_alpha * @param int $color_alpha
* @param string $color_type * @param string $color_type
*/ */
public function setGlowProperties($size, $color_value = null, $color_alpha = null, $color_type = null) public function setGlowProperties($size, $color_value = null, $color_alpha = null, $color_type = null)
{ {

18
src/PhpSpreadsheet/Chart/Layout.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Chart;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -343,7 +343,7 @@ class Layout
* Set show legend key * Set show legend key
* Specifies that legend keys should be shown in data labels. * Specifies that legend keys should be shown in data labels.
* *
* @param bool $value Show legend key * @param bool $value Show legend key
* *
* @return Layout * @return Layout
*/ */
@ -368,7 +368,7 @@ class Layout
* Set show val * Set show val
* Specifies that the value should be shown in data labels. * Specifies that the value should be shown in data labels.
* *
* @param bool $value Show val * @param bool $value Show val
* *
* @return Layout * @return Layout
*/ */
@ -393,7 +393,7 @@ class Layout
* Set show cat name * Set show cat name
* Specifies that the category name should be shown in data labels. * Specifies that the category name should be shown in data labels.
* *
* @param bool $value Show cat name * @param bool $value Show cat name
* *
* @return Layout * @return Layout
*/ */
@ -418,7 +418,7 @@ class Layout
* Set show ser name * Set show ser name
* Specifies that the series name should be shown in data labels. * Specifies that the series name should be shown in data labels.
* *
* @param bool $value Show series name * @param bool $value Show series name
* *
* @return Layout * @return Layout
*/ */
@ -443,7 +443,7 @@ class Layout
* Set show percentage * Set show percentage
* Specifies that the percentage should be shown in data labels. * Specifies that the percentage should be shown in data labels.
* *
* @param bool $value Show percentage * @param bool $value Show percentage
* *
* @return Layout * @return Layout
*/ */
@ -468,7 +468,7 @@ class Layout
* Set show bubble size * Set show bubble size
* Specifies that the bubble size should be shown in data labels. * Specifies that the bubble size should be shown in data labels.
* *
* @param bool $value Show bubble size * @param bool $value Show bubble size
* *
* @return Layout * @return Layout
*/ */
@ -493,7 +493,7 @@ class Layout
* Set show leader lines * Set show leader lines
* Specifies that leader lines should be shown in data labels. * Specifies that leader lines should be shown in data labels.
* *
* @param bool $value Show leader lines * @param bool $value Show leader lines
* *
* @return Layout * @return Layout
*/ */

26
src/PhpSpreadsheet/Chart/Legend.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Chart;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -52,26 +52,26 @@ class Legend
/** /**
* Legend position. * Legend position.
* *
* @var string * @var string
*/ */
private $position = self::POSITION_RIGHT; private $position = self::POSITION_RIGHT;
/** /**
* Allow overlay of other elements? * Allow overlay of other elements?
* *
* @var bool * @var bool
*/ */
private $overlay = true; private $overlay = true;
/** /**
* Legend Layout. * Legend Layout.
* *
* @var Layout * @var Layout
*/ */
private $layout = null; private $layout = null;
/** /**
* Create a new Legend. * Create a new Legend.
* *
* @param mixed $position * @param mixed $position
* @param mixed $overlay * @param mixed $overlay
@ -86,7 +86,7 @@ class Legend
/** /**
* Get legend position as an excel string value. * Get legend position as an excel string value.
* *
* @return string * @return string
*/ */
public function getPosition() public function getPosition()
{ {
@ -96,7 +96,7 @@ class Legend
/** /**
* Get legend position using an excel string value. * Get legend position using an excel string value.
* *
* @param string $position * @param string $position
*/ */
public function setPosition($position = self::POSITION_RIGHT) public function setPosition($position = self::POSITION_RIGHT)
{ {
@ -112,7 +112,7 @@ class Legend
/** /**
* Get legend position as an Excel internal numeric value. * Get legend position as an Excel internal numeric value.
* *
* @return number * @return number
*/ */
public function getPositionXL() public function getPositionXL()
{ {
@ -122,7 +122,7 @@ class Legend
/** /**
* Set legend position using an Excel internal numeric value. * Set legend position using an Excel internal numeric value.
* *
* @param number $positionXL * @param number $positionXL
*/ */
public function setPositionXL($positionXL = self::XL_LEGEND_POSITION_RIGHT) public function setPositionXL($positionXL = self::XL_LEGEND_POSITION_RIGHT)
{ {
@ -138,7 +138,7 @@ class Legend
/** /**
* Get allow overlay of other elements? * Get allow overlay of other elements?
* *
* @return bool * @return bool
*/ */
public function getOverlay() public function getOverlay()
{ {
@ -148,9 +148,9 @@ class Legend
/** /**
* Set allow overlay of other elements? * Set allow overlay of other elements?
* *
* @param bool $overlay * @param bool $overlay
* *
* @return bool * @return bool
*/ */
public function setOverlay($overlay = false) public function setOverlay($overlay = false)
{ {

6
src/PhpSpreadsheet/Chart/PlotArea.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Chart;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -111,7 +111,7 @@ class PlotArea
/** /**
* Set Plot Series. * Set Plot Series.
* *
* @param DataSeries[] * @param DataSeries[]
* @param mixed $plotSeries * @param mixed $plotSeries
* *
* @return PlotArea * @return PlotArea

4
src/PhpSpreadsheet/Chart/Renderer/JpGraph.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Chart\Renderer;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *

4
src/PhpSpreadsheet/Chart/Title.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Chart;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *

6
src/PhpSpreadsheet/Comment.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -308,7 +308,7 @@ class Comment implements IComparable
/** /**
* Get hash code. * Get hash code.
* *
* @return string Hash code * @return string Hash code
*/ */
public function getHashCode() public function getHashCode()
{ {

4
src/PhpSpreadsheet/Document/Properties.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Document;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *

12
src/PhpSpreadsheet/Document/Security.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Document;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -165,8 +165,8 @@ class Security
/** /**
* Set RevisionsPassword. * Set RevisionsPassword.
* *
* @param string $pValue * @param string $pValue
* @param bool $pAlreadyHashed If the password has already been hashed, set this to true * @param bool $pAlreadyHashed If the password has already been hashed, set this to true
* *
* @return Security * @return Security
*/ */
@ -193,8 +193,8 @@ class Security
/** /**
* Set WorkbookPassword. * Set WorkbookPassword.
* *
* @param string $pValue * @param string $pValue
* @param bool $pAlreadyHashed If the password has already been hashed, set this to true * @param bool $pAlreadyHashed If the password has already been hashed, set this to true
* *
* @return Security * @return Security
*/ */

4
src/PhpSpreadsheet/Exception.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *

32
src/PhpSpreadsheet/HashTable.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -43,9 +43,9 @@ class HashTable
/** /**
* Create a new \PhpOffice\PhpSpreadsheet\HashTable. * Create a new \PhpOffice\PhpSpreadsheet\HashTable.
* *
* @param IComparable[] $pSource Optional source array to create HashTable from * @param IComparable[] $pSource Optional source array to create HashTable from
* *
* @throws Exception * @throws Exception
*/ */
public function __construct($pSource = null) public function __construct($pSource = null)
{ {
@ -58,9 +58,9 @@ class HashTable
/** /**
* Add HashTable items from source. * Add HashTable items from source.
* *
* @param IComparable[] $pSource Source array to create HashTable from * @param IComparable[] $pSource Source array to create HashTable from
* *
* @throws Exception * @throws Exception
*/ */
public function addFromSource($pSource = null) public function addFromSource($pSource = null)
{ {
@ -79,9 +79,9 @@ class HashTable
/** /**
* Add HashTable item. * Add HashTable item.
* *
* @param IComparable $pSource Item to add * @param IComparable $pSource Item to add
* *
* @throws Exception * @throws Exception
*/ */
public function add(IComparable $pSource = null) public function add(IComparable $pSource = null)
{ {
@ -95,9 +95,9 @@ class HashTable
/** /**
* Remove HashTable item. * Remove HashTable item.
* *
* @param IComparable $pSource Item to remove * @param IComparable $pSource Item to remove
* *
* @throws Exception * @throws Exception
*/ */
public function remove(IComparable $pSource = null) public function remove(IComparable $pSource = null)
{ {
@ -141,9 +141,9 @@ class HashTable
/** /**
* Get index for hash code. * Get index for hash code.
* *
* @param string $pHashCode * @param string $pHashCode
* *
* @return int Index * @return int Index
*/ */
public function getIndexForHashCode($pHashCode = '') public function getIndexForHashCode($pHashCode = '')
{ {
@ -153,9 +153,9 @@ class HashTable
/** /**
* Get by index. * Get by index.
* *
* @param int $pIndex * @param int $pIndex
* *
* @return IComparable * @return IComparable
*/ */
public function getByIndex($pIndex = 0) public function getByIndex($pIndex = 0)
{ {
@ -169,9 +169,9 @@ class HashTable
/** /**
* Get by hashcode. * Get by hashcode.
* *
* @param string $pHashCode * @param string $pHashCode
* *
* @return IComparable * @return IComparable
*/ */
public function getByHashCode($pHashCode = '') public function getByHashCode($pHashCode = '')
{ {

4
src/PhpSpreadsheet/Helper/Html.php
View File

@ -17,12 +17,12 @@ use DOMText;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *

6
src/PhpSpreadsheet/IComparable.php
View File

@ -10,12 +10,12 @@ namespace PhpOffice\PhpSpreadsheet;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -27,7 +27,7 @@ interface IComparable
/** /**
* Get hash code. * Get hash code.
* *
* @return string Hash code * @return string Hash code
*/ */
public function getHashCode(); public function getHashCode();
} }

54
src/PhpSpreadsheet/IOFactory.php
View File

@ -14,12 +14,12 @@ use PhpOffice\PhpSpreadsheet\Shared\File;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -31,7 +31,7 @@ class IOFactory
/** /**
* Search locations. * Search locations.
* *
* @var array * @var array
* @static * @static
*/ */
private static $searchLocations = [ private static $searchLocations = [
@ -42,7 +42,7 @@ class IOFactory
/** /**
* Autoresolve classes. * Autoresolve classes.
* *
* @var array * @var array
* @static * @static
*/ */
private static $autoResolveClasses = [ private static $autoResolveClasses = [
@ -57,7 +57,7 @@ class IOFactory
]; ];
/** /**
* Private constructor for IOFactory. * Private constructor for IOFactory.
*/ */
private function __construct() private function __construct()
{ {
@ -68,7 +68,7 @@ class IOFactory
* *
* @static * @static
* *
* @return array * @return array
*/ */
public static function getSearchLocations() public static function getSearchLocations()
{ {
@ -80,9 +80,9 @@ class IOFactory
* *
* @static * @static
* *
* @param array $value * @param array $value
* *
* @throws Reader\Exception * @throws Reader\Exception
*/ */
public static function setSearchLocations($value) public static function setSearchLocations($value)
{ {
@ -98,9 +98,9 @@ class IOFactory
* *
* @static * @static
* *
* @param string $type Example: IWriter * @param string $type Example: IWriter
* @param string $location Example: PhpSpreadsheet/Writer/{0}.php * @param string $location Example: PhpSpreadsheet/Writer/{0}.php
* @param string $classname Example: Writer\{0} * @param string $classname Example: Writer\{0}
*/ */
public static function addSearchLocation($type = '', $location = '', $classname = '') public static function addSearchLocation($type = '', $location = '', $classname = '')
{ {
@ -112,12 +112,12 @@ class IOFactory
* *
* @static * @static
* *
* @param Spreadsheet $spreadsheet * @param Spreadsheet $spreadsheet
* @param string $writerType Example: Xlsx * @param string $writerType Example: Xlsx
* *
* @throws Writer\Exception * @throws Writer\Exception
* *
* @return Writer\IWriter * @return Writer\IWriter
*/ */
public static function createWriter(Spreadsheet $spreadsheet, $writerType) public static function createWriter(Spreadsheet $spreadsheet, $writerType)
{ {
@ -145,11 +145,11 @@ class IOFactory
* *
* @static * @static
* *
* @param string $readerType Example: Xlsx * @param string $readerType Example: Xlsx
* *
* @throws Reader\Exception * @throws Reader\Exception
* *
* @return Reader\IReader * @return Reader\IReader
*/ */
public static function createReader($readerType = '') public static function createReader($readerType = '')
{ {
@ -177,11 +177,11 @@ class IOFactory
* *
* @static * @static
* *
* @param string $pFilename The name of the spreadsheet file * @param string $pFilename The name of the spreadsheet file
* *
* @throws Reader\Exception * @throws Reader\Exception
* *
* @return Spreadsheet * @return Spreadsheet
*/ */
public static function load($pFilename) public static function load($pFilename)
{ {
@ -195,11 +195,11 @@ class IOFactory
* *
* @static * @static
* *
* @param string $pFilename The name of the spreadsheet file to identify * @param string $pFilename The name of the spreadsheet file to identify
* *
* @throws Reader\Exception * @throws Reader\Exception
* *
* @return string * @return string
*/ */
public static function identify($pFilename) public static function identify($pFilename)
{ {
@ -216,11 +216,11 @@ class IOFactory
* *
* @static * @static
* *
* @param string $pFilename The name of the spreadsheet file * @param string $pFilename The name of the spreadsheet file
* *
* @throws Reader\Exception * @throws Reader\Exception
* *
* @return Reader\IReader * @return Reader\IReader
*/ */
public static function createReaderForFile($pFilename) public static function createReaderForFile($pFilename)
{ {

6
src/PhpSpreadsheet/NamedRange.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -68,7 +68,7 @@ class NamedRange
* @param Worksheet $pWorksheet * @param Worksheet $pWorksheet
* @param string $pRange * @param string $pRange
* @param bool $pLocalOnly * @param bool $pLocalOnly
* @param Worksheet|null $pScope Scope. Only applies when $pLocalOnly = true. Null for global scope. * @param Worksheet|null $pScope Scope. Only applies when $pLocalOnly = true. Null for global scope.
* *
* @throws Exception * @throws Exception
*/ */

34
src/PhpSpreadsheet/Reader/BaseReader.php
View File

@ -14,12 +14,12 @@ use PhpOffice\PhpSpreadsheet\Shared\File;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -33,7 +33,7 @@ abstract class BaseReader implements IReader
* Identifies whether the Reader should only read data values for cells, and ignore any formatting information; * Identifies whether the Reader should only read data values for cells, and ignore any formatting information;
* or whether it should read both data and formatting. * or whether it should read both data and formatting.
* *
* @var bool * @var bool
*/ */
protected $readDataOnly = false; protected $readDataOnly = false;
@ -42,7 +42,7 @@ abstract class BaseReader implements IReader
* Identifies whether the Reader should read data values for cells all cells, or should ignore cells containing * Identifies whether the Reader should read data values for cells all cells, or should ignore cells containing
* null value or empty string. * null value or empty string.
* *
* @var bool * @var bool
*/ */
protected $readEmptyCells = true; protected $readEmptyCells = true;
@ -50,7 +50,7 @@ abstract class BaseReader implements IReader
* Read charts that are defined in the workbook? * Read charts that are defined in the workbook?
* Identifies whether the Reader should read the definitions for any charts that exist in the workbook;. * Identifies whether the Reader should read the definitions for any charts that exist in the workbook;.
* *
* @var bool * @var bool
*/ */
protected $includeCharts = false; protected $includeCharts = false;
@ -76,7 +76,7 @@ abstract class BaseReader implements IReader
* If this is true, then the Reader will only read data values for cells, it will not read any formatting information. * If this is true, then the Reader will only read data values for cells, it will not read any formatting information.
* If false (the default) it will read data and formatting. * If false (the default) it will read data and formatting.
* *
* @return bool * @return bool
*/ */
public function getReadDataOnly() public function getReadDataOnly()
{ {
@ -88,9 +88,9 @@ abstract class BaseReader implements IReader
* Set to true, to advise the Reader only to read data values for cells, and to ignore any formatting information. * Set to true, to advise the Reader only to read data values for cells, and to ignore any formatting information.
* Set to false (the default) to advise the Reader to read both data and formatting for cells. * Set to false (the default) to advise the Reader to read both data and formatting for cells.
* *
* @param bool $pValue * @param bool $pValue
* *
* @return IReader * @return IReader
*/ */
public function setReadDataOnly($pValue = false) public function setReadDataOnly($pValue = false)
{ {
@ -104,7 +104,7 @@ abstract class BaseReader implements IReader
* If this is true (the default), then the Reader will read data values for all cells, irrespective of value. * If this is true (the default), then the Reader will read data values for all cells, irrespective of value.
* If false it will not read data for cells containing a null value or an empty string. * If false it will not read data for cells containing a null value or an empty string.
* *
* @return bool * @return bool
*/ */
public function getReadEmptyCells() public function getReadEmptyCells()
{ {
@ -116,9 +116,9 @@ abstract class BaseReader implements IReader
* Set to true (the default) to advise the Reader read data values for all cells, irrespective of value. * Set to true (the default) to advise the Reader read data values for all cells, irrespective of value.
* Set to false to advise the Reader to ignore cells containing a null value or an empty string. * Set to false to advise the Reader to ignore cells containing a null value or an empty string.
* *
* @param bool $pValue * @param bool $pValue
* *
* @return IReader * @return IReader
*/ */
public function setReadEmptyCells($pValue = true) public function setReadEmptyCells($pValue = true)
{ {
@ -133,7 +133,7 @@ abstract class BaseReader implements IReader
* Note that a ReadDataOnly value of false overrides, and charts won't be read regardless of the IncludeCharts value. * Note that a ReadDataOnly value of false overrides, and charts won't be read regardless of the IncludeCharts value.
* If false (the default) it will ignore any charts defined in the workbook file. * If false (the default) it will ignore any charts defined in the workbook file.
* *
* @return bool * @return bool
*/ */
public function getIncludeCharts() public function getIncludeCharts()
{ {
@ -146,9 +146,9 @@ abstract class BaseReader implements IReader
* Note that a ReadDataOnly value of false overrides, and charts won't be read regardless of the IncludeCharts value. * Note that a ReadDataOnly value of false overrides, and charts won't be read regardless of the IncludeCharts value.
* Set to false (the default) to discard charts. * Set to false (the default) to discard charts.
* *
* @param bool $pValue * @param bool $pValue
* *
* @return IReader * @return IReader
*/ */
public function setIncludeCharts($pValue = false) public function setIncludeCharts($pValue = false)
{ {
@ -231,7 +231,7 @@ abstract class BaseReader implements IReader
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception * @throws Exception
* *
* @return resource * @return resource
*/ */
@ -249,7 +249,7 @@ abstract class BaseReader implements IReader
/** /**
* Scan theXML for use of <!ENTITY to prevent XXE/XEE attacks. * Scan theXML for use of <!ENTITY to prevent XXE/XEE attacks.
* *
* @param string $xml * @param string $xml
* *
* @throws Exception * @throws Exception
*/ */
@ -266,7 +266,7 @@ abstract class BaseReader implements IReader
/** /**
* Scan theXML for use of <!ENTITY to prevent XXE/XEE attacks. * Scan theXML for use of <!ENTITY to prevent XXE/XEE attacks.
* *
* @param string $filestream * @param string $filestream
* *
* @throws Exception * @throws Exception
*/ */

34
src/PhpSpreadsheet/Reader/Csv.php
View File

@ -14,12 +14,12 @@ use PhpOffice\PhpSpreadsheet\Spreadsheet;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -31,7 +31,7 @@ class Csv extends BaseReader implements IReader
/** /**
* Input encoding. * Input encoding.
* *
* @var string * @var string
*/ */
private $inputEncoding = 'UTF-8'; private $inputEncoding = 'UTF-8';
@ -45,28 +45,28 @@ class Csv extends BaseReader implements IReader
/** /**
* Enclosure. * Enclosure.
* *
* @var string * @var string
*/ */
private $enclosure = '"'; private $enclosure = '"';
/** /**
* Sheet index to read. * Sheet index to read.
* *
* @var int * @var int
*/ */
private $sheetIndex = 0; private $sheetIndex = 0;
/** /**
* Load rows contiguously. * Load rows contiguously.
* *
* @var bool * @var bool
*/ */
private $contiguous = false; private $contiguous = false;
/** /**
* Row counter for loading rows contiguously. * Row counter for loading rows contiguously.
* *
* @var int * @var int
*/ */
private $contiguousRow = -1; private $contiguousRow = -1;
@ -155,9 +155,9 @@ class Csv extends BaseReader implements IReader
/** /**
* Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns). * Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns).
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception * @throws Exception
*/ */
public function listWorksheetInfo($pFilename) public function listWorksheetInfo($pFilename)
{ {
@ -199,7 +199,7 @@ class Csv extends BaseReader implements IReader
/** /**
* Loads Spreadsheet from file. * Loads Spreadsheet from file.
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception * @throws Exception
* *
@ -304,9 +304,9 @@ class Csv extends BaseReader implements IReader
/** /**
* Set delimiter. * Set delimiter.
* *
* @param string $pValue Delimiter, defaults to , * @param string $pValue Delimiter, defaults to ,
* *
* @return CSV * @return CSV
*/ */
public function setDelimiter($pValue = ',') public function setDelimiter($pValue = ',')
{ {
@ -328,9 +328,9 @@ class Csv extends BaseReader implements IReader
/** /**
* Set enclosure. * Set enclosure.
* *
* @param string $pValue Enclosure, defaults to " * @param string $pValue Enclosure, defaults to "
* *
* @return CSV * @return CSV
*/ */
public function setEnclosure($pValue = '"') public function setEnclosure($pValue = '"')
{ {
@ -355,9 +355,9 @@ class Csv extends BaseReader implements IReader
/** /**
* Set sheet index. * Set sheet index.
* *
* @param int $pValue Sheet index * @param int $pValue Sheet index
* *
* @return CSV * @return CSV
*/ */
public function setSheetIndex($pValue = 0) public function setSheetIndex($pValue = 0)
{ {
@ -394,7 +394,7 @@ class Csv extends BaseReader implements IReader
/** /**
* Can the current IReader read the file? * Can the current IReader read the file?
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception * @throws Exception
* *

12
src/PhpSpreadsheet/Reader/DefaultReadFilter.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Reader;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -29,11 +29,11 @@ class DefaultReadFilter implements IReadFilter
/** /**
* Should this cell be read? * Should this cell be read?
* *
* @param $column Column address (as a string value like "A", or "IV") * @param $column Column address (as a string value like "A", or "IV")
* @param $row Row number * @param $row Row number
* @param $worksheetName Optional worksheet name * @param $worksheetName Optional worksheet name
* *
* @return bool * @return bool
*/ */
public function readCell($column, $row, $worksheetName = '') public function readCell($column, $row, $worksheetName = '')
{ {

4
src/PhpSpreadsheet/Reader/Exception.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Reader;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *

30
src/PhpSpreadsheet/Reader/Gnumeric.php
View File

@ -16,12 +16,12 @@ use PhpOffice\PhpSpreadsheet\Spreadsheet;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -58,11 +58,11 @@ class Gnumeric extends BaseReader implements IReader
/** /**
* Can the current IReader read the file? * Can the current IReader read the file?
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception * @throws Exception
* *
* @return bool * @return bool
*/ */
public function canRead($pFilename) public function canRead($pFilename)
{ {
@ -88,9 +88,9 @@ class Gnumeric extends BaseReader implements IReader
/** /**
* Reads names of the worksheets from a file, without parsing the whole file to a Spreadsheet object. * Reads names of the worksheets from a file, without parsing the whole file to a Spreadsheet object.
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception * @throws Exception
*/ */
public function listWorksheetNames($pFilename) public function listWorksheetNames($pFilename)
{ {
@ -117,9 +117,9 @@ class Gnumeric extends BaseReader implements IReader
/** /**
* Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns). * Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns).
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception * @throws Exception
*/ */
public function listWorksheetInfo($pFilename) public function listWorksheetInfo($pFilename)
{ {
@ -182,11 +182,11 @@ class Gnumeric extends BaseReader implements IReader
/** /**
* Loads Spreadsheet from file. * Loads Spreadsheet from file.
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception * @throws Exception
* *
* @return Spreadsheet * @return Spreadsheet
*/ */
public function load($pFilename) public function load($pFilename)
{ {
@ -200,12 +200,12 @@ class Gnumeric extends BaseReader implements IReader
/** /**
* Loads from file into Spreadsheet instance. * Loads from file into Spreadsheet instance.
* *
* @param string $pFilename * @param string $pFilename
* @param Spreadsheet $spreadsheet * @param Spreadsheet $spreadsheet
* *
* @throws Exception * @throws Exception
* *
* @return Spreadsheet * @return Spreadsheet
*/ */
public function loadIntoExisting($pFilename, Spreadsheet $spreadsheet) public function loadIntoExisting($pFilename, Spreadsheet $spreadsheet)
{ {

16
src/PhpSpreadsheet/Reader/Html.php
View File

@ -18,12 +18,12 @@ use PhpOffice\PhpSpreadsheet\Spreadsheet;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -127,7 +127,7 @@ class Html extends BaseReader implements IReader
/** /**
* Validate that the current file is an HTML file. * Validate that the current file is an HTML file.
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception * @throws Exception
* *
@ -190,7 +190,7 @@ class Html extends BaseReader implements IReader
/** /**
* Loads Spreadsheet from file. * Loads Spreadsheet from file.
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception * @throws Exception
* *
@ -499,8 +499,8 @@ class Html extends BaseReader implements IReader
/** /**
* Loads PhpSpreadsheet from file into PhpSpreadsheet instance. * Loads PhpSpreadsheet from file into PhpSpreadsheet instance.
* *
* @param string $pFilename * @param string $pFilename
* @param Spreadsheet $spreadsheet * @param Spreadsheet $spreadsheet
* *
* @throws Exception * @throws Exception
* *
@ -552,7 +552,7 @@ class Html extends BaseReader implements IReader
/** /**
* Set sheet index. * Set sheet index.
* *
* @param int $pValue Sheet index * @param int $pValue Sheet index
* *
* @return HTML * @return HTML
*/ */
@ -566,7 +566,7 @@ class Html extends BaseReader implements IReader
/** /**
* Scan theXML for use of <!ENTITY to prevent XXE/XEE attacks. * Scan theXML for use of <!ENTITY to prevent XXE/XEE attacks.
* *
* @param string $xml * @param string $xml
* *
* @throws Exception * @throws Exception
*/ */

12
src/PhpSpreadsheet/Reader/IReadFilter.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Reader;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -29,11 +29,11 @@ interface IReadFilter
/** /**
* Should this cell be read? * Should this cell be read?
* *
* @param $column Column address (as a string value like "A", or "IV") * @param $column Column address (as a string value like "A", or "IV")
* @param $row Row number * @param $row Row number
* @param $worksheetName Optional worksheet name * @param $worksheetName Optional worksheet name
* *
* @return bool * @return bool
*/ */
public function readCell($column, $row, $worksheetName = ''); public function readCell($column, $row, $worksheetName = '');
} }

12
src/PhpSpreadsheet/Reader/IReader.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Reader;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -29,18 +29,18 @@ interface IReader
/** /**
* Can the current IReader read the file? * Can the current IReader read the file?
* *
* @param string $pFilename * @param string $pFilename
* *
* @return bool * @return bool
*/ */
public function canRead($pFilename); public function canRead($pFilename);
/** /**
* Loads PhpSpreadsheet from file. * Loads PhpSpreadsheet from file.
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception * @throws Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Spreadsheet * @return \PhpOffice\PhpSpreadsheet\Spreadsheet
*/ */

30
src/PhpSpreadsheet/Reader/Ods.php
View File

@ -16,12 +16,12 @@ use PhpOffice\PhpSpreadsheet\Shared\File;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -48,11 +48,11 @@ class Ods extends BaseReader implements IReader
/** /**
* Can the current IReader read the file? * Can the current IReader read the file?
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception * @throws Exception
* *
* @return bool * @return bool
*/ */
public function canRead($pFilename) public function canRead($pFilename)
{ {
@ -98,9 +98,9 @@ class Ods extends BaseReader implements IReader
/** /**
* Reads names of the worksheets from a file, without parsing the whole file to a PhpSpreadsheet object. * Reads names of the worksheets from a file, without parsing the whole file to a PhpSpreadsheet object.
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception * @throws Exception
*/ */
public function listWorksheetNames($pFilename) public function listWorksheetNames($pFilename)
{ {
@ -152,9 +152,9 @@ class Ods extends BaseReader implements IReader
/** /**
* Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns). * Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns).
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception * @throws Exception
*/ */
public function listWorksheetInfo($pFilename) public function listWorksheetInfo($pFilename)
{ {
@ -244,11 +244,11 @@ class Ods extends BaseReader implements IReader
/** /**
* Loads PhpSpreadsheet from file. * Loads PhpSpreadsheet from file.
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception * @throws Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Spreadsheet * @return \PhpOffice\PhpSpreadsheet\Spreadsheet
*/ */
public function load($pFilename) public function load($pFilename)
{ {
@ -276,12 +276,12 @@ class Ods extends BaseReader implements IReader
/** /**
* Loads PhpSpreadsheet from file into PhpSpreadsheet instance. * Loads PhpSpreadsheet from file into PhpSpreadsheet instance.
* *
* @param string $pFilename * @param string $pFilename
* @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet
* *
* @throws Exception * @throws Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Spreadsheet * @return \PhpOffice\PhpSpreadsheet\Spreadsheet
*/ */
public function loadIntoExisting($pFilename, \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet) public function loadIntoExisting($pFilename, \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet)
{ {

26
src/PhpSpreadsheet/Reader/Slk.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Reader;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -65,7 +65,7 @@ class Slk extends BaseReader implements IReader
/** /**
* Validate that the current file is a SYLK file. * Validate that the current file is a SYLK file.
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception * @throws Exception
* *
@ -121,9 +121,9 @@ class Slk extends BaseReader implements IReader
/** /**
* Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns). * Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns).
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception * @throws Exception
*/ */
public function listWorksheetInfo($pFilename) public function listWorksheetInfo($pFilename)
{ {
@ -190,11 +190,11 @@ class Slk extends BaseReader implements IReader
/** /**
* Loads PhpSpreadsheet from file. * Loads PhpSpreadsheet from file.
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception * @throws Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Spreadsheet * @return \PhpOffice\PhpSpreadsheet\Spreadsheet
*/ */
public function load($pFilename) public function load($pFilename)
{ {
@ -208,12 +208,12 @@ class Slk extends BaseReader implements IReader
/** /**
* Loads PhpSpreadsheet from file into PhpSpreadsheet instance. * Loads PhpSpreadsheet from file into PhpSpreadsheet instance.
* *
* @param string $pFilename * @param string $pFilename
* @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet
* *
* @throws Exception * @throws Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Spreadsheet * @return \PhpOffice\PhpSpreadsheet\Spreadsheet
*/ */
public function loadIntoExisting($pFilename, \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet) public function loadIntoExisting($pFilename, \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet)
{ {
@ -470,7 +470,7 @@ class Slk extends BaseReader implements IReader
/** /**
* Set sheet index. * Set sheet index.
* *
* @param int $pValue Sheet index * @param int $pValue Sheet index
* *
* @return SYLK * @return SYLK
*/ */

40
src/PhpSpreadsheet/Reader/Xls.php
View File

@ -14,12 +14,12 @@ use PhpOffice\PhpSpreadsheet\Shared\File;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -414,11 +414,11 @@ class Xls extends BaseReader implements IReader
/** /**
* Can the current IReader read the file? * Can the current IReader read the file?
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception * @throws Exception
* *
* @return bool * @return bool
*/ */
public function canRead($pFilename) public function canRead($pFilename)
{ {
@ -440,9 +440,9 @@ class Xls extends BaseReader implements IReader
/** /**
* Reads names of the worksheets from a file, without parsing the whole file to a PhpSpreadsheet object. * Reads names of the worksheets from a file, without parsing the whole file to a PhpSpreadsheet object.
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception * @throws Exception
*/ */
public function listWorksheetNames($pFilename) public function listWorksheetNames($pFilename)
{ {
@ -494,9 +494,9 @@ class Xls extends BaseReader implements IReader
/** /**
* Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns). * Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns).
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception * @throws Exception
*/ */
public function listWorksheetInfo($pFilename) public function listWorksheetInfo($pFilename)
{ {
@ -598,11 +598,11 @@ class Xls extends BaseReader implements IReader
/** /**
* Loads PhpSpreadsheet from file. * Loads PhpSpreadsheet from file.
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception * @throws Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Spreadsheet * @return \PhpOffice\PhpSpreadsheet\Spreadsheet
*/ */
public function load($pFilename) public function load($pFilename)
{ {
@ -1202,9 +1202,9 @@ class Xls extends BaseReader implements IReader
/** /**
* Read record data from stream, decrypting as required. * Read record data from stream, decrypting as required.
* *
* @param string $data Data stream to read from * @param string $data Data stream to read from
* @param int $pos Position to start reading from * @param int $pos Position to start reading from
* @param int $len Record data length * @param int $len Record data length
* *
* @return string Record data * @return string Record data
*/ */
@ -1603,7 +1603,7 @@ class Xls extends BaseReader implements IReader
} }
/** /**
* The TEXT Object record contains the text associated with a cell annotation. * The TEXT Object record contains the text associated with a cell annotation.
*/ */
private function readTextObject() private function readTextObject()
{ {
@ -1715,7 +1715,7 @@ class Xls extends BaseReader implements IReader
/** /**
* Make an RC4 decryptor for the given block. * Make an RC4 decryptor for the given block.
* *
* @param int Block for which to create decrypto * @param int Block for which to create decrypto
* @param string $valContext MD5 context state * @param string $valContext MD5 context state
* @param mixed $block * @param mixed $block
* *
@ -1748,11 +1748,11 @@ class Xls extends BaseReader implements IReader
/** /**
* Verify RC4 file password. * Verify RC4 file password.
* *
* @param string $password Password to check * @param string $password Password to check
* @param string $docid Document id * @param string $docid Document id
* @param string $salt_data Salt data * @param string $salt_data Salt data
* @param string $hashedsalt_data Hashed salt data * @param string $hashedsalt_data Hashed salt data
* @param string $valContext Set to the MD5 context of the value * @param string $valContext Set to the MD5 context of the value
* *
* @return bool Success * @return bool Success
*/ */

4
src/PhpSpreadsheet/Reader/Xls/Escher.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Reader\Xls;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *

4
src/PhpSpreadsheet/Reader/Xls/MD5.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Reader\Xls;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *

4
src/PhpSpreadsheet/Reader/Xls/RC4.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Reader\Xls;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *

28
src/PhpSpreadsheet/Reader/Xlsx.php
View File

@ -31,12 +31,12 @@ use PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -71,11 +71,11 @@ class Xlsx extends BaseReader implements IReader
/** /**
* Can the current IReader read the file? * Can the current IReader read the file?
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception * @throws Exception
* *
* @return bool * @return bool
*/ */
public function canRead($pFilename) public function canRead($pFilename)
{ {
@ -121,11 +121,11 @@ class Xlsx extends BaseReader implements IReader
/** /**
* Reads names of the worksheets from a file, without parsing the whole file to a Spreadsheet object. * Reads names of the worksheets from a file, without parsing the whole file to a Spreadsheet object.
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception * @throws Exception
* *
* @return array * @return array
*/ */
public function listWorksheetNames($pFilename) public function listWorksheetNames($pFilename)
{ {
@ -167,11 +167,11 @@ class Xlsx extends BaseReader implements IReader
/** /**
* Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns). * Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns).
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception * @throws Exception
* *
* @return array * @return array
*/ */
public function listWorksheetInfo($pFilename) public function listWorksheetInfo($pFilename)
{ {
@ -352,11 +352,11 @@ class Xlsx extends BaseReader implements IReader
/** /**
* Loads Spreadsheet from file. * Loads Spreadsheet from file.
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception * @throws Exception
* *
* @return Spreadsheet * @return Spreadsheet
*/ */
public function load($pFilename) public function load($pFilename)
{ {

4
src/PhpSpreadsheet/Reader/Xlsx/Chart.php
View File

@ -14,12 +14,12 @@ use PhpOffice\PhpSpreadsheet\Calculation\Functions;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *

4
src/PhpSpreadsheet/Reader/Xlsx/Theme.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Reader\Xlsx;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *

30
src/PhpSpreadsheet/Reader/Xml.php
View File

@ -15,12 +15,12 @@ use PhpOffice\PhpSpreadsheet\Spreadsheet;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -58,11 +58,11 @@ class Xml extends BaseReader implements IReader
/** /**
* Can the current IReader read the file? * Can the current IReader read the file?
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception * @throws Exception
* *
* @return bool * @return bool
*/ */
public function canRead($pFilename) public function canRead($pFilename)
{ {
@ -110,9 +110,9 @@ class Xml extends BaseReader implements IReader
/** /**
* Reads names of the worksheets from a file, without parsing the whole file to a Spreadsheet object. * Reads names of the worksheets from a file, without parsing the whole file to a Spreadsheet object.
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception * @throws Exception
*/ */
public function listWorksheetNames($pFilename) public function listWorksheetNames($pFilename)
{ {
@ -142,9 +142,9 @@ class Xml extends BaseReader implements IReader
/** /**
* Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns). * Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns).
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception * @throws Exception
*/ */
public function listWorksheetInfo($pFilename) public function listWorksheetInfo($pFilename)
{ {
@ -214,11 +214,11 @@ class Xml extends BaseReader implements IReader
/** /**
* Loads Spreadsheet from file. * Loads Spreadsheet from file.
* *
* @param string $pFilename * @param string $pFilename
* *
* @throws Exception * @throws Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Spreadsheet * @return \PhpOffice\PhpSpreadsheet\Spreadsheet
*/ */
public function load($pFilename) public function load($pFilename)
{ {
@ -287,12 +287,12 @@ class Xml extends BaseReader implements IReader
/** /**
* Loads from file into Spreadsheet instance. * Loads from file into Spreadsheet instance.
* *
* @param string $pFilename * @param string $pFilename
* @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet
* *
* @throws Exception * @throws Exception
* *
* @return \PhpOffice\PhpSpreadsheet\Spreadsheet * @return \PhpOffice\PhpSpreadsheet\Spreadsheet
*/ */
public function loadIntoExisting($pFilename, \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet) public function loadIntoExisting($pFilename, \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet)
{ {

204
src/PhpSpreadsheet/ReferenceHelper.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -65,10 +65,10 @@ class ReferenceHelper
* Compare two column addresses * Compare two column addresses
* Intended for use as a Callback function for sorting column addresses by column. * Intended for use as a Callback function for sorting column addresses by column.
* *
* @param string $a First column to test (e.g. 'AA') * @param string $a First column to test (e.g. 'AA')
* @param string $b Second column to test (e.g. 'Z') * @param string $b Second column to test (e.g. 'Z')
* *
* @return int * @return int
*/ */
public static function columnSort($a, $b) public static function columnSort($a, $b)
{ {
@ -79,10 +79,10 @@ class ReferenceHelper
* Compare two column addresses * Compare two column addresses
* Intended for use as a Callback function for reverse sorting column addresses by column. * Intended for use as a Callback function for reverse sorting column addresses by column.
* *
* @param string $a First column to test (e.g. 'AA') * @param string $a First column to test (e.g. 'AA')
* @param string $b Second column to test (e.g. 'Z') * @param string $b Second column to test (e.g. 'Z')
* *
* @return int * @return int
*/ */
public static function columnReverseSort($a, $b) public static function columnReverseSort($a, $b)
{ {
@ -93,10 +93,10 @@ class ReferenceHelper
* Compare two cell addresses * Compare two cell addresses
* Intended for use as a Callback function for sorting cell addresses by column and row. * Intended for use as a Callback function for sorting cell addresses by column and row.
* *
* @param string $a First cell to test (e.g. 'AA1') * @param string $a First cell to test (e.g. 'AA1')
* @param string $b Second cell to test (e.g. 'Z1') * @param string $b Second cell to test (e.g. 'Z1')
* *
* @return int * @return int
*/ */
public static function cellSort($a, $b) public static function cellSort($a, $b)
{ {
@ -114,10 +114,10 @@ class ReferenceHelper
* Compare two cell addresses * Compare two cell addresses
* Intended for use as a Callback function for sorting cell addresses by column and row. * Intended for use as a Callback function for sorting cell addresses by column and row.
* *
* @param string $a First cell to test (e.g. 'AA1') * @param string $a First cell to test (e.g. 'AA1')
* @param string $b Second cell to test (e.g. 'Z1') * @param string $b Second cell to test (e.g. 'Z1')
* *
* @return int * @return int
*/ */
public static function cellReverseSort($a, $b) public static function cellReverseSort($a, $b)
{ {
@ -134,13 +134,13 @@ class ReferenceHelper
/** /**
* Test whether a cell address falls within a defined range of cells. * Test whether a cell address falls within a defined range of cells.
* *
* @param string $cellAddress Address of the cell we're testing * @param string $cellAddress Address of the cell we're testing
* @param int $beforeRow Number of the row we're inserting/deleting before * @param int $beforeRow Number of the row we're inserting/deleting before
* @param int $pNumRows Number of rows to insert/delete (negative values indicate deletion) * @param int $pNumRows Number of rows to insert/delete (negative values indicate deletion)
* @param int $beforeColumnIndex Index number of the column we're inserting/deleting before * @param int $beforeColumnIndex Index number of the column we're inserting/deleting before
* @param int $pNumCols Number of columns to insert/delete (negative values indicate deletion) * @param int $pNumCols Number of columns to insert/delete (negative values indicate deletion)
* *
* @return bool * @return bool
*/ */
private static function cellAddressInDeleteRange($cellAddress, $beforeRow, $pNumRows, $beforeColumnIndex, $pNumCols) private static function cellAddressInDeleteRange($cellAddress, $beforeRow, $pNumRows, $beforeColumnIndex, $pNumCols)
{ {
@ -163,12 +163,12 @@ class ReferenceHelper
/** /**
* Update page breaks when inserting/deleting rows/columns. * Update page breaks when inserting/deleting rows/columns.
* *
* @param Worksheet $pSheet The worksheet that we're editing * @param Worksheet $pSheet The worksheet that we're editing
* @param string $pBefore Insert/Delete before this cell address (e.g. 'A1') * @param string $pBefore Insert/Delete before this cell address (e.g. 'A1')
* @param int $beforeColumnIndex Index number of the column we're inserting/deleting before * @param int $beforeColumnIndex Index number of the column we're inserting/deleting before
* @param int $pNumCols Number of columns to insert/delete (negative values indicate deletion) * @param int $pNumCols Number of columns to insert/delete (negative values indicate deletion)
* @param int $beforeRow Number of the row we're inserting/deleting before * @param int $beforeRow Number of the row we're inserting/deleting before
* @param int $pNumRows Number of rows to insert/delete (negative values indicate deletion) * @param int $pNumRows Number of rows to insert/delete (negative values indicate deletion)
*/ */
protected function adjustPageBreaks(Worksheet $pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows) protected function adjustPageBreaks(Worksheet $pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows)
{ {
@ -196,12 +196,12 @@ class ReferenceHelper
/** /**
* Update cell comments when inserting/deleting rows/columns. * Update cell comments when inserting/deleting rows/columns.
* *
* @param Worksheet $pSheet The worksheet that we're editing * @param Worksheet $pSheet The worksheet that we're editing
* @param string $pBefore Insert/Delete before this cell address (e.g. 'A1') * @param string $pBefore Insert/Delete before this cell address (e.g. 'A1')
* @param int $beforeColumnIndex Index number of the column we're inserting/deleting before * @param int $beforeColumnIndex Index number of the column we're inserting/deleting before
* @param int $pNumCols Number of columns to insert/delete (negative values indicate deletion) * @param int $pNumCols Number of columns to insert/delete (negative values indicate deletion)
* @param int $beforeRow Number of the row we're inserting/deleting before * @param int $beforeRow Number of the row we're inserting/deleting before
* @param int $pNumRows Number of rows to insert/delete (negative values indicate deletion) * @param int $pNumRows Number of rows to insert/delete (negative values indicate deletion)
*/ */
protected function adjustComments($pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows) protected function adjustComments($pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows)
{ {
@ -223,12 +223,12 @@ class ReferenceHelper
/** /**
* Update hyperlinks when inserting/deleting rows/columns. * Update hyperlinks when inserting/deleting rows/columns.
* *
* @param Worksheet $pSheet The worksheet that we're editing * @param Worksheet $pSheet The worksheet that we're editing
* @param string $pBefore Insert/Delete before this cell address (e.g. 'A1') * @param string $pBefore Insert/Delete before this cell address (e.g. 'A1')
* @param int $beforeColumnIndex Index number of the column we're inserting/deleting before * @param int $beforeColumnIndex Index number of the column we're inserting/deleting before
* @param int $pNumCols Number of columns to insert/delete (negative values indicate deletion) * @param int $pNumCols Number of columns to insert/delete (negative values indicate deletion)
* @param int $beforeRow Number of the row we're inserting/deleting before * @param int $beforeRow Number of the row we're inserting/deleting before
* @param int $pNumRows Number of rows to insert/delete (negative values indicate deletion) * @param int $pNumRows Number of rows to insert/delete (negative values indicate deletion)
*/ */
protected function adjustHyperlinks($pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows) protected function adjustHyperlinks($pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows)
{ {
@ -248,12 +248,12 @@ class ReferenceHelper
/** /**
* Update data validations when inserting/deleting rows/columns. * Update data validations when inserting/deleting rows/columns.
* *
* @param Worksheet $pSheet The worksheet that we're editing * @param Worksheet $pSheet The worksheet that we're editing
* @param string $pBefore Insert/Delete before this cell address (e.g. 'A1') * @param string $pBefore Insert/Delete before this cell address (e.g. 'A1')
* @param int $beforeColumnIndex Index number of the column we're inserting/deleting before * @param int $beforeColumnIndex Index number of the column we're inserting/deleting before
* @param int $pNumCols Number of columns to insert/delete (negative values indicate deletion) * @param int $pNumCols Number of columns to insert/delete (negative values indicate deletion)
* @param int $beforeRow Number of the row we're inserting/deleting before * @param int $beforeRow Number of the row we're inserting/deleting before
* @param int $pNumRows Number of rows to insert/delete (negative values indicate deletion) * @param int $pNumRows Number of rows to insert/delete (negative values indicate deletion)
*/ */
protected function adjustDataValidations($pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows) protected function adjustDataValidations($pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows)
{ {
@ -273,12 +273,12 @@ class ReferenceHelper
/** /**
* Update merged cells when inserting/deleting rows/columns. * Update merged cells when inserting/deleting rows/columns.
* *
* @param Worksheet $pSheet The worksheet that we're editing * @param Worksheet $pSheet The worksheet that we're editing
* @param string $pBefore Insert/Delete before this cell address (e.g. 'A1') * @param string $pBefore Insert/Delete before this cell address (e.g. 'A1')
* @param int $beforeColumnIndex Index number of the column we're inserting/deleting before * @param int $beforeColumnIndex Index number of the column we're inserting/deleting before
* @param int $pNumCols Number of columns to insert/delete (negative values indicate deletion) * @param int $pNumCols Number of columns to insert/delete (negative values indicate deletion)
* @param int $beforeRow Number of the row we're inserting/deleting before * @param int $beforeRow Number of the row we're inserting/deleting before
* @param int $pNumRows Number of rows to insert/delete (negative values indicate deletion) * @param int $pNumRows Number of rows to insert/delete (negative values indicate deletion)
*/ */
protected function adjustMergeCells($pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows) protected function adjustMergeCells($pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows)
{ {
@ -294,12 +294,12 @@ class ReferenceHelper
/** /**
* Update protected cells when inserting/deleting rows/columns. * Update protected cells when inserting/deleting rows/columns.
* *
* @param Worksheet $pSheet The worksheet that we're editing * @param Worksheet $pSheet The worksheet that we're editing
* @param string $pBefore Insert/Delete before this cell address (e.g. 'A1') * @param string $pBefore Insert/Delete before this cell address (e.g. 'A1')
* @param int $beforeColumnIndex Index number of the column we're inserting/deleting before * @param int $beforeColumnIndex Index number of the column we're inserting/deleting before
* @param int $pNumCols Number of columns to insert/delete (negative values indicate deletion) * @param int $pNumCols Number of columns to insert/delete (negative values indicate deletion)
* @param int $beforeRow Number of the row we're inserting/deleting before * @param int $beforeRow Number of the row we're inserting/deleting before
* @param int $pNumRows Number of rows to insert/delete (negative values indicate deletion) * @param int $pNumRows Number of rows to insert/delete (negative values indicate deletion)
*/ */
protected function adjustProtectedCells($pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows) protected function adjustProtectedCells($pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows)
{ {
@ -318,12 +318,12 @@ class ReferenceHelper
/** /**
* Update column dimensions when inserting/deleting rows/columns. * Update column dimensions when inserting/deleting rows/columns.
* *
* @param Worksheet $pSheet The worksheet that we're editing * @param Worksheet $pSheet The worksheet that we're editing
* @param string $pBefore Insert/Delete before this cell address (e.g. 'A1') * @param string $pBefore Insert/Delete before this cell address (e.g. 'A1')
* @param int $beforeColumnIndex Index number of the column we're inserting/deleting before * @param int $beforeColumnIndex Index number of the column we're inserting/deleting before
* @param int $pNumCols Number of columns to insert/delete (negative values indicate deletion) * @param int $pNumCols Number of columns to insert/delete (negative values indicate deletion)
* @param int $beforeRow Number of the row we're inserting/deleting before * @param int $beforeRow Number of the row we're inserting/deleting before
* @param int $pNumRows Number of rows to insert/delete (negative values indicate deletion) * @param int $pNumRows Number of rows to insert/delete (negative values indicate deletion)
*/ */
protected function adjustColumnDimensions($pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows) protected function adjustColumnDimensions($pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows)
{ {
@ -343,12 +343,12 @@ class ReferenceHelper
/** /**
* Update row dimensions when inserting/deleting rows/columns. * Update row dimensions when inserting/deleting rows/columns.
* *
* @param Worksheet $pSheet The worksheet that we're editing * @param Worksheet $pSheet The worksheet that we're editing
* @param string $pBefore Insert/Delete before this cell address (e.g. 'A1') * @param string $pBefore Insert/Delete before this cell address (e.g. 'A1')
* @param int $beforeColumnIndex Index number of the column we're inserting/deleting before * @param int $beforeColumnIndex Index number of the column we're inserting/deleting before
* @param int $pNumCols Number of columns to insert/delete (negative values indicate deletion) * @param int $pNumCols Number of columns to insert/delete (negative values indicate deletion)
* @param int $beforeRow Number of the row we're inserting/deleting before * @param int $beforeRow Number of the row we're inserting/deleting before
* @param int $pNumRows Number of rows to insert/delete (negative values indicate deletion) * @param int $pNumRows Number of rows to insert/delete (negative values indicate deletion)
*/ */
protected function adjustRowDimensions($pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows) protected function adjustRowDimensions($pSheet, $pBefore, $beforeColumnIndex, $pNumCols, $beforeRow, $pNumRows)
{ {
@ -377,12 +377,12 @@ class ReferenceHelper
/** /**
* Insert a new column or row, updating all possible related data. * Insert a new column or row, updating all possible related data.
* *
* @param string $pBefore Insert before this cell address (e.g. 'A1') * @param string $pBefore Insert before this cell address (e.g. 'A1')
* @param int $pNumCols Number of columns to insert/delete (negative values indicate deletion) * @param int $pNumCols Number of columns to insert/delete (negative values indicate deletion)
* @param int $pNumRows Number of rows to insert/delete (negative values indicate deletion) * @param int $pNumRows Number of rows to insert/delete (negative values indicate deletion)
* @param Worksheet $pSheet The worksheet that we're editing * @param Worksheet $pSheet The worksheet that we're editing
* *
* @throws Exception * @throws Exception
*/ */
public function insertNewBefore($pBefore = 'A1', $pNumCols = 0, $pNumRows = 0, Worksheet $pSheet = null) public function insertNewBefore($pBefore = 'A1', $pNumCols = 0, $pNumRows = 0, Worksheet $pSheet = null)
{ {
@ -635,15 +635,15 @@ class ReferenceHelper
/** /**
* Update references within formulas. * Update references within formulas.
* *
* @param string $pFormula Formula to update * @param string $pFormula Formula to update
* @param int $pBefore Insert before this one * @param int $pBefore Insert before this one
* @param int $pNumCols Number of columns to insert * @param int $pNumCols Number of columns to insert
* @param int $pNumRows Number of rows to insert * @param int $pNumRows Number of rows to insert
* @param string $sheetName Worksheet name/title * @param string $sheetName Worksheet name/title
* *
* @throws Exception * @throws Exception
* *
* @return string Updated formula * @return string Updated formula
*/ */
public function updateFormulaReferences($pFormula = '', $pBefore = 'A1', $pNumCols = 0, $pNumRows = 0, $sheetName = '') public function updateFormulaReferences($pFormula = '', $pBefore = 'A1', $pNumCols = 0, $pNumRows = 0, $sheetName = '')
{ {
@ -778,14 +778,14 @@ class ReferenceHelper
/** /**
* Update cell reference. * Update cell reference.
* *
* @param string $pCellRange Cell range * @param string $pCellRange Cell range
* @param int $pBefore Insert before this one * @param int $pBefore Insert before this one
* @param int $pNumCols Number of columns to increment * @param int $pNumCols Number of columns to increment
* @param int $pNumRows Number of rows to increment * @param int $pNumRows Number of rows to increment
* *
* @throws Exception * @throws Exception
* *
* @return string Updated cell range * @return string Updated cell range
*/ */
public function updateCellReference($pCellRange = 'A1', $pBefore = 'A1', $pNumCols = 0, $pNumRows = 0) public function updateCellReference($pCellRange = 'A1', $pBefore = 'A1', $pNumCols = 0, $pNumRows = 0)
{ {
@ -807,9 +807,9 @@ class ReferenceHelper
/** /**
* Update named formulas (i.e. containing worksheet references / named ranges). * Update named formulas (i.e. containing worksheet references / named ranges).
* *
* @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet Object to update * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet Object to update
* @param string $oldName Old name (name to replace) * @param string $oldName Old name (name to replace)
* @param string $newName New name * @param string $newName New name
*/ */
public function updateNamedFormulas(Spreadsheet $spreadsheet, $oldName = '', $newName = '') public function updateNamedFormulas(Spreadsheet $spreadsheet, $oldName = '', $newName = '')
{ {
@ -835,14 +835,14 @@ class ReferenceHelper
/** /**
* Update cell range. * Update cell range.
* *
* @param string $pCellRange Cell range (e.g. 'B2:D4', 'B:C' or '2:3') * @param string $pCellRange Cell range (e.g. 'B2:D4', 'B:C' or '2:3')
* @param int $pBefore Insert before this one * @param int $pBefore Insert before this one
* @param int $pNumCols Number of columns to increment * @param int $pNumCols Number of columns to increment
* @param int $pNumRows Number of rows to increment * @param int $pNumRows Number of rows to increment
* *
* @throws Exception * @throws Exception
* *
* @return string Updated cell range * @return string Updated cell range
*/ */
private function updateCellRange($pCellRange = 'A1:A1', $pBefore = 'A1', $pNumCols = 0, $pNumRows = 0) private function updateCellRange($pCellRange = 'A1:A1', $pBefore = 'A1', $pNumCols = 0, $pNumRows = 0)
{ {
@ -874,14 +874,14 @@ class ReferenceHelper
/** /**
* Update single cell reference. * Update single cell reference.
* *
* @param string $pCellReference Single cell reference * @param string $pCellReference Single cell reference
* @param int $pBefore Insert before this one * @param int $pBefore Insert before this one
* @param int $pNumCols Number of columns to increment * @param int $pNumCols Number of columns to increment
* @param int $pNumRows Number of rows to increment * @param int $pNumRows Number of rows to increment
* *
* @throws Exception * @throws Exception
* *
* @return string Updated cell reference * @return string Updated cell reference
*/ */
private function updateSingleCellReference($pCellReference = 'A1', $pBefore = 'A1', $pNumCols = 0, $pNumRows = 0) private function updateSingleCellReference($pCellReference = 'A1', $pBefore = 'A1', $pNumCols = 0, $pNumRows = 0)
{ {
@ -915,7 +915,7 @@ class ReferenceHelper
/** /**
* __clone implementation. Cloning should not be allowed in a Singleton! * __clone implementation. Cloning should not be allowed in a Singleton!
* *
* @throws Exception * @throws Exception
*/ */
final public function __clone() final public function __clone()
{ {

6
src/PhpSpreadsheet/RichText.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -170,7 +170,7 @@ class RichText implements IComparable
/** /**
* Get hash code. * Get hash code.
* *
* @return string Hash code * @return string Hash code
*/ */
public function getHashCode() public function getHashCode()
{ {

10
src/PhpSpreadsheet/RichText/ITextElement.php
View File

@ -10,12 +10,12 @@ namespace PhpOffice\PhpSpreadsheet\RichText;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -27,14 +27,14 @@ interface ITextElement
/** /**
* Get text. * Get text.
* *
* @return string Text * @return string Text
*/ */
public function getText(); public function getText();
/** /**
* Set text. * Set text.
* *
* @param $pText string Text * @param $pText string Text
* *
* @return ITextElement * @return ITextElement
*/ */
@ -50,7 +50,7 @@ interface ITextElement
/** /**
* Get hash code. * Get hash code.
* *
* @return string Hash code * @return string Hash code
*/ */
public function getHashCode(); public function getHashCode();
} }

14
src/PhpSpreadsheet/RichText/Run.php
View File

@ -10,12 +10,12 @@ namespace PhpOffice\PhpSpreadsheet\RichText;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -34,7 +34,7 @@ class Run extends TextElement implements ITextElement
/** /**
* Create a new Run instance. * Create a new Run instance.
* *
* @param string $pText Text * @param string $pText Text
*/ */
public function __construct($pText = '') public function __construct($pText = '')
{ {
@ -56,11 +56,11 @@ class Run extends TextElement implements ITextElement
/** /**
* Set font. * Set font.
* *
* @param \PhpOffice\PhpSpreadsheet\Style\Font $pFont Font * @param \PhpOffice\PhpSpreadsheet\Style\Font $pFont Font
* *
* @throws \PhpOffice\PhpSpreadsheet\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception
* *
* @return ITextElement * @return ITextElement
*/ */
public function setFont(\PhpOffice\PhpSpreadsheet\Style\Font $pFont = null) public function setFont(\PhpOffice\PhpSpreadsheet\Style\Font $pFont = null)
{ {
@ -72,7 +72,7 @@ class Run extends TextElement implements ITextElement
/** /**
* Get hash code. * Get hash code.
* *
* @return string Hash code * @return string Hash code
*/ */
public function getHashCode() public function getHashCode()
{ {

14
src/PhpSpreadsheet/RichText/TextElement.php
View File

@ -10,12 +10,12 @@ namespace PhpOffice\PhpSpreadsheet\RichText;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -34,7 +34,7 @@ class TextElement implements ITextElement
/** /**
* Create a new TextElement instance. * Create a new TextElement instance.
* *
* @param string $pText Text * @param string $pText Text
*/ */
public function __construct($pText = '') public function __construct($pText = '')
{ {
@ -45,7 +45,7 @@ class TextElement implements ITextElement
/** /**
* Get text. * Get text.
* *
* @return string Text * @return string Text
*/ */
public function getText() public function getText()
{ {
@ -55,9 +55,9 @@ class TextElement implements ITextElement
/** /**
* Set text. * Set text.
* *
* @param $pText string Text * @param $pText string Text
* *
* @return ITextElement * @return ITextElement
*/ */
public function setText($pText = '') public function setText($pText = '')
{ {
@ -79,7 +79,7 @@ class TextElement implements ITextElement
/** /**
* Get hash code. * Get hash code.
* *
* @return string Hash code * @return string Hash code
*/ */
public function getHashCode() public function getHashCode()
{ {

30
src/PhpSpreadsheet/Settings.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -51,7 +51,7 @@ class Settings
/** /**
* Name of the class used for Zip file management * Name of the class used for Zip file management
* e.g. * e.g.
* ZipArchive. * ZipArchive.
* *
* @var string * @var string
@ -60,7 +60,7 @@ class Settings
/** /**
* Name of the external Library used for rendering charts * Name of the external Library used for rendering charts
* e.g. * e.g.
* jpgraph. * jpgraph.
* *
* @var string * @var string
@ -76,7 +76,7 @@ class Settings
/** /**
* Name of the external Library used for rendering PDF files * Name of the external Library used for rendering PDF files
* e.g. * e.g.
* mPDF. * mPDF.
* *
* @var string * @var string
@ -93,10 +93,10 @@ class Settings
/** /**
* Set the Zip handler Class that PhpSpreadsheet should use for Zip file management (PCLZip or ZipArchive). * Set the Zip handler Class that PhpSpreadsheet should use for Zip file management (PCLZip or ZipArchive).
* *
* @param string $zipClass The Zip handler class that PhpSpreadsheet should use for Zip file management * @param string $zipClass The Zip handler class that PhpSpreadsheet should use for Zip file management
* e.g. \PhpOffice\PhpSpreadsheet\Settings::PCLZIP or \PhpOffice\PhpSpreadsheet\Settings::ZIPARCHIVE * e.g. \PhpOffice\PhpSpreadsheet\Settings::PCLZIP or \PhpOffice\PhpSpreadsheet\Settings::ZIPARCHIVE
* *
* @return bool Success or failure * @return bool Success or failure
*/ */
public static function setZipClass($zipClass) public static function setZipClass($zipClass)
{ {
@ -112,7 +112,7 @@ class Settings
/** /**
* Return the name of the Zip handler Class that PhpSpreadsheet is configured to use (PCLZip or ZipArchive) * Return the name of the Zip handler Class that PhpSpreadsheet is configured to use (PCLZip or ZipArchive)
* or Zip file management. * or Zip file management.
* *
* @return string Name of the Zip handler Class that PhpSpreadsheet is configured to use * @return string Name of the Zip handler Class that PhpSpreadsheet is configured to use
* for Zip file management * for Zip file management
@ -171,11 +171,11 @@ class Settings
/** /**
* Set details of the external library that PhpSpreadsheet should use for rendering charts. * Set details of the external library that PhpSpreadsheet should use for rendering charts.
* *
* @param string $libraryName Internal reference name of the library * @param string $libraryName Internal reference name of the library
* e.g. \PhpOffice\PhpSpreadsheet\Settings::CHART_RENDERER_JPGRAPH * e.g. \PhpOffice\PhpSpreadsheet\Settings::CHART_RENDERER_JPGRAPH
* @param string $libraryBaseDir Directory path to the library's base folder * @param string $libraryBaseDir Directory path to the library's base folder
* *
* @return bool Success or failure * @return bool Success or failure
*/ */
public static function setChartRenderer($libraryName, $libraryBaseDir) public static function setChartRenderer($libraryName, $libraryBaseDir)
{ {
@ -189,10 +189,10 @@ class Settings
/** /**
* Identify to PhpSpreadsheet the external library to use for rendering charts. * Identify to PhpSpreadsheet the external library to use for rendering charts.
* *
* @param string $libraryName Internal reference name of the library * @param string $libraryName Internal reference name of the library
* e.g. \PhpOffice\PhpSpreadsheet\Settings::CHART_RENDERER_JPGRAPH * e.g. \PhpOffice\PhpSpreadsheet\Settings::CHART_RENDERER_JPGRAPH
* *
* @return bool Success or failure * @return bool Success or failure
*/ */
public static function setChartRendererName($libraryName) public static function setChartRendererName($libraryName)
{ {
@ -207,9 +207,9 @@ class Settings
/** /**
* Tell PhpSpreadsheet where to find the external library to use for rendering charts. * Tell PhpSpreadsheet where to find the external library to use for rendering charts.
* *
* @param string $libraryBaseDir Directory path to the library's base folder * @param string $libraryBaseDir Directory path to the library's base folder
* *
* @return bool Success or failure * @return bool Success or failure
*/ */
public static function setChartRendererPath($libraryBaseDir) public static function setChartRendererPath($libraryBaseDir)
{ {
@ -265,7 +265,7 @@ class Settings
* *
* @return string|null Internal reference name of the PDF Rendering Library that PhpSpreadsheet is * @return string|null Internal reference name of the PDF Rendering Library that PhpSpreadsheet is
* currently configured to use * currently configured to use
* e.g. \PhpOffice\PhpSpreadsheet\Settings::PDF_RENDERER_TCPDF, * e.g. \PhpOffice\PhpSpreadsheet\Settings::PDF_RENDERER_TCPDF,
* \PhpOffice\PhpSpreadsheet\Settings::PDF_RENDERER_DOMPDF * \PhpOffice\PhpSpreadsheet\Settings::PDF_RENDERER_DOMPDF
* or \PhpOffice\PhpSpreadsheet\Settings::PDF_RENDERER_MPDF * or \PhpOffice\PhpSpreadsheet\Settings::PDF_RENDERER_MPDF
*/ */

4
src/PhpSpreadsheet/Shared/CodePage.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *

108
src/PhpSpreadsheet/Shared/Date.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -35,7 +35,7 @@ class Date
* Planned usage for locale settings * Planned usage for locale settings
* *
* @public * @public
* @var string[] * @var string[]
*/ */
public static $monthNames = [ public static $monthNames = [
'Jan' => 'January', 'Jan' => 'January',
@ -54,7 +54,7 @@ class Date
/* /*
* @public * @public
* @var string[] * @var string[]
*/ */
public static $numberSuffixes = [ public static $numberSuffixes = [
'st', 'st',
@ -68,7 +68,7 @@ class Date
* Value is either CALENDAR_WINDOWS_1900 (1900) or CALENDAR_MAC_1904 (1904) * Value is either CALENDAR_WINDOWS_1900 (1900) or CALENDAR_MAC_1904 (1904)
* *
* @private * @private
* @var int * @var int
*/ */
protected static $excelCalendar = self::CALENDAR_WINDOWS_1900; protected static $excelCalendar = self::CALENDAR_WINDOWS_1900;
@ -76,16 +76,16 @@ class Date
* Default timezone to use for DateTime objects * Default timezone to use for DateTime objects
* *
* @private * @private
* @var null|\DateTimeZone * @var null|\DateTimeZone
*/ */
protected static $defaultTimeZone; protected static $defaultTimeZone;
/** /**
* Set the Excel calendar (Windows 1900 or Mac 1904). * Set the Excel calendar (Windows 1900 or Mac 1904).
* *
* @param int $baseDate Excel base date (1900 or 1904) * @param int $baseDate Excel base date (1900 or 1904)
* *
* @return bool Success or failure * @return bool Success or failure
*/ */
public static function setExcelCalendar($baseDate) public static function setExcelCalendar($baseDate)
{ {
@ -102,7 +102,7 @@ class Date
/** /**
* Return the Excel calendar (Windows 1900 or Mac 1904). * Return the Excel calendar (Windows 1900 or Mac 1904).
* *
* @return int Excel base date (1900 or 1904) * @return int Excel base date (1900 or 1904)
*/ */
public static function getExcelCalendar() public static function getExcelCalendar()
{ {
@ -112,12 +112,12 @@ class Date
/** /**
* Set the Default timezone to use for dates. * Set the Default timezone to use for dates.
* *
* @param string|\DateTimeZone $timeZone The timezone to set for all Excel datetimestamp to PHP DateTime Object conversions * @param string|\DateTimeZone $timeZone The timezone to set for all Excel datetimestamp to PHP DateTime Object conversions
* *
* @throws \Exception * @throws \Exception
* *
* @return bool Success or failure * @return bool Success or failure
* @return bool Success or failure * @return bool Success or failure
*/ */
public static function setDefaultTimezone($timeZone) public static function setDefaultTimezone($timeZone)
{ {
@ -133,7 +133,7 @@ class Date
/** /**
* Return the Default timezone being used for dates. * Return the Default timezone being used for dates.
* *
* @return \DateTimeZone The timezone being used as default for Excel timestamp to PHP DateTime object * @return \DateTimeZone The timezone being used as default for Excel timestamp to PHP DateTime object
*/ */
public static function getDefaultTimezone() public static function getDefaultTimezone()
{ {
@ -147,12 +147,12 @@ class Date
/** /**
* Validate a timezone. * Validate a timezone.
* *
* @param string|\DateTimeZone $timeZone The timezone to validate, either as a timezone string or object * @param string|\DateTimeZone $timeZone The timezone to validate, either as a timezone string or object
* *
* @throws \Exception * @throws \Exception
* *
* @return \DateTimeZone The timezone as a timezone object * @return \DateTimeZone The timezone as a timezone object
* @return \DateTimeZone The timezone as a timezone object * @return \DateTimeZone The timezone as a timezone object
*/ */
protected static function validateTimeZone($timeZone) protected static function validateTimeZone($timeZone)
{ {
@ -167,14 +167,14 @@ class Date
/** /**
* Convert a MS serialized datetime value from Excel to a PHP Date/Time object. * Convert a MS serialized datetime value from Excel to a PHP Date/Time object.
* *
* @param int|float $excelTimestamp MS Excel serialized date/time value * @param int|float $excelTimestamp MS Excel serialized date/time value
* @param \DateTimeZone|string|null $timeZone The timezone to assume for the Excel timestamp, * @param \DateTimeZone|string|null $timeZone The timezone to assume for the Excel timestamp,
* if you don't want to treat it as a UTC value * if you don't want to treat it as a UTC value
* Use the default (UST) unless you absolutely need a conversion * Use the default (UST) unless you absolutely need a conversion
* *
* @throws \Exception * @throws \Exception
* *
* @return \DateTime PHP date/time object * @return \DateTime PHP date/time object
*/ */
public static function excelToDateTimeObject($excelTimestamp = 0, $timeZone = null) public static function excelToDateTimeObject($excelTimestamp = 0, $timeZone = null)
{ {
@ -208,14 +208,14 @@ class Date
/** /**
* Convert a MS serialized datetime value from Excel to a unix timestamp. * Convert a MS serialized datetime value from Excel to a unix timestamp.
* *
* @param int|float $excelTimestamp MS Excel serialized date/time value * @param int|float $excelTimestamp MS Excel serialized date/time value
* @param \DateTimeZone|string|null $timeZone The timezone to assume for the Excel timestamp, * @param \DateTimeZone|string|null $timeZone The timezone to assume for the Excel timestamp,
* if you don't want to treat it as a UTC value * if you don't want to treat it as a UTC value
* Use the default (UST) unless you absolutely need a conversion * Use the default (UST) unless you absolutely need a conversion
* *
* @throws \Exception * @throws \Exception
* *
* @return int Unix timetamp for this date/time * @return int Unix timetamp for this date/time
*/ */
public static function excelToTimestamp($excelTimestamp = 0, $timeZone = null) public static function excelToTimestamp($excelTimestamp = 0, $timeZone = null)
{ {
@ -224,11 +224,11 @@ class Date
} }
/** /**
* Convert a date from PHP to an MS Excel serialized date/time value. * Convert a date from PHP to an MS Excel serialized date/time value.
* *
* @param mixed $dateValue Unix Timestamp or PHP DateTime object or a string * @param mixed $dateValue Unix Timestamp or PHP DateTime object or a string
* *
* @return float|bool Excel date/time value * @return float|bool Excel date/time value
* or boolean FALSE on failure * or boolean FALSE on failure
*/ */
public static function PHPToExcel($dateValue = 0) public static function PHPToExcel($dateValue = 0)
@ -245,11 +245,11 @@ class Date
} }
/** /**
* Convert a PHP DateTime object to an MS Excel serialized date/time value. * Convert a PHP DateTime object to an MS Excel serialized date/time value.
* *
* @param \DateTimeInterface $dateValue PHP DateTime object * @param \DateTimeInterface $dateValue PHP DateTime object
* *
* @return float MS Excel serialized date/time value * @return float MS Excel serialized date/time value
*/ */
public static function dateTimeToExcel(\DateTimeInterface $dateValue = null) public static function dateTimeToExcel(\DateTimeInterface $dateValue = null)
{ {
@ -264,11 +264,11 @@ class Date
} }
/** /**
* Convert a Unix timestamp to an MS Excel serialized date/time value. * Convert a Unix timestamp to an MS Excel serialized date/time value.
* *
* @param \DateTimeInterface $dateValue Unix Timestamp * @param \DateTimeInterface $dateValue Unix Timestamp
* *
* @return float MS Excel serialized date/time value * @return float MS Excel serialized date/time value
*/ */
public static function timestampToExcel($dateValue = 0) public static function timestampToExcel($dateValue = 0)
{ {
@ -282,14 +282,14 @@ class Date
/** /**
* formattedPHPToExcel. * formattedPHPToExcel.
* *
* @param int $year * @param int $year
* @param int $month * @param int $month
* @param int $day * @param int $day
* @param int $hours * @param int $hours
* @param int $minutes * @param int $minutes
* @param int $seconds * @param int $seconds
* *
* @return float Excel date/time value * @return float Excel date/time value
*/ */
public static function formattedPHPToExcel($year, $month, $day, $hours = 0, $minutes = 0, $seconds = 0) public static function formattedPHPToExcel($year, $month, $day, $hours = 0, $minutes = 0, $seconds = 0)
{ {
@ -329,9 +329,9 @@ class Date
/** /**
* Is a given cell a date/time? * Is a given cell a date/time?
* *
* @param \PhpOffice\PhpSpreadsheet\Cell $pCell * @param \PhpOffice\PhpSpreadsheet\Cell $pCell
* *
* @return bool * @return bool
*/ */
public static function isDateTime(\PhpOffice\PhpSpreadsheet\Cell $pCell) public static function isDateTime(\PhpOffice\PhpSpreadsheet\Cell $pCell)
{ {
@ -345,9 +345,9 @@ class Date
/** /**
* Is a given number format a date/time? * Is a given number format a date/time?
* *
* @param \PhpOffice\PhpSpreadsheet\Style\NumberFormat $pFormat * @param \PhpOffice\PhpSpreadsheet\Style\NumberFormat $pFormat
* *
* @return bool * @return bool
*/ */
public static function isDateTimeFormat(\PhpOffice\PhpSpreadsheet\Style\NumberFormat $pFormat) public static function isDateTimeFormat(\PhpOffice\PhpSpreadsheet\Style\NumberFormat $pFormat)
{ {
@ -359,9 +359,9 @@ class Date
/** /**
* Is a given number format code a date/time? * Is a given number format code a date/time?
* *
* @param string $pFormatCode * @param string $pFormatCode
* *
* @return bool * @return bool
*/ */
public static function isDateTimeFormatCode($pFormatCode = '') public static function isDateTimeFormatCode($pFormatCode = '')
{ {
@ -433,9 +433,9 @@ class Date
/** /**
* Convert a date/time string to Excel time. * Convert a date/time string to Excel time.
* *
* @param string $dateValue Examples: '2009-12-31', '2009-12-31 15:59', '2009-12-31 15:59:10' * @param string $dateValue Examples: '2009-12-31', '2009-12-31 15:59', '2009-12-31 15:59:10'
* *
* @return float|false Excel date/time serial value * @return float|false Excel date/time serial value
*/ */
public static function stringToExcel($dateValue = '') public static function stringToExcel($dateValue = '')
{ {
@ -466,9 +466,9 @@ class Date
/** /**
* Converts a month name (either a long or a short name) to a month number. * Converts a month name (either a long or a short name) to a month number.
* *
* @param string $month Month name or abbreviation * @param string $month Month name or abbreviation
* *
* @return int|string Month number (1 - 12), or the original string argument if it isn't a valid month name * @return int|string Month number (1 - 12), or the original string argument if it isn't a valid month name
*/ */
public static function monthStringToNumber($month) public static function monthStringToNumber($month)
{ {
@ -486,9 +486,9 @@ class Date
/** /**
* Strips an ordinal froma numeric value. * Strips an ordinal froma numeric value.
* *
* @param string $day Day number with an ordinal * @param string $day Day number with an ordinal
* *
* @return int|string The integer value with any ordinal stripped, or the original string argument if it isn't a valid numeric * @return int|string The integer value with any ordinal stripped, or the original string argument if it isn't a valid numeric
*/ */
public static function dayStringToNumber($day) public static function dayStringToNumber($day)
{ {

40
src/PhpSpreadsheet/Shared/Drawing.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -29,9 +29,9 @@ class Drawing
/** /**
* Convert pixels to EMU. * Convert pixels to EMU.
* *
* @param int $pValue Value in pixels * @param int $pValue Value in pixels
* *
* @return int Value in EMU * @return int Value in EMU
*/ */
public static function pixelsToEMU($pValue = 0) public static function pixelsToEMU($pValue = 0)
{ {
@ -41,9 +41,9 @@ class Drawing
/** /**
* Convert EMU to pixels. * Convert EMU to pixels.
* *
* @param int $pValue Value in EMU * @param int $pValue Value in EMU
* *
* @return int Value in pixels * @return int Value in pixels
*/ */
public static function EMUToPixels($pValue = 0) public static function EMUToPixels($pValue = 0)
{ {
@ -59,10 +59,10 @@ class Drawing
* By inspection of a real Excel file using Calibri 11, one finds 1000px ~ 142.85546875 * By inspection of a real Excel file using Calibri 11, one finds 1000px ~ 142.85546875
* This gives a conversion factor of 7. Also, we assume that pixels and font size are proportional. * This gives a conversion factor of 7. Also, we assume that pixels and font size are proportional.
* *
* @param int $pValue Value in pixels * @param int $pValue Value in pixels
* @param \PhpOffice\PhpSpreadsheet\Style\Font $pDefaultFont Default font of the workbook * @param \PhpOffice\PhpSpreadsheet\Style\Font $pDefaultFont Default font of the workbook
* *
* @return int Value in cell dimension * @return int Value in cell dimension
*/ */
public static function pixelsToCellDimension($pValue, \PhpOffice\PhpSpreadsheet\Style\Font $pDefaultFont) public static function pixelsToCellDimension($pValue, \PhpOffice\PhpSpreadsheet\Style\Font $pDefaultFont)
{ {
@ -85,10 +85,10 @@ class Drawing
/** /**
* Convert column width from (intrinsic) Excel units to pixels. * Convert column width from (intrinsic) Excel units to pixels.
* *
* @param float $pValue Value in cell dimension * @param float $pValue Value in cell dimension
* @param \PhpOffice\PhpSpreadsheet\Style\Font $pDefaultFont Default font of the workbook * @param \PhpOffice\PhpSpreadsheet\Style\Font $pDefaultFont Default font of the workbook
* *
* @return int Value in pixels * @return int Value in pixels
*/ */
public static function cellDimensionToPixels($pValue, \PhpOffice\PhpSpreadsheet\Style\Font $pDefaultFont) public static function cellDimensionToPixels($pValue, \PhpOffice\PhpSpreadsheet\Style\Font $pDefaultFont)
{ {
@ -114,9 +114,9 @@ class Drawing
/** /**
* Convert pixels to points. * Convert pixels to points.
* *
* @param int $pValue Value in pixels * @param int $pValue Value in pixels
* *
* @return float Value in points * @return float Value in points
*/ */
public static function pixelsToPoints($pValue = 0) public static function pixelsToPoints($pValue = 0)
{ {
@ -126,9 +126,9 @@ class Drawing
/** /**
* Convert points to pixels. * Convert points to pixels.
* *
* @param int $pValue Value in points * @param int $pValue Value in points
* *
* @return int Value in pixels * @return int Value in pixels
*/ */
public static function pointsToPixels($pValue = 0) public static function pointsToPixels($pValue = 0)
{ {
@ -142,9 +142,9 @@ class Drawing
/** /**
* Convert degrees to angle. * Convert degrees to angle.
* *
* @param int $pValue Degrees * @param int $pValue Degrees
* *
* @return int Angle * @return int Angle
*/ */
public static function degreesToAngle($pValue = 0) public static function degreesToAngle($pValue = 0)
{ {
@ -154,9 +154,9 @@ class Drawing
/** /**
* Convert angle to degrees. * Convert angle to degrees.
* *
* @param int $pValue Angle * @param int $pValue Angle
* *
* @return int Degrees * @return int Degrees
*/ */
public static function angleToDegrees($pValue = 0) public static function angleToDegrees($pValue = 0)
{ {

4
src/PhpSpreadsheet/Shared/Escher.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *

4
src/PhpSpreadsheet/Shared/Escher/DgContainer.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared\Escher;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *

4
src/PhpSpreadsheet/Shared/Escher/DgContainer/SpgrContainer.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared\Escher\DgContainer;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *

4
src/PhpSpreadsheet/Shared/Escher/DgContainer/SpgrContainer/SpContainer.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared\Escher\DgContainer\SpgrContainer;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *

4
src/PhpSpreadsheet/Shared/Escher/DggContainer.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared\Escher;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *

4
src/PhpSpreadsheet/Shared/Escher/DggContainer/BstoreContainer.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *

4
src/PhpSpreadsheet/Shared/Escher/DggContainer/BstoreContainer/BSE.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *

4
src/PhpSpreadsheet/Shared/Escher/DggContainer/BstoreContainer/BSE/Blip.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer\BS
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *

12
src/PhpSpreadsheet/Shared/File.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -30,7 +30,7 @@ class File
* Use Temp or File Upload Temp for temporary files * Use Temp or File Upload Temp for temporary files
* *
* @protected * @protected
* @var boolean * @var boolean
*/ */
protected static $useUploadTempDirectory = false; protected static $useUploadTempDirectory = false;
@ -38,7 +38,7 @@ class File
/** /**
* Set the flag indicating whether the File Upload Temp directory should be used for temporary files. * Set the flag indicating whether the File Upload Temp directory should be used for temporary files.
* *
* @param bool $useUploadTempDir Use File Upload Temporary directory (true or false) * @param bool $useUploadTempDir Use File Upload Temporary directory (true or false)
*/ */
public static function setUseUploadTempDirectory($useUploadTempDir = false) public static function setUseUploadTempDirectory($useUploadTempDir = false)
{ {
@ -48,7 +48,7 @@ class File
/** /**
* Get the flag indicating whether the File Upload Temp directory should be used for temporary files. * Get the flag indicating whether the File Upload Temp directory should be used for temporary files.
* *
* @return bool Use File Upload Temporary directory (true or false) * @return bool Use File Upload Temporary directory (true or false)
*/ */
public static function getUseUploadTempDirectory() public static function getUseUploadTempDirectory()
{ {
@ -58,7 +58,7 @@ class File
/** /**
* Verify if a file exists. * Verify if a file exists.
* *
* @param string $pFilename Filename * @param string $pFilename Filename
* *
* @return bool * @return bool
*/ */

30
src/PhpSpreadsheet/Shared/Font.php
View File

@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared;
* *
* This library is distributed in the hope that it will be useful, * This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details. * Lesser General Public License for more details.
* *
* You should have received a copy of the GNU Lesser General Public * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software * License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
* *
* @category PhpSpreadsheet * @category PhpSpreadsheet
* *
@ -184,7 +184,7 @@ class Font
* *
* @param string $pValue * @param string $pValue
* *
* @return bool Success or failure * @return bool Success or failure
*/ */
public static function setAutoSizeMethod($pValue = self::AUTOSIZE_METHOD_APPROX) public static function setAutoSizeMethod($pValue = self::AUTOSIZE_METHOD_APPROX)
{ {
@ -213,7 +213,7 @@ class Font
* <li>C:/Windows/Fonts/</li> * <li>C:/Windows/Fonts/</li>
* <li>/usr/share/fonts/truetype/</li> * <li>/usr/share/fonts/truetype/</li>
* <li>~/.fonts/</li> * <li>~/.fonts/</li>
* </ul>. * </ul>.
* *
* @param string $pValue * @param string $pValue
*/ */
@ -235,12 +235,12 @@ class Font
/** /**
* Calculate an (approximate) OpenXML column width, based on font size and text contained. * Calculate an (approximate) OpenXML column width, based on font size and text contained.
* *
* @param \PhpOffice\PhpSpreadsheet\Style\Font $font Font object * @param \PhpOffice\PhpSpreadsheet\Style\Font $font Font object
* @param \PhpOffice\PhpSpreadsheet\RichText|string $cellText Text to calculate width * @param \PhpOffice\PhpSpreadsheet\RichText|string $cellText Text to calculate width
* @param int $rotation Rotation angle * @param int $rotation Rotation angle
* @param \PhpOffice\PhpSpreadsheet\Style\Font|null $defaultFont Font object * @param \PhpOffice\PhpSpreadsheet\Style\Font|null $defaultFont Font object
* *
* @return int Column width * @return int Column width
*/ */
public static function calculateColumnWidth(\PhpOffice\PhpSpreadsheet\Style\Font $font, $cellText = '', $rotation = 0, \PhpOffice\PhpSpreadsheet\Style\Font $defaultFont = null) public static function calculateColumnWidth(\PhpOffice\PhpSpreadsheet\Style\Font $font, $cellText = '', $rotation = 0, \PhpOffice\PhpSpreadsheet\Style\Font $defaultFont = null)
{ {
@ -378,9 +378,9 @@ class Font
/** /**
* Calculate an (approximate) pixel size, based on a font points size. * Calculate an (approximate) pixel size, based on a font points size.
* *
* @param int $fontSizeInPoints Font size (in points) * @param int $fontSizeInPoints Font size (in points)
* *
* @return int Font size (in pixels) * @return int Font size (in pixels)
*/ */
public static function fontSizeToPixels($fontSizeInPoints = 11) public static function fontSizeToPixels($fontSizeInPoints = 11)
{ {
@ -390,9 +390,9 @@ class Font
/** /**
* Calculate an (approximate) pixel size, based on inch size. * Calculate an (approximate) pixel size, based on inch size.
* *
* @param int $sizeInInch Font size (in inch) * @param int $sizeInInch Font size (in inch)
* *
* @return int Size (in pixels) * @return int Size (in pixels)
*/ */
public static function inchSizeToPixels($sizeInInch = 1) public static function inchSizeToPixels($sizeInInch = 1)
{ {
@ -402,9 +402,9 @@ class Font
/** /**
* Calculate an (approximate) pixel size, based on centimeter size. * Calculate an (approximate) pixel size, based on centimeter size.
* *
* @param int $sizeInCm Font size (in centimeters) * @param int $sizeInCm Font size (in centimeters)
* *
* @return float Size (in pixels) * @return float Size (in pixels)
*/ */
public static function centimeterSizeToPixels($sizeInCm = 1) public static function centimeterSizeToPixels($sizeInCm = 1)
{ {

30
src/PhpSpreadsheet/Shared/JAMA/CholeskyDecomposition.php
View File

@ -20,32 +20,32 @@ namespace PhpOffice\PhpSpreadsheet\Shared\JAMA;
class CholeskyDecomposition class CholeskyDecomposition
{ {
/** /**
* Decomposition storage. * Decomposition storage.
* *
* @var array * @var array
*/ */
private $L = []; private $L = [];
/** /**
* Matrix row and column dimension. * Matrix row and column dimension.
* *
* @var int * @var int
*/ */
private $m; private $m;
/** /**
* Symmetric positive definite flag. * Symmetric positive definite flag.
* *
* @var bool * @var bool
*/ */
private $isspd = true; private $isspd = true;
/** /**
* CholeskyDecomposition. * CholeskyDecomposition.
* *
* Class constructor - decomposes symmetric positive definite matrix * Class constructor - decomposes symmetric positive definite matrix
* *
* @param mixed Matrix square symmetric positive definite matrix * @param mixed Matrix square symmetric positive definite matrix
* @param null|mixed $A * @param null|mixed $A
*/ */
public function __construct($A = null) public function __construct($A = null)
@ -86,7 +86,7 @@ class CholeskyDecomposition
/** /**
* Is the matrix symmetric and positive definite? * Is the matrix symmetric and positive definite?
* *
* @return bool * @return bool
*/ */
public function isSPD() public function isSPD()
{ {
@ -96,11 +96,11 @@ class CholeskyDecomposition
// function isSPD() // function isSPD()
/** /**
* getL. * getL.
* *
* Return triangular factor. * Return triangular factor.
* *
* @return Matrix Lower triangular matrix * @return Matrix Lower triangular matrix
*/ */
public function getL() public function getL()
{ {
@ -110,11 +110,11 @@ class CholeskyDecomposition
// function getL() // function getL()
/** /**
* Solve A*X = B. * Solve A*X = B.
* *
* @param $B Row-equal matrix * @param $B Row-equal matrix
* *
* @return Matrix L * L' * X = B * @return Matrix L * L' * X = B
*/ */
public function solve($B = null) public function solve($B = null)
{ {

66
src/PhpSpreadsheet/Shared/JAMA/EigenvalueDecomposition.php
View File

@ -26,58 +26,58 @@ namespace PhpOffice\PhpSpreadsheet\Shared\JAMA;
class EigenvalueDecomposition class EigenvalueDecomposition
{ {
/** /**
* Row and column dimension (square matrix). * Row and column dimension (square matrix).
* *
* @var int * @var int
*/ */
private $n; private $n;
/** /**
* Internal symmetry flag. * Internal symmetry flag.
* *
* @var int * @var int
*/ */
private $issymmetric; private $issymmetric;
/** /**
* Arrays for internal storage of eigenvalues. * Arrays for internal storage of eigenvalues.
* *
* @var array * @var array
*/ */
private $d = []; private $d = [];
private $e = []; private $e = [];
/** /**
* Array for internal storage of eigenvectors. * Array for internal storage of eigenvectors.
* *
* @var array * @var array
*/ */
private $V = []; private $V = [];
/** /**
* Array for internal storage of nonsymmetric Hessenberg form. * Array for internal storage of nonsymmetric Hessenberg form.
* *
* @var array * @var array
*/ */
private $H = []; private $H = [];
/** /**
* Working storage for nonsymmetric algorithm. * Working storage for nonsymmetric algorithm.
* *
* @var array * @var array
*/ */
private $ort; private $ort;
/** /**
* Used for complex scalar division. * Used for complex scalar division.
* *
* @var float * @var float
*/ */
private $cdivr; private $cdivr;
private $cdivi; private $cdivi;
/** /**
* Symmetric Householder reduction to tridiagonal form. * Symmetric Householder reduction to tridiagonal form.
*/ */
private function tred2() private function tred2()
{ {
@ -179,12 +179,12 @@ class EigenvalueDecomposition
} }
/** /**
* Symmetric tridiagonal QL algorithm. * Symmetric tridiagonal QL algorithm.
* *
* This is derived from the Algol procedures tql2, by * This is derived from the Algol procedures tql2, by
* Bowdler, Martin, Reinsch, and Wilkinson, Handbook for * Bowdler, Martin, Reinsch, and Wilkinson, Handbook for
* Auto. Comp., Vol.ii-Linear Algebra, and the corresponding * Auto. Comp., Vol.ii-Linear Algebra, and the corresponding
* Fortran subroutine in EISPACK. * Fortran subroutine in EISPACK.
*/ */
private function tql2() private function tql2()
{ {
@ -286,12 +286,12 @@ class EigenvalueDecomposition
} }
/** /**
* Nonsymmetric reduction to Hessenberg form. * Nonsymmetric reduction to Hessenberg form.
* *
* This is derived from the Algol procedures orthes and ortran, * This is derived from the Algol procedures orthes and ortran,
* by Martin and Wilkinson, Handbook for Auto. Comp., * by Martin and Wilkinson, Handbook for Auto. Comp.,
* Vol.ii-Linear Algebra, and the corresponding * Vol.ii-Linear Algebra, and the corresponding
* Fortran subroutines in EISPACK. * Fortran subroutines in EISPACK.
*/ */
private function orthes() private function orthes()
{ {
@ -371,7 +371,7 @@ class EigenvalueDecomposition
} }
/** /**
* Performs complex division. * Performs complex division.
* *
* @param mixed $xr * @param mixed $xr
* @param mixed $xi * @param mixed $xi
@ -394,12 +394,12 @@ class EigenvalueDecomposition
} }
/** /**
* Nonsymmetric reduction from Hessenberg to real Schur form. * Nonsymmetric reduction from Hessenberg to real Schur form.
* *
* Code is derived from the Algol procedure hqr2, * Code is derived from the Algol procedure hqr2,
* by Martin and Wilkinson, Handbook for Auto. Comp., * by Martin and Wilkinson, Handbook for Auto. Comp.,
* Vol.ii-Linear Algebra, and the corresponding * Vol.ii-Linear Algebra, and the corresponding
* Fortran subroutine in EISPACK. * Fortran subroutine in EISPACK.
*/ */
private function hqr2() private function hqr2()
{ {
@ -781,12 +781,12 @@ class EigenvalueDecomposition
// end hqr2 // end hqr2
/** /**
* Constructor: Check for symmetry, then construct the eigenvalue decomposition. * Constructor: Check for symmetry, then construct the eigenvalue decomposition.
* *
* @param A Square matrix * @param A Square matrix
* @param mixed $Arg * @param mixed $Arg
* *
* @return Structure to access D and V * @return Structure to access D and V
*/ */
public function __construct($Arg) public function __construct($Arg)
{ {
@ -817,9 +817,9 @@ class EigenvalueDecomposition
} }
/** /**
* Return the eigenvector matrix. * Return the eigenvector matrix.
* *
* @return V * @return V
*/ */
public function getV() public function getV()
{ {
@ -827,9 +827,9 @@ class EigenvalueDecomposition
} }
/** /**
* Return the real parts of the eigenvalues. * Return the real parts of the eigenvalues.
* *
* @return real(diag(D)) * @return real(diag(D))
*/ */
public function getRealEigenvalues() public function getRealEigenvalues()
{ {
@ -837,9 +837,9 @@ class EigenvalueDecomposition
} }
/** /**
* Return the imaginary parts of the eigenvalues. * Return the imaginary parts of the eigenvalues.
* *
* @return imag(diag(D)) * @return imag(diag(D))
*/ */
public function getImagEigenvalues() public function getImagEigenvalues()
{ {
@ -847,9 +847,9 @@ class EigenvalueDecomposition
} }
/** /**
* Return the block diagonal eigenvalue matrix. * Return the block diagonal eigenvalue matrix.
* *
* @return D * @return D
*/ */
public function getD() public function getD()
{ {

Some files were not shown because too many files have changed in this diff Show More