Changeset 7970

Timestamp:

03/19/08 13:37:29 (1 year ago)

Author:

fabien

Message:

moved internal storage of user parameters to an array + added php doc for all available options

Files:

• branches/1.1/lib/user/sfBasicSecurityUser.class.php (modified) (5 diffs)
• branches/1.1/lib/user/sfUser.class.php (modified) (10 diffs)

branches/1.1/lib/user/sfBasicSecurityUser.class.php

@@ -63 +63 @@
-        if ($credential == $value)
-        {
-getParameter('logging')
+options['logging']
-          {
-            $this->dispatcher->notify(new sfEvent($this, 'application.log', array(sprintf('Remove credential "%s"', $credential))));
@@ -97 +97 @@
-    $credentials = (is_array(func_get_arg(0))) ? func_get_arg(0) : func_get_args();
-
-getParameter('logging')
+options['logging']
-    {
-      $this->dispatcher->notify(new sfEvent($this, 'application.log', array(sprintf('Add credential(s) "%s"', implode(', ', $credentials)))));
@@ -172 +172 @@
-  public function setAuthenticated($authenticated)
-  {
-getParameter('logging')
+options['logging']
-    {
-      $this->dispatcher->notify(new sfEvent($this, 'application.log', array(sprintf('User is %sauthenticated', $authenticated === true ? '' : 'not '))));
@@ -209 +209 @@
-
-  /**
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-  {
-    // initialize parent
-
+
+
+
+
+
+
-
-    // read data from storage
@@ -237 +239 @@
-    {
-      // Automatic logout logged in user if no request within timeout parameter seconds
-getParameter('timeout', 1800)
+options['timeout']
-      if (false !== $timeout && !is_null($this->lastRequest) && time() - $this->lastRequest >= $timeout)
-      {
-getParameter('logging')
+options['logging']
-        {
-          $this->dispatcher->notify(new sfEvent($this, 'application.log', array('Automatic user logout due to timeout')));

branches/1.1/lib/user/sfUser.class.php

@@ -33 +33 @@
-
-  protected
-parameterHolder = null
+options         = array()
-    $attributeHolder = null,
-    $culture         = null,
@@ -44 +44 @@
-   * @see initialize()
-   */
-parameter
-
-parameter
-
-getParameter('auto_shutdown', true)
+option
+
+option
+
+options['auto_shutdown']
-    {
-      register_shutdown_function(array($this, 'shutdown'));
@@ -57 +57 @@
-   * Initializes this sfUser.
-   *
+   * Available options:
+   *
+   *  * auto_shutdown:   Whether to automatically save the changes to the session (true by default)
+   *  * culture:         The user culture
+   *  * default_culture: The default user culture (en by default)
+   *  * use_flash:       Whether to enable flash usage (false by default)
+   *  * logging:         Whether to enable logging (false by default)
+   *
-   * @param sfEventDispatcher A sfEventDispatcher instance.
-
-
-
-
-
-
-
-
+
+
+
+
+
+
-  {
-    $this->dispatcher = $dispatcher;
-    $this->storage    = $storage;
-
-
-
+
+
+
+
+
+
+
-
-    $this->attributeHolder = new sfNamespacedParameterHolder(self::ATTRIBUTE_NAMESPACE);
@@ -90 +101 @@
-    //  - use the default culture set in settings.yml
-    $currentCulture = $storage->read(self::CULTURE_NAMESPACE);
-$this->getParameter('culture', !is_null($currentCulture) ? $currentCulture : $this->getParameter('default_culture', 'en')
+!is_null($this->options['culture']) ? $this->options['culture'] : (!is_null($currentCulture) ? $currentCulture : $this->options['default_culture']
-
-    // flag current flash to be removed at shutdown
-getParameter('use_flash', false)
-
-getParameter('logging')
+options['use_flash']
+
+options['logging']
-      {
-        $this->dispatcher->notify(new sfEvent($this, 'application.log', array(sprintf('Flag old flash messages ("%s")', implode('", "', $names)))));
@@ -131 +142 @@
-  public function setFlash($name, $value, $persist = true)
-  {
-getParameter('use_flash', false)
+options['use_flash']
-    {
-      return;
@@ -158 +169 @@
-  public function getFlash($name, $default = null)
-  {
-getParameter('use_flash', false)
+options['use_flash']
-    {
-      return $default;
@@ -175 +186 @@
-  public function hasFlash($name)
-  {
-getParameter('use_flash', false)
+options['use_flash']
-    {
-      return false;
@@ -193 +204 @@
-  }
-
-  public function getParameterHolder()
-  {
-    return $this->parameterHolder;
-  }
-
-  public function getAttributeHolder()
-  {
@@ -218 +224 @@
-  }
-
-  public function getParameter($name, $default = null)
-  {
-    return $this->parameterHolder->get($name, $default);
-  }
-
-  public function hasParameter($name)
-  {
-    return $this->parameterHolder->has($name);
-  }
-
-  public function setParameter($name, $value)
-  {
-    return $this->parameterHolder->set($name, $value);
-  }
-
-  /**
-   * Executes the shutdown procedure.
@@ -241 +232 @@
-  {
-    // remove flash that are tagged to be removed
-getParameter('use_flash', false)
-
-getParameter('logging')
+options['use_flash']
+
+options['logging']
-      {
-        $this->dispatcher->notify(new sfEvent($this, 'application.log', array(sprintf('Remove old flash messages ("%s")', implode('", "', $names)))));