diff options
author | Olivier Paroz <github@oparoz.com> | 2015-04-21 15:47:36 +0300 |
---|---|---|
committer | Olivier Paroz <github@oparoz.com> | 2015-04-21 15:47:36 +0300 |
commit | db643a0fdd2fee89d4056eb69ead03b892f9796d (patch) | |
tree | 4791f01b2ab38f316d5b586229383fefb35169a0 | |
parent | 470a3c04f96fa67e31900685ea5390004f2539da (diff) |
Change phpdoc from @type to @var
The official body behind the specification backtracked
-rw-r--r-- | controller/configcontroller.php | 4 | ||||
-rw-r--r-- | controller/filescontroller.php | 10 | ||||
-rw-r--r-- | controller/pagecontroller.php | 4 | ||||
-rw-r--r-- | controller/previewcontroller.php | 12 | ||||
-rw-r--r-- | environment/environment.php | 16 | ||||
-rw-r--r-- | http/imageresponse.php | 4 | ||||
-rw-r--r-- | middleware/checkmiddleware.php | 8 | ||||
-rw-r--r-- | middleware/envcheckmiddleware.php | 8 | ||||
-rw-r--r-- | middleware/sharingcheckmiddleware.php | 4 | ||||
-rw-r--r-- | preview/preview.php | 16 | ||||
-rw-r--r-- | service/configparser.php | 2 | ||||
-rw-r--r-- | service/configservice.php | 10 | ||||
-rw-r--r-- | service/downloadservice.php | 2 | ||||
-rw-r--r-- | service/filesservice.php | 6 | ||||
-rw-r--r-- | service/previewservice.php | 10 | ||||
-rw-r--r-- | service/searchmediaservice.php | 4 | ||||
-rw-r--r-- | service/service.php | 6 | ||||
-rw-r--r-- | service/thumbnailservice.php | 4 | ||||
-rw-r--r-- | templates/authenticate.php | 4 | ||||
-rw-r--r-- | templates/index.php | 2 | ||||
-rw-r--r-- | templates/part.content.php | 4 | ||||
-rw-r--r-- | templates/part.filenotfounderror.php | 4 | ||||
-rw-r--r-- | templates/part.linkerror.php | 4 | ||||
-rw-r--r-- | templates/public.php | 4 | ||||
-rw-r--r-- | utility/smarterlogger.php | 4 |
25 files changed, 78 insertions, 78 deletions
diff --git a/controller/configcontroller.php b/controller/configcontroller.php index 469faf3b..d1441816 100644 --- a/controller/configcontroller.php +++ b/controller/configcontroller.php @@ -30,11 +30,11 @@ class ConfigController extends Controller { use JsonHttpError; /** - * @type ConfigService + * @var ConfigService */ private $configService; /** - * @type SmarterLogger + * @var SmarterLogger */ private $logger; diff --git a/controller/filescontroller.php b/controller/filescontroller.php index 1715d3b8..b2408918 100644 --- a/controller/filescontroller.php +++ b/controller/filescontroller.php @@ -35,19 +35,19 @@ class FilesController extends Controller { use JsonHttpError; /** - * @type FilesService + * @var FilesService */ private $filesService; /** - * @type ConfigService + * @var ConfigService */ private $configService; /** - * @type SearchMediaService + * @var SearchMediaService */ private $searchMediaService; /** - * @type SmarterLogger + * @var SmarterLogger */ private $logger; @@ -98,7 +98,7 @@ class FilesController extends Controller { $features = explode(',', $features); $mediaTypesArray = explode(';', $this->request->getParam('mediatypes')); try { - /** @type Folder $folderNode */ + /** @var Folder $folderNode */ list($folderPathFromRoot, $folderNode, $locationHasChanged) = $this->filesService->getCurrentFolder(rawurldecode($location), $features); $albumInfo = diff --git a/controller/pagecontroller.php b/controller/pagecontroller.php index bf23dfa6..6ecc4cf3 100644 --- a/controller/pagecontroller.php +++ b/controller/pagecontroller.php @@ -31,11 +31,11 @@ use OCA\GalleryPlus\Environment\Environment; class PageController extends Controller { /** - * @type Environment + * @var Environment */ private $environment; /** - * @type IURLGenerator + * @var IURLGenerator */ private $urlGenerator; diff --git a/controller/previewcontroller.php b/controller/previewcontroller.php index fccbef05..c5550e40 100644 --- a/controller/previewcontroller.php +++ b/controller/previewcontroller.php @@ -38,27 +38,27 @@ class PreviewController extends Controller { use JsonHttpError; /** - * @type IURLGenerator + * @var IURLGenerator */ private $urlGenerator; /** - * @type ThumbnailService + * @var ThumbnailService */ private $thumbnailService; /** - * @type PreviewService + * @var PreviewService */ private $previewService; /** - * @type DownloadService + * @var DownloadService */ private $downloadService; /** - * @type IEventSource + * @var IEventSource */ private $eventSource; /** - * @type SmarterLogger + * @var SmarterLogger */ private $logger; diff --git a/environment/environment.php b/environment/environment.php index f51cf240..28749fb5 100644 --- a/environment/environment.php +++ b/environment/environment.php @@ -34,13 +34,13 @@ use OCA\GalleryPlus\Utility\SmarterLogger; class Environment { /** - * @type string + * @var string */ private $appName; /** * The userId of the logged-in user or the person sharing a folder publicly * - * @type string + * @var string */ private $userId; /** @@ -50,19 +50,19 @@ class Environment { * A share needs to be tracked back to its original owner in order to be able to access the * resource * - * @type Folder|null + * @var Folder|null */ private $userFolder; /** - * @type IUserManager + * @var IUserManager */ private $userManager; /** - * @type IServerContainer + * @var IServerContainer */ private $serverContainer; /** - * @type SmarterLogger + * @var SmarterLogger */ private $logger; /** @@ -71,13 +71,13 @@ class Environment { * For public folders, it's the path from the shared folder to the root folder in the original * owner's filesystem: /userId/files/parent_folder/shared_folder * - * @type string + * @var string */ private $fromRootToFolder; /** * The name of the shared folder * - * @type string + * @var string */ private $folderName; diff --git a/http/imageresponse.php b/http/imageresponse.php index 4f2ddccd..444cc560 100644 --- a/http/imageresponse.php +++ b/http/imageresponse.php @@ -23,11 +23,11 @@ use OCP\AppFramework\Http; class ImageResponse extends Response { /** - * @type string + * @var string */ private $path; /** - * @type \OC_Image|string + * @var \OC_Image|string */ private $preview; diff --git a/middleware/checkmiddleware.php b/middleware/checkmiddleware.php index 5e5b819f..b7a78c7a 100644 --- a/middleware/checkmiddleware.php +++ b/middleware/checkmiddleware.php @@ -33,19 +33,19 @@ use OCA\GalleryPlus\Utility\SmarterLogger; abstract class CheckMiddleware extends Middleware { /** - * @type string + * @var string */ protected $appName; /** - * @type IRequest + * @var IRequest */ protected $request; /** - * @type IURLGenerator + * @var IURLGenerator */ private $urlGenerator; /** - * @type SmarterLogger + * @var SmarterLogger */ protected $logger; diff --git a/middleware/envcheckmiddleware.php b/middleware/envcheckmiddleware.php index f4979fdc..cc2a954d 100644 --- a/middleware/envcheckmiddleware.php +++ b/middleware/envcheckmiddleware.php @@ -40,19 +40,19 @@ use OCA\GalleryPlus\Utility\SmarterLogger; class EnvCheckMiddleware extends CheckMiddleware { /** - * @type IHasher + * @var IHasher * */ private $hasher; /** - * @type ISession + * @var ISession * */ private $session; /** - * @type Environment + * @var Environment */ private $environment; /** - * @type IControllerMethodReflector + * @var IControllerMethodReflector */ protected $reflector; diff --git a/middleware/sharingcheckmiddleware.php b/middleware/sharingcheckmiddleware.php index ed81ea73..d3d55c35 100644 --- a/middleware/sharingcheckmiddleware.php +++ b/middleware/sharingcheckmiddleware.php @@ -31,11 +31,11 @@ use OCA\GalleryPlus\Utility\SmarterLogger; class SharingCheckMiddleware extends CheckMiddleware { /** - * @type IConfig + * @var IConfig * */ private $config; /** - * @type IControllerMethodReflector + * @var IControllerMethodReflector */ protected $reflector; diff --git a/preview/preview.php b/preview/preview.php index d6bbcd9e..e416b225 100644 --- a/preview/preview.php +++ b/preview/preview.php @@ -30,35 +30,35 @@ use OCA\GalleryPlus\Utility\SmarterLogger; class Preview { /** - * @type string + * @var string */ private $dataDir; /** - * @type mixed + * @var mixed */ private $previewManager; /** - * @type SmarterLogger + * @var SmarterLogger */ private $logger; /** - * @type string + * @var string */ private $userId; /** - * @type \OC\Preview + * @var \OC\Preview */ private $preview; /** - * @type File + * @var File */ private $file; /** - * @type int[] + * @var int[] */ private $dims; /** - * @type bool + * @var bool */ private $success = true; diff --git a/service/configparser.php b/service/configparser.php index 46574d7e..92ca90a0 100644 --- a/service/configparser.php +++ b/service/configparser.php @@ -73,7 +73,7 @@ class ConfigParser { * @throws ServiceException */ private function parseConfig($folder, $configName) { - /** @type File $configFile */ + /** @var File $configFile */ $configFile = $folder->get($configName); try { $rawConfig = $configFile->getContent(); diff --git a/service/configservice.php b/service/configservice.php index 405202cf..098cccc7 100644 --- a/service/configservice.php +++ b/service/configservice.php @@ -28,19 +28,19 @@ use OCA\GalleryPlus\Utility\SmarterLogger; class ConfigService extends FilesService { /** - * @type string + * @var string */ private $configName = 'gallery.cnf'; /** - * @type string + * @var string */ private $privacyChecker = '.nomedia'; /** - * @type array <string,bool> + * @var array <string,bool> */ private $configItems = ['information' => false, 'sorting' => false]; /** - * @type ConfigParser + * @var ConfigParser */ private $configParser; @@ -70,7 +70,7 @@ class ConfigService extends FilesService { */ public function getFeaturesList() { $featuresList = []; - /** @type Folder $rootFolder */ + /** @var Folder $rootFolder */ $rootFolder = $this->environment->getNode(''); if ($rootFolder && $rootFolder->nodeExists($this->configName)) { try { diff --git a/service/downloadservice.php b/service/downloadservice.php index 410c96c9..585c194e 100644 --- a/service/downloadservice.php +++ b/service/downloadservice.php @@ -39,7 +39,7 @@ class DownloadService extends Service { $file = null; $download = false; try { - /** @type File $file */ + /** @var File $file */ $file = $this->environment->getResourceFromPath($image); $download = [ 'path' => $image, diff --git a/service/filesservice.php b/service/filesservice.php index a6741783..782dad75 100644 --- a/service/filesservice.php +++ b/service/filesservice.php @@ -24,12 +24,12 @@ use OCA\GalleryPlus\Environment\NotFoundEnvException; */ class FilesService extends Service { /** - * @type int + * @var int */ protected $virtualRootLevel = null; /** - * @type string[] + * @var string[] */ protected $features; @@ -151,7 +151,7 @@ class FilesService extends Service { */ protected function getAllowedSubFolder($node, $nodeType) { if ($nodeType === 'dir') { - /** @type Folder $node */ + /** @var Folder $node */ if (!$node->nodeExists('.nomedia')) { return [$node]; } diff --git a/service/previewservice.php b/service/previewservice.php index 5bc19231..7e96b092 100644 --- a/service/previewservice.php +++ b/service/previewservice.php @@ -30,13 +30,13 @@ class PreviewService extends Service { use Base64Encode; /** - * @type Preview + * @var Preview */ private $previewManager; /** * @todo This hard-coded array could be replaced by admin settings * - * @type string[] + * @var string[] */ private $baseMimeTypes = [ 'image/png', @@ -54,7 +54,7 @@ class PreviewService extends Service { * These types are useful for files preview in the files app, but * not for the gallery side * - * @type string[] + * @var string[] */ private $slideshowMimeTypes = [ 'application/font-sfnt', @@ -122,7 +122,7 @@ class PreviewService extends Service { public function isPreviewRequired($image, $animatedPreview) { $file = null; try { - /** @type File $file */ + /** @var File $file */ $file = $this->environment->getResourceFromPath($image); } catch (NotFoundEnvException $exception) { @@ -173,7 +173,7 @@ class PreviewService extends Service { ) { $file = null; try { - /** @type File $file */ + /** @var File $file */ $file = $this->environment->getResourceFromPath($image); } catch (NotFoundEnvException $exception) { $this->logAndThrowNotFound($exception->getMessage()); diff --git a/service/searchmediaservice.php b/service/searchmediaservice.php index 955ff7fa..78135a8f 100644 --- a/service/searchmediaservice.php +++ b/service/searchmediaservice.php @@ -24,11 +24,11 @@ use OCP\Files\Node; class SearchMediaService extends FilesService { /** - * @type null|array<string,string|int> + * @var null|array<string,string|int> */ private $images = []; /** - * @type string[] + * @var string[] */ private $supportedMediaTypes; diff --git a/service/service.php b/service/service.php index aa915c0e..e658421e 100644 --- a/service/service.php +++ b/service/service.php @@ -23,15 +23,15 @@ use OCA\GalleryPlus\Utility\SmarterLogger; abstract class Service { /** - * @type string + * @var string */ protected $appName; /** - * @type Environment + * @var Environment */ protected $environment; /** - * @type SmarterLogger + * @var SmarterLogger */ protected $logger; diff --git a/service/thumbnailservice.php b/service/thumbnailservice.php index b0103fe2..a526604f 100644 --- a/service/thumbnailservice.php +++ b/service/thumbnailservice.php @@ -20,11 +20,11 @@ namespace OCA\GalleryPlus\Service; class ThumbnailService { /** - * @type bool + * @var bool */ private $animatedPreview = false; /** - * @type bool + * @var bool */ private $base64Encode = true; diff --git a/templates/authenticate.php b/templates/authenticate.php index 8f8cea61..666e7d01 100644 --- a/templates/authenticate.php +++ b/templates/authenticate.php @@ -1,9 +1,9 @@ <?php /** - * @type $_ array + * @var $_ array */ /** - * @type $l OC_L10N + * @var $l OC_L10N */ style('galleryplus', 'authenticate'); ?> diff --git a/templates/index.php b/templates/index.php index e5627799..15f634d5 100644 --- a/templates/index.php +++ b/templates/index.php @@ -1,6 +1,6 @@ <?php /** - * @type $_ array + * @var $_ array */ ?> diff --git a/templates/part.content.php b/templates/part.content.php index 989f3274..cdd7d4ae 100644 --- a/templates/part.content.php +++ b/templates/part.content.php @@ -1,9 +1,9 @@ <?php /** - * @type $_ array + * @var $_ array */ /** - * @type $l OC_L10N + * @var $l OC_L10N */ script( $_['appName'], diff --git a/templates/part.filenotfounderror.php b/templates/part.filenotfounderror.php index cb3f4d7d..90722768 100644 --- a/templates/part.filenotfounderror.php +++ b/templates/part.filenotfounderror.php @@ -1,9 +1,9 @@ <?php /** - * @type $_ array + * @var $_ array */ /** - * @type $l OC_L10N + * @var $l OC_L10N */ style( $_['appName'], diff --git a/templates/part.linkerror.php b/templates/part.linkerror.php index a3511ca0..35308046 100644 --- a/templates/part.linkerror.php +++ b/templates/part.linkerror.php @@ -1,9 +1,9 @@ <?php /** - * @type $_ array + * @var $_ array */ /** - * @type $l OC_L10N + * @var $l OC_L10N */ style( $_['appName'], diff --git a/templates/public.php b/templates/public.php index fc6c214b..32f59c5f 100644 --- a/templates/public.php +++ b/templates/public.php @@ -1,9 +1,9 @@ <?php /** - * @type $_ array + * @var $_ array */ /** - * @type $l OC_L10N + * @var $l OC_L10N */ script( $_['appName'], diff --git a/utility/smarterlogger.php b/utility/smarterlogger.php index 209b7126..0f571ae8 100644 --- a/utility/smarterlogger.php +++ b/utility/smarterlogger.php @@ -23,11 +23,11 @@ use OCP\ILogger; class SmarterLogger implements ILogger { /** - * @type ILogger + * @var ILogger */ private $logger; /** - * @type Normalizer + * @var Normalizer */ private $normalizer; |