webstream-framework / WebStream

WebStream/Delegate/Router.php

Doc Comments +3 added lines, -1 removed lines

@@ -34,7 +34,7 @@ 
 
     /**
      * コンストラクタ
-     * @param Request リクエストオブジェクト
+     * @param Request Container
      */
     public function __construct(array $rules, Container $request)
     {
@@ -190,6 +190,7 @@ 
     /**
      * コントローラを設定する
      * @param string コントローラ文字列
+     * @param string $controller
      */
     private function setController($controller)
     {
@@ -202,6 +203,7 @@ 
     /**
      * アクションを設定する
      * @param string アクション文字列
+     * @param string $action
      */
     private function setAction($action)
     {

Spacing +10 added lines, -10 removed lines

@@ -82,11 +82,11 @@ 
             // 静的ファイルへのパスがルーティングルールに定義された場合
             // パス定義された時点で弾く
             if (preg_match('/\/(img|js|css|file)(?:$|\/)/', $path)) {
-                throw new RouterException("Include the prohibit routing path: " . $path);
+                throw new RouterException("Include the prohibit routing path: ".$path);
             }
             // 許可したルーティングパス定義に合っていなければ弾く
             if (!preg_match('/^\/{1}(?:$|:?[a-zA-Z]{1}[a-zA-Z0-9-_\/\.:]{0,}$)/', $path)) {
-                throw new RouterException("Invalid path defintion: " . $path);
+                throw new RouterException("Invalid path defintion: ".$path);
             }
             // ルールとURLがマッチした場合に動的にチェックを掛ける
             // パスがマッチしたときにアクション名をチェックし、その時点で弾く
@@ -96,7 +96,7 @@ 
                 // NG例：my__blog, my_blog_
                 if (!preg_match('/^(?:([a-z]{1}(?:_(?=[a-z])|[a-z0-9])+))#(?:([a-z]{1}(?:_(?=[a-z])|[a-z0-9])+))$/', $ca, $matches)) {
                     // ルーティング定義(Controller#Action)が正しくない場合
-                    throw new RouterException("Invalid controller#action definition: " . $ca);
+                    throw new RouterException("Invalid controller#action definition: ".$ca);
                 }
             }
         }
@@ -129,7 +129,7 @@ 
             if (($this->request->pathInfo !== $path) &&
                 count(explode('/', $path)) === count(explode('/', $this->request->pathInfo))) {
                 // プレースホルダと実URLをひもづける
-                $pathPattern = "/^\/" . implode("\/", $tokens) . "$/";
+                $pathPattern = "/^\/".implode("\/", $tokens)."$/";
                 if (preg_match($pathPattern, $this->request->pathInfo, $matches)) {
                     for ($j = 1; $j < count($matches); $j++) {
                         $key = $keyList[$j - 1];
@@ -146,7 +146,7 @@ 
                 $this->setController($matches[1]);
                 $this->setAction($matches[2]);
                 $this->routingContainer->params = $placeholderedParams;
-                $this->logger->info("Routed path: " . $matches[1] . "#" . $matches[2]);
+                $this->logger->info("Routed path: ".$matches[1]."#".$matches[2]);
 
                 // ルーティングルールがマッチした場合は抜ける
                 return true;
@@ -161,7 +161,7 @@ 
      */
     private function resolveStaticFilePath()
     {
-        $staticFile = $this->applicationInfo->applicationRoot . "/app/views/" . $this->applicationInfo->publicDir .  $this->request->pathInfo;
+        $staticFile = $this->applicationInfo->applicationRoot."/app/views/".$this->applicationInfo->publicDir.$this->request->pathInfo;
 
         if (is_file($staticFile)) {
             $this->routingContainer->staticFile = $staticFile;
@@ -170,10 +170,10 @@ 
             $less = new \lessc();
             $dirpath = dirname($staticFile);
             $filenameWitoutExt = pathinfo($staticFile, PATHINFO_FILENAME);
-            $lessFilepath = $dirpath . "/" . $filenameWitoutExt . ".less";
+            $lessFilepath = $dirpath."/".$filenameWitoutExt.".less";
             // lessファイルも見つからない場合はエラー
             if (!file_exists($lessFilepath)) {
-                $this->logger->error("The file of css has been specified, but not found even file of less:" . $lessFilepath);
+                $this->logger->error("The file of css has been specified, but not found even file of less:".$lessFilepath);
 
                 return;
             }
@@ -181,7 +181,7 @@ 
                 if (is_file($staticFile)) {
                     $this->routingContainer->staticFile = $staticFile;
                 } else {
-                    $this->logger->error("Failed to file create, cause parmission denied: " . $dirpath);
+                    $this->logger->error("Failed to file create, cause parmission denied: ".$dirpath);
                 }
             }
         }
@@ -195,7 +195,7 @@ 
     {
         if (isset($controller)) {
             $this->routingContainer->pageName = $this->snake2ucamel($controller);
-            $this->routingContainer->controller = $this->snake2ucamel($controller) . "Controller";
+            $this->routingContainer->controller = $this->snake2ucamel($controller)."Controller";
         }
     }
 

WebStream/DI/Injector.php

Doc Comments +1 added lines

@@ -17,6 +17,7 @@
      * オブジェクトを注入する
      * @param string プロパティ名
      * @param mixed オブジェクト
+     * @param string $name
      * @return Injector
      */
     public function inject($name, $object)

WebStream/DI/ServiceLocator.php

Doc Comments +1 added lines, -1 removed lines

@@ -26,7 +26,7 @@
     /**
      * コンテナを作成する
      * @param boolean テスト環境フラグ
-     * @return object コンテナ
+     * @return Container コンテナ
      */
     public function getContainer()
     {

Indentation +1 added lines, -1 removed lines

@@ -63,7 +63,7 @@
             $config = \Spyc::YAMLLoad($container->applicationInfo->applicationRoot . $container->applicationInfo->routeConfigPath);
             $router = new Router($config, $container->request);
             $router->inject('logger', $container->logger)
-                   ->inject('applicationInfo', $container->applicationInfo);
+                    ->inject('applicationInfo', $container->applicationInfo);
             $router->resolve();
 
             return $router->getRoutingResult();

Spacing +9 added lines, -9 removed lines

@@ -33,34 +33,34 @@ 
         $container = new Container();
 
         // LoggerAdapter
-        $container->logger = function () {
+        $container->logger = function() {
             return new LoggerAdapter(Logger::getInstance());
         };
         // Request
-        $container->request = function () use (&$container) {
+        $container->request = function() use (&$container) {
             $request = new Request();
             $request->inject('logger', $container->logger);
 
             return $request->getContainer();
         };
         // Response
-        $container->response = function () use (&$container) {
+        $container->response = function() use (&$container) {
             $response = new Response();
             $response->inject('logger', $container->logger);
 
             return $response;
         };
         // Session
-        $container->session = function () use (&$container) {
+        $container->session = function() use (&$container) {
             $session = new Session();
             $session->inject('logger', $container->logger);
 
             return $session;
         };
         // Router
-        $container->router = function () use (&$container) {
+        $container->router = function() use (&$container) {
             // Router
-            $config = \Spyc::YAMLLoad($container->applicationInfo->applicationRoot . $container->applicationInfo->routeConfigPath);
+            $config = \Spyc::YAMLLoad($container->applicationInfo->applicationRoot.$container->applicationInfo->routeConfigPath);
             $router = new Router($config, $container->request);
             $router->inject('logger', $container->logger)
                    ->inject('applicationInfo', $container->applicationInfo);
@@ -69,15 +69,15 @@ 
             return $router->getRoutingResult();
         };
         // CoreDelegator
-        $container->coreDelegator = function () use (&$container) {
+        $container->coreDelegator = function() use (&$container) {
             return new CoreDelegator($container);
         };
         // AnnotationDelegator
-        $container->annotationDelegator = function () use (&$container) {
+        $container->annotationDelegator = function() use (&$container) {
             return new AnnotationDelegator($container);
         };
         // twig
-        $container->twig = function () {
+        $container->twig = function() {
             Twig_Autoloader::register();
         };
         // Application Info

WebStream/Exception/SystemException.php

Doc Comments +1 added lines

@@ -13,6 +13,7 @@
 {
     /**
      * constructor
+     * @param \Exception $exception
      */
     public function __construct($message, $code = 500, $exception = null)
     {

Spacing +1 added lines, -1 removed lines

@@ -26,7 +26,7 @@
             $exception = $this;
         }
 
-        Logger::error(get_class($exception) . " is thrown: " . $exception->getFile() . "(" . $exception->getLine() . ")");
+        Logger::error(get_class($exception)." is thrown: ".$exception->getFile()."(".$exception->getLine().")");
         if (!empty($message)) {
             Logger::error($this->getMessage(), $this->getTraceAsString());
         }

WebStream/Http/Request.php

Doc Comments +1 added lines

@@ -108,6 +108,7 @@
     /**
      * SERVERパラメータ取得
      * @param string パラメータキー
+     * @param string $key
      */
     private function server($key)
     {

WebStream/Http/Response.php

Doc Comments +9 added lines

@@ -67,6 +67,7 @@ 
     /**
      * Cache-Controlを設定
      * @param String Cache-Control
+     * @param string $cacheControl
      */
     public function setCacheControl($cacheControl)
     {
@@ -76,6 +77,7 @@ 
     /**
      * Pragmaを設定
      * @param String Pragma
+     * @param string $pragma
      */
     public function setPragma($pragma)
     {
@@ -86,6 +88,7 @@ 
      * MimeTypeを設定
      * ファイルタイプにより指定
      * @param String ファイルタイプ
+     * @param string $fileType
      */
     public function setType($fileType)
     {
@@ -167,6 +170,7 @@ 
     /**
      * Content-Lengthを設定
      * @param Integer Content-Length
+     * @param integer $contentLength
      */
     public function setContentLength($contentLength)
     {
@@ -187,6 +191,7 @@ 
     /**
      * Content-Transfer-Encodingを設定
      * @param String エンコーディング方法
+     * @param string $contentTransferEncoding
      */
     public function setContentTransferEncoding($contentTransferEncoding)
     {
@@ -196,6 +201,7 @@ 
     /**
      * Expiresを設定
      * @param Integer 有効期限
+     * @param integer $expires
      */
     public function setExpires($expires)
     {
@@ -205,6 +211,7 @@ 
     /**
      * レスポンスボディを設定
      * @param String レスポンスボディ
+     * @param string $body
      */
     public function setBody($body)
     {
@@ -504,6 +511,7 @@ 
     /**
      * 指定したステータスコードのページに遷移
      * @param Integer ステータスコード
+     * @param integer $statusCode
      */
     public function move($statusCode)
     {
@@ -545,6 +553,7 @@ 
     /**
      * HTMLテンプレート
      * @param String 表示内容
+     * @param string $content
      * @return String HTML
      */
     private function bodyTemplate($content)

Indentation +1 added lines, -1 removed lines

@@ -236,7 +236,7 @@
     {
         // StatusCode
         $headerMessage = 'HTTP/' . self::HTTP_VERSION . ' ' .
-                         $this->statusCode . ' ' . $this->status[$this->statusCode];
+                            $this->statusCode . ' ' . $this->status[$this->statusCode];
         header($headerMessage);
 
         // Redirect

Spacing +18 added lines, -18 removed lines

@@ -155,11 +155,11 @@ 
     public function setStatusCode($statusCode)
     {
         if (!is_string($statusCode) && !is_int($statusCode)) {
-            throw new ConnectionException("Invalid status code format: " . strval($statusCode));
+            throw new ConnectionException("Invalid status code format: ".strval($statusCode));
         }
 
         if (!array_key_exists($statusCode, $this->status)) {
-            throw new ConnectionException("Unknown status code: " . $statusCode);
+            throw new ConnectionException("Unknown status code: ".$statusCode);
         }
         $this->statusCode = $statusCode;
     }
@@ -180,7 +180,7 @@ 
     public function setContentDisposition($filename)
     {
         if (file_exists($filename)) {
-            $this->contentDisposition = 'attachement; filename="'. basename($filename) . '"';
+            $this->contentDisposition = 'attachement; filename="'.basename($filename).'"';
         }
     }
 
@@ -235,43 +235,43 @@ 
     public function header()
     {
         // StatusCode
-        $headerMessage = 'HTTP/' . self::HTTP_VERSION . ' ' .
-                         $this->statusCode . ' ' . $this->status[$this->statusCode];
+        $headerMessage = 'HTTP/'.self::HTTP_VERSION.' '.
+                         $this->statusCode.' '.$this->status[$this->statusCode];
         header($headerMessage);
 
         // Redirect
         if (intval($this->statusCode) === 301) {
-            header('Location: ' . $this->location);
+            header('Location: '.$this->location);
         }
 
         // Content-Type
-        header('Content-Type: ' . $this->mimeType . '; charset=' . $this->charset);
+        header('Content-Type: '.$this->mimeType.'; charset='.$this->charset);
 
         // Content-Length
         if ($this->contentLength === null) {
             $this->contentLength = $this->bytelen($this->body);
         }
-        header('Content-Length: ' . $this->contentLength);
+        header('Content-Length: '.$this->contentLength);
 
         // Content-Disposition
         if ($this->contentDisposition !== null) {
-            header('Content-Disposition: ' . $this->contentDisposition);
+            header('Content-Disposition: '.$this->contentDisposition);
         }
 
         // Content-Transfer-Encoding
         if ($this->contentTransferEncoding !== null) {
-            header('Content-Transfer-Encoding: ' . $this->contentTransferEncoding);
+            header('Content-Transfer-Encoding: '.$this->contentTransferEncoding);
         }
 
         // Cache-Control
-        header('Cache-Control: ' . $this->cacheControl);
+        header('Cache-Control: '.$this->cacheControl);
 
         // Pragma
-        header('Pragma: ' . $this->pragma);
+        header('Pragma: '.$this->pragma);
 
         // Expires
         if ($this->expires !== null) {
-            header('Expires: ' . $this->expires);
+            header('Expires: '.$this->expires);
         }
 
         // X-Content-Type-Options
@@ -279,20 +279,20 @@ 
 
         // Access-Control-Allow-Origin
         if (!empty($this->accessControlAllowOrigin)) {
-            header('Access-Control-Allow-Origin: ' . implode(',', $this->accessControlAllowOrigin));
+            header('Access-Control-Allow-Origin: '.implode(',', $this->accessControlAllowOrigin));
         }
 
         // X-Frame-Options
         if ($this->xframeOptions !== null) {
-            header('X-Frame-Options: ' . $this->xframeOptions);
+            header('X-Frame-Options: '.$this->xframeOptions);
         }
 
         // X-XSS-Protection
         if ($this->xxssProtection !== null) {
-            header('X-XSS-Protection: ' . $this->xxssProtection);
+            header('X-XSS-Protection: '.$this->xxssProtection);
         }
 
-        $this->logger->info("HTTP access occured: status code " . $this->statusCode);
+        $this->logger->info("HTTP access occured: status code ".$this->statusCode);
     }
 
     /**
@@ -510,7 +510,7 @@ 
         ob_clean(); // これまでの出力バッファをクリア
         $statusCode = array_key_exists($statusCode, $this->status) ? $statusCode : 500;
         $this->setStatusCode($statusCode);
-        $bodyMessage = $statusCode . ' ' . $this->status[$statusCode];
+        $bodyMessage = $statusCode.' '.$this->status[$statusCode];
         $this->setBody($this->bodyTemplate($bodyMessage));
         $this->send();
         exit;

WebStream/Http/Session.php

Doc Comments +4 added lines

@@ -49,6 +49,10 @@
      * @param string Cookieを有効にするドメイン
      * @param boolean Secure属性を有効にする
      * @param boolean HttpOnly属性を有効にする
+     * @param string $path
+     * @param string $domain
+     * @param boolean $secure
+     * @param boolean $httpOnly
      */
     private function initialize($expire, $path, $domain, $secure, $httpOnly)
     {

WebStream/Module/ClassLoader.php

Doc Comments +2 added lines

@@ -27,6 +27,7 @@ 
     /**
      * クラスをロードする
      * @param string|array クラス名
+     * @param string $className
      * @return array<string> ロード済みクラスリスト
      */
     public function load($className)
@@ -38,6 +39,7 @@ 
      * ファイルをインポートする
      * @param string ファイルパス
      * @param callable フィルタリング無名関数 trueを返すとインポート
+     * @param string $filepath
      * @return boolean インポート結果
      */
     public function import($filepath, callable $filter = null)

Unused Use Statements -1 removed lines

@@ -4,7 +4,6 @@
 require_once dirname(__FILE__) . '/Utility/FileUtils.php';
 require_once dirname(__FILE__) . '/../DI/Injector.php';
 
-use WebStream\Module\Utility\ApplicationUtils;
 use WebStream\Module\Utility\FileUtils;
 use WebStream\DI\Injector;
 

Spacing +16 added lines, -16 removed lines

@@ -1,8 +1,8 @@ 
 <?php
 namespace WebStream\Module;
 
-require_once dirname(__FILE__) . '/Utility/FileUtils.php';
-require_once dirname(__FILE__) . '/../DI/Injector.php';
+require_once dirname(__FILE__).'/Utility/FileUtils.php';
+require_once dirname(__FILE__).'/../DI/Injector.php';
 
 use WebStream\Module\Utility\ApplicationUtils;
 use WebStream\Module\Utility\FileUtils;
@@ -49,13 +49,13 @@ 
      */
     public function import($filepath, callable $filter = null)
     {
-        $includeFile = $this->applicationRoot . "/" . $filepath;
+        $includeFile = $this->applicationRoot."/".$filepath;
         if (is_file($includeFile)) {
             $ext = pathinfo($includeFile, PATHINFO_EXTENSION);
             if ($ext === 'php') {
                 if ($filter === null || (is_callable($filter) && $filter($includeFile) === true)) {
                     include_once $includeFile;
-                    $this->logger->debug($includeFile . " import success.");
+                    $this->logger->debug($includeFile." import success.");
                 }
             }
 
@@ -73,7 +73,7 @@ 
      */
     public function importAll($dirPath, callable $filter = null)
     {
-        $includeDir = realpath($this->applicationRoot . "/" . $dirPath);
+        $includeDir = realpath($this->applicationRoot."/".$dirPath);
         if (is_dir($includeDir)) {
             $iterator = $this->getFileSearchIterator($includeDir);
             $isSuccess = true;
@@ -86,11 +86,11 @@ 
                     if ($ext === 'php') {
                         if ($filter === null || (is_callable($filter) && $filter($filepath) === true)) {
                             include_once $filepath;
-                            $this->logger->debug($filepath . " import success.");
+                            $this->logger->debug($filepath." import success.");
                         }
                     }
                 } else {
-                    $this->logger->warn($filepath . " import failure.");
+                    $this->logger->warn($filepath." import failure.");
                     $isSuccess = false;
                 }
             }
@@ -114,13 +114,13 @@ 
         }
 
         // appディレクトリを名前空間付きで全検索し、マッチするもの全てをincludeする
-        $iterator = $this->getFileSearchIterator($rootDir . "/app");
+        $iterator = $this->getFileSearchIterator($rootDir."/app");
         $includeList = [];
         foreach ($iterator as $filepath => $fileObject) {
-            if (strpos($filepath, $className . ".php") !== false) {
+            if (strpos($filepath, $className.".php") !== false) {
                 include_once $filepath;
                 $includeList[] = $filepath;
-                $this->logger->debug($filepath . " load success. (search from " . $rootDir . "/app/)");
+                $this->logger->debug($filepath." load success. (search from ".$rootDir."/app/)");
             }
         }
         if (!empty($includeList)) {
@@ -133,12 +133,12 @@ 
             $classNameWithoutNamespace = $matches[1];
             // この処理が走るケースはapp配下のクラスがディレクトリ構成と名前空間が一致していない
             // 場合以外ない(テスト用クラス除く)ので、app配下の検索を優先する
-            $iterator = $this->getFileSearchIterator($rootDir . "/app");
+            $iterator = $this->getFileSearchIterator($rootDir."/app");
             foreach ($iterator as $filepath => $fileObject) {
-                if (strpos($filepath, $classNameWithoutNamespace . ".php") !== false) {
+                if (strpos($filepath, $classNameWithoutNamespace.".php") !== false) {
                     include_once $filepath;
                     $includeList[] = $filepath;
-                    $this->logger->debug($filepath . " load success. (full search)");
+                    $this->logger->debug($filepath." load success. (full search)");
                 }
             }
             if (!empty($includeList)) {
@@ -146,12 +146,12 @@ 
             }
 
             // プロジェクトルート配下すべてのディレクトリを検索する
-            $iterator = $this->getFileSearchIterator($rootDir . "/core");
+            $iterator = $this->getFileSearchIterator($rootDir."/core");
             foreach ($iterator as $filepath => $fileObject) {
-                if (strpos($filepath, $classNameWithoutNamespace . ".php") !== false) {
+                if (strpos($filepath, $classNameWithoutNamespace.".php") !== false) {
                     include_once $filepath;
                     $includeList[] = $filepath;
-                    $this->logger->debug($filepath . " load success. (full search, use in test)");
+                    $this->logger->debug($filepath." load success. (full search, use in test)");
                 }
             }
             if (!empty($includeList)) {

WebStream/Module/Container.php

Doc Comments -2 removed lines

@@ -72,8 +72,6 @@
 
     /**
      * キーの値を設定する
-     * @param  string $name      メソッド名
-     * @param  array  $arguments 引数リスト
      * @return void
      */
     public function set($key, $value)