Browse code

Add some missing PHPDOC descriptions

Benjamin Roth authored on08/06/2015 15:55:22
Showing1 changed files
... ...
@@ -27,11 +27,19 @@ class CookiePolicy extends \Frontend
27 27
 	 */
28 28
 	protected $strTemplate = 'cookiepolicy_dialog';
29 29
 
30
+	/**
31
+	 * Root page object
32
+	 * @var \PageModel|null
33
+	 */
30 34
 	protected $objRootPage;
31 35
 
32 36
 
33 37
 	/**
34 38
 	 * Cookie policy check
39
+	 *
40
+	 * @param \PageModel $objPage
41
+	 * @param \LayoutModel $objLayout
42
+	 * @param \PageRegular $objPageRegular
35 43
 	 */
36 44
 	public function cookiePolicyCheck(\PageModel $objPage, \LayoutModel $objLayout, \PageRegular $objPageRegular)
37 45
 	{
... ...
@@ -61,10 +69,13 @@ class CookiePolicy extends \Frontend
61 69
 
62 70
 		// Add dialog code to page
63 71
 		$GLOBALS['TL_JQUERY'][] = $objTemplate->parse();
64
-
65
-
66 72
 	}
67 73
 
74
+	/**
75
+	 * Is policy token correct
76
+	 *
77
+	 * @return bool
78
+	 */
68 79
 	public static function ajaxPassCookiePolicy()
69 80
 	{
70 81
 		if (!\Input::get('cookiepolicy_commit'))
... ...
@@ -80,7 +91,12 @@ class CookiePolicy extends \Frontend
80 91
 			return true;
81 92
 		}
82 93
 	}
83
-	
94
+
95
+	/**
96
+	 * Create and return a 32 char token
97
+	 *
98
+	 * @return string
99
+	 */
84 100
 	protected function createToken()
85 101
 	{
86 102
 		if (!$_SESSION['eSM_cookiepolicy_token'])
... ...
@@ -97,6 +113,12 @@ class CookiePolicy extends \Frontend
97 113
 		return $_SESSION['eSM_cookiepolicy_token'];
98 114
 	}
99 115
 
116
+	/**
117
+	 * Replace placeholders
118
+	 *
119
+	 * @param $strString
120
+	 * @return string
121
+	 */
100 122
 	protected function replacePlaceholders($strString)
101 123
 	{
102 124
 		$strReturn = '';