BaseExport::setTitle() - Code Metrics - Inspection of "Support for mutiple export" - o5/grido - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#263)

by AntikCz

created 2016-02-26 18:47 UTC

BaseExport::setTitle() A

↳ Parent: BaseExport

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	5
rs	9.4285
cc	1
eloc	3
nc	1
nop	1

<?php

namespace Grido\Components\Exports;

use Grido\Components\Component;
use Grido\Grid;
use Nette\Application\IResponse;
use Nette\Utils\Strings;

/**
 * Exporting data.
 *
 * @package     Grido
 * @subpackage  Components
 *
 * @property int $fetchLimit
 * @property-write array $header
 * @property-write callable $customData
 */
abstract class BaseExport extends Component implements IResponse
{

    const ID = 'export';

    /** @var int */
    protected $fetchLimit = 100000;

    /** @var array */
    protected $header = [];

    /** @var callable */
    protected $customData;

    /** @var string */
    private $title;

    /**
     * @param string $label
     */
    public function __construct($label = NULL)
    {
        $this->label = $label;
        $this->monitor('Grido\Grid');
    }

    protected function attached($presenter)
    {
        parent::attached($presenter);
        if ($presenter instanceof Grid) {
            $this->grid = $presenter;
        }
    }

    /**
     * @return void
     */
    abstract protected function printData();

    /**
     * @param \Nette\Http\IResponse $httpResponse
     * @param string $label
     * @return void
     */
    abstract protected function setHttpHeaders(\Nette\Http\IResponse $httpResponse, $label);

    /**
     * @param string $title
     * @return self
     */
    public function setTitle($title)
    {
        $this->title = $title;
        return $this;
    }

    /**
     * @return string
     */
    public function getTitle()
    {
        return $this->title;
    }

    /**
     * Sets a limit which will be used in order to retrieve data from datasource.
     * @param int $limit
     * @return \Grido\Components\Export
     */
    public function setFetchLimit($limit)
    {
        $this->fetchLimit = (int) $limit;
        return $this;
    }

    /**
     * @return int
     */
    public function getFetchLimit()
    {
        return $this->fetchLimit;
    }

    /**
     * Sets a custom header of result CSV file (list of field names).
     * @param array $header
     * @return \Grido\Components\Export
     */
    public function setHeader(array $header)
    {
        $this->header = $header;
        return $this;
    }

    /**
     * Sets a callback to modify output data. This callback must return a list of items. (array) function($datasource)
     * DEBUG? You probably need to comment lines started with $httpResponse->setHeader in Grido\Components\Export.php
     * @param callable $callback
     * @return \Grido\Components\Export
     */
    public function setCustomData($callback)
    {
        $this->customData = $callback;
        return $this;
    }

    /**
     * @internal
     */
    public function handleExport()
    {
        !empty($this->grid->onRegistered) && $this->grid->onRegistered($this->grid);
        $this->grid->presenter->sendResponse($this);
    }

    /*************************** interface \Nette\Application\IResponse ***************************/

    /**
     * Sends response to output.
     * @param \Nette\Http\IRequest $httpRequest
     * @param \Nette\Http\IResponse $httpResponse
     * @return void
     */
    public function send(\Nette\Http\IRequest $httpRequest, \Nette\Http\IResponse $httpResponse)
    {
        $label = $this->label
            ? ucfirst(Strings::webalize($this->label))
            : ucfirst($this->grid->name);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        $this->setHttpHeaders($httpResponse, $label);

        print chr(0xEF) . chr(0xBB) . chr(0xBF); //UTF-8 BOM
        $this->printData();
    }
}


1			<?php
2
3			namespace Grido\Components\Exports;
4
5			use Grido\Components\Component;
6			use Grido\Grid;
7			use Nette\Application\IResponse;
8			use Nette\Utils\Strings;
9
10			/**
11			* Exporting data.
12			*
13			* @package Grido
14			* @subpackage Components
15			*
16			* @property int $fetchLimit
17			* @property-write array $header
18			* @property-write callable $customData
19			*/
20			abstract class BaseExport extends Component implements IResponse
21			{
22
23			const ID = 'export';
24
25			/** @var int */
26			protected $fetchLimit = 100000;
27
28			/** @var array */
29			protected $header = [];
30
31			/** @var callable */
32			protected $customData;
33
34			/** @var string */
35			private $title;
36
37			/**
38			* @param string $label
39			*/
40			public function __construct($label = NULL)
41			{
42			$this->label = $label;
43			$this->monitor('Grido\Grid');
44			}
45
46			protected function attached($presenter)
47			{
48			parent::attached($presenter);
49			if ($presenter instanceof Grid) {
50			$this->grid = $presenter;
51			}
52			}
53
54			/**
55			* @return void
56			*/
57			abstract protected function printData();
58
59			/**
60			* @param \Nette\Http\IResponse $httpResponse
61			* @param string $label
62			* @return void
63			*/
64			abstract protected function setHttpHeaders(\Nette\Http\IResponse $httpResponse, $label);
65
66			/**
67			* @param string $title
68			* @return self
69			*/
70			public function setTitle($title)
71			{
72			$this->title = $title;
73			return $this;
74			}
75
76			/**
77			* @return string
78			*/
79			public function getTitle()
80			{
81			return $this->title;
82			}
83
84			/**
85			* Sets a limit which will be used in order to retrieve data from datasource.
86			* @param int $limit
87			* @return \Grido\Components\Export
88			*/
89			public function setFetchLimit($limit)
90			{
91			$this->fetchLimit = (int) $limit;
92			return $this;
93			}
94
95			/**
96			* @return int
97			*/
98			public function getFetchLimit()
99			{
100			return $this->fetchLimit;
101			}
102
103			/**
104			* Sets a custom header of result CSV file (list of field names).
105			* @param array $header
106			* @return \Grido\Components\Export
107			*/
108			public function setHeader(array $header)
109			{
110			$this->header = $header;
111			return $this;
112			}
113
114			/**
115			* Sets a callback to modify output data. This callback must return a list of items. (array) function($datasource)
116			* DEBUG? You probably need to comment lines started with $httpResponse->setHeader in Grido\Components\Export.php
117			* @param callable $callback
118			* @return \Grido\Components\Export
119			*/
120			public function setCustomData($callback)
121			{
122			$this->customData = $callback;
123			return $this;
124			}
125
126			/**
127			* @internal
128			*/
129			public function handleExport()
130			{
131			!empty($this->grid->onRegistered) && $this->grid->onRegistered($this->grid);
132			$this->grid->presenter->sendResponse($this);
133			}
134
135			/************************* interface \Nette\Application\IResponse *************************/
136
137			/**
138			* Sends response to output.
139			* @param \Nette\Http\IRequest $httpRequest
140			* @param \Nette\Http\IResponse $httpResponse
141			* @return void
142			*/
143			public function send(\Nette\Http\IRequest $httpRequest, \Nette\Http\IResponse $httpResponse)
144			{
145			$label = $this->label
146			? ucfirst(Strings::webalize($this->label))
147			: ucfirst($this->grid->name);
			0 ignored issues – show Documentation introduced 2016-02-24 13:33 UTC by Report Bug Copy Issue Report The property `$name` is declared private in `Nette\ComponentModel\Component`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
148
149			$this->setHttpHeaders($httpResponse, $label);
150
151			print chr(0xEF) . chr(0xBB) . chr(0xBF); //UTF-8 BOM
152			$this->printData();
153			}
154			}
155

o5 / grido

Pull Request — master (#263)

BaseExport::setTitle() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like