diff options
| author | robocoder <anthon.pang@gmail.com> | 2009-08-22 17:23:16 +0400 |
|---|---|---|
| committer | robocoder <anthon.pang@gmail.com> | 2009-08-22 17:23:16 +0400 |
| commit | 20cac9adab214fe1e8e8a37f0cf81ec28c7968fa (patch) | |
| tree | 436d3d9c8546deb59b8f307dd5b20cd1a60d407f /core/Cookie.php | |
| parent | 6eb358f25786a76f3dfcd52f40304a515cf98411 (diff) | |
phpdoc cleanup:
* add @category (Piwik => 'core', Piwik_Plugins => 'plugins')
* in core, use @package and @subpackage more consistently to group files/classes; exception is DataFiles/*, PluginsFunctions/*, and SmartyPlugins/*
* in plugins, @package is the plugin name
* removed '@param none' -- not a phpdoc convention
* '@throws' and '@return void' are also not phpdoc conventions, but are widely used elsewhere, e.g., Smarty & Zend
git-svn-id: http://dev.piwik.org/svn/trunk@1420 59fd770c-687e-43c8-a1e3-f5a4ff64c105
Diffstat (limited to 'core/Cookie.php')
| -rw-r--r-- | core/Cookie.php | 17 |
1 files changed, 7 insertions, 10 deletions
diff --git a/core/Cookie.php b/core/Cookie.php index 518a1d316f..3da0fe5cd4 100644 --- a/core/Cookie.php +++ b/core/Cookie.php @@ -6,7 +6,8 @@ * @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later * @version $Id$ * - * @package Piwik_Helper + * @category Piwik + * @package Piwik */ /** @@ -15,7 +16,7 @@ * - edit an existing cookie and save it * - create a new cookie, set values, expiration date, etc. and save it * - * @package Piwik_Helper + * @package Piwik */ class Piwik_Cookie { @@ -66,6 +67,7 @@ class Piwik_Cookie /** * Returns true if the visitor already has the cookie. + * * @return bool */ public function isCookieFound() @@ -75,6 +77,7 @@ class Piwik_Cookie /** * Returns the default expiry time, 2 years + * * @return int Timestamp in 2 years */ protected function getDefaultExpire() @@ -113,8 +116,6 @@ class Piwik_Cookie /** * We set the privacy policy header - * - * @return void */ protected function setP3PHeader() { @@ -123,8 +124,6 @@ class Piwik_Cookie /** * Delete the cookie - * - * @return void */ public function delete() { @@ -148,8 +147,6 @@ class Piwik_Cookie * Parses the cookie string to extract the different variables. * Unserialize the array when necessary. * Decode the non numeric values that were base64 encoded. - * - * @return void */ protected function loadContentFromCookie() { @@ -183,6 +180,7 @@ class Piwik_Cookie /** * Returns the string to save in the cookie from the $this->value array of values. * It goes through the array and generates the cookie content string. + * * @return string Cookie content */ protected function generateContentString() @@ -214,8 +212,7 @@ class Piwik_Cookie * * @param string Name of the value to save; the name will be used to retrieve this value * @param string|array|numeric Value to save - * - */ + */ public function set( $name, $value ) { $name = self::escapeValue($name); |