PHPOffice / PhpSpreadsheet

src/PhpSpreadsheet/Worksheet.php

Doc Comments +7 added lines, -8 removed lines

@@ -580,7 +580,7 @@ 
      *
      * @throws Exception
      *
-     * @return false|Chart
+     * @return Chart
      */
     public function getChartByIndex($index)
     {
@@ -1091,7 +1091,7 @@ 
      * @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
+     * @return integer Highest row number that contains data
      */
     public function getHighestDataRow($column = null)
     {
@@ -1143,7 +1143,7 @@ 
      * Set a cell value.
      *
      * @param string $pCoordinate Coordinate of the cell, eg: 'A1'
-     * @param mixed $pValue Value of the cell
+     * @param string $pValue Value of the cell
      * @param string $pDataType Explicit data type, see Cell\DataType::TYPE_*
      *
      * @return Worksheet
@@ -1163,7 +1163,6 @@ 
      * @param int $pRow Numeric row coordinate of the cell
      * @param mixed $pValue Value of the cell
      * @param string $pDataType Explicit data type, see Cell\DataType::TYPE_*
-     * @param bool $returnCell Return the worksheet (false, default) or the cell (true)
      *
      * @return Worksheet
      */
@@ -1349,7 +1348,7 @@ 
      * Get row dimension at a specific row.
      *
      * @param int $pRow Numeric index of the row
-     * @param mixed $create
+     * @param boolean $create
      *
      * @return Worksheet\RowDimension
      */
@@ -1375,7 +1374,7 @@ 
      * Get column dimension at a specific column.
      *
      * @param string $pColumn String index of the column eg: 'A'
-     * @param mixed $create
+     * @param boolean $create
      *
      * @return Worksheet\ColumnDimension
      */
@@ -1921,7 +1920,7 @@ 
     /**
      * Set AutoFilter.
      *
-     * @param Worksheet\AutoFilter|string $pValue
+     * @param string $pValue
      *            A simple string containing a Cell range like 'A1:E10' is permitted for backward compatibility
      *
      * @throws Exception
@@ -2985,7 +2984,7 @@ 
      *
      * @throws Exception
      *
-     * @return objWorksheet
+     * @return Worksheet
      */
     public function setCodeName($pValue, $validate = true)
     {

tests/PhpSpreadsheetTests/WorksheetTest.php

Indentation +107 added lines, -107 removed lines

@@ -8,111 +8,111 @@
 
 class WorksheetTest extends PHPUnit_Framework_TestCase
 {
-	public function testSetTitle()
-	{
-		$test_title = str_repeat('a', 31);
-
-		$worksheet = new Worksheet();
-		$worksheet->setTitle($test_title);
-		$this->assertSame($test_title, $worksheet->getTitle());
-	}
-
-	public function setTitleInvalidProvider()
-	{
-		return [
-			[str_repeat('a', 32), 'Maximum 31 characters allowed in sheet title.'],
-			['invalid*title', 'Invalid character found in sheet title'],
-		];
-	}
-
-	/** @dataProvider setTitleInvalidProvider */
-	public function testSetTitleInvalid($title, $expect_message)
-	{
-		// First, test setting title with validation disabled -- should be successful
-		$worksheet = new Worksheet();
-		$worksheet->setTitle($title, true, false);
-
-		// Next, test again with validation enabled -- this time we should fail
-		$worksheet = new Worksheet();
-		$this->expectException(\Exception::class);
-		$this->expectExceptionMessage($expect_message);
-		$worksheet->setTitle($title);
-	}
-
-	public function testSetTitleDuplicate()
-	{
-		// Create a Spreadsheet with three Worksheets (the first is created automatically)
-		$spreadsheet = new Spreadsheet();
-		$spreadsheet->createSheet();
-		$spreadsheet->createSheet();
-
-		// Set unique title -- should be unchanged
-		$sheet = $spreadsheet->getSheet(0);
-		$sheet->setTitle('Test Title');
-		$this->assertSame('Test Title', $sheet->getTitle());
-
-		// Set duplicate title -- should have numeric suffix appended
-		$sheet = $spreadsheet->getSheet(1);
-		$sheet->setTitle('Test Title');
-		$this->assertSame('Test Title 1', $sheet->getTitle());
-
-		// Set duplicate title with validation disabled -- should be unchanged
-		$sheet = $spreadsheet->getSheet(2);
-		$sheet->setTitle('Test Title', true, false);
-		$this->assertSame('Test Title', $sheet->getTitle());
-	}
-
-	public function testSetCodeName()
-	{
-		$test_code_name = str_repeat('a', 31);
-
-		$worksheet = new Worksheet();
-		$worksheet->setCodeName($test_code_name);
-		$this->assertSame($test_code_name, $worksheet->getCodeName());
-	}
-
-	public function setCodeNameInvalidProvider()
-	{
-		return [
-			[str_repeat('a', 32), 'Maximum 31 characters allowed in sheet code name.'],
-			['invalid*code*name', 'Invalid character found in sheet code name'],
-		];
-	}
-
-	/** @dataProvider setCodeNameInvalidProvider */
-	public function testSetCodeNameInvalid($code_name, $expect_message)
-	{
-		// First, test setting code name with validation disabled -- should be successful
-		$worksheet = new Worksheet();
-		$worksheet->setCodeName($code_name, false);
-
-		// Next, test again with validation enabled -- this time we should fail
-		$worksheet = new Worksheet();
-		$this->expectException(\Exception::class);
-		$this->expectExceptionMessage($expect_message);
-		$worksheet->setCodeName($code_name);
-	}
-
-	public function testSetCodeNameDuplicate()
-	{
-		// Create a Spreadsheet with three Worksheets (the first is created automatically)
-		$spreadsheet = new Spreadsheet();
-		$spreadsheet->createSheet();
-		$spreadsheet->createSheet();
-
-		// Set unique code name -- should be massaged to Snake_Case
-		$sheet = $spreadsheet->getSheet(0);
-		$sheet->setCodeName('Test Code Name');
-		$this->assertSame('Test_Code_Name', $sheet->getCodeName());
-
-		// Set duplicate code name -- should be massaged and have numeric suffix appended
-		$sheet = $spreadsheet->getSheet(1);
-		$sheet->setCodeName('Test Code Name');
-		$this->assertSame('Test_Code_Name_1', $sheet->getCodeName());
-
-		// Set duplicate code name with validation disabled -- should be unchanged, and unmassaged
-		$sheet = $spreadsheet->getSheet(2);
-		$sheet->setCodeName('Test Code Name', false);
-		$this->assertSame('Test Code Name', $sheet->getCodeName());
-	}
+    public function testSetTitle()
+    {
+        $test_title = str_repeat('a', 31);
+
+        $worksheet = new Worksheet();
+        $worksheet->setTitle($test_title);
+        $this->assertSame($test_title, $worksheet->getTitle());
+    }
+
+    public function setTitleInvalidProvider()
+    {
+        return [
+            [str_repeat('a', 32), 'Maximum 31 characters allowed in sheet title.'],
+            ['invalid*title', 'Invalid character found in sheet title'],
+        ];
+    }
+
+    /** @dataProvider setTitleInvalidProvider */
+    public function testSetTitleInvalid($title, $expect_message)
+    {
+        // First, test setting title with validation disabled -- should be successful
+        $worksheet = new Worksheet();
+        $worksheet->setTitle($title, true, false);
+
+        // Next, test again with validation enabled -- this time we should fail
+        $worksheet = new Worksheet();
+        $this->expectException(\Exception::class);
+        $this->expectExceptionMessage($expect_message);
+        $worksheet->setTitle($title);
+    }
+
+    public function testSetTitleDuplicate()
+    {
+        // Create a Spreadsheet with three Worksheets (the first is created automatically)
+        $spreadsheet = new Spreadsheet();
+        $spreadsheet->createSheet();
+        $spreadsheet->createSheet();
+
+        // Set unique title -- should be unchanged
+        $sheet = $spreadsheet->getSheet(0);
+        $sheet->setTitle('Test Title');
+        $this->assertSame('Test Title', $sheet->getTitle());
+
+        // Set duplicate title -- should have numeric suffix appended
+        $sheet = $spreadsheet->getSheet(1);
+        $sheet->setTitle('Test Title');
+        $this->assertSame('Test Title 1', $sheet->getTitle());
+
+        // Set duplicate title with validation disabled -- should be unchanged
+        $sheet = $spreadsheet->getSheet(2);
+        $sheet->setTitle('Test Title', true, false);
+        $this->assertSame('Test Title', $sheet->getTitle());
+    }
+
+    public function testSetCodeName()
+    {
+        $test_code_name = str_repeat('a', 31);
+
+        $worksheet = new Worksheet();
+        $worksheet->setCodeName($test_code_name);
+        $this->assertSame($test_code_name, $worksheet->getCodeName());
+    }
+
+    public function setCodeNameInvalidProvider()
+    {
+        return [
+            [str_repeat('a', 32), 'Maximum 31 characters allowed in sheet code name.'],
+            ['invalid*code*name', 'Invalid character found in sheet code name'],
+        ];
+    }
+
+    /** @dataProvider setCodeNameInvalidProvider */
+    public function testSetCodeNameInvalid($code_name, $expect_message)
+    {
+        // First, test setting code name with validation disabled -- should be successful
+        $worksheet = new Worksheet();
+        $worksheet->setCodeName($code_name, false);
+
+        // Next, test again with validation enabled -- this time we should fail
+        $worksheet = new Worksheet();
+        $this->expectException(\Exception::class);
+        $this->expectExceptionMessage($expect_message);
+        $worksheet->setCodeName($code_name);
+    }
+
+    public function testSetCodeNameDuplicate()
+    {
+        // Create a Spreadsheet with three Worksheets (the first is created automatically)
+        $spreadsheet = new Spreadsheet();
+        $spreadsheet->createSheet();
+        $spreadsheet->createSheet();
+
+        // Set unique code name -- should be massaged to Snake_Case
+        $sheet = $spreadsheet->getSheet(0);
+        $sheet->setCodeName('Test Code Name');
+        $this->assertSame('Test_Code_Name', $sheet->getCodeName());
+
+        // Set duplicate code name -- should be massaged and have numeric suffix appended
+        $sheet = $spreadsheet->getSheet(1);
+        $sheet->setCodeName('Test Code Name');
+        $this->assertSame('Test_Code_Name_1', $sheet->getCodeName());
+
+        // Set duplicate code name with validation disabled -- should be unchanged, and unmassaged
+        $sheet = $spreadsheet->getSheet(2);
+        $sheet->setCodeName('Test Code Name', false);
+        $this->assertSame('Test Code Name', $sheet->getCodeName());
+    }
 }