Index: branches/5.2.x/core/kernel/session/session.php =================================================================== diff -u -N -r14879 -r14995 --- branches/5.2.x/core/kernel/session/session.php (.../session.php) (revision 14879) +++ branches/5.2.x/core/kernel/session/session.php (.../session.php) (revision 14995) @@ -1,6 +1,6 @@ Data->Set($name, $value); - if ($optional) { + if ( $optional ) { // make variable optional, also remember optional value $this->OptionalData[$name] = $value; } - elseif (!$optional && array_key_exists($name, $this->OptionalData)) { - if ($this->OptionalData[$name] == $value) { + elseif ( !$optional && array_key_exists($name, $this->OptionalData) ) { + if ( $this->OptionalData[$name] == $value ) { // same value as optional -> don't remove optional mark - return ; + return; } // make variable non-optional unset($this->OptionalData[$name]); } } - function StorePersistentVar($name, $value, $optional = false) + /** + * Stores variable to persistent session + * + * @param string $name + * @param mixed $value + * @param bool $optional + * @return void + * @access public + */ + public function StorePersistentVar($name, $value, $optional = false) { $this->Storage->StorePersistentVar($name, $value, $optional); } @@ -934,53 +955,98 @@ $this->Storage->LoadPersistentVars(); } - function StoreVarDefault($name, $value, $optional=false) + /** + * Stores default value for session variable + * + * @param string $name + * @param string $value + * @param bool $optional + * @return void + * @access public + * @see Session::RecallVar() + * @see Session::StoreVar() + */ + public function StoreVarDefault($name, $value, $optional = false) { $tmp = $this->RecallVar($name); - if($tmp === false || $tmp == '') - { + + if ( $tmp === false || $tmp == '' ) { $this->StoreVar($name, $value, $optional); } } - function RecallVar($name, $default = false) + /** + * Returns session variable value + * + * Return value of $var variable stored in Session. An optional default value could be passed as second parameter. + * + * @param string $name Variable name + * @param mixed $default Default value to return if no $var variable found in session + * @return mixed + * @access public + */ + public function RecallVar($name, $default = false) { $ret = $this->Data->Get($name); + return ($ret === false) ? $default : $ret; } - function RecallPersistentVar($name, $default = false) + /** + * Returns variable value from persistent session + * + * @param string $name + * @param mixed $default + * @return mixed + * @access public + */ + public function RecallPersistentVar($name, $default = false) { return $this->Storage->RecallPersistentVar($name, $default); } - - function RemoveVar($name) + /** + * Deletes Session variable + * + * @param string $var + * @return void + * @access public + */ + public function RemoveVar($name) { $this->Storage->RemoveFromData($name); $this->Data->Remove($name); } - function RemovePersistentVar($name) + /** + * Removes variable from persistent session + * + * @param string $name + * @return void + * @access public + */ + public function RemovePersistentVar($name) { - return $this->Storage->RemovePersistentVar($name); + $this->Storage->RemovePersistentVar($name); } /** - * Ignores session varible value set before + * Ignores session variable value set before * * @param string $name + * @return void + * @access public */ - function RestoreVar($name) + public function RestoreVar($name) { $value = $this->Storage->GetFromData($name, '__missing__'); - if ($value === '__missing__') { + if ( $value === '__missing__' ) { // there is nothing to restore (maybe session was not saved), look in optional variable values $value = array_key_exists($name, $this->OptionalData) ? $this->OptionalData[$name] : false; } - return $this->StoreVar($name, $value); + $this->StoreVar($name, $value); } function GetField($var_name, $default = false)