Mark Scherer 10 years ago
parent
commit
0e9800e61d

+ 3 - 0
src/Controller/Component/AuthUserComponent.php

@@ -13,6 +13,9 @@ class AuthUserComponent extends Component {
 
 	use AuthUserTrait;
 
+	/**
+	 * @var array
+	 */
 	public $components = ['Auth'];
 
 	/**

+ 3 - 5
src/Controller/Component/MobileComponent.php

@@ -33,26 +33,24 @@ use Tools\Utility\Utility;
  */
 class MobileComponent extends Component {
 
-	public $Controller = null;
-
 	/**
 	 * Stores the result of the auto-detection.
 	 *
-	 * @var bool
+	 * @var bool|null
 	 */
 	public $isMobile = null;
 
 	/**
 	 * Stores the final detection result including user preference.
 	 *
-	 * @var bool
+	 * @var bool|null
 	 */
 	public $setMobile = null;
 
 	/**
 	 * Default values. Can also be set using Configure.
 	 *
-	 * @param array
+	 * @var array
 	 */
 	protected $_defaultConfig = [
 		'on' => 'beforeFilter', // initialize (prior to controller's beforeRender) or startup

+ 15 - 0
src/Mailer/Email.php

@@ -14,14 +14,29 @@ class Email extends CakeEmail {
 
 	use LogTrait;
 
+	/**
+	 * @var int|null
+	 */
 	protected $_wrapLength = null;
 
+	/**
+	 * @var int|null
+	 */
 	protected $_priority = null;
 
+	/**
+	 * @var string|null
+	 */
 	protected $_error = null;
 
+	/**
+	 * @var bool|null
+	 */
 	protected $_debug = null;
 
+	/**
+	 * @var array
+	 */
 	protected $_log = [];
 
 	/**

+ 16 - 0
src/Model/Behavior/ConfirmableBehavior.php

@@ -23,6 +23,9 @@ use Cake\Validation\Validator;
  */
 class ConfirmableBehavior extends Behavior {
 
+	/**
+	 * @var array
+	 */
 	protected $_defaultConfig = [
 		'message' => null,
 		'field' => 'confirm',
@@ -30,6 +33,10 @@ class ConfirmableBehavior extends Behavior {
 		'validator' => 'default',
 	];
 
+	/**
+	 * @param \Cake\ORM\Table $table
+	 * @param array $config
+	 */
 	public function __construct(Table $table, array $config = []) {
 		parent::__construct($table, $config);
 
@@ -38,10 +45,19 @@ class ConfirmableBehavior extends Behavior {
 		}
 	}
 
+	/**
+	 * @param \Cake\Event\Event $event
+	 * @param \Cake\Validation\Validator $validator
+	 * @param string $name
+	 */
 	public function buildValidator(Event $event, Validator $validator, $name) {
 		$this->build($validator, $name);
 	}
 
+	/**
+	 * @param \Cake\Validation\Validator $validator
+	 * @param string $name
+	 */
 	public function build(Validator $validator, $name = 'default') {
 		if ($name !== $this->_config['validator']) {
 			return;

+ 3 - 0
src/Model/Behavior/JsonableBehavior.php

@@ -36,6 +36,9 @@ use Tools\Utility\Text;
  */
 class JsonableBehavior extends Behavior {
 
+	/**
+	 * @var string|false|null
+	 */
 	public $decoded = null;
 
 	/**

+ 3 - 0
src/Model/Behavior/ResetBehavior.php

@@ -45,6 +45,9 @@ use Cake\ORM\Table;
  */
 class ResetBehavior extends Behavior {
 
+	/**
+	 * @var array
+	 */
 	protected $_defaultConfig = [
 		'limit' => 100, // batch of records per loop
 		'timeout' => null, // in seconds

+ 15 - 0
src/Model/Table/TokensTable.php

@@ -14,14 +14,29 @@ use Tools\Utility\Random;
  */
 class TokensTable extends Table {
 
+	/**
+	 * @var string
+	 */
 	public $displayField = 'key';
 
+	/**
+	 * @var array
+	 */
 	public $order = ['created' => 'DESC'];
 
+	/**
+	 * @var int
+	 */
 	public $defaultLength = 22;
 
+	/**
+	 * @var int
+	 */
 	public $validity = MONTH;
 
+	/**
+	 * @var array
+	 */
 	public $validate = [
 		'type' => [
 			'notBlank' => [

+ 3 - 0
src/Utility/Mime.php

@@ -13,6 +13,9 @@ use Cake\Network\Response;
  */
 class Mime extends Response {
 
+	/**
+	 * @var array
+	 */
 	protected $_mimeTypesExt = [
 		'3dm' => 'x-world/x-3dmf',
 		'3dmf' => 'x-world/x-3dmf',

+ 36 - 0
src/Utility/Text.php

@@ -11,28 +11,64 @@ use Cake\Utility\Text as CakeText;
  */
 class Text extends CakeText {
 
+	/**
+	 * @var string
+	 */
 	public $text;
 
+	/**
+	 * @var int
+	 */
 	public $length;
 
+	/**
+	 * @var string
+	 */
 	public $char;
 
+	/**
+	 * @var string
+	 */
 	public $letter;
 
+	/**
+	 * @var string
+	 */
 	public $space;
 
+	/**
+	 * @var string
+	 */
 	public $word;
 
+	/**
+	 * @var string
+	 */
 	public $rWord;
 
+	/**
+	 * @var string
+	 */
 	public $sen;
 
+	/**
+	 * @var string
+	 */
 	public $rSen;
 
+	/**
+	 * @var string
+	 */
 	public $para;
 
+	/**
+	 * @var string
+	 */
 	public $rPara;
 
+	/**
+	 * @var string
+	 */
 	public $beautified;
 
 	/**

+ 3 - 0
src/View/Helper/CommonHelper.php

@@ -13,6 +13,9 @@ use Cake\View\Helper;
  */
 class CommonHelper extends Helper {
 
+	/**
+	 * @var array
+	 */
 	public $helpers = ['Html', 'Url'];
 
 	/**

+ 0 - 2
src/View/Helper/FlashHelper.php

@@ -14,8 +14,6 @@ use Tools\Controller\Component\FlashComponent;
  */
 class FlashHelper extends Helper {
 
-	public $helpers = [];
-
 	/**
 	 * Display all flash messages.
 	 *

+ 3 - 0
src/View/Helper/FormHelper.php

@@ -12,6 +12,9 @@ use Cake\View\View;
  */
 class FormHelper extends CakeFormHelper {
 
+	/**
+	 * @var array
+	 */
 	protected $_defaultConfigExt = [
 		'novalidate' => false
 	];

+ 15 - 0
src/View/Helper/FormatHelper.php

@@ -25,8 +25,14 @@ class FormatHelper extends Helper {
 	 */
 	public $helpers = ['Html'];
 
+	/**
+	 * @var \Cake\View\StringTemplate
+	 */
 	public $template;
 
+	/**
+	 * @var array
+	 */
 	protected $_defaultIcons = [
 		'yes' => 'fa fa-check',
 		'no' => 'fa fa-times',
@@ -44,6 +50,9 @@ class FormatHelper extends Helper {
 		//'genderless' => 'fa fa-genderless'
 	];
 
+	/**
+	 * @var array
+	 */
 	protected $_defaults = [
 		'fontIcons' => null,
 		'iconNamespace' => 'fa', // Used to be icon,
@@ -54,6 +63,12 @@ class FormatHelper extends Helper {
 		]
 	];
 
+	/**
+	 * FormatHelper constructor.
+	 *
+	 * @param \Cake\View\View $View
+	 * @param array $config
+	 */
 	public function __construct(View $View, array $config = []) {
 		$defaults = (array)Configure::read('Format') + $this->_defaults;
 		$config += $defaults;

+ 1 - 1
src/View/Helper/GravatarHelper.php

@@ -20,7 +20,7 @@ class GravatarHelper extends Helper {
 	/**
 	 * Gravatar avatar image base URL
 	 *
-	 * @var string
+	 * @var array
 	 */
 	protected $_url = [
 		'http' => 'http://www.gravatar.com/avatar/',

+ 22 - 3
src/View/Helper/QrCodeHelper.php

@@ -41,20 +41,30 @@ if (!defined('QS_CODE_DEFAULT_LEVEL')) {
  */
 class QrCodeHelper extends Helper {
 
-	public $helpers = ['Html'];
-
 	const MIN_SIZE = 58; # not readable anymore below this value
+
 	const MAX_SIZE = 540; # max of 300000 pixels
 	const DEFAULT_SIZE = 74; # 2x size
 	const DEFAULT_LEVEL = 'L'; # highest correction level
-
 	const SIZE_L = 58;
+
 	const SIZE_M = 66;
 	const SIZE_Q = 66;
 	const SIZE_H = 74;
 
+	/**
+	 * @var array
+	 */
+	public $helpers = ['Html'];
+
+	/**
+	 * @var string
+	 */
 	public $engine = 'google';
 
+	/**
+	 * @var string
+	 */
 	public $url = 'http://chart.apis.google.com/chart?';
 
 	/**
@@ -62,15 +72,24 @@ class QrCodeHelper extends Helper {
 	 * - chl: string $text
 	 * - choe: string $outputEncoding
 	 * - chs: size (...x...)
+	 *
+	 * @var array
 	 */
 	public $options = ['cht' => 'qr', 'chl' => '', 'choe' => '', 'chs' => ''];
 
+	/**
+	 * @var array
+	 */
 	public $ecLevels = ['H', 'Q', 'M', 'L']; # 30%..7%
 
+	/**
+	 * @var array
+	 */
 	public $formattingTypes = ['url' => 'http', 'tel' => 'tel', 'sms' => 'smsto', 'card' => 'mecard'];
 
 	/**
 	 * QrCodeHelper constructor.
+	 *
 	 * @param \Cake\View\View $View
 	 * @param array $config
 	 */

+ 4 - 1
src/View/Helper/TimeHelper.php

@@ -11,6 +11,9 @@ use Cake\View\View;
  */
 class TimeHelper extends CakeTimeHelper {
 
+	/**
+	 * @var array
+	 */
 	public $helpers = ['Html'];
 
 	/**
@@ -27,7 +30,7 @@ class TimeHelper extends CakeTimeHelper {
 	 *
 	 * @var \Cake\I18n\Number
 	 */
-	protected $_engine = null;
+	protected $_engine;
 
 	/**
 	 * Default Constructor

+ 9 - 0
src/View/Helper/TimelineHelper.php

@@ -19,8 +19,14 @@ use Cake\View\View;
  */
 class TimelineHelper extends Helper {
 
+	/**
+	 * @var array
+	 */
 	public $helpers = ['Tools.Js'];
 
+	/**
+	 * @var array
+	 */
 	protected $_defaultConfig = [
 		'id' => 'mytimeline',
 		'selectable' => false,
@@ -33,6 +39,9 @@ class TimelineHelper extends Helper {
 		'current' => null, // Current time.
 	];
 
+	/**
+	 * @var array
+	 */
 	protected $_items = [];
 
 	/**

+ 4 - 1
tests/TestCase/Controller/Component/AuthUserComponentTest.php

@@ -18,10 +18,13 @@ class AuthUserComponentTest extends TestCase {
 	/**
 	 * fixtures
 	 *
-	 * @var string
+	 * @var array
 	 */
 	public $fixtures = ['core.sessions'];
 
+	/**
+	 * @var \Tools\Controller\Component\AuthUserComponent
+	 */
 	public $AuthUser;
 
 	/**

+ 5 - 2
tests/TestCase/View/Helper/AuthUserHelperTest.php

@@ -13,12 +13,15 @@ use Tools\View\Helper\AuthUserHelper;
 class AuthUserHelperTest extends TestCase {
 
 	/**
-	 * fixtures
+	 * Fixtures
 	 *
-	 * @var string
+	 * @var array
 	 */
 	public $fixtures = ['core.sessions'];
 
+	/**
+	 * @var \Tools\View\Helper\AuthUserHelper
+	 */
 	public $AuthUser;
 
 	/**

+ 6 - 0
tests/TestCase/View/Helper/CommonHelperTest.php

@@ -13,8 +13,14 @@ use Tools\View\Helper\CommonHelper;
  */
 class CommonHelperTest extends TestCase {
 
+	/**
+	 * @var \Tools\View\Helper\CommonHelper
+	 */
 	public $Common;
 
+	/**
+	 * @return void
+	 */
 	public function setUp() {
 		parent::setUp();
 

+ 6 - 0
tests/TestCase/View/Helper/CookieHelperTest.php

@@ -13,6 +13,9 @@ use Tools\View\Helper\CookieHelper;
 
 class CookieHelperTest extends TestCase {
 
+	/**
+	 * @var \Tools\View\Helper\CookieHelper
+	 */
 	public $Cookie;
 
 	/**
@@ -25,6 +28,9 @@ class CookieHelperTest extends TestCase {
 		$this->Cookie->request = $this->getMock('Cake\Network\Request', ['cookie']);
 	}
 
+	/**
+	 * @return void
+	 */
 	public function tearDown() {
 		unset($this->Table);
 

+ 6 - 0
tests/TestCase/View/Helper/FlashHelperTest.php

@@ -15,8 +15,14 @@ class FlashHelperTest extends TestCase {
 
 	public $fixtures = ['core.sessions'];
 
+	/**
+	 * @var \Tools\View\Helper\FlashHelper
+	 */
 	public $Flash;
 
+	/**
+	 * @return void
+	 */
 	public function setUp() {
 		parent::setUp();
 

+ 6 - 0
tests/TestCase/View/Helper/FormHelperTest.php

@@ -13,8 +13,14 @@ use Tools\View\Helper\FormHelper;
  */
 class FormHelperTest extends TestCase {
 
+	/**
+	 * @var\Tools\View\Helper\FormHelper
+	 */
 	public $Form;
 
+	/**
+	 * @return void
+	 */
 	public function setUp() {
 		parent::setUp();
 

+ 6 - 0
tests/TestCase/View/Helper/FormatHelperTest.php

@@ -14,8 +14,14 @@ class FormatHelperTest extends TestCase {
 
 	public $fixtures = ['core.sessions'];
 
+	/**
+	 * @var \Tools\View\Helper\FormatHelper
+	 */
 	public $Format;
 
+	/**
+	 * @return void
+	 */
 	public function setUp() {
 		parent::setUp();
 

+ 3 - 0
tests/TestCase/View/Helper/TimelineHelperTest.php

@@ -12,6 +12,9 @@ use Tools\View\Helper\TimelineHelper;
  */
 class TimelineHelperTest extends TestCase {
 
+	/**
+	 * @var \Tools\View\Helper\TimelineHelper
+	 */
 	public $Timeline;
 
 	/**

+ 6 - 0
tests/TestCase/View/Helper/TreeHelperTest.php

@@ -13,10 +13,16 @@ use Tools\View\Helper\TreeHelper;
 
 class TreeHelperTest extends TestCase {
 
+	/**
+	 * @var array
+	 */
 	public $fixtures = [
 		'plugin.tools.after_trees'
 	];
 
+	/**
+	 * @var \Cake\ORM\Table
+	 */
 	public $Table;
 
 	/**