CoreView::__customAnnotation() - Code Metrics - Inspection of "__customAnnotationをCoreInterfaceに定義" - webstream-framework/WebStream - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/0.7.0 ( a43410...0adc7f )

by Ryuichi

created 2016-03-05 03:11 UTC

CoreView::__customAnnotation() A

↳ Parent: CoreView

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php
namespace WebStream\Core;

use WebStream\Module\Container;
use WebStream\Module\Utility\CommonUtils;
use WebStream\Template\ITemplateEngine;
use WebStream\Annotation\Filter;
use WebStream\Annotation\Base\IAnnotatable;

/**
 * CoreViewクラス
 * @author Ryuichi TANAKA.
 * @since 2011/09/12
 * @version 0.7
 */
class CoreView implements CoreInterface, IAnnotatable
{
    use CommonUtils;

    /**
     * @var Container 依存コンテナ
     */
    private $container;

    /**
     * @var ITemplateEngine テンプレートエンジン
     */
    private $templateEngine;

    /**
     * @var LoggerAdapter ロガー
     */
    private $logger;

    /**
     * {@inheritdoc}
     */
    public function __construct(Container $container)
    {
        $this->container = $container;
        $this->logger = $container->logger;
<?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->logger->debug("View start.");
    }

    /**
     * {@inheritdoc}
     */
    public function __destruct()
    {
        $this->logger->debug("View end.");
    }

    /**
     * {@inheritdoc}
     * @Filter(type="initialize")
     */
    public function __initialize(Container $container)
    {
    }

    /**
     * {@inheritdoc}
     */
    public function __customAnnotation(array $annotation)
    {
    }

    /**
     * テンプレートエンジンを設定する
     * @param ITemplateEngine テンプレートエンジン
     */
    public function setTemplateEngine(ITemplateEngine $templateEngine = null)
    {
        $this->templateEngine = $templateEngine;
    }

    /**
     * テンプレートを描画する
     * @param array<string> パラメータ
     */
    public function draw(array $params)
    {
        $mimeType = $params["mimeType"] ?: "html";
        $this->outputHeader($mimeType);

        // HTML,XML以外はテンプレートを使用しない
        if ($mimeType !== "html" && $mimeType !== "xml") {
            $this->logger->debug("Only html or xml draw view template.");

            return;
        }

        if ($this->templateEngine !== null) {
            $this->templateEngine->render($params);
            if ($this->templateEngine instanceof \WebStream\Template\Basic) {
                $this->templateEngine->renderHelper($params);
            }
        }
    }

    /**
     * テンプレートキャッシュを作成する
     * @param string テンプレートファイルパス
     * @param string 保存データ
     * @param integer 有効期限
     */
    public function templateCache($filepath, $cacheData, $cacheTime)
    {
        if ($this->templateEngine instanceof \WebStream\Template\Basic) {
            $this->templateEngine->cache($filepath, $cacheData, $cacheTime);
        }
    }

    /**
     * 共通ヘッダを出力する
     * @param String ファイルタイプ
     */
    private function outputHeader($type)
    {
        $this->container->response->setType($type);
<?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.");
        }
    }

}
    }

    /**
     * publicディレクトリにある静的ファイルを表示する
     * @param String ファイルパス
     */
    final public function __file($filepath)
    {
        $publicDir = $this->container->applicationInfo->publicDir;
<?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.");
        }
    }

}
        if (preg_match('/\/views\/' . $publicDir . '\/img\/.+\.(?:jp(?:e|)g|png|bmp|(?:tif|gi)f)$/i', $filepath) ||
            preg_match('/\/views\/' . $publicDir . '\/css\/.+\.css$/i', $filepath) ||
            preg_match('/\/views\/' . $publicDir . '\/js\/.+\.js$/i', $filepath)) { // 画像,css,jsの場合
            $this->display($filepath);
        } elseif (preg_match('/\/views\/' . $publicDir . '\/file\/.+$/i', $filepath)) { // それ以外のファイル
            $this->download($filepath);
        } else { // 全てのファイル
            $this->display($filepath);
        }
    }

    /**
     * 画像、CSS、JavaScriptファイルを表示する
     * @param string ファイルパス
     */
    final private function display($filename)
    {
        $this->container->response->displayFile($filename);
<?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.");
        }
    }

}
    }

    /**
     * ファイルをダウンロードする
     * @param string ファイルパス
     */
    final private function download($filename)
    {
        $userAgent = $this->container->request->userAgent();
<?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->container->response->downloadFile($filename, $userAgent);
<?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.");
        }
    }

}
    }
}


1			<?php
2			namespace WebStream\Core;
3
4			use WebStream\Module\Container;
5			use WebStream\Module\Utility\CommonUtils;
6			use WebStream\Template\ITemplateEngine;
7			use WebStream\Annotation\Filter;
8			use WebStream\Annotation\Base\IAnnotatable;
9
10			/**
11			* CoreViewクラス
12			* @author Ryuichi TANAKA.
13			* @since 2011/09/12
14			* @version 0.7
15			*/
16			class CoreView implements CoreInterface, IAnnotatable
17			{
18			use CommonUtils;
19
20			/**
21			* @var Container 依存コンテナ
22			*/
23			private $container;
24
25			/**
26			* @var ITemplateEngine テンプレートエンジン
27			*/
28			private $templateEngine;
29
30			/**
31			* @var LoggerAdapter ロガー
32			*/
33			private $logger;
34
35			/**
36			* {@inheritdoc}
37			*/
38			public function __construct(Container $container)
39			{
40			$this->container = $container;
41			$this->logger = $container->logger;
			0 ignored issues – show Documentation introduced 2016-01-25 08:21 UTC by Report Bug Copy Issue Report The property `logger` does not exist on `object<WebStream\Module\Container>`. Since you implemented `__set`, maybe consider adding a @property annotation. 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...
42			$this->logger->debug("View start.");
43			}
44
45			/**
46			* {@inheritdoc}
47			*/
48			public function __destruct()
49			{
50			$this->logger->debug("View end.");
51			}
52
53			/**
54			* {@inheritdoc}
55			* @Filter(type="initialize")
56			*/
57			public function __initialize(Container $container)
58			{
59			}
60
61			/**
62			* {@inheritdoc}
63			*/
64			public function __customAnnotation(array $annotation)
65			{
66			}
67
68			/**
69			* テンプレートエンジンを設定する
70			* @param ITemplateEngine テンプレートエンジン
71			*/
72			public function setTemplateEngine(ITemplateEngine $templateEngine = null)
73			{
74			$this->templateEngine = $templateEngine;
75			}
76
77			/**
78			* テンプレートを描画する
79			* @param array<string> パラメータ
80			*/
81			public function draw(array $params)
82			{
83			$mimeType = $params["mimeType"] ?: "html";
84			$this->outputHeader($mimeType);
85
86			// HTML,XML以外はテンプレートを使用しない
87			if ($mimeType !== "html" && $mimeType !== "xml") {
88			$this->logger->debug("Only html or xml draw view template.");
89
90			return;
91			}
92
93			if ($this->templateEngine !== null) {
94			$this->templateEngine->render($params);
95			if ($this->templateEngine instanceof \WebStream\Template\Basic) {
96			$this->templateEngine->renderHelper($params);
97			}
98			}
99			}
100
101			/**
102			* テンプレートキャッシュを作成する
103			* @param string テンプレートファイルパス
104			* @param string 保存データ
105			* @param integer 有効期限
106			*/
107			public function templateCache($filepath, $cacheData, $cacheTime)
108			{
109			if ($this->templateEngine instanceof \WebStream\Template\Basic) {
110			$this->templateEngine->cache($filepath, $cacheData, $cacheTime);
111			}
112			}
113
114			/**
115			* 共通ヘッダを出力する
116			* @param String ファイルタイプ
117			*/
118			private function outputHeader($type)
119			{
120			$this->container->response->setType($type);
			0 ignored issues – show Documentation introduced 2016-01-25 08:21 UTC by Report Bug Copy Issue Report The property `response` does not exist on `object<WebStream\Module\Container>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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...
121			}
122
123			/**
124			* publicディレクトリにある静的ファイルを表示する
125			* @param String ファイルパス
126			*/
127			final public function __file($filepath)
128			{
129			$publicDir = $this->container->applicationInfo->publicDir;
			0 ignored issues – show Documentation introduced 2016-01-25 08:21 UTC by Report Bug Copy Issue Report The property `applicationInfo` does not exist on `object<WebStream\Module\Container>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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...
130			if (preg_match('/\/views\/' . $publicDir . '\/img\/.+\.(?:jp(?:e\|)g\|png\|bmp\|(?:tif\|gi)f)$/i', $filepath) \|\|
131			preg_match('/\/views\/' . $publicDir . '\/css\/.+\.css$/i', $filepath) \|\|
132			preg_match('/\/views\/' . $publicDir . '\/js\/.+\.js$/i', $filepath)) { // 画像,css,jsの場合
133			$this->display($filepath);
134			} elseif (preg_match('/\/views\/' . $publicDir . '\/file\/.+$/i', $filepath)) { // それ以外のファイル
135			$this->download($filepath);
136			} else { // 全てのファイル
137			$this->display($filepath);
138			}
139			}
140
141			/**
142			* 画像、CSS、JavaScriptファイルを表示する
143			* @param string ファイルパス
144			*/
145			final private function display($filename)
146			{
147			$this->container->response->displayFile($filename);
			0 ignored issues – show Documentation introduced 2016-01-25 08:21 UTC by Report Bug Copy Issue Report The property `response` does not exist on `object<WebStream\Module\Container>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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
150			/**
151			* ファイルをダウンロードする
152			* @param string ファイルパス
153			*/
154			final private function download($filename)
155			{
156			$userAgent = $this->container->request->userAgent();
			0 ignored issues – show Documentation introduced 2016-01-25 08:21 UTC by Report Bug Copy Issue Report The property `request` does not exist on `object<WebStream\Module\Container>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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...
157			$this->container->response->downloadFile($filename, $userAgent);
			0 ignored issues – show Documentation introduced 2016-01-25 08:21 UTC by Report Bug Copy Issue Report The property `response` does not exist on `object<WebStream\Module\Container>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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...
158			}
159			}
160

webstream-framework / WebStream

Push — feature/0.7.0 ( a43410...0adc7f )

CoreView::__customAnnotation() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like