diff --git a/src/Bootstrap.php b/src/Bootstrap.php index e9961c41..b7062b5a 100644 --- a/src/Bootstrap.php +++ b/src/Bootstrap.php @@ -12,12 +12,12 @@ * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * diff --git a/src/PhpSpreadsheet/CachedObjectStorage/APC.php b/src/PhpSpreadsheet/CachedObjectStorage/APC.php index 2223b728..12d6f345 100644 --- a/src/PhpSpreadsheet/CachedObjectStorage/APC.php +++ b/src/PhpSpreadsheet/CachedObjectStorage/APC.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\CachedObjectStorage; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -42,9 +42,9 @@ class APC extends CacheBase implements ICache /** * 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() { @@ -67,12 +67,12 @@ class APC extends CacheBase implements ICache /** * Add or Update a cell in cache identified by coordinate address. * - * @param string $pCoord Coordinate address of the cell to update - * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update + * @param string $pCoord Coordinate address of the 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) { @@ -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? * - * @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) { @@ -121,11 +121,11 @@ class APC extends CacheBase implements ICache /** * 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) { @@ -160,7 +160,7 @@ class APC extends CacheBase implements ICache /** * Get a list of all cell addresses currently held in cache. * - * @return string[] + * @return string[] */ public function getCellList() { @@ -174,9 +174,9 @@ class APC extends CacheBase implements ICache /** * 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) { @@ -190,9 +190,9 @@ class APC extends CacheBase implements ICache /** * 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) { @@ -240,8 +240,8 @@ class APC extends CacheBase implements ICache /** * Initialise this new cell collection. * - * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The worksheet for this cell collection - * @param array of mixed $arguments Additional initialisation arguments + * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The worksheet for this cell collection + * @param array $arguments Additional initialisation 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 * Some methods are dependent on the availability of certain extensions being enabled in the PHP build. * - * @return bool + * @return bool */ public static function cacheMethodIsAvailable() { diff --git a/src/PhpSpreadsheet/CachedObjectStorage/CacheBase.php b/src/PhpSpreadsheet/CachedObjectStorage/CacheBase.php index ecb4e35f..db224696 100644 --- a/src/PhpSpreadsheet/CachedObjectStorage/CacheBase.php +++ b/src/PhpSpreadsheet/CachedObjectStorage/CacheBase.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\CachedObjectStorage; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -56,7 +56,7 @@ abstract class CacheBase /** * 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 */ @@ -65,7 +65,7 @@ abstract class CacheBase /** * 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) { @@ -78,7 +78,7 @@ abstract class CacheBase /** * Return the parent worksheet for this cell collection. * - * @return \PhpOffice\PhpSpreadsheet\Worksheet + * @return \PhpOffice\PhpSpreadsheet\Worksheet */ 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? * - * @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) { @@ -104,10 +104,10 @@ abstract class CacheBase /** * Move a cell object from one address to another. * - * @param string $fromAddress Current address of the cell to move - * @param string $toAddress Destination 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 * - * @return bool + * @return bool */ public function moveCell($fromAddress, $toAddress) { @@ -126,11 +126,11 @@ abstract class CacheBase /** * 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) { @@ -140,9 +140,9 @@ abstract class CacheBase /** * 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) { @@ -161,7 +161,7 @@ abstract class CacheBase /** * Get a list of all cell addresses currently held in cache. * - * @return string[] + * @return string[] */ 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. * - * @return string[] + * @return string[] */ public function getSortedCellList() { @@ -215,7 +215,7 @@ abstract class CacheBase /** * Return the cell address of the currently active cell object. * - * @return string + * @return string */ public function getCurrentAddress() { @@ -225,7 +225,7 @@ abstract class CacheBase /** * Return the column address of the currently active cell object. * - * @return string + * @return string */ public function getCurrentColumn() { @@ -237,7 +237,7 @@ abstract class CacheBase /** * Return the row address of the currently active cell object. * - * @return int + * @return int */ public function getCurrentRow() { @@ -249,10 +249,10 @@ abstract class CacheBase /** * Get highest worksheet column. * - * @param string $row Return the highest column for the specified row, - * or the highest column of any row if no row number is passed + * @param string $row Return the highest column for the specified row, + * 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) { @@ -277,10 +277,10 @@ abstract class CacheBase /** * Get highest worksheet row. * - * @param string $column Return the highest row for the specified column, - * or the highest row of any column if no column letter is passed + * @param string $column Return the highest row for the specified column, + * 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) { @@ -321,7 +321,7 @@ abstract class CacheBase /** * 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) { @@ -337,7 +337,7 @@ abstract class CacheBase /** * 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) { @@ -352,7 +352,7 @@ abstract class CacheBase /** * 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) { @@ -368,7 +368,7 @@ abstract class CacheBase * Identify whether the caching method is currently available * Some methods are dependent on the availability of certain extensions being enabled in the PHP build. * - * @return bool + * @return bool */ public static function cacheMethodIsAvailable() { diff --git a/src/PhpSpreadsheet/CachedObjectStorage/DiscISAM.php b/src/PhpSpreadsheet/CachedObjectStorage/DiscISAM.php index 9bda9662..d630742b 100644 --- a/src/PhpSpreadsheet/CachedObjectStorage/DiscISAM.php +++ b/src/PhpSpreadsheet/CachedObjectStorage/DiscISAM.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\CachedObjectStorage; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -49,9 +49,9 @@ class DiscISAM extends CacheBase implements ICache /** * 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() { @@ -72,12 +72,12 @@ class DiscISAM extends CacheBase implements ICache /** * Add or Update a cell in cache identified by coordinate address. * - * @param string $pCoord Coordinate address of the cell to update - * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update + * @param string $pCoord Coordinate address of the 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) { @@ -95,11 +95,11 @@ class DiscISAM extends CacheBase implements ICache /** * 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) { @@ -128,7 +128,7 @@ class DiscISAM extends CacheBase implements ICache /** * Get a list of all cell addresses currently held in cache. * - * @return string[] + * @return string[] */ public function getCellList() { @@ -142,7 +142,7 @@ class DiscISAM extends CacheBase implements ICache /** * 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) { @@ -178,8 +178,8 @@ class DiscISAM extends CacheBase implements ICache /** * Initialise this new cell collection. * - * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The worksheet for this cell collection - * @param array of mixed $arguments Additional initialisation arguments + * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The worksheet for this cell collection + * @param array of mixed $arguments Additional initialisation arguments */ public function __construct(\PhpOffice\PhpSpreadsheet\Worksheet $parent, $arguments) { diff --git a/src/PhpSpreadsheet/CachedObjectStorage/ICache.php b/src/PhpSpreadsheet/CachedObjectStorage/ICache.php index a39b9335..9c2edefa 100644 --- a/src/PhpSpreadsheet/CachedObjectStorage/ICache.php +++ b/src/PhpSpreadsheet/CachedObjectStorage/ICache.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\CachedObjectStorage; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -29,73 +29,73 @@ interface ICache /** * Add or Update a cell in cache identified by coordinate address. * - * @param string $pCoord Coordinate address of the cell to update - * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update + * @param string $pCoord Coordinate address of the 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); /** * 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); /** * 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); /** * 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); /** * 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); /** * Get a list of all cell addresses currently held in cache. * - * @return string[] + * @return string[] */ public function getCellList(); /** * Get the list of all cell addresses currently held in cache sorted by column and row. * - * @return string[] + * @return string[] */ public function getSortedCellList(); /** * 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); @@ -103,7 +103,7 @@ interface ICache * Identify whether the caching method is currently available * Some methods are dependent on the availability of certain extensions being enabled in the PHP build. * - * @return bool + * @return bool */ public static function cacheMethodIsAvailable(); } diff --git a/src/PhpSpreadsheet/CachedObjectStorage/Igbinary.php b/src/PhpSpreadsheet/CachedObjectStorage/Igbinary.php index dcd34d9b..86ea2a12 100644 --- a/src/PhpSpreadsheet/CachedObjectStorage/Igbinary.php +++ b/src/PhpSpreadsheet/CachedObjectStorage/Igbinary.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\CachedObjectStorage; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -28,9 +28,9 @@ class Igbinary extends CacheBase implements ICache { /** * 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() { @@ -48,12 +48,12 @@ class Igbinary extends CacheBase implements ICache /** * Add or Update a cell in cache identified by coordinate address. * - * @param string $pCoord Coordinate address of the cell to update - * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update + * @param string $pCoord Coordinate address of the 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) { @@ -71,11 +71,11 @@ class Igbinary extends CacheBase implements ICache /** * 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) { @@ -105,7 +105,7 @@ class Igbinary extends CacheBase implements ICache /** * Get a list of all cell addresses currently held in cache. * - * @return string[] + * @return string[] */ public function getCellList() { @@ -137,7 +137,7 @@ class Igbinary extends CacheBase implements ICache * Identify whether the caching method is currently available * Some methods are dependent on the availability of certain extensions being enabled in the PHP build. * - * @return bool + * @return bool */ public static function cacheMethodIsAvailable() { diff --git a/src/PhpSpreadsheet/CachedObjectStorage/Memcache.php b/src/PhpSpreadsheet/CachedObjectStorage/Memcache.php index b3323bb4..a760b38a 100644 --- a/src/PhpSpreadsheet/CachedObjectStorage/Memcache.php +++ b/src/PhpSpreadsheet/CachedObjectStorage/Memcache.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\CachedObjectStorage; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -49,9 +49,9 @@ class Memcache extends CacheBase implements ICache /** * 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() { @@ -73,12 +73,12 @@ class Memcache extends CacheBase implements ICache /** * Add or Update a cell in cache identified by coordinate address. * - * @param string $pCoord Coordinate address of the cell to update - * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update + * @param string $pCoord Coordinate address of the 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) { @@ -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? * - * @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) { @@ -127,11 +127,11 @@ class Memcache extends CacheBase implements ICache /** * 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) { @@ -166,7 +166,7 @@ class Memcache extends CacheBase implements ICache /** * Get a list of all cell addresses currently held in cache. * - * @return string[] + * @return string[] */ public function getCellList() { @@ -180,9 +180,9 @@ class Memcache extends CacheBase implements ICache /** * 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) { @@ -196,9 +196,9 @@ class Memcache extends CacheBase implements ICache /** * 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) { @@ -246,10 +246,10 @@ class Memcache extends CacheBase implements ICache /** * Initialise this new cell collection. * - * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The worksheet for this cell collection - * @param mixed[] $arguments Additional initialisation arguments + * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The worksheet for this cell collection + * @param mixed[] $arguments Additional initialisation arguments * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception */ public function __construct(\PhpOffice\PhpSpreadsheet\Worksheet $parent, $arguments) { @@ -275,10 +275,10 @@ class Memcache extends CacheBase implements ICache /** * Memcache error handler. * - * @param string $host Memcache server - * @param int $port Memcache port + * @param string $host Memcache server + * @param int $port Memcache port * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception */ public function failureCallback($host, $port) { @@ -300,7 +300,7 @@ class Memcache extends CacheBase implements ICache * Identify whether the caching method is currently available * Some methods are dependent on the availability of certain extensions being enabled in the PHP build. * - * @return bool + * @return bool */ public static function cacheMethodIsAvailable() { diff --git a/src/PhpSpreadsheet/CachedObjectStorage/Memory.php b/src/PhpSpreadsheet/CachedObjectStorage/Memory.php index 3b776de0..57d0c496 100644 --- a/src/PhpSpreadsheet/CachedObjectStorage/Memory.php +++ b/src/PhpSpreadsheet/CachedObjectStorage/Memory.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\CachedObjectStorage; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -36,12 +36,12 @@ class Memory extends CacheBase implements ICache /** * Add or Update a cell in cache identified by coordinate address. * - * @param string $pCoord Coordinate address of the cell to update - * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update + * @param string $pCoord Coordinate address of the 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) { @@ -56,11 +56,11 @@ class Memory extends CacheBase implements ICache /** * 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) { @@ -81,7 +81,7 @@ class Memory extends CacheBase implements ICache /** * 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) { diff --git a/src/PhpSpreadsheet/CachedObjectStorage/MemoryGZip.php b/src/PhpSpreadsheet/CachedObjectStorage/MemoryGZip.php index 7266c2e3..8483fbb6 100644 --- a/src/PhpSpreadsheet/CachedObjectStorage/MemoryGZip.php +++ b/src/PhpSpreadsheet/CachedObjectStorage/MemoryGZip.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\CachedObjectStorage; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -28,9 +28,9 @@ class MemoryGZip extends CacheBase implements ICache { /** * 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() { @@ -46,12 +46,12 @@ class MemoryGZip extends CacheBase implements ICache /** * Add or Update a cell in cache identified by coordinate address. * - * @param string $pCoord Coordinate address of the cell to update - * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update + * @param string $pCoord Coordinate address of the 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) { @@ -69,11 +69,11 @@ class MemoryGZip extends CacheBase implements ICache /** * 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) { @@ -101,7 +101,7 @@ class MemoryGZip extends CacheBase implements ICache /** * Get a list of all cell addresses currently held in cache. * - * @return string[] + * @return string[] */ public function getCellList() { diff --git a/src/PhpSpreadsheet/CachedObjectStorage/MemorySerialized.php b/src/PhpSpreadsheet/CachedObjectStorage/MemorySerialized.php index 55048389..2c3069c9 100644 --- a/src/PhpSpreadsheet/CachedObjectStorage/MemorySerialized.php +++ b/src/PhpSpreadsheet/CachedObjectStorage/MemorySerialized.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\CachedObjectStorage; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -28,9 +28,9 @@ class MemorySerialized extends CacheBase implements ICache { /** * 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() { @@ -46,12 +46,12 @@ class MemorySerialized extends CacheBase implements ICache /** * Add or Update a cell in cache identified by coordinate address. * - * @param string $pCoord Coordinate address of the cell to update - * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update + * @param string $pCoord Coordinate address of the 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) { @@ -69,11 +69,11 @@ class MemorySerialized extends CacheBase implements ICache /** * 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) { @@ -101,7 +101,7 @@ class MemorySerialized extends CacheBase implements ICache /** * Get a list of all cell addresses currently held in cache. * - * @return string[] + * @return string[] */ public function getCellList() { diff --git a/src/PhpSpreadsheet/CachedObjectStorage/PHPTemp.php b/src/PhpSpreadsheet/CachedObjectStorage/PHPTemp.php index 7624e279..e2497436 100644 --- a/src/PhpSpreadsheet/CachedObjectStorage/PHPTemp.php +++ b/src/PhpSpreadsheet/CachedObjectStorage/PHPTemp.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\CachedObjectStorage; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -42,9 +42,9 @@ class PHPTemp extends CacheBase implements ICache /** * 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() { @@ -65,12 +65,12 @@ class PHPTemp extends CacheBase implements ICache /** * Add or Update a cell in cache identified by coordinate address. * - * @param string $pCoord Coordinate address of the cell to update - * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update + * @param string $pCoord Coordinate address of the 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) { @@ -88,11 +88,11 @@ class PHPTemp extends CacheBase implements ICache /** * 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) { @@ -121,7 +121,7 @@ class PHPTemp extends CacheBase implements ICache /** * Get a list of all cell addresses currently held in cache. * - * @return string[] + * @return string[] */ public function getCellList() { @@ -135,7 +135,7 @@ class PHPTemp extends CacheBase implements ICache /** * 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) { @@ -171,8 +171,8 @@ class PHPTemp extends CacheBase implements ICache /** * Initialise this new cell collection. * - * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The worksheet for this cell collection - * @param mixed[] $arguments Additional initialisation arguments + * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The worksheet for this cell collection + * @param mixed[] $arguments Additional initialisation arguments */ public function __construct(\PhpOffice\PhpSpreadsheet\Worksheet $parent, $arguments) { diff --git a/src/PhpSpreadsheet/CachedObjectStorage/SQLite.php b/src/PhpSpreadsheet/CachedObjectStorage/SQLite.php index 0f66ac82..2139b950 100644 --- a/src/PhpSpreadsheet/CachedObjectStorage/SQLite.php +++ b/src/PhpSpreadsheet/CachedObjectStorage/SQLite.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\CachedObjectStorage; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -42,9 +42,9 @@ class SQLite extends CacheBase implements ICache /** * 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() { @@ -62,12 +62,12 @@ class SQLite extends CacheBase implements ICache /** * Add or Update a cell in cache identified by coordinate address. * - * @param string $pCoord Coordinate address of the cell to update - * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update + * @param string $pCoord Coordinate address of the 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) { @@ -85,11 +85,11 @@ class SQLite extends CacheBase implements ICache /** * 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) { @@ -122,11 +122,11 @@ class SQLite extends CacheBase implements ICache /** * 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) { @@ -150,9 +150,9 @@ class SQLite extends CacheBase implements ICache /** * 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) { @@ -173,12 +173,12 @@ class SQLite extends CacheBase implements ICache /** * Move a cell object from one address to another. * - * @param string $fromAddress Current address of the cell to move - * @param string $toAddress Destination 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 * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return bool + * @return bool */ 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. * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return string[] + * @return string[] */ public function getCellList() { @@ -231,9 +231,9 @@ class SQLite extends CacheBase implements ICache /** * 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) { @@ -271,9 +271,9 @@ class SQLite extends CacheBase implements ICache /** * 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) { @@ -307,7 +307,7 @@ class SQLite extends CacheBase implements ICache * Identify whether the caching method is currently available * Some methods are dependent on the availability of certain extensions being enabled in the PHP build. * - * @return bool + * @return bool */ public static function cacheMethodIsAvailable() { diff --git a/src/PhpSpreadsheet/CachedObjectStorage/SQLite3.php b/src/PhpSpreadsheet/CachedObjectStorage/SQLite3.php index f18516f8..3f78e911 100644 --- a/src/PhpSpreadsheet/CachedObjectStorage/SQLite3.php +++ b/src/PhpSpreadsheet/CachedObjectStorage/SQLite3.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\CachedObjectStorage; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -70,9 +70,9 @@ class SQLite3 extends CacheBase implements ICache /** * 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() { @@ -93,12 +93,12 @@ class SQLite3 extends CacheBase implements ICache /** * Add or Update a cell in cache identified by coordinate address. * - * @param string $pCoord Coordinate address of the cell to update - * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update + * @param string $pCoord Coordinate address of the 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) { @@ -116,12 +116,12 @@ class SQLite3 extends CacheBase implements ICache /** * 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) { @@ -155,11 +155,11 @@ class SQLite3 extends CacheBase implements ICache /** * 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) { @@ -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) { @@ -205,12 +205,12 @@ class SQLite3 extends CacheBase implements ICache /** * Move a cell object from one address to another. * - * @param string $fromAddress Current address of the cell to move - * @param string $toAddress Destination 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 * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return bool + * @return bool */ 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. * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return string[] + * @return string[] */ public function getCellList() { @@ -264,9 +264,9 @@ class SQLite3 extends CacheBase implements ICache /** * 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) { @@ -304,9 +304,9 @@ class SQLite3 extends CacheBase implements ICache /** * 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) { @@ -346,7 +346,7 @@ class SQLite3 extends CacheBase implements ICache * Identify whether the caching method is currently available * Some methods are dependent on the availability of certain extensions being enabled in the PHP build. * - * @return bool + * @return bool */ public static function cacheMethodIsAvailable() { diff --git a/src/PhpSpreadsheet/CachedObjectStorage/Wincache.php b/src/PhpSpreadsheet/CachedObjectStorage/Wincache.php index bec52f05..8dc656f7 100644 --- a/src/PhpSpreadsheet/CachedObjectStorage/Wincache.php +++ b/src/PhpSpreadsheet/CachedObjectStorage/Wincache.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\CachedObjectStorage; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -42,9 +42,9 @@ class Wincache extends CacheBase implements ICache /** * 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() { @@ -72,12 +72,12 @@ class Wincache extends CacheBase implements ICache /** * Add or Update a cell in cache identified by coordinate address. * - * @param string $pCoord Coordinate address of the cell to update - * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to update + * @param string $pCoord Coordinate address of the 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) { @@ -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? * - * @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) { @@ -126,11 +126,11 @@ class Wincache extends CacheBase implements ICache /** * 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) { @@ -167,7 +167,7 @@ class Wincache extends CacheBase implements ICache /** * Get a list of all cell addresses currently held in cache. * - * @return string[] + * @return string[] */ public function getCellList() { @@ -181,9 +181,9 @@ class Wincache extends CacheBase implements ICache /** * 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) { @@ -197,9 +197,9 @@ class Wincache extends CacheBase implements ICache /** * 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) { @@ -248,8 +248,8 @@ class Wincache extends CacheBase implements ICache /** * Initialise this new cell collection. * - * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The worksheet for this cell collection - * @param mixed[] $arguments Additional initialisation arguments + * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent The worksheet for this cell collection + * @param mixed[] $arguments Additional initialisation 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 * Some methods are dependent on the availability of certain extensions being enabled in the PHP build. * - * @return bool + * @return bool */ public static function cacheMethodIsAvailable() { diff --git a/src/PhpSpreadsheet/CachedObjectStorageFactory.php b/src/PhpSpreadsheet/CachedObjectStorageFactory.php index a8c1e4b5..e8af0bec 100644 --- a/src/PhpSpreadsheet/CachedObjectStorageFactory.php +++ b/src/PhpSpreadsheet/CachedObjectStorageFactory.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -160,8 +160,8 @@ class CachedObjectStorageFactory /** * Identify the cache storage method to use. * - * @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 string $method Name of the method to use for cell cacheing + * @param mixed[] $arguments Additional arguments to pass to the cell caching class * when instantiating * * @return bool @@ -195,9 +195,9 @@ class CachedObjectStorageFactory /** * 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) { diff --git a/src/PhpSpreadsheet/CalcEngine/CyclicReferenceStack.php b/src/PhpSpreadsheet/CalcEngine/CyclicReferenceStack.php index fad3e6b4..437e235d 100644 --- a/src/PhpSpreadsheet/CalcEngine/CyclicReferenceStack.php +++ b/src/PhpSpreadsheet/CalcEngine/CyclicReferenceStack.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\CalcEngine; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -27,16 +27,16 @@ namespace PhpOffice\PhpSpreadsheet\CalcEngine; class CyclicReferenceStack { /** - * The call stack for calculated cells. + * The call stack for calculated cells. * - * @var mixed[] + * @var mixed[] */ private $stack = []; /** * Return the number of entries on the stack. * - * @return int + * @return int */ public function count() { @@ -46,7 +46,7 @@ class CyclicReferenceStack /** * Push a new entry onto the stack. * - * @param mixed $value + * @param mixed $value */ public function push($value) { @@ -56,7 +56,7 @@ class CyclicReferenceStack /** * Pop the last entry from the stack. * - * @return mixed + * @return mixed */ public function pop() { @@ -66,7 +66,7 @@ class CyclicReferenceStack /** * 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) { @@ -84,7 +84,7 @@ class CyclicReferenceStack /** * Return an array of all entries on the stack. * - * @return mixed[] + * @return mixed[] */ public function showStack() { diff --git a/src/PhpSpreadsheet/CalcEngine/Logger.php b/src/PhpSpreadsheet/CalcEngine/Logger.php index b81fd9ff..cde401a5 100644 --- a/src/PhpSpreadsheet/CalcEngine/Logger.php +++ b/src/PhpSpreadsheet/CalcEngine/Logger.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\CalcEngine; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -62,7 +62,7 @@ class Logger /** * Instantiate a Calculation engine logger. * - * @param CyclicReferenceStack $stack + * @param CyclicReferenceStack $stack */ public function __construct(CyclicReferenceStack $stack) { @@ -72,7 +72,7 @@ class Logger /** * Enable/Disable Calculation engine logging. * - * @param bool $pValue + * @param bool $pValue */ public function setWriteDebugLog($pValue = false) { @@ -82,7 +82,7 @@ class Logger /** * Return whether calculation engine logging is enabled or disabled. * - * @return bool + * @return bool */ public function getWriteDebugLog() { @@ -92,7 +92,7 @@ class Logger /** * Enable/Disable echoing of debug log information. * - * @param bool $pValue + * @param bool $pValue */ public function setEchoDebugLog($pValue = false) { @@ -102,7 +102,7 @@ class Logger /** * Return whether echoing of debug log information is enabled or disabled. * - * @return bool + * @return bool */ public function getEchoDebugLog() { @@ -141,7 +141,7 @@ class Logger /** * Return the calculation engine debug log. * - * @return string[] + * @return string[] */ public function getLog() { diff --git a/src/PhpSpreadsheet/Calculation.php b/src/PhpSpreadsheet/Calculation.php index 761121e8..bc994987 100644 --- a/src/PhpSpreadsheet/Calculation.php +++ b/src/PhpSpreadsheet/Calculation.php @@ -39,12 +39,12 @@ if (!defined('CALCULATION_REGEXP_CELLREF')) { * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -165,7 +165,7 @@ class Calculation /** * Current iteration counter for cyclic formulae * 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 */ @@ -2051,7 +2051,7 @@ class Calculation /** * 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 * * @return Calculation @@ -2075,7 +2075,7 @@ class Calculation /** * 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() { @@ -2104,7 +2104,7 @@ class Calculation /** * __clone implementation. Cloning should not be allowed in a Singleton! * - * @throws Calculation\Exception + * @throws Calculation\Exception */ final public function __clone() { @@ -2114,7 +2114,7 @@ class Calculation /** * 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() { @@ -2124,7 +2124,7 @@ class Calculation /** * 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() { @@ -2134,9 +2134,9 @@ class Calculation /** * 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) { @@ -2154,7 +2154,7 @@ class Calculation /** * 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() { @@ -2245,7 +2245,7 @@ class Calculation /** * 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 */ @@ -2511,11 +2511,11 @@ class Calculation * Calculate cell value (using formula from a cell ID) * 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) { @@ -2529,12 +2529,12 @@ class Calculation /** * Calculate the value of a cell formula. * - * @param Cell $pCell Cell to calculate - * @param bool $resetLog Flag indicating whether the debug log should be reset or not + * @param Cell $pCell Cell to calculate + * @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) { @@ -2606,11 +2606,11 @@ class Calculation /** * 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) { @@ -2632,13 +2632,13 @@ class Calculation /** * Calculate the value of a formula. * - * @param string $formula Formula to parse - * @param string $cellID Address of the cell to calculate - * @param Cell $pCell Cell to calculate + * @param string $formula Formula to parse + * @param string $cellID Address of the 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) { @@ -2702,13 +2702,13 @@ class Calculation /** * Parse a cell formula and calculate its value. * - * @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 Cell $pCell Cell to 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 Cell $pCell Cell to calculate * - * @throws Calculation\Exception + * @throws Calculation\Exception * - * @return mixed + * @return mixed */ 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. * - * @param mixed &$operand1 First matrix operand - * @param mixed &$operand2 Second matrix operand - * @param int $resize Flag indicating whether the matrices should be resized to match + * @param mixed &$operand1 First matrix operand + * @param mixed &$operand2 Second matrix operand + * @param int $resize Flag indicating whether the matrices should be resized to match * and (if so), whether the smaller dimension should grow or the * larger should shrink. * 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. * - * @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) { @@ -2837,12 +2837,12 @@ class Calculation /** * Ensure that paired matrix operands are both matrices of the same size. * - * @param mixed &$matrix1 First matrix operand - * @param mixed &$matrix2 Second matrix operand - * @param int $matrix1Rows Row 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 $matrix2Columns Column size of second matrix operand + * @param mixed &$matrix1 First matrix operand + * @param mixed &$matrix2 Second matrix operand + * @param int $matrix1Rows Row 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 $matrix2Columns Column size of second matrix operand */ 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. * - * @param mixed &$matrix1 First matrix operand - * @param mixed &$matrix2 Second matrix operand - * @param int $matrix1Rows Row 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 $matrix2Columns Column size of second matrix operand + * @param mixed &$matrix1 First matrix operand + * @param mixed &$matrix2 Second matrix operand + * @param int $matrix1Rows Row 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 $matrix2Columns Column size of second matrix operand */ 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). * - * @param mixed $value First matrix operand + * @param mixed $value First matrix operand * - * @return mixed + * @return mixed */ 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). * - * @param mixed $value First matrix operand + * @param mixed $value First matrix operand * - * @return string|null + * @return string|null */ 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. * - * @param string $str1 First string value for the comparison - * @param string $str2 Second string value for the comparison + * @param string $str1 First string value for the comparison + * @param string $str2 Second string value for the comparison * - * @return int + * @return int */ private function strcmpLowercaseFirst($str1, $str2) { @@ -4058,13 +4058,13 @@ class Calculation /** * Extract range values. * - * @param string &$pRange String based range representation - * @param Worksheet $pSheet Worksheet - * @param bool $resetLog Flag indicating whether calculation log should be reset or not + * @param string &$pRange String based range representation + * @param Worksheet $pSheet Worksheet + * @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) { @@ -4109,13 +4109,13 @@ class Calculation /** * Extract range values. * - * @param string &$pRange String based range representation - * @param Worksheet $pSheet Worksheet - * @param bool $resetLog Flag indicating whether calculation log should be reset or not + * @param string &$pRange String based range representation + * @param Worksheet $pSheet Worksheet + * @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) { @@ -4175,9 +4175,9 @@ class Calculation /** * Is a specific function implemented? * - * @param string $pFunction Function Name + * @param string $pFunction Function Name * - * @return bool + * @return bool */ public function isImplemented($pFunction) { @@ -4190,7 +4190,7 @@ class Calculation /** * 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() { @@ -4200,7 +4200,7 @@ class Calculation /** * Get a list of implemented Excel function names. * - * @return array + * @return array */ public function getImplementedFunctionNames() { diff --git a/src/PhpSpreadsheet/Calculation/Category.php b/src/PhpSpreadsheet/Calculation/Category.php index ae876516..a3d2c31e 100644 --- a/src/PhpSpreadsheet/Calculation/Category.php +++ b/src/PhpSpreadsheet/Calculation/Category.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Calculation; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * diff --git a/src/PhpSpreadsheet/Calculation/Database.php b/src/PhpSpreadsheet/Calculation/Database.php index 90c97f25..72e2a88e 100644 --- a/src/PhpSpreadsheet/Calculation/Database.php +++ b/src/PhpSpreadsheet/Calculation/Database.php @@ -31,17 +31,17 @@ class Database * * 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 * information are records, and columns of data are fields. The * 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 * "Age" or "Yield," or a number (without quotation marks) that * represents the position of the column within the list: 1 for * the first column, 2 for the second column, and so on. * - * @return string|null + * @return string|null */ 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 * 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 * information are records, and columns of data are fields. The * 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 * includes at least one column label and at least one cell below * the column label in which you specify a condition for the * column. * - * @return array of mixed + * @return array of mixed */ private static function filter($database, $criteria) { @@ -154,22 +154,22 @@ class Database * * @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 * information are records, and columns of data are fields. The * 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 * "Age" or "Yield," or a number (without quotation marks) that * represents the position of the column within the list: 1 for * 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 * includes at least one column label and at least one cell below * the column label in which you specify a condition for the * column. * - * @return float + * @return float */ public static function DAVERAGE($database, $field, $criteria) { @@ -198,22 +198,22 @@ class Database * * @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 * information are records, and columns of data are fields. The * 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 * "Age" or "Yield," or a number (without quotation marks) that * represents the position of the column within the list: 1 for * 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 * includes at least one column label and at least one cell below * the column label in which you specify a condition for the * column. * - * @return int + * @return int * * @TODO The field argument is optional. If field is omitted, DCOUNT counts all records in the * database that match the criteria. @@ -241,22 +241,22 @@ class Database * * @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 * information are records, and columns of data are fields. The * 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 * "Age" or "Yield," or a number (without quotation marks) that * represents the position of the column within the list: 1 for * 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 * includes at least one column label and at least one cell below * the column label in which you specify a condition for the * column. * - * @return int + * @return int * * @TODO The field argument is optional. If field is omitted, DCOUNTA counts all records in the * database that match the criteria. @@ -293,22 +293,22 @@ class Database * * @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 * information are records, and columns of data are fields. The * 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 * "Age" or "Yield," or a number (without quotation marks) that * represents the position of the column within the list: 1 for * 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 * includes at least one column label and at least one cell below * the column label in which you specify a condition for the * column. * - * @return mixed + * @return mixed */ public static function DGET($database, $field, $criteria) { @@ -337,22 +337,22 @@ class Database * * @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 * information are records, and columns of data are fields. The * 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 * "Age" or "Yield," or a number (without quotation marks) that * represents the position of the column within the list: 1 for * 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 * includes at least one column label and at least one cell below * the column label in which you specify a condition for the * column. * - * @return float + * @return float */ public static function DMAX($database, $field, $criteria) { @@ -378,22 +378,22 @@ class Database * * @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 * information are records, and columns of data are fields. The * 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 * "Age" or "Yield," or a number (without quotation marks) that * represents the position of the column within the list: 1 for * 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 * includes at least one column label and at least one cell below * the column label in which you specify a condition for the * column. * - * @return float + * @return float */ public static function DMIN($database, $field, $criteria) { @@ -418,22 +418,22 @@ class Database * * @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 * information are records, and columns of data are fields. The * 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 * "Age" or "Yield," or a number (without quotation marks) that * represents the position of the column within the list: 1 for * 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 * includes at least one column label and at least one cell below * the column label in which you specify a condition for the * column. * - * @return float + * @return float */ public static function DPRODUCT($database, $field, $criteria) { @@ -459,22 +459,22 @@ class Database * * @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 * information are records, and columns of data are fields. The * 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 * "Age" or "Yield," or a number (without quotation marks) that * represents the position of the column within the list: 1 for * 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 * includes at least one column label and at least one cell below * the column label in which you specify a condition for the * column. * - * @return float + * @return float */ public static function DSTDEV($database, $field, $criteria) { @@ -500,22 +500,22 @@ class Database * * @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 * information are records, and columns of data are fields. The * 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 * "Age" or "Yield," or a number (without quotation marks) that * represents the position of the column within the list: 1 for * 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 * includes at least one column label and at least one cell below * the column label in which you specify a condition for the * column. * - * @return float + * @return float */ public static function DSTDEVP($database, $field, $criteria) { @@ -540,22 +540,22 @@ class Database * * @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 * information are records, and columns of data are fields. The * 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 * "Age" or "Yield," or a number (without quotation marks) that * represents the position of the column within the list: 1 for * 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 * includes at least one column label and at least one cell below * the column label in which you specify a condition for the * column. * - * @return float + * @return float */ public static function DSUM($database, $field, $criteria) { @@ -581,22 +581,22 @@ class Database * * @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 * information are records, and columns of data are fields. The * 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 * "Age" or "Yield," or a number (without quotation marks) that * represents the position of the column within the list: 1 for * 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 * includes at least one column label and at least one cell below * the column label in which you specify a condition for the * column. * - * @return float + * @return float */ public static function DVAR($database, $field, $criteria) { @@ -622,22 +622,22 @@ class Database * * @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 * information are records, and columns of data are fields. The * 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 * "Age" or "Yield," or a number (without quotation marks) that * represents the position of the column within the list: 1 for * 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 * includes at least one column label and at least one cell below * the column label in which you specify a condition for the * column. * - * @return float + * @return float */ public static function DVARP($database, $field, $criteria) { diff --git a/src/PhpSpreadsheet/Calculation/DateTime.php b/src/PhpSpreadsheet/Calculation/DateTime.php index 23f0d9e2..11e20a1c 100644 --- a/src/PhpSpreadsheet/Calculation/DateTime.php +++ b/src/PhpSpreadsheet/Calculation/DateTime.php @@ -29,9 +29,9 @@ class DateTime /** * 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) { @@ -41,15 +41,15 @@ class DateTime /** * 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 $startMonth Month of the start date - * @param int $startYear Year of the start date - * @param int $endDay Day of month of the start date - * @param int $endMonth Month 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 int $startDay Day of month of the start date + * @param int $startMonth Month of the start date + * @param int $startYear Year of the start date + * @param int $endDay Day of month of the start date + * @param int $endMonth Month 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 * - * @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) { @@ -78,9 +78,9 @@ class DateTime /** * 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) { @@ -105,9 +105,9 @@ class DateTime /** * 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) { @@ -162,7 +162,7 @@ class DateTime * * @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 */ public static function DATETIMENOW() @@ -202,7 +202,7 @@ class DateTime * * @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 */ public static function DATENOW() @@ -244,7 +244,7 @@ class DateTime * * @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 * date system: 1900 or 1904. * If year is between 0 (zero) and 1899 (inclusive), Excel adds that @@ -255,7 +255,7 @@ class DateTime * 2008. * If year is less than 0 or is 10000 or greater, Excel returns the * #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). * 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) @@ -264,7 +264,7 @@ class DateTime * number of months, plus 1, from the first month in the year * specified. For example, DATE(2008,-3,2) returns the serial number * 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. * 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 @@ -275,7 +275,7 @@ class DateTime * example, DATE(2008,1,-15) returns the serial number representing * 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 */ public static function DATE($year = 0, $month = 1, $day = 1) @@ -358,19 +358,19 @@ class DateTime * * @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 * will be treated as the hour value. For example, TIME(27,0,0) = * 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. * 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, * and seconds. For example, TIME(0,0,2000) = TIME(0,33,22) = .023148 * 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 */ public static function TIME($hour = 0, $minute = 0, $second = 0) @@ -471,7 +471,7 @@ class DateTime * * @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 * quotation marks that represent dates. Using the default date * 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 * #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 */ public static function DATEVALUE($dateValue = 1) @@ -607,12 +607,12 @@ class DateTime * * @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 * within quotation marks that represent time. * 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 */ public static function TIMEVALUE($timeValue) @@ -657,13 +657,13 @@ class DateTime /** * 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 - * @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 - * @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') { @@ -783,11 +783,11 @@ class DateTime * * @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 - * @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 - * @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 * 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 @@ -799,7 +799,7 @@ class DateTime * occur on the 31st of a month become equal to the 30th of the * 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) { @@ -844,18 +844,18 @@ class DateTime * * @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 - * @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 - * @param int $method Method used for the calculation + * @param int $method Method used for the calculation * 0 or omitted US (NASD) 30/360 * 1 Actual/actual * 2 Actual/360 * 3 Actual/365 * 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) { @@ -944,12 +944,12 @@ class DateTime * * @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 - * @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 * - * @return int Interval between the dates + * @return int Interval between the dates */ public static function NETWORKDAYS($startDate, $endDate) { @@ -1026,13 +1026,13 @@ class DateTime * * @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 - * @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 * 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 */ public static function WORKDAY($startDate, $endDays) @@ -1135,10 +1135,10 @@ class DateTime * Excel Function: * 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 * - * @return int Day of the month + * @return int Day of the month */ public static function DAYOFMONTH($dateValue = 1) { @@ -1169,14 +1169,14 @@ class DateTime * Excel Function: * 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 - * @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). * 2 Numbers 1 (Monday) through 7 (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) { @@ -1246,13 +1246,13 @@ class DateTime * Excel Function: * 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 - * @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. * 2 Week begins on Monday. * - * @return int Week Number + * @return int Week Number */ public static function WEEKNUM($dateValue = 1, $method = 1) { @@ -1299,10 +1299,10 @@ class DateTime * Excel Function: * 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 * - * @return int Month of the year + * @return int Month of the year */ public static function MONTHOFYEAR($dateValue = 1) { @@ -1332,10 +1332,10 @@ class DateTime * Excel Function: * 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 * - * @return int Year + * @return int Year */ public static function YEAR($dateValue = 1) { @@ -1364,10 +1364,10 @@ class DateTime * Excel Function: * 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 * - * @return int Hour + * @return int Hour */ public static function HOUROFDAY($timeValue = 0) { @@ -1405,10 +1405,10 @@ class DateTime * Excel Function: * 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 * - * @return int Minute + * @return int Minute */ public static function MINUTE($timeValue = 0) { @@ -1446,10 +1446,10 @@ class DateTime * Excel Function: * 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 * - * @return int Second + * @return int Second */ public static function SECOND($timeValue = 0) { @@ -1489,13 +1489,13 @@ class DateTime * Excel Function: * 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 - * @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 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 */ public static function EDATE($dateValue = 1, $adjustmentMonths = 0) @@ -1535,13 +1535,13 @@ class DateTime * Excel Function: * 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 - * @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 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 */ public static function EOMONTH($dateValue = 1, $adjustmentMonths = 0) diff --git a/src/PhpSpreadsheet/Calculation/Engineering.php b/src/PhpSpreadsheet/Calculation/Engineering.php index 50c388c2..d74a39a8 100644 --- a/src/PhpSpreadsheet/Calculation/Engineering.php +++ b/src/PhpSpreadsheet/Calculation/Engineering.php @@ -738,9 +738,9 @@ class Engineering * * 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) { @@ -793,9 +793,9 @@ class Engineering /** * 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) { @@ -818,10 +818,10 @@ class Engineering /** * Formats a number base string value with leading zeroes. * - * @param string $xVal The "number" to pad - * @param int $places The length that we want to pad this value + * @param string $xVal The "number" to pad + * @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) { @@ -845,7 +845,7 @@ class Engineering } /** - * BESSELI. + * BESSELI. * * Returns the modified Bessel function In(x), which is equivalent to the Bessel function evaluated * for purely imaginary arguments @@ -855,14 +855,14 @@ class Engineering * * @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. - * @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 nonnumeric, BESSELI returns the #VALUE! error value. * If $ord < 0, BESSELI returns the #NUM! error value. * - * @return float + * @return float */ public static function BESSELI($x, $ord) { @@ -901,7 +901,7 @@ class Engineering } /** - * BESSELJ. + * BESSELJ. * * Returns the Bessel function * @@ -910,13 +910,13 @@ class Engineering * * @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. - * @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 < 0, BESSELJ returns the #NUM! error value. * - * @return float + * @return float */ 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 * for purely imaginary arguments. @@ -1003,13 +1003,13 @@ class Engineering * * @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. - * @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 < 0, BESSELK returns the #NUM! error value. * - * @return float + * @return float */ 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: * BESSELY(x,ord) * * @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. - * @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 < 0, BESSELK returns the #NUM! error value. * - * @return float + * @return float */ public static function BESSELY($x, $ord) { @@ -1142,14 +1142,14 @@ class Engineering * * @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 * bit of number is the sign bit. The remaining 9 bits are magnitude bits. * Negative numbers are represented using two's-complement notation. * If number is not a valid binary number, or if number contains more than * 10 characters (10 bits), BIN2DEC returns the #NUM! error value. * - * @return string + * @return string */ public static function BINTODEC($x) { @@ -1191,20 +1191,20 @@ class Engineering * * @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 * bit of number is the sign bit. The remaining 9 bits are magnitude bits. * Negative numbers are represented using two's-complement notation. * If number is not a valid binary number, or if number contains more than * 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 * return value with leading 0s (zeros). * If places is not an integer, it is truncated. * If places is nonnumeric, BIN2HEX returns the #VALUE! error value. * If places is negative, BIN2HEX returns the #NUM! error value. * - * @return string + * @return string */ public static function BINTOHEX($x, $places = null) { @@ -1247,20 +1247,20 @@ class Engineering * * @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 * bit of number is the sign bit. The remaining 9 bits are magnitude bits. * Negative numbers are represented using two's-complement notation. * If number is not a valid binary number, or if number contains more than * 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 * return value with leading 0s (zeros). * If places is not an integer, it is truncated. * If places is nonnumeric, BIN2OCT returns the #VALUE! error value. * If places is negative, BIN2OCT returns the #NUM! error value. * - * @return string + * @return string */ public static function BINTOOCT($x, $places = null) { @@ -1302,7 +1302,7 @@ class Engineering * * @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 * (10-bit) binary number in which the most significant bit is the sign * 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 DEC2BIN requires more than places characters, it returns the #NUM! * 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 * padding the return value with leading 0s (zeros). * If places is not an integer, it is truncated. * If places is nonnumeric, DEC2BIN returns the #VALUE! 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) { @@ -1363,7 +1363,7 @@ class Engineering * * @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) * hexadecimal number in which the most significant bit is the sign * 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 DEC2HEX requires more than places characters, it returns the * #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 * padding the return value with leading 0s (zeros). * If places is not an integer, it is truncated. * If places is nonnumeric, DEC2HEX returns the #VALUE! 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) { @@ -1418,7 +1418,7 @@ class Engineering * * @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) * octal number in which the most significant bit is the sign bit. * 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 DEC2OCT requires more than places characters, it returns the * #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 * padding the return value with leading 0s (zeros). * If places is not an integer, it is truncated. * If places is nonnumeric, DEC2OCT returns the #VALUE! 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) { @@ -1474,7 +1474,7 @@ class Engineering * * @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. * The most significant bit of number is the sign bit (40th bit from the right). * The remaining 9 bits are magnitude bits. @@ -1484,14 +1484,14 @@ class Engineering * 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 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 * is useful for padding the return value with leading 0s (zeros). * If places is not an integer, it is truncated. * If places is nonnumeric, HEX2BIN returns the #VALUE! error value. * If places is negative, HEX2BIN returns the #NUM! error value. * - * @return string + * @return string */ public static function HEXTOBIN($x, $places = null) { @@ -1519,7 +1519,7 @@ class Engineering * * @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 * bit of number is the sign bit. The remaining 39 bits are magnitude * 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 * #NUM! error value. * - * @return string + * @return string */ public static function HEXTODEC($x) { @@ -1570,7 +1570,7 @@ class Engineering * * @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 * number is the sign bit. The remaining 39 bits are magnitude * bits. Negative numbers are represented using two's-complement @@ -1583,7 +1583,7 @@ class Engineering * the #NUM! error value. * If HEX2OCT requires more than places characters, it returns * 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 * useful for padding the return value with leading 0s (zeros). * If places is not an integer, it is truncated. @@ -1591,7 +1591,7 @@ class Engineering * value. * If places is negative, HEX2OCT returns the #NUM! error value. * - * @return string + * @return string */ public static function HEXTOOCT($x, $places = null) { @@ -1624,7 +1624,7 @@ class Engineering * * @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 * bit of number is the sign bit. The remaining 29 bits * are magnitude bits. Negative numbers are represented @@ -1637,7 +1637,7 @@ class Engineering * the #NUM! error value. * If OCT2BIN 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, * OCT2BIN uses the minimum number of characters necessary. * Places is useful for padding the return value with * leading 0s (zeros). @@ -1647,7 +1647,7 @@ class Engineering * If places is negative, OCT2BIN returns the #NUM! error * value. * - * @return string + * @return string */ public static function OCTTOBIN($x, $places = null) { @@ -1675,7 +1675,7 @@ class Engineering * * @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 * bit of number is the sign bit. The remaining 29 bits are * magnitude bits. Negative numbers are represented using @@ -1683,7 +1683,7 @@ class Engineering * If number is not a valid octal number, OCT2DEC returns the * #NUM! error value. * - * @return string + * @return string */ public static function OCTTODEC($x) { @@ -1721,7 +1721,7 @@ class Engineering * * @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 * bit of number is the sign bit. The remaining 29 bits are * magnitude bits. Negative numbers are represented using @@ -1732,14 +1732,14 @@ class Engineering * #NUM! error value. * If OCT2HEX requires more than places characters, it returns * 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 * for padding the return value with leading 0s (zeros). * If places is not an integer, it is truncated. * If places is nonnumeric, OCT2HEX returns the #VALUE! error value. * If places is negative, OCT2HEX returns the #NUM! error value. * - * @return string + * @return string */ public static function OCTTOHEX($x, $places = null) { @@ -1768,12 +1768,12 @@ class Engineering * * @category Engineering Functions * - * @param float $realNumber the real 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 float $realNumber the real 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. * 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') { @@ -1827,10 +1827,10 @@ class Engineering * * @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 * - * @return float + * @return float */ public static function IMAGINARY($complexNumber) { @@ -1851,9 +1851,9 @@ class Engineering * * @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) { @@ -1872,9 +1872,9 @@ class Engineering * Excel Function: * 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) { @@ -1897,9 +1897,9 @@ class Engineering * Excel Function: * 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) { @@ -1930,9 +1930,9 @@ class Engineering * Excel Function: * 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) { @@ -1961,9 +1961,9 @@ class Engineering * Excel Function: * 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) { @@ -1992,9 +1992,9 @@ class Engineering * Excel Function: * 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) { @@ -2021,9 +2021,9 @@ class Engineering * Excel Function: * 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) { @@ -2055,9 +2055,9 @@ class Engineering * Excel Function: * 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) { @@ -2087,9 +2087,9 @@ class Engineering * Excel Function: * 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) { @@ -2114,9 +2114,9 @@ class Engineering * Excel Function: * 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) { @@ -2141,9 +2141,9 @@ class Engineering * Excel Function: * 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) { @@ -2174,10 +2174,10 @@ class Engineering * Excel Function: * IMPOWER(complexNumber,realNumber) * - * @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 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 * - * @return string + * @return string */ public static function IMPOWER($complexNumber, $realNumber) { @@ -2210,10 +2210,10 @@ class Engineering * Excel Function: * IMDIV(complexDividend,complexDivisor) * - * @param string $complexDividend the complex numerator or dividend - * @param string $complexDivisor the complex denominator or divisor + * @param string $complexDividend the complex numerator or dividend + * @param string $complexDivisor the complex denominator or divisor * - * @return string + * @return string */ public static function IMDIV($complexDividend, $complexDivisor) { @@ -2256,10 +2256,10 @@ class Engineering * Excel Function: * IMSUB(complexNumber1,complexNumber2) * - * @param string $complexNumber1 the complex number from which to subtract complexNumber2 - * @param string $complexNumber2 the complex number to subtract from complexNumber1 + * @param string $complexNumber1 the complex number from which to subtract complexNumber2 + * @param string $complexNumber2 the complex number to subtract from complexNumber1 * - * @return string + * @return string */ public static function IMSUB($complexNumber1, $complexNumber2) { @@ -2291,9 +2291,9 @@ class Engineering * Excel Function: * 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() { @@ -2331,9 +2331,9 @@ class Engineering * Excel Function: * 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() { @@ -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 * functions you calculate the count of equal pairs. This function is also known as the - * Kronecker Delta function. + * Kronecker Delta function. * * Excel Function: * DELTA(a[,b]) * - * @param float $a the first number - * @param float $b The second number. If omitted, b is assumed to be zero. + * @param float $a the first number + * @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) { @@ -2388,20 +2388,20 @@ class Engineering } /** - * GESTEP. + * GESTEP. * * Excel Function: * GESTEP(number[,step]) * * Returns 1 if number >= step; returns 0 (zero) otherwise * 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 $step The threshold value. + * @param float $number the value to test against step + * @param float $step The threshold value. * If you omit a value for step, GESTEP uses zero. * - * @return int + * @return int */ 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, * the function would return a #NUM! error. However, in Excel 2010, the function algorithm was @@ -2452,11 +2452,11 @@ class Engineering * Excel Function: * ERF(lower[,upper]) * - * @param float $lower lower bound for integrating ERF - * @param float $upper upper bound for integrating ERF. + * @param float $lower lower bound for integrating ERF + * @param float $upper upper bound for integrating ERF. * If omitted, ERF integrates between zero and lower_limit * - * @return float + * @return float */ 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 * @@ -2521,9 +2521,9 @@ class Engineering * Excel Function: * 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) { @@ -2538,9 +2538,9 @@ class Engineering /** * 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() { @@ -2554,11 +2554,11 @@ class Engineering /** * 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) { @@ -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) { @@ -2596,9 +2596,9 @@ class Engineering /** * 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() { @@ -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 - * in kilometers. + * in kilometers. * * Excel Function: * CONVERT(value,fromUOM,toUOM) * - * @param float $value the value in fromUOM to convert - * @param string $fromUOM the units for value - * @param string $toUOM the units for the result + * @param float $value the value in fromUOM to convert + * @param string $fromUOM the units for value + * @param string $toUOM the units for the result * - * @return float + * @return float */ public static function CONVERTUOM($value, $fromUOM, $toUOM) { diff --git a/src/PhpSpreadsheet/Calculation/Exception.php b/src/PhpSpreadsheet/Calculation/Exception.php index 8674eb1e..6a9711fc 100644 --- a/src/PhpSpreadsheet/Calculation/Exception.php +++ b/src/PhpSpreadsheet/Calculation/Exception.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Calculation; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * diff --git a/src/PhpSpreadsheet/Calculation/ExceptionHandler.php b/src/PhpSpreadsheet/Calculation/ExceptionHandler.php index c9215423..a8b82405 100644 --- a/src/PhpSpreadsheet/Calculation/ExceptionHandler.php +++ b/src/PhpSpreadsheet/Calculation/ExceptionHandler.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Calculation; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * diff --git a/src/PhpSpreadsheet/Calculation/Financial.php b/src/PhpSpreadsheet/Calculation/Financial.php index 5f2ac445..35c44533 100644 --- a/src/PhpSpreadsheet/Calculation/Financial.php +++ b/src/PhpSpreadsheet/Calculation/Financial.php @@ -37,9 +37,9 @@ class Financial * * Returns a boolean TRUE/FALSE indicating if this date is the last date of the month * - * @param DateTime $testDate The date for testing + * @param DateTime $testDate The date for testing * - * @return bool + * @return bool */ private static function isLastDayOfMonth($testDate) { @@ -51,9 +51,9 @@ class Financial * * Returns a boolean TRUE/FALSE indicating if this date is the first date of the month * - * @param DateTime $testDate The date for testing + * @param DateTime $testDate The date for testing * - * @return bool + * @return bool */ private static function isFirstDayOfMonth($testDate) { @@ -99,15 +99,15 @@ class Financial * * Returns the number of days in a specified year, as defined by the "basis" value * - * @param int $year The year against which we're testing - * @param int $basis The type of day count: + * @param int $year The year against which we're testing + * @param int $basis The type of day count: * 0 or omitted US (NASD) 360 * 1 Actual (365 or 366 in a leap year) * 2 360 * 3 365 * 4 European 360 * - * @return int + * @return int */ private static function daysPerYear($year, $basis = 0) { @@ -153,15 +153,15 @@ class Financial * * @category Financial Functions * - * @param mixed $issue the security's issue date - * @param mixed $firstinterest the security's first interest date - * @param mixed $settlement The security's settlement date. + * @param mixed $issue the security's issue date + * @param mixed $firstinterest the security's first interest date + * @param mixed $settlement The security's settlement date. * The security settlement date is the date after the issue date * when the security is traded to the buyer. - * @param float $rate the security's annual coupon rate - * @param float $par The security's par value. + * @param float $rate the security's annual coupon rate + * @param float $par The security's par value. * If you omit par, ACCRINT uses $1,000. - * @param int $frequency the number of coupon payments per year. + * @param int $frequency the number of coupon payments per year. * Valid frequency values are: * 1 Annual * 2 Semi-Annual @@ -170,14 +170,14 @@ class Financial * also available * 6 Bimonthly * 12 Monthly - * @param int $basis The type of day count to use. + * @param int $basis The type of day count to use. * 0 or omitted US (NASD) 30/360 * 1 Actual/actual * 2 Actual/360 * 3 Actual/365 * 4 European 30/360 * - * @return float + * @return float */ public static function ACCRINT($issue, $firstinterest, $settlement, $rate, $par = 1000, $frequency = 1, $basis = 0) { @@ -218,12 +218,12 @@ class Financial * * @category Financial Functions * - * @param mixed issue The security's issue date - * @param mixed settlement The security's settlement (or maturity) date - * @param float rate The security's annual coupon rate - * @param float par The security's par value. + * @param mixed issue The security's issue date + * @param mixed settlement The security's settlement (or maturity) date + * @param float rate The security's annual coupon rate + * @param float par The security's par value. * If you omit par, ACCRINT uses $1,000. - * @param int basis The type of day count to use. + * @param int basis The type of day count to use. * 0 or omitted US (NASD) 30/360 * 1 Actual/actual * 2 Actual/360 @@ -235,7 +235,7 @@ class Financial * @param mixed $par * @param mixed $basis * - * @return float + * @return float */ public static function ACCRINTM($issue, $settlement, $rate, $par = 1000, $basis = 0) { @@ -281,13 +281,13 @@ class Financial * * @category Financial Functions * - * @param float cost The cost of the asset - * @param mixed purchased Date of the purchase of the asset - * @param mixed firstPeriod Date of the end of the first period - * @param mixed salvage The salvage value at the end of the life of the asset - * @param float period The period - * @param float rate Rate of depreciation - * @param int basis The type of day count to use. + * @param float cost The cost of the asset + * @param mixed purchased Date of the purchase of the asset + * @param mixed firstPeriod Date of the end of the first period + * @param mixed salvage The salvage value at the end of the life of the asset + * @param float period The period + * @param float rate Rate of depreciation + * @param int basis The type of day count to use. * 0 or omitted US (NASD) 30/360 * 1 Actual/actual * 2 Actual/360 @@ -301,7 +301,7 @@ class Financial * @param mixed $rate * @param mixed $basis * - * @return float + * @return float */ public static function AMORDEGRC($cost, $purchased, $firstPeriod, $salvage, $period, $rate, $basis = 0) { @@ -366,13 +366,13 @@ class Financial * * @category Financial Functions * - * @param float cost The cost of the asset - * @param mixed purchased Date of the purchase of the asset - * @param mixed firstPeriod Date of the end of the first period - * @param mixed salvage The salvage value at the end of the life of the asset - * @param float period The period - * @param float rate Rate of depreciation - * @param int basis The type of day count to use. + * @param float cost The cost of the asset + * @param mixed purchased Date of the purchase of the asset + * @param mixed firstPeriod Date of the end of the first period + * @param mixed salvage The salvage value at the end of the life of the asset + * @param float period The period + * @param float rate Rate of depreciation + * @param int basis The type of day count to use. * 0 or omitted US (NASD) 30/360 * 1 Actual/actual * 2 Actual/360 @@ -386,7 +386,7 @@ class Financial * @param mixed $rate * @param mixed $basis * - * @return float + * @return float */ public static function AMORLINC($cost, $purchased, $firstPeriod, $salvage, $period, $rate, $basis = 0) { @@ -432,12 +432,12 @@ class Financial * * @category Financial Functions * - * @param mixed settlement The security's settlement date. + * @param mixed settlement The security's settlement date. * The security settlement date is the date after the issue * date when the security is traded to the buyer. - * @param mixed maturity The security's maturity date. + * @param mixed maturity The security's maturity date. * The maturity date is the date when the security expires. - * @param int frequency the number of coupon payments per year. + * @param int frequency the number of coupon payments per year. * Valid frequency values are: * 1 Annual * 2 Semi-Annual @@ -446,7 +446,7 @@ class Financial * also available * 6 Bimonthly * 12 Monthly - * @param int basis The type of day count to use. + * @param int basis The type of day count to use. * 0 or omitted US (NASD) 30/360 * 1 Actual/actual * 2 Actual/360 @@ -457,7 +457,7 @@ class Financial * @param mixed $frequency * @param mixed $basis * - * @return float + * @return float */ public static function COUPDAYBS($settlement, $maturity, $frequency, $basis = 0) { @@ -495,12 +495,12 @@ class Financial * * @category Financial Functions * - * @param mixed settlement The security's settlement date. + * @param mixed settlement The security's settlement date. * The security settlement date is the date after the issue * date when the security is traded to the buyer. - * @param mixed maturity The security's maturity date. + * @param mixed maturity The security's maturity date. * The maturity date is the date when the security expires. - * @param mixed frequency the number of coupon payments per year. + * @param mixed frequency the number of coupon payments per year. * Valid frequency values are: * 1 Annual * 2 Semi-Annual @@ -509,7 +509,7 @@ class Financial * also available * 6 Bimonthly * 12 Monthly - * @param int basis The type of day count to use. + * @param int basis The type of day count to use. * 0 or omitted US (NASD) 30/360 * 1 Actual/actual * 2 Actual/360 @@ -520,7 +520,7 @@ class Financial * @param mixed $maturity * @param mixed $basis * - * @return float + * @return float */ public static function COUPDAYS($settlement, $maturity, $frequency, $basis = 0) { @@ -575,12 +575,12 @@ class Financial * * @category Financial Functions * - * @param mixed settlement The security's settlement date. + * @param mixed settlement The security's settlement date. * The security settlement date is the date after the issue * date when the security is traded to the buyer. - * @param mixed maturity The security's maturity date. + * @param mixed maturity The security's maturity date. * The maturity date is the date when the security expires. - * @param mixed frequency the number of coupon payments per year. + * @param mixed frequency the number of coupon payments per year. * Valid frequency values are: * 1 Annual * 2 Semi-Annual @@ -589,7 +589,7 @@ class Financial * also available * 6 Bimonthly * 12 Monthly - * @param int basis The type of day count to use. + * @param int basis The type of day count to use. * 0 or omitted US (NASD) 30/360 * 1 Actual/actual * 2 Actual/360 @@ -600,7 +600,7 @@ class Financial * @param mixed $frequency * @param mixed $basis * - * @return float + * @return float */ public static function COUPDAYSNC($settlement, $maturity, $frequency, $basis = 0) { @@ -638,12 +638,12 @@ class Financial * * @category Financial Functions * - * @param mixed settlement The security's settlement date. + * @param mixed settlement The security's settlement date. * The security settlement date is the date after the issue * date when the security is traded to the buyer. - * @param mixed maturity The security's maturity date. + * @param mixed maturity The security's maturity date. * The maturity date is the date when the security expires. - * @param mixed frequency the number of coupon payments per year. + * @param mixed frequency the number of coupon payments per year. * Valid frequency values are: * 1 Annual * 2 Semi-Annual @@ -652,7 +652,7 @@ class Financial * also available * 6 Bimonthly * 12 Monthly - * @param int basis The type of day count to use. + * @param int basis The type of day count to use. * 0 or omitted US (NASD) 30/360 * 1 Actual/actual * 2 Actual/360 @@ -663,7 +663,7 @@ class Financial * @param mixed $frequency * @param mixed $basis * - * @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 */ public static function COUPNCD($settlement, $maturity, $frequency, $basis = 0) @@ -700,12 +700,12 @@ class Financial * * @category Financial Functions * - * @param mixed settlement The security's settlement date. + * @param mixed settlement The security's settlement date. * The security settlement date is the date after the issue * date when the security is traded to the buyer. - * @param mixed maturity The security's maturity date. + * @param mixed maturity The security's maturity date. * The maturity date is the date when the security expires. - * @param mixed frequency the number of coupon payments per year. + * @param mixed frequency the number of coupon payments per year. * Valid frequency values are: * 1 Annual * 2 Semi-Annual @@ -714,7 +714,7 @@ class Financial * also available * 6 Bimonthly * 12 Monthly - * @param int basis The type of day count to use. + * @param int basis The type of day count to use. * 0 or omitted US (NASD) 30/360 * 1 Actual/actual * 2 Actual/360 @@ -725,7 +725,7 @@ class Financial * @param mixed $frequency * @param mixed $basis * - * @return int + * @return int */ public static function COUPNUM($settlement, $maturity, $frequency, $basis = 0) { @@ -776,12 +776,12 @@ class Financial * * @category Financial Functions * - * @param mixed settlement The security's settlement date. + * @param mixed settlement The security's settlement date. * The security settlement date is the date after the issue * date when the security is traded to the buyer. - * @param mixed maturity The security's maturity date. + * @param mixed maturity The security's maturity date. * The maturity date is the date when the security expires. - * @param mixed frequency the number of coupon payments per year. + * @param mixed frequency the number of coupon payments per year. * Valid frequency values are: * 1 Annual * 2 Semi-Annual @@ -790,7 +790,7 @@ class Financial * also available * 6 Bimonthly * 12 Monthly - * @param int basis The type of day count to use. + * @param int basis The type of day count to use. * 0 or omitted US (NASD) 30/360 * 1 Actual/actual * 2 Actual/360 @@ -801,7 +801,7 @@ class Financial * @param mixed $frequency * @param mixed $basis * - * @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 */ public static function COUPPCD($settlement, $maturity, $frequency, $basis = 0) @@ -837,17 +837,17 @@ class Financial * * @category Financial Functions * - * @param float $rate The Interest rate - * @param int $nper The total number of payment periods - * @param float $pv Present Value - * @param int $start The first period in the calculation. + * @param float $rate The Interest rate + * @param int $nper The total number of payment periods + * @param float $pv Present Value + * @param int $start The first period in the calculation. * Payment periods are numbered beginning with 1. - * @param int $end the last period in the calculation - * @param int $type A number 0 or 1 and indicates when payments are due: + * @param int $end the last period in the calculation + * @param int $type A number 0 or 1 and indicates when payments are due: * 0 or omitted At the end of the period. * 1 At the beginning of the period. * - * @return float + * @return float */ public static function CUMIPMT($rate, $nper, $pv, $start, $end, $type = 0) { @@ -885,17 +885,17 @@ class Financial * * @category Financial Functions * - * @param float $rate The Interest rate - * @param int $nper The total number of payment periods - * @param float $pv Present Value - * @param int $start The first period in the calculation. + * @param float $rate The Interest rate + * @param int $nper The total number of payment periods + * @param float $pv Present Value + * @param int $start The first period in the calculation. * Payment periods are numbered beginning with 1. - * @param int $end the last period in the calculation - * @param int $type A number 0 or 1 and indicates when payments are due: + * @param int $end the last period in the calculation + * @param int $type A number 0 or 1 and indicates when payments are due: * 0 or omitted At the end of the period. * 1 At the beginning of the period. * - * @return float + * @return float */ public static function CUMPRINC($rate, $nper, $pv, $start, $end, $type = 0) { @@ -938,14 +938,14 @@ class Financial * * @category Financial Functions * - * @param float cost Initial cost of the asset - * @param float salvage Value at the end of the depreciation. + * @param float cost Initial cost of the asset + * @param float salvage Value at the end of the depreciation. * (Sometimes called the salvage value of the asset) - * @param int life Number of periods over which the asset is depreciated. + * @param int life Number of periods over which the asset is depreciated. * (Sometimes called the useful life of the asset) - * @param int period The period for which you want to calculate the + * @param int period The period for which you want to calculate the * depreciation. Period must use the same units as life. - * @param int month Number of months in the first year. If month is omitted, + * @param int month Number of months in the first year. If month is omitted, * it defaults to 12. * @param mixed $cost * @param mixed $salvage @@ -953,7 +953,7 @@ class Financial * @param mixed $period * @param mixed $month * - * @return float + * @return float */ public static function DB($cost, $salvage, $life, $period, $month = 12) { @@ -1012,14 +1012,14 @@ class Financial * * @category Financial Functions * - * @param float cost Initial cost of the asset - * @param float salvage Value at the end of the depreciation. + * @param float cost Initial cost of the asset + * @param float salvage Value at the end of the depreciation. * (Sometimes called the salvage value of the asset) - * @param int life Number of periods over which the asset is depreciated. + * @param int life Number of periods over which the asset is depreciated. * (Sometimes called the useful life of the asset) - * @param int period The period for which you want to calculate the + * @param int period The period for which you want to calculate the * depreciation. Period must use the same units as life. - * @param float factor The rate at which the balance declines. + * @param float factor The rate at which the balance declines. * If factor is omitted, it is assumed to be 2 (the * double-declining balance method). * @param mixed $cost @@ -1028,7 +1028,7 @@ class Financial * @param mixed $period * @param mixed $factor * - * @return float + * @return float */ public static function DDB($cost, $salvage, $life, $period, $factor = 2.0) { @@ -1078,14 +1078,14 @@ class Financial * * @category Financial Functions * - * @param mixed settlement The security's settlement date. + * @param mixed settlement The security's settlement date. * The security settlement date is the date after the issue * date when the security is traded to the buyer. - * @param mixed maturity The security's maturity date. + * @param mixed maturity The security's maturity date. * The maturity date is the date when the security expires. - * @param int price The security's price per $100 face value - * @param int redemption The security's redemption value per $100 face value - * @param int basis The type of day count to use. + * @param int price The security's price per $100 face value + * @param int redemption The security's redemption value per $100 face value + * @param int basis The type of day count to use. * 0 or omitted US (NASD) 30/360 * 1 Actual/actual * 2 Actual/360 @@ -1097,7 +1097,7 @@ class Financial * @param mixed $redemption * @param mixed $basis * - * @return float + * @return float */ public static function DISC($settlement, $maturity, $price, $redemption, $basis = 0) { @@ -1139,10 +1139,10 @@ class Financial * * @category Financial Functions * - * @param float $fractional_dollar Fractional Dollar - * @param int $fraction Fraction + * @param float $fractional_dollar Fractional Dollar + * @param int $fraction Fraction * - * @return float + * @return float */ public static function DOLLARDE($fractional_dollar = null, $fraction = 0) { @@ -1177,10 +1177,10 @@ class Financial * * @category Financial Functions * - * @param float $decimal_dollar Decimal Dollar - * @param int $fraction Fraction + * @param float $decimal_dollar Decimal Dollar + * @param int $fraction Fraction * - * @return float + * @return float */ public static function DOLLARFR($decimal_dollar = null, $fraction = 0) { @@ -1214,10 +1214,10 @@ class Financial * * @category Financial Functions * - * @param float $nominal_rate Nominal interest rate - * @param int $npery Number of compounding payments per year + * @param float $nominal_rate Nominal interest rate + * @param int $npery Number of compounding payments per year * - * @return float + * @return float */ public static function EFFECT($nominal_rate = 0, $npery = 0) { @@ -1242,18 +1242,18 @@ class Financial * * @category Financial Functions * - * @param float $rate The interest rate per period - * @param int $nper Total number of payment periods in an annuity - * @param float $pmt The payment made each period: it cannot change over the + * @param float $rate The interest rate per period + * @param int $nper Total number of payment periods in an annuity + * @param float $pmt The payment made each period: it cannot change over the * life of the annuity. Typically, pmt contains principal * and interest but no other fees or taxes. - * @param float $pv present Value, or the lump-sum amount that a series of + * @param float $pv present Value, or the lump-sum amount that a series of * future payments is worth right now - * @param int $type A number 0 or 1 and indicates when payments are due: + * @param int $type A number 0 or 1 and indicates when payments are due: * 0 or omitted At the end of the period. * 1 At the beginning of the period. * - * @return float + * @return float */ public static function FV($rate = 0, $nper = 0, $pmt = 0, $pv = 0, $type = 0) { @@ -1285,10 +1285,10 @@ class Financial * Excel Function: * FVSCHEDULE(principal,schedule) * - * @param float $principal the present value - * @param float[] $schedule an array of interest rates to apply + * @param float $principal the present value + * @param float[] $schedule an array of interest rates to apply * - * @return float + * @return float */ public static function FVSCHEDULE($principal, $schedule) { @@ -1310,20 +1310,20 @@ class Financial * Excel Function: * INTRATE(settlement,maturity,investment,redemption[,basis]) * - * @param mixed $settlement The security's settlement date. + * @param mixed $settlement The security's settlement date. * The security settlement date is the date after the issue date when the security is traded to the buyer. - * @param mixed $maturity The security's maturity date. + * @param mixed $maturity The security's maturity date. * The maturity date is the date when the security expires. - * @param int $investment the amount invested in the security - * @param int $redemption the amount to be received at maturity - * @param int $basis The type of day count to use. + * @param int $investment the amount invested in the security + * @param int $redemption the amount to be received at maturity + * @param int $basis The type of day count to use. * 0 or omitted US (NASD) 30/360 * 1 Actual/actual * 2 Actual/360 * 3 Actual/365 * 4 European 30/360 * - * @return float + * @return float */ public static function INTRATE($settlement, $maturity, $investment, $redemption, $basis = 0) { @@ -1361,14 +1361,14 @@ class Financial * Excel Function: * IPMT(rate,per,nper,pv[,fv][,type]) * - * @param float $rate Interest rate per period - * @param int $per Period for which we want to find the interest - * @param int $nper Number of periods - * @param float $pv Present Value - * @param float $fv Future Value - * @param int $type Payment type: 0 = at the end of each period, 1 = at the beginning of each period + * @param float $rate Interest rate per period + * @param int $per Period for which we want to find the interest + * @param int $nper Number of periods + * @param float $pv Present Value + * @param float $fv Future Value + * @param int $type Payment type: 0 = at the end of each period, 1 = at the beginning of each period * - * @return float + * @return float */ public static function IPMT($rate, $per, $nper, $pv, $fv = 0, $type = 0) { @@ -1405,13 +1405,13 @@ class Financial * Excel Function: * IRR(values[,guess]) * - * @param float[] $values An array or a reference to cells that contain numbers for which you want + * @param float[] $values An array or a reference to cells that contain numbers for which you want * to calculate the internal rate of return. * Values must contain at least one positive value and one negative value to * calculate the internal rate of return. - * @param float $guess A number that you guess is close to the result of IRR + * @param float $guess A number that you guess is close to the result of IRR * - * @return float + * @return float */ public static function IRR($values, $guess = 0.1) { @@ -1515,13 +1515,13 @@ class Financial * Excel Function: * MIRR(values,finance_rate, reinvestment_rate) * - * @param float[] $values An array or a reference to cells that contain a series of payments and + * @param float[] $values An array or a reference to cells that contain a series of payments and * income occurring at regular intervals. * Payments are negative value, income is positive values. - * @param float $finance_rate The interest rate you pay on the money used in the cash flows - * @param float $reinvestment_rate The interest rate you receive on the cash flows as you reinvest them + * @param float $finance_rate The interest rate you pay on the money used in the cash flows + * @param float $reinvestment_rate The interest rate you receive on the cash flows as you reinvest them * - * @return float + * @return float */ public static function MIRR($values, $finance_rate, $reinvestment_rate) { @@ -1560,10 +1560,10 @@ class Financial * * Returns the nominal interest rate given the effective rate and the number of compounding payments per year. * - * @param float $effect_rate Effective interest rate - * @param int $npery Number of compounding payments per year + * @param float $effect_rate Effective interest rate + * @param int $npery Number of compounding payments per year * - * @return float + * @return float */ public static function NOMINAL($effect_rate = 0, $npery = 0) { @@ -1584,13 +1584,13 @@ class Financial * * Returns the number of periods for a cash flow with constant periodic payments (annuities), and interest rate. * - * @param float $rate Interest rate per period - * @param int $pmt Periodic payment (annuity) - * @param float $pv Present Value - * @param float $fv Future Value - * @param int $type Payment type: 0 = at the end of each period, 1 = at the beginning of each period + * @param float $rate Interest rate per period + * @param int $pmt Periodic payment (annuity) + * @param float $pv Present Value + * @param float $fv Future Value + * @param int $type Payment type: 0 = at the end of each period, 1 = at the beginning of each period * - * @return float + * @return float */ public static function NPER($rate = 0, $pmt = 0, $pv = 0, $fv = 0, $type = 0) { @@ -1625,7 +1625,7 @@ class Financial * * Returns the Net Present Value of a cash flow series given a discount rate. * - * @return float + * @return float */ public static function NPV() { @@ -1653,13 +1653,13 @@ class Financial * * Returns the constant payment (annuity) for a cash flow with a constant interest rate. * - * @param float $rate Interest rate per period - * @param int $nper Number of periods - * @param float $pv Present Value - * @param float $fv Future Value - * @param int $type Payment type: 0 = at the end of each period, 1 = at the beginning of each period + * @param float $rate Interest rate per period + * @param int $nper Number of periods + * @param float $pv Present Value + * @param float $fv Future Value + * @param int $type Payment type: 0 = at the end of each period, 1 = at the beginning of each period * - * @return float + * @return float */ public static function PMT($rate = 0, $nper = 0, $pv = 0, $fv = 0, $type = 0) { @@ -1687,14 +1687,14 @@ class Financial * * Returns the interest payment for a given period for an investment based on periodic, constant payments and a constant interest rate. * - * @param float $rate Interest rate per period - * @param int $per Period for which we want to find the interest - * @param int $nper Number of periods - * @param float $pv Present Value - * @param float $fv Future Value - * @param int $type Payment type: 0 = at the end of each period, 1 = at the beginning of each period + * @param float $rate Interest rate per period + * @param int $per Period for which we want to find the interest + * @param int $nper Number of periods + * @param float $pv Present Value + * @param float $fv Future Value + * @param int $type Payment type: 0 = at the end of each period, 1 = at the beginning of each period * - * @return float + * @return float */ public static function PPMT($rate, $per, $nper, $pv, $fv = 0, $type = 0) { @@ -1765,13 +1765,13 @@ class Financial * * Returns the price per $100 face value of a discounted security. * - * @param mixed settlement The security's settlement date. + * @param mixed settlement The security's settlement date. * The security settlement date is the date after the issue date when the security is traded to the buyer. - * @param mixed maturity The security's maturity date. + * @param mixed maturity The security's maturity date. * The maturity date is the date when the security expires. - * @param int discount The security's discount rate - * @param int redemption The security's redemption value per $100 face value - * @param int basis The type of day count to use. + * @param int discount The security's discount rate + * @param int redemption The security's redemption value per $100 face value + * @param int basis The type of day count to use. * 0 or omitted US (NASD) 30/360 * 1 Actual/actual * 2 Actual/360 @@ -1783,7 +1783,7 @@ class Financial * @param mixed $redemption * @param mixed $basis * - * @return float + * @return float */ public static function PRICEDISC($settlement, $maturity, $discount, $redemption, $basis = 0) { @@ -1815,14 +1815,14 @@ class Financial * * Returns the price per $100 face value of a security that pays interest at maturity. * - * @param mixed settlement The security's settlement date. + * @param mixed settlement The security's settlement date. * The security's settlement date is the date after the issue date when the security is traded to the buyer. - * @param mixed maturity The security's maturity date. + * @param mixed maturity The security's maturity date. * The maturity date is the date when the security expires. - * @param mixed issue The security's issue date - * @param int rate The security's interest rate at date of issue - * @param int yield The security's annual yield - * @param int basis The type of day count to use. + * @param mixed issue The security's issue date + * @param int rate The security's interest rate at date of issue + * @param int yield The security's annual yield + * @param int basis The type of day count to use. * 0 or omitted US (NASD) 30/360 * 1 Actual/actual * 2 Actual/360 @@ -1835,7 +1835,7 @@ class Financial * @param mixed $yield * @param mixed $basis * - * @return float + * @return float */ public static function PRICEMAT($settlement, $maturity, $issue, $rate, $yield, $basis = 0) { @@ -1887,13 +1887,13 @@ class Financial * * Returns the Present Value of a cash flow with constant payments and interest rate (annuities). * - * @param float $rate Interest rate per period - * @param int $nper Number of periods - * @param float $pmt Periodic payment (annuity) - * @param float $fv Future Value - * @param int $type Payment type: 0 = at the end of each period, 1 = at the beginning of each period + * @param float $rate Interest rate per period + * @param int $nper Number of periods + * @param float $pmt Periodic payment (annuity) + * @param float $fv Future Value + * @param int $type Payment type: 0 = at the end of each period, 1 = at the beginning of each period * - * @return float + * @return float */ public static function PV($rate = 0, $nper = 0, $pmt = 0, $fv = 0, $type = 0) { @@ -1929,20 +1929,20 @@ class Financial * * @category Financial Functions * - * @param float nper The total number of payment periods in an annuity - * @param float pmt The payment made each period and cannot change over the life + * @param float nper The total number of payment periods in an annuity + * @param float pmt The payment made each period and cannot change over the life * of the annuity. * Typically, pmt includes principal and interest but no other * fees or taxes. - * @param float pv The present value - the total amount that a series of future + * @param float pv The present value - the total amount that a series of future * payments is worth now - * @param float fv The future value, or a cash balance you want to attain after + * @param float fv The future value, or a cash balance you want to attain after * the last payment is made. If fv is omitted, it is assumed * to be 0 (the future value of a loan, for example, is 0). - * @param int type A number 0 or 1 and indicates when payments are due: + * @param int type A number 0 or 1 and indicates when payments are due: * 0 or omitted At the end of the period. * 1 At the beginning of the period. - * @param float guess Your guess for what the rate will be. + * @param float guess Your guess for what the rate will be. * If you omit guess, it is assumed to be 10 percent. * @param mixed $nper * @param mixed $pmt @@ -1951,7 +1951,7 @@ class Financial * @param mixed $type * @param mixed $guess * - * @return float + * @return float **/ public static function RATE($nper, $pmt, $pv, $fv = 0.0, $type = 0, $guess = 0.1) { @@ -2002,13 +2002,13 @@ class Financial * * Returns the price per $100 face value of a discounted security. * - * @param mixed settlement The security's settlement date. + * @param mixed settlement The security's settlement date. * The security settlement date is the date after the issue date when the security is traded to the buyer. - * @param mixed maturity The security's maturity date. + * @param mixed maturity The security's maturity date. * The maturity date is the date when the security expires. - * @param int investment The amount invested in the security - * @param int discount The security's discount rate - * @param int basis The type of day count to use. + * @param int investment The amount invested in the security + * @param int discount The security's discount rate + * @param int basis The type of day count to use. * 0 or omitted US (NASD) 30/360 * 1 Actual/actual * 2 Actual/360 @@ -2020,7 +2020,7 @@ class Financial * @param mixed $discount * @param mixed $basis * - * @return float + * @return float */ public static function RECEIVED($settlement, $maturity, $investment, $discount, $basis = 0) { @@ -2052,14 +2052,14 @@ class Financial * * Returns the straight-line depreciation of an asset for one period * - * @param cost Initial cost of the asset - * @param salvage Value at the end of the depreciation - * @param life Number of periods over which the asset is depreciated + * @param cost Initial cost of the asset + * @param salvage Value at the end of the depreciation + * @param life Number of periods over which the asset is depreciated * @param mixed $cost * @param mixed $salvage * @param mixed $life * - * @return float + * @return float */ public static function SLN($cost, $salvage, $life) { @@ -2084,16 +2084,16 @@ class Financial * * Returns the sum-of-years' digits depreciation of an asset for a specified period. * - * @param cost Initial cost of the asset - * @param salvage Value at the end of the depreciation - * @param life Number of periods over which the asset is depreciated - * @param period Period + * @param cost Initial cost of the asset + * @param salvage Value at the end of the depreciation + * @param life Number of periods over which the asset is depreciated + * @param period Period * @param mixed $cost * @param mixed $salvage * @param mixed $life * @param mixed $period * - * @return float + * @return float */ public static function SYD($cost, $salvage, $life, $period) { @@ -2119,16 +2119,16 @@ class Financial * * Returns the bond-equivalent yield for a Treasury bill. * - * @param mixed settlement The Treasury bill's settlement date. + * @param mixed settlement The Treasury bill's settlement date. * The Treasury bill's settlement date is the date after the issue date when the Treasury bill is traded to the buyer. - * @param mixed maturity The Treasury bill's maturity date. + * @param mixed maturity The Treasury bill's maturity date. * The maturity date is the date when the Treasury bill expires. - * @param int discount The Treasury bill's discount rate + * @param int discount The Treasury bill's discount rate * @param mixed $settlement * @param mixed $maturity * @param mixed $discount * - * @return float + * @return float */ public static function TBILLEQ($settlement, $maturity, $discount) { @@ -2161,16 +2161,16 @@ class Financial * * Returns the yield for a Treasury bill. * - * @param mixed settlement The Treasury bill's settlement date. + * @param mixed settlement The Treasury bill's settlement date. * The Treasury bill's settlement date is the date after the issue date when the Treasury bill is traded to the buyer. - * @param mixed maturity The Treasury bill's maturity date. + * @param mixed maturity The Treasury bill's maturity date. * The maturity date is the date when the Treasury bill expires. - * @param int discount The Treasury bill's discount rate + * @param int discount The Treasury bill's discount rate * @param mixed $settlement * @param mixed $maturity * @param mixed $discount * - * @return float + * @return float */ public static function TBILLPRICE($settlement, $maturity, $discount) { @@ -2219,16 +2219,16 @@ class Financial * * Returns the yield for a Treasury bill. * - * @param mixed settlement The Treasury bill's settlement date. + * @param mixed settlement The Treasury bill's settlement date. * The Treasury bill's settlement date is the date after the issue date when the Treasury bill is traded to the buyer. - * @param mixed maturity The Treasury bill's maturity date. + * @param mixed maturity The Treasury bill's maturity date. * The maturity date is the date when the Treasury bill expires. - * @param int price The Treasury bill's price per $100 face value + * @param int price The Treasury bill's price per $100 face value * @param mixed $settlement * @param mixed $maturity * @param mixed $price * - * @return float + * @return float */ public static function TBILLYIELD($settlement, $maturity, $price) { @@ -2326,16 +2326,16 @@ class Financial * Excel Function: * =XNPV(rate,values,dates) * - * @param float $rate the discount rate to apply to the cash flows - * @param array of float $values A series of cash flows that corresponds to a schedule of payments in dates. + * @param float $rate the discount rate to apply to the cash flows + * @param array of float $values A series of cash flows that corresponds to a schedule of payments in dates. * The first payment is optional and corresponds to a cost or payment that occurs at the beginning of the investment. * If the first value is a cost or payment, it must be a negative value. All succeeding payments are discounted based on a 365-day year. * The series of values must contain at least one positive value and one negative value. - * @param array of mixed $dates A schedule of payment dates that corresponds to the cash flow payments. + * @param array of mixed $dates A schedule of payment dates that corresponds to the cash flow payments. * The first payment date indicates the beginning of the schedule of payments. * All other dates must be later than this date, but they may occur in any order. * - * @return float + * @return float */ public static function XNPV($rate, $values, $dates) { @@ -2372,13 +2372,13 @@ class Financial * * Returns the annual yield of a security that pays interest at maturity. * - * @param mixed settlement The security's settlement date. + * @param mixed settlement The security's settlement date. * The security's settlement date is the date after the issue date when the security is traded to the buyer. - * @param mixed maturity The security's maturity date. + * @param mixed maturity The security's maturity date. * The maturity date is the date when the security expires. - * @param int price The security's price per $100 face value - * @param int redemption The security's redemption value per $100 face value - * @param int basis The type of day count to use. + * @param int price The security's price per $100 face value + * @param int redemption The security's redemption value per $100 face value + * @param int basis The type of day count to use. * 0 or omitted US (NASD) 30/360 * 1 Actual/actual * 2 Actual/360 @@ -2390,7 +2390,7 @@ class Financial * @param mixed $redemption * @param mixed $basis * - * @return float + * @return float */ public static function YIELDDISC($settlement, $maturity, $price, $redemption, $basis = 0) { @@ -2427,14 +2427,14 @@ class Financial * * Returns the annual yield of a security that pays interest at maturity. * - * @param mixed settlement The security's settlement date. + * @param mixed settlement The security's settlement date. * The security's settlement date is the date after the issue date when the security is traded to the buyer. - * @param mixed maturity The security's maturity date. + * @param mixed maturity The security's maturity date. * The maturity date is the date when the security expires. - * @param mixed issue The security's issue date - * @param int rate The security's interest rate at date of issue - * @param int price The security's price per $100 face value - * @param int basis The type of day count to use. + * @param mixed issue The security's issue date + * @param int rate The security's interest rate at date of issue + * @param int price The security's price per $100 face value + * @param int basis The type of day count to use. * 0 or omitted US (NASD) 30/360 * 1 Actual/actual * 2 Actual/360 @@ -2447,7 +2447,7 @@ class Financial * @param mixed $price * @param mixed $basis * - * @return float + * @return float */ public static function YIELDMAT($settlement, $maturity, $issue, $rate, $price, $basis = 0) { diff --git a/src/PhpSpreadsheet/Calculation/FormulaParser.php b/src/PhpSpreadsheet/Calculation/FormulaParser.php index 6c214e5b..f37c4716 100644 --- a/src/PhpSpreadsheet/Calculation/FormulaParser.php +++ b/src/PhpSpreadsheet/Calculation/FormulaParser.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Calculation; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -83,9 +83,9 @@ class 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 = '') { @@ -113,11 +113,11 @@ class FormulaParser /** * 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) { diff --git a/src/PhpSpreadsheet/Calculation/FormulaToken.php b/src/PhpSpreadsheet/Calculation/FormulaToken.php index d6a39fdf..ab46f5b1 100644 --- a/src/PhpSpreadsheet/Calculation/FormulaToken.php +++ b/src/PhpSpreadsheet/Calculation/FormulaToken.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Calculation; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -99,9 +99,9 @@ class FormulaToken /** * Create a new FormulaToken. * - * @param string $pValue - * @param string $pTokenType Token type (represented by TOKEN_TYPE_*) - * @param string $pTokenSubType Token Subtype (represented by TOKEN_SUBTYPE_*) + * @param string $pValue + * @param string $pTokenType Token type (represented by TOKEN_TYPE_*) + * @param string $pTokenSubType Token Subtype (represented by TOKEN_SUBTYPE_*) */ public function __construct($pValue, $pTokenType = self::TOKEN_TYPE_UNKNOWN, $pTokenSubType = self::TOKEN_SUBTYPE_NOTHING) { @@ -124,7 +124,7 @@ class FormulaToken /** * Set Value. * - * @param string $value + * @param string $value */ public function setValue($value) { @@ -144,7 +144,7 @@ class FormulaToken /** * Set Token Type. * - * @param string $value + * @param string $value */ public function setTokenType($value = self::TOKEN_TYPE_UNKNOWN) { @@ -164,7 +164,7 @@ class FormulaToken /** * Set Token SubType. * - * @param string $value + * @param string $value */ public function setTokenSubType($value = self::TOKEN_SUBTYPE_NOTHING) { diff --git a/src/PhpSpreadsheet/Calculation/Functions.php b/src/PhpSpreadsheet/Calculation/Functions.php index bdd2edd2..c5ffef52 100644 --- a/src/PhpSpreadsheet/Calculation/Functions.php +++ b/src/PhpSpreadsheet/Calculation/Functions.php @@ -82,13 +82,13 @@ class Functions * * @category Function Configuration * - * @param string $compatibilityMode Compatibility Mode + * @param string $compatibilityMode Compatibility Mode * Permitted values are: * Functions::COMPATIBILITY_EXCEL 'Excel' * Functions::COMPATIBILITY_GNUMERIC 'Gnumeric' * Functions::COMPATIBILITY_OPENOFFICE 'OpenOfficeCalc' * - * @return bool (Success or Failure) + * @return bool (Success or Failure) */ public static function setCompatibilityMode($compatibilityMode) { @@ -109,7 +109,7 @@ class Functions * * @category Function Configuration * - * @return string Compatibility Mode + * @return string Compatibility Mode * Possible Return values are: * Functions::COMPATIBILITY_EXCEL 'Excel' * Functions::COMPATIBILITY_GNUMERIC 'Gnumeric' @@ -125,13 +125,13 @@ class Functions * * @category Function Configuration * - * @param string $returnDateType Return Date Format + * @param string $returnDateType Return Date Format * Permitted values are: * Functions::RETURNDATE_PHP_NUMERIC 'P' * Functions::RETURNDATE_PHP_OBJECT 'O' * Functions::RETURNDATE_EXCEL 'E' * - * @return bool Success or failure + * @return bool Success or failure */ public static function setReturnDateType($returnDateType) { @@ -152,7 +152,7 @@ class Functions * * @category Function Configuration * - * @return string Return Date Format + * @return string Return Date Format * Possible Return values are: * Functions::RETURNDATE_PHP_NUMERIC 'P' * Functions::RETURNDATE_PHP_OBJECT 'O' @@ -168,7 +168,7 @@ class Functions * * @category Error Returns * - * @return string #Not Yet Implemented + * @return string #Not Yet Implemented */ public static function DUMMY() { @@ -180,7 +180,7 @@ class Functions * * @category Error Returns * - * @return string #Not Yet Implemented + * @return string #Not Yet Implemented */ public static function DIV0() { @@ -198,7 +198,7 @@ class Functions * * @category Logical Functions * - * @return string #N/A! + * @return string #N/A! */ public static function NA() { @@ -212,7 +212,7 @@ class Functions * * @category Error Returns * - * @return string #NUM! + * @return string #NUM! */ public static function NAN() { @@ -226,7 +226,7 @@ class Functions * * @category Error Returns * - * @return string #NAME? + * @return string #NAME? */ public static function NAME() { @@ -240,7 +240,7 @@ class Functions * * @category Error Returns * - * @return string #REF! + * @return string #REF! */ public static function REF() { @@ -254,7 +254,7 @@ class Functions * * @category Error Returns * - * @return string #NULL! + * @return string #NULL! */ public static function null() { @@ -268,7 +268,7 @@ class Functions * * @category Error Returns * - * @return string #VALUE! + * @return string #VALUE! */ public static function VALUE() { @@ -317,9 +317,9 @@ class Functions /** * ERROR_TYPE. * - * @param mixed $value Value to check + * @param mixed $value Value to check * - * @return bool + * @return bool */ public static function errorType($value = '') { @@ -339,9 +339,9 @@ class Functions /** * IS_BLANK. * - * @param mixed $value Value to check + * @param mixed $value Value to check * - * @return bool + * @return bool */ public static function isBlank($value = null) { @@ -355,9 +355,9 @@ class Functions /** * IS_ERR. * - * @param mixed $value Value to check + * @param mixed $value Value to check * - * @return bool + * @return bool */ public static function isErr($value = '') { @@ -369,9 +369,9 @@ class Functions /** * IS_ERROR. * - * @param mixed $value Value to check + * @param mixed $value Value to check * - * @return bool + * @return bool */ public static function isError($value = '') { @@ -387,9 +387,9 @@ class Functions /** * IS_NA. * - * @param mixed $value Value to check + * @param mixed $value Value to check * - * @return bool + * @return bool */ public static function isNa($value = '') { @@ -401,9 +401,9 @@ class Functions /** * 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) { @@ -421,9 +421,9 @@ class Functions /** * 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) { @@ -441,9 +441,9 @@ class Functions /** * IS_NUMBER. * - * @param mixed $value Value to check + * @param mixed $value Value to check * - * @return bool + * @return bool */ public static function isNumber($value = null) { @@ -459,9 +459,9 @@ class Functions /** * IS_LOGICAL. * - * @param mixed $value Value to check + * @param mixed $value Value to check * - * @return bool + * @return bool */ public static function isLogical($value = null) { @@ -473,9 +473,9 @@ class Functions /** * IS_TEXT. * - * @param mixed $value Value to check + * @param mixed $value Value to check * - * @return bool + * @return bool */ public static function isText($value = null) { @@ -487,9 +487,9 @@ class Functions /** * IS_NONTEXT. * - * @param mixed $value Value to check + * @param mixed $value Value to check * - * @return bool + * @return bool */ public static function isNonText($value = null) { @@ -501,10 +501,10 @@ class Functions * * 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 * - * @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 * A number That number * A date The serial number of that date @@ -542,10 +542,10 @@ class Functions * * 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 * - * @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 * A number 1 * Text 2 @@ -593,9 +593,9 @@ class Functions /** * 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) { @@ -626,9 +626,9 @@ class Functions /** * 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) { @@ -659,9 +659,9 @@ class Functions /** * 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 = '') { diff --git a/src/PhpSpreadsheet/Calculation/Logical.php b/src/PhpSpreadsheet/Calculation/Logical.php index e120f90c..14907f26 100644 --- a/src/PhpSpreadsheet/Calculation/Logical.php +++ b/src/PhpSpreadsheet/Calculation/Logical.php @@ -36,7 +36,7 @@ class Logical * * @category Logical Functions * - * @return bool True + * @return bool True */ public static function true() { @@ -53,7 +53,7 @@ class Logical * * @category Logical Functions * - * @return bool False + * @return bool False */ public static function false() { @@ -78,9 +78,9 @@ class Logical * * @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() { @@ -135,9 +135,9 @@ class Logical * * @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() { @@ -191,9 +191,9 @@ class Logical * * @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) { @@ -239,11 +239,11 @@ class Logical * * @category Logical Functions * - * @param mixed $condition Condition to evaluate - * @param mixed $returnIfTrue Value to return when condition is true - * @param mixed $returnIfFalse Optional value to return when condition is false + * @param mixed $condition Condition to evaluate + * @param mixed $returnIfTrue Value to return when condition is true + * @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) { @@ -262,10 +262,10 @@ class Logical * * @category Logical Functions * - * @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 $testValue Value to check, is also the value returned when no error + * @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 = '') { diff --git a/src/PhpSpreadsheet/Calculation/LookupRef.php b/src/PhpSpreadsheet/Calculation/LookupRef.php index ceb06411..c0d6b42b 100644 --- a/src/PhpSpreadsheet/Calculation/LookupRef.php +++ b/src/PhpSpreadsheet/Calculation/LookupRef.php @@ -34,24 +34,24 @@ class LookupRef * Excel Function: * =ADDRESS(row, column, [relativity], [referenceStyle], [sheetText]) * - * @param row Row 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 row Row 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 * 1 or omitted Absolute * 2 Absolute row; relative column * 3 Relative row; absolute column * 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 * 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 $column * @param mixed $relativity * @param mixed $referenceStyle * @param mixed $sheetText * - * @return string + * @return string */ public static function cellAddress($row, $column, $relativity = 1, $referenceStyle = true, $sheetText = '') { @@ -103,10 +103,10 @@ class LookupRef * Excel Function: * =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 * - * @return int or array of integer + * @return int or array of integer */ public static function COLUMN($cellAddress = null) { @@ -149,10 +149,10 @@ class LookupRef * Excel Function: * =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 * - * @return int The number of columns in cellAddress + * @return int The number of columns in cellAddress */ public static function COLUMNS($cellAddress = null) { @@ -184,10 +184,10 @@ class LookupRef * Excel Function: * =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 * - * @return int or array of integer + * @return int or array of integer */ public static function ROW($cellAddress = null) { @@ -230,10 +230,10 @@ class LookupRef * Excel Function: * =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 * - * @return int The number of rows in cellAddress + * @return int The number of rows in cellAddress */ public static function ROWS($cellAddress = null) { @@ -262,11 +262,11 @@ class LookupRef * * @category Logical Functions * - * @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 \PhpOffice\PhpSpreadsheet\Cell $pCell The cell to set the hyperlink in + * @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 \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) { @@ -301,10 +301,10 @@ class LookupRef * * 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 \PhpOffice\PhpSpreadsheet\Cell $pCell 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) * - * @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 */ @@ -359,26 +359,26 @@ class LookupRef * Excel Function: * =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. - * @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 * five rows below reference. Rows can be positive (which means below 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 * 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 * 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 width The width, in number of columns, that you want the returned reference to be. Width 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 null|mixed $cellAddress * @param mixed $rows * @param mixed $columns * @param null|mixed $height * @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) { @@ -458,15 +458,15 @@ class LookupRef * Excel Function: * =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 * 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 * index_num. The arguments can be numbers, cell references, defined names, formulas, functions, or * text. * - * @return mixed The selected value + * @return mixed The selected value */ public static function CHOOSE() { @@ -502,14 +502,14 @@ class LookupRef * Excel Function: * =MATCH(lookup_value, lookup_array, [match_type]) * - * @param lookup_value The value that you want to match in lookup_array - * @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 lookup_value The value that you want to match in lookup_array + * @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 mixed $lookup_value * @param mixed $lookup_array * @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) { @@ -600,14 +600,14 @@ class LookupRef * Excel Function: * =INDEX(range_array, row_num, [column_num]) * - * @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 column_num The column in array from which to return a value. If column_num is omitted, row_num is required. + * @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 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 $rowNum * @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) { @@ -658,9 +658,9 @@ class LookupRef /** * 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 */ @@ -699,16 +699,16 @@ class LookupRef * 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. * - * @param lookup_value The value that you want to match in lookup_array - * @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 not_exact_match determines if you are looking for an exact match based on lookup_value + * @param lookup_value The value that you want to match in lookup_array + * @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 not_exact_match determines if you are looking for an exact match based on lookup_value * @param mixed $lookup_value * @param mixed $lookup_array * @param mixed $index_number * @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) { @@ -768,16 +768,16 @@ class LookupRef * 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. * - * @param lookup_value The value that you want to match in lookup_array - * @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 not_exact_match determines if you are looking for an exact match based on lookup_value + * @param lookup_value The value that you want to match in lookup_array + * @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 not_exact_match determines if you are looking for an exact match based on lookup_value * @param mixed $lookup_value * @param mixed $lookup_array * @param mixed $index_number * @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) { @@ -833,14 +833,14 @@ class LookupRef * LOOKUP * 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_vector The range of cells being searched - * @param result_vector The column from which the matching value must be returned + * @param lookup_value The value that you want to match in lookup_array + * @param lookup_vector The range of cells being searched + * @param result_vector The column from which the matching value must be returned * @param mixed $lookup_value * @param mixed $lookup_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) { diff --git a/src/PhpSpreadsheet/Calculation/MathTrig.php b/src/PhpSpreadsheet/Calculation/MathTrig.php index 34582f41..deb6d0f6 100644 --- a/src/PhpSpreadsheet/Calculation/MathTrig.php +++ b/src/PhpSpreadsheet/Calculation/MathTrig.php @@ -75,10 +75,10 @@ class MathTrig * * @category Mathematical and Trigonometric Functions * - * @param float $xCoordinate the x-coordinate of the point - * @param float $yCoordinate the y-coordinate of the point + * @param float $xCoordinate the x-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) { @@ -116,10 +116,10 @@ class MathTrig * * @category Mathematical and Trigonometric Functions * - * @param float $number the number you want to round - * @param float $significance the multiple to which you want to round + * @param float $number the number 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) { @@ -155,10 +155,10 @@ class MathTrig * * @category Mathematical and Trigonometric Functions * - * @param int $numObjs Number of different objects - * @param int $numInSet Number of objects in each combination + * @param int $numObjs Number of different objects + * @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) { @@ -192,9 +192,9 @@ class MathTrig * * @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) { @@ -226,9 +226,9 @@ class MathTrig * * @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) { @@ -266,9 +266,9 @@ class MathTrig * * @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) { @@ -301,10 +301,10 @@ class MathTrig * * @category Mathematical and Trigonometric Functions * - * @param float $number Number to round - * @param float $significance Significance + * @param float $number Number to round + * @param float $significance Significance * - * @return float Rounded Number + * @return float Rounded Number */ public static function FLOOR($number, $significance = null) { @@ -343,9 +343,9 @@ class MathTrig * * @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() { @@ -419,9 +419,9 @@ class MathTrig * * @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) { @@ -452,9 +452,9 @@ class MathTrig * * @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() { @@ -503,10 +503,10 @@ class MathTrig * * @category Mathematical and Trigonometric Functions * - * @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 $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. * - * @return float + * @return float */ public static function logBase($number = null, $base = 10) { @@ -533,9 +533,9 @@ class MathTrig * * @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) { @@ -585,9 +585,9 @@ class MathTrig * * @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) { @@ -632,10 +632,10 @@ class MathTrig /** * MMULT. * - * @param array $matrixData1 A matrix of values - * @param array $matrixData2 A matrix of values + * @param array $matrixData1 A matrix of values + * @param array $matrixData2 A matrix of values * - * @return array + * @return array */ public static function MMULT($matrixData1, $matrixData2) { @@ -694,10 +694,10 @@ class MathTrig /** * MOD. * - * @param int $a Dividend - * @param int $b Divisor + * @param int $a Dividend + * @param int $b Divisor * - * @return int Remainder + * @return int Remainder */ 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 * - * @param float $number Number to round - * @param int $multiple Multiple to which you want to round $number + * @param float $number Number to round + * @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) { @@ -751,9 +751,9 @@ class MathTrig * * 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() { @@ -788,9 +788,9 @@ class MathTrig * * 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) { @@ -822,10 +822,10 @@ class MathTrig * * Computes x raised to the power y. * - * @param float $x - * @param float $y + * @param float $x + * @param float $y * - * @return float + * @return float */ public static function POWER($x = 0, $y = 2) { @@ -855,9 +855,9 @@ class MathTrig * * @category Mathematical and Trigonometric Functions * - * @param mixed $arg,... Data values + * @param mixed $arg,... Data values * - * @return float + * @return float */ public static function PRODUCT() { @@ -895,9 +895,9 @@ class MathTrig * * @category Mathematical and Trigonometric Functions * - * @param mixed $arg,... Data values + * @param mixed $arg,... Data values * - * @return float + * @return float */ public static function QUOTIENT() { @@ -927,10 +927,10 @@ class MathTrig /** * RAND. * - * @param int $min Minimal value - * @param int $max Maximal value + * @param int $min Minimal value + * @param int $max Maximal value * - * @return int Random number + * @return int Random number */ 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 * - * @param float $number Number to round - * @param int $digits Number of digits to which you want to round $number + * @param float $number Number to round + * @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) { @@ -1008,10 +1008,10 @@ class MathTrig * * Rounds a number down to a specified number of decimal places * - * @param float $number Number to round - * @param int $digits Number of digits to which you want to round $number + * @param float $number Number to round + * @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) { @@ -1035,12 +1035,12 @@ class MathTrig * * Returns the sum of a 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 $m Step by which to increase $n for each term in the series - * @param array of mixed Data Series + * @param float $x Input value to the power series + * @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 array of mixed Data Series * - * @return float + * @return float */ 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) * 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) { @@ -1104,9 +1104,9 @@ class MathTrig * * 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) { @@ -1128,11 +1128,11 @@ class MathTrig * * 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 - * @param array of mixed Data Series + * @param array of mixed Data Series * - * @return float + * @return float */ public static function SUBTOTAL() { @@ -1181,9 +1181,9 @@ class MathTrig * * @category Mathematical and Trigonometric Functions * - * @param mixed $arg,... Data values + * @param mixed $arg,... Data values * - * @return float + * @return float */ public static function SUM() { @@ -1210,12 +1210,12 @@ class MathTrig * * @category Mathematical and Trigonometric Functions * - * @param mixed $arg,... Data values - * @param string $condition the criteria that defines which cells will be summed + * @param mixed $arg,... Data values + * @param string $condition the criteria that defines which cells will be summed * @param mixed $aArgs * @param mixed $sumArgs * - * @return float + * @return float */ 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 * @@ -1254,10 +1254,10 @@ class MathTrig * * @category Mathematical and Trigonometric Functions * - * @param mixed $arg,... Data values - * @param string $condition the criteria that defines which cells will be summed + * @param mixed $arg,... Data values + * @param string $condition the criteria that defines which cells will be summed * - * @return float + * @return float */ public static function SUMIFS() { @@ -1302,9 +1302,9 @@ class MathTrig * * @category Mathematical and Trigonometric Functions * - * @param mixed $arg,... Data values + * @param mixed $arg,... Data values * - * @return float + * @return float */ public static function SUMPRODUCT() { @@ -1347,9 +1347,9 @@ class MathTrig * * @category Mathematical and Trigonometric Functions * - * @param mixed $arg,... Data values + * @param mixed $arg,... Data values * - * @return float + * @return float */ public static function SUMSQ() { @@ -1369,10 +1369,10 @@ class MathTrig /** * SUMX2MY2. * - * @param mixed[] $matrixData1 Matrix #1 - * @param mixed[] $matrixData2 Matrix #2 + * @param mixed[] $matrixData1 Matrix #1 + * @param mixed[] $matrixData2 Matrix #2 * - * @return float + * @return float */ public static function SUMX2MY2($matrixData1, $matrixData2) { @@ -1394,10 +1394,10 @@ class MathTrig /** * SUMX2PY2. * - * @param mixed[] $matrixData1 Matrix #1 - * @param mixed[] $matrixData2 Matrix #2 + * @param mixed[] $matrixData1 Matrix #1 + * @param mixed[] $matrixData2 Matrix #2 * - * @return float + * @return float */ public static function SUMX2PY2($matrixData1, $matrixData2) { @@ -1419,10 +1419,10 @@ class MathTrig /** * SUMXMY2. * - * @param mixed[] $matrixData1 Matrix #1 - * @param mixed[] $matrixData2 Matrix #2 + * @param mixed[] $matrixData1 Matrix #1 + * @param mixed[] $matrixData2 Matrix #2 * - * @return float + * @return float */ public static function SUMXMY2($matrixData1, $matrixData2) { @@ -1446,10 +1446,10 @@ class MathTrig * * Truncates value to the number of fractional digits by number_digits. * - * @param float $value - * @param int $digits + * @param float $value + * @param int $digits * - * @return float Truncated value + * @return float Truncated value */ public static function TRUNC($value = 0, $digits = 0) { diff --git a/src/PhpSpreadsheet/Calculation/Statistical.php b/src/PhpSpreadsheet/Calculation/Statistical.php index e020630e..3d28a952 100644 --- a/src/PhpSpreadsheet/Calculation/Statistical.php +++ b/src/PhpSpreadsheet/Calculation/Statistical.php @@ -722,9 +722,9 @@ class Statistical * * @category Statistical Functions * - * @param mixed $arg,... Data values + * @param mixed $arg,... Data values * - * @return float + * @return float */ public static function AVEDEV() { @@ -773,9 +773,9 @@ class Statistical * * @category Statistical Functions * - * @param mixed $arg,... Data values + * @param mixed $arg,... Data values * - * @return float + * @return float */ public static function AVERAGE() { @@ -816,9 +816,9 @@ class Statistical * * @category Statistical Functions * - * @param mixed $arg,... Data values + * @param mixed $arg,... Data values * - * @return float + * @return float */ public static function AVERAGEA() { @@ -863,12 +863,12 @@ class Statistical * * @category Mathematical and Trigonometric Functions * - * @param mixed $arg,... Data values - * @param string $condition the criteria that defines which cells will be checked - * @param mixed[] $averageArgs Data values + * @param mixed $arg,... Data values + * @param string $condition the criteria that defines which cells will be checked + * @param mixed[] $averageArgs Data values * @param mixed $aArgs * - * @return float + * @return float */ public static function AVERAGEIF($aArgs, $condition, $averageArgs = []) { @@ -907,13 +907,13 @@ class Statistical * * Returns the beta distribution. * - * @param float $value Value at which you want to evaluate the distribution - * @param float $alpha Parameter to the distribution - * @param float $beta Parameter to the distribution + * @param float $value Value at which you want to evaluate the distribution + * @param float $alpha Parameter to the distribution + * @param float $beta Parameter to the distribution * @param mixed $rMin * @param mixed $rMax * - * @return float + * @return float */ public static function BETADIST($value, $alpha, $beta, $rMin = 0, $rMax = 1) { @@ -946,13 +946,13 @@ class Statistical * * Returns the inverse of the beta distribution. * - * @param float $probability Probability at which you want to evaluate the distribution - * @param float $alpha Parameter to the distribution - * @param float $beta Parameter to the distribution - * @param float $rMin Minimum value - * @param float $rMax Maximum value + * @param float $probability Probability at which you want to evaluate the distribution + * @param float $alpha Parameter to the distribution + * @param float $beta Parameter to the distribution + * @param float $rMin Minimum value + * @param float $rMax Maximum value * - * @return float + * @return float */ public static function BETAINV($probability, $alpha, $beta, $rMin = 0, $rMax = 1) { @@ -1005,12 +1005,12 @@ class Statistical * experiment. For example, BINOMDIST can calculate the probability that two of the next three * babies born are male. * - * @param float $value Number of successes in trials - * @param float $trials Number of trials - * @param float $probability Probability of success on each trial - * @param bool $cumulative + * @param float $value Number of successes in trials + * @param float $trials Number of trials + * @param float $probability Probability of success on each trial + * @param bool $cumulative * - * @return float + * @return float * * @todo Cumulative distribution function */ @@ -1049,10 +1049,10 @@ class Statistical * * Returns the one-tailed probability of the chi-squared distribution. * - * @param float $value Value for the function - * @param float $degrees degrees of freedom + * @param float $value Value for the function + * @param float $degrees degrees of freedom * - * @return float + * @return float */ public static function CHIDIST($value, $degrees) { @@ -1082,10 +1082,10 @@ class Statistical * * Returns the one-tailed probability of the chi-squared distribution. * - * @param float $probability Probability for the function - * @param float $degrees degrees of freedom + * @param float $probability Probability for the function + * @param float $degrees degrees of freedom * - * @return float + * @return float */ public static function CHIINV($probability, $degrees) { @@ -1140,11 +1140,11 @@ class Statistical * * Returns the confidence interval for a population mean * - * @param float $alpha - * @param float $stdDev Standard Deviation - * @param float $size + * @param float $alpha + * @param float $stdDev Standard Deviation + * @param float $size * - * @return float + * @return float */ public static function CONFIDENCE($alpha, $stdDev, $size) { @@ -1171,12 +1171,12 @@ class Statistical * * Returns covariance, the average of the products of deviations for each data point pair. * - * @param array of mixed Data Series Y - * @param array of mixed Data Series X + * @param array of mixed Data Series Y + * @param array of mixed Data Series X * @param mixed $yValues * @param null|mixed $xValues * - * @return float + * @return float */ public static function CORREL($yValues, $xValues = null) { @@ -1210,9 +1210,9 @@ class Statistical * * @category Statistical Functions * - * @param mixed $arg,... Data values + * @param mixed $arg,... Data values * - * @return int + * @return int */ public static function COUNT() { @@ -1244,9 +1244,9 @@ class Statistical * * @category Statistical Functions * - * @param mixed $arg,... Data values + * @param mixed $arg,... Data values * - * @return int + * @return int */ public static function COUNTA() { @@ -1274,9 +1274,9 @@ class Statistical * * @category Statistical Functions * - * @param mixed $arg,... Data values + * @param mixed $arg,... Data values * - * @return int + * @return int */ public static function COUNTBLANK() { @@ -1304,11 +1304,11 @@ class Statistical * * @category Statistical Functions * - * @param mixed $arg,... Data values - * @param string $condition the criteria that defines which cells will be counted + * @param mixed $arg,... Data values + * @param string $condition the criteria that defines which cells will be counted * @param mixed $aArgs * - * @return int + * @return int */ public static function COUNTIF($aArgs, $condition) { @@ -1336,12 +1336,12 @@ class Statistical * * Returns covariance, the average of the products of deviations for each data point pair. * - * @param array of mixed Data Series Y - * @param array of mixed Data Series X + * @param array of mixed Data Series Y + * @param array of mixed Data Series X * @param mixed $yValues * @param mixed $xValues * - * @return float + * @return float */ public static function COVAR($yValues, $xValues) { @@ -1370,11 +1370,11 @@ class Statistical * * See http://support.microsoft.com/kb/828117/ for details of the algorithm used * - * @param float $trials number of Bernoulli trials - * @param float $probability probability of a success on each trial - * @param float $alpha criterion value + * @param float $trials number of Bernoulli trials + * @param float $probability probability of a success on each trial + * @param float $alpha criterion value * - * @return int + * @return int * * @todo Warning. This implementation differs from the algorithm detailed on the MS * web site in that $CumPGuessMinus1 = $CumPGuess - 1 rather than $CumPGuess - $PGuess @@ -1495,9 +1495,9 @@ class Statistical * * @category Statistical Functions * - * @param mixed $arg,... Data values + * @param mixed $arg,... Data values * - * @return float + * @return float */ public static function DEVSQ() { @@ -1544,11 +1544,11 @@ class Statistical * such as how long an automated bank teller takes to deliver cash. For example, you can * use EXPONDIST to determine the probability that the process takes at most 1 minute. * - * @param float $value Value of the function - * @param float $lambda The parameter value - * @param bool $cumulative + * @param float $value Value of the function + * @param float $lambda The parameter value + * @param bool $cumulative * - * @return float + * @return float */ public static function EXPONDIST($value, $lambda, $cumulative) { @@ -1579,9 +1579,9 @@ class Statistical * is normally distributed rather than skewed. Use this function to perform hypothesis * testing on the correlation coefficient. * - * @param float $value + * @param float $value * - * @return float + * @return float */ public static function FISHER($value) { @@ -1605,9 +1605,9 @@ class Statistical * analyzing correlations between ranges or arrays of data. If y = FISHER(x), then * FISHERINV(y) = x. * - * @param float $value + * @param float $value * - * @return float + * @return float */ public static function FISHERINV($value) { @@ -1625,14 +1625,14 @@ class Statistical * * Calculates, or predicts, a future value by using existing values. The predicted value is a y-value for a given x-value. * - * @param float Value of X for which we want to find Y - * @param array of mixed Data Series Y - * @param array of mixed Data Series X + * @param float Value of X for which we want to find Y + * @param array of mixed Data Series Y + * @param array of mixed Data Series X * @param mixed $xValue * @param mixed $yValues * @param mixed $xValues * - * @return float + * @return float */ public static function FORECAST($xValue, $yValues, $xValues) { @@ -1661,12 +1661,12 @@ class Statistical * * Returns the gamma distribution. * - * @param float $value Value at which you want to evaluate the distribution - * @param float $a Parameter to the distribution - * @param float $b Parameter to the distribution - * @param bool $cumulative + * @param float $value Value at which you want to evaluate the distribution + * @param float $a Parameter to the distribution + * @param float $b Parameter to the distribution + * @param bool $cumulative * - * @return float + * @return float */ public static function GAMMADIST($value, $a, $b, $cumulative) { @@ -1695,11 +1695,11 @@ class Statistical * * Returns the inverse of the beta distribution. * - * @param float $probability Probability at which you want to evaluate the distribution - * @param float $alpha Parameter to the distribution - * @param float $beta Parameter to the distribution + * @param float $probability Probability at which you want to evaluate the distribution + * @param float $alpha Parameter to the distribution + * @param float $beta Parameter to the distribution * - * @return float + * @return float */ public static function GAMMAINV($probability, $alpha, $beta) { @@ -1758,9 +1758,9 @@ class Statistical * * Returns the natural logarithm of the gamma function. * - * @param float $value + * @param float $value * - * @return float + * @return float */ public static function GAMMALN($value) { @@ -1789,9 +1789,9 @@ class Statistical * * @category Statistical Functions * - * @param mixed $arg,... Data values + * @param mixed $arg,... Data values * - * @return float + * @return float */ public static function GEOMEAN() { @@ -1813,16 +1813,16 @@ class Statistical * * Returns values along a predicted emponential Trend * - * @param array of mixed Data Series Y - * @param array of mixed Data Series X - * @param array of mixed Values of X for which we want to find Y - * @param bool a logical value specifying whether to force the intersect to equal 0 + * @param array of mixed Data Series Y + * @param array of mixed Data Series X + * @param array of mixed Values of X for which we want to find Y + * @param bool a logical value specifying whether to force the intersect to equal 0 * @param mixed $yValues * @param mixed $xValues * @param mixed $newValues * @param mixed $const * - * @return array of float + * @return array of float */ public static function GROWTH($yValues, $xValues = [], $newValues = [], $const = true) { @@ -1855,9 +1855,9 @@ class Statistical * * @category Statistical Functions * - * @param mixed $arg,... Data values + * @param mixed $arg,... Data values * - * @return float + * @return float */ public static function HARMEAN() { @@ -1899,12 +1899,12 @@ class Statistical * Returns the hypergeometric distribution. HYPGEOMDIST returns the probability of a given number of * sample successes, given the sample size, population successes, and population size. * - * @param float $sampleSuccesses Number of successes in the sample - * @param float $sampleNumber Size of the sample - * @param float $populationSuccesses Number of successes in the population - * @param float $populationNumber Population size + * @param float $sampleSuccesses Number of successes in the sample + * @param float $sampleNumber Size of the sample + * @param float $populationSuccesses Number of successes in the population + * @param float $populationNumber Population size * - * @return float + * @return float */ public static function HYPGEOMDIST($sampleSuccesses, $sampleNumber, $populationSuccesses, $populationNumber) { @@ -1937,12 +1937,12 @@ class Statistical * * Calculates the point at which a line will intersect the y-axis by using existing x-values and y-values. * - * @param array of mixed Data Series Y - * @param array of mixed Data Series X + * @param array of mixed Data Series Y + * @param array of mixed Data Series X * @param mixed $yValues * @param mixed $xValues * - * @return float + * @return float */ public static function INTERCEPT($yValues, $xValues) { @@ -1971,9 +1971,9 @@ class Statistical * kurtosis indicates a relatively peaked distribution. Negative kurtosis indicates a * relatively flat distribution. * - * @param array Data Series + * @param array Data Series * - * @return float + * @return float */ public static function KURT() { @@ -2016,10 +2016,10 @@ class Statistical * * @category Statistical Functions * - * @param mixed $arg,... Data values - * @param int $entry Position (ordered from the largest) in the array or range of data to return + * @param mixed $arg,... Data values + * @param int $entry Position (ordered from the largest) in the array or range of data to return * - * @return float + * @return float */ public static function LARGE() { @@ -2055,16 +2055,16 @@ class Statistical * Calculates the statistics for a line by using the "least squares" method to calculate a straight line that best fits your data, * and then returns an array that describes the line. * - * @param array of mixed Data Series Y - * @param array of mixed Data Series X - * @param bool a logical value specifying whether to force the intersect to equal 0 - * @param bool a logical value specifying whether to return additional regression statistics + * @param array of mixed Data Series Y + * @param array of mixed Data Series X + * @param bool a logical value specifying whether to force the intersect to equal 0 + * @param bool a logical value specifying whether to return additional regression statistics * @param mixed $yValues * @param null|mixed $xValues * @param mixed $const * @param mixed $stats * - * @return array + * @return array */ public static function LINEST($yValues, $xValues = null, $const = true, $stats = false) { @@ -2118,16 +2118,16 @@ class Statistical * Calculates an exponential curve that best fits the X and Y data series, * and then returns an array that describes the line. * - * @param array of mixed Data Series Y - * @param array of mixed Data Series X - * @param bool a logical value specifying whether to force the intersect to equal 0 - * @param bool a logical value specifying whether to return additional regression statistics + * @param array of mixed Data Series Y + * @param array of mixed Data Series X + * @param bool a logical value specifying whether to force the intersect to equal 0 + * @param bool a logical value specifying whether to return additional regression statistics * @param mixed $yValues * @param null|mixed $xValues * @param mixed $const * @param mixed $stats * - * @return array + * @return array */ public static function LOGEST($yValues, $xValues = null, $const = true, $stats = false) { @@ -2186,11 +2186,11 @@ class Statistical * * Returns the inverse of the normal cumulative distribution * - * @param float $probability - * @param float $mean - * @param float $stdDev + * @param float $probability + * @param float $mean + * @param float $stdDev * - * @return float + * @return float * * @todo Try implementing P J Acklam's refinement algorithm for greater * accuracy if I can get my head round the mathematics @@ -2219,11 +2219,11 @@ class Statistical * Returns the cumulative lognormal distribution of x, where ln(x) is normally distributed * with parameters mean and standard_dev. * - * @param float $value - * @param float $mean - * @param float $stdDev + * @param float $value + * @param float $mean + * @param float $stdDev * - * @return float + * @return float */ public static function LOGNORMDIST($value, $mean, $stdDev) { @@ -2253,9 +2253,9 @@ class Statistical * * @category Statistical Functions * - * @param mixed $arg,... Data values + * @param mixed $arg,... Data values * - * @return float + * @return float */ public static function MAX() { @@ -2289,9 +2289,9 @@ class Statistical * * @category Statistical Functions * - * @param mixed $arg,... Data values + * @param mixed $arg,... Data values * - * @return float + * @return float */ public static function MAXA() { @@ -2330,12 +2330,12 @@ class Statistical * * @category Mathematical and Trigonometric Functions * - * @param mixed $arg,... Data values - * @param string $condition the criteria that defines which cells will be checked + * @param mixed $arg,... Data values + * @param string $condition the criteria that defines which cells will be checked * @param mixed $aArgs * @param mixed $sumArgs * - * @return float + * @return float */ public static function MAXIF($aArgs, $condition, $sumArgs = []) { @@ -2373,9 +2373,9 @@ class Statistical * * @category Statistical Functions * - * @param mixed $arg,... Data values + * @param mixed $arg,... Data values * - * @return float + * @return float */ public static function MEDIAN() { @@ -2417,9 +2417,9 @@ class Statistical * * @category Statistical Functions * - * @param mixed $arg,... Data values + * @param mixed $arg,... Data values * - * @return float + * @return float */ public static function MIN() { @@ -2453,9 +2453,9 @@ class Statistical * * @category Statistical Functions * - * @param mixed $arg,... Data values + * @param mixed $arg,... Data values * - * @return float + * @return float */ public static function MINA() { @@ -2494,12 +2494,12 @@ class Statistical * * @category Mathematical and Trigonometric Functions * - * @param mixed $arg,... Data values - * @param string $condition the criteria that defines which cells will be checked + * @param mixed $arg,... Data values + * @param string $condition the criteria that defines which cells will be checked * @param mixed $aArgs * @param mixed $sumArgs * - * @return float + * @return float */ public static function MINIF($aArgs, $condition, $sumArgs = []) { @@ -2574,9 +2574,9 @@ class Statistical * * @category Statistical Functions * - * @param mixed $arg,... Data values + * @param mixed $arg,... Data values * - * @return float + * @return float */ public static function MODE() { @@ -2609,11 +2609,11 @@ class Statistical * distribution, except that the number of successes is fixed, and the number of trials is * variable. Like the binomial, trials are assumed to be independent. * - * @param float $failures Number of Failures - * @param float $successes Threshold number of Successes - * @param float $probability Probability of success on each trial + * @param float $failures Number of Failures + * @param float $successes Threshold number of Successes + * @param float $probability Probability of success on each trial * - * @return float + * @return float */ public static function NEGBINOMDIST($failures, $successes, $probability) { @@ -2646,12 +2646,12 @@ class Statistical * function has a very wide range of applications in statistics, including hypothesis * testing. * - * @param float $value - * @param float $mean Mean Value - * @param float $stdDev Standard Deviation - * @param bool $cumulative + * @param float $value + * @param float $mean Mean Value + * @param float $stdDev Standard Deviation + * @param bool $cumulative * - * @return float + * @return float */ public static function NORMDIST($value, $mean, $stdDev, $cumulative) { @@ -2680,11 +2680,11 @@ class Statistical * * Returns the inverse of the normal cumulative distribution for the specified mean and standard deviation. * - * @param float $probability - * @param float $mean Mean Value - * @param float $stdDev Standard Deviation + * @param float $probability + * @param float $mean Mean Value + * @param float $stdDev Standard Deviation * - * @return float + * @return float */ public static function NORMINV($probability, $mean, $stdDev) { @@ -2713,9 +2713,9 @@ class Statistical * a mean of 0 (zero) and a standard deviation of one. Use this function in place of a * table of standard normal curve areas. * - * @param float $value + * @param float $value * - * @return float + * @return float */ public static function NORMSDIST($value) { @@ -2729,9 +2729,9 @@ class Statistical * * Returns the inverse of the standard normal cumulative distribution * - * @param float $value + * @param float $value * - * @return float + * @return float */ public static function NORMSINV($value) { @@ -2748,10 +2748,10 @@ class Statistical * * @category Statistical Functions * - * @param mixed $arg,... Data values - * @param float $entry Percentile value in the range 0..1, inclusive. + * @param mixed $arg,... Data values + * @param float $entry Percentile value in the range 0..1, inclusive. * - * @return float + * @return float */ public static function PERCENTILE() { @@ -2795,14 +2795,14 @@ class Statistical * * Returns the rank of a value in a data set as a percentage of the data set. * - * @param array of number An array of, or a reference to, a list of numbers - * @param number the number whose rank you want to find - * @param number the number of significant digits for the returned percentage value + * @param array of number An array of, or a reference to, a list of numbers + * @param number the number whose rank you want to find + * @param number the number of significant digits for the returned percentage value * @param mixed $valueSet * @param mixed $value * @param mixed $significance * - * @return float + * @return float */ public static function PERCENTRANK($valueSet, $value, $significance = 3) { @@ -2849,10 +2849,10 @@ class Statistical * combinations, for which the internal order is not significant. Use this function * for lottery-style probability calculations. * - * @param int $numObjs Number of different objects - * @param int $numInSet Number of objects in each permutation + * @param int $numObjs Number of different objects + * @param int $numInSet Number of objects in each permutation * - * @return int Number of permutations + * @return int Number of permutations */ public static function PERMUT($numObjs, $numInSet) { @@ -2878,11 +2878,11 @@ class Statistical * is predicting the number of events over a specific time, such as the number of * cars arriving at a toll plaza in 1 minute. * - * @param float $value - * @param float $mean Mean Value - * @param bool $cumulative + * @param float $value + * @param float $mean Mean Value + * @param bool $cumulative * - * @return float + * @return float */ public static function POISSON($value, $mean, $cumulative) { @@ -2920,10 +2920,10 @@ class Statistical * * @category Statistical Functions * - * @param mixed $arg,... Data values - * @param int $entry Quartile value in the range 1..3, inclusive. + * @param mixed $arg,... Data values + * @param int $entry Quartile value in the range 1..3, inclusive. * - * @return float + * @return float */ public static function QUARTILE() { @@ -2949,14 +2949,14 @@ class Statistical * * Returns the rank of a number in a list of numbers. * - * @param number the number whose rank you want to find - * @param array of number An array of, or a reference to, a list of numbers - * @param mixed Order to sort the values in the value set + * @param number the number whose rank you want to find + * @param array of number An array of, or a reference to, a list of numbers + * @param mixed Order to sort the values in the value set * @param mixed $value * @param mixed $valueSet * @param mixed $order * - * @return float + * @return float */ public static function RANK($value, $valueSet, $order = 0) { @@ -2988,12 +2988,12 @@ class Statistical * * Returns the square of the Pearson product moment correlation coefficient through data points in known_y's and known_x's. * - * @param array of mixed Data Series Y - * @param array of mixed Data Series X + * @param array of mixed Data Series Y + * @param array of mixed Data Series X * @param mixed $yValues * @param mixed $xValues * - * @return float + * @return float */ public static function RSQ($yValues, $xValues) { @@ -3022,9 +3022,9 @@ class Statistical * asymmetric tail extending toward more positive values. Negative skewness indicates a * distribution with an asymmetric tail extending toward more negative values. * - * @param array Data Series + * @param array Data Series * - * @return float + * @return float */ public static function SKEW() { @@ -3058,12 +3058,12 @@ class Statistical * * Returns the slope of the linear regression line through data points in known_y's and known_x's. * - * @param array of mixed Data Series Y - * @param array of mixed Data Series X + * @param array of mixed Data Series Y + * @param array of mixed Data Series X * @param mixed $yValues * @param mixed $xValues * - * @return float + * @return float */ public static function SLOPE($yValues, $xValues) { @@ -3095,10 +3095,10 @@ class Statistical * * @category Statistical Functions * - * @param mixed $arg,... Data values - * @param int $entry Position (ordered from the smallest) in the array or range of data to return + * @param mixed $arg,... Data values + * @param int $entry Position (ordered from the smallest) in the array or range of data to return * - * @return float + * @return float */ public static function SMALL() { @@ -3133,11 +3133,11 @@ class Statistical * * Returns a normalized value from a distribution characterized by mean and standard_dev. * - * @param float $value Value to normalize - * @param float $mean Mean Value - * @param float $stdDev Standard Deviation + * @param float $value Value to normalize + * @param float $mean Mean Value + * @param float $stdDev Standard Deviation * - * @return float Standardized value + * @return float Standardized value */ public static function STANDARDIZE($value, $mean, $stdDev) { @@ -3167,9 +3167,9 @@ class Statistical * * @category Statistical Functions * - * @param mixed $arg,... Data values + * @param mixed $arg,... Data values * - * @return float + * @return float */ public static function STDEV() { @@ -3216,9 +3216,9 @@ class Statistical * * @category Statistical Functions * - * @param mixed $arg,... Data values + * @param mixed $arg,... Data values * - * @return float + * @return float */ public static function STDEVA() { @@ -3268,9 +3268,9 @@ class Statistical * * @category Statistical Functions * - * @param mixed $arg,... Data values + * @param mixed $arg,... Data values * - * @return float + * @return float */ public static function STDEVP() { @@ -3315,9 +3315,9 @@ class Statistical * * @category Statistical Functions * - * @param mixed $arg,... Data values + * @param mixed $arg,... Data values * - * @return float + * @return float */ public static function STDEVPA() { @@ -3362,12 +3362,12 @@ class Statistical * * Returns the standard error of the predicted y-value for each x in the regression. * - * @param array of mixed Data Series Y - * @param array of mixed Data Series X + * @param array of mixed Data Series Y + * @param array of mixed Data Series X * @param mixed $yValues * @param mixed $xValues * - * @return float + * @return float */ public static function STEYX($yValues, $xValues) { @@ -3393,11 +3393,11 @@ class Statistical * * Returns the probability of Student's T distribution. * - * @param float $value Value for the function - * @param float $degrees degrees of freedom - * @param float $tails number of tails (1 or 2) + * @param float $value Value for the function + * @param float $degrees degrees of freedom + * @param float $tails number of tails (1 or 2) * - * @return float + * @return float */ public static function TDIST($value, $degrees, $tails) { @@ -3458,10 +3458,10 @@ class Statistical * * Returns the one-tailed probability of the chi-squared distribution. * - * @param float $probability Probability for the function - * @param float $degrees degrees of freedom + * @param float $probability Probability for the function + * @param float $degrees degrees of freedom * - * @return float + * @return float */ public static function TINV($probability, $degrees) { @@ -3516,16 +3516,16 @@ class Statistical * * Returns values along a linear Trend * - * @param array of mixed Data Series Y - * @param array of mixed Data Series X - * @param array of mixed Values of X for which we want to find Y - * @param bool a logical value specifying whether to force the intersect to equal 0 + * @param array of mixed Data Series Y + * @param array of mixed Data Series X + * @param array of mixed Values of X for which we want to find Y + * @param bool a logical value specifying whether to force the intersect to equal 0 * @param mixed $yValues * @param mixed $xValues * @param mixed $newValues * @param mixed $const * - * @return array of float + * @return array of float */ public static function TREND($yValues, $xValues = [], $newValues = [], $const = true) { @@ -3559,10 +3559,10 @@ class Statistical * * @category Statistical Functions * - * @param mixed $arg,... Data values - * @param float $discard Percentage to discard + * @param mixed $arg,... Data values + * @param float $discard Percentage to discard * - * @return float + * @return float */ public static function TRIMMEAN() { @@ -3605,9 +3605,9 @@ class Statistical * * @category Statistical Functions * - * @param mixed $arg,... Data values + * @param mixed $arg,... Data values * - * @return float + * @return float */ public static function VARFunc() { @@ -3649,9 +3649,9 @@ class Statistical * * @category Statistical Functions * - * @param mixed $arg,... Data values + * @param mixed $arg,... Data values * - * @return float + * @return float */ public static function VARA() { @@ -3702,9 +3702,9 @@ class Statistical * * @category Statistical Functions * - * @param mixed $arg,... Data values + * @param mixed $arg,... Data values * - * @return float + * @return float */ public static function VARP() { @@ -3747,9 +3747,9 @@ class Statistical * * @category Statistical Functions * - * @param mixed $arg,... Data values + * @param mixed $arg,... Data values * - * @return float + * @return float */ public static function VARPA() { @@ -3796,12 +3796,12 @@ class Statistical * Returns the Weibull distribution. Use this distribution in reliability * analysis, such as calculating a device's mean time to failure. * - * @param float $value - * @param float $alpha Alpha Parameter - * @param float $beta Beta Parameter - * @param bool $cumulative + * @param float $value + * @param float $alpha Alpha Parameter + * @param float $beta Beta Parameter + * @param bool $cumulative * - * @return float + * @return float */ public static function WEIBULL($value, $alpha, $beta, $cumulative) { @@ -3831,11 +3831,11 @@ class Statistical * Returns the Weibull distribution. Use this distribution in reliability * analysis, such as calculating a device's mean time to failure. * - * @param float $dataSet - * @param float $m0 Alpha Parameter - * @param float $sigma Beta Parameter + * @param float $dataSet + * @param float $m0 Alpha Parameter + * @param float $sigma Beta Parameter * - * @return float + * @return float */ public static function ZTEST($dataSet, $m0, $sigma = null) { diff --git a/src/PhpSpreadsheet/Calculation/TextData.php b/src/PhpSpreadsheet/Calculation/TextData.php index da3a147b..b02de87c 100644 --- a/src/PhpSpreadsheet/Calculation/TextData.php +++ b/src/PhpSpreadsheet/Calculation/TextData.php @@ -36,9 +36,9 @@ class TextData /** * CHARACTER. * - * @param string $character Value + * @param string $character Value * - * @return string + * @return string */ public static function CHARACTER($character) { @@ -58,9 +58,9 @@ class TextData /** * TRIMNONPRINTABLE. * - * @param mixed $stringValue Value to check + * @param mixed $stringValue Value to check * - * @return string + * @return string */ public static function TRIMNONPRINTABLE($stringValue = '') { @@ -84,9 +84,9 @@ class TextData /** * TRIMSPACES. * - * @param mixed $stringValue Value to check + * @param mixed $stringValue Value to check * - * @return string + * @return string */ public static function TRIMSPACES($stringValue = '') { @@ -105,9 +105,9 @@ class TextData /** * ASCIICODE. * - * @param string $characters Value + * @param string $characters Value * - * @return int + * @return int */ public static function ASCIICODE($characters) { @@ -141,7 +141,7 @@ class TextData /** * CONCATENATE. * - * @return string + * @return string */ 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. * The format used is $#,##0.00_);($#,##0.00).. * - * @param float $value The value to format - * @param int $decimals The number of digits to display to the right of the decimal point. + * @param float $value The value to format + * @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 you omit decimals, it is assumed to be 2 * - * @return string + * @return string */ public static function DOLLAR($value = 0, $decimals = 2) { @@ -204,11 +204,11 @@ class TextData /** * SEARCHSENSITIVE. * - * @param string $needle The string to look for - * @param string $haystack The string in which to look - * @param int $offset Offset within $haystack + * @param string $needle The string to look for + * @param string $haystack The string in which to look + * @param int $offset Offset within $haystack * - * @return string + * @return string */ public static function SEARCHSENSITIVE($needle, $haystack, $offset = 1) { @@ -242,11 +242,11 @@ class TextData /** * SEARCHINSENSITIVE. * - * @param string $needle The string to look for - * @param string $haystack The string in which to look - * @param int $offset Offset within $haystack + * @param string $needle The string to look for + * @param string $haystack The string in which to look + * @param int $offset Offset within $haystack * - * @return string + * @return string */ public static function SEARCHINSENSITIVE($needle, $haystack, $offset = 1) { @@ -280,11 +280,11 @@ class TextData /** * FIXEDFORMAT. * - * @param mixed $value Value to check - * @param int $decimals - * @param bool $no_commas + * @param mixed $value Value to check + * @param int $decimals + * @param bool $no_commas * - * @return string + * @return string */ public static function FIXEDFORMAT($value, $decimals = 2, $no_commas = false) { @@ -312,10 +312,10 @@ class TextData /** * LEFT. * - * @param string $value Value - * @param int $chars Number of characters + * @param string $value Value + * @param int $chars Number of characters * - * @return string + * @return string */ public static function LEFT($value = '', $chars = 1) { @@ -340,11 +340,11 @@ class TextData /** * MID. * - * @param string $value Value - * @param int $start Start character - * @param int $chars Number of characters + * @param string $value Value + * @param int $start Start character + * @param int $chars Number of characters * - * @return string + * @return string */ public static function MID($value = '', $start = 1, $chars = null) { @@ -373,10 +373,10 @@ class TextData /** * RIGHT. * - * @param string $value Value - * @param int $chars Number of characters + * @param string $value Value + * @param int $chars Number of characters * - * @return string + * @return string */ public static function RIGHT($value = '', $chars = 1) { @@ -401,9 +401,9 @@ class TextData /** * STRINGLENGTH. * - * @param string $value Value + * @param string $value Value * - * @return int + * @return int */ public static function STRINGLENGTH($value = '') { @@ -425,9 +425,9 @@ class TextData * * Converts a string value to upper case. * - * @param string $mixedCaseString + * @param string $mixedCaseString * - * @return string + * @return string */ public static function LOWERCASE($mixedCaseString) { @@ -445,9 +445,9 @@ class TextData * * Converts a string value to upper case. * - * @param string $mixedCaseString + * @param string $mixedCaseString * - * @return string + * @return string */ public static function UPPERCASE($mixedCaseString) { @@ -465,9 +465,9 @@ class TextData * * Converts a string value to upper case. * - * @param string $mixedCaseString + * @param string $mixedCaseString * - * @return string + * @return string */ public static function PROPERCASE($mixedCaseString) { @@ -483,12 +483,12 @@ class TextData /** * REPLACE. * - * @param string $oldText String to modify - * @param int $start Start character - * @param int $chars Number of characters - * @param string $newText String to replace in defined position + * @param string $oldText String to modify + * @param int $start Start character + * @param int $chars Number of characters + * @param string $newText String to replace in defined position * - * @return string + * @return string */ public static function REPLACE($oldText, $start, $chars, $newText) { @@ -506,12 +506,12 @@ class TextData /** * SUBSTITUTE. * - * @param string $text Value - * @param string $fromText From Value - * @param string $toText To Value - * @param int $instance Instance Number + * @param string $text Value + * @param string $fromText From Value + * @param string $toText To Value + * @param int $instance Instance Number * - * @return string + * @return string */ public static function SUBSTITUTE($text = '', $fromText = '', $toText = '', $instance = 0) { @@ -553,9 +553,9 @@ class TextData /** * RETURNSTRING. * - * @param mixed $testValue Value to check + * @param mixed $testValue Value to check * - * @return string|null + * @return string|null */ public static function RETURNSTRING($testValue = '') { @@ -571,10 +571,10 @@ class TextData /** * TEXTFORMAT. * - * @param mixed $value Value to check - * @param string $format Format mask to use + * @param mixed $value Value to check + * @param string $format Format mask to use * - * @return string + * @return string */ public static function TEXTFORMAT($value, $format) { @@ -591,9 +591,9 @@ class TextData /** * VALUE. * - * @param mixed $value Value to check + * @param mixed $value Value to check * - * @return bool + * @return bool */ public static function VALUE($value = '') { diff --git a/src/PhpSpreadsheet/Calculation/Token/Stack.php b/src/PhpSpreadsheet/Calculation/Token/Stack.php index a83c1b76..efa63011 100644 --- a/src/PhpSpreadsheet/Calculation/Token/Stack.php +++ b/src/PhpSpreadsheet/Calculation/Token/Stack.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Calculation\Token; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -27,23 +27,23 @@ namespace PhpOffice\PhpSpreadsheet\Calculation\Token; class Stack { /** - * The parser stack for formulae. + * The parser stack for formulae. * - * @var mixed[] + * @var mixed[] */ private $stack = []; /** - * Count of entries in the parser stack. + * Count of entries in the parser stack. * - * @var int + * @var int */ private $count = 0; /** * Return the number of entries on the stack. * - * @return int + * @return int */ public function count() { @@ -53,9 +53,9 @@ class Stack /** * Push a new entry onto the stack. * - * @param mixed $type - * @param mixed $value - * @param mixed $reference + * @param mixed $type + * @param mixed $value + * @param mixed $reference */ public function push($type, $value, $reference = null) { @@ -75,7 +75,7 @@ class Stack /** * Pop the last entry from the stack. * - * @return mixed + * @return mixed */ public function pop() { @@ -89,9 +89,9 @@ class Stack /** * 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) { diff --git a/src/PhpSpreadsheet/Cell.php b/src/PhpSpreadsheet/Cell.php index 7dcc4d23..889739a3 100644 --- a/src/PhpSpreadsheet/Cell.php +++ b/src/PhpSpreadsheet/Cell.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -27,23 +27,23 @@ namespace PhpOffice\PhpSpreadsheet; class Cell { /** - * Default range variable constant. + * Default range variable constant. * - * @var string + * @var string */ const DEFAULT_RANGE = 'A1:A1'; /** - * Value binder to use. + * Value binder to use. * - * @var Cell\IValueBinder + * @var Cell\IValueBinder */ private static $valueBinder; /** - * Value of the cell. + * Value of the cell. * - * @var mixed + * @var mixed */ private $value; @@ -55,38 +55,38 @@ class Cell * 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. * - * @var mixed + * @var mixed */ private $calculatedValue; /** - * Type of the cell data. + * Type of the cell data. * - * @var string + * @var string */ private $dataType; /** - * Parent worksheet. + * Parent worksheet. * - * @var CachedObjectStorage\CacheBase + * @var CachedObjectStorage\CacheBase */ private $parent; /** - * Index to cellXf. + * Index to cellXf. * - * @var int + * @var int */ private $xfIndex = 0; /** - * Attributes of the formula. + * Attributes of the formula. */ private $formulaAttributes; /** - * Send notification to the cache controller. + * Send notification to the cache controller. **/ public function notifyCacheController() { @@ -106,13 +106,13 @@ class Cell } /** - * Create a new Cell. + * Create a new Cell. * - * @param mixed $pValue - * @param string $pDataType - * @param Worksheet $pSheet + * @param mixed $pValue + * @param string $pDataType + * @param Worksheet $pSheet * - * @throws Exception + * @throws Exception */ 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() { @@ -144,9 +144,9 @@ class Cell } /** - * Get cell coordinate row. + * Get cell coordinate row. * - * @return int + * @return int */ public function getRow() { @@ -154,9 +154,9 @@ class Cell } /** - * Get cell coordinate. + * Get cell coordinate. * - * @return string + * @return string */ public function getCoordinate() { @@ -164,9 +164,9 @@ class Cell } /** - * Get cell value. + * Get cell value. * - * @return mixed + * @return mixed */ 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() { @@ -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 * - * @param mixed $pValue Value + * @param mixed $pValue Value * - * @throws Exception + * @throws Exception * - * @return Cell + * @return Cell */ 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 string $pDataType Explicit data type + * @param mixed $pValue Value + * @param string $pDataType Explicit data type * - * @throws Exception + * @throws Exception * - * @return Cell + * @return Cell */ 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 * - * @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) { @@ -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) { @@ -326,7 +326,7 @@ class Cell * 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. * - * @return mixed + * @return mixed */ public function getOldCalculatedValue() { @@ -334,9 +334,9 @@ class Cell } /** - * Get cell data type. + * Get cell data type. * - * @return string + * @return string */ 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) { @@ -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() { @@ -373,9 +373,9 @@ class Cell /** * Does this cell contain Data validation rules? * - * @throws Exception + * @throws Exception * - * @return bool + * @return bool */ 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() { @@ -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) { @@ -425,9 +425,9 @@ class Cell /** * Does this cell contain a Hyperlink? * - * @throws Exception + * @throws Exception * - * @return bool + * @return bool */ 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() { @@ -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) { @@ -475,9 +475,9 @@ class Cell } /** - * Get parent worksheet. + * Get parent worksheet. * - * @return CachedObjectStorage\CacheBase + * @return CachedObjectStorage\CacheBase */ public function getParent() { @@ -485,9 +485,9 @@ class Cell } /** - * Get parent worksheet. + * Get parent worksheet. * - * @return Worksheet + * @return Worksheet */ 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() { @@ -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() { @@ -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() { @@ -539,9 +539,9 @@ class Cell } /** - * Get cell style. + * Get cell style. * - * @return Style + * @return Style */ 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) { @@ -565,9 +565,9 @@ class Cell /** * 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') { @@ -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') { @@ -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 * - * @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') { @@ -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') { @@ -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')) * 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) { @@ -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) */ 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') { @@ -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) */ 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') { @@ -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) { @@ -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') { @@ -949,10 +949,10 @@ class Cell /** * Compare 2 cells. * - * @param Cell $a Cell a - * @param Cell $b Cell b + * @param Cell $a Cell a + * @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) { diff --git a/src/PhpSpreadsheet/Cell/AdvancedValueBinder.php b/src/PhpSpreadsheet/Cell/AdvancedValueBinder.php index eaa940c6..ba960839 100644 --- a/src/PhpSpreadsheet/Cell/AdvancedValueBinder.php +++ b/src/PhpSpreadsheet/Cell/AdvancedValueBinder.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Cell; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -29,8 +29,8 @@ class AdvancedValueBinder extends DefaultValueBinder implements IValueBinder /** * Bind value to a cell. * - * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to bind value to - * @param mixed $value Value to bind in cell + * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to bind value to + * @param mixed $value Value to bind in cell * * @return bool */ diff --git a/src/PhpSpreadsheet/Cell/DataType.php b/src/PhpSpreadsheet/Cell/DataType.php index 5e18de94..ee2fa6b6 100644 --- a/src/PhpSpreadsheet/Cell/DataType.php +++ b/src/PhpSpreadsheet/Cell/DataType.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Cell; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -64,10 +64,10 @@ class DataType /** * 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 * - * @return mixed Sanitized value + * @return mixed Sanitized value */ public static function checkString($pValue = null) { @@ -88,10 +88,10 @@ class DataType /** * 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 * - * @return string Sanitized value + * @return string Sanitized value */ public static function checkErrorCode($pValue = null) { diff --git a/src/PhpSpreadsheet/Cell/DataValidation.php b/src/PhpSpreadsheet/Cell/DataValidation.php index faffe464..c7e7681d 100644 --- a/src/PhpSpreadsheet/Cell/DataValidation.php +++ b/src/PhpSpreadsheet/Cell/DataValidation.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Cell; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -162,7 +162,7 @@ class DataValidation /** * Set Formula 1. * - * @param string $value + * @param string $value * * @return DataValidation */ @@ -186,7 +186,7 @@ class DataValidation /** * Set Formula 2. * - * @param string $value + * @param string $value * * @return DataValidation */ @@ -210,7 +210,7 @@ class DataValidation /** * Set Type. * - * @param string $value + * @param string $value * * @return DataValidation */ @@ -234,7 +234,7 @@ class DataValidation /** * Set Error style. * - * @param string $value + * @param string $value * * @return DataValidation */ @@ -258,7 +258,7 @@ class DataValidation /** * Set Operator. * - * @param string $value + * @param string $value * * @return DataValidation */ @@ -282,7 +282,7 @@ class DataValidation /** * Set Allow Blank. * - * @param bool $value + * @param bool $value * * @return DataValidation */ @@ -306,7 +306,7 @@ class DataValidation /** * Set Show DropDown. * - * @param bool $value + * @param bool $value * * @return DataValidation */ @@ -330,7 +330,7 @@ class DataValidation /** * Set Show InputMessage. * - * @param bool $value + * @param bool $value * * @return DataValidation */ @@ -354,7 +354,7 @@ class DataValidation /** * Set Show ErrorMessage. * - * @param bool $value + * @param bool $value * * @return DataValidation */ @@ -378,7 +378,7 @@ class DataValidation /** * Set Error title. * - * @param string $value + * @param string $value * * @return DataValidation */ @@ -402,7 +402,7 @@ class DataValidation /** * Set Error. * - * @param string $value + * @param string $value * * @return DataValidation */ @@ -426,7 +426,7 @@ class DataValidation /** * Set Prompt title. * - * @param string $value + * @param string $value * * @return DataValidation */ @@ -450,7 +450,7 @@ class DataValidation /** * Set Prompt. * - * @param string $value + * @param string $value * * @return DataValidation */ @@ -464,7 +464,7 @@ class DataValidation /** * Get hash code. * - * @return string Hash code + * @return string Hash code */ public function getHashCode() { diff --git a/src/PhpSpreadsheet/Cell/DefaultValueBinder.php b/src/PhpSpreadsheet/Cell/DefaultValueBinder.php index 6faaca11..461c96e6 100644 --- a/src/PhpSpreadsheet/Cell/DefaultValueBinder.php +++ b/src/PhpSpreadsheet/Cell/DefaultValueBinder.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Cell; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -29,8 +29,8 @@ class DefaultValueBinder implements IValueBinder /** * Bind value to a cell. * - * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to bind value to - * @param mixed $value Value to bind in cell + * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to bind value to + * @param mixed $value Value to bind in cell * * @return bool */ @@ -58,9 +58,9 @@ class DefaultValueBinder implements IValueBinder /** * DataType for value. * - * @param mixed $pValue + * @param mixed $pValue * - * @return string + * @return string */ public static function dataTypeForValue($pValue = null) { diff --git a/src/PhpSpreadsheet/Cell/Hyperlink.php b/src/PhpSpreadsheet/Cell/Hyperlink.php index 1be5a818..0ec811b7 100644 --- a/src/PhpSpreadsheet/Cell/Hyperlink.php +++ b/src/PhpSpreadsheet/Cell/Hyperlink.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Cell; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -43,8 +43,8 @@ class Hyperlink /** * Create a new Hyperlink. * - * @param string $pUrl Url to link the cell to - * @param string $pTooltip Tooltip to display on the hyperlink + * @param string $pUrl Url to link the cell to + * @param string $pTooltip Tooltip to display on the hyperlink */ public function __construct($pUrl = '', $pTooltip = '') { @@ -66,7 +66,7 @@ class Hyperlink /** * Set URL. * - * @param string $value + * @param string $value * * @return Hyperlink */ @@ -90,7 +90,7 @@ class Hyperlink /** * Set tooltip. * - * @param string $value + * @param string $value * * @return Hyperlink */ @@ -114,7 +114,7 @@ class Hyperlink /** * Get hash code. * - * @return string Hash code + * @return string Hash code */ public function getHashCode() { diff --git a/src/PhpSpreadsheet/Cell/IValueBinder.php b/src/PhpSpreadsheet/Cell/IValueBinder.php index 6ea5dfbe..191eb844 100644 --- a/src/PhpSpreadsheet/Cell/IValueBinder.php +++ b/src/PhpSpreadsheet/Cell/IValueBinder.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Cell; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -29,8 +29,8 @@ interface IValueBinder /** * Bind value to a cell. * - * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to bind value to - * @param mixed $value Value to bind in cell + * @param \PhpOffice\PhpSpreadsheet\Cell $cell Cell to bind value to + * @param mixed $value Value to bind in cell * * @return bool */ diff --git a/src/PhpSpreadsheet/Chart.php b/src/PhpSpreadsheet/Chart.php index f15defc9..17530463 100644 --- a/src/PhpSpreadsheet/Chart.php +++ b/src/PhpSpreadsheet/Chart.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -205,11 +205,11 @@ class Chart /** * Set Worksheet. * - * @param Worksheet $pValue + * @param Worksheet $pValue * - * @throws Chart\Exception + * @throws Chart\Exception * - * @return Chart + * @return Chart */ public function setWorksheet(Worksheet $pValue = null) { @@ -231,9 +231,9 @@ class Chart /** * Set Title. * - * @param Chart\Title $title + * @param Chart\Title $title * - * @return Chart + * @return Chart */ public function setTitle(Chart\Title $title) { @@ -255,9 +255,9 @@ class Chart /** * Set Legend. * - * @param Chart\Legend $legend + * @param Chart\Legend $legend * - * @return Chart + * @return Chart */ public function setLegend(Chart\Legend $legend) { @@ -279,9 +279,9 @@ class Chart /** * Set X-Axis Label. * - * @param Chart\Title $label + * @param Chart\Title $label * - * @return Chart + * @return Chart */ public function setXAxisLabel(Chart\Title $label) { @@ -303,9 +303,9 @@ class Chart /** * Set Y-Axis Label. * - * @param Chart\Title $label + * @param Chart\Title $label * - * @return Chart + * @return Chart */ public function setYAxisLabel(Chart\Title $label) { @@ -429,9 +429,9 @@ class Chart /** * Set the Top Left position for the chart. * - * @param string $cell - * @param int $xOffset - * @param int $yOffset + * @param string $cell + * @param int $xOffset + * @param int $yOffset * * @return Chart */ @@ -451,7 +451,7 @@ class 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() { @@ -475,7 +475,7 @@ class Chart /** * Set the Top Left cell position for the chart. * - * @param string $cell + * @param string $cell * * @return Chart */ @@ -489,8 +489,8 @@ class Chart /** * Set the offset position within the Top Left cell for the chart. * - * @param int $xOffset - * @param int $yOffset + * @param int $xOffset + * @param int $yOffset * * @return Chart */ @@ -546,9 +546,9 @@ class Chart /** * Set the Bottom Right position of the chart. * - * @param string $cell - * @param int $xOffset - * @param int $yOffset + * @param string $cell + * @param int $xOffset + * @param int $yOffset * * @return Chart */ @@ -568,7 +568,7 @@ class 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() { @@ -599,8 +599,8 @@ class Chart /** * Set the offset position within the Bottom Right cell for the chart. * - * @param int $xOffset - * @param int $yOffset + * @param int $xOffset + * @param int $yOffset * * @return Chart */ diff --git a/src/PhpSpreadsheet/Chart/Axis.php b/src/PhpSpreadsheet/Chart/Axis.php index a253c1a2..40170957 100644 --- a/src/PhpSpreadsheet/Chart/Axis.php +++ b/src/PhpSpreadsheet/Chart/Axis.php @@ -13,7 +13,7 @@ class Axis extends Properties /** * Axis Number. * - * @var array of mixed + * @var array of mixed */ private $axisNumber = [ 'format' => self::FORMAT_CODE_GENERAL, @@ -23,7 +23,7 @@ class Axis extends Properties /** * Axis Options. * - * @var array of mixed + * @var array of mixed */ private $axisOptions = [ 'minimum' => null, @@ -41,7 +41,7 @@ class Axis extends Properties /** * Fill Properties. * - * @var array of mixed + * @var array of mixed */ private $fillProperties = [ 'type' => self::EXCEL_COLOR_TYPE_ARGB, @@ -52,7 +52,7 @@ class Axis extends Properties /** * Line Properties. * - * @var array of mixed + * @var array of mixed */ private $lineProperties = [ 'type' => self::EXCEL_COLOR_TYPE_ARGB, @@ -63,7 +63,7 @@ class Axis extends Properties /** * Line Style Properties. * - * @var array of mixed + * @var array of mixed */ private $lineStyleProperties = [ 'width' => '9525', @@ -86,7 +86,7 @@ class Axis extends Properties /** * Shadow Properties. * - * @var array of mixed + * @var array of mixed */ private $shadowProperties = [ 'presets' => self::SHADOW_PRESETS_NOSHADOW, @@ -111,7 +111,7 @@ class Axis extends Properties /** * Glow Properties. * - * @var array of mixed + * @var array of mixed */ private $glowProperties = [ 'size' => null, @@ -125,7 +125,7 @@ class Axis extends Properties /** * Soft Edge Properties. * - * @var array of mixed + * @var array of mixed */ private $softEdges = [ 'size' => null, @@ -136,7 +136,7 @@ class Axis extends Properties * * @param mixed $format_code * - * @return string + * @return string */ public function setAxisNumberProperties($format_code) { @@ -147,7 +147,7 @@ class Axis extends Properties /** * Get Axis Number Format Data Type. * - * @return string + * @return string */ public function getAxisNumberFormat() { @@ -157,7 +157,7 @@ class Axis extends Properties /** * Get Axis Number Source Linked. * - * @return string + * @return string */ public function getAxisNumberSourceLinked() { diff --git a/src/PhpSpreadsheet/Chart/DataSeries.php b/src/PhpSpreadsheet/Chart/DataSeries.php index e7246e5a..6dc90760 100644 --- a/src/PhpSpreadsheet/Chart/DataSeries.php +++ b/src/PhpSpreadsheet/Chart/DataSeries.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Chart; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * diff --git a/src/PhpSpreadsheet/Chart/DataSeriesValues.php b/src/PhpSpreadsheet/Chart/DataSeriesValues.php index 831cbd9c..b752c3c2 100644 --- a/src/PhpSpreadsheet/Chart/DataSeriesValues.php +++ b/src/PhpSpreadsheet/Chart/DataSeriesValues.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Chart; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -37,42 +37,42 @@ class DataSeriesValues /** * Series Data Type. * - * @var string + * @var string */ private $dataType; /** * Series Data Source. * - * @var string + * @var string */ private $dataSource; /** * Format Code. * - * @var string + * @var string */ private $formatCode; /** * Series Point Marker. * - * @var string + * @var string */ private $pointMarker; /** * Point Count (The number of datapoints in the dataseries). * - * @var int + * @var int */ private $pointCount = 0; /** * Data Values. * - * @var array of mixed + * @var array of mixed */ private $dataValues = []; @@ -99,7 +99,7 @@ class DataSeriesValues /** * Get Series Data Type. * - * @return string + * @return string */ public function getDataType() { @@ -109,16 +109,16 @@ class DataSeriesValues /** * Set Series Data Type. * - * @param string $dataType Datatype of this data series + * @param string $dataType Datatype of this data series * Typical values are: * \PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::DATASERIES_TYPE_STRING * Normally used for axis point values * \PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::DATASERIES_TYPE_NUMBER * Normally used for chart data values * - * @throws Exception + * @throws Exception * - * @return DataSeriesValues + * @return DataSeriesValues */ public function setDataType($dataType = self::DATASERIES_TYPE_NUMBER) { @@ -133,7 +133,7 @@ class DataSeriesValues /** * Get Series Data Source (formula). * - * @return string + * @return string */ public function getDataSource() { @@ -143,10 +143,10 @@ class DataSeriesValues /** * Set Series Data Source (formula). * - * @param string $dataSource + * @param string $dataSource * @param mixed $refreshDataValues * - * @return DataSeriesValues + * @return DataSeriesValues */ public function setDataSource($dataSource = null, $refreshDataValues = true) { @@ -172,9 +172,9 @@ class DataSeriesValues /** * Set Point Marker. * - * @param string $marker + * @param string $marker * - * @return DataSeriesValues + * @return DataSeriesValues */ public function setPointMarker($marker = null) { @@ -186,7 +186,7 @@ class DataSeriesValues /** * Get Series Format Code. * - * @return string + * @return string */ public function getFormatCode() { @@ -196,9 +196,9 @@ class DataSeriesValues /** * Set Series Format Code. * - * @param string $formatCode + * @param string $formatCode * - * @return DataSeriesValues + * @return DataSeriesValues */ public function setFormatCode($formatCode = null) { @@ -210,7 +210,7 @@ class DataSeriesValues /** * Get Series Point Count. * - * @return int + * @return int */ public function getPointCount() { @@ -220,7 +220,7 @@ class DataSeriesValues /** * Identify if the Data Series is a multi-level or a simple series. * - * @return bool|null + * @return bool|null */ public function isMultiLevelSeries() { @@ -234,7 +234,7 @@ class DataSeriesValues /** * Return the level count of a multi-level Data Series. * - * @return int + * @return int */ public function multiLevelCount() { @@ -249,7 +249,7 @@ class DataSeriesValues /** * Get Series Data Values. * - * @return array of mixed + * @return array of mixed */ public function getDataValues() { @@ -259,7 +259,7 @@ class DataSeriesValues /** * Get the first Series Data value. * - * @return mixed + * @return mixed */ public function getDataValue() { @@ -276,12 +276,12 @@ class DataSeriesValues /** * Set Series Data Values. * - * @param array $dataValues - * @param bool $refreshDataSource + * @param array $dataValues + * @param bool $refreshDataSource * TRUE - refresh the value of dataSource based on the values of $dataValues * FALSE - don't change the value of dataSource * - * @return DataSeriesValues + * @return DataSeriesValues */ public function setDataValues($dataValues = [], $refreshDataSource = true) { diff --git a/src/PhpSpreadsheet/Chart/Exception.php b/src/PhpSpreadsheet/Chart/Exception.php index 8342a8c9..57562b73 100644 --- a/src/PhpSpreadsheet/Chart/Exception.php +++ b/src/PhpSpreadsheet/Chart/Exception.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Chart; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * diff --git a/src/PhpSpreadsheet/Chart/GridLines.php b/src/PhpSpreadsheet/Chart/GridLines.php index 875f1911..63bbf4dd 100644 --- a/src/PhpSpreadsheet/Chart/GridLines.php +++ b/src/PhpSpreadsheet/Chart/GridLines.php @@ -177,7 +177,7 @@ class GridLines extends Properties /** * Get Line Style Property. * - * @param array|string $elements + * @param array|string $elements * * @return string */ @@ -189,10 +189,10 @@ class GridLines extends Properties /** * Set Glow Properties. * - * @param float $size - * @param string $color_value - * @param int $color_alpha - * @param string $color_type + * @param float $size + * @param string $color_value + * @param int $color_alpha + * @param string $color_type */ public function setGlowProperties($size, $color_value = null, $color_alpha = null, $color_type = null) { diff --git a/src/PhpSpreadsheet/Chart/Layout.php b/src/PhpSpreadsheet/Chart/Layout.php index 1080feda..98e5e6f6 100644 --- a/src/PhpSpreadsheet/Chart/Layout.php +++ b/src/PhpSpreadsheet/Chart/Layout.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Chart; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -343,7 +343,7 @@ class Layout * Set show legend key * Specifies that legend keys should be shown in data labels. * - * @param bool $value Show legend key + * @param bool $value Show legend key * * @return Layout */ @@ -368,7 +368,7 @@ class Layout * Set show val * Specifies that the value should be shown in data labels. * - * @param bool $value Show val + * @param bool $value Show val * * @return Layout */ @@ -393,7 +393,7 @@ class Layout * Set show cat name * 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 */ @@ -418,7 +418,7 @@ class Layout * Set show ser name * 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 */ @@ -443,7 +443,7 @@ class Layout * Set show percentage * Specifies that the percentage should be shown in data labels. * - * @param bool $value Show percentage + * @param bool $value Show percentage * * @return Layout */ @@ -468,7 +468,7 @@ class Layout * Set show bubble size * 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 */ @@ -493,7 +493,7 @@ class Layout * Set show leader lines * Specifies that leader lines should be shown in data labels. * - * @param bool $value Show leader lines + * @param bool $value Show leader lines * * @return Layout */ diff --git a/src/PhpSpreadsheet/Chart/Legend.php b/src/PhpSpreadsheet/Chart/Legend.php index 786a47fe..c472cd8f 100644 --- a/src/PhpSpreadsheet/Chart/Legend.php +++ b/src/PhpSpreadsheet/Chart/Legend.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Chart; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -52,26 +52,26 @@ class Legend /** * Legend position. * - * @var string + * @var string */ private $position = self::POSITION_RIGHT; /** * Allow overlay of other elements? * - * @var bool + * @var bool */ private $overlay = true; /** * Legend Layout. * - * @var Layout + * @var Layout */ private $layout = null; /** - * Create a new Legend. + * Create a new Legend. * * @param mixed $position * @param mixed $overlay @@ -86,7 +86,7 @@ class Legend /** * Get legend position as an excel string value. * - * @return string + * @return string */ public function getPosition() { @@ -96,7 +96,7 @@ class Legend /** * Get legend position using an excel string value. * - * @param string $position + * @param string $position */ public function setPosition($position = self::POSITION_RIGHT) { @@ -112,7 +112,7 @@ class Legend /** * Get legend position as an Excel internal numeric value. * - * @return number + * @return number */ public function getPositionXL() { @@ -122,7 +122,7 @@ class Legend /** * Set legend position using an Excel internal numeric value. * - * @param number $positionXL + * @param number $positionXL */ public function setPositionXL($positionXL = self::XL_LEGEND_POSITION_RIGHT) { @@ -138,7 +138,7 @@ class Legend /** * Get allow overlay of other elements? * - * @return bool + * @return bool */ public function getOverlay() { @@ -148,9 +148,9 @@ class Legend /** * Set allow overlay of other elements? * - * @param bool $overlay + * @param bool $overlay * - * @return bool + * @return bool */ public function setOverlay($overlay = false) { diff --git a/src/PhpSpreadsheet/Chart/PlotArea.php b/src/PhpSpreadsheet/Chart/PlotArea.php index 1aed6bcd..afcced96 100644 --- a/src/PhpSpreadsheet/Chart/PlotArea.php +++ b/src/PhpSpreadsheet/Chart/PlotArea.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Chart; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -111,7 +111,7 @@ class PlotArea /** * Set Plot Series. * - * @param DataSeries[] + * @param DataSeries[] * @param mixed $plotSeries * * @return PlotArea diff --git a/src/PhpSpreadsheet/Chart/Renderer/JpGraph.php b/src/PhpSpreadsheet/Chart/Renderer/JpGraph.php index ec6e06b5..834d06d8 100644 --- a/src/PhpSpreadsheet/Chart/Renderer/JpGraph.php +++ b/src/PhpSpreadsheet/Chart/Renderer/JpGraph.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Chart\Renderer; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * diff --git a/src/PhpSpreadsheet/Chart/Title.php b/src/PhpSpreadsheet/Chart/Title.php index ba63fe02..753e63e8 100644 --- a/src/PhpSpreadsheet/Chart/Title.php +++ b/src/PhpSpreadsheet/Chart/Title.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Chart; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * diff --git a/src/PhpSpreadsheet/Comment.php b/src/PhpSpreadsheet/Comment.php index 4871d454..f04f3ce6 100644 --- a/src/PhpSpreadsheet/Comment.php +++ b/src/PhpSpreadsheet/Comment.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -308,7 +308,7 @@ class Comment implements IComparable /** * Get hash code. * - * @return string Hash code + * @return string Hash code */ public function getHashCode() { diff --git a/src/PhpSpreadsheet/Document/Properties.php b/src/PhpSpreadsheet/Document/Properties.php index edd51c93..d0705dc8 100644 --- a/src/PhpSpreadsheet/Document/Properties.php +++ b/src/PhpSpreadsheet/Document/Properties.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Document; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * diff --git a/src/PhpSpreadsheet/Document/Security.php b/src/PhpSpreadsheet/Document/Security.php index 86ce6cd7..380f7265 100644 --- a/src/PhpSpreadsheet/Document/Security.php +++ b/src/PhpSpreadsheet/Document/Security.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Document; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -165,8 +165,8 @@ class Security /** * Set RevisionsPassword. * - * @param string $pValue - * @param bool $pAlreadyHashed If the password has already been hashed, set this to true + * @param string $pValue + * @param bool $pAlreadyHashed If the password has already been hashed, set this to true * * @return Security */ @@ -193,8 +193,8 @@ class Security /** * Set WorkbookPassword. * - * @param string $pValue - * @param bool $pAlreadyHashed If the password has already been hashed, set this to true + * @param string $pValue + * @param bool $pAlreadyHashed If the password has already been hashed, set this to true * * @return Security */ diff --git a/src/PhpSpreadsheet/Exception.php b/src/PhpSpreadsheet/Exception.php index 4ec48986..1adcb1bf 100644 --- a/src/PhpSpreadsheet/Exception.php +++ b/src/PhpSpreadsheet/Exception.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * diff --git a/src/PhpSpreadsheet/HashTable.php b/src/PhpSpreadsheet/HashTable.php index f7a7b0a4..fededf17 100644 --- a/src/PhpSpreadsheet/HashTable.php +++ b/src/PhpSpreadsheet/HashTable.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -43,9 +43,9 @@ class 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) { @@ -58,9 +58,9 @@ class HashTable /** * 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) { @@ -79,9 +79,9 @@ class HashTable /** * 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) { @@ -95,9 +95,9 @@ class HashTable /** * 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) { @@ -141,9 +141,9 @@ class HashTable /** * Get index for hash code. * - * @param string $pHashCode + * @param string $pHashCode * - * @return int Index + * @return int Index */ public function getIndexForHashCode($pHashCode = '') { @@ -153,9 +153,9 @@ class HashTable /** * Get by index. * - * @param int $pIndex + * @param int $pIndex * - * @return IComparable + * @return IComparable */ public function getByIndex($pIndex = 0) { @@ -169,9 +169,9 @@ class HashTable /** * Get by hashcode. * - * @param string $pHashCode + * @param string $pHashCode * - * @return IComparable + * @return IComparable */ public function getByHashCode($pHashCode = '') { diff --git a/src/PhpSpreadsheet/Helper/Html.php b/src/PhpSpreadsheet/Helper/Html.php index 7c5df34d..67b3c481 100644 --- a/src/PhpSpreadsheet/Helper/Html.php +++ b/src/PhpSpreadsheet/Helper/Html.php @@ -17,12 +17,12 @@ use DOMText; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * diff --git a/src/PhpSpreadsheet/IComparable.php b/src/PhpSpreadsheet/IComparable.php index edefe868..2b8cabba 100644 --- a/src/PhpSpreadsheet/IComparable.php +++ b/src/PhpSpreadsheet/IComparable.php @@ -10,12 +10,12 @@ namespace PhpOffice\PhpSpreadsheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -27,7 +27,7 @@ interface IComparable /** * Get hash code. * - * @return string Hash code + * @return string Hash code */ public function getHashCode(); } diff --git a/src/PhpSpreadsheet/IOFactory.php b/src/PhpSpreadsheet/IOFactory.php index 650daa7e..949cc87d 100644 --- a/src/PhpSpreadsheet/IOFactory.php +++ b/src/PhpSpreadsheet/IOFactory.php @@ -14,12 +14,12 @@ use PhpOffice\PhpSpreadsheet\Shared\File; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -31,7 +31,7 @@ class IOFactory /** * Search locations. * - * @var array + * @var array * @static */ private static $searchLocations = [ @@ -42,7 +42,7 @@ class IOFactory /** * Autoresolve classes. * - * @var array + * @var array * @static */ private static $autoResolveClasses = [ @@ -57,7 +57,7 @@ class IOFactory ]; /** - * Private constructor for IOFactory. + * Private constructor for IOFactory. */ private function __construct() { @@ -68,7 +68,7 @@ class IOFactory * * @static * - * @return array + * @return array */ public static function getSearchLocations() { @@ -80,9 +80,9 @@ class IOFactory * * @static * - * @param array $value + * @param array $value * - * @throws Reader\Exception + * @throws Reader\Exception */ public static function setSearchLocations($value) { @@ -98,9 +98,9 @@ class IOFactory * * @static * - * @param string $type Example: IWriter - * @param string $location Example: PhpSpreadsheet/Writer/{0}.php - * @param string $classname Example: Writer\{0} + * @param string $type Example: IWriter + * @param string $location Example: PhpSpreadsheet/Writer/{0}.php + * @param string $classname Example: Writer\{0} */ public static function addSearchLocation($type = '', $location = '', $classname = '') { @@ -112,12 +112,12 @@ class IOFactory * * @static * - * @param Spreadsheet $spreadsheet - * @param string $writerType Example: Xlsx + * @param Spreadsheet $spreadsheet + * @param string $writerType Example: Xlsx * - * @throws Writer\Exception + * @throws Writer\Exception * - * @return Writer\IWriter + * @return Writer\IWriter */ public static function createWriter(Spreadsheet $spreadsheet, $writerType) { @@ -145,11 +145,11 @@ class IOFactory * * @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 = '') { @@ -177,11 +177,11 @@ class IOFactory * * @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) { @@ -195,11 +195,11 @@ class IOFactory * * @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) { @@ -216,11 +216,11 @@ class IOFactory * * @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) { diff --git a/src/PhpSpreadsheet/NamedRange.php b/src/PhpSpreadsheet/NamedRange.php index 607ddc9b..fffe7ee9 100644 --- a/src/PhpSpreadsheet/NamedRange.php +++ b/src/PhpSpreadsheet/NamedRange.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -68,7 +68,7 @@ class NamedRange * @param Worksheet $pWorksheet * @param string $pRange * @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 */ diff --git a/src/PhpSpreadsheet/Reader/BaseReader.php b/src/PhpSpreadsheet/Reader/BaseReader.php index 587cc1e0..dd8d0769 100644 --- a/src/PhpSpreadsheet/Reader/BaseReader.php +++ b/src/PhpSpreadsheet/Reader/BaseReader.php @@ -14,12 +14,12 @@ use PhpOffice\PhpSpreadsheet\Shared\File; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -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; * or whether it should read both data and formatting. * - * @var bool + * @var bool */ 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 * null value or empty string. * - * @var bool + * @var bool */ protected $readEmptyCells = true; @@ -50,7 +50,7 @@ abstract class BaseReader implements IReader * Read charts that are defined 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; @@ -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 false (the default) it will read data and formatting. * - * @return bool + * @return bool */ 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 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) { @@ -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 false it will not read data for cells containing a null value or an empty string. * - * @return bool + * @return bool */ 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 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) { @@ -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. * If false (the default) it will ignore any charts defined in the workbook file. * - * @return bool + * @return bool */ 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. * Set to false (the default) to discard charts. * - * @param bool $pValue + * @param bool $pValue * - * @return IReader + * @return IReader */ public function setIncludeCharts($pValue = false) { @@ -231,7 +231,7 @@ abstract class BaseReader implements IReader * * @param string $pFilename * - * @throws Exception + * @throws Exception * * @return resource */ @@ -249,7 +249,7 @@ abstract class BaseReader implements IReader /** * Scan theXML for use of 'January', @@ -54,7 +54,7 @@ class Date /* * @public - * @var string[] + * @var string[] */ public static $numberSuffixes = [ 'st', @@ -68,7 +68,7 @@ class Date * Value is either CALENDAR_WINDOWS_1900 (1900) or CALENDAR_MAC_1904 (1904) * * @private - * @var int + * @var int */ protected static $excelCalendar = self::CALENDAR_WINDOWS_1900; @@ -76,16 +76,16 @@ class Date * Default timezone to use for DateTime objects * * @private - * @var null|\DateTimeZone + * @var null|\DateTimeZone */ protected static $defaultTimeZone; /** * 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) { @@ -102,7 +102,7 @@ class Date /** * 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() { @@ -112,12 +112,12 @@ class Date /** * 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) { @@ -133,7 +133,7 @@ class Date /** * 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() { @@ -147,12 +147,12 @@ class Date /** * 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) { @@ -167,14 +167,14 @@ class Date /** * 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 \DateTimeZone|string|null $timeZone The timezone to assume for the Excel timestamp, + * @param int|float $excelTimestamp MS Excel serialized date/time value + * @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 * 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) { @@ -208,14 +208,14 @@ class Date /** * Convert a MS serialized datetime value from Excel to a unix timestamp. * - * @param int|float $excelTimestamp MS Excel serialized date/time value - * @param \DateTimeZone|string|null $timeZone The timezone to assume for the Excel timestamp, + * @param int|float $excelTimestamp MS Excel serialized date/time value + * @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 * 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) { @@ -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 */ 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) { @@ -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) { @@ -282,14 +282,14 @@ class Date /** * formattedPHPToExcel. * - * @param int $year - * @param int $month - * @param int $day - * @param int $hours - * @param int $minutes - * @param int $seconds + * @param int $year + * @param int $month + * @param int $day + * @param int $hours + * @param int $minutes + * @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) { @@ -329,9 +329,9 @@ class Date /** * 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) { @@ -345,9 +345,9 @@ class Date /** * 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) { @@ -359,9 +359,9 @@ class Date /** * Is a given number format code a date/time? * - * @param string $pFormatCode + * @param string $pFormatCode * - * @return bool + * @return bool */ public static function isDateTimeFormatCode($pFormatCode = '') { @@ -433,9 +433,9 @@ class Date /** * 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 = '') { @@ -466,9 +466,9 @@ class Date /** * 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) { @@ -486,9 +486,9 @@ class Date /** * 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) { diff --git a/src/PhpSpreadsheet/Shared/Drawing.php b/src/PhpSpreadsheet/Shared/Drawing.php index 9b347622..969d9bf8 100644 --- a/src/PhpSpreadsheet/Shared/Drawing.php +++ b/src/PhpSpreadsheet/Shared/Drawing.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -29,9 +29,9 @@ class Drawing /** * 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) { @@ -41,9 +41,9 @@ class Drawing /** * 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) { @@ -59,10 +59,10 @@ class Drawing * 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. * - * @param int $pValue Value in pixels - * @param \PhpOffice\PhpSpreadsheet\Style\Font $pDefaultFont Default font of the workbook + * @param int $pValue Value in pixels + * @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) { @@ -85,10 +85,10 @@ class Drawing /** * Convert column width from (intrinsic) Excel units to pixels. * - * @param float $pValue Value in cell dimension - * @param \PhpOffice\PhpSpreadsheet\Style\Font $pDefaultFont Default font of the workbook + * @param float $pValue Value in cell dimension + * @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) { @@ -114,9 +114,9 @@ class Drawing /** * 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) { @@ -126,9 +126,9 @@ class Drawing /** * 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) { @@ -142,9 +142,9 @@ class Drawing /** * Convert degrees to angle. * - * @param int $pValue Degrees + * @param int $pValue Degrees * - * @return int Angle + * @return int Angle */ public static function degreesToAngle($pValue = 0) { @@ -154,9 +154,9 @@ class Drawing /** * Convert angle to degrees. * - * @param int $pValue Angle + * @param int $pValue Angle * - * @return int Degrees + * @return int Degrees */ public static function angleToDegrees($pValue = 0) { diff --git a/src/PhpSpreadsheet/Shared/Escher.php b/src/PhpSpreadsheet/Shared/Escher.php index 1172fd7e..ffd051bd 100644 --- a/src/PhpSpreadsheet/Shared/Escher.php +++ b/src/PhpSpreadsheet/Shared/Escher.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * diff --git a/src/PhpSpreadsheet/Shared/Escher/DgContainer.php b/src/PhpSpreadsheet/Shared/Escher/DgContainer.php index 5572c940..8e0201f3 100644 --- a/src/PhpSpreadsheet/Shared/Escher/DgContainer.php +++ b/src/PhpSpreadsheet/Shared/Escher/DgContainer.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared\Escher; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * diff --git a/src/PhpSpreadsheet/Shared/Escher/DgContainer/SpgrContainer.php b/src/PhpSpreadsheet/Shared/Escher/DgContainer/SpgrContainer.php index f32565d3..33dd29ea 100644 --- a/src/PhpSpreadsheet/Shared/Escher/DgContainer/SpgrContainer.php +++ b/src/PhpSpreadsheet/Shared/Escher/DgContainer/SpgrContainer.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared\Escher\DgContainer; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * diff --git a/src/PhpSpreadsheet/Shared/Escher/DgContainer/SpgrContainer/SpContainer.php b/src/PhpSpreadsheet/Shared/Escher/DgContainer/SpgrContainer/SpContainer.php index a00dfe2c..a1eac1df 100644 --- a/src/PhpSpreadsheet/Shared/Escher/DgContainer/SpgrContainer/SpContainer.php +++ b/src/PhpSpreadsheet/Shared/Escher/DgContainer/SpgrContainer/SpContainer.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared\Escher\DgContainer\SpgrContainer; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * diff --git a/src/PhpSpreadsheet/Shared/Escher/DggContainer.php b/src/PhpSpreadsheet/Shared/Escher/DggContainer.php index f0e8b287..bdaf6fdd 100644 --- a/src/PhpSpreadsheet/Shared/Escher/DggContainer.php +++ b/src/PhpSpreadsheet/Shared/Escher/DggContainer.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared\Escher; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * diff --git a/src/PhpSpreadsheet/Shared/Escher/DggContainer/BstoreContainer.php b/src/PhpSpreadsheet/Shared/Escher/DggContainer/BstoreContainer.php index 0e3f07a5..9d7be0f0 100644 --- a/src/PhpSpreadsheet/Shared/Escher/DggContainer/BstoreContainer.php +++ b/src/PhpSpreadsheet/Shared/Escher/DggContainer/BstoreContainer.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * diff --git a/src/PhpSpreadsheet/Shared/Escher/DggContainer/BstoreContainer/BSE.php b/src/PhpSpreadsheet/Shared/Escher/DggContainer/BstoreContainer/BSE.php index d236ef53..9d37507b 100644 --- a/src/PhpSpreadsheet/Shared/Escher/DggContainer/BstoreContainer/BSE.php +++ b/src/PhpSpreadsheet/Shared/Escher/DggContainer/BstoreContainer/BSE.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * diff --git a/src/PhpSpreadsheet/Shared/Escher/DggContainer/BstoreContainer/BSE/Blip.php b/src/PhpSpreadsheet/Shared/Escher/DggContainer/BstoreContainer/BSE/Blip.php index 9884ea70..e3ca3719 100644 --- a/src/PhpSpreadsheet/Shared/Escher/DggContainer/BstoreContainer/BSE/Blip.php +++ b/src/PhpSpreadsheet/Shared/Escher/DggContainer/BstoreContainer/BSE/Blip.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared\Escher\DggContainer\BstoreContainer\BS * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * diff --git a/src/PhpSpreadsheet/Shared/File.php b/src/PhpSpreadsheet/Shared/File.php index b4c96f17..e536fd12 100644 --- a/src/PhpSpreadsheet/Shared/File.php +++ b/src/PhpSpreadsheet/Shared/File.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -30,7 +30,7 @@ class File * Use Temp or File Upload Temp for temporary files * * @protected - * @var boolean + * @var boolean */ 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. * - * @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) { @@ -48,7 +48,7 @@ class File /** * 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() { @@ -58,7 +58,7 @@ class File /** * Verify if a file exists. * - * @param string $pFilename Filename + * @param string $pFilename Filename * * @return bool */ diff --git a/src/PhpSpreadsheet/Shared/Font.php b/src/PhpSpreadsheet/Shared/Font.php index ea31b817..dbef7701 100644 --- a/src/PhpSpreadsheet/Shared/Font.php +++ b/src/PhpSpreadsheet/Shared/Font.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -184,7 +184,7 @@ class Font * * @param string $pValue * - * @return bool Success or failure + * @return bool Success or failure */ public static function setAutoSizeMethod($pValue = self::AUTOSIZE_METHOD_APPROX) { @@ -213,7 +213,7 @@ class Font *
  • C:/Windows/Fonts/
    • *
  • /usr/share/fonts/truetype/
    • *
  • ~/.fonts/
    • - * . + * . * * @param string $pValue */ @@ -235,12 +235,12 @@ class Font /** * Calculate an (approximate) OpenXML column width, based on font size and text contained. * - * @param \PhpOffice\PhpSpreadsheet\Style\Font $font Font object - * @param \PhpOffice\PhpSpreadsheet\RichText|string $cellText Text to calculate width - * @param int $rotation Rotation angle - * @param \PhpOffice\PhpSpreadsheet\Style\Font|null $defaultFont Font object + * @param \PhpOffice\PhpSpreadsheet\Style\Font $font Font object + * @param \PhpOffice\PhpSpreadsheet\RichText|string $cellText Text to calculate width + * @param int $rotation Rotation angle + * @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) { @@ -378,9 +378,9 @@ class Font /** * 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) { @@ -390,9 +390,9 @@ class Font /** * 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) { @@ -402,9 +402,9 @@ class Font /** * 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) { diff --git a/src/PhpSpreadsheet/Shared/JAMA/CholeskyDecomposition.php b/src/PhpSpreadsheet/Shared/JAMA/CholeskyDecomposition.php index 0fda6144..79b96566 100644 --- a/src/PhpSpreadsheet/Shared/JAMA/CholeskyDecomposition.php +++ b/src/PhpSpreadsheet/Shared/JAMA/CholeskyDecomposition.php @@ -20,32 +20,32 @@ namespace PhpOffice\PhpSpreadsheet\Shared\JAMA; class CholeskyDecomposition { /** - * Decomposition storage. + * Decomposition storage. * - * @var array + * @var array */ private $L = []; /** - * Matrix row and column dimension. + * Matrix row and column dimension. * - * @var int + * @var int */ private $m; /** - * Symmetric positive definite flag. + * Symmetric positive definite flag. * - * @var bool + * @var bool */ private $isspd = true; /** - * CholeskyDecomposition. + * CholeskyDecomposition. * * 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 */ public function __construct($A = null) @@ -86,7 +86,7 @@ class CholeskyDecomposition /** * Is the matrix symmetric and positive definite? * - * @return bool + * @return bool */ public function isSPD() { @@ -96,11 +96,11 @@ class CholeskyDecomposition // function isSPD() /** - * getL. + * getL. * - * Return triangular factor. + * Return triangular factor. * - * @return Matrix Lower triangular matrix + * @return Matrix Lower triangular matrix */ public function getL() { @@ -110,11 +110,11 @@ class CholeskyDecomposition // 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) { diff --git a/src/PhpSpreadsheet/Shared/JAMA/EigenvalueDecomposition.php b/src/PhpSpreadsheet/Shared/JAMA/EigenvalueDecomposition.php index bbbd3797..094ded83 100644 --- a/src/PhpSpreadsheet/Shared/JAMA/EigenvalueDecomposition.php +++ b/src/PhpSpreadsheet/Shared/JAMA/EigenvalueDecomposition.php @@ -26,58 +26,58 @@ namespace PhpOffice\PhpSpreadsheet\Shared\JAMA; class EigenvalueDecomposition { /** - * Row and column dimension (square matrix). + * Row and column dimension (square matrix). * - * @var int + * @var int */ private $n; /** - * Internal symmetry flag. + * Internal symmetry flag. * - * @var int + * @var int */ private $issymmetric; /** - * Arrays for internal storage of eigenvalues. + * Arrays for internal storage of eigenvalues. * - * @var array + * @var array */ private $d = []; private $e = []; /** - * Array for internal storage of eigenvectors. + * Array for internal storage of eigenvectors. * - * @var array + * @var array */ private $V = []; /** - * Array for internal storage of nonsymmetric Hessenberg form. + * Array for internal storage of nonsymmetric Hessenberg form. * - * @var array + * @var array */ private $H = []; /** - * Working storage for nonsymmetric algorithm. + * Working storage for nonsymmetric algorithm. * - * @var array + * @var array */ private $ort; /** - * Used for complex scalar division. + * Used for complex scalar division. * - * @var float + * @var float */ private $cdivr; private $cdivi; /** - * Symmetric Householder reduction to tridiagonal form. + * Symmetric Householder reduction to tridiagonal form. */ 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 * Bowdler, Martin, Reinsch, and Wilkinson, Handbook for * Auto. Comp., Vol.ii-Linear Algebra, and the corresponding - * Fortran subroutine in EISPACK. + * Fortran subroutine in EISPACK. */ 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, * by Martin and Wilkinson, Handbook for Auto. Comp., * Vol.ii-Linear Algebra, and the corresponding - * Fortran subroutines in EISPACK. + * Fortran subroutines in EISPACK. */ private function orthes() { @@ -371,7 +371,7 @@ class EigenvalueDecomposition } /** - * Performs complex division. + * Performs complex division. * * @param mixed $xr * @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, * by Martin and Wilkinson, Handbook for Auto. Comp., * Vol.ii-Linear Algebra, and the corresponding - * Fortran subroutine in EISPACK. + * Fortran subroutine in EISPACK. */ private function hqr2() { @@ -781,12 +781,12 @@ class EigenvalueDecomposition // 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 * - * @return Structure to access D and V + * @return Structure to access D and V */ 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() { @@ -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() { @@ -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() { @@ -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() { diff --git a/src/PhpSpreadsheet/Shared/JAMA/LUDecomposition.php b/src/PhpSpreadsheet/Shared/JAMA/LUDecomposition.php index 996fe317..bf4b1636 100644 --- a/src/PhpSpreadsheet/Shared/JAMA/LUDecomposition.php +++ b/src/PhpSpreadsheet/Shared/JAMA/LUDecomposition.php @@ -27,46 +27,46 @@ class LUDecomposition const MATRIX_SQUARE_EXCEPTION = 'Mismatched Row dimension'; /** - * Decomposition storage. + * Decomposition storage. * - * @var array + * @var array */ private $LU = []; /** - * Row dimension. + * Row dimension. * - * @var int + * @var int */ private $m; /** - * Column dimension. + * Column dimension. * - * @var int + * @var int */ private $n; /** - * Pivot sign. + * Pivot sign. * - * @var int + * @var int */ private $pivsign; /** - * Internal storage of pivot vector. + * Internal storage of pivot vector. * - * @var array + * @var array */ private $piv = []; /** - * LU Decomposition constructor. + * LU Decomposition constructor. * - * @param Matrix $A Rectangular matrix + * @param Matrix $A Rectangular matrix * - * @return Structure to access L, U and piv + * @return Structure to access L, U and piv */ public function __construct($A) { @@ -131,9 +131,9 @@ class LUDecomposition // function __construct() /** - * Get lower triangular factor. + * Get lower triangular factor. * - * @return Matrix Lower triangular factor + * @return Matrix Lower triangular factor */ public function getL() { @@ -155,9 +155,9 @@ class LUDecomposition // function getL() /** - * Get upper triangular factor. + * Get upper triangular factor. * - * @return Matrix Upper triangular factor + * @return Matrix Upper triangular factor */ public function getU() { @@ -177,9 +177,9 @@ class LUDecomposition // function getU() /** - * Return pivot permutation vector. + * Return pivot permutation vector. * - * @return array Pivot vector + * @return array Pivot vector */ public function getPivot() { @@ -189,7 +189,7 @@ class LUDecomposition // function getPivot() /** - * Alias for getPivot. + * Alias for getPivot. * * @see getPivot */ @@ -203,7 +203,7 @@ class LUDecomposition /** * Is the matrix nonsingular? * - * @return bool true if U, and hence A, is nonsingular + * @return bool true if U, and hence A, is nonsingular */ public function isNonsingular() { @@ -219,9 +219,9 @@ class LUDecomposition // function isNonsingular() /** - * Count determinants. + * Count determinants. * - * @return array d matrix deterninat + * @return array d matrix deterninat */ public function det() { @@ -239,14 +239,14 @@ class LUDecomposition // function det() /** - * Solve A*X = B. + * Solve A*X = B. * - * @param $B a Matrix with as many rows as A and any number of columns + * @param $B a Matrix with as many rows as A and any number of columns * - * @throws \PhpOffice\PhpSpreadsheet\Calculation\Exception illegalArgumentException Matrix row dimensions must agree - * @throws \PhpOffice\PhpSpreadsheet\Calculation\Exception runtimeException Matrix is singular + * @throws \PhpOffice\PhpSpreadsheet\Calculation\Exception illegalArgumentException Matrix row dimensions must agree + * @throws \PhpOffice\PhpSpreadsheet\Calculation\Exception runtimeException Matrix is singular * - * @return X so that L*U*X = B(piv,:) + * @return X so that L*U*X = B(piv,:) */ public function solve($B) { diff --git a/src/PhpSpreadsheet/Shared/JAMA/Matrix.php b/src/PhpSpreadsheet/Shared/JAMA/Matrix.php index 44eca3ea..436abdfb 100644 --- a/src/PhpSpreadsheet/Shared/JAMA/Matrix.php +++ b/src/PhpSpreadsheet/Shared/JAMA/Matrix.php @@ -22,30 +22,30 @@ class Matrix const ARRAY_LENGTH_EXCEPTION = 'Array length must be a multiple of m.'; /** - * Matrix storage. + * Matrix storage. * - * @var array + * @var array */ public $A = []; /** - * Matrix row dimension. + * Matrix row dimension. * - * @var int + * @var int */ private $m; /** - * Matrix column dimension. + * Matrix column dimension. * - * @var int + * @var int */ private $n; /** - * Polymorphic constructor. + * Polymorphic constructor. * - * As PHP has no support for polymorphic constructors, we use tricks to make our own sort of polymorphism using func_num_args, func_get_arg, and gettype. In essence, we're just implementing a simple RTTI filter and calling the appropriate constructor. + * As PHP has no support for polymorphic constructors, we use tricks to make our own sort of polymorphism using func_num_args, func_get_arg, and gettype. In essence, we're just implementing a simple RTTI filter and calling the appropriate constructor. */ public function __construct() { @@ -100,9 +100,9 @@ class Matrix } /** - * getArray. + * getArray. * - * @return array Matrix array + * @return array Matrix array */ public function getArray() { @@ -110,9 +110,9 @@ class Matrix } /** - * getRowDimension. + * getRowDimension. * - * @return int Row dimension + * @return int Row dimension */ public function getRowDimension() { @@ -120,9 +120,9 @@ class Matrix } /** - * getColumnDimension. + * getColumnDimension. * - * @return int Column dimension + * @return int Column dimension */ public function getColumnDimension() { @@ -130,14 +130,14 @@ class Matrix } /** - * get. + * get. * - * Get the i,j-th element of the matrix. + * Get the i,j-th element of the matrix. * - * @param int $i Row position - * @param int $j Column position + * @param int $i Row position + * @param int $j Column position * - * @return mixed Element (int/float/double) + * @return mixed Element (int/float/double) */ public function get($i = null, $j = null) { @@ -145,16 +145,16 @@ class Matrix } /** - * getMatrix. + * getMatrix. * * Get a submatrix * - * @param int $i0 Initial row index - * @param int $iF Final row index - * @param int $j0 Initial column index - * @param int $jF Final column index + * @param int $i0 Initial row index + * @param int $iF Final row index + * @param int $j0 Initial column index + * @param int $jF Final column index * - * @return Matrix Submatrix + * @return Matrix Submatrix */ public function getMatrix() { @@ -283,13 +283,13 @@ class Matrix } /** - * checkMatrixDimensions. + * checkMatrixDimensions. * * Is matrix B the same size? * - * @param Matrix $B Matrix B + * @param Matrix $B Matrix B * - * @return bool + * @return bool */ public function checkMatrixDimensions($B = null) { @@ -305,15 +305,15 @@ class Matrix // function checkMatrixDimensions() /** - * set. + * set. * - * Set the i,j-th element of the matrix. + * Set the i,j-th element of the matrix. * - * @param int $i Row position - * @param int $j Column position - * @param mixed $c Int/float/double value + * @param int $i Row position + * @param int $j Column position + * @param mixed $c Int/float/double value * - * @return mixed Element (int/float/double) + * @return mixed Element (int/float/double) */ public function set($i = null, $j = null, $c = null) { @@ -324,14 +324,14 @@ class Matrix // function set() /** - * identity. + * identity. * - * Generate an identity matrix. + * Generate an identity matrix. * - * @param int $m Row dimension - * @param int $n Column dimension + * @param int $m Row dimension + * @param int $n Column dimension * - * @return Matrix Identity matrix + * @return Matrix Identity matrix */ public function identity($m = null, $n = null) { @@ -339,15 +339,15 @@ class Matrix } /** - * diagonal. + * diagonal. * * Generate a diagonal matrix * - * @param int $m Row dimension - * @param int $n Column dimension - * @param mixed $c Diagonal value + * @param int $m Row dimension + * @param int $n Column dimension + * @param mixed $c Diagonal value * - * @return Matrix Diagonal matrix + * @return Matrix Diagonal matrix */ public function diagonal($m = null, $n = null, $c = 1) { @@ -360,14 +360,14 @@ class Matrix } /** - * getMatrixByRow. + * getMatrixByRow. * * Get a submatrix by row index/range * - * @param int $i0 Initial row index - * @param int $iF Final row index + * @param int $i0 Initial row index + * @param int $iF Final row index * - * @return Matrix Submatrix + * @return Matrix Submatrix */ public function getMatrixByRow($i0 = null, $iF = null) { @@ -382,14 +382,14 @@ class Matrix } /** - * getMatrixByCol. + * getMatrixByCol. * * Get a submatrix by column index/range * - * @param int $j0 Initial column index - * @param int $jF Final column index + * @param int $j0 Initial column index + * @param int $jF Final column index * - * @return Matrix Submatrix + * @return Matrix Submatrix */ public function getMatrixByCol($j0 = null, $jF = null) { @@ -404,11 +404,11 @@ class Matrix } /** - * transpose. + * transpose. * * Tranpose matrix * - * @return Matrix Transposed matrix + * @return Matrix Transposed matrix */ public function transpose() { @@ -425,11 +425,11 @@ class Matrix // function transpose() /** - * trace. + * trace. * * Sum of diagonal elements * - * @return float Sum of diagonal elements + * @return float Sum of diagonal elements */ public function trace() { @@ -443,24 +443,24 @@ class Matrix } /** - * uminus. + * uminus. * * Unary minus matrix -A * - * @return Matrix Unary minus matrix + * @return Matrix Unary minus matrix */ public function uminus() { } /** - * plus. + * plus. * * A + B * - * @param mixed $B Matrix/Array + * @param mixed $B Matrix/Array * - * @return Matrix Sum + * @return Matrix Sum */ public function plus() { @@ -496,13 +496,13 @@ class Matrix } /** - * plusEquals. + * plusEquals. * * A = A + B * - * @param mixed $B Matrix/Array + * @param mixed $B Matrix/Array * - * @return Matrix Sum + * @return Matrix Sum */ public function plusEquals() { @@ -552,13 +552,13 @@ class Matrix } /** - * minus. + * minus. * * A - B * - * @param mixed $B Matrix/Array + * @param mixed $B Matrix/Array * - * @return Matrix Sum + * @return Matrix Sum */ public function minus() { @@ -594,13 +594,13 @@ class Matrix } /** - * minusEquals. + * minusEquals. * * A = A - B * - * @param mixed $B Matrix/Array + * @param mixed $B Matrix/Array * - * @return Matrix Sum + * @return Matrix Sum */ public function minusEquals() { @@ -650,14 +650,14 @@ class Matrix } /** - * arrayTimes. + * arrayTimes. * * Element-by-element multiplication * Cij = Aij * Bij * - * @param mixed $B Matrix/Array + * @param mixed $B Matrix/Array * - * @return Matrix Matrix Cij + * @return Matrix Matrix Cij */ public function arrayTimes() { @@ -693,14 +693,14 @@ class Matrix } /** - * arrayTimesEquals. + * arrayTimesEquals. * * Element-by-element multiplication * Aij = Aij * Bij * - * @param mixed $B Matrix/Array + * @param mixed $B Matrix/Array * - * @return Matrix Matrix Aij + * @return Matrix Matrix Aij */ public function arrayTimesEquals() { @@ -750,14 +750,14 @@ class Matrix } /** - * arrayRightDivide. + * arrayRightDivide. * * Element-by-element right division * A / B * - * @param Matrix $B Matrix B + * @param Matrix $B Matrix B * - * @return Matrix Division result + * @return Matrix Division result */ public function arrayRightDivide() { @@ -812,14 +812,14 @@ class Matrix } /** - * arrayRightDivideEquals. + * arrayRightDivideEquals. * * Element-by-element right division * Aij = Aij / Bij * - * @param mixed $B Matrix/Array + * @param mixed $B Matrix/Array * - * @return Matrix Matrix Aij + * @return Matrix Matrix Aij */ public function arrayRightDivideEquals() { @@ -855,14 +855,14 @@ class Matrix } /** - * arrayLeftDivide. + * arrayLeftDivide. * * Element-by-element Left division * A / B * - * @param Matrix $B Matrix B + * @param Matrix $B Matrix B * - * @return Matrix Division result + * @return Matrix Division result */ public function arrayLeftDivide() { @@ -898,14 +898,14 @@ class Matrix } /** - * arrayLeftDivideEquals. + * arrayLeftDivideEquals. * * Element-by-element Left division * Aij = Aij / Bij * - * @param mixed $B Matrix/Array + * @param mixed $B Matrix/Array * - * @return Matrix Matrix Aij + * @return Matrix Matrix Aij */ public function arrayLeftDivideEquals() { @@ -941,13 +941,13 @@ class Matrix } /** - * times. + * times. * * Matrix multiplication * - * @param mixed $n Matrix/Array/Scalar + * @param mixed $n Matrix/Array/Scalar * - * @return Matrix Product + * @return Matrix Product */ public function times() { @@ -1034,13 +1034,13 @@ class Matrix } /** - * power. + * power. * * A = A ^ B * - * @param mixed $B Matrix/Array + * @param mixed $B Matrix/Array * - * @return Matrix Sum + * @return Matrix Sum */ public function power() { @@ -1090,13 +1090,13 @@ class Matrix } /** - * concat. + * concat. * * A = A & B * - * @param mixed $B Matrix/Array + * @param mixed $B Matrix/Array * - * @return Matrix Sum + * @return Matrix Sum */ public function concat() { @@ -1132,11 +1132,11 @@ class Matrix } /** - * Solve A*X = B. + * Solve A*X = B. * - * @param Matrix $B Right hand side + * @param Matrix $B Right hand side * - * @return Matrix ... Solution if A is square, least squares solution otherwise + * @return Matrix ... Solution if A is square, least squares solution otherwise */ public function solve($B) { @@ -1151,9 +1151,9 @@ class Matrix } /** - * Matrix inverse or pseudoinverse. + * Matrix inverse or pseudoinverse. * - * @return Matrix ... Inverse(A) if A is square, pseudoinverse otherwise. + * @return Matrix ... Inverse(A) if A is square, pseudoinverse otherwise. */ public function inverse() { @@ -1161,11 +1161,11 @@ class Matrix } /** - * det. + * det. * * Calculate determinant * - * @return float Determinant + * @return float Determinant */ public function det() { diff --git a/src/PhpSpreadsheet/Shared/JAMA/QRDecomposition.php b/src/PhpSpreadsheet/Shared/JAMA/QRDecomposition.php index c664e77a..21644dab 100644 --- a/src/PhpSpreadsheet/Shared/JAMA/QRDecomposition.php +++ b/src/PhpSpreadsheet/Shared/JAMA/QRDecomposition.php @@ -23,39 +23,39 @@ class QRDecomposition const MATRIX_RANK_EXCEPTION = 'Can only perform operation on full-rank matrix.'; /** - * Array for internal storage of decomposition. + * Array for internal storage of decomposition. * - * @var array + * @var array */ private $QR = []; /** - * Row dimension. + * Row dimension. * - * @var int + * @var int */ private $m; /** - * Column dimension. + * Column dimension. * - * @var int + * @var int */ private $n; /** - * Array for internal storage of diagonal of R. + * Array for internal storage of diagonal of R. * - * @var array + * @var array */ private $Rdiag = []; /** - * QR Decomposition computed by Householder reflections. + * QR Decomposition computed by Householder reflections. * - * @param matrix $A Rectangular matrix + * @param matrix $A Rectangular matrix * - * @return Structure to access R and the Householder vectors and compute Q + * @return Structure to access R and the Householder vectors and compute Q */ public function __construct($A) { @@ -104,7 +104,7 @@ class QRDecomposition /** * Is the matrix full rank? * - * @return bool true if R, and hence A, has full rank, else false + * @return bool true if R, and hence A, has full rank, else false */ public function isFullRank() { @@ -120,9 +120,9 @@ class QRDecomposition // function isFullRank() /** - * Return the Householder vectors. + * Return the Householder vectors. * - * @return Matrix Lower trapezoidal matrix whose columns define the reflections + * @return Matrix Lower trapezoidal matrix whose columns define the reflections */ public function getH() { @@ -142,9 +142,9 @@ class QRDecomposition // function getH() /** - * Return the upper triangular factor. + * Return the upper triangular factor. * - * @return Matrix upper triangular factor + * @return Matrix upper triangular factor */ public function getR() { @@ -166,9 +166,9 @@ class QRDecomposition // function getR() /** - * Generate and return the (economy-sized) orthogonal factor. + * Generate and return the (economy-sized) orthogonal factor. * - * @return Matrix orthogonal factor + * @return Matrix orthogonal factor */ public function getQ() { @@ -205,11 +205,11 @@ class QRDecomposition // function getQ() /** - * Least squares solution of A*X = B. + * Least squares solution of A*X = B. * - * @param Matrix $B a Matrix with as many rows as A and any number of columns + * @param Matrix $B a Matrix with as many rows as A and any number of columns * - * @return Matrix matrix that minimizes the two norm of Q*R*X-B + * @return Matrix matrix that minimizes the two norm of Q*R*X-B */ public function solve($B) { diff --git a/src/PhpSpreadsheet/Shared/JAMA/SingularValueDecomposition.php b/src/PhpSpreadsheet/Shared/JAMA/SingularValueDecomposition.php index c78d0b25..cfd20113 100644 --- a/src/PhpSpreadsheet/Shared/JAMA/SingularValueDecomposition.php +++ b/src/PhpSpreadsheet/Shared/JAMA/SingularValueDecomposition.php @@ -22,49 +22,49 @@ namespace PhpOffice\PhpSpreadsheet\Shared\JAMA; class SingularValueDecomposition { /** - * Internal storage of U. + * Internal storage of U. * - * @var array + * @var array */ private $U = []; /** - * Internal storage of V. + * Internal storage of V. * - * @var array + * @var array */ private $V = []; /** - * Internal storage of singular values. + * Internal storage of singular values. * - * @var array + * @var array */ private $s = []; /** - * Row dimension. + * Row dimension. * - * @var int + * @var int */ private $m; /** - * Column dimension. + * Column dimension. * - * @var int + * @var int */ private $n; /** - * Construct the singular value decomposition. + * Construct the singular value decomposition. * - * Derived from LINPACK code. + * Derived from LINPACK code. * - * @param $A Rectangular matrix + * @param $A Rectangular matrix * @param mixed $Arg * - * @return Structure to access U, S and V + * @return Structure to access U, S and V */ public function __construct($Arg) { @@ -439,9 +439,9 @@ class SingularValueDecomposition // end constructor /** - * Return the left singular vectors. + * Return the left singular vectors. * - * @return U + * @return U */ public function getU() { @@ -449,9 +449,9 @@ class SingularValueDecomposition } /** - * Return the right singular vectors. + * Return the right singular vectors. * - * @return V + * @return V */ public function getV() { @@ -459,9 +459,9 @@ class SingularValueDecomposition } /** - * Return the one-dimensional array of singular values. + * Return the one-dimensional array of singular values. * - * @return diagonal of S + * @return diagonal of S */ public function getSingularValues() { @@ -469,9 +469,9 @@ class SingularValueDecomposition } /** - * Return the diagonal matrix of singular values. + * Return the diagonal matrix of singular values. * - * @return S + * @return S */ public function getS() { @@ -486,9 +486,9 @@ class SingularValueDecomposition } /** - * Two norm. + * Two norm. * - * @return max(S) + * @return max(S) */ public function norm2() { @@ -496,9 +496,9 @@ class SingularValueDecomposition } /** - * Two norm condition number. + * Two norm condition number. * - * @return max(S)/min(S) + * @return max(S)/min(S) */ public function cond() { @@ -506,9 +506,9 @@ class SingularValueDecomposition } /** - * Effective numerical matrix rank. + * Effective numerical matrix rank. * - * @return Number of nonnegligible singular values + * @return Number of nonnegligible singular values */ public function rank() { diff --git a/src/PhpSpreadsheet/Shared/JAMA/utils/Error.php b/src/PhpSpreadsheet/Shared/JAMA/utils/Error.php index f2950631..cc6a25e7 100644 --- a/src/PhpSpreadsheet/Shared/JAMA/utils/Error.php +++ b/src/PhpSpreadsheet/Shared/JAMA/utils/Error.php @@ -65,7 +65,7 @@ $error['EN'][ROW_LENGTH_EXCEPTION] = 'All rows must have the same length.'; /** * Custom error handler. * - * @param int $errorNumber Error number + * @param int $errorNumber Error number */ function JAMAError($errorNumber = null) { diff --git a/src/PhpSpreadsheet/Shared/OLE.php b/src/PhpSpreadsheet/Shared/OLE.php index 72c5893c..33153c57 100644 --- a/src/PhpSpreadsheet/Shared/OLE.php +++ b/src/PhpSpreadsheet/Shared/OLE.php @@ -69,28 +69,28 @@ class OLE /** * Big Block Allocation Table. * - * @var array (blockId => nextBlockId) + * @var array (blockId => nextBlockId) */ public $bbat; /** * Short Block Allocation Table. * - * @var array (blockId => nextBlockId) + * @var array (blockId => nextBlockId) */ public $sbat; /** * Size of big blocks. This is usually 512. * - * @var int number of octets per block + * @var int number of octets per block */ public $bigBlockSize; /** * Size of small blocks. This is usually 64. * - * @var int number of octets per block + * @var int number of octets per block */ public $smallBlockSize; @@ -190,8 +190,8 @@ class OLE } /** - * @param int block id - * @param int byte offset from beginning of file + * @param int block id + * @param int byte offset from beginning of file * @param mixed $blockId */ public function _getBlockOffset($blockId) @@ -203,10 +203,10 @@ class OLE * Returns a stream for use with fread() etc. External callers should * use \PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\File::getStream(). * - * @param int|PPS block id or PPS + * @param int|PPS block id or PPS * @param mixed $blockIdOrPps * - * @return resource read-only stream + * @return resource read-only stream */ public function getStream($blockIdOrPps) { @@ -236,9 +236,9 @@ class OLE /** * Reads a signed char. * - * @param resource $fh file handle + * @param resource $fh file handle * - * @return int + * @return int */ private static function _readInt1($fh) { @@ -250,9 +250,9 @@ class OLE /** * Reads an unsigned short (2 octets). * - * @param resource $fh file handle + * @param resource $fh file handle * - * @return int + * @return int */ private static function _readInt2($fh) { @@ -264,9 +264,9 @@ class OLE /** * Reads an unsigned long (4 octets). * - * @param resource $fh file handle + * @param resource $fh file handle * - * @return int + * @return int */ private static function _readInt4($fh) { @@ -279,7 +279,7 @@ class OLE * Gets information about all PPS's on the OLE container from the PPS WK's * creates an OLE_PPS object for each one. * - * @param int $blockId the block id of the first block + * @param int $blockId the block id of the first block * * @return bool true on success, PEAR_Error on failure */ @@ -417,10 +417,10 @@ class OLE * Gets data from a PPS * If there is no PPS for the index given, it will return an empty string. * - * @param int $index The index for the PPS + * @param int $index The index for the PPS * @param int $position The position from which to start reading * (relative to the PPS) - * @param int $length The amount of bytes to read (at most) + * @param int $length The amount of bytes to read (at most) * * @return string The binary string containing the data requested * @@ -443,7 +443,7 @@ class OLE * Gets the data length from a PPS * If there is no PPS for the index given, it will return 0. * - * @param int $index The index for the PPS + * @param int $index The index for the PPS * * @return int The amount of bytes in data the PPS has */ diff --git a/src/PhpSpreadsheet/Shared/OLE/ChainedBlockStream.php b/src/PhpSpreadsheet/Shared/OLE/ChainedBlockStream.php index a5813b7c..997e2938 100644 --- a/src/PhpSpreadsheet/Shared/OLE/ChainedBlockStream.php +++ b/src/PhpSpreadsheet/Shared/OLE/ChainedBlockStream.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared\OLE; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -43,14 +43,14 @@ class ChainedBlockStream /** * The binary data of the file. * - * @var string + * @var string */ public $data; /** * The file pointer. * - * @var int byte offset + * @var int byte offset */ public $pos; @@ -58,13 +58,13 @@ class ChainedBlockStream * Implements support for fopen(). * For creating streams using this wrapper, use OLE_PPS_File::getStream(). * - * @param string $path resource name including scheme, e.g. + * @param string $path resource name including scheme, e.g. * ole-chainedblockstream://oleInstanceId=1 - * @param string $mode only "r" is supported - * @param int $options mask of STREAM_REPORT_ERRORS and STREAM_USE_PATH - * @param string &$openedPath absolute path of the opened stream (out parameter) + * @param string $mode only "r" is supported + * @param int $options mask of STREAM_REPORT_ERRORS and STREAM_USE_PATH + * @param string &$openedPath absolute path of the opened stream (out parameter) * - * @return bool true on success + * @return bool true on success */ public function stream_open($path, $mode, $options, &$openedPath) // @codingStandardsIgnoreLine { @@ -130,9 +130,9 @@ class ChainedBlockStream /** * Implements support for fread(), fgets() etc. * - * @param int $count maximum number of bytes to read + * @param int $count maximum number of bytes to read * - * @return string + * @return string */ public function stream_read($count) // @codingStandardsIgnoreLine { @@ -148,7 +148,7 @@ class ChainedBlockStream /** * Implements support for feof(). * - * @return bool TRUE if the file pointer is at EOF; otherwise FALSE + * @return bool TRUE if the file pointer is at EOF; otherwise FALSE */ public function stream_eof() // @codingStandardsIgnoreLine { @@ -159,7 +159,7 @@ class ChainedBlockStream * Returns the position of the file pointer, i.e. its offset into the file * stream. Implements support for ftell(). * - * @return int + * @return int */ public function stream_tell() // @codingStandardsIgnoreLine { @@ -169,10 +169,10 @@ class ChainedBlockStream /** * Implements support for fseek(). * - * @param int $offset byte offset - * @param int $whence SEEK_SET, SEEK_CUR or SEEK_END + * @param int $offset byte offset + * @param int $whence SEEK_SET, SEEK_CUR or SEEK_END * - * @return bool + * @return bool */ public function stream_seek($offset, $whence) // @codingStandardsIgnoreLine { @@ -193,7 +193,7 @@ class ChainedBlockStream * Implements support for fstat(). Currently the only supported field is * "size". * - * @return array + * @return array */ public function stream_stat() // @codingStandardsIgnoreLine { diff --git a/src/PhpSpreadsheet/Shared/OLE/PPS.php b/src/PhpSpreadsheet/Shared/OLE/PPS.php index ed3cb2c9..fdc3a879 100644 --- a/src/PhpSpreadsheet/Shared/OLE/PPS.php +++ b/src/PhpSpreadsheet/Shared/OLE/PPS.php @@ -124,16 +124,16 @@ class PPS /** * The constructor. * - * @param int $No The PPS index - * @param string $name The PPS name + * @param int $No The PPS index + * @param string $name The PPS name * @param int $type The PPS type. Dir, Root or File * @param int $prev The index of the previous PPS * @param int $next The index of the next PPS - * @param int $dir The index of it's first child if this is a Dir or Root PPS + * @param int $dir The index of it's first child if this is a Dir or Root PPS * @param int $time_1st A timestamp * @param int $time_2nd A timestamp - * @param string $data The (usually binary) source data of the PPS - * @param array $children Array containing children PPS for this PPS + * @param string $data The (usually binary) source data of the PPS + * @param array $children Array containing children PPS for this PPS */ public function __construct($No, $name, $type, $prev, $next, $dir, $time_1st, $time_2nd, $data, $children) { @@ -205,7 +205,7 @@ class PPS * @param mixed $to_save * @param mixed $depth * - * @return int The index for this PPS + * @return int The index for this PPS */ public static function _savePpsSetPnt(&$raList, $to_save, $depth = 0) { diff --git a/src/PhpSpreadsheet/Shared/OLE/PPS/File.php b/src/PhpSpreadsheet/Shared/OLE/PPS/File.php index 71c07d2f..1df6c73f 100644 --- a/src/PhpSpreadsheet/Shared/OLE/PPS/File.php +++ b/src/PhpSpreadsheet/Shared/OLE/PPS/File.php @@ -65,7 +65,7 @@ class File extends \PhpOffice\PhpSpreadsheet\Shared\OLE\PPS /** * Returns a stream for reading this file using fread() etc. * - * @return resource a read-only stream + * @return resource a read-only stream */ public function getStream() { diff --git a/src/PhpSpreadsheet/Shared/OLERead.php b/src/PhpSpreadsheet/Shared/OLERead.php index 7276d113..515a1fa3 100644 --- a/src/PhpSpreadsheet/Shared/OLERead.php +++ b/src/PhpSpreadsheet/Shared/OLERead.php @@ -14,12 +14,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @copyright Copyright (c) 2006 - 2016 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/Shared/PCLZip/gnu-lgpl.txt b/src/PhpSpreadsheet/Shared/PCLZip/gnu-lgpl.txt index 9abd2c21..d6213f33 100644 --- a/src/PhpSpreadsheet/Shared/PCLZip/gnu-lgpl.txt +++ b/src/PhpSpreadsheet/Shared/PCLZip/gnu-lgpl.txt @@ -480,7 +480,7 @@ convey the exclusion of warranty; and each file should have at least the This library is distributed in the hope that it will be useful, 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. You should have received a copy of the GNU Lesser General Public diff --git a/src/PhpSpreadsheet/Shared/PasswordHasher.php b/src/PhpSpreadsheet/Shared/PasswordHasher.php index c24f37f0..f47a6573 100644 --- a/src/PhpSpreadsheet/Shared/PasswordHasher.php +++ b/src/PhpSpreadsheet/Shared/PasswordHasher.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -33,9 +33,9 @@ class PasswordHasher * Daniel Rentz of OpenOffice and the PEAR package * Spreadsheet_Excel_Writer by Xavier Noguer . * - * @param string $pPassword Password to hash + * @param string $pPassword Password to hash * - * @return string Hashed password + * @return string Hashed password */ public static function hashPassword($pPassword = '') { diff --git a/src/PhpSpreadsheet/Shared/StringHelper.php b/src/PhpSpreadsheet/Shared/StringHelper.php index c6778351..1084db68 100644 --- a/src/PhpSpreadsheet/Shared/StringHelper.php +++ b/src/PhpSpreadsheet/Shared/StringHelper.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -343,9 +343,9 @@ class StringHelper * So you could end up with something like _x0008_ in a string (either in a cell value () * element or in the shared string element. * - * @param string $value Value to unescape + * @param string $value Value to unescape * - * @return string + * @return string */ public static function controlCharacterOOXML2PHP($value = '') { @@ -363,9 +363,9 @@ class StringHelper * So you could end up with something like _x0008_ in a string (either in a cell value () * element or in the shared string element. * - * @param string $value Value to escape + * @param string $value Value to escape * - * @return string + * @return string */ public static function controlCharacterPHP2OOXML($value = '') { @@ -433,7 +433,7 @@ class StringHelper * although this will give wrong results for non-ASCII strings * see OpenOffice.org's Documentation of the Microsoft Excel File Format, sect. 2.5.3. * - * @param string $value UTF-8 encoded string + * @param string $value UTF-8 encoded string * @param mixed[] $arrcRuns Details of rich text runs in $value * * @return string @@ -527,10 +527,10 @@ class StringHelper * This function was taken from http://php.net/manual/en/function.utf8-decode.php * and $bom_be parameter added. * - * @param string $str uTF-16 encoded data to decode + * @param string $str uTF-16 encoded data to decode * @param mixed $bom_be * - * @return string uTF-8 / ISO encoded data + * @return string uTF-8 / ISO encoded data * * @version 0.2 / 2010-05-13 * @@ -645,7 +645,7 @@ class StringHelper /** * Convert a UTF-8 encoded string to title/proper case - * (uppercase every first character in each word, lower case all other characters). + * (uppercase every first character in each word, lower case all other characters). * * @param string $pValue UTF-8 encoded string * @@ -674,7 +674,7 @@ class StringHelper /** * Reverse the case of a string, so that all uppercase characters become lowercase - * and all lowercase characters become uppercase. + * and all lowercase characters become uppercase. * * @param string $pValue UTF-8 encoded string * @@ -700,7 +700,7 @@ class StringHelper /** * Identify whether a string contains a fractional numeric value, - * and convert it to a numeric if it is. + * and convert it to a numeric if it is. * * @param string &$operand string value to test * @@ -848,11 +848,11 @@ class StringHelper /** * Retrieve any leading numeric part of a string, or return the full string if no leading numeric - * (handles basic integer or float, but not exponent or non decimal). + * (handles basic integer or float, but not exponent or non decimal). * - * @param string $value + * @param string $value * - * @return mixed string or only the leading numeric part of the string + * @return mixed string or only the leading numeric part of the string */ public static function testStringAsNumeric($value) { diff --git a/src/PhpSpreadsheet/Shared/TimeZone.php b/src/PhpSpreadsheet/Shared/TimeZone.php index f1d51578..46348cae 100644 --- a/src/PhpSpreadsheet/Shared/TimeZone.php +++ b/src/PhpSpreadsheet/Shared/TimeZone.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -30,16 +30,16 @@ class TimeZone * Default Timezone used for date/time conversions * * @private - * @var string + * @var string */ protected static $timezone = 'UTC'; /** * Validate a Timezone name. * - * @param string $timezone Time zone (e.g. 'Europe/London') + * @param string $timezone Time zone (e.g. 'Europe/London') * - * @return bool Success or failure + * @return bool Success or failure */ private static function validateTimeZone($timezone) { @@ -53,9 +53,9 @@ class TimeZone /** * Set the Default Timezone used for date/time conversions. * - * @param string $timezone Time zone (e.g. 'Europe/London') + * @param string $timezone Time zone (e.g. 'Europe/London') * - * @return bool Success or failure + * @return bool Success or failure */ public static function setTimeZone($timezone) { @@ -71,7 +71,7 @@ class TimeZone /** * Return the Default Timezone used for date/time conversions. * - * @return string Timezone (e.g. 'Europe/London') + * @return string Timezone (e.g. 'Europe/London') */ public static function getTimeZone() { @@ -80,14 +80,14 @@ class TimeZone /** * Return the Timezone offset used for date/time conversions to/from UST - * This requires both the timezone and the calculated date/time to allow for local DST. + * This requires both the timezone and the calculated date/time to allow for local DST. * - * @param string $timezone The timezone for finding the adjustment to UST - * @param int $timestamp PHP date/time value + * @param string $timezone The timezone for finding the adjustment to UST + * @param int $timestamp PHP date/time value * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return int Number of seconds for timezone adjustment + * @return int Number of seconds for timezone adjustment */ public static function getTimeZoneAdjustment($timezone, $timestamp) { diff --git a/src/PhpSpreadsheet/Shared/Trend/BestFit.php b/src/PhpSpreadsheet/Shared/Trend/BestFit.php index 1b3caff7..83740ff1 100644 --- a/src/PhpSpreadsheet/Shared/Trend/BestFit.php +++ b/src/PhpSpreadsheet/Shared/Trend/BestFit.php @@ -14,12 +14,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared\Trend; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -31,49 +31,49 @@ class BestFit /** * Indicator flag for a calculation error. * - * @var bool + * @var bool **/ protected $error = false; /** * Algorithm type to use for best-fit. * - * @var string + * @var string **/ protected $bestFitType = 'undetermined'; /** * Number of entries in the sets of x- and y-value arrays. * - * @var int + * @var int **/ protected $valueCount = 0; /** * X-value dataseries of values. * - * @var float[] + * @var float[] **/ protected $xValues = []; /** * Y-value dataseries of values. * - * @var float[] + * @var float[] **/ protected $yValues = []; /** * Flag indicating whether values should be adjusted to Y=0. * - * @var bool + * @var bool **/ protected $adjustToZero = false; /** * Y-value series of best-fit values. * - * @var float[] + * @var float[] **/ protected $yBestFitValues = []; @@ -118,9 +118,9 @@ class BestFit /** * Return the Y-Value for a specified value of X. * - * @param float $xValue X-Value + * @param float $xValue X-Value * - * @return bool Y-Value + * @return bool Y-Value */ public function getValueOfYForX($xValue) { @@ -130,9 +130,9 @@ class BestFit /** * Return the X-Value for a specified value of Y. * - * @param float $yValue Y-Value + * @param float $yValue Y-Value * - * @return bool X-Value + * @return bool X-Value */ public function getValueOfXForY($yValue) { @@ -142,7 +142,7 @@ class BestFit /** * Return the original set of X-Values. * - * @return float[] X-Values + * @return float[] X-Values */ public function getXValues() { @@ -152,9 +152,9 @@ class BestFit /** * Return the Equation of the best-fit line. * - * @param int $dp Number of places of decimal precision to display + * @param int $dp Number of places of decimal precision to display * - * @return bool + * @return bool */ public function getEquation($dp = 0) { @@ -164,9 +164,9 @@ class BestFit /** * Return the Slope of the line. * - * @param int $dp Number of places of decimal precision to display + * @param int $dp Number of places of decimal precision to display * - * @return string + * @return string */ public function getSlope($dp = 0) { @@ -180,9 +180,9 @@ class BestFit /** * Return the standard error of the Slope. * - * @param int $dp Number of places of decimal precision to display + * @param int $dp Number of places of decimal precision to display * - * @return string + * @return string */ public function getSlopeSE($dp = 0) { @@ -196,9 +196,9 @@ class BestFit /** * Return the Value of X where it intersects Y = 0. * - * @param int $dp Number of places of decimal precision to display + * @param int $dp Number of places of decimal precision to display * - * @return string + * @return string */ public function getIntersect($dp = 0) { @@ -212,9 +212,9 @@ class BestFit /** * Return the standard error of the Intersect. * - * @param int $dp Number of places of decimal precision to display + * @param int $dp Number of places of decimal precision to display * - * @return string + * @return string */ public function getIntersectSE($dp = 0) { @@ -228,9 +228,9 @@ class BestFit /** * Return the goodness of fit for this regression. * - * @param int $dp Number of places of decimal precision to return + * @param int $dp Number of places of decimal precision to return * - * @return float + * @return float */ public function getGoodnessOfFit($dp = 0) { @@ -253,9 +253,9 @@ class BestFit /** * Return the standard deviation of the residuals for this regression. * - * @param int $dp Number of places of decimal precision to return + * @param int $dp Number of places of decimal precision to return * - * @return float + * @return float */ public function getStdevOfResiduals($dp = 0) { @@ -422,9 +422,9 @@ class BestFit /** * Define the regression. * - * @param float[] $yValues The set of Y-values for this regression - * @param float[] $xValues The set of X-values for this regression - * @param bool $const + * @param float[] $yValues The set of Y-values for this regression + * @param float[] $xValues The set of X-values for this regression + * @param bool $const */ public function __construct($yValues, $xValues = [], $const = true) { diff --git a/src/PhpSpreadsheet/Shared/Trend/ExponentialBestFit.php b/src/PhpSpreadsheet/Shared/Trend/ExponentialBestFit.php index e93ee715..7ffb6ab3 100644 --- a/src/PhpSpreadsheet/Shared/Trend/ExponentialBestFit.php +++ b/src/PhpSpreadsheet/Shared/Trend/ExponentialBestFit.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared\Trend; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -30,16 +30,16 @@ class ExponentialBestFit extends BestFit * Algorithm type to use for best-fit * (Name of this Trend class). * - * @var string + * @var string **/ protected $bestFitType = 'exponential'; /** * Return the Y-Value for a specified value of X. * - * @param float $xValue X-Value + * @param float $xValue X-Value * - * @return float Y-Value + * @return float Y-Value **/ public function getValueOfYForX($xValue) { @@ -49,9 +49,9 @@ class ExponentialBestFit extends BestFit /** * Return the X-Value for a specified value of Y. * - * @param float $yValue Y-Value + * @param float $yValue Y-Value * - * @return float X-Value + * @return float X-Value **/ public function getValueOfXForY($yValue) { @@ -61,9 +61,9 @@ class ExponentialBestFit extends BestFit /** * Return the Equation of the best-fit line. * - * @param int $dp Number of places of decimal precision to display + * @param int $dp Number of places of decimal precision to display * - * @return string + * @return string **/ public function getEquation($dp = 0) { @@ -76,9 +76,9 @@ class ExponentialBestFit extends BestFit /** * Return the Slope of the line. * - * @param int $dp Number of places of decimal precision to display + * @param int $dp Number of places of decimal precision to display * - * @return float + * @return float **/ public function getSlope($dp = 0) { @@ -92,9 +92,9 @@ class ExponentialBestFit extends BestFit /** * Return the Value of X where it intersects Y = 0. * - * @param int $dp Number of places of decimal precision to display + * @param int $dp Number of places of decimal precision to display * - * @return float + * @return float **/ public function getIntersect($dp = 0) { @@ -108,9 +108,9 @@ class ExponentialBestFit extends BestFit /** * Execute the regression and calculate the goodness of fit for a set of X and Y data values. * - * @param float[] $yValues The set of Y-values for this regression - * @param float[] $xValues The set of X-values for this regression - * @param bool $const + * @param float[] $yValues The set of Y-values for this regression + * @param float[] $xValues The set of X-values for this regression + * @param bool $const */ private function exponentialRegression($yValues, $xValues, $const) { @@ -129,9 +129,9 @@ class ExponentialBestFit extends BestFit /** * Define the regression and calculate the goodness of fit for a set of X and Y data values. * - * @param float[] $yValues The set of Y-values for this regression - * @param float[] $xValues The set of X-values for this regression - * @param bool $const + * @param float[] $yValues The set of Y-values for this regression + * @param float[] $xValues The set of X-values for this regression + * @param bool $const */ public function __construct($yValues, $xValues = [], $const = true) { diff --git a/src/PhpSpreadsheet/Shared/Trend/LinearBestFit.php b/src/PhpSpreadsheet/Shared/Trend/LinearBestFit.php index 8ecd57c7..f09d797c 100644 --- a/src/PhpSpreadsheet/Shared/Trend/LinearBestFit.php +++ b/src/PhpSpreadsheet/Shared/Trend/LinearBestFit.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared\Trend; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -30,16 +30,16 @@ class LinearBestFit extends BestFit * Algorithm type to use for best-fit * (Name of this Trend class). * - * @var string + * @var string **/ protected $bestFitType = 'linear'; /** * Return the Y-Value for a specified value of X. * - * @param float $xValue X-Value + * @param float $xValue X-Value * - * @return float Y-Value + * @return float Y-Value **/ public function getValueOfYForX($xValue) { @@ -49,9 +49,9 @@ class LinearBestFit extends BestFit /** * Return the X-Value for a specified value of Y. * - * @param float $yValue Y-Value + * @param float $yValue Y-Value * - * @return float X-Value + * @return float X-Value **/ public function getValueOfXForY($yValue) { @@ -61,9 +61,9 @@ class LinearBestFit extends BestFit /** * Return the Equation of the best-fit line. * - * @param int $dp Number of places of decimal precision to display + * @param int $dp Number of places of decimal precision to display * - * @return string + * @return string **/ public function getEquation($dp = 0) { @@ -76,9 +76,9 @@ class LinearBestFit extends BestFit /** * Execute the regression and calculate the goodness of fit for a set of X and Y data values. * - * @param float[] $yValues The set of Y-values for this regression - * @param float[] $xValues The set of X-values for this regression - * @param bool $const + * @param float[] $yValues The set of Y-values for this regression + * @param float[] $xValues The set of X-values for this regression + * @param bool $const */ private function linearRegression($yValues, $xValues, $const) { @@ -88,9 +88,9 @@ class LinearBestFit extends BestFit /** * Define the regression and calculate the goodness of fit for a set of X and Y data values. * - * @param float[] $yValues The set of Y-values for this regression - * @param float[] $xValues The set of X-values for this regression - * @param bool $const + * @param float[] $yValues The set of Y-values for this regression + * @param float[] $xValues The set of X-values for this regression + * @param bool $const */ public function __construct($yValues, $xValues = [], $const = true) { diff --git a/src/PhpSpreadsheet/Shared/Trend/LogarithmicBestFit.php b/src/PhpSpreadsheet/Shared/Trend/LogarithmicBestFit.php index bb06bce3..2f99f9e8 100644 --- a/src/PhpSpreadsheet/Shared/Trend/LogarithmicBestFit.php +++ b/src/PhpSpreadsheet/Shared/Trend/LogarithmicBestFit.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared\Trend; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -30,16 +30,16 @@ class LogarithmicBestFit extends BestFit * Algorithm type to use for best-fit * (Name of this Trend class). * - * @var string + * @var string **/ protected $bestFitType = 'logarithmic'; /** * Return the Y-Value for a specified value of X. * - * @param float $xValue X-Value + * @param float $xValue X-Value * - * @return float Y-Value + * @return float Y-Value **/ public function getValueOfYForX($xValue) { @@ -49,9 +49,9 @@ class LogarithmicBestFit extends BestFit /** * Return the X-Value for a specified value of Y. * - * @param float $yValue Y-Value + * @param float $yValue Y-Value * - * @return float X-Value + * @return float X-Value **/ public function getValueOfXForY($yValue) { @@ -61,9 +61,9 @@ class LogarithmicBestFit extends BestFit /** * Return the Equation of the best-fit line. * - * @param int $dp Number of places of decimal precision to display + * @param int $dp Number of places of decimal precision to display * - * @return string + * @return string **/ public function getEquation($dp = 0) { @@ -76,9 +76,9 @@ class LogarithmicBestFit extends BestFit /** * Execute the regression and calculate the goodness of fit for a set of X and Y data values. * - * @param float[] $yValues The set of Y-values for this regression - * @param float[] $xValues The set of X-values for this regression - * @param bool $const + * @param float[] $yValues The set of Y-values for this regression + * @param float[] $xValues The set of X-values for this regression + * @param bool $const */ private function logarithmicRegression($yValues, $xValues, $const) { @@ -97,9 +97,9 @@ class LogarithmicBestFit extends BestFit /** * Define the regression and calculate the goodness of fit for a set of X and Y data values. * - * @param float[] $yValues The set of Y-values for this regression - * @param float[] $xValues The set of X-values for this regression - * @param bool $const + * @param float[] $yValues The set of Y-values for this regression + * @param float[] $xValues The set of X-values for this regression + * @param bool $const */ public function __construct($yValues, $xValues = [], $const = true) { diff --git a/src/PhpSpreadsheet/Shared/Trend/PolynomialBestFit.php b/src/PhpSpreadsheet/Shared/Trend/PolynomialBestFit.php index a5079944..822a3e70 100644 --- a/src/PhpSpreadsheet/Shared/Trend/PolynomialBestFit.php +++ b/src/PhpSpreadsheet/Shared/Trend/PolynomialBestFit.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared\Trend; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -30,7 +30,7 @@ class PolynomialBestFit extends BestFit * Algorithm type to use for best-fit * (Name of this Trend class). * - * @var string + * @var string **/ protected $bestFitType = 'polynomial'; @@ -39,14 +39,14 @@ class PolynomialBestFit extends BestFit * * @protected * - * @var int + * @var int **/ protected $order = 0; /** * Return the order of this polynomial. * - * @return int + * @return int **/ public function getOrder() { @@ -56,9 +56,9 @@ class PolynomialBestFit extends BestFit /** * Return the Y-Value for a specified value of X. * - * @param float $xValue X-Value + * @param float $xValue X-Value * - * @return float Y-Value + * @return float Y-Value **/ public function getValueOfYForX($xValue) { @@ -76,9 +76,9 @@ class PolynomialBestFit extends BestFit /** * Return the X-Value for a specified value of Y. * - * @param float $yValue Y-Value + * @param float $yValue Y-Value * - * @return float X-Value + * @return float X-Value **/ public function getValueOfXForY($yValue) { @@ -88,9 +88,9 @@ class PolynomialBestFit extends BestFit /** * Return the Equation of the best-fit line. * - * @param int $dp Number of places of decimal precision to display + * @param int $dp Number of places of decimal precision to display * - * @return string + * @return string **/ public function getEquation($dp = 0) { @@ -113,9 +113,9 @@ class PolynomialBestFit extends BestFit /** * Return the Slope of the line. * - * @param int $dp Number of places of decimal precision to display + * @param int $dp Number of places of decimal precision to display * - * @return string + * @return string **/ public function getSlope($dp = 0) { @@ -139,10 +139,10 @@ class PolynomialBestFit extends BestFit /** * Execute the regression and calculate the goodness of fit for a set of X and Y data values. * - * @param int $order Order of Polynomial for this regression - * @param float[] $yValues The set of Y-values for this regression - * @param float[] $xValues The set of X-values for this regression - * @param bool $const + * @param int $order Order of Polynomial for this regression + * @param float[] $yValues The set of Y-values for this regression + * @param float[] $xValues The set of X-values for this regression + * @param bool $const */ private function polynomialRegression($order, $yValues, $xValues, $const) { @@ -196,10 +196,10 @@ class PolynomialBestFit extends BestFit /** * Define the regression and calculate the goodness of fit for a set of X and Y data values. * - * @param int $order Order of Polynomial for this regression - * @param float[] $yValues The set of Y-values for this regression - * @param float[] $xValues The set of X-values for this regression - * @param bool $const + * @param int $order Order of Polynomial for this regression + * @param float[] $yValues The set of Y-values for this regression + * @param float[] $xValues The set of X-values for this regression + * @param bool $const */ public function __construct($order, $yValues, $xValues = [], $const = true) { diff --git a/src/PhpSpreadsheet/Shared/Trend/PowerBestFit.php b/src/PhpSpreadsheet/Shared/Trend/PowerBestFit.php index 1635a631..c838d224 100644 --- a/src/PhpSpreadsheet/Shared/Trend/PowerBestFit.php +++ b/src/PhpSpreadsheet/Shared/Trend/PowerBestFit.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared\Trend; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -30,16 +30,16 @@ class PowerBestFit extends BestFit * Algorithm type to use for best-fit * (Name of this Trend class). * - * @var string + * @var string **/ protected $bestFitType = 'power'; /** * Return the Y-Value for a specified value of X. * - * @param float $xValue X-Value + * @param float $xValue X-Value * - * @return float Y-Value + * @return float Y-Value **/ public function getValueOfYForX($xValue) { @@ -49,9 +49,9 @@ class PowerBestFit extends BestFit /** * Return the X-Value for a specified value of Y. * - * @param float $yValue Y-Value + * @param float $yValue Y-Value * - * @return float X-Value + * @return float X-Value **/ public function getValueOfXForY($yValue) { @@ -61,9 +61,9 @@ class PowerBestFit extends BestFit /** * Return the Equation of the best-fit line. * - * @param int $dp Number of places of decimal precision to display + * @param int $dp Number of places of decimal precision to display * - * @return string + * @return string **/ public function getEquation($dp = 0) { @@ -76,9 +76,9 @@ class PowerBestFit extends BestFit /** * Return the Value of X where it intersects Y = 0. * - * @param int $dp Number of places of decimal precision to display + * @param int $dp Number of places of decimal precision to display * - * @return float + * @return float **/ public function getIntersect($dp = 0) { @@ -92,9 +92,9 @@ class PowerBestFit extends BestFit /** * Execute the regression and calculate the goodness of fit for a set of X and Y data values. * - * @param float[] $yValues The set of Y-values for this regression - * @param float[] $xValues The set of X-values for this regression - * @param bool $const + * @param float[] $yValues The set of Y-values for this regression + * @param float[] $xValues The set of X-values for this regression + * @param bool $const */ private function powerRegression($yValues, $xValues, $const) { @@ -121,9 +121,9 @@ class PowerBestFit extends BestFit /** * Define the regression and calculate the goodness of fit for a set of X and Y data values. * - * @param float[] $yValues The set of Y-values for this regression - * @param float[] $xValues The set of X-values for this regression - * @param bool $const + * @param float[] $yValues The set of Y-values for this regression + * @param float[] $xValues The set of X-values for this regression + * @param bool $const */ public function __construct($yValues, $xValues = [], $const = true) { diff --git a/src/PhpSpreadsheet/Shared/Trend/Trend.php b/src/PhpSpreadsheet/Shared/Trend/Trend.php index 7d0acb48..b4d9d93e 100644 --- a/src/PhpSpreadsheet/Shared/Trend/Trend.php +++ b/src/PhpSpreadsheet/Shared/Trend/Trend.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared\Trend; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * diff --git a/src/PhpSpreadsheet/Shared/XMLWriter.php b/src/PhpSpreadsheet/Shared/XMLWriter.php index 9e16932a..3a5cc301 100644 --- a/src/PhpSpreadsheet/Shared/XMLWriter.php +++ b/src/PhpSpreadsheet/Shared/XMLWriter.php @@ -20,12 +20,12 @@ if (!defined('DEBUGMODE_ENABLED')) { * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -48,8 +48,8 @@ class XMLWriter extends \XMLWriter /** * Create a new XMLWriter instance. * - * @param int $pTemporaryStorage Temporary storage location - * @param string $pTemporaryStorageFolder Temporary storage folder + * @param int $pTemporaryStorage Temporary storage location + * @param string $pTemporaryStorageFolder Temporary storage folder */ public function __construct($pTemporaryStorage = self::STORAGE_MEMORY, $pTemporaryStorageFolder = null) { diff --git a/src/PhpSpreadsheet/Shared/Xls.php b/src/PhpSpreadsheet/Shared/Xls.php index d3bdaf32..de7c29e5 100644 --- a/src/PhpSpreadsheet/Shared/Xls.php +++ b/src/PhpSpreadsheet/Shared/Xls.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * diff --git a/src/PhpSpreadsheet/Shared/ZipArchive.php b/src/PhpSpreadsheet/Shared/ZipArchive.php index dab97b61..3926f834 100644 --- a/src/PhpSpreadsheet/Shared/ZipArchive.php +++ b/src/PhpSpreadsheet/Shared/ZipArchive.php @@ -18,12 +18,12 @@ use PhpOffice\PhpSpreadsheet\Shared\PCLZip\PclZip; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -53,9 +53,9 @@ class ZipArchive /** * Open a new zip archive. * - * @param string $fileName Filename for the zip archive + * @param string $fileName Filename for the zip archive * - * @return bool + * @return bool */ public function open($fileName) { @@ -75,10 +75,10 @@ class ZipArchive /** * Add a new file to the zip archive from a string of raw data. * - * @param string $localname Directory/Name of the file to add to the zip archive - * @param string $contents String of data to add to the zip archive + * @param string $localname Directory/Name of the file to add to the zip archive + * @param string $contents String of data to add to the zip archive * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ public function addFromString($localname, $contents) { @@ -99,9 +99,9 @@ class ZipArchive /** * Find if given fileName exist in archive (Emulate ZipArchive locateName()). * - * @param string $fileName Filename for the file in zip archive + * @param string $fileName Filename for the file in zip archive * - * @return bool + * @return bool */ public function locateName($fileName) { @@ -124,9 +124,9 @@ class ZipArchive /** * Extract file from archive by given fileName (Emulate ZipArchive getFromName()). * - * @param string $fileName Filename for the file in zip archive + * @param string $fileName Filename for the file in zip archive * - * @return string $contents File string contents + * @return string $contents File string contents */ public function getFromName($fileName) { diff --git a/src/PhpSpreadsheet/Shared/ZipStreamWrapper.php b/src/PhpSpreadsheet/Shared/ZipStreamWrapper.php index 2c9f6012..3cedb78a 100644 --- a/src/PhpSpreadsheet/Shared/ZipStreamWrapper.php +++ b/src/PhpSpreadsheet/Shared/ZipStreamWrapper.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Shared; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -66,14 +66,14 @@ class ZipStreamWrapper /** * Implements support for fopen(). * - * @param string $path resource name including scheme, e.g. - * @param string $mode only "r" is supported - * @param int $options mask of STREAM_REPORT_ERRORS and STREAM_USE_PATH - * @param string &$openedPath absolute path of the opened stream (out parameter) + * @param string $path resource name including scheme, e.g. + * @param string $mode only "r" is supported + * @param int $options mask of STREAM_REPORT_ERRORS and STREAM_USE_PATH + * @param string &$openedPath absolute path of the opened stream (out parameter) * - * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception + * @throws \PhpOffice\PhpSpreadsheet\Reader\Exception * - * @return bool true on success + * @return bool true on success */ public function stream_open($path, $mode, $options, &$opened_path) // @codingStandardsIgnoreLine { @@ -101,7 +101,7 @@ class ZipStreamWrapper /** * Implements support for fstat(). * - * @return string + * @return string */ public function statName() { @@ -111,7 +111,7 @@ class ZipStreamWrapper /** * Implements support for fstat(). * - * @return string + * @return string */ public function url_stat() // @codingStandardsIgnoreLine { @@ -121,7 +121,7 @@ class ZipStreamWrapper /** * Implements support for fstat(). * - * @return bool + * @return bool */ public function stream_stat() // @codingStandardsIgnoreLine { @@ -131,9 +131,9 @@ class ZipStreamWrapper /** * Implements support for fread(), fgets() etc. * - * @param int $count maximum number of bytes to read + * @param int $count maximum number of bytes to read * - * @return string + * @return string */ public function stream_read($count) // @codingStandardsIgnoreLine { @@ -147,7 +147,7 @@ class ZipStreamWrapper * Returns the position of the file pointer, i.e. its offset into the file * stream. Implements support for ftell(). * - * @return int + * @return int */ public function stream_tell() // @codingStandardsIgnoreLine { @@ -157,7 +157,7 @@ class ZipStreamWrapper /** * EOF stream. * - * @return bool + * @return bool */ public function stream_eof() // @codingStandardsIgnoreLine { @@ -167,10 +167,10 @@ class ZipStreamWrapper /** * Seek stream. * - * @param int $offset byte offset - * @param int $whence SEEK_SET, SEEK_CUR or SEEK_END + * @param int $offset byte offset + * @param int $whence SEEK_SET, SEEK_CUR or SEEK_END * - * @return bool + * @return bool */ public function stream_seek($offset, $whence) // @codingStandardsIgnoreLine { diff --git a/src/PhpSpreadsheet/Spreadsheet.php b/src/PhpSpreadsheet/Spreadsheet.php index 89de18fb..91f433d5 100644 --- a/src/PhpSpreadsheet/Spreadsheet.php +++ b/src/PhpSpreadsheet/Spreadsheet.php @@ -14,12 +14,12 @@ namespace PhpOffice\PhpSpreadsheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -338,7 +338,7 @@ class Spreadsheet /** * Check if a sheet with a specified code name already exists. * - * @param string $pSheetCodeName Name of the worksheet to check + * @param string $pSheetCodeName Name of the worksheet to check * * @return bool */ @@ -408,7 +408,7 @@ class Spreadsheet /** * Disconnect all worksheets from this PhpSpreadsheet workbook object, - * typically so that the PhpSpreadsheet object can be unset. + * typically so that the PhpSpreadsheet object can be unset. */ public function disconnectWorksheets() { @@ -444,7 +444,7 @@ class Spreadsheet /** * Set properties. * - * @param Document\Properties $pValue + * @param Document\Properties $pValue */ public function setProperties(Document\Properties $pValue) { @@ -464,7 +464,7 @@ class Spreadsheet /** * Set security. * - * @param Document\Security $pValue + * @param Document\Security $pValue */ public function setSecurity(Document\Security $pValue) { @@ -486,7 +486,7 @@ class Spreadsheet /** * Create sheet and add it to this workbook. * - * @param int|null $iSheetIndex Index where sheet should go (0,1,..., or null for last) + * @param int|null $iSheetIndex Index where sheet should go (0,1,..., or null for last) * * @throws Exception * @@ -503,7 +503,7 @@ class Spreadsheet /** * Check if a sheet with a specified name already exists. * - * @param string $pSheetName Name of the worksheet to check + * @param string $pSheetName Name of the worksheet to check * * @return bool */ @@ -515,8 +515,8 @@ class Spreadsheet /** * Add sheet. * - * @param Worksheet $pSheet - * @param int|null $iSheetIndex Index where sheet should go (0,1,..., or null for last) + * @param Worksheet $pSheet + * @param int|null $iSheetIndex Index where sheet should go (0,1,..., or null for last) * * @throws Exception * @@ -560,7 +560,7 @@ class Spreadsheet /** * Remove sheet by index. * - * @param int $pIndex Active sheet index + * @param int $pIndex Active sheet index * * @throws Exception */ @@ -584,7 +584,7 @@ class Spreadsheet /** * Get sheet by index. * - * @param int $pIndex Sheet index + * @param int $pIndex Sheet index * * @throws Exception * @@ -615,7 +615,7 @@ class Spreadsheet /** * Get sheet by name. * - * @param string $pName Sheet name + * @param string $pName Sheet name * * @return Worksheet */ @@ -634,7 +634,7 @@ class Spreadsheet /** * Get index for sheet. * - * @param Worksheet $pSheet + * @param Worksheet $pSheet * * @throws Exception * @@ -654,8 +654,8 @@ class Spreadsheet /** * Set index for sheet by sheet name. * - * @param string $sheetName Sheet name to modify index for - * @param int $newIndex New index for the sheet + * @param string $sheetName Sheet name to modify index for + * @param int $newIndex New index for the sheet * * @throws Exception * @@ -702,7 +702,7 @@ class Spreadsheet /** * Set active sheet index. * - * @param int $pIndex Active sheet index + * @param int $pIndex Active sheet index * * @throws Exception * @@ -725,7 +725,7 @@ class Spreadsheet /** * Set active sheet index by name. * - * @param string $pValue Sheet title + * @param string $pValue Sheet title * * @throws Exception * @@ -761,8 +761,8 @@ class Spreadsheet /** * Add external sheet. * - * @param Worksheet $pSheet External sheet to add - * @param int|null $iSheetIndex Index where sheet should go (0,1,..., or null for last) + * @param Worksheet $pSheet External sheet to add + * @param int|null $iSheetIndex Index where sheet should go (0,1,..., or null for last) * * @throws Exception * @@ -807,7 +807,7 @@ class Spreadsheet /** * Add named range. * - * @param NamedRange $namedRange + * @param NamedRange $namedRange * * @return bool */ @@ -827,8 +827,8 @@ class Spreadsheet /** * Get named range. * - * @param string $namedRange - * @param Worksheet|null $pSheet Scope. Use null for global scope + * @param string $namedRange + * @param Worksheet|null $pSheet Scope. Use null for global scope * * @return NamedRange|null */ @@ -854,8 +854,8 @@ class Spreadsheet /** * Remove named range. * - * @param string $namedRange - * @param Worksheet|null $pSheet scope: use null for global scope + * @param string $namedRange + * @param Worksheet|null $pSheet scope: use null for global scope * * @return Spreadsheet */ @@ -927,7 +927,7 @@ class Spreadsheet /** * Get cellXf by index. * - * @param int $pIndex + * @param int $pIndex * * @return Style */ @@ -939,7 +939,7 @@ class Spreadsheet /** * Get cellXf by hash code. * - * @param string $pValue + * @param string $pValue * * @return Style|false */ @@ -957,7 +957,7 @@ class Spreadsheet /** * Check if style exists in style collection. * - * @param Style $pCellStyle + * @param Style $pCellStyle * * @return bool */ @@ -1059,7 +1059,7 @@ class Spreadsheet /** * Get cellStyleXf by hash code. * - * @param string $pValue + * @param string $pValue * * @return Style|false */ diff --git a/src/PhpSpreadsheet/Style.php b/src/PhpSpreadsheet/Style.php index 6db5e267..b8c0675f 100644 --- a/src/PhpSpreadsheet/Style.php +++ b/src/PhpSpreadsheet/Style.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -201,10 +201,10 @@ class Style extends Style\Supervisor implements IComparable * ); * * - * @param array $pStyles Array containing style information - * @param bool $pAdvanced advanced mode for setting borders + * @param array $pStyles Array containing style information + * @param bool $pAdvanced advanced mode for setting borders * - * @throws Exception + * @throws Exception * * @return Style */ diff --git a/src/PhpSpreadsheet/Style/Alignment.php b/src/PhpSpreadsheet/Style/Alignment.php index 3643d29d..68ded6c4 100644 --- a/src/PhpSpreadsheet/Style/Alignment.php +++ b/src/PhpSpreadsheet/Style/Alignment.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Style; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -100,10 +100,10 @@ class Alignment extends Supervisor implements \PhpOffice\PhpSpreadsheet\ICompara /** * Create a new Alignment. * - * @param bool $isSupervisor Flag indicating if this is a supervisor or not + * @param bool $isSupervisor Flag indicating if this is a supervisor or not * Leave this value at default unless you understand exactly what * its ramifications are - * @param bool $isConditional Flag indicating if this is a conditional style or not + * @param bool $isConditional Flag indicating if this is a conditional style or not * Leave this value at default unless you understand exactly what * its ramifications are */ @@ -156,11 +156,11 @@ class Alignment extends Supervisor implements \PhpOffice\PhpSpreadsheet\ICompara * ); * * - * @param array $pStyles Array containing style information + * @param array $pStyles Array containing style information * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return Alignment + * @return Alignment */ public function applyFromArray($pStyles = null) { @@ -468,7 +468,7 @@ class Alignment extends Supervisor implements \PhpOffice\PhpSpreadsheet\ICompara /** * Get hash code. * - * @return string Hash code + * @return string Hash code */ public function getHashCode() { diff --git a/src/PhpSpreadsheet/Style/Border.php b/src/PhpSpreadsheet/Style/Border.php index e1a1c42f..8eed8981 100644 --- a/src/PhpSpreadsheet/Style/Border.php +++ b/src/PhpSpreadsheet/Style/Border.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Style; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -66,10 +66,10 @@ class Border extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparable /** * Create a new Border. * - * @param bool $isSupervisor Flag indicating if this is a supervisor or not + * @param bool $isSupervisor Flag indicating if this is a supervisor or not * Leave this value at default unless you understand exactly what * its ramifications are - * @param bool $isConditional Flag indicating if this is a conditional style or not + * @param bool $isConditional Flag indicating if this is a conditional style or not * Leave this value at default unless you understand exactly what * its ramifications are */ @@ -175,11 +175,11 @@ class Border extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparable * ); * * - * @param array $pStyles Array containing style information + * @param array $pStyles Array containing style information * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return Border + * @return Border */ public function applyFromArray($pStyles = null) { @@ -218,7 +218,7 @@ class Border extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparable /** * Set Border style. * - * @param string|bool $pValue + * @param string|bool $pValue * When passing a boolean, FALSE equates Border::BORDER_NONE * and TRUE to Border::BORDER_MEDIUM * @@ -254,11 +254,11 @@ class Border extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparable /** * Set Border Color. * - * @param Color $pValue + * @param Color $pValue * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return Border + * @return Border */ public function setColor(Color $pValue = null) { @@ -278,7 +278,7 @@ class Border extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparable /** * Get hash code. * - * @return string Hash code + * @return string Hash code */ public function getHashCode() { diff --git a/src/PhpSpreadsheet/Style/Borders.php b/src/PhpSpreadsheet/Style/Borders.php index 998aa298..674da8fb 100644 --- a/src/PhpSpreadsheet/Style/Borders.php +++ b/src/PhpSpreadsheet/Style/Borders.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Style; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -112,10 +112,10 @@ class Borders extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparabl /** * Create a new Borders. * - * @param bool $isSupervisor Flag indicating if this is a supervisor or not + * @param bool $isSupervisor Flag indicating if this is a supervisor or not * Leave this value at default unless you understand exactly what * its ramifications are - * @param bool $isConditional Flag indicating if this is a conditional style or not + * @param bool $isConditional Flag indicating if this is a conditional style or not * Leave this value at default unless you understand exactly what * its ramifications are */ @@ -212,11 +212,11 @@ class Borders extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparabl * ); * * - * @param array $pStyles Array containing style information + * @param array $pStyles Array containing style information * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return Borders + * @return Borders */ public function applyFromArray($pStyles = null) { @@ -309,9 +309,9 @@ class Borders extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparabl /** * Get AllBorders (pseudo-border). Only applies to supervisor. * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return Border + * @return Border */ public function getAllBorders() { @@ -425,7 +425,7 @@ class Borders extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparabl /** * Get hash code. * - * @return string Hash code + * @return string Hash code */ public function getHashCode() { diff --git a/src/PhpSpreadsheet/Style/Color.php b/src/PhpSpreadsheet/Style/Color.php index fe3c318a..2079ba77 100644 --- a/src/PhpSpreadsheet/Style/Color.php +++ b/src/PhpSpreadsheet/Style/Color.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Style; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -62,11 +62,11 @@ class Color extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparable /** * Create a new Color. * - * @param string $pARGB ARGB value for the colour - * @param bool $isSupervisor Flag indicating if this is a supervisor or not + * @param string $pARGB ARGB value for the colour + * @param bool $isSupervisor Flag indicating if this is a supervisor or not * Leave this value at default unless you understand exactly what * its ramifications are - * @param bool $isConditional Flag indicating if this is a conditional style or not + * @param bool $isConditional Flag indicating if this is a conditional style or not * Leave this value at default unless you understand exactly what * its ramifications are */ @@ -146,9 +146,9 @@ class Color extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparable * $spreadsheet->getActiveSheet()->getStyle('B2')->getFont()->getColor()->applyFromArray( array('rgb' => '808080') ); * * - * @param array $pStyles Array containing style information + * @param array $pStyles Array containing style information * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * * @return Color */ @@ -225,7 +225,7 @@ class Color extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparable /** * Set RGB. * - * @param string $pValue RGB value + * @param string $pValue RGB value * * @return Color */ @@ -249,12 +249,12 @@ class Color extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparable * * @private * - * @param string $RGB The colour as an RGB value (e.g. FF00CCCC or CCDDEE - * @param int $offset Position within the RGB value to extract - * @param bool $hex Flag indicating whether the component should be returned as a hex or a + * @param string $RGB The colour as an RGB value (e.g. FF00CCCC or CCDDEE + * @param int $offset Position within the RGB value to extract + * @param bool $hex Flag indicating whether the component should be returned as a hex or a * decimal value * - * @return string The extracted colour component + * @return string The extracted colour component */ private static function getColourComponent($RGB, $offset, $hex = true) { @@ -269,11 +269,11 @@ class Color extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparable /** * Get the red colour component of an RGB value. * - * @param string $RGB The colour as an RGB value (e.g. FF00CCCC or CCDDEE - * @param bool $hex Flag indicating whether the component should be returned as a hex or a + * @param string $RGB The colour as an RGB value (e.g. FF00CCCC or CCDDEE + * @param bool $hex Flag indicating whether the component should be returned as a hex or a * decimal value * - * @return string The red colour component + * @return string The red colour component */ public static function getRed($RGB, $hex = true) { @@ -283,11 +283,11 @@ class Color extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparable /** * Get the green colour component of an RGB value. * - * @param string $RGB The colour as an RGB value (e.g. FF00CCCC or CCDDEE - * @param bool $hex Flag indicating whether the component should be returned as a hex or a + * @param string $RGB The colour as an RGB value (e.g. FF00CCCC or CCDDEE + * @param bool $hex Flag indicating whether the component should be returned as a hex or a * decimal value * - * @return string The green colour component + * @return string The green colour component */ public static function getGreen($RGB, $hex = true) { @@ -297,11 +297,11 @@ class Color extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparable /** * Get the blue colour component of an RGB value. * - * @param string $RGB The colour as an RGB value (e.g. FF00CCCC or CCDDEE - * @param bool $hex Flag indicating whether the component should be returned as a hex or a + * @param string $RGB The colour as an RGB value (e.g. FF00CCCC or CCDDEE + * @param bool $hex Flag indicating whether the component should be returned as a hex or a * decimal value * - * @return string The blue colour component + * @return string The blue colour component */ public static function getBlue($RGB, $hex = true) { @@ -311,10 +311,10 @@ class Color extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparable /** * Adjust the brightness of a color. * - * @param string $hex The colour as an RGBA or RGB value (e.g. FF00CCCC or CCDDEE) - * @param float $adjustPercentage The percentage by which to adjust the colour as a float from -1 to 1 + * @param string $hex The colour as an RGBA or RGB value (e.g. FF00CCCC or CCDDEE) + * @param float $adjustPercentage The percentage by which to adjust the colour as a float from -1 to 1 * - * @return string The adjusted colour as an RGBA or RGB value (e.g. FF00CCCC or CCDDEE) + * @return string The adjusted colour as an RGBA or RGB value (e.g. FF00CCCC or CCDDEE) */ public static function changeBrightness($hex, $adjustPercentage) { @@ -361,11 +361,11 @@ class Color extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparable /** * Get indexed color. * - * @param int $pIndex Index entry point into the colour array - * @param bool $background Flag to indicate whether default background or foreground colour + * @param int $pIndex Index entry point into the colour array + * @param bool $background Flag to indicate whether default background or foreground colour * should be returned if the indexed colour doesn't exist * - * @return Color + * @return Color */ public static function indexedColor($pIndex, $background = false) { @@ -448,7 +448,7 @@ class Color extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparable /** * Get hash code. * - * @return string Hash code + * @return string Hash code */ public function getHashCode() { diff --git a/src/PhpSpreadsheet/Style/Conditional.php b/src/PhpSpreadsheet/Style/Conditional.php index 64f7c22f..1387d35f 100644 --- a/src/PhpSpreadsheet/Style/Conditional.php +++ b/src/PhpSpreadsheet/Style/Conditional.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Style; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -107,7 +107,7 @@ class Conditional implements \PhpOffice\PhpSpreadsheet\IComparable /** * Set Condition type. * - * @param string $pValue Condition type + * @param string $pValue Condition type * * @return Conditional */ @@ -131,7 +131,7 @@ class Conditional implements \PhpOffice\PhpSpreadsheet\IComparable /** * Set Operator type. * - * @param string $pValue Conditional operator type + * @param string $pValue Conditional operator type * * @return Conditional */ @@ -179,7 +179,7 @@ class Conditional implements \PhpOffice\PhpSpreadsheet\IComparable /** * Set Conditions. * - * @param string[] $pValue Condition + * @param string[] $pValue Condition * * @return Conditional */ @@ -196,7 +196,7 @@ class Conditional implements \PhpOffice\PhpSpreadsheet\IComparable /** * Add Condition. * - * @param string $pValue Condition + * @param string $pValue Condition * * @return Conditional */ @@ -220,11 +220,11 @@ class Conditional implements \PhpOffice\PhpSpreadsheet\IComparable /** * Set Style. * - * @param \PhpOffice\PhpSpreadsheet\Style $pValue + * @param \PhpOffice\PhpSpreadsheet\Style $pValue * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return Conditional + * @return Conditional */ public function setStyle(\PhpOffice\PhpSpreadsheet\Style $pValue = null) { @@ -236,7 +236,7 @@ class Conditional implements \PhpOffice\PhpSpreadsheet\IComparable /** * Get hash code. * - * @return string Hash code + * @return string Hash code */ public function getHashCode() { diff --git a/src/PhpSpreadsheet/Style/Fill.php b/src/PhpSpreadsheet/Style/Fill.php index d2dffaf1..4570e877 100644 --- a/src/PhpSpreadsheet/Style/Fill.php +++ b/src/PhpSpreadsheet/Style/Fill.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Style; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -80,10 +80,10 @@ class Fill extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparable /** * Create a new Fill. * - * @param bool $isSupervisor Flag indicating if this is a supervisor or not + * @param bool $isSupervisor Flag indicating if this is a supervisor or not * Leave this value at default unless you understand exactly what * its ramifications are - * @param bool $isConditional Flag indicating if this is a conditional style or not + * @param bool $isConditional Flag indicating if this is a conditional style or not * Leave this value at default unless you understand exactly what * its ramifications are */ @@ -147,9 +147,9 @@ class Fill extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparable * ); * * - * @param array $pStyles Array containing style information + * @param array $pStyles Array containing style information * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * * @return Fill */ @@ -199,7 +199,7 @@ class Fill extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparable /** * Set Fill Type. * - * @param string $pValue Fill type + * @param string $pValue Fill type * * @return Fill */ @@ -261,9 +261,9 @@ class Fill extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparable /** * Set Start Color. * - * @param Color $pValue + * @param Color $pValue * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * * @return Fill */ @@ -295,9 +295,9 @@ class Fill extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparable /** * Set End Color. * - * @param Color $pValue + * @param Color $pValue * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * * @return Fill */ @@ -319,7 +319,7 @@ class Fill extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparable /** * Get hash code. * - * @return string Hash code + * @return string Hash code */ public function getHashCode() { diff --git a/src/PhpSpreadsheet/Style/Font.php b/src/PhpSpreadsheet/Style/Font.php index 15b2bfff..ba4cc7f0 100644 --- a/src/PhpSpreadsheet/Style/Font.php +++ b/src/PhpSpreadsheet/Style/Font.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Style; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -99,10 +99,10 @@ class Font extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparable /** * Create a new Font. * - * @param bool $isSupervisor Flag indicating if this is a supervisor or not + * @param bool $isSupervisor Flag indicating if this is a supervisor or not * Leave this value at default unless you understand exactly what * its ramifications are - * @param bool $isConditional Flag indicating if this is a conditional style or not + * @param bool $isConditional Flag indicating if this is a conditional style or not * Leave this value at default unless you understand exactly what * its ramifications are */ @@ -172,9 +172,9 @@ class Font extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparable * ); * * - * @param array $pStyles Array containing style information + * @param array $pStyles Array containing style information * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * * @return Font */ @@ -454,7 +454,7 @@ class Font extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparable /** * Set Underline. * - * @param string|bool $pValue \PhpOffice\PhpSpreadsheet\Style\Font underline type + * @param string|bool $pValue \PhpOffice\PhpSpreadsheet\Style\Font underline type * If a boolean is passed, then TRUE equates to UNDERLINE_SINGLE, * false equates to UNDERLINE_NONE * @@ -526,9 +526,9 @@ class Font extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparable /** * Set Color. * - * @param Color $pValue + * @param Color $pValue * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * * @return Font */ @@ -550,7 +550,7 @@ class Font extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComparable /** * Get hash code. * - * @return string Hash code + * @return string Hash code */ public function getHashCode() { diff --git a/src/PhpSpreadsheet/Style/NumberFormat.php b/src/PhpSpreadsheet/Style/NumberFormat.php index 984779a3..fb729905 100644 --- a/src/PhpSpreadsheet/Style/NumberFormat.php +++ b/src/PhpSpreadsheet/Style/NumberFormat.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Style; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -97,10 +97,10 @@ class NumberFormat extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComp /** * Create a new NumberFormat. * - * @param bool $isSupervisor Flag indicating if this is a supervisor or not + * @param bool $isSupervisor Flag indicating if this is a supervisor or not * Leave this value at default unless you understand exactly what * its ramifications are - * @param bool $isConditional Flag indicating if this is a conditional style or not + * @param bool $isConditional Flag indicating if this is a conditional style or not * Leave this value at default unless you understand exactly what * its ramifications are */ @@ -149,9 +149,9 @@ class NumberFormat extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComp * ); * * - * @param array $pStyles Array containing style information + * @param array $pStyles Array containing style information * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * * @return NumberFormat */ @@ -336,9 +336,9 @@ class NumberFormat extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComp /** * Get built-in format code. * - * @param int $pIndex + * @param int $pIndex * - * @return string + * @return string */ public static function builtInFormatCode($pIndex) { @@ -359,9 +359,9 @@ class NumberFormat extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComp /** * Get built-in format code index. * - * @param string $formatCode + * @param string $formatCode * - * @return int|bool + * @return int|bool */ public static function builtInFormatCodeIndex($formatCode) { @@ -379,7 +379,7 @@ class NumberFormat extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComp /** * Get hash code. * - * @return string Hash code + * @return string Hash code */ public function getHashCode() { @@ -587,11 +587,11 @@ class NumberFormat extends Supervisor implements \PhpOffice\PhpSpreadsheet\IComp /** * Convert a value in a pre-defined format to a PHP string. * - * @param mixed $value Value to format - * @param string $format Format code - * @param array $callBack Callback function for additional formatting of string + * @param mixed $value Value to format + * @param string $format Format code + * @param array $callBack Callback function for additional formatting of string * - * @return string Formatted string + * @return string Formatted string */ public static function toFormattedString($value = '0', $format = self::FORMAT_GENERAL, $callBack = null) { diff --git a/src/PhpSpreadsheet/Style/Protection.php b/src/PhpSpreadsheet/Style/Protection.php index 3e5b4a90..27145488 100644 --- a/src/PhpSpreadsheet/Style/Protection.php +++ b/src/PhpSpreadsheet/Style/Protection.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Style; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -48,10 +48,10 @@ class Protection extends Supervisor implements \PhpOffice\PhpSpreadsheet\ICompar /** * Create a new Protection. * - * @param bool $isSupervisor Flag indicating if this is a supervisor or not + * @param bool $isSupervisor Flag indicating if this is a supervisor or not * Leave this value at default unless you understand exactly what * its ramifications are - * @param bool $isConditional Flag indicating if this is a conditional style or not + * @param bool $isConditional Flag indicating if this is a conditional style or not * Leave this value at default unless you understand exactly what * its ramifications are */ @@ -102,9 +102,9 @@ class Protection extends Supervisor implements \PhpOffice\PhpSpreadsheet\ICompar * ); * * - * @param array $pStyles Array containing style information + * @param array $pStyles Array containing style information * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * * @return Protection */ @@ -197,7 +197,7 @@ class Protection extends Supervisor implements \PhpOffice\PhpSpreadsheet\ICompar /** * Get hash code. * - * @return string Hash code + * @return string Hash code */ public function getHashCode() { diff --git a/src/PhpSpreadsheet/Style/Supervisor.php b/src/PhpSpreadsheet/Style/Supervisor.php index d881a669..d3b07929 100644 --- a/src/PhpSpreadsheet/Style/Supervisor.php +++ b/src/PhpSpreadsheet/Style/Supervisor.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Style; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -43,7 +43,7 @@ abstract class Supervisor /** * Create a new Supervisor. * - * @param bool $isSupervisor Flag indicating if this is a supervisor or not + * @param bool $isSupervisor Flag indicating if this is a supervisor or not * Leave this value at default unless you understand exactly what * its ramifications are */ diff --git a/src/PhpSpreadsheet/Worksheet.php b/src/PhpSpreadsheet/Worksheet.php index d0dc781a..65219664 100644 --- a/src/PhpSpreadsheet/Worksheet.php +++ b/src/PhpSpreadsheet/Worksheet.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -326,8 +326,8 @@ class Worksheet implements IComparable /** * Create a new worksheet. * - * @param Spreadsheet $parent - * @param string $pTitle + * @param Spreadsheet $parent + * @param string $pTitle */ public function __construct(Spreadsheet $parent = null, $pTitle = 'Worksheet') { @@ -362,7 +362,7 @@ class Worksheet implements IComparable /** * Disconnect all cells from this Worksheet object, - * typically so that the worksheet object can be unset. + * typically so that the worksheet object can be unset. */ public function disconnectCells() { @@ -576,7 +576,7 @@ class Worksheet implements IComparable /** * Return the count of charts on this worksheet. * - * @return int The number of charts + * @return int The number of charts */ public function getChartCount() { @@ -690,7 +690,7 @@ class Worksheet implements IComparable /** * Calculate worksheet dimension. * - * @return string String containing the dimension of this worksheet + * @return string String containing the dimension of this worksheet */ public function calculateWorksheetDimension() { @@ -701,7 +701,7 @@ class Worksheet implements IComparable /** * Calculate worksheet data dimension. * - * @return string String containing the dimension of this worksheet that actually contain data + * @return string String containing the dimension of this worksheet that actually contain data */ public function calculateWorksheetDataDimension() { @@ -938,7 +938,7 @@ class Worksheet implements IComparable /** * Set page setup. * - * @param Worksheet\PageSetup $pValue + * @param Worksheet\PageSetup $pValue * * @return Worksheet */ @@ -962,7 +962,7 @@ class Worksheet implements IComparable /** * Set page margins. * - * @param Worksheet\PageMargins $pValue + * @param Worksheet\PageMargins $pValue * * @return Worksheet */ @@ -986,7 +986,7 @@ class Worksheet implements IComparable /** * Set page header/footer. * - * @param Worksheet\HeaderFooter $pValue + * @param Worksheet\HeaderFooter $pValue * * @return Worksheet */ @@ -1010,7 +1010,7 @@ class Worksheet implements IComparable /** * Set sheet view. * - * @param Worksheet\SheetView $pValue + * @param Worksheet\SheetView $pValue * * @return Worksheet */ @@ -1034,7 +1034,7 @@ class Worksheet implements IComparable /** * Set Protection. * - * @param Worksheet\Protection $pValue + * @param Worksheet\Protection $pValue * * @return Worksheet */ @@ -1049,7 +1049,7 @@ class Worksheet implements IComparable /** * Get highest worksheet column. * - * @param string $row Return the data highest column for the specified row, + * @param string $row Return the data highest column for the specified row, * or the highest column of any row if no row number is passed * * @return string Highest column name @@ -1066,7 +1066,7 @@ class Worksheet implements IComparable /** * Get highest worksheet column that contains data. * - * @param string $row Return the highest data column for the specified row, + * @param string $row Return the highest data column for the specified row, * or the highest data column of any row if no row number is passed * * @return string Highest column name that contains data @@ -1079,7 +1079,7 @@ class Worksheet implements IComparable /** * Get highest worksheet row. * - * @param string $column Return the highest data row for the specified column, + * @param string $column Return the highest data row for the specified column, * or the highest row of any column if no column letter is passed * * @return int Highest row number @@ -1096,7 +1096,7 @@ class Worksheet implements IComparable /** * Get highest worksheet row that contains data. * - * @param string $column Return the highest data row for the specified column, + * @param string $column Return the highest data row for the specified column, * or the highest data row of any column if no column letter is passed * * @return string Highest row number that contains data @@ -1121,9 +1121,9 @@ class Worksheet implements IComparable * * @param string $pCoordinate Coordinate of the cell * @param mixed $pValue Value of the cell - * @param bool $returnCell Return the worksheet (false, default) or the cell (true) + * @param bool $returnCell Return the worksheet (false, default) or the cell (true) * - * @return Worksheet|Cell Depending on the last parameter being specified + * @return Worksheet|Cell Depending on the last parameter being specified */ public function setCellValue($pCoordinate = 'A1', $pValue = null, $returnCell = false) { @@ -1140,7 +1140,7 @@ class Worksheet implements IComparable * @param mixed $pValue Value of the cell * @param bool $returnCell Return the worksheet (false, default) or the cell (true) * - * @return Worksheet|Cell Depending on the last parameter being specified + * @return Worksheet|Cell Depending on the last parameter being specified */ public function setCellValueByColumnAndRow($pColumn = 0, $pRow = 1, $pValue = null, $returnCell = false) { @@ -1153,11 +1153,11 @@ class Worksheet implements IComparable * Set a cell value. * * @param string $pCoordinate Coordinate of the cell - * @param mixed $pValue Value of the cell + * @param mixed $pValue Value of the cell * @param string $pDataType Explicit data type * @param bool $returnCell Return the worksheet (false, default) or the cell (true) * - * @return Worksheet|Cell Depending on the last parameter being specified + * @return Worksheet|Cell Depending on the last parameter being specified */ public function setCellValueExplicit($pCoordinate = 'A1', $pValue = null, $pDataType = Cell\DataType::TYPE_STRING, $returnCell = false) { @@ -1176,7 +1176,7 @@ class Worksheet implements IComparable * @param string $pDataType Explicit data type * @param bool $returnCell Return the worksheet (false, default) or the cell (true) * - * @return Worksheet|Cell Depending on the last parameter being specified + * @return Worksheet|Cell Depending on the last parameter being specified */ public function setCellValueExplicitByColumnAndRow($pColumn = 0, $pRow = 1, $pValue = null, $pDataType = Cell\DataType::TYPE_STRING, $returnCell = false) { @@ -1188,8 +1188,8 @@ class Worksheet implements IComparable /** * Get cell at a specific coordinate. * - * @param string $pCoordinate Coordinate of the cell - * @param bool $createIfNotExists Flag indicating whether a new cell should be created if it doesn't + * @param string $pCoordinate Coordinate of the cell + * @param bool $createIfNotExists Flag indicating whether a new cell should be created if it doesn't * already exist, or a null should be returned instead * * @throws Exception @@ -1237,9 +1237,9 @@ class Worksheet implements IComparable /** * Get cell at a specific coordinate by using numeric cell coordinates. * - * @param string $pColumn Numeric column coordinate of the cell + * @param string $pColumn Numeric column coordinate of the cell * @param string $pRow Numeric row coordinate of the cell - * @param bool $createIfNotExists Flag indicating whether a new cell should be created if it doesn't + * @param bool $createIfNotExists Flag indicating whether a new cell should be created if it doesn't * already exist, or a null should be returned instead * * @return null|Cell Cell that was found/created or null @@ -1260,7 +1260,7 @@ class Worksheet implements IComparable /** * Create a new cell at the specified coordinate. * - * @param string $pCoordinate Coordinate of the cell + * @param string $pCoordinate Coordinate of the cell * * @return Cell Cell that was created */ @@ -1298,7 +1298,7 @@ class Worksheet implements IComparable /** * Does the cell at a specific coordinate exist? * - * @param string $pCoordinate Coordinate of the cell + * @param string $pCoordinate Coordinate of the cell * * @throws Exception * @@ -1529,7 +1529,7 @@ class Worksheet implements IComparable /** * Get style for cell by using numeric cell coordinates. * - * @param int $pColumn Numeric column coordinate of the cell + * @param int $pColumn Numeric column coordinate of the cell * @param int $pRow Numeric row coordinate of the cell * @param int pColumn2 Numeric column coordinate of the range cell * @param int pRow2 Numeric row coordinate of the range cell @@ -1602,7 +1602,7 @@ class Worksheet implements IComparable * * Please note that this will overwrite existing cell styles for cells in range! * - * @param Style\Conditional[] $pCellStyle Cell style to duplicate + * @param Style\Conditional[] $pCellStyle Cell style to duplicate * @param string $pRange Range of cells (i.e. "A1:B10"), or just one cell (i.e. "A1") * * @throws Exception @@ -1672,7 +1672,7 @@ class Worksheet implements IComparable * * @param int $pColumn Numeric column coordinate of the cell * @param int $pRow Numeric row coordinate of the cell - * @param int $pBreak Break type (type of \PhpOffice\PhpSpreadsheet\Worksheet::BREAK_*) + * @param int $pBreak Break type (type of \PhpOffice\PhpSpreadsheet\Worksheet::BREAK_*) * * @return Worksheet */ @@ -1694,7 +1694,7 @@ class Worksheet implements IComparable /** * Set merge on a cell range. * - * @param string $pRange Cell range (e.g. A1:E1) + * @param string $pRange Cell range (e.g. A1:E1) * * @throws Exception * @@ -1736,12 +1736,12 @@ class Worksheet implements IComparable /** * Set merge on a cell range by using numeric cell coordinates. * - * @param int $pColumn1 Numeric column coordinate of the first cell - * @param int $pRow1 Numeric row coordinate of the first cell - * @param int $pColumn2 Numeric column coordinate of the last cell - * @param int $pRow2 Numeric row coordinate of the last cell + * @param int $pColumn1 Numeric column coordinate of the first cell + * @param int $pRow1 Numeric row coordinate of the first cell + * @param int $pColumn2 Numeric column coordinate of the last cell + * @param int $pRow2 Numeric row coordinate of the last cell * - * @throws Exception + * @throws Exception * * @return Worksheet */ @@ -1755,9 +1755,9 @@ class Worksheet implements IComparable /** * Remove merge on a cell range. * - * @param string $pRange Cell range (e.g. A1:E1) + * @param string $pRange Cell range (e.g. A1:E1) * - * @throws Exception + * @throws Exception * * @return Worksheet */ @@ -1782,12 +1782,12 @@ class Worksheet implements IComparable /** * Remove merge on a cell range by using numeric cell coordinates. * - * @param int $pColumn1 Numeric column coordinate of the first cell - * @param int $pRow1 Numeric row coordinate of the first cell - * @param int $pColumn2 Numeric column coordinate of the last cell - * @param int $pRow2 Numeric row coordinate of the last cell + * @param int $pColumn1 Numeric column coordinate of the first cell + * @param int $pRow1 Numeric row coordinate of the first cell + * @param int $pColumn2 Numeric column coordinate of the last cell + * @param int $pRow2 Numeric row coordinate of the last cell * - * @throws Exception + * @throws Exception * * @return Worksheet */ @@ -1825,11 +1825,11 @@ class Worksheet implements IComparable /** * Set protection on a cell range. * - * @param string $pRange Cell (e.g. A1) or cell range (e.g. A1:E1) - * @param string $pPassword Password to unlock the protection - * @param bool $pAlreadyHashed If the password has already been hashed, set this to true + * @param string $pRange Cell (e.g. A1) or cell range (e.g. A1:E1) + * @param string $pPassword Password to unlock the protection + * @param bool $pAlreadyHashed If the password has already been hashed, set this to true * - * @throws Exception + * @throws Exception * * @return Worksheet */ @@ -1849,14 +1849,14 @@ class Worksheet implements IComparable /** * Set protection on a cell range by using numeric cell coordinates. * - * @param int $pColumn1 Numeric column coordinate of the first cell - * @param int $pRow1 Numeric row coordinate of the first cell - * @param int $pColumn2 Numeric column coordinate of the last cell - * @param int $pRow2 Numeric row coordinate of the last cell - * @param string $pPassword Password to unlock the protection - * @param bool $pAlreadyHashed If the password has already been hashed, set this to true + * @param int $pColumn1 Numeric column coordinate of the first cell + * @param int $pRow1 Numeric row coordinate of the first cell + * @param int $pColumn2 Numeric column coordinate of the last cell + * @param int $pRow2 Numeric row coordinate of the last cell + * @param string $pPassword Password to unlock the protection + * @param bool $pAlreadyHashed If the password has already been hashed, set this to true * - * @throws Exception + * @throws Exception * * @return Worksheet */ @@ -1870,9 +1870,9 @@ class Worksheet implements IComparable /** * Remove protection on a cell range. * - * @param string $pRange Cell (e.g. A1) or cell range (e.g. A1:E1) + * @param string $pRange Cell (e.g. A1) or cell range (e.g. A1:E1) * - * @throws Exception + * @throws Exception * * @return Worksheet */ @@ -1893,14 +1893,14 @@ class Worksheet implements IComparable /** * Remove protection on a cell range by using numeric cell coordinates. * - * @param int $pColumn1 Numeric column coordinate of the first cell - * @param int $pRow1 Numeric row coordinate of the first cell - * @param int $pColumn2 Numeric column coordinate of the last cell - * @param int $pRow2 Numeric row coordinate of the last cell - * @param string $pPassword Password to unlock the protection - * @param bool $pAlreadyHashed If the password has already been hashed, set this to true + * @param int $pColumn1 Numeric column coordinate of the first cell + * @param int $pRow1 Numeric row coordinate of the first cell + * @param int $pColumn2 Numeric column coordinate of the last cell + * @param int $pRow2 Numeric row coordinate of the last cell + * @param string $pPassword Password to unlock the protection + * @param bool $pAlreadyHashed If the password has already been hashed, set this to true * - * @throws Exception + * @throws Exception * * @return Worksheet */ @@ -1922,9 +1922,9 @@ class Worksheet implements IComparable } /** - * Get Autofilter. + * Get Autofilter. * - * @return Worksheet\AutoFilter + * @return Worksheet\AutoFilter */ public function getAutoFilter() { @@ -1932,14 +1932,14 @@ class Worksheet implements IComparable } /** - * Set AutoFilter. + * Set AutoFilter. * - * @param Worksheet\AutoFilter|string $pValue + * @param Worksheet\AutoFilter|string $pValue * A simple string containing a Cell range like 'A1:E10' is permitted for backward compatibility * - * @throws Exception + * @throws Exception * - * @return Worksheet + * @return Worksheet */ public function setAutoFilter($pValue) { @@ -1954,16 +1954,16 @@ class Worksheet implements IComparable } /** - * Set Autofilter Range by using numeric cell coordinates. + * Set Autofilter Range by using numeric cell coordinates. * - * @param int $pColumn1 Numeric column coordinate of the first cell - * @param int $pRow1 Numeric row coordinate of the first cell - * @param int $pColumn2 Numeric column coordinate of the second cell - * @param int $pRow2 Numeric row coordinate of the second cell + * @param int $pColumn1 Numeric column coordinate of the first cell + * @param int $pRow1 Numeric row coordinate of the first cell + * @param int $pColumn2 Numeric column coordinate of the second cell + * @param int $pRow2 Numeric row coordinate of the second cell * - * @throws Exception + * @throws Exception * - * @return Worksheet + * @return Worksheet */ public function setAutoFilterByColumnAndRow($pColumn1 = 0, $pRow1 = 1, $pColumn2 = 0, $pRow2 = 1) { @@ -1999,14 +1999,14 @@ class Worksheet implements IComparable /** * Freeze Pane. * - * @param string $pCell Cell (i.e. A2) + * @param string $pCell Cell (i.e. A2) * Examples: * A2 will freeze the rows above cell A2 (i.e row 1) * B1 will freeze the columns to the left of cell B1 (i.e column A) * B2 will freeze the rows above and to the left of cell A2 * (i.e row 1 and column A) * - * @throws Exception + * @throws Exception * * @return Worksheet */ @@ -2026,10 +2026,10 @@ class Worksheet implements IComparable /** * Freeze Pane by using numeric cell coordinates. * - * @param int $pColumn Numeric column coordinate of the cell - * @param int $pRow Numeric row coordinate of the cell + * @param int $pColumn Numeric column coordinate of the cell + * @param int $pRow Numeric row coordinate of the cell * - * @throws Exception + * @throws Exception * * @return Worksheet */ @@ -2051,10 +2051,10 @@ class Worksheet implements IComparable /** * Insert a new row, updating all possible related data. * - * @param int $pBefore Insert before this one - * @param int $pNumRows Number of rows to insert + * @param int $pBefore Insert before this one + * @param int $pNumRows Number of rows to insert * - * @throws Exception + * @throws Exception * * @return Worksheet */ @@ -2073,10 +2073,10 @@ class Worksheet implements IComparable /** * Insert a new column, updating all possible related data. * - * @param int $pBefore Insert before this one - * @param int $pNumCols Number of columns to insert + * @param int $pBefore Insert before this one + * @param int $pNumCols Number of columns to insert * - * @throws Exception + * @throws Exception * * @return Worksheet */ @@ -2095,10 +2095,10 @@ class Worksheet implements IComparable /** * Insert a new column, updating all possible related data. * - * @param int $pBefore Insert before this one (numeric column coordinate of the cell) - * @param int $pNumCols Number of columns to insert + * @param int $pBefore Insert before this one (numeric column coordinate of the cell) + * @param int $pNumCols Number of columns to insert * - * @throws Exception + * @throws Exception * * @return Worksheet */ @@ -2113,10 +2113,10 @@ class Worksheet implements IComparable /** * Delete a row, updating all possible related data. * - * @param int $pRow Remove starting with this one - * @param int $pNumRows Number of rows to remove + * @param int $pRow Remove starting with this one + * @param int $pNumRows Number of rows to remove * - * @throws Exception + * @throws Exception * * @return Worksheet */ @@ -2140,10 +2140,10 @@ class Worksheet implements IComparable /** * Remove a column, updating all possible related data. * - * @param string $pColumn Remove starting with this one - * @param int $pNumCols Number of columns to remove + * @param string $pColumn Remove starting with this one + * @param int $pNumCols Number of columns to remove * - * @throws Exception + * @throws Exception * * @return Worksheet */ @@ -2168,10 +2168,10 @@ class Worksheet implements IComparable /** * Remove a column, updating all possible related data. * - * @param int $pColumn Remove starting with this one (numeric column coordinate of the cell) - * @param int $pNumCols Number of columns to remove + * @param int $pColumn Remove starting with this one (numeric column coordinate of the cell) + * @param int $pNumCols Number of columns to remove * - * @throws Exception + * @throws Exception * * @return Worksheet */ @@ -2196,7 +2196,7 @@ class Worksheet implements IComparable /** * Set show gridlines. * - * @param bool $pValue Show gridlines (true/false) + * @param bool $pValue Show gridlines (true/false) * * @return Worksheet */ @@ -2268,7 +2268,7 @@ class Worksheet implements IComparable /** * Set show summary below. * - * @param bool $pValue Show summary below (true/false) + * @param bool $pValue Show summary below (true/false) * * @return Worksheet */ @@ -2292,7 +2292,7 @@ class Worksheet implements IComparable /** * Set show summary right. * - * @param bool $pValue Show summary right (true/false) + * @param bool $pValue Show summary right (true/false) * * @return Worksheet */ @@ -2331,7 +2331,7 @@ class Worksheet implements IComparable /** * Get comment for cell. * - * @param string $pCellCoordinate Cell coordinate to get comment for + * @param string $pCellCoordinate Cell coordinate to get comment for * * @throws Exception * @@ -2365,8 +2365,8 @@ class Worksheet implements IComparable /** * Get comment for cell by using numeric cell coordinates. * - * @param int $pColumn Numeric column coordinate of the cell - * @param int $pRow Numeric row coordinate of the cell + * @param int $pColumn Numeric column coordinate of the cell + * @param int $pRow Numeric row coordinate of the cell * * @return Comment */ @@ -2398,7 +2398,7 @@ class Worksheet implements IComparable /** * Selected cell. * - * @param string $pCoordinate Cell (i.e. A1) + * @param string $pCoordinate Cell (i.e. A1) * * @return Worksheet */ @@ -2410,9 +2410,9 @@ class Worksheet implements IComparable /** * Select a range of cells. * - * @param string $pCoordinate Cell range, examples: 'A1', 'B2:G5', 'A:C', '3:6' + * @param string $pCoordinate Cell range, examples: 'A1', 'B2:G5', 'A:C', '3:6' * - * @throws Exception + * @throws Exception * * @return Worksheet */ @@ -2472,7 +2472,7 @@ class Worksheet implements IComparable /** * Set right-to-left. * - * @param bool $value Right-to-left true/false + * @param bool $value Right-to-left true/false * * @return Worksheet */ @@ -2605,11 +2605,11 @@ class Worksheet implements IComparable /** * Create array from a range of cells. * - * @param string $pNamedRange Name of the Named Range - * @param mixed $nullValue Value returned in the array entry if a cell doesn't exist - * @param bool $calculateFormulas Should formulas be calculated? - * @param bool $formatData Should formatting be applied to cell values? - * @param bool $returnCellRef False - Return a simple array of rows and columns indexed by number counting from zero + * @param string $pNamedRange Name of the Named Range + * @param mixed $nullValue Value returned in the array entry if a cell doesn't exist + * @param bool $calculateFormulas Should formulas be calculated? + * @param bool $formatData Should formatting be applied to cell values? + * @param bool $returnCellRef False - Return a simple array of rows and columns indexed by number counting from zero * True - Return rows and columns indexed by their actual row and column IDs * * @throws Exception @@ -2634,7 +2634,7 @@ class Worksheet implements IComparable * * @param mixed $nullValue Value returned in the array entry if a cell doesn't exist * @param bool $calculateFormulas Should formulas be calculated? - * @param bool $formatData Should formatting be applied to cell values? + * @param bool $formatData Should formatting be applied to cell values? * @param bool $returnCellRef False - Return a simple array of rows and columns indexed by number counting from zero * True - Return rows and columns indexed by their actual row and column IDs * @@ -2655,8 +2655,8 @@ class Worksheet implements IComparable /** * Get row iterator. * - * @param int $startRow The row number at which to start iterating - * @param int $endRow The row number at which to stop iterating + * @param int $startRow The row number at which to start iterating + * @param int $endRow The row number at which to stop iterating * * @return Worksheet\RowIterator */ @@ -2668,8 +2668,8 @@ class Worksheet implements IComparable /** * Get column iterator. * - * @param string $startColumn The column address at which to start iterating - * @param string $endColumn The column address at which to stop iterating + * @param string $startColumn The column address at which to start iterating + * @param string $endColumn The column address at which to stop iterating * * @return Worksheet\ColumnIterator */ @@ -2718,7 +2718,7 @@ class Worksheet implements IComparable /** * Get hash code. * - * @return string Hash code + * @return string Hash code */ public function getHashCode() { @@ -2736,8 +2736,8 @@ class Worksheet implements IComparable * Example: extractSheetTitle("testSheet!A1") ==> 'A1' * Example: extractSheetTitle("'testSheet 1'!A1", true) ==> array('testSheet 1', 'A1'); * - * @param string $pRange Range to extract title from - * @param bool $returnRange Return range? (see example) + * @param string $pRange Range to extract title from + * @param bool $returnRange Return range? (see example) * * @return mixed */ @@ -2758,7 +2758,7 @@ class Worksheet implements IComparable /** * Get hyperlink. * - * @param string $pCellCoordinate Cell coordinate to get hyperlink for + * @param string $pCellCoordinate Cell coordinate to get hyperlink for */ public function getHyperlink($pCellCoordinate = 'A1') { @@ -2776,8 +2776,8 @@ class Worksheet implements IComparable /** * Set hyperlnk. * - * @param string $pCellCoordinate Cell coordinate to insert hyperlink - * @param Cell\Hyperlink $pHyperlink + * @param string $pCellCoordinate Cell coordinate to insert hyperlink + * @param Cell\Hyperlink $pHyperlink * * @return Worksheet */ @@ -2835,8 +2835,8 @@ class Worksheet implements IComparable /** * Set data validation. * - * @param string $pCellCoordinate Cell coordinate to insert data validation - * @param Cell\DataValidation $pDataValidation + * @param string $pCellCoordinate Cell coordinate to insert data validation + * @param Cell\DataValidation $pDataValidation * * @return Worksheet */ diff --git a/src/PhpSpreadsheet/Worksheet/AutoFilter.php b/src/PhpSpreadsheet/Worksheet/AutoFilter.php index 68e341d8..fd9904c8 100644 --- a/src/PhpSpreadsheet/Worksheet/AutoFilter.php +++ b/src/PhpSpreadsheet/Worksheet/AutoFilter.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Worksheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -50,8 +50,8 @@ class AutoFilter /** * Create a new AutoFilter. * - * @param string $pRange Cell range (i.e. A1:E10) - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet + * @param string $pRange Cell range (i.e. A1:E10) + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet */ public function __construct($pRange = '', \PhpOffice\PhpSpreadsheet\Worksheet $pSheet = null) { @@ -72,7 +72,7 @@ class AutoFilter /** * Set AutoFilter Parent Worksheet. * - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet * * @return AutoFilter */ @@ -94,13 +94,13 @@ class AutoFilter } /** - * Set AutoFilter Range. + * Set AutoFilter Range. * - * @param string $pRange Cell range (i.e. A1:E10) + * @param string $pRange Cell range (i.e. A1:E10) * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return AutoFilter + * @return AutoFilter */ public function setRange($pRange = '') { @@ -138,7 +138,7 @@ class AutoFilter /** * Get all AutoFilter Columns. * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * * @return AutoFilter\Column[] */ @@ -150,11 +150,11 @@ class AutoFilter /** * Validate that the specified column is in the AutoFilter range. * - * @param string $column Column name (e.g. A) + * @param string $column Column name (e.g. A) * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return int The column offset within the autofilter range + * @return int The column offset within the autofilter range */ public function testColumnInRange($column) { @@ -174,11 +174,11 @@ class AutoFilter /** * Get a specified AutoFilter Column Offset within the defined AutoFilter range. * - * @param string $pColumn Column name (e.g. A) + * @param string $pColumn Column name (e.g. A) * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return int The offset of the specified column within the autofilter range + * @return int The offset of the specified column within the autofilter range */ public function getColumnOffset($pColumn) { @@ -188,11 +188,11 @@ class AutoFilter /** * Get a specified AutoFilter Column. * - * @param string $pColumn Column name (e.g. A) + * @param string $pColumn Column name (e.g. A) * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return AutoFilter\Column + * @return AutoFilter\Column */ public function getColumn($pColumn) { @@ -208,11 +208,11 @@ class AutoFilter /** * Get a specified AutoFilter Column by it's offset. * - * @param int $pColumnOffset Column offset within range (starting from 0) + * @param int $pColumnOffset Column offset within range (starting from 0) * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return AutoFilter\Column + * @return AutoFilter\Column */ public function getColumnByOffset($pColumnOffset = 0) { @@ -223,14 +223,14 @@ class AutoFilter } /** - * Set AutoFilter. + * Set AutoFilter. * - * @param AutoFilter\Column|string $pColumn + * @param AutoFilter\Column|string $pColumn * A simple string containing a Column ID like 'A' is permitted * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return AutoFilter + * @return AutoFilter */ public function setColumn($pColumn) { @@ -257,11 +257,11 @@ class AutoFilter /** * Clear a specified AutoFilter Column. * - * @param string $pColumn Column name (e.g. A) + * @param string $pColumn Column name (e.g. A) * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return AutoFilter + * @return AutoFilter */ public function clearColumn($pColumn) { @@ -275,16 +275,16 @@ class AutoFilter } /** - * Shift an AutoFilter Column Rule to a different column. + * Shift an AutoFilter Column Rule to a different column. * - * Note: This method bypasses validation of the destination column to ensure it is within this AutoFilter range. + * Note: This method bypasses validation of the destination column to ensure it is within this AutoFilter range. * Nor does it verify whether any column rule already exists at $toColumn, but will simply overrideany existing value. * Use with caution. * - * @param string $fromColumn Column name (e.g. A) - * @param string $toColumn Column name (e.g. B) + * @param string $fromColumn Column name (e.g. A) + * @param string $toColumn Column name (e.g. B) * - * @return AutoFilter + * @return AutoFilter */ public function shiftColumn($fromColumn = null, $toColumn = null) { @@ -305,12 +305,12 @@ class AutoFilter } /** - * Test if cell value is in the defined set of values. + * Test if cell value is in the defined set of values. * - * @param mixed $cellValue - * @param mixed[] $dataSet + * @param mixed $cellValue + * @param mixed[] $dataSet * - * @return bool + * @return bool */ private static function filterTestInSimpleDataSet($cellValue, $dataSet) { @@ -324,12 +324,12 @@ class AutoFilter } /** - * Test if cell value is in the defined set of Excel date values. + * Test if cell value is in the defined set of Excel date values. * - * @param mixed $cellValue - * @param mixed[] $dataSet + * @param mixed $cellValue + * @param mixed[] $dataSet * - * @return bool + * @return bool */ private static function filterTestInDateGroupSet($cellValue, $dataSet) { @@ -366,12 +366,12 @@ class AutoFilter } /** - * Test if cell value is within a set of values defined by a ruleset. + * Test if cell value is within a set of values defined by a ruleset. * - * @param mixed $cellValue - * @param mixed[] $ruleSet + * @param mixed $cellValue + * @param mixed[] $ruleSet * - * @return bool + * @return bool */ private static function filterTestInCustomDataSet($cellValue, $ruleSet) { @@ -445,12 +445,12 @@ class AutoFilter } /** - * Test if cell date value is matches a set of values defined by a set of months. + * Test if cell date value is matches a set of values defined by a set of months. * - * @param mixed $cellValue - * @param mixed[] $monthSet + * @param mixed $cellValue + * @param mixed[] $monthSet * - * @return bool + * @return bool */ private static function filterTestInPeriodDateSet($cellValue, $monthSet) { @@ -470,20 +470,20 @@ class AutoFilter } /** - * Search/Replace arrays to convert Excel wildcard syntax to a regexp syntax for preg_matching. + * Search/Replace arrays to convert Excel wildcard syntax to a regexp syntax for preg_matching. * - * @var array + * @var array */ private static $fromReplace = ['\*', '\?', '~~', '~.*', '~.?']; private static $toReplace = ['.*', '.', '~', '\*', '\?']; /** - * Convert a dynamic rule daterange to a custom filter range expression for ease of calculation. + * Convert a dynamic rule daterange to a custom filter range expression for ease of calculation. * - * @param string $dynamicRuleType - * @param AutoFilter\Column $filterColumn + * @param string $dynamicRuleType + * @param AutoFilter\Column $filterColumn * - * @return mixed[] + * @return mixed[] */ private function dynamicFilterDateRange($dynamicRuleType, &$filterColumn) { @@ -603,11 +603,11 @@ class AutoFilter } /** - * Apply the AutoFilter rules to the AutoFilter Range. + * Apply the AutoFilter rules to the AutoFilter Range. * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return AutoFilter + * @return AutoFilter */ public function showHideRows() { @@ -847,7 +847,7 @@ class AutoFilter /** * toString method replicates previous behavior by returning the range if object is - * referenced as a property of its parent. + * referenced as a property of its parent. */ public function __toString() { diff --git a/src/PhpSpreadsheet/Worksheet/AutoFilter/Column.php b/src/PhpSpreadsheet/Worksheet/AutoFilter/Column.php index b6cdcd11..b5c0fbaa 100644 --- a/src/PhpSpreadsheet/Worksheet/AutoFilter/Column.php +++ b/src/PhpSpreadsheet/Worksheet/AutoFilter/Column.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -110,8 +110,8 @@ class Column /** * Create a new Column. * - * @param string $pColumn Column (e.g. A) - * @param \PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter $pParent Autofilter for this column + * @param string $pColumn Column (e.g. A) + * @param \PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter $pParent Autofilter for this column */ public function __construct($pColumn, \PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter $pParent = null) { @@ -130,13 +130,13 @@ class Column } /** - * Set AutoFilter Column Index. + * Set AutoFilter Column Index. * - * @param string $pColumn Column (e.g. A) + * @param string $pColumn Column (e.g. A) * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return Column + * @return Column */ public function setColumnIndex($pColumn) { @@ -186,13 +186,13 @@ class Column } /** - * Set AutoFilter Type. + * Set AutoFilter Type. * - * @param string $pFilterType + * @param string $pFilterType * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return Column + * @return Column */ public function setFilterType($pFilterType = self::AUTOFILTER_FILTERTYPE_FILTER) { @@ -216,13 +216,13 @@ class Column } /** - * Set AutoFilter Multiple Rules And/Or. + * Set AutoFilter Multiple Rules And/Or. * - * @param string $pJoin And/Or + * @param string $pJoin And/Or * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return Column + * @return Column */ public function setJoin($pJoin = self::AUTOFILTER_COLUMN_JOIN_OR) { @@ -238,13 +238,13 @@ class Column } /** - * Set AutoFilter Attributes. + * Set AutoFilter Attributes. * - * @param string[] $pAttributes + * @param string[] $pAttributes * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return Column + * @return Column */ public function setAttributes($pAttributes = []) { @@ -254,14 +254,14 @@ class Column } /** - * Set An AutoFilter Attribute. + * Set An AutoFilter Attribute. * - * @param string $pName Attribute Name - * @param string $pValue Attribute Value + * @param string $pName Attribute Name + * @param string $pValue Attribute Value * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return Column + * @return Column */ public function setAttribute($pName, $pValue) { @@ -283,7 +283,7 @@ class Column /** * Get specific AutoFilter Column Attribute. * - * @param string $pName Attribute Name + * @param string $pName Attribute Name * * @return string */ @@ -299,9 +299,9 @@ class Column /** * Get all AutoFilter Column Rules. * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return Column\Rule[] + * @return Column\Rule[] */ public function getRules() { @@ -311,9 +311,9 @@ class Column /** * Get a specified AutoFilter Column Rule. * - * @param int $pIndex Rule index in the ruleset array + * @param int $pIndex Rule index in the ruleset array * - * @return Column\Rule + * @return Column\Rule */ public function getRule($pIndex) { @@ -327,7 +327,7 @@ class Column /** * Create a new AutoFilter Column Rule in the ruleset. * - * @return Column\Rule + * @return Column\Rule */ public function createRule() { @@ -339,10 +339,10 @@ class Column /** * Add a new AutoFilter Column Rule to the ruleset. * - * @param Column\Rule $pRule - * @param bool $returnRule Flag indicating whether the rule object or the column object should be returned + * @param Column\Rule $pRule + * @param bool $returnRule Flag indicating whether the rule object or the column object should be returned * - * @return Column|Column\Rule + * @return Column|Column\Rule */ public function addRule(Column\Rule $pRule, $returnRule = true) { @@ -354,11 +354,11 @@ class Column /** * Delete a specified AutoFilter Column Rule - * If the number of rules is reduced to 1, then we reset And/Or logic to Or. + * If the number of rules is reduced to 1, then we reset And/Or logic to Or. * - * @param int $pIndex Rule index in the ruleset array + * @param int $pIndex Rule index in the ruleset array * - * @return Column + * @return Column */ public function deleteRule($pIndex) { @@ -376,7 +376,7 @@ class Column /** * Delete all AutoFilter Column Rules. * - * @return Column + * @return Column */ public function clearRules() { diff --git a/src/PhpSpreadsheet/Worksheet/AutoFilter/Column/Rule.php b/src/PhpSpreadsheet/Worksheet/AutoFilter/Column/Rule.php index 6220a5e1..f9daee1e 100644 --- a/src/PhpSpreadsheet/Worksheet/AutoFilter/Column/Rule.php +++ b/src/PhpSpreadsheet/Worksheet/AutoFilter/Column/Rule.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -275,13 +275,13 @@ class Rule } /** - * Set AutoFilter Rule Type. + * Set AutoFilter Rule Type. * - * @param string $pRuleType + * @param string $pRuleType * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return Rule + * @return Rule */ public function setRuleType($pRuleType = self::AUTOFILTER_RULETYPE_FILTER) { @@ -305,13 +305,13 @@ class Rule } /** - * Set AutoFilter Rule Value. + * Set AutoFilter Rule Value. * - * @param string|string[] $pValue + * @param string|string[] $pValue * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return Rule + * @return Rule */ public function setValue($pValue = '') { @@ -349,13 +349,13 @@ class Rule } /** - * Set AutoFilter Rule Operator. + * Set AutoFilter Rule Operator. * - * @param string $pOperator + * @param string $pOperator * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return Rule + * @return Rule */ public function setOperator($pOperator = self::AUTOFILTER_COLUMN_RULE_EQUAL) { @@ -382,13 +382,13 @@ class Rule } /** - * Set AutoFilter Rule Grouping. + * Set AutoFilter Rule Grouping. * - * @param string $pGrouping + * @param string $pGrouping * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return Rule + * @return Rule */ public function setGrouping($pGrouping = null) { @@ -404,15 +404,15 @@ class Rule } /** - * Set AutoFilter Rule. + * Set AutoFilter Rule. * - * @param string $pOperator - * @param string|string[] $pValue - * @param string $pGrouping + * @param string $pOperator + * @param string|string[] $pValue + * @param string $pGrouping * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return Rule + * @return Rule */ public function setRule($pOperator = self::AUTOFILTER_COLUMN_RULE_EQUAL, $pValue = '', $pGrouping = null) { @@ -441,7 +441,7 @@ class Rule /** * Set this Rule's AutoFilter Column Parent. * - * @param \PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column + * @param \PhpOffice\PhpSpreadsheet\Worksheet\AutoFilter\Column * * @return Rule */ diff --git a/src/PhpSpreadsheet/Worksheet/BaseDrawing.php b/src/PhpSpreadsheet/Worksheet/BaseDrawing.php index 174d7569..dbf75f24 100644 --- a/src/PhpSpreadsheet/Worksheet/BaseDrawing.php +++ b/src/PhpSpreadsheet/Worksheet/BaseDrawing.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Worksheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -210,12 +210,12 @@ class BaseDrawing implements \PhpOffice\PhpSpreadsheet\IComparable /** * Set Worksheet. * - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pValue - * @param bool $pOverrideOld If a Worksheet has already been assigned, overwrite it and remove image from old Worksheet? + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pValue + * @param bool $pOverrideOld If a Worksheet has already been assigned, overwrite it and remove image from old Worksheet? * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return BaseDrawing + * @return BaseDrawing */ public function setWorksheet(\PhpOffice\PhpSpreadsheet\Worksheet $pValue = null, $pOverrideOld = false) { @@ -477,11 +477,11 @@ class BaseDrawing implements \PhpOffice\PhpSpreadsheet\IComparable /** * Set Shadow. * - * @param Drawing\Shadow $pValue + * @param Drawing\Shadow $pValue * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return BaseDrawing + * @return BaseDrawing */ public function setShadow(Drawing\Shadow $pValue = null) { @@ -493,7 +493,7 @@ class BaseDrawing implements \PhpOffice\PhpSpreadsheet\IComparable /** * Get hash code. * - * @return string Hash code + * @return string Hash code */ public function getHashCode() { diff --git a/src/PhpSpreadsheet/Worksheet/CellIterator.php b/src/PhpSpreadsheet/Worksheet/CellIterator.php index 8f914693..9dced6b3 100644 --- a/src/PhpSpreadsheet/Worksheet/CellIterator.php +++ b/src/PhpSpreadsheet/Worksheet/CellIterator.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Worksheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -75,7 +75,7 @@ abstract class CellIterator /** * Set the iterator to loop only existing cells. * - * @param bool $value + * @param bool $value * * @throws \PhpOffice\PhpSpreadsheet\Exception */ diff --git a/src/PhpSpreadsheet/Worksheet/Column.php b/src/PhpSpreadsheet/Worksheet/Column.php index 429a3e3e..d1e40750 100644 --- a/src/PhpSpreadsheet/Worksheet/Column.php +++ b/src/PhpSpreadsheet/Worksheet/Column.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Worksheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -43,8 +43,8 @@ class Column /** * Create a new column. * - * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent - * @param string $columnIndex + * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent + * @param string $columnIndex */ public function __construct(\PhpOffice\PhpSpreadsheet\Worksheet $parent = null, $columnIndex = 'A') { @@ -74,8 +74,8 @@ class Column /** * Get cell iterator. * - * @param int $startRow The row number at which to start iterating - * @param int $endRow Optionally, the row number at which to stop iterating + * @param int $startRow The row number at which to start iterating + * @param int $endRow Optionally, the row number at which to stop iterating * * @return ColumnCellIterator */ diff --git a/src/PhpSpreadsheet/Worksheet/ColumnCellIterator.php b/src/PhpSpreadsheet/Worksheet/ColumnCellIterator.php index a7a0239a..8fcef2fb 100644 --- a/src/PhpSpreadsheet/Worksheet/ColumnCellIterator.php +++ b/src/PhpSpreadsheet/Worksheet/ColumnCellIterator.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Worksheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -50,10 +50,10 @@ class ColumnCellIterator extends CellIterator implements \Iterator /** * Create a new row iterator. * - * @param \PhpOffice\PhpSpreadsheet\Worksheet $subject The worksheet to iterate over - * @param string $columnIndex The column that we want to iterate - * @param int $startRow The row number at which to start iterating - * @param int $endRow Optionally, the row number at which to stop iterating + * @param \PhpOffice\PhpSpreadsheet\Worksheet $subject The worksheet to iterate over + * @param string $columnIndex The column that we want to iterate + * @param int $startRow The row number at which to start iterating + * @param int $endRow Optionally, the row number at which to stop iterating */ public function __construct(\PhpOffice\PhpSpreadsheet\Worksheet $subject = null, $columnIndex = 'A', $startRow = 1, $endRow = null) { @@ -75,7 +75,7 @@ class ColumnCellIterator extends CellIterator implements \Iterator /** * (Re)Set the start row and the current row pointer. * - * @param int $startRow The row number at which to start iterating + * @param int $startRow The row number at which to start iterating * * @throws \PhpOffice\PhpSpreadsheet\Exception * @@ -93,7 +93,7 @@ class ColumnCellIterator extends CellIterator implements \Iterator /** * (Re)Set the end row. * - * @param int $endRow The row number at which to stop iterating + * @param int $endRow The row number at which to stop iterating * * @throws \PhpOffice\PhpSpreadsheet\Exception * @@ -110,7 +110,7 @@ class ColumnCellIterator extends CellIterator implements \Iterator /** * Set the row pointer to the selected row. * - * @param int $row The row number to set the current pointer at + * @param int $row The row number to set the current pointer at * * @throws \PhpOffice\PhpSpreadsheet\Exception * diff --git a/src/PhpSpreadsheet/Worksheet/ColumnDimension.php b/src/PhpSpreadsheet/Worksheet/ColumnDimension.php index 472684c5..7aa214de 100644 --- a/src/PhpSpreadsheet/Worksheet/ColumnDimension.php +++ b/src/PhpSpreadsheet/Worksheet/ColumnDimension.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Worksheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * diff --git a/src/PhpSpreadsheet/Worksheet/ColumnIterator.php b/src/PhpSpreadsheet/Worksheet/ColumnIterator.php index 2814add7..9dfc6db9 100644 --- a/src/PhpSpreadsheet/Worksheet/ColumnIterator.php +++ b/src/PhpSpreadsheet/Worksheet/ColumnIterator.php @@ -15,12 +15,12 @@ use PhpOffice\PhpSpreadsheet\Exception; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -60,9 +60,9 @@ class ColumnIterator implements \Iterator /** * Create a new column iterator. * - * @param \PhpOffice\PhpSpreadsheet\Worksheet $subject The worksheet to iterate over - * @param string $startColumn The column address at which to start iterating - * @param string $endColumn Optionally, the column address at which to stop iterating + * @param \PhpOffice\PhpSpreadsheet\Worksheet $subject The worksheet to iterate over + * @param string $startColumn The column address at which to start iterating + * @param string $endColumn Optionally, the column address at which to stop iterating */ public function __construct(\PhpOffice\PhpSpreadsheet\Worksheet $subject, $startColumn = 'A', $endColumn = null) { @@ -83,7 +83,7 @@ class ColumnIterator implements \Iterator /** * (Re)Set the start column and the current column pointer. * - * @param int $startColumn The column address at which to start iterating + * @param int $startColumn The column address at which to start iterating * * @throws Exception * @@ -108,7 +108,7 @@ class ColumnIterator implements \Iterator /** * (Re)Set the end column. * - * @param string $endColumn The column address at which to stop iterating + * @param string $endColumn The column address at which to stop iterating * * @return ColumnIterator */ @@ -123,11 +123,11 @@ class ColumnIterator implements \Iterator /** * Set the column pointer to the selected column. * - * @param string $column The column address to set the current pointer at + * @param string $column The column address to set the current pointer at * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return ColumnIterator + * @return ColumnIterator */ public function seek($column = 'A') { diff --git a/src/PhpSpreadsheet/Worksheet/Dimension.php b/src/PhpSpreadsheet/Worksheet/Dimension.php index da06a66c..41493985 100644 --- a/src/PhpSpreadsheet/Worksheet/Dimension.php +++ b/src/PhpSpreadsheet/Worksheet/Dimension.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Worksheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -104,7 +104,7 @@ abstract class Dimension * * Value must be between 0 and 7 * - * @param int $pValue + * @param int $pValue * * @throws \PhpOffice\PhpSpreadsheet\Exception * @@ -134,7 +134,7 @@ abstract class Dimension /** * Set Collapsed. * - * @param bool $pValue + * @param bool $pValue * * @return Dimension */ @@ -158,7 +158,7 @@ abstract class Dimension /** * Set index to cellXf. * - * @param int $pValue + * @param int $pValue * * @return Dimension */ diff --git a/src/PhpSpreadsheet/Worksheet/Drawing.php b/src/PhpSpreadsheet/Worksheet/Drawing.php index 0c2bfe29..26d40f9e 100644 --- a/src/PhpSpreadsheet/Worksheet/Drawing.php +++ b/src/PhpSpreadsheet/Worksheet/Drawing.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Worksheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -93,12 +93,12 @@ class Drawing extends BaseDrawing implements \PhpOffice\PhpSpreadsheet\IComparab /** * Set Path. * - * @param string $pValue File path - * @param bool $pVerifyFile Verify file + * @param string $pValue File path + * @param bool $pVerifyFile Verify file * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return Drawing + * @return Drawing */ public function setPath($pValue = '', $pVerifyFile = true) { @@ -123,7 +123,7 @@ class Drawing extends BaseDrawing implements \PhpOffice\PhpSpreadsheet\IComparab /** * Get hash code. * - * @return string Hash code + * @return string Hash code */ public function getHashCode() { diff --git a/src/PhpSpreadsheet/Worksheet/Drawing/Shadow.php b/src/PhpSpreadsheet/Worksheet/Drawing/Shadow.php index 38c6878e..644fe708 100644 --- a/src/PhpSpreadsheet/Worksheet/Drawing/Shadow.php +++ b/src/PhpSpreadsheet/Worksheet/Drawing/Shadow.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Worksheet\Drawing; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -237,11 +237,11 @@ class Shadow implements \PhpOffice\PhpSpreadsheet\IComparable /** * Set Color. * - * @param \PhpOffice\PhpSpreadsheet\Style\Color $pValue + * @param \PhpOffice\PhpSpreadsheet\Style\Color $pValue * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return Shadow + * @return Shadow */ public function setColor(\PhpOffice\PhpSpreadsheet\Style\Color $pValue = null) { @@ -277,7 +277,7 @@ class Shadow implements \PhpOffice\PhpSpreadsheet\IComparable /** * Get hash code. * - * @return string Hash code + * @return string Hash code */ public function getHashCode() { diff --git a/src/PhpSpreadsheet/Worksheet/HeaderFooter.php b/src/PhpSpreadsheet/Worksheet/HeaderFooter.php index b8ad3ccf..a8f5cf65 100644 --- a/src/PhpSpreadsheet/Worksheet/HeaderFooter.php +++ b/src/PhpSpreadsheet/Worksheet/HeaderFooter.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Worksheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not,241 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 * @@ -191,9 +191,9 @@ class HeaderFooter /** * Set OddHeader. * - * @param string $pValue + * @param string $pValue * - * @return HeaderFooter + * @return HeaderFooter */ public function setOddHeader($pValue) { @@ -215,9 +215,9 @@ class HeaderFooter /** * Set OddFooter. * - * @param string $pValue + * @param string $pValue * - * @return HeaderFooter + * @return HeaderFooter */ public function setOddFooter($pValue) { @@ -239,9 +239,9 @@ class HeaderFooter /** * Set EvenHeader. * - * @param string $pValue + * @param string $pValue * - * @return HeaderFooter + * @return HeaderFooter */ public function setEvenHeader($pValue) { @@ -263,9 +263,9 @@ class HeaderFooter /** * Set EvenFooter. * - * @param string $pValue + * @param string $pValue * - * @return HeaderFooter + * @return HeaderFooter */ public function setEvenFooter($pValue) { @@ -287,9 +287,9 @@ class HeaderFooter /** * Set FirstHeader. * - * @param string $pValue + * @param string $pValue * - * @return HeaderFooter + * @return HeaderFooter */ public function setFirstHeader($pValue) { @@ -421,12 +421,12 @@ class HeaderFooter /** * Add header/footer image. * - * @param HeaderFooterDrawing $image - * @param string $location + * @param HeaderFooterDrawing $image + * @param string $location * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return HeaderFooter + * @return HeaderFooter */ public function addImage(HeaderFooterDrawing $image = null, $location = self::IMAGE_HEADER_LEFT) { @@ -456,7 +456,7 @@ class HeaderFooter /** * Set header/footer images. * - * @param HeaderFooterDrawing[] $images + * @param HeaderFooterDrawing[] $images * * @throws \PhpOffice\PhpSpreadsheet\Exception * diff --git a/src/PhpSpreadsheet/Worksheet/HeaderFooterDrawing.php b/src/PhpSpreadsheet/Worksheet/HeaderFooterDrawing.php index c684b90e..57a888b2 100644 --- a/src/PhpSpreadsheet/Worksheet/HeaderFooterDrawing.php +++ b/src/PhpSpreadsheet/Worksheet/HeaderFooterDrawing.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Worksheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -315,12 +315,12 @@ class HeaderFooterDrawing extends Drawing implements \PhpOffice\PhpSpreadsheet\I /** * Set Path. * - * @param string $pValue File path - * @param bool $pVerifyFile Verify file + * @param string $pValue File path + * @param bool $pVerifyFile Verify file * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return HeaderFooterDrawing + * @return HeaderFooterDrawing */ public function setPath($pValue = '', $pVerifyFile = true) { @@ -345,7 +345,7 @@ class HeaderFooterDrawing extends Drawing implements \PhpOffice\PhpSpreadsheet\I /** * Get hash code. * - * @return string Hash code + * @return string Hash code */ public function getHashCode() { diff --git a/src/PhpSpreadsheet/Worksheet/Iterator.php b/src/PhpSpreadsheet/Worksheet/Iterator.php index 03fe44f8..c7cdbc19 100644 --- a/src/PhpSpreadsheet/Worksheet/Iterator.php +++ b/src/PhpSpreadsheet/Worksheet/Iterator.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Worksheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -43,7 +43,7 @@ class Iterator implements \Iterator /** * Create a new worksheet iterator. * - * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $subject + * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $subject */ public function __construct(\PhpOffice\PhpSpreadsheet\Spreadsheet $subject = null) { diff --git a/src/PhpSpreadsheet/Worksheet/MemoryDrawing.php b/src/PhpSpreadsheet/Worksheet/MemoryDrawing.php index 5267d72c..130f0129 100644 --- a/src/PhpSpreadsheet/Worksheet/MemoryDrawing.php +++ b/src/PhpSpreadsheet/Worksheet/MemoryDrawing.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Worksheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -94,7 +94,7 @@ class MemoryDrawing extends BaseDrawing implements \PhpOffice\PhpSpreadsheet\ICo /** * Set image resource. * - * @param $value resource + * @param $value resource * * @return MemoryDrawing */ @@ -176,7 +176,7 @@ class MemoryDrawing extends BaseDrawing implements \PhpOffice\PhpSpreadsheet\ICo /** * Get hash code. * - * @return string Hash code + * @return string Hash code */ public function getHashCode() { diff --git a/src/PhpSpreadsheet/Worksheet/PageMargins.php b/src/PhpSpreadsheet/Worksheet/PageMargins.php index 9aa51665..2f8f0411 100644 --- a/src/PhpSpreadsheet/Worksheet/PageMargins.php +++ b/src/PhpSpreadsheet/Worksheet/PageMargins.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Worksheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * diff --git a/src/PhpSpreadsheet/Worksheet/PageSetup.php b/src/PhpSpreadsheet/Worksheet/PageSetup.php index 6503afde..41a1a22e 100644 --- a/src/PhpSpreadsheet/Worksheet/PageSetup.php +++ b/src/PhpSpreadsheet/Worksheet/PageSetup.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Worksheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -339,10 +339,10 @@ class PageSetup * Print scaling. Valid values range from 10 to 400 * This setting is overridden when fitToWidth and/or fitToHeight are in use * - * @param int? $pValue - * @param bool $pUpdate Update fitToPage so scaling applies rather than fitToHeight / fitToWidth + * @param int? $pValue + * @param bool $pUpdate Update fitToPage so scaling applies rather than fitToHeight / fitToWidth * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * * @return PageSetup */ @@ -528,7 +528,7 @@ class PageSetup /** * Set Rows to repeat at top. * - * @param array $pValue Containing start column and end column, empty array if option unset + * @param array $pValue Containing start column and end column, empty array if option unset * * @return PageSetup */ @@ -605,16 +605,16 @@ class PageSetup } /** - * Get print area. + * Get print area. * - * @param int $index Identifier for a specific print area range if several ranges have been set + * @param int $index Identifier for a specific print area range if several ranges have been set * Default behaviour, or a index value of 0, will return all ranges as a comma-separated string * Otherwise, the specific range identified by the value of $index will be returned * Print areas are numbered from 1 * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return string + * @return string */ public function getPrintArea($index = 0) { @@ -631,12 +631,12 @@ class PageSetup /** * Is print area set? * - * @param int $index Identifier for a specific print area range if several ranges have been set + * @param int $index Identifier for a specific print area range if several ranges have been set * Default behaviour, or an index value of 0, will identify whether any print range is set * Otherwise, existence of the range identified by the value of $index will be returned * Print areas are numbered from 1 * - * @return bool + * @return bool */ public function isPrintAreaSet($index = 0) { @@ -651,12 +651,12 @@ class PageSetup /** * Clear a print area. * - * @param int $index Identifier for a specific print area range if several ranges have been set + * @param int $index Identifier for a specific print area range if several ranges have been set * Default behaviour, or an index value of 0, will clear all print ranges that are set * Otherwise, the range identified by the value of $index will be removed from the series * Print areas are numbered from 1 * - * @return PageSetup + * @return PageSetup */ public function clearPrintArea($index = 0) { @@ -676,8 +676,8 @@ class PageSetup /** * Set print area. e.g. 'A1:D10' or 'A1:D10,G5:M20'. * - * @param string $value - * @param int $index Identifier for a specific print area range allowing several ranges to be set + * @param string $value + * @param int $index Identifier for a specific print area range allowing several ranges to be set * When the method is "O"verwrite, then a positive integer index will overwrite that indexed * entry in the print areas list; a negative index value will identify which entry to * overwrite working bacward through the print area to the list, with the last entry as -1. @@ -687,13 +687,13 @@ class PageSetup * Specifying an index value of 0, will always append the new print range at the end of the * list. * Print areas are numbered from 1 - * @param string $method Determines the method used when setting multiple print areas + * @param string $method Determines the method used when setting multiple print areas * Default behaviour, or the "O" method, overwrites existing print area * The "I" method, inserts the new print area before any specified index, or at the end of the list * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return PageSetup + * @return PageSetup */ public function setPrintArea($value, $index = 0, $method = self::SETPRINTRANGE_OVERWRITE) { @@ -744,17 +744,17 @@ class PageSetup /** * Add a new print area (e.g. 'A1:D10' or 'A1:D10,G5:M20') to the list of print areas. * - * @param string $value - * @param int $index Identifier for a specific print area range allowing several ranges to be set + * @param string $value + * @param int $index Identifier for a specific print area range allowing several ranges to be set * A positive index will insert after that indexed entry in the print areas list, while a * negative index will insert before the indexed entry. * Specifying an index value of 0, will always append the new print range at the end of the * list. * Print areas are numbered from 1 * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return PageSetup + * @return PageSetup */ public function addPrintArea($value, $index = -1) { @@ -764,11 +764,11 @@ class PageSetup /** * Set print area. * - * @param int $column1 Column 1 - * @param int $row1 Row 1 - * @param int $column2 Column 2 - * @param int $row2 Row 2 - * @param int $index Identifier for a specific print area range allowing several ranges to be set + * @param int $column1 Column 1 + * @param int $row1 Row 1 + * @param int $column2 Column 2 + * @param int $row2 Row 2 + * @param int $index Identifier for a specific print area range allowing several ranges to be set * When the method is "O"verwrite, then a positive integer index will overwrite that indexed * entry in the print areas list; a negative index value will identify which entry to * overwrite working bacward through the print area to the list, with the last entry as -1. @@ -778,13 +778,13 @@ class PageSetup * Specifying an index value of 0, will always append the new print range at the end of the * list. * Print areas are numbered from 1 - * @param string $method Determines the method used when setting multiple print areas + * @param string $method Determines the method used when setting multiple print areas * Default behaviour, or the "O" method, overwrites existing print area * The "I" method, inserts the new print area before any specified index, or at the end of the list * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return PageSetup + * @return PageSetup */ public function setPrintAreaByColumnAndRow($column1, $row1, $column2, $row2, $index = 0, $method = self::SETPRINTRANGE_OVERWRITE) { @@ -798,20 +798,20 @@ class PageSetup /** * Add a new print area to the list of print areas. * - * @param int $column1 Start Column for the print area - * @param int $row1 Start Row for the print area - * @param int $column2 End Column for the print area - * @param int $row2 End Row for the print area - * @param int $index Identifier for a specific print area range allowing several ranges to be set + * @param int $column1 Start Column for the print area + * @param int $row1 Start Row for the print area + * @param int $column2 End Column for the print area + * @param int $row2 End Row for the print area + * @param int $index Identifier for a specific print area range allowing several ranges to be set * A positive index will insert after that indexed entry in the print areas list, while a * negative index will insert before the indexed entry. * Specifying an index value of 0, will always append the new print range at the end of the * list. * Print areas are numbered from 1 * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return PageSetup + * @return PageSetup */ public function addPrintAreaByColumnAndRow($column1, $row1, $column2, $row2, $index = -1) { diff --git a/src/PhpSpreadsheet/Worksheet/Protection.php b/src/PhpSpreadsheet/Worksheet/Protection.php index f619cf59..cda264ee 100644 --- a/src/PhpSpreadsheet/Worksheet/Protection.php +++ b/src/PhpSpreadsheet/Worksheet/Protection.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Worksheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -574,8 +574,8 @@ class Protection /** * Set Password. * - * @param string $pValue - * @param bool $pAlreadyHashed If the password has already been hashed, set this to true + * @param string $pValue + * @param bool $pAlreadyHashed If the password has already been hashed, set this to true * * @return Protection */ diff --git a/src/PhpSpreadsheet/Worksheet/Row.php b/src/PhpSpreadsheet/Worksheet/Row.php index d8c2fd81..5e565980 100644 --- a/src/PhpSpreadsheet/Worksheet/Row.php +++ b/src/PhpSpreadsheet/Worksheet/Row.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Worksheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -43,8 +43,8 @@ class Row /** * Create a new row. * - * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent - * @param int $rowIndex + * @param \PhpOffice\PhpSpreadsheet\Worksheet $parent + * @param int $rowIndex */ public function __construct(\PhpOffice\PhpSpreadsheet\Worksheet $worksheet = null, $rowIndex = 1) { @@ -74,8 +74,8 @@ class Row /** * Get cell iterator. * - * @param string $startColumn The column address at which to start iterating - * @param string $endColumn Optionally, the column address at which to stop iterating + * @param string $startColumn The column address at which to start iterating + * @param string $endColumn Optionally, the column address at which to stop iterating * * @return RowCellIterator */ diff --git a/src/PhpSpreadsheet/Worksheet/RowCellIterator.php b/src/PhpSpreadsheet/Worksheet/RowCellIterator.php index 813e708d..8ae0eb63 100644 --- a/src/PhpSpreadsheet/Worksheet/RowCellIterator.php +++ b/src/PhpSpreadsheet/Worksheet/RowCellIterator.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Worksheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -50,10 +50,10 @@ class RowCellIterator extends CellIterator implements \Iterator /** * Create a new column iterator. * - * @param \PhpOffice\PhpSpreadsheet\Worksheet $subject The worksheet to iterate over - * @param int $rowIndex The row that we want to iterate - * @param string $startColumn The column address at which to start iterating - * @param string $endColumn Optionally, the column address at which to stop iterating + * @param \PhpOffice\PhpSpreadsheet\Worksheet $subject The worksheet to iterate over + * @param int $rowIndex The row that we want to iterate + * @param string $startColumn The column address at which to start iterating + * @param string $endColumn Optionally, the column address at which to stop iterating */ public function __construct(\PhpOffice\PhpSpreadsheet\Worksheet $subject = null, $rowIndex = 1, $startColumn = 'A', $endColumn = null) { @@ -75,7 +75,7 @@ class RowCellIterator extends CellIterator implements \Iterator /** * (Re)Set the start column and the current column pointer. * - * @param int $startColumn The column address at which to start iterating + * @param int $startColumn The column address at which to start iterating * * @throws \PhpOffice\PhpSpreadsheet\Exception * @@ -94,7 +94,7 @@ class RowCellIterator extends CellIterator implements \Iterator /** * (Re)Set the end column. * - * @param string $endColumn The column address at which to stop iterating + * @param string $endColumn The column address at which to stop iterating * * @throws \PhpOffice\PhpSpreadsheet\Exception * @@ -112,7 +112,7 @@ class RowCellIterator extends CellIterator implements \Iterator /** * Set the column pointer to the selected column. * - * @param string $column The column address to set the current pointer at + * @param string $column The column address to set the current pointer at * * @throws \PhpOffice\PhpSpreadsheet\Exception * diff --git a/src/PhpSpreadsheet/Worksheet/RowDimension.php b/src/PhpSpreadsheet/Worksheet/RowDimension.php index 60097dcc..d48a97bd 100644 --- a/src/PhpSpreadsheet/Worksheet/RowDimension.php +++ b/src/PhpSpreadsheet/Worksheet/RowDimension.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Worksheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * diff --git a/src/PhpSpreadsheet/Worksheet/RowIterator.php b/src/PhpSpreadsheet/Worksheet/RowIterator.php index e0077ca7..b92f8c9e 100644 --- a/src/PhpSpreadsheet/Worksheet/RowIterator.php +++ b/src/PhpSpreadsheet/Worksheet/RowIterator.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Worksheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -57,9 +57,9 @@ class RowIterator implements \Iterator /** * Create a new row iterator. * - * @param \PhpOffice\PhpSpreadsheet\Worksheet $subject The worksheet to iterate over - * @param int $startRow The row number at which to start iterating - * @param int $endRow Optionally, the row number at which to stop iterating + * @param \PhpOffice\PhpSpreadsheet\Worksheet $subject The worksheet to iterate over + * @param int $startRow The row number at which to start iterating + * @param int $endRow Optionally, the row number at which to stop iterating */ public function __construct(\PhpOffice\PhpSpreadsheet\Worksheet $subject, $startRow = 1, $endRow = null) { @@ -80,7 +80,7 @@ class RowIterator implements \Iterator /** * (Re)Set the start row and the current row pointer. * - * @param int $startRow The row number at which to start iterating + * @param int $startRow The row number at which to start iterating * * @throws \PhpOffice\PhpSpreadsheet\Exception * @@ -104,7 +104,7 @@ class RowIterator implements \Iterator /** * (Re)Set the end row. * - * @param int $endRow The row number at which to stop iterating + * @param int $endRow The row number at which to stop iterating * * @return RowIterator */ @@ -118,7 +118,7 @@ class RowIterator implements \Iterator /** * Set the row pointer to the selected row. * - * @param int $row The row number to set the current pointer at + * @param int $row The row number to set the current pointer at * * @throws \PhpOffice\PhpSpreadsheet\Exception * diff --git a/src/PhpSpreadsheet/Worksheet/SheetView.php b/src/PhpSpreadsheet/Worksheet/SheetView.php index 8ac4849f..64c60522 100644 --- a/src/PhpSpreadsheet/Worksheet/SheetView.php +++ b/src/PhpSpreadsheet/Worksheet/SheetView.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Worksheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -86,11 +86,11 @@ class SheetView * * Valid values range from 10 to 400. * - * @param int $pValue + * @param int $pValue * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return SheetView + * @return SheetView */ public function setZoomScale($pValue = 100) { @@ -120,11 +120,11 @@ class SheetView * * Valid values range from 10 to 400. * - * @param int $pValue + * @param int $pValue * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return SheetView + * @return SheetView */ public function setZoomScaleNormal($pValue = 100) { @@ -155,11 +155,11 @@ class SheetView * 'pageLayout' self::SHEETVIEW_PAGE_LAYOUT * 'pageBreakPreview' self::SHEETVIEW_PAGE_BREAK_PREVIEW * - * @param string $pValue + * @param string $pValue * - * @throws \PhpOffice\PhpSpreadsheet\Exception + * @throws \PhpOffice\PhpSpreadsheet\Exception * - * @return SheetView + * @return SheetView */ public function setView($pValue = null) { diff --git a/src/PhpSpreadsheet/Writer/BaseWriter.php b/src/PhpSpreadsheet/Writer/BaseWriter.php index 05821181..67d60017 100644 --- a/src/PhpSpreadsheet/Writer/BaseWriter.php +++ b/src/PhpSpreadsheet/Writer/BaseWriter.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -30,14 +30,14 @@ abstract class BaseWriter implements IWriter * Write charts that are defined in the workbook? * Identifies whether the Writer should write definitions for any charts that exist in the PhpSpreadsheet object;. * - * @var bool + * @var bool */ protected $includeCharts = false; /** * Pre-calculate formulas * Forces PhpSpreadsheet to recalculate all formulae in a workbook when saving, so that the pre-calculated values are - * immediately available to MS Excel or other office spreadsheet viewer when opening the file. + * immediately available to MS Excel or other office spreadsheet viewer when opening the file. * * @var bool */ @@ -62,7 +62,7 @@ abstract class BaseWriter implements IWriter * If this is true, then the Writer will write definitions for any charts that exist in the PhpSpreadsheet object. * If false (the default) it will ignore any charts defined in the PhpSpreadsheet object. * - * @return bool + * @return bool */ public function getIncludeCharts() { @@ -74,9 +74,9 @@ abstract class BaseWriter implements IWriter * Set to true, to advise the Writer to include any charts that exist in the PhpSpreadsheet object. * Set to false (the default) to ignore charts. * - * @param bool $pValue + * @param bool $pValue * - * @return IWriter + * @return IWriter */ public function setIncludeCharts($pValue = false) { @@ -105,9 +105,9 @@ abstract class BaseWriter implements IWriter * Set to true (the default) to advise the Writer to calculate all formulae on save * Set to false to prevent precalculation of formulae on save. * - * @param bool $pValue Pre-Calculate Formulas? + * @param bool $pValue Pre-Calculate Formulas? * - * @return IWriter + * @return IWriter */ public function setPreCalculateFormulas($pValue = true) { @@ -129,12 +129,12 @@ abstract class BaseWriter implements IWriter /** * Set use disk caching where possible? * - * @param bool $pValue - * @param string $pDirectory Disk caching directory + * @param bool $pValue + * @param string $pDirectory Disk caching directory * - * @throws Exception when directory does not exist + * @throws Exception when directory does not exist * - * @return IWriter + * @return IWriter */ public function setUseDiskCaching($pValue = false, $pDirectory = null) { diff --git a/src/PhpSpreadsheet/Writer/Csv.php b/src/PhpSpreadsheet/Writer/Csv.php index c40c657e..07afe03e 100644 --- a/src/PhpSpreadsheet/Writer/Csv.php +++ b/src/PhpSpreadsheet/Writer/Csv.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -86,7 +86,7 @@ class Csv extends BaseWriter implements IWriter /** * Create a new CSV. * - * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet Spreadsheet object + * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet Spreadsheet object */ public function __construct(\PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet) { @@ -96,9 +96,9 @@ class Csv extends BaseWriter implements IWriter /** * Save PhpSpreadsheet to file. * - * @param string $pFilename + * @param string $pFilename * - * @throws Exception + * @throws Exception */ public function save($pFilename = null) { @@ -164,7 +164,7 @@ class Csv extends BaseWriter implements IWriter /** * Set delimiter. * - * @param string $pValue Delimiter, defaults to , + * @param string $pValue Delimiter, defaults to , * * @return CSV */ @@ -188,7 +188,7 @@ class Csv extends BaseWriter implements IWriter /** * Set enclosure. * - * @param string $pValue Enclosure, defaults to " + * @param string $pValue Enclosure, defaults to " * * @return CSV */ @@ -215,7 +215,7 @@ class Csv extends BaseWriter implements IWriter /** * Set line ending. * - * @param string $pValue Line ending, defaults to OS line ending (PHP_EOL) + * @param string $pValue Line ending, defaults to OS line ending (PHP_EOL) * * @return CSV */ @@ -239,7 +239,7 @@ class Csv extends BaseWriter implements IWriter /** * Set whether BOM should be used. * - * @param bool $pValue Use UTF-8 byte-order mark? Defaults to false + * @param bool $pValue Use UTF-8 byte-order mark? Defaults to false * * @return CSV */ @@ -263,7 +263,7 @@ class Csv extends BaseWriter implements IWriter /** * Set whether a separator line should be included as the first line of the file. * - * @param bool $pValue Use separator line? Defaults to false + * @param bool $pValue Use separator line? Defaults to false * * @return CSV */ @@ -287,7 +287,7 @@ class Csv extends BaseWriter implements IWriter /** * Set whether the file should be saved with full Excel Compatibility. * - * @param bool $pValue Set the file to be written as a fully Excel compatible csv file + * @param bool $pValue Set the file to be written as a fully Excel compatible csv file * Note that this overrides other settings such as useBOM, enclosure and delimiter * * @return CSV @@ -312,7 +312,7 @@ class Csv extends BaseWriter implements IWriter /** * Set sheet index. * - * @param int $pValue Sheet index + * @param int $pValue Sheet index * * @return CSV */ @@ -326,10 +326,10 @@ class Csv extends BaseWriter implements IWriter /** * Write line to CSV file. * - * @param resource $pFileHandle PHP filehandle - * @param array $pValues Array containing values in a row + * @param resource $pFileHandle PHP filehandle + * @param array $pValues Array containing values in a row * - * @throws Exception + * @throws Exception */ private function writeLine($pFileHandle = null, $pValues = null) { diff --git a/src/PhpSpreadsheet/Writer/Exception.php b/src/PhpSpreadsheet/Writer/Exception.php index d36fc3f2..b0f4d618 100644 --- a/src/PhpSpreadsheet/Writer/Exception.php +++ b/src/PhpSpreadsheet/Writer/Exception.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * diff --git a/src/PhpSpreadsheet/Writer/Html.php b/src/PhpSpreadsheet/Writer/Html.php index c5335e78..4066dd9b 100644 --- a/src/PhpSpreadsheet/Writer/Html.php +++ b/src/PhpSpreadsheet/Writer/Html.php @@ -17,12 +17,12 @@ use PhpOffice\PhpSpreadsheet\Spreadsheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 Spreadsheet * @@ -132,7 +132,7 @@ class Html extends BaseWriter implements IWriter /** * Create a new HTML. * - * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet + * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet */ public function __construct(Spreadsheet $spreadsheet) { @@ -143,9 +143,9 @@ class Html extends BaseWriter implements IWriter /** * Save Spreadsheet to file. * - * @param string $pFilename + * @param string $pFilename * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ public function save($pFilename = null) { @@ -190,7 +190,7 @@ class Html extends BaseWriter implements IWriter /** * Map VAlign. * - * @param string $vAlign Vertical alignment + * @param string $vAlign Vertical alignment * * @return string */ @@ -212,7 +212,7 @@ class Html extends BaseWriter implements IWriter /** * Map HAlign. * - * @param string $hAlign Horizontal alignment + * @param string $hAlign Horizontal alignment * * @return string|false */ @@ -238,9 +238,9 @@ class Html extends BaseWriter implements IWriter /** * Map border style. * - * @param int $borderStyle Sheet index + * @param int $borderStyle Sheet index * - * @return string + * @return string */ private function mapBorderStyle($borderStyle) { @@ -292,7 +292,7 @@ class Html extends BaseWriter implements IWriter /** * Set sheet index. * - * @param int $pValue Sheet index + * @param int $pValue Sheet index * * @return HTML */ @@ -316,7 +316,7 @@ class Html extends BaseWriter implements IWriter /** * Set sheet index. * - * @param bool $pValue Flag indicating whether the sheet navigation block should be generated or not + * @param bool $pValue Flag indicating whether the sheet navigation block should be generated or not * * @return HTML */ @@ -340,11 +340,11 @@ class Html extends BaseWriter implements IWriter /** * Generate HTML header. * - * @param bool $pIncludeStyles Include styles? + * @param bool $pIncludeStyles Include styles? * * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string + * @return string */ public function generateHTMLHeader($pIncludeStyles = false) { @@ -404,7 +404,7 @@ class Html extends BaseWriter implements IWriter * * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string + * @return string */ public function generateSheetData() { @@ -524,7 +524,7 @@ class Html extends BaseWriter implements IWriter * * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string + * @return string */ public function generateNavigation() { @@ -616,12 +616,12 @@ class Html extends BaseWriter implements IWriter /** * Generate image tag in cell. * - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet \PhpOffice\PhpSpreadsheet\Worksheet - * @param string $coordinates Cell coordinates + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet \PhpOffice\PhpSpreadsheet\Worksheet + * @param string $coordinates Cell coordinates * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string + * @return string */ private function writeImageInCell(\PhpOffice\PhpSpreadsheet\Worksheet $pSheet, $coordinates) { @@ -699,12 +699,12 @@ class Html extends BaseWriter implements IWriter /** * Generate chart tag in cell. * - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet \PhpOffice\PhpSpreadsheet\Worksheet - * @param string $coordinates Cell coordinates + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet \PhpOffice\PhpSpreadsheet\Worksheet + * @param string $coordinates Cell coordinates * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string + * @return string */ private function writeChartInCell(\PhpOffice\PhpSpreadsheet\Worksheet $pSheet, $coordinates) { @@ -748,11 +748,11 @@ class Html extends BaseWriter implements IWriter /** * Generate CSS styles. * - * @param bool $generateSurroundingHTML Generate surrounding HTML tags? (<style> and </style>) + * @param bool $generateSurroundingHTML Generate surrounding HTML tags? (<style> and </style>) * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string + * @return string */ public function generateStyles($generateSurroundingHTML = true) { @@ -792,11 +792,11 @@ class Html extends BaseWriter implements IWriter /** * Build CSS styles. * - * @param bool $generateSurroundingHTML Generate surrounding HTML style? (html { }) + * @param bool $generateSurroundingHTML Generate surrounding HTML style? (html { }) * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return array + * @return array */ public function buildCSS($generateSurroundingHTML = true) { @@ -949,9 +949,9 @@ class Html extends BaseWriter implements IWriter /** * Create CSS style. * - * @param \PhpOffice\PhpSpreadsheet\Style $pStyle + * @param \PhpOffice\PhpSpreadsheet\Style $pStyle * - * @return array + * @return array */ private function createCSSStyle(\PhpOffice\PhpSpreadsheet\Style $pStyle) { @@ -973,9 +973,9 @@ class Html extends BaseWriter implements IWriter /** * Create CSS style (\PhpOffice\PhpSpreadsheet\Style\Alignment). * - * @param \PhpOffice\PhpSpreadsheet\Style\Alignment $pStyle \PhpOffice\PhpSpreadsheet\Style\Alignment + * @param \PhpOffice\PhpSpreadsheet\Style\Alignment $pStyle \PhpOffice\PhpSpreadsheet\Style\Alignment * - * @return array + * @return array */ private function createCSSStyleAlignment(\PhpOffice\PhpSpreadsheet\Style\Alignment $pStyle) { @@ -997,9 +997,9 @@ class Html extends BaseWriter implements IWriter /** * Create CSS style (\PhpOffice\PhpSpreadsheet\Style\Font). * - * @param \PhpOffice\PhpSpreadsheet\Style\Font $pStyle \PhpOffice\PhpSpreadsheet\Style\Font + * @param \PhpOffice\PhpSpreadsheet\Style\Font $pStyle \PhpOffice\PhpSpreadsheet\Style\Font * - * @return array + * @return array */ private function createCSSStyleFont(\PhpOffice\PhpSpreadsheet\Style\Font $pStyle) { @@ -1031,9 +1031,9 @@ class Html extends BaseWriter implements IWriter /** * Create CSS style (\PhpOffice\PhpSpreadsheet\Style\Borders). * - * @param \PhpOffice\PhpSpreadsheet\Style\Borders $pStyle \PhpOffice\PhpSpreadsheet\Style\Borders + * @param \PhpOffice\PhpSpreadsheet\Style\Borders $pStyle \PhpOffice\PhpSpreadsheet\Style\Borders * - * @return array + * @return array */ private function createCSSStyleBorders(\PhpOffice\PhpSpreadsheet\Style\Borders $pStyle) { @@ -1052,9 +1052,9 @@ class Html extends BaseWriter implements IWriter /** * Create CSS style (\PhpOffice\PhpSpreadsheet\Style\Border). * - * @param \PhpOffice\PhpSpreadsheet\Style\Border $pStyle \PhpOffice\PhpSpreadsheet\Style\Border + * @param \PhpOffice\PhpSpreadsheet\Style\Border $pStyle \PhpOffice\PhpSpreadsheet\Style\Border * - * @return string + * @return string */ private function createCSSStyleBorder(\PhpOffice\PhpSpreadsheet\Style\Border $pStyle) { @@ -1068,9 +1068,9 @@ class Html extends BaseWriter implements IWriter /** * Create CSS style (\PhpOffice\PhpSpreadsheet\Style\Fill). * - * @param \PhpOffice\PhpSpreadsheet\Style\Fill $pStyle \PhpOffice\PhpSpreadsheet\Style\Fill + * @param \PhpOffice\PhpSpreadsheet\Style\Fill $pStyle \PhpOffice\PhpSpreadsheet\Style\Fill * - * @return array + * @return array */ private function createCSSStyleFill(\PhpOffice\PhpSpreadsheet\Style\Fill $pStyle) { @@ -1101,11 +1101,11 @@ class Html extends BaseWriter implements IWriter /** * Generate table header. * - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet The worksheet for the table we are writing + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet The worksheet for the table we are writing * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string + * @return string */ private function generateTableHeader($pSheet) { @@ -1150,7 +1150,7 @@ class Html extends BaseWriter implements IWriter /** * Generate table footer. * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function generateTableFooter() { @@ -1162,14 +1162,14 @@ class Html extends BaseWriter implements IWriter /** * Generate row. * - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet \PhpOffice\PhpSpreadsheet\Worksheet - * @param array $pValues Array containing cells in a row - * @param int $pRow Row number (0-based) + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet \PhpOffice\PhpSpreadsheet\Worksheet + * @param array $pValues Array containing cells in a row + * @param int $pRow Row number (0-based) * @param mixed $cellType * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string + * @return string */ private function generateRow(\PhpOffice\PhpSpreadsheet\Worksheet $pSheet, $pValues = null, $pRow = 0, $cellType = 'td') { diff --git a/src/PhpSpreadsheet/Writer/IWriter.php b/src/PhpSpreadsheet/Writer/IWriter.php index 0fd2109e..4093a34b 100644 --- a/src/PhpSpreadsheet/Writer/IWriter.php +++ b/src/PhpSpreadsheet/Writer/IWriter.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -27,11 +27,11 @@ namespace PhpOffice\PhpSpreadsheet\Writer; interface IWriter { /** - * Save PhpSpreadsheet to file. + * Save PhpSpreadsheet to file. * - * @param string $pFilename Name of the file to save + * @param string $pFilename Name of the file to save * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ public function save($pFilename = null); } diff --git a/src/PhpSpreadsheet/Writer/Ods.php b/src/PhpSpreadsheet/Writer/Ods.php index 3ae21adb..ecddf9bd 100644 --- a/src/PhpSpreadsheet/Writer/Ods.php +++ b/src/PhpSpreadsheet/Writer/Ods.php @@ -14,12 +14,12 @@ use PhpOffice\PhpSpreadsheet\Spreadsheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -69,7 +69,7 @@ class Ods extends BaseWriter implements IWriter /** * Get writer part. * - * @param string $pPartName Writer part name + * @param string $pPartName Writer part name * * @return Ods\WriterPart|null */ @@ -85,7 +85,7 @@ class Ods extends BaseWriter implements IWriter /** * Save PhpSpreadsheet to file. * - * @param string $pFilename + * @param string $pFilename * * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ @@ -183,7 +183,7 @@ class Ods extends BaseWriter implements IWriter /** * Set Spreadsheet object. * - * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet PhpSpreadsheet object + * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet PhpSpreadsheet object * * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * diff --git a/src/PhpSpreadsheet/Writer/Ods/Cell/Comment.php b/src/PhpSpreadsheet/Writer/Ods/Cell/Comment.php index 9d3b4c00..0ccf5618 100644 --- a/src/PhpSpreadsheet/Writer/Ods/Cell/Comment.php +++ b/src/PhpSpreadsheet/Writer/Ods/Cell/Comment.php @@ -14,12 +14,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Ods\Cell; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * diff --git a/src/PhpSpreadsheet/Writer/Ods/Content.php b/src/PhpSpreadsheet/Writer/Ods/Content.php index 844d6fe7..0d960d6d 100644 --- a/src/PhpSpreadsheet/Writer/Ods/Content.php +++ b/src/PhpSpreadsheet/Writer/Ods/Content.php @@ -14,12 +14,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Ods; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -41,11 +41,11 @@ class Content extends WriterPart /** * Write content.xml to XML format. * - * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet + * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string XML Output + * @return string XML Output */ public function write(\PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet = null) { diff --git a/src/PhpSpreadsheet/Writer/Ods/Meta.php b/src/PhpSpreadsheet/Writer/Ods/Meta.php index 79d99869..4a57ac69 100644 --- a/src/PhpSpreadsheet/Writer/Ods/Meta.php +++ b/src/PhpSpreadsheet/Writer/Ods/Meta.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Ods; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -29,11 +29,11 @@ class Meta extends WriterPart /** * Write meta.xml to XML format. * - * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet + * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string XML Output + * @return string XML Output */ public function write(\PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet = null) { diff --git a/src/PhpSpreadsheet/Writer/Ods/MetaInf.php b/src/PhpSpreadsheet/Writer/Ods/MetaInf.php index 676c9e88..c712e7cd 100644 --- a/src/PhpSpreadsheet/Writer/Ods/MetaInf.php +++ b/src/PhpSpreadsheet/Writer/Ods/MetaInf.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Ods; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -31,9 +31,9 @@ class MetaInf extends WriterPart * * @param \PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string XML Output + * @return string XML Output */ public function writeManifest(\PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet = null) { diff --git a/src/PhpSpreadsheet/Writer/Ods/Mimetype.php b/src/PhpSpreadsheet/Writer/Ods/Mimetype.php index 5a10d337..f3bf03b5 100644 --- a/src/PhpSpreadsheet/Writer/Ods/Mimetype.php +++ b/src/PhpSpreadsheet/Writer/Ods/Mimetype.php @@ -10,12 +10,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Ods; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -29,9 +29,9 @@ class Mimetype extends WriterPart * * @param \PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string XML Output + * @return string XML Output */ public function write(\PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet = null) { diff --git a/src/PhpSpreadsheet/Writer/Ods/Settings.php b/src/PhpSpreadsheet/Writer/Ods/Settings.php index c32c2c5a..dd77ae54 100644 --- a/src/PhpSpreadsheet/Writer/Ods/Settings.php +++ b/src/PhpSpreadsheet/Writer/Ods/Settings.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Ods; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -29,11 +29,11 @@ class Settings extends WriterPart /** * Write settings.xml to XML format. * - * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet + * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string XML Output + * @return string XML Output */ public function write(\PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet = null) { diff --git a/src/PhpSpreadsheet/Writer/Ods/Styles.php b/src/PhpSpreadsheet/Writer/Ods/Styles.php index 333f813e..5219f106 100644 --- a/src/PhpSpreadsheet/Writer/Ods/Styles.php +++ b/src/PhpSpreadsheet/Writer/Ods/Styles.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Ods; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -29,11 +29,11 @@ class Styles extends WriterPart /** * Write styles.xml to XML format. * - * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet + * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string XML Output + * @return string XML Output */ public function write(\PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet = null) { diff --git a/src/PhpSpreadsheet/Writer/Ods/Thumbnails.php b/src/PhpSpreadsheet/Writer/Ods/Thumbnails.php index f8fb2b72..df5642fb 100644 --- a/src/PhpSpreadsheet/Writer/Ods/Thumbnails.php +++ b/src/PhpSpreadsheet/Writer/Ods/Thumbnails.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Ods; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -29,11 +29,11 @@ class Thumbnails extends WriterPart /** * Write Thumbnails/thumbnail.png to PNG format. * - * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet + * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string XML Output + * @return string XML Output */ public function writeThumbnail(\PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet = null) { diff --git a/src/PhpSpreadsheet/Writer/Ods/WriterPart.php b/src/PhpSpreadsheet/Writer/Ods/WriterPart.php index 647aca37..dee7532c 100644 --- a/src/PhpSpreadsheet/Writer/Ods/WriterPart.php +++ b/src/PhpSpreadsheet/Writer/Ods/WriterPart.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Ods; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * diff --git a/src/PhpSpreadsheet/Writer/Pdf.php b/src/PhpSpreadsheet/Writer/Pdf.php index cb16dc6b..2bb20fc7 100644 --- a/src/PhpSpreadsheet/Writer/Pdf.php +++ b/src/PhpSpreadsheet/Writer/Pdf.php @@ -14,12 +14,12 @@ use PhpOffice\PhpSpreadsheet\Spreadsheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -36,11 +36,11 @@ class Pdf implements IWriter private $renderer = null; /** - * Instantiate a new renderer of the configured type within this container class. + * Instantiate a new renderer of the configured type within this container class. * - * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet PhpSpreadsheet object + * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet PhpSpreadsheet object * - * @throws Exception when PDF library is not configured + * @throws Exception when PDF library is not configured */ public function __construct(Spreadsheet $spreadsheet) { @@ -54,12 +54,12 @@ class Pdf implements IWriter } /** - * Magic method to handle direct calls to the configured PDF renderer wrapper class. + * Magic method to handle direct calls to the configured PDF renderer wrapper class. * - * @param string $name Renderer library method name - * @param mixed[] $arguments Array of arguments to pass to the renderer method + * @param string $name Renderer library method name + * @param mixed[] $arguments Array of arguments to pass to the renderer method * - * @return mixed Returned data from the PDF renderer wrapper method + * @return mixed Returned data from the PDF renderer wrapper method */ public function __call($name, $arguments) { diff --git a/src/PhpSpreadsheet/Writer/Pdf/Core.php b/src/PhpSpreadsheet/Writer/Pdf/Core.php index 62ca4667..6e429817 100644 --- a/src/PhpSpreadsheet/Writer/Pdf/Core.php +++ b/src/PhpSpreadsheet/Writer/Pdf/Core.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Pdf; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -136,9 +136,9 @@ abstract class Core extends \PhpOffice\PhpSpreadsheet\Writer\Html ]; /** - * Create a new PDF Writer instance. + * Create a new PDF Writer instance. * - * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet Spreadsheet object + * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet Spreadsheet object */ public function __construct(\PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet) { @@ -148,9 +148,9 @@ abstract class Core extends \PhpOffice\PhpSpreadsheet\Writer\Html } /** - * Get Font. + * Get Font. * - * @return string + * @return string */ public function getFont() { @@ -158,13 +158,13 @@ abstract class Core extends \PhpOffice\PhpSpreadsheet\Writer\Html } /** - * Set font. Examples: + * Set font. Examples: * 'arialunicid0-chinese-simplified' * 'arialunicid0-chinese-traditional' * 'arialunicid0-korean' * 'arialunicid0-japanese'. * - * @param string $fontName + * @param string $fontName */ public function setFont($fontName) { @@ -174,9 +174,9 @@ abstract class Core extends \PhpOffice\PhpSpreadsheet\Writer\Html } /** - * Get Paper Size. + * Get Paper Size. * - * @return int + * @return int */ public function getPaperSize() { @@ -184,11 +184,11 @@ abstract class Core extends \PhpOffice\PhpSpreadsheet\Writer\Html } /** - * Set Paper Size. + * Set Paper Size. * - * @param string $pValue Paper size + * @param string $pValue Paper size * - * @return self + * @return self */ public function setPaperSize($pValue = \PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::PAPERSIZE_LETTER) { @@ -198,9 +198,9 @@ abstract class Core extends \PhpOffice\PhpSpreadsheet\Writer\Html } /** - * Get Orientation. + * Get Orientation. * - * @return string + * @return string */ public function getOrientation() { @@ -208,11 +208,11 @@ abstract class Core extends \PhpOffice\PhpSpreadsheet\Writer\Html } /** - * Set Orientation. + * Set Orientation. * - * @param string $pValue Page orientation + * @param string $pValue Page orientation * - * @return self + * @return self */ public function setOrientation($pValue = \PhpOffice\PhpSpreadsheet\Worksheet\PageSetup::ORIENTATION_DEFAULT) { @@ -222,9 +222,9 @@ abstract class Core extends \PhpOffice\PhpSpreadsheet\Writer\Html } /** - * Get temporary storage directory. + * Get temporary storage directory. * - * @return string + * @return string */ public function getTempDir() { @@ -232,13 +232,13 @@ abstract class Core extends \PhpOffice\PhpSpreadsheet\Writer\Html } /** - * Set temporary storage directory. + * Set temporary storage directory. * - * @param string $pValue Temporary storage directory + * @param string $pValue Temporary storage directory * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception when directory does not exist + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception when directory does not exist * - * @return self + * @return self */ public function setTempDir($pValue = '') { @@ -252,11 +252,11 @@ abstract class Core extends \PhpOffice\PhpSpreadsheet\Writer\Html } /** - * Save Spreadsheet to PDF file, pre-save. + * Save Spreadsheet to PDF file, pre-save. * - * @param string $pFilename Name of the file to save as + * @param string $pFilename Name of the file to save as * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ protected function prepareForSave($pFilename = null) { @@ -281,11 +281,11 @@ abstract class Core extends \PhpOffice\PhpSpreadsheet\Writer\Html } /** - * Save PhpSpreadsheet to PDF file, post-save. + * Save PhpSpreadsheet to PDF file, post-save. * - * @param resource $fileHandle + * @param resource $fileHandle * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ protected function restoreStateAfterSave($fileHandle) { diff --git a/src/PhpSpreadsheet/Writer/Pdf/DomPDF.php b/src/PhpSpreadsheet/Writer/Pdf/DomPDF.php index 54b74ed3..2fa219c8 100644 --- a/src/PhpSpreadsheet/Writer/Pdf/DomPDF.php +++ b/src/PhpSpreadsheet/Writer/Pdf/DomPDF.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Pdf; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -27,11 +27,11 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Pdf; class DomPDF extends Core implements \PhpOffice\PhpSpreadsheet\Writer\IWriter { /** - * Save Spreadsheet to file. + * Save Spreadsheet to file. * - * @param string $pFilename Name of the file to save as + * @param string $pFilename Name of the file to save as * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ public function save($pFilename = null) { diff --git a/src/PhpSpreadsheet/Writer/Pdf/MPDF.php b/src/PhpSpreadsheet/Writer/Pdf/MPDF.php index da69dc3e..14feb1ff 100644 --- a/src/PhpSpreadsheet/Writer/Pdf/MPDF.php +++ b/src/PhpSpreadsheet/Writer/Pdf/MPDF.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Pdf; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -27,11 +27,11 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Pdf; class MPDF extends Core implements \PhpOffice\PhpSpreadsheet\Writer\IWriter { /** - * Save Spreadsheet to file. + * Save Spreadsheet to file. * - * @param string $pFilename Name of the file to save as + * @param string $pFilename Name of the file to save as * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * @throws \PhpOffice\PhpSpreadsheet\Exception */ public function save($pFilename = null) diff --git a/src/PhpSpreadsheet/Writer/Pdf/TcPDF.php b/src/PhpSpreadsheet/Writer/Pdf/TcPDF.php index 4fa34e0e..678a5591 100644 --- a/src/PhpSpreadsheet/Writer/Pdf/TcPDF.php +++ b/src/PhpSpreadsheet/Writer/Pdf/TcPDF.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Pdf; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -27,11 +27,11 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Pdf; class TcPDF extends Core implements \PhpOffice\PhpSpreadsheet\Writer\IWriter { /** - * Save Spreadsheet to file. + * Save Spreadsheet to file. * - * @param string $pFilename Name of the file to save as + * @param string $pFilename Name of the file to save as * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ public function save($pFilename = null) { diff --git a/src/PhpSpreadsheet/Writer/Xls.php b/src/PhpSpreadsheet/Writer/Xls.php index 57dd2417..b7845ae3 100644 --- a/src/PhpSpreadsheet/Writer/Xls.php +++ b/src/PhpSpreadsheet/Writer/Xls.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -92,7 +92,7 @@ class Xls extends BaseWriter implements IWriter /** * Create a new Xls Writer. * - * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet PhpSpreadsheet object + * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet PhpSpreadsheet object */ public function __construct(\PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet) { @@ -104,9 +104,9 @@ class Xls extends BaseWriter implements IWriter /** * Save Spreadsheet to file. * - * @param string $pFilename + * @param string $pFilename * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ public function save($pFilename = null) { diff --git a/src/PhpSpreadsheet/Writer/Xls/BIFFwriter.php b/src/PhpSpreadsheet/Writer/Xls/BIFFwriter.php index e5d16cd3..a45ba07b 100644 --- a/src/PhpSpreadsheet/Writer/Xls/BIFFwriter.php +++ b/src/PhpSpreadsheet/Writer/Xls/BIFFwriter.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Xls; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -51,7 +51,7 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Xls; // * // * This library is distributed in the hope that it will be useful, // * 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. // * // * You should have received a copy of the GNU Lesser General Public @@ -160,7 +160,7 @@ class BIFFwriter * Writes Excel BOF record to indicate the beginning of a stream or * sub-stream in the BIFF file. * - * @param int $type type of BIFF file to write: 0x0005 Workbook, + * @param int $type type of BIFF file to write: 0x0005 Workbook, * 0x0010 Worksheet */ protected function storeBof($type) @@ -213,9 +213,9 @@ class BIFFwriter * This function takes a long BIFF record and inserts CONTINUE records as * necessary. * - * @param string $data The original binary data to be written + * @param string $data The original binary data to be written * - * @return string A very convenient string of continue blocks + * @return string A very convenient string of continue blocks */ private function addContinue($data) { diff --git a/src/PhpSpreadsheet/Writer/Xls/Escher.php b/src/PhpSpreadsheet/Writer/Xls/Escher.php index 693d30ef..8926b192 100644 --- a/src/PhpSpreadsheet/Writer/Xls/Escher.php +++ b/src/PhpSpreadsheet/Writer/Xls/Escher.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Xls; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * diff --git a/src/PhpSpreadsheet/Writer/Xls/Font.php b/src/PhpSpreadsheet/Writer/Xls/Font.php index e4ecea91..5b4ad203 100644 --- a/src/PhpSpreadsheet/Writer/Xls/Font.php +++ b/src/PhpSpreadsheet/Writer/Xls/Font.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Xls; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * diff --git a/src/PhpSpreadsheet/Writer/Xls/Parser.php b/src/PhpSpreadsheet/Writer/Xls/Parser.php index c9f15122..dfa8bec5 100644 --- a/src/PhpSpreadsheet/Writer/Xls/Parser.php +++ b/src/PhpSpreadsheet/Writer/Xls/Parser.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Xls; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -41,7 +41,7 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Xls; // * // * This library is distributed in the hope that it will be useful, // * 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. // * // * You should have received a copy of the GNU Lesser General Public @@ -593,7 +593,7 @@ class Parser * Convert a function to a ptgFunc or ptgFuncVarV depending on the number of * args that it takes. * - * @param string $token the name of the function for convertion to ptg value + * @param string $token the name of the function for convertion to ptg value * @param int $num_args the number of arguments the function receives * * @return string The packed ptg for the function @@ -615,8 +615,8 @@ class Parser /** * Convert an Excel range such as A1:D4 to a ptgRefV. * - * @param string $range An Excel range in the A1:A2 - * @param int $class + * @param string $range An Excel range in the A1:A2 + * @param int $class */ private function convertRange2d($range, $class = 0) { @@ -728,9 +728,9 @@ class Parser /** * Convert an error code to a ptgErr. * - * @param string $errorCode The error code for conversion to its ptg value + * @param string $errorCode The error code for conversion to its ptg value * - * @return string The error code ptgErr + * @return string The error code ptgErr */ private function convertError($errorCode) { @@ -758,9 +758,9 @@ class Parser * Convert the sheet name part of an external reference, for example "Sheet1" or * "Sheet1:Sheet2", to a packed structure. * - * @param string $ext_ref The name of the external reference + * @param string $ext_ref The name of the external reference * - * @return string The reference index in packed() format + * @return string The reference index in packed() format */ private function packExtRef($ext_ref) { @@ -863,9 +863,9 @@ class Parser * sheet names is updated by the addworksheet() method of the * \PhpOffice\PhpSpreadsheet\Writer\Xls\Workbook class. * - * @param string $sheet_name Sheet name + * @param string $sheet_name Sheet name * - * @return int The sheet index, -1 if the sheet was not found + * @return int The sheet index, -1 if the sheet was not found */ private function getSheetIndex($sheet_name) { @@ -883,7 +883,7 @@ class Parser * * @see \PhpOffice\PhpSpreadsheet\Writer\Xls\Workbook::addWorksheet() * - * @param string $name The name of the worksheet being added + * @param string $name The name of the worksheet being added * @param int $index The index of the worksheet being added */ public function setExtSheet($name, $index) @@ -1043,7 +1043,7 @@ class Parser * * @param mixed $token the token to check * - * @return mixed The checked token or false on failure + * @return mixed The checked token or false on failure */ private function match($token) { @@ -1419,7 +1419,7 @@ class Parser * as elements. * * @param mixed $value the value of this node - * @param mixed $left the left array (sub-tree) or a final node + * @param mixed $left the left array (sub-tree) or a final node * @param mixed $right the right array (sub-tree) or a final node * * @return array A tree diff --git a/src/PhpSpreadsheet/Writer/Xls/Workbook.php b/src/PhpSpreadsheet/Writer/Xls/Workbook.php index 9419fbab..38ac7b30 100644 --- a/src/PhpSpreadsheet/Writer/Xls/Workbook.php +++ b/src/PhpSpreadsheet/Writer/Xls/Workbook.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Xls; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -52,7 +52,7 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Xls; // * // * This library is distributed in the hope that it will be useful, // * 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. // * // * You should have received a copy of the GNU Lesser General Public @@ -191,11 +191,11 @@ class Workbook extends BIFFwriter * Class constructor. * * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet The Workbook - * @param int $str_total Total number of strings - * @param int $str_unique Total number of unique strings - * @param array $str_table String Table - * @param array $colors Colour Table - * @param Parser $parser The formula parser created for the Workbook + * @param int $str_total Total number of strings + * @param int $str_unique Total number of unique strings + * @param array $str_table String Table + * @param array $colors Colour Table + * @param Parser $parser The formula parser created for the Workbook */ public function __construct(\PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet, &$str_total, &$str_unique, &$str_table, &$colors, Parser $parser) { @@ -418,9 +418,9 @@ class Workbook extends BIFFwriter * Assemble worksheets into a workbook and send the BIFF data to an OLE * storage. * - * @param array $pWorksheetSizes The sizes in bytes of the binary worksheet streams + * @param array $pWorksheetSizes The sizes in bytes of the binary worksheet streams * - * @return string Binary data for workbook stream + * @return string Binary data for workbook stream */ public function writeWorkbook($pWorksheetSizes = null) { @@ -794,12 +794,12 @@ class Workbook extends BIFFwriter /** * Write a DEFINEDNAME record for BIFF8 using explicit binary formula data. * - * @param string $name The name in UTF-8 - * @param string $formulaData The binary formula data - * @param string $sheetIndex 1-based sheet index the defined name applies to. 0 = global - * @param bool $isBuiltIn Built-in name? + * @param string $name The name in UTF-8 + * @param string $formulaData The binary formula data + * @param string $sheetIndex 1-based sheet index the defined name applies to. 0 = global + * @param bool $isBuiltIn Built-in name? * - * @return string Complete binary record data + * @return string Complete binary record data */ private function writeDefinedNameBiff8($name, $formulaData, $sheetIndex = 0, $isBuiltIn = false) { @@ -830,12 +830,12 @@ class Workbook extends BIFFwriter /** * Write a short NAME record. * - * @param string $name - * @param string $sheetIndex 1-based sheet index the defined name applies to. 0 = global - * @param integer[][] $rangeBounds range boundaries - * @param bool $isHidden + * @param string $name + * @param string $sheetIndex 1-based sheet index the defined name applies to. 0 = global + * @param integer[][] $rangeBounds range boundaries + * @param bool $isHidden * - * @return string Complete binary record data + * @return string Complete binary record data * */ private function writeShortNameBiff8($name, $sheetIndex, $rangeBounds, $isHidden = false) { @@ -914,8 +914,8 @@ class Workbook extends BIFFwriter /** * Writes Excel BIFF BOUNDSHEET record. * - * @param \PhpOffice\PhpSpreadsheet\Worksheet $sheet Worksheet name - * @param int $offset Location of worksheet BOF + * @param \PhpOffice\PhpSpreadsheet\Worksheet $sheet Worksheet name + * @param int $offset Location of worksheet BOF */ private function writeBoundSheet($sheet, $offset) { @@ -1005,8 +1005,8 @@ class Workbook extends BIFFwriter /** * Writes Excel FORMAT record for non "built-in" numerical formats. * - * @param string $format Custom format string - * @param int $ifmt Format index code + * @param string $format Custom format string + * @param int $ifmt Format index code */ private function writeNumberFormat($format, $ifmt) { @@ -1085,8 +1085,8 @@ class Workbook extends BIFFwriter * Store the NAME record in the short format that is used for storing the print * area, repeat rows only and repeat columns only. * - * @param int $index Sheet index - * @param int $type Built-in name type + * @param int $index Sheet index + * @param int $type Built-in name type * @param int $rowmin Start row * @param int $rowmax End row * @param int $colmin Start colum @@ -1150,7 +1150,7 @@ class Workbook extends BIFFwriter * Code abstraction for reuse can be carried too far, and I should know. ;-). * * @param int $index Sheet index - * @param int $type Built-in name type + * @param int $type Built-in name type * @param int $rowmin Start row * @param int $rowmax End row * @param int $colmin Start colum diff --git a/src/PhpSpreadsheet/Writer/Xls/Worksheet.php b/src/PhpSpreadsheet/Writer/Xls/Worksheet.php index 93edaea1..333fc540 100644 --- a/src/PhpSpreadsheet/Writer/Xls/Worksheet.php +++ b/src/PhpSpreadsheet/Writer/Xls/Worksheet.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Xls; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -52,7 +52,7 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Xls; // * // * This library is distributed in the hope that it will be useful, // * 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. // * // * You should have received a copy of the GNU Lesser General Public @@ -219,13 +219,13 @@ class Worksheet extends BIFFwriter /** * Constructor. * - * @param int &$str_total Total number of strings - * @param int &$str_unique Total number of unique strings - * @param array &$str_table String Table - * @param array &$colors Colour Table - * @param mixed $parser The formula parser created for the Workbook - * @param bool $preCalculateFormulas Flag indicating whether formulas should be calculated or just written - * @param string $phpSheet The worksheet to write + * @param int &$str_total Total number of strings + * @param int &$str_unique Total number of unique strings + * @param array &$str_table String Table + * @param array &$colors Colour Table + * @param mixed $parser The formula parser created for the Workbook + * @param bool $preCalculateFormulas Flag indicating whether formulas should be calculated or just written + * @param string $phpSheet The worksheet to write * @param \PhpOffice\PhpSpreadsheet\Worksheet $phpSheet */ public function __construct(&$str_total, &$str_unique, &$str_table, &$colors, $parser, $preCalculateFormulas, $phpSheet) @@ -621,10 +621,10 @@ class Worksheet extends BIFFwriter * Returns 0 : normal termination * -2 : row or column out of range * - * @param int $row Zero indexed row - * @param int $col Zero indexed column - * @param float $num The number to write - * @param mixed $xfIndex The optional XF format + * @param int $row Zero indexed row + * @param int $col Zero indexed column + * @param float $num The number to write + * @param mixed $xfIndex The optional XF format * * @return int */ @@ -665,7 +665,7 @@ class Worksheet extends BIFFwriter * @param int $row Row index (0-based) * @param int $col Column index (0-based) * @param string $str The string - * @param int $xfIndex The XF format index for the cell + * @param int $xfIndex The XF format index for the cell * @param array $arrcRun Index to Font record and characters beginning */ private function writeRichTextString($row, $col, $str, $xfIndex, $arrcRun) @@ -693,10 +693,10 @@ class Worksheet extends BIFFwriter * -2 : row or column out of range * -3 : long string truncated to 255 chars. * - * @param int $row Zero indexed row - * @param int $col Zero indexed column - * @param string $str The string to write - * @param mixed $xfIndex The XF format index for the cell + * @param int $row Zero indexed row + * @param int $col Zero indexed column + * @param string $str The string to write + * @param mixed $xfIndex The XF format index for the cell * * @return int */ @@ -730,10 +730,10 @@ class Worksheet extends BIFFwriter * -2 : row or column out of range * -3 : long string truncated to 255 chars. * - * @param int $row Zero indexed row - * @param int $col Zero indexed column - * @param string $str The string to write - * @param mixed $xfIndex The XF format index for the cell + * @param int $row Zero indexed row + * @param int $col Zero indexed column + * @param string $str The string to write + * @param mixed $xfIndex The XF format index for the cell * * @return int */ @@ -759,9 +759,9 @@ class Worksheet extends BIFFwriter * Writes a note associated with the cell given by the row and column. * NOTE records don't have a length limit. * - * @param int $row Zero indexed row - * @param int $col Zero indexed column - * @param string $note The note to write + * @param int $row Zero indexed row + * @param int $col Zero indexed column + * @param string $note The note to write */ private function writeNote($row, $col, $note) { @@ -798,9 +798,9 @@ class Worksheet extends BIFFwriter * -1 : insufficient number of arguments * -2 : row or column out of range * - * @param int $row Zero indexed row - * @param int $col Zero indexed column - * @param mixed $xfIndex The XF format index + * @param int $row Zero indexed row + * @param int $col Zero indexed column + * @param mixed $xfIndex The XF format index */ public function writeBlank($row, $col, $xfIndex) { @@ -844,11 +844,11 @@ class Worksheet extends BIFFwriter * -1 : formula errors (bad formula) * -2 : row or column out of range * - * @param int $row Zero indexed row - * @param int $col Zero indexed column - * @param string $formula The formula text string - * @param mixed $xfIndex The XF format index - * @param mixed $calculatedValue Calculated value + * @param int $row Zero indexed row + * @param int $col Zero indexed column + * @param string $formula The formula text string + * @param mixed $xfIndex The XF format index + * @param mixed $calculatedValue Calculated value * * @return int */ @@ -960,9 +960,9 @@ class Worksheet extends BIFFwriter * -2 : row or column out of range * -3 : long string truncated to 255 chars * - * @param int $row Row - * @param int $col Column - * @param string $url URL string + * @param int $row Row + * @param int $col Column + * @param string $url URL string * * @return int */ @@ -980,11 +980,11 @@ class Worksheet extends BIFFwriter * * @see writeUrl() * - * @param int $row1 Start row - * @param int $col1 Start column - * @param int $row2 End row - * @param int $col2 End column - * @param string $url URL string + * @param int $row1 Start row + * @param int $col1 Start column + * @param int $row2 End row + * @param int $col2 End column + * @param string $url URL string * * @return int */ @@ -1008,11 +1008,11 @@ class Worksheet extends BIFFwriter * * @see writeUrl() * - * @param int $row1 Start row - * @param int $col1 Start column - * @param int $row2 End row - * @param int $col2 End column - * @param string $url URL string + * @param int $row1 Start row + * @param int $col1 Start column + * @param int $row2 End row + * @param int $col2 End column + * @param string $url URL string * * @return int */ @@ -1053,11 +1053,11 @@ class Worksheet extends BIFFwriter * * @see writeUrl() * - * @param int $row1 Start row - * @param int $col1 Start column - * @param int $row2 End row - * @param int $col2 End column - * @param string $url URL string + * @param int $row1 Start row + * @param int $col1 Start column + * @param int $row2 End row + * @param int $col2 End column + * @param string $url URL string * * @return int */ @@ -1106,11 +1106,11 @@ class Worksheet extends BIFFwriter * * @see writeUrl() * - * @param int $row1 Start row - * @param int $col1 Start column - * @param int $row2 End row - * @param int $col2 End column - * @param string $url URL string + * @param int $row1 Start row + * @param int $col1 Start column + * @param int $row2 End row + * @param int $col2 End column + * @param string $url URL string * * @return int */ @@ -1202,12 +1202,12 @@ class Worksheet extends BIFFwriter /** * This method is used to set the height and format for a row. * - * @param int $row The row to set + * @param int $row The row to set * @param int $height Height we are giving to the row. * Use null to set XF without setting height - * @param int $xfIndex The optional cell style Xf index to apply to the columns - * @param bool $hidden The optional hidden attribute - * @param int $level The optional outline level for row, in range [0,7] + * @param int $xfIndex The optional cell style Xf index to apply to the columns + * @param bool $hidden The optional hidden attribute + * @param int $level The optional outline level for row, in range [0,7] */ private function writeRow($row, $height, $xfIndex, $hidden = false, $level = 0) { @@ -2322,13 +2322,13 @@ class Worksheet extends BIFFwriter /** * Insert a 24bit bitmap image in a worksheet. * - * @param int $row The row we are going to insert the bitmap into - * @param int $col The column we are going to insert the bitmap into - * @param mixed $bitmap The bitmap filename or GD-image resource - * @param int $x the horizontal position (offset) of the image inside the cell - * @param int $y the vertical position (offset) of the image inside the cell - * @param float $scale_x The horizontal scale - * @param float $scale_y The vertical scale + * @param int $row The row we are going to insert the bitmap into + * @param int $col The column we are going to insert the bitmap into + * @param mixed $bitmap The bitmap filename or GD-image resource + * @param int $x the horizontal position (offset) of the image inside the cell + * @param int $y the vertical position (offset) of the image inside the cell + * @param float $scale_x The horizontal scale + * @param float $scale_y The vertical scale */ public function insertBitmap($row, $col, $bitmap, $x = 0, $y = 0, $scale_x = 1, $scale_y = 1) { @@ -2398,10 +2398,10 @@ class Worksheet extends BIFFwriter * * @param int $col_start Col containing upper left corner of object * @param int $row_start Row containing top left corner of object - * @param int $x1 Distance to left side of object - * @param int $y1 Distance to top of object - * @param int $width Width of image frame - * @param int $height Height of image frame + * @param int $x1 Distance to left side of object + * @param int $y1 Distance to top of object + * @param int $width Width of image frame + * @param int $height Height of image frame */ public function positionImage($col_start, $row_start, $x1, $y1, $width, $height) { @@ -2462,13 +2462,13 @@ class Worksheet extends BIFFwriter * to support other Excel objects. * * @param int $colL Column containing upper left corner of object - * @param int $dxL Distance from left side of cell - * @param int $rwT Row containing top left corner of object - * @param int $dyT Distance from top of cell + * @param int $dxL Distance from left side of cell + * @param int $rwT Row containing top left corner of object + * @param int $dyT Distance from top of cell * @param int $colR Column containing lower right corner of object - * @param int $dxR Distance from right of cell - * @param int $rwB Row containing bottom right corner of object - * @param int $dyB Distance from bottom of cell + * @param int $dxR Distance from right of cell + * @param int $rwB Row containing bottom right corner of object + * @param int $dyB Distance from bottom of cell */ private function writeObjPicture($colL, $dxL, $rwT, $dyT, $colR, $dxR, $rwB, $dyB) { diff --git a/src/PhpSpreadsheet/Writer/Xls/Xf.php b/src/PhpSpreadsheet/Writer/Xls/Xf.php index 14ae6c4c..3b5af382 100644 --- a/src/PhpSpreadsheet/Writer/Xls/Xf.php +++ b/src/PhpSpreadsheet/Writer/Xls/Xf.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Xls; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -52,7 +52,7 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Xls; // * // * This library is distributed in the hope that it will be useful, // * 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. // * // * You should have received a copy of the GNU Lesser General Public @@ -134,7 +134,7 @@ class Xf /** * Constructor. * - * @param \PhpOffice\PhpSpreadsheet\Style The XF format + * @param \PhpOffice\PhpSpreadsheet\Style The XF format */ public function __construct(\PhpOffice\PhpSpreadsheet\Style $style = null) { diff --git a/src/PhpSpreadsheet/Writer/Xlsx.php b/src/PhpSpreadsheet/Writer/Xlsx.php index 524b8128..ed383ce2 100644 --- a/src/PhpSpreadsheet/Writer/Xlsx.php +++ b/src/PhpSpreadsheet/Writer/Xlsx.php @@ -14,12 +14,12 @@ use PhpOffice\PhpSpreadsheet\Spreadsheet; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -151,9 +151,9 @@ class Xlsx extends BaseWriter implements IWriter /** * Get writer part. * - * @param string $pPartName Writer part name + * @param string $pPartName Writer part name * - * @return \PhpOffice\PhpSpreadsheet\Writer\Xlsx\WriterPart + * @return \PhpOffice\PhpSpreadsheet\Writer\Xlsx\WriterPart */ public function getWriterPart($pPartName = '') { @@ -167,9 +167,9 @@ class Xlsx extends BaseWriter implements IWriter /** * Save PhpSpreadsheet to file. * - * @param string $pFilename + * @param string $pFilename * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ public function save($pFilename = null) { @@ -416,9 +416,9 @@ class Xlsx extends BaseWriter implements IWriter /** * Set Spreadsheet object. * - * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet PhpSpreadsheet object + * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet PhpSpreadsheet object * - * @return Xlsx + * @return Xlsx */ public function setSpreadsheet(Spreadsheet $spreadsheet = null) { @@ -520,7 +520,7 @@ class Xlsx extends BaseWriter implements IWriter /** * Set Office2003 compatibility. * - * @param bool $pValue Office2003 compatibility? + * @param bool $pValue Office2003 compatibility? * * @return Xlsx */ diff --git a/src/PhpSpreadsheet/Writer/Xlsx/Chart.php b/src/PhpSpreadsheet/Writer/Xlsx/Chart.php index 828d26b8..b6396f3f 100644 --- a/src/PhpSpreadsheet/Writer/Xlsx/Chart.php +++ b/src/PhpSpreadsheet/Writer/Xlsx/Chart.php @@ -21,12 +21,12 @@ use PhpOffice\PhpSpreadsheet\Chart\Title; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -40,12 +40,12 @@ class Chart extends WriterPart /** * Write charts to XML format. * - * @param \PhpOffice\PhpSpreadsheet\Chart $pChart + * @param \PhpOffice\PhpSpreadsheet\Chart $pChart * @param mixed $calculateCellValues * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string XML Output + * @return string XML Output */ public function writeChart(\PhpOffice\PhpSpreadsheet\Chart $pChart = null, $calculateCellValues = true) { @@ -121,10 +121,10 @@ class Chart extends WriterPart /** * Write Chart Title. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param Title $title + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param Title $title * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeTitle(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter, Title $title = null) { @@ -166,10 +166,10 @@ class Chart extends WriterPart /** * Write Chart Legend. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param Legend $legend + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param Legend $legend * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeLegend(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter, Legend $legend = null) { @@ -217,15 +217,15 @@ class Chart extends WriterPart /** * Write Chart Plot Area. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet - * @param PlotArea $plotArea - * @param Title $xAxisLabel - * @param Title $yAxisLabel - * @param Axis $xAxis - * @param Axis $yAxis + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet + * @param PlotArea $plotArea + * @param Title $xAxisLabel + * @param Title $yAxisLabel + * @param Axis $xAxis + * @param Axis $yAxis * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writePlotArea(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter, \PhpOffice\PhpSpreadsheet\Worksheet $pSheet, PlotArea $plotArea, Title $xAxisLabel = null, Title $yAxisLabel = null, Axis $xAxis = null, Axis $yAxis = null, GridLines $majorGridlines = null, GridLines $minorGridlines = null) { @@ -353,10 +353,10 @@ class Chart extends WriterPart /** * Write Data Labels. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Chart\Layout $chartLayout Chart layout + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Chart\Layout $chartLayout Chart layout * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeDataLabels($objWriter, Layout $chartLayout = null) { @@ -403,17 +403,17 @@ class Chart extends WriterPart /** * Write Category Axis. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param PlotArea $plotArea - * @param Title $xAxisLabel - * @param string $groupType Chart type - * @param string $id1 - * @param string $id2 - * @param bool $isMultiLevelSeries + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param PlotArea $plotArea + * @param Title $xAxisLabel + * @param string $groupType Chart type + * @param string $id1 + * @param string $id2 + * @param bool $isMultiLevelSeries * @param mixed $xAxis * @param mixed $yAxis * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeCategoryAxis($objWriter, PlotArea $plotArea, $xAxisLabel, $groupType, $id1, $id2, $isMultiLevelSeries, $xAxis, $yAxis) { @@ -526,19 +526,19 @@ class Chart extends WriterPart /** * Write Value Axis. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param PlotArea $plotArea - * @param Title $yAxisLabel - * @param string $groupType Chart type - * @param string $id1 - * @param string $id2 - * @param bool $isMultiLevelSeries + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param PlotArea $plotArea + * @param Title $yAxisLabel + * @param string $groupType Chart type + * @param string $id1 + * @param string $id2 + * @param bool $isMultiLevelSeries * @param mixed $xAxis * @param mixed $yAxis * @param mixed $majorGridlines * @param mixed $minorGridlines * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeValueAxis($objWriter, PlotArea $plotArea, $yAxisLabel, $groupType, $id1, $id2, $isMultiLevelSeries, $xAxis, $yAxis, $majorGridlines, $minorGridlines) { @@ -1016,11 +1016,11 @@ class Chart extends WriterPart /** * Get the data series type(s) for a chart plot series. * - * @param PlotArea $plotArea + * @param PlotArea $plotArea * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string|array + * @return string|array */ private static function getChartType($plotArea) { @@ -1045,15 +1045,15 @@ class Chart extends WriterPart /** * Write Plot Group (series of related plots). * - * @param DataSeries $plotGroup - * @param string $groupType Type of plot for dataseries - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param bool &$catIsMultiLevelSeries Is category a multi-series category - * @param bool &$valIsMultiLevelSeries Is value set a multi-series set - * @param string &$plotGroupingType Type of grouping for multi-series values - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet + * @param DataSeries $plotGroup + * @param string $groupType Type of plot for dataseries + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param bool &$catIsMultiLevelSeries Is category a multi-series category + * @param bool &$valIsMultiLevelSeries Is value set a multi-series set + * @param string &$plotGroupingType Type of grouping for multi-series values + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writePlotGroup($plotGroup, $groupType, $objWriter, &$catIsMultiLevelSeries, &$valIsMultiLevelSeries, &$plotGroupingType, \PhpOffice\PhpSpreadsheet\Worksheet $pSheet) { @@ -1224,10 +1224,10 @@ class Chart extends WriterPart /** * Write Plot Series Label. * - * @param DataSeriesValues $plotSeriesLabel - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param DataSeriesValues $plotSeriesLabel + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writePlotSeriesLabel($plotSeriesLabel, $objWriter) { @@ -1259,12 +1259,12 @@ class Chart extends WriterPart /** * Write Plot Series Values. * - * @param DataSeriesValues $plotSeriesValues - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param string $groupType Type of plot for dataseries - * @param string $dataType Datatype of series values + * @param DataSeriesValues $plotSeriesValues + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param string $groupType Type of plot for dataseries + * @param string $dataType Datatype of series values * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writePlotSeriesValues($plotSeriesValues, \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter, $groupType, $dataType = 'str') { @@ -1353,10 +1353,10 @@ class Chart extends WriterPart /** * Write Bubble Chart Details. * - * @param DataSeriesValues $plotSeriesValues - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param DataSeriesValues $plotSeriesValues + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeBubbles($plotSeriesValues, $objWriter) { @@ -1400,10 +1400,10 @@ class Chart extends WriterPart /** * Write Layout. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param Layout $layout + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param Layout $layout * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeLayout(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter, Layout $layout = null) { @@ -1470,9 +1470,9 @@ class Chart extends WriterPart /** * Write Alternate Content block. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeAlternateContent($objWriter) { @@ -1500,9 +1500,9 @@ class Chart extends WriterPart /** * Write Printer Settings. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writePrintSettings($objWriter) { diff --git a/src/PhpSpreadsheet/Writer/Xlsx/Comments.php b/src/PhpSpreadsheet/Writer/Xlsx/Comments.php index b8a3e33a..72dba7ea 100644 --- a/src/PhpSpreadsheet/Writer/Xlsx/Comments.php +++ b/src/PhpSpreadsheet/Writer/Xlsx/Comments.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Xlsx; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -29,11 +29,11 @@ class Comments extends WriterPart /** * Write comments to XML format. * - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pWorksheet + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pWorksheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string XML Output + * @return string XML Output */ public function writeComments(\PhpOffice\PhpSpreadsheet\Worksheet $pWorksheet = null) { @@ -87,12 +87,12 @@ class Comments extends WriterPart /** * Write comment to XML format. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param string $pCellReference Cell reference - * @param \PhpOffice\PhpSpreadsheet\Comment $pComment Comment - * @param array $pAuthors Array of authors + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param string $pCellReference Cell reference + * @param \PhpOffice\PhpSpreadsheet\Comment $pComment Comment + * @param array $pAuthors Array of authors * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeComment(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, $pCellReference = 'A1', \PhpOffice\PhpSpreadsheet\Comment $pComment = null, $pAuthors = null) { @@ -186,11 +186,11 @@ class Comments extends WriterPart /** * Write VML comment to XML format. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param string $pCellReference Cell reference - * @param \PhpOffice\PhpSpreadsheet\Comment $pComment Comment + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param string $pCellReference Cell reference + * @param \PhpOffice\PhpSpreadsheet\Comment $pComment Comment * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeVMLComment(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, $pCellReference = 'A1', \PhpOffice\PhpSpreadsheet\Comment $pComment = null) { diff --git a/src/PhpSpreadsheet/Writer/Xlsx/ContentTypes.php b/src/PhpSpreadsheet/Writer/Xlsx/ContentTypes.php index 1ce7f868..ca6211f8 100644 --- a/src/PhpSpreadsheet/Writer/Xlsx/ContentTypes.php +++ b/src/PhpSpreadsheet/Writer/Xlsx/ContentTypes.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Xlsx; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -29,12 +29,12 @@ class ContentTypes extends WriterPart /** * Write content types to XML format. * - * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet - * @param bool $includeCharts Flag indicating if we should include drawing details for charts + * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet + * @param bool $includeCharts Flag indicating if we should include drawing details for charts * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string XML Output + * @return string XML Output */ public function writeContentTypes(\PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet = null, $includeCharts = false) { @@ -185,11 +185,11 @@ class ContentTypes extends WriterPart /** * Get image mime type. * - * @param string $pFile Filename + * @param string $pFile Filename * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string Mime Type + * @return string Mime Type */ private function getImageMimeType($pFile = '') { @@ -204,11 +204,11 @@ class ContentTypes extends WriterPart /** * Write Default content type. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param string $pPartname Part name - * @param string $pContentType Content type + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param string $pPartname Part name + * @param string $pContentType Content type * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeDefaultContentType(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, $pPartname = '', $pContentType = '') { @@ -226,11 +226,11 @@ class ContentTypes extends WriterPart /** * Write Override content type. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param string $pPartname Part name - * @param string $pContentType Content type + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param string $pPartname Part name + * @param string $pContentType Content type * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeOverrideContentType(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, $pPartname = '', $pContentType = '') { diff --git a/src/PhpSpreadsheet/Writer/Xlsx/DocProps.php b/src/PhpSpreadsheet/Writer/Xlsx/DocProps.php index 7c3c3688..3cc78cbe 100644 --- a/src/PhpSpreadsheet/Writer/Xlsx/DocProps.php +++ b/src/PhpSpreadsheet/Writer/Xlsx/DocProps.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Xlsx; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -31,9 +31,9 @@ class DocProps extends WriterPart * * @param \PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string XML Output + * @return string XML Output */ public function writeDocPropsApp(\PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet = null) { @@ -130,9 +130,9 @@ class DocProps extends WriterPart * * @param \PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string XML Output + * @return string XML Output */ public function writeDocPropsCore(\PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet = null) { @@ -199,9 +199,9 @@ class DocProps extends WriterPart * * @param \PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string XML Output + * @return string XML Output */ public function writeDocPropsCustom(\PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet = null) { diff --git a/src/PhpSpreadsheet/Writer/Xlsx/Drawing.php b/src/PhpSpreadsheet/Writer/Xlsx/Drawing.php index 3639bf1f..e4221ec4 100644 --- a/src/PhpSpreadsheet/Writer/Xlsx/Drawing.php +++ b/src/PhpSpreadsheet/Writer/Xlsx/Drawing.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Xlsx; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -29,13 +29,13 @@ class Drawing extends WriterPart /** * Write drawings to XML format. * - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pWorksheet - * @param int &$chartRef Chart ID - * @param bool $includeCharts Flag indicating if we should include drawing details for charts + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pWorksheet + * @param int &$chartRef Chart ID + * @param bool $includeCharts Flag indicating if we should include drawing details for charts * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string XML Output + * @return string XML Output */ public function writeDrawings(\PhpOffice\PhpSpreadsheet\Worksheet $pWorksheet, &$chartRef, $includeCharts = false) { @@ -84,11 +84,11 @@ class Drawing extends WriterPart /** * Write drawings to XML format. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Chart $pChart - * @param int $pRelationId + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Chart $pChart + * @param int $pRelationId * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ public function writeChart(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Chart $pChart = null, $pRelationId = -1) { @@ -157,11 +157,11 @@ class Drawing extends WriterPart /** * Write drawings to XML format. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing $pDrawing - * @param int $pRelationId + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing $pDrawing + * @param int $pRelationId * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ public function writeDrawing(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Worksheet\BaseDrawing $pDrawing = null, $pRelationId = -1) { @@ -335,11 +335,11 @@ class Drawing extends WriterPart /** * Write VML header/footer images to XML format. * - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pWorksheet + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pWorksheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string XML Output + * @return string XML Output */ public function writeVMLHeaderFooterImages(\PhpOffice\PhpSpreadsheet\Worksheet $pWorksheet = null) { @@ -484,11 +484,11 @@ class Drawing extends WriterPart /** * Write VML comment to XML format. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param string $pReference Reference - * @param \PhpOffice\PhpSpreadsheet\Worksheet\HeaderFooterDrawing $pImage Image + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param string $pReference Reference + * @param \PhpOffice\PhpSpreadsheet\Worksheet\HeaderFooterDrawing $pImage Image * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeVMLHeaderFooterImage(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, $pReference = '', \PhpOffice\PhpSpreadsheet\Worksheet\HeaderFooterDrawing $pImage = null) { @@ -527,11 +527,11 @@ class Drawing extends WriterPart /** * Get an array of all drawings. * - * @param \PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet + * @param \PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return \PhpOffice\PhpSpreadsheet\Worksheet\Drawing[] All drawings in PhpSpreadsheet + * @return \PhpOffice\PhpSpreadsheet\Worksheet\Drawing[] All drawings in PhpSpreadsheet */ public function allDrawings(\PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet = null) { diff --git a/src/PhpSpreadsheet/Writer/Xlsx/Rels.php b/src/PhpSpreadsheet/Writer/Xlsx/Rels.php index df577943..842eec07 100644 --- a/src/PhpSpreadsheet/Writer/Xlsx/Rels.php +++ b/src/PhpSpreadsheet/Writer/Xlsx/Rels.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Xlsx; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -31,9 +31,9 @@ class Rels extends WriterPart * * @param \PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string XML Output + * @return string XML Output */ public function writeRelationships(\PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet = null) { @@ -106,9 +106,9 @@ class Rels extends WriterPart * * @param \PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string XML Output + * @return string XML Output */ public function writeWorkbookRelationships(\PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet = null) { @@ -185,13 +185,13 @@ class Rels extends WriterPart * rId1 - Drawings * rId_hyperlink_x - Hyperlinks * - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pWorksheet - * @param int $pWorksheetId - * @param bool $includeCharts Flag indicating if we should write charts + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pWorksheet + * @param int $pWorksheetId + * @param bool $includeCharts Flag indicating if we should write charts * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string XML Output + * @return string XML Output */ public function writeWorksheetRelationships(\PhpOffice\PhpSpreadsheet\Worksheet $pWorksheet = null, $pWorksheetId = 1, $includeCharts = false) { @@ -280,13 +280,13 @@ class Rels extends WriterPart /** * Write drawing relationships to XML format. * - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pWorksheet - * @param int &$chartRef Chart ID - * @param bool $includeCharts Flag indicating if we should write charts + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pWorksheet + * @param int &$chartRef Chart ID + * @param bool $includeCharts Flag indicating if we should write charts * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string XML Output + * @return string XML Output */ public function writeDrawingRelationships(\PhpOffice\PhpSpreadsheet\Worksheet $pWorksheet, &$chartRef, $includeCharts = false) { @@ -347,11 +347,11 @@ class Rels extends WriterPart /** * Write header/footer drawing relationships to XML format. * - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pWorksheet + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pWorksheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string XML Output + * @return string XML Output */ public function writeHeaderFooterDrawingRelationships(\PhpOffice\PhpSpreadsheet\Worksheet $pWorksheet = null) { @@ -389,13 +389,13 @@ class Rels extends WriterPart /** * Write Override content type. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param int $pId Relationship ID. rId will be prepended! - * @param string $pType Relationship type - * @param string $pTarget Relationship target - * @param string $pTargetMode Relationship target mode + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param int $pId Relationship ID. rId will be prepended! + * @param string $pType Relationship type + * @param string $pTarget Relationship target + * @param string $pTargetMode Relationship target mode * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeRelationship(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, $pId = 1, $pType = '', $pTarget = '', $pTargetMode = '') { diff --git a/src/PhpSpreadsheet/Writer/Xlsx/RelsRibbon.php b/src/PhpSpreadsheet/Writer/Xlsx/RelsRibbon.php index 016e1ca4..d89a3dcd 100644 --- a/src/PhpSpreadsheet/Writer/Xlsx/RelsRibbon.php +++ b/src/PhpSpreadsheet/Writer/Xlsx/RelsRibbon.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Xlsx; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -31,7 +31,7 @@ class RelsRibbon extends WriterPart * * @param \PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * * @return string XML Output */ diff --git a/src/PhpSpreadsheet/Writer/Xlsx/RelsVBA.php b/src/PhpSpreadsheet/Writer/Xlsx/RelsVBA.php index f42011c8..b25e6705 100644 --- a/src/PhpSpreadsheet/Writer/Xlsx/RelsVBA.php +++ b/src/PhpSpreadsheet/Writer/Xlsx/RelsVBA.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Xlsx; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -31,9 +31,9 @@ class RelsVBA extends WriterPart * * @param \PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string XML Output + * @return string XML Output */ public function writeVBARelationships(\PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet = null) { diff --git a/src/PhpSpreadsheet/Writer/Xlsx/StringTable.php b/src/PhpSpreadsheet/Writer/Xlsx/StringTable.php index b4778b8a..fc780307 100644 --- a/src/PhpSpreadsheet/Writer/Xlsx/StringTable.php +++ b/src/PhpSpreadsheet/Writer/Xlsx/StringTable.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Xlsx; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -29,12 +29,12 @@ class StringTable extends WriterPart /** * Create worksheet stringtable. * - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet - * @param string[] $pExistingTable Existing table to eventually merge with + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet + * @param string[] $pExistingTable Existing table to eventually merge with * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string[] String table for worksheet + * @return string[] String table for worksheet */ public function createStringTable($pSheet = null, $pExistingTable = null) { @@ -79,11 +79,11 @@ class StringTable extends WriterPart /** * Write string table to XML format. * - * @param string[] $pStringTable + * @param string[] $pStringTable * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string XML Output + * @return string XML Output */ public function writeStringTable($pStringTable = null) { @@ -133,11 +133,11 @@ class StringTable extends WriterPart /** * Write Rich Text. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\RichText $pRichText Rich text - * @param string $prefix Optional Namespace prefix + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\RichText $pRichText Rich text + * @param string $prefix Optional Namespace prefix * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ public function writeRichText(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\RichText $pRichText = null, $prefix = null) { @@ -218,11 +218,11 @@ class StringTable extends WriterPart /** * Write Rich Text. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param string|\PhpOffice\PhpSpreadsheet\RichText $pRichText text string or Rich text - * @param string $prefix Optional Namespace prefix + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param string|\PhpOffice\PhpSpreadsheet\RichText $pRichText text string or Rich text + * @param string $prefix Optional Namespace prefix * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ public function writeRichTextForCharts(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, $pRichText = null, $prefix = null) { @@ -282,9 +282,9 @@ class StringTable extends WriterPart /** * Flip string table (for index searching). * - * @param array $stringTable Stringtable + * @param array $stringTable Stringtable * - * @return array + * @return array */ public function flipStringTable($stringTable = []) { diff --git a/src/PhpSpreadsheet/Writer/Xlsx/Style.php b/src/PhpSpreadsheet/Writer/Xlsx/Style.php index d9b507fd..3be4b76c 100644 --- a/src/PhpSpreadsheet/Writer/Xlsx/Style.php +++ b/src/PhpSpreadsheet/Writer/Xlsx/Style.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Xlsx; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -31,9 +31,9 @@ class Style extends WriterPart * * @param \PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string XML Output + * @return string XML Output */ public function writeStyles(\PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet = null) { @@ -161,10 +161,10 @@ class Style extends WriterPart /** * Write Fill. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Style\Fill $pFill Fill style + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Style\Fill $pFill Fill style * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeFill(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Style\Fill $pFill = null) { @@ -182,10 +182,10 @@ class Style extends WriterPart /** * Write Gradient Fill. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Style\Fill $pFill Fill style + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Style\Fill $pFill Fill style * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeGradientFill(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Style\Fill $pFill = null) { @@ -227,10 +227,10 @@ class Style extends WriterPart /** * Write Pattern Fill. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Style\Fill $pFill Fill style + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Style\Fill $pFill Fill style * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writePatternFill(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Style\Fill $pFill = null) { @@ -266,10 +266,10 @@ class Style extends WriterPart /** * Write Font. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Style\Font $pFont Font style + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Style\Font $pFont Font style * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeFont(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Style\Font $pFont = null) { @@ -347,10 +347,10 @@ class Style extends WriterPart /** * Write Border. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Style\Borders $pBorders Borders style + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Style\Borders $pBorders Borders style * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeBorder(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Style\Borders $pBorders = null) { @@ -384,11 +384,11 @@ class Style extends WriterPart /** * Write Cell Style Xf. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Style $pStyle Style - * @param \PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet Workbook + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Style $pStyle Style + * @param \PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet Workbook * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeCellStyleXf(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Style $pStyle = null, \PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet = null) { @@ -461,10 +461,10 @@ class Style extends WriterPart /** * Write Cell Style Dxf. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Style $pStyle Style + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Style $pStyle Style * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeCellStyleDxf(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Style $pStyle = null) { @@ -526,11 +526,11 @@ class Style extends WriterPart /** * Write BorderPr. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param string $pName Element name - * @param \PhpOffice\PhpSpreadsheet\Style\Border $pBorder Border style + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param string $pName Element name + * @param \PhpOffice\PhpSpreadsheet\Style\Border $pBorder Border style * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeBorderPr(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, $pName = 'left', \PhpOffice\PhpSpreadsheet\Style\Border $pBorder = null) { @@ -551,11 +551,11 @@ class Style extends WriterPart /** * Write NumberFormat. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Style\NumberFormat $pNumberFormat Number Format - * @param int $pId Number Format identifier + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Style\NumberFormat $pNumberFormat Number Format + * @param int $pId Number Format identifier * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeNumFmt(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Style\NumberFormat $pNumberFormat = null, $pId = 0) { @@ -574,11 +574,11 @@ class Style extends WriterPart /** * Get an array of all styles. * - * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet + * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return \PhpOffice\PhpSpreadsheet\Style[] All styles in PhpSpreadsheet + * @return \PhpOffice\PhpSpreadsheet\Style[] All styles in PhpSpreadsheet */ public function allStyles(\PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet = null) { @@ -588,11 +588,11 @@ class Style extends WriterPart /** * Get an array of all conditional styles. * - * @param \PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet + * @param \PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return \PhpOffice\PhpSpreadsheet\Style\Conditional[] All conditional styles in PhpSpreadsheet + * @return \PhpOffice\PhpSpreadsheet\Style\Conditional[] All conditional styles in PhpSpreadsheet */ public function allConditionalStyles(\PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet = null) { @@ -616,9 +616,9 @@ class Style extends WriterPart * * @param \PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return \PhpOffice\PhpSpreadsheet\Style\Fill[] All fills in PhpSpreadsheet + * @return \PhpOffice\PhpSpreadsheet\Style\Fill[] All fills in PhpSpreadsheet */ public function allFills(\PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet = null) { @@ -650,9 +650,9 @@ class Style extends WriterPart * * @param \PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return \PhpOffice\PhpSpreadsheet\Style\Font[] All fonts in PhpSpreadsheet + * @return \PhpOffice\PhpSpreadsheet\Style\Font[] All fonts in PhpSpreadsheet */ public function allFonts(\PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet = null) { @@ -675,9 +675,9 @@ class Style extends WriterPart * * @param \PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return \PhpOffice\PhpSpreadsheet\Style\Borders[] All borders in PhpSpreadsheet + * @return \PhpOffice\PhpSpreadsheet\Style\Borders[] All borders in PhpSpreadsheet */ public function allBorders(\PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet = null) { @@ -700,9 +700,9 @@ class Style extends WriterPart * * @param \PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return \PhpOffice\PhpSpreadsheet\Style\NumberFormat[] All number formats in PhpSpreadsheet + * @return \PhpOffice\PhpSpreadsheet\Style\NumberFormat[] All number formats in PhpSpreadsheet */ public function allNumberFormats(\PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet = null) { diff --git a/src/PhpSpreadsheet/Writer/Xlsx/Theme.php b/src/PhpSpreadsheet/Writer/Xlsx/Theme.php index cc66eea6..89ec67e6 100644 --- a/src/PhpSpreadsheet/Writer/Xlsx/Theme.php +++ b/src/PhpSpreadsheet/Writer/Xlsx/Theme.php @@ -14,12 +14,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Xlsx; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -133,9 +133,9 @@ class Theme extends WriterPart * * @param \PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string XML Output + * @return string XML Output */ public function writeTheme(\PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet = null) { @@ -815,13 +815,13 @@ class Theme extends WriterPart /** * Write fonts to XML format. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter - * @param string $latinFont - * @param array of string $fontSet + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter + * @param string $latinFont + * @param array of string $fontSet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string XML Output + * @return string XML Output */ private function writeFonts($objWriter, $latinFont, $fontSet) { @@ -851,11 +851,11 @@ class Theme extends WriterPart /** * Write colour scheme to XML format. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string XML Output + * @return string XML Output */ private function writeColourScheme($objWriter) { diff --git a/src/PhpSpreadsheet/Writer/Xlsx/Workbook.php b/src/PhpSpreadsheet/Writer/Xlsx/Workbook.php index 774e99ed..133d8585 100644 --- a/src/PhpSpreadsheet/Writer/Xlsx/Workbook.php +++ b/src/PhpSpreadsheet/Writer/Xlsx/Workbook.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Xlsx; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -30,11 +30,11 @@ class Workbook extends WriterPart * Write workbook to XML format. * * @param \PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet - * @param bool $recalcRequired Indicate whether formulas should be recalculated before writing + * @param bool $recalcRequired Indicate whether formulas should be recalculated before writing * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string XML Output + * @return string XML Output */ public function writeWorkbook(\PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet = null, $recalcRequired = false) { @@ -86,9 +86,9 @@ class Workbook extends WriterPart /** * Write file version. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeFileVersion(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter) { @@ -103,9 +103,9 @@ class Workbook extends WriterPart /** * Write WorkbookPr. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeWorkbookPr(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter) { @@ -123,10 +123,10 @@ class Workbook extends WriterPart /** * Write BookViews. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeBookViews(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter, \PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet = null) { @@ -154,10 +154,10 @@ class Workbook extends WriterPart /** * Write WorkbookProtection. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeWorkbookProtection(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter, \PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet = null) { @@ -182,10 +182,10 @@ class Workbook extends WriterPart /** * Write calcPr. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param bool $recalcRequired Indicate whether formulas should be recalculated before writing + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param bool $recalcRequired Indicate whether formulas should be recalculated before writing * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeCalcPr(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter, $recalcRequired = true) { @@ -206,10 +206,10 @@ class Workbook extends WriterPart /** * Write sheets. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeSheets(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter, \PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet = null) { @@ -233,13 +233,13 @@ class Workbook extends WriterPart /** * Write sheet. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param string $pSheetname Sheet name - * @param int $pSheetId Sheet id - * @param int $pRelId Relationship ID - * @param string $sheetState Sheet state (visible, hidden, veryHidden) + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param string $pSheetname Sheet name + * @param int $pSheetId Sheet id + * @param int $pRelId Relationship ID + * @param string $sheetState Sheet state (visible, hidden, veryHidden) * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeSheet(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter, $pSheetname = '', $pSheetId = 1, $pRelId = 1, $sheetState = 'visible') { @@ -261,10 +261,10 @@ class Workbook extends WriterPart /** * Write Defined Names. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeDefinedNames(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter, \PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet = null) { @@ -296,10 +296,10 @@ class Workbook extends WriterPart /** * Write named ranges. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer * @param \PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeNamedRanges(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter, \PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet) { @@ -313,10 +313,10 @@ class Workbook extends WriterPart /** * Write Defined Name for named range. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\NamedRange $pNamedRange + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\NamedRange $pNamedRange * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeDefinedNameForNamedRange(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter, \PhpOffice\PhpSpreadsheet\NamedRange $pNamedRange) { @@ -345,11 +345,11 @@ class Workbook extends WriterPart /** * Write Defined Name for autoFilter. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet - * @param int $pSheetId + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet + * @param int $pSheetId * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeDefinedNameForAutofilter(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter, \PhpOffice\PhpSpreadsheet\Worksheet $pSheet = null, $pSheetId = 0) { @@ -382,11 +382,11 @@ class Workbook extends WriterPart /** * Write Defined Name for PrintTitles. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet - * @param int $pSheetId + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet + * @param int $pSheetId * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeDefinedNameForPrintTitles(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter, \PhpOffice\PhpSpreadsheet\Worksheet $pSheet = null, $pSheetId = 0) { @@ -426,11 +426,11 @@ class Workbook extends WriterPart /** * Write Defined Name for PrintTitles. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet - * @param int $pSheetId + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet + * @param int $pSheetId * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeDefinedNameForPrintArea(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter, \PhpOffice\PhpSpreadsheet\Worksheet $pSheet = null, $pSheetId = 0) { diff --git a/src/PhpSpreadsheet/Writer/Xlsx/Worksheet.php b/src/PhpSpreadsheet/Writer/Xlsx/Worksheet.php index 22e8a570..4bea3a71 100644 --- a/src/PhpSpreadsheet/Writer/Xlsx/Worksheet.php +++ b/src/PhpSpreadsheet/Writer/Xlsx/Worksheet.php @@ -14,12 +14,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Xlsx; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -37,13 +37,13 @@ class Worksheet extends WriterPart /** * Write worksheet to XML format. * - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet - * @param string[] $pStringTable - * @param bool $includeCharts Flag indicating if we should write charts + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet + * @param string[] $pStringTable + * @param bool $includeCharts Flag indicating if we should write charts * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception * - * @return string XML Output + * @return string XML Output */ public function writeWorksheet($pSheet = null, $pStringTable = null, $includeCharts = false) { @@ -139,10 +139,10 @@ class Worksheet extends WriterPart /** * Write SheetPr. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeSheetPr(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Worksheet $pSheet = null) { @@ -187,10 +187,10 @@ class Worksheet extends WriterPart /** * Write Dimension. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeDimension(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Worksheet $pSheet = null) { @@ -203,10 +203,10 @@ class Worksheet extends WriterPart /** * Write SheetViews. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeSheetViews(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Worksheet $pSheet = null) { @@ -316,10 +316,10 @@ class Worksheet extends WriterPart /** * Write SheetFormatPr. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeSheetFormatPr(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Worksheet $pSheet = null) { @@ -369,10 +369,10 @@ class Worksheet extends WriterPart /** * Write Cols. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeCols(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Worksheet $pSheet = null) { @@ -435,10 +435,10 @@ class Worksheet extends WriterPart /** * Write SheetProtection. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeSheetProtection(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Worksheet $pSheet = null) { @@ -471,10 +471,10 @@ class Worksheet extends WriterPart /** * Write ConditionalFormatting. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeConditionalFormatting(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Worksheet $pSheet = null) { @@ -545,10 +545,10 @@ class Worksheet extends WriterPart /** * Write DataValidations. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeDataValidations(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Worksheet $pSheet = null) { @@ -612,10 +612,10 @@ class Worksheet extends WriterPart /** * Write Hyperlinks. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeHyperlinks(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Worksheet $pSheet = null) { @@ -654,10 +654,10 @@ class Worksheet extends WriterPart /** * Write ProtectedRanges. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeProtectedRanges(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Worksheet $pSheet = null) { @@ -684,10 +684,10 @@ class Worksheet extends WriterPart /** * Write MergeCells. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeMergeCells(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Worksheet $pSheet = null) { @@ -710,10 +710,10 @@ class Worksheet extends WriterPart /** * Write PrintOptions. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writePrintOptions(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Worksheet $pSheet = null) { @@ -737,10 +737,10 @@ class Worksheet extends WriterPart /** * Write PageMargins. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writePageMargins(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Worksheet $pSheet = null) { @@ -758,10 +758,10 @@ class Worksheet extends WriterPart /** * Write AutoFilter. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeAutoFilter(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Worksheet $pSheet = null) { @@ -852,10 +852,10 @@ class Worksheet extends WriterPart /** * Write PageSetup. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writePageSetup(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Worksheet $pSheet = null) { @@ -888,10 +888,10 @@ class Worksheet extends WriterPart /** * Write Header / Footer. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeHeaderFooter(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Worksheet $pSheet = null) { @@ -914,10 +914,10 @@ class Worksheet extends WriterPart /** * Write Breaks. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeBreaks(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Worksheet $pSheet = null) { @@ -972,11 +972,11 @@ class Worksheet extends WriterPart /** * Write SheetData. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet - * @param string[] $pStringTable String table + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet + * @param string[] $pStringTable String table * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeSheetData(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Worksheet $pSheet = null, $pStringTable = null) { @@ -1063,13 +1063,13 @@ class Worksheet extends WriterPart /** * Write Cell. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet - * @param \PhpOffice\PhpSpreadsheet\Cell $pCellAddress Cell Address - * @param string[] $pStringTable String table - * @param string[] $pFlippedStringTable String table (flipped), for faster index searching + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet + * @param \PhpOffice\PhpSpreadsheet\Cell $pCellAddress Cell Address + * @param string[] $pStringTable String table + * @param string[] $pFlippedStringTable String table (flipped), for faster index searching * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeCell(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Worksheet $pSheet = null, $pCellAddress = null, $pStringTable = null, $pFlippedStringTable = null) { @@ -1183,11 +1183,11 @@ class Worksheet extends WriterPart /** * Write Drawings. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet - * @param bool $includeCharts Flag indicating if we should include drawing details for charts + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet + * @param bool $includeCharts Flag indicating if we should include drawing details for charts * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeDrawings(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Worksheet $pSheet = null, $includeCharts = false) { @@ -1204,10 +1204,10 @@ class Worksheet extends WriterPart /** * Write LegacyDrawing. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeLegacyDrawing(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Worksheet $pSheet = null) { @@ -1222,10 +1222,10 @@ class Worksheet extends WriterPart /** * Write LegacyDrawingHF. * - * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer - * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet + * @param \PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter XML Writer + * @param \PhpOffice\PhpSpreadsheet\Worksheet $pSheet Worksheet * - * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception + * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ private function writeLegacyDrawingHF(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter $objWriter = null, \PhpOffice\PhpSpreadsheet\Worksheet $pSheet = null) { diff --git a/src/PhpSpreadsheet/Writer/Xlsx/WriterPart.php b/src/PhpSpreadsheet/Writer/Xlsx/WriterPart.php index 63d626e0..48744bb9 100644 --- a/src/PhpSpreadsheet/Writer/Xlsx/WriterPart.php +++ b/src/PhpSpreadsheet/Writer/Xlsx/WriterPart.php @@ -12,12 +12,12 @@ namespace PhpOffice\PhpSpreadsheet\Writer\Xlsx; * * This library is distributed in the hope that it will be useful, * 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. * * You should have received a copy of the GNU Lesser General Public * 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 * @@ -36,7 +36,7 @@ abstract class WriterPart /** * Set parent IWriter object. * - * @param \PhpOffice\PhpSpreadsheet\Writer\IWriter $pWriter + * @param \PhpOffice\PhpSpreadsheet\Writer\IWriter $pWriter * * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ @@ -63,7 +63,7 @@ abstract class WriterPart /** * Set parent IWriter object. * - * @param \PhpOffice\PhpSpreadsheet\Writer\IWriter $pWriter + * @param \PhpOffice\PhpSpreadsheet\Writer\IWriter $pWriter * * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception */ diff --git a/src/PhpSpreadsheet/locale/bg/config b/src/PhpSpreadsheet/locale/bg/config index e012aeb7..0391d387 100644 --- a/src/PhpSpreadsheet/locale/bg/config +++ b/src/PhpSpreadsheet/locale/bg/config @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/bg/functions b/src/PhpSpreadsheet/locale/bg/functions index 51e06207..85a24a58 100644 --- a/src/PhpSpreadsheet/locale/bg/functions +++ b/src/PhpSpreadsheet/locale/bg/functions @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/cs/config b/src/PhpSpreadsheet/locale/cs/config index d7f4a34e..6ec52d60 100644 --- a/src/PhpSpreadsheet/locale/cs/config +++ b/src/PhpSpreadsheet/locale/cs/config @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/cs/functions b/src/PhpSpreadsheet/locale/cs/functions index b1a44a72..fe00ed02 100644 --- a/src/PhpSpreadsheet/locale/cs/functions +++ b/src/PhpSpreadsheet/locale/cs/functions @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/da/config b/src/PhpSpreadsheet/locale/da/config index 62f3f5a7..7d3a4fb6 100644 --- a/src/PhpSpreadsheet/locale/da/config +++ b/src/PhpSpreadsheet/locale/da/config @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/da/functions b/src/PhpSpreadsheet/locale/da/functions index c8dd3957..a6e6a172 100644 --- a/src/PhpSpreadsheet/locale/da/functions +++ b/src/PhpSpreadsheet/locale/da/functions @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/de/config b/src/PhpSpreadsheet/locale/de/config index fe4a0a94..f980c1cb 100644 --- a/src/PhpSpreadsheet/locale/de/config +++ b/src/PhpSpreadsheet/locale/de/config @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/de/functions b/src/PhpSpreadsheet/locale/de/functions index 0847c11e..c08cd9f2 100644 --- a/src/PhpSpreadsheet/locale/de/functions +++ b/src/PhpSpreadsheet/locale/de/functions @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/en/uk/config b/src/PhpSpreadsheet/locale/en/uk/config index 962a7a92..4bc379f8 100644 --- a/src/PhpSpreadsheet/locale/en/uk/config +++ b/src/PhpSpreadsheet/locale/en/uk/config @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/es/config b/src/PhpSpreadsheet/locale/es/config index 07f37038..db13753c 100644 --- a/src/PhpSpreadsheet/locale/es/config +++ b/src/PhpSpreadsheet/locale/es/config @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/es/functions b/src/PhpSpreadsheet/locale/es/functions index c46bdfee..41882cd6 100644 --- a/src/PhpSpreadsheet/locale/es/functions +++ b/src/PhpSpreadsheet/locale/es/functions @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/fi/config b/src/PhpSpreadsheet/locale/fi/config index f5363fbb..cb8d0182 100644 --- a/src/PhpSpreadsheet/locale/fi/config +++ b/src/PhpSpreadsheet/locale/fi/config @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/fi/functions b/src/PhpSpreadsheet/locale/fi/functions index 7480ae0a..cd4fb891 100644 --- a/src/PhpSpreadsheet/locale/fi/functions +++ b/src/PhpSpreadsheet/locale/fi/functions @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/fr/config b/src/PhpSpreadsheet/locale/fr/config index 3907fb7c..dd1e630a 100644 --- a/src/PhpSpreadsheet/locale/fr/config +++ b/src/PhpSpreadsheet/locale/fr/config @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/fr/functions b/src/PhpSpreadsheet/locale/fr/functions index 3b7802fe..37af7b69 100644 --- a/src/PhpSpreadsheet/locale/fr/functions +++ b/src/PhpSpreadsheet/locale/fr/functions @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/hu/config b/src/PhpSpreadsheet/locale/hu/config index 31dcfdba..f3c19144 100644 --- a/src/PhpSpreadsheet/locale/hu/config +++ b/src/PhpSpreadsheet/locale/hu/config @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/hu/functions b/src/PhpSpreadsheet/locale/hu/functions index 3fed0df1..e4a21182 100644 --- a/src/PhpSpreadsheet/locale/hu/functions +++ b/src/PhpSpreadsheet/locale/hu/functions @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/it/config b/src/PhpSpreadsheet/locale/it/config index 5a8e0676..534100b9 100644 --- a/src/PhpSpreadsheet/locale/it/config +++ b/src/PhpSpreadsheet/locale/it/config @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/it/functions b/src/PhpSpreadsheet/locale/it/functions index 914a1d06..25ab3eb3 100644 --- a/src/PhpSpreadsheet/locale/it/functions +++ b/src/PhpSpreadsheet/locale/it/functions @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/nl/config b/src/PhpSpreadsheet/locale/nl/config index b95476f6..9522a62b 100644 --- a/src/PhpSpreadsheet/locale/nl/config +++ b/src/PhpSpreadsheet/locale/nl/config @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/nl/functions b/src/PhpSpreadsheet/locale/nl/functions index d52fad98..dd5d65dc 100644 --- a/src/PhpSpreadsheet/locale/nl/functions +++ b/src/PhpSpreadsheet/locale/nl/functions @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/no/config b/src/PhpSpreadsheet/locale/no/config index 983df31a..c7db6785 100644 --- a/src/PhpSpreadsheet/locale/no/config +++ b/src/PhpSpreadsheet/locale/no/config @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/no/functions b/src/PhpSpreadsheet/locale/no/functions index f86b9084..3b15d737 100644 --- a/src/PhpSpreadsheet/locale/no/functions +++ b/src/PhpSpreadsheet/locale/no/functions @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/pl/config b/src/PhpSpreadsheet/locale/pl/config index 4f91fdf3..48b74f0f 100644 --- a/src/PhpSpreadsheet/locale/pl/config +++ b/src/PhpSpreadsheet/locale/pl/config @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/pl/functions b/src/PhpSpreadsheet/locale/pl/functions index 370eeed3..4444e095 100644 --- a/src/PhpSpreadsheet/locale/pl/functions +++ b/src/PhpSpreadsheet/locale/pl/functions @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/pt/br/config b/src/PhpSpreadsheet/locale/pt/br/config index 970e99d6..760134ac 100644 --- a/src/PhpSpreadsheet/locale/pt/br/config +++ b/src/PhpSpreadsheet/locale/pt/br/config @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/pt/config b/src/PhpSpreadsheet/locale/pt/config index 56b4dd4f..417a102c 100644 --- a/src/PhpSpreadsheet/locale/pt/config +++ b/src/PhpSpreadsheet/locale/pt/config @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/ru/config b/src/PhpSpreadsheet/locale/ru/config index f4e00a23..30cba5bb 100644 --- a/src/PhpSpreadsheet/locale/ru/config +++ b/src/PhpSpreadsheet/locale/ru/config @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/ru/functions b/src/PhpSpreadsheet/locale/ru/functions index 43482c93..4eb8490b 100644 --- a/src/PhpSpreadsheet/locale/ru/functions +++ b/src/PhpSpreadsheet/locale/ru/functions @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/sv/config b/src/PhpSpreadsheet/locale/sv/config index 3d914b4a..2650dac1 100644 --- a/src/PhpSpreadsheet/locale/sv/config +++ b/src/PhpSpreadsheet/locale/sv/config @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/tr/config b/src/PhpSpreadsheet/locale/tr/config index 6cda815f..11de4a5d 100644 --- a/src/PhpSpreadsheet/locale/tr/config +++ b/src/PhpSpreadsheet/locale/tr/config @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet) diff --git a/src/PhpSpreadsheet/locale/tr/functions b/src/PhpSpreadsheet/locale/tr/functions index ca5de56d..22b557e2 100644 --- a/src/PhpSpreadsheet/locale/tr/functions +++ b/src/PhpSpreadsheet/locale/tr/functions @@ -11,12 +11,12 @@ ## ## This library is distributed in the hope that it will be useful, ## 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. ## ## You should have received a copy of the GNU Lesser General Public ## 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 ## @copyright Copyright (c) 2006 - 2013 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet)