Meta::write() - Code Metrics - Inspection of "Rename OOCalc and OpenDocument into Ods" - PHPOffice/PhpSpreadsheet - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 39b55d...e2e982 )

by Adrien

created 2016-10-06 12:10 UTC

Meta::write() A

↳ Parent: Meta

Complexity

Conditions	4
Paths	8

Size

Total Lines	58
Code Lines	39

Duplication

Lines	5
Ratio	8.62 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes

Metric	Value
cc	4
eloc	39
nc	8
nop	1
dl	5
loc	58
ccs	0
cts	44
cp	0
crap	20
rs	9.0077
c	0
b	0
f	0

How to fix Long Method

<?php

namespace PhpOffice\PhpSpreadsheet\Writer\Ods;

/**
 * Copyright (c) 2006 - 2015 PhpSpreadsheet
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * 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
 * 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
 *
 * @category   PhpSpreadsheet
 * @copyright  Copyright (c) 2006 - 2015 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet)
 * @license    http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt    LGPL
 * @version    ##VERSION##, ##DATE##
 */
class Meta extends WriterPart
{
    /**
     * Write meta.xml to XML format
     *
     * @param   \PhpOffice\PhpSpreadsheet\Spreadsheet                   $spreadsheet
     * @throws  \PhpOffice\PhpSpreadsheet\Writer\Exception
     * @return  string                     XML Output
     */
    public function write(\PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet = null)
    {
        if (!$spreadsheet) {
            $spreadsheet = $this->getParentWriter()->getSpreadsheet();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        }

        $objWriter = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        if ($this->getParentWriter()->getUseDiskCaching()) {
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            $objWriter = new \PhpOffice\PhpSpreadsheet\Shared\XMLWriter(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter::STORAGE_DISK, $this->getParentWriter()->getDiskCachingDirectory());
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        } else {
            $objWriter = new \PhpOffice\PhpSpreadsheet\Shared\XMLWriter(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter::STORAGE_MEMORY);
        }

        // XML header
        $objWriter->startDocument('1.0', 'UTF-8');

        // Meta
        $objWriter->startElement('office:document-meta');

        $objWriter->writeAttribute('xmlns:office', 'urn:oasis:names:tc:opendocument:xmlns:office:1.0');
        $objWriter->writeAttribute('xmlns:xlink', 'http://www.w3.org/1999/xlink');
        $objWriter->writeAttribute('xmlns:dc', 'http://purl.org/dc/elements/1.1/');
        $objWriter->writeAttribute('xmlns:meta', 'urn:oasis:names:tc:opendocument:xmlns:meta:1.0');
        $objWriter->writeAttribute('xmlns:ooo', 'http://openoffice.org/2004/office');
        $objWriter->writeAttribute('xmlns:grddl', 'http://www.w3.org/2003/g/data-view#');
        $objWriter->writeAttribute('office:version', '1.2');

        $objWriter->startElement('office:meta');

        $objWriter->writeElement('meta:initial-creator', $spreadsheet->getProperties()->getCreator());
        $objWriter->writeElement('dc:creator', $spreadsheet->getProperties()->getCreator());
        $objWriter->writeElement('meta:creation-date', date(DATE_W3C, $spreadsheet->getProperties()->getCreated()));
        $objWriter->writeElement('dc:date', date(DATE_W3C, $spreadsheet->getProperties()->getCreated()));
        $objWriter->writeElement('dc:title', $spreadsheet->getProperties()->getTitle());
        $objWriter->writeElement('dc:description', $spreadsheet->getProperties()->getDescription());
        $objWriter->writeElement('dc:subject', $spreadsheet->getProperties()->getSubject());
        $keywords = explode(' ', $spreadsheet->getProperties()->getKeywords());
        foreach ($keywords as $keyword) {
            $objWriter->writeElement('meta:keyword', $keyword);
        }

        //<meta:document-statistic meta:table-count="XXX" meta:cell-count="XXX" meta:object-count="XXX"/>
        $objWriter->startElement('meta:user-defined');
        $objWriter->writeAttribute('meta:name', 'Company');
        $objWriter->writeRaw($spreadsheet->getProperties()->getCompany());
        $objWriter->endElement();

        $objWriter->startElement('meta:user-defined');
        $objWriter->writeAttribute('meta:name', 'category');
        $objWriter->writeRaw($spreadsheet->getProperties()->getCategory());
        $objWriter->endElement();

        $objWriter->endElement();

        $objWriter->endElement();

        return $objWriter->getData();
    }
}


Push — develop ( 39b55d...e2e982 )

Meta::write() A

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Available Fixes

Available Fixes

Available Fixes

1		<?php
2
3		namespace PhpOffice\PhpSpreadsheet\Writer\Ods;
4
5		/**
6		* Copyright (c) 2006 - 2015 PhpSpreadsheet
7		*
8		* This library is free software; you can redistribute it and/or
9		* modify it under the terms of the GNU Lesser General Public
10		* License as published by the Free Software Foundation; either
11		* version 2.1 of the License, or (at your option) any later version.
12		*
13		* This library is distributed in the hope that it will be useful,
14		* but WITHOUT ANY WARRANTY; without even the implied warranty of
15		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16		* Lesser General Public License for more details.
17		*
18		* You should have received a copy of the GNU Lesser General Public
19		* License along with this library; if not, write to the Free Software
20		* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21		*
22		* @category PhpSpreadsheet
23		* @copyright Copyright (c) 2006 - 2015 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet)
24		* @license http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL
25		* @version ##VERSION##, ##DATE##
26		*/
27		class Meta extends WriterPart
28		{
29		/**
30		* Write meta.xml to XML format
31		*
32		* @param \PhpOffice\PhpSpreadsheet\Spreadsheet $spreadsheet
33		* @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
34		* @return string XML Output
35		*/
36		public function write(\PhpOffice\PhpSpreadsheet\SpreadSheet $spreadsheet = null)
37		{
38		if (!$spreadsheet) {
39		$spreadsheet = $this->getParentWriter()->getSpreadsheet();
		0 ignored issues – show Bug introduced 2016-10-06 12:29 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `PhpOffice\PhpSpreadsheet\Writer\IWriter` as the method `getSpreadsheet()` does only exist in the following implementations of said interface: `PhpOffice\PhpSpreadsheet\Writer\Ods`, `PhpOffice\PhpSpreadsheet\Writer\Xlsx`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
40		}
41
42		$objWriter = null;
		0 ignored issues – show Unused Code introduced 2016-08-14 05:24 UTC by Report Bug Copy Issue Report `$objWriter` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
43	View Code Duplication	if ($this->getParentWriter()->getUseDiskCaching()) {
		0 ignored issues – show Duplication introduced 2016-08-14 05:24 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history... Bug introduced 2016-10-06 12:29 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `PhpOffice\PhpSpreadsheet\Writer\IWriter` as the method `getUseDiskCaching()` does only exist in the following implementations of said interface: `PhpOffice\PhpSpreadsheet\Writer\BaseWriter`, `PhpOffice\PhpSpreadsheet\Writer\CSV`, `PhpOffice\PhpSpreadsheet\Writer\HTML`, `PhpOffice\PhpSpreadsheet\Writer\Ods`, `PhpOffice\PhpSpreadsheet\Writer\PDF\Core`, `PhpOffice\PhpSpreadsheet\Writer\PDF\DomPDF`, `PhpOffice\PhpSpreadsheet\Writer\PDF\MPDF`, `PhpOffice\PhpSpreadsheet\Writer\PDF\TcPDF`, `PhpOffice\PhpSpreadsheet\Writer\Xls`, `PhpOffice\PhpSpreadsheet\Writer\Xlsx`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
44		$objWriter = new \PhpOffice\PhpSpreadsheet\Shared\XMLWriter(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter::STORAGE_DISK, $this->getParentWriter()->getDiskCachingDirectory());
		0 ignored issues – show Bug introduced 2016-10-06 12:29 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `PhpOffice\PhpSpreadsheet\Writer\IWriter` as the method `getDiskCachingDirectory()` does only exist in the following implementations of said interface: `PhpOffice\PhpSpreadsheet\Writer\BaseWriter`, `PhpOffice\PhpSpreadsheet\Writer\CSV`, `PhpOffice\PhpSpreadsheet\Writer\HTML`, `PhpOffice\PhpSpreadsheet\Writer\Ods`, `PhpOffice\PhpSpreadsheet\Writer\PDF\Core`, `PhpOffice\PhpSpreadsheet\Writer\PDF\DomPDF`, `PhpOffice\PhpSpreadsheet\Writer\PDF\MPDF`, `PhpOffice\PhpSpreadsheet\Writer\PDF\TcPDF`, `PhpOffice\PhpSpreadsheet\Writer\Xls`, `PhpOffice\PhpSpreadsheet\Writer\Xlsx`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
45		} else {
46		$objWriter = new \PhpOffice\PhpSpreadsheet\Shared\XMLWriter(\PhpOffice\PhpSpreadsheet\Shared\XMLWriter::STORAGE_MEMORY);
47		}
48
49		// XML header
50		$objWriter->startDocument('1.0', 'UTF-8');
51
52		// Meta
53		$objWriter->startElement('office:document-meta');
54
55		$objWriter->writeAttribute('xmlns:office', 'urn:oasis:names:tc:opendocument:xmlns:office:1.0');
56		$objWriter->writeAttribute('xmlns:xlink', 'http://www.w3.org/1999/xlink');
57		$objWriter->writeAttribute('xmlns:dc', 'http://purl.org/dc/elements/1.1/');
58		$objWriter->writeAttribute('xmlns:meta', 'urn:oasis:names:tc:opendocument:xmlns:meta:1.0');
59		$objWriter->writeAttribute('xmlns:ooo', 'http://openoffice.org/2004/office');
60		$objWriter->writeAttribute('xmlns:grddl', 'http://www.w3.org/2003/g/data-view#');
61		$objWriter->writeAttribute('office:version', '1.2');
62
63		$objWriter->startElement('office:meta');
64
65		$objWriter->writeElement('meta:initial-creator', $spreadsheet->getProperties()->getCreator());
66		$objWriter->writeElement('dc:creator', $spreadsheet->getProperties()->getCreator());
67		$objWriter->writeElement('meta:creation-date', date(DATE_W3C, $spreadsheet->getProperties()->getCreated()));
68		$objWriter->writeElement('dc:date', date(DATE_W3C, $spreadsheet->getProperties()->getCreated()));
69		$objWriter->writeElement('dc:title', $spreadsheet->getProperties()->getTitle());
70		$objWriter->writeElement('dc:description', $spreadsheet->getProperties()->getDescription());
71		$objWriter->writeElement('dc:subject', $spreadsheet->getProperties()->getSubject());
72		$keywords = explode(' ', $spreadsheet->getProperties()->getKeywords());
73		foreach ($keywords as $keyword) {
74		$objWriter->writeElement('meta:keyword', $keyword);
75		}
76
77		//<meta:document-statistic meta:table-count="XXX" meta:cell-count="XXX" meta:object-count="XXX"/>
78		$objWriter->startElement('meta:user-defined');
79		$objWriter->writeAttribute('meta:name', 'Company');
80		$objWriter->writeRaw($spreadsheet->getProperties()->getCompany());
81		$objWriter->endElement();
82
83		$objWriter->startElement('meta:user-defined');
84		$objWriter->writeAttribute('meta:name', 'category');
85		$objWriter->writeRaw($spreadsheet->getProperties()->getCategory());
86		$objWriter->endElement();
87
88		$objWriter->endElement();
89
90		$objWriter->endElement();
91
92		return $objWriter->getData();
93		}
94		}
95

PHPOffice / PhpSpreadsheet

Push — develop ( 39b55d...e2e982 )

Meta::write() A

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like