<commit_before>doAuthPlugin
-------------
Inspired by sfGuardPlugin an easy-to-use new authorization system. doAuth is ready to work out of the box with just a few configuration changes. It takes all the common user functionality - User authorization by login and password, registration, activation by email, password reset. If you don't need sfGuard permissions system but a simple user module that works, you should try doAuth. Great for a new symfony 1.4 projects.

Features
--------
* All common user actions: authorization, registration, activation, password reset works out the box.
* Developer friendly: only 2 tables, model named 'User' that can be extended with Doctrine inheritance.
* Highly configurable and customizable. You can extend classes, add your event handlers or just edit configuration to create custom behavior.
* Standard emails are sent on registration, activation and password requests.
* Refactored from sfGuard. Shares similar concepts and some config APIs.

Coming Soon: doAccess plugin that adds a permissions functionality on top of doAuth plugin.

Installation
------------
  * Install the plugin

        $ symfony plugin:install doAuthPlugin

  * Build your model and forms:

        $ symfony doctrine:build-model
        $ symfony doctrine:build-forms

  * Update your database:

        $ symfony doctrine:insert-sql

  * make myUser class typically located in app/frontend/lib to extend doAuthSecurityUser:

        [php]
        class myUser extends doAuthSecurityUser
        {

        }

  * Enable [baseAuth] module in setting.yml of your frontend or skip it and start the customization.

  * Optionally add the &quot;Remember Me&quot; filter to `filters.yml` above the security filter:

        remember_me:
          class: doAuthRememberMeFilter

  * Change the default login and secure modules in `settings.yml`

        login_module:           sfGuardAuth
        login_action:           signin

        secure_module:          sfGuardAuth
        secure_action:          secure

You are ready to use. Try to access /register, /login, /logout routes.
By default doAuth automaticaly signs user is on registration and sends email with username and password.

Usage
-----
Access your user model from a class User.
(well, is very common thing, but should be noted for sfGuardUser users)

* creating a user (example)

        [php]
        $user = new User();
        $user->setUsername('davert');
        $user->setPassword('<PASSWORD>');
        $user->setEmail('<EMAIL>');
        $user->save();

* accessing user session class (example in controller)
<commit_msg>docmentation updates<commit_after>doAuthPlugin
-------------
Inspired by sfGuardPlugin an easy-to-use new authorization system. doAuth is ready to work out of the box with just a few configuration changes. It takes all the common user functionality - User authorization by login and password, registration, activation by email, password reset. If you don't need sfGuard permissions system but a simple user module that works, you should try doAuth. Great for a new symfony 1.4 projects.

Features
--------
* All common user actions: authorization, registration, activation, password reset works out the box.
* Developer friendly: only 2 tables, model named 'User' that can be extended with Doctrine inheritance.
* Highly configurable and customizable. You can extend classes, add your event handlers or just edit configuration to create custom behavior.
* Standard emails are sent on registration, activation and password requests.
* Refactored from sfGuard. Shares similar concepts and some config APIs.

Coming Soon: doAccess plugin that adds a permissions functionality on top of doAuth plugin.

Installation
------------
  * Install the plugin

        $ symfony plugin:install doAuthPlugin

  * Build your model and forms:

        $ symfony doctrine:build-model
        $ symfony doctrine:build-forms

  * Update your database:

        $ symfony doctrine:insert-sql

  * make myUser class typically located in app/frontend/lib to extend doAuthSecurityUser:

        [php]
        class myUser extends doAuthSecurityUser
        {

        }

  * Optionally add the &quot;Remember Me&quot; filter to `filters.yml` above the security filter:

        remember_me:
          class: doAuthRememberMeFilter

  * Enable [baseAuth] module in setting.yml of your frontend or skip it and start the customization.

  * Change the default login and secure modules in `settings.yml`

        login_module:           baseAuth
        login_action:           signin

        secure_module:          baseAuth
        secure_action:          secure

You are ready to use. Try to access /register, /login, /logout routes.
By default doAuth automaticaly signs user is on registration and sends email with username and password.

Usage
-----
Access your user model from a class User.
(well, is very common thing, but should be noted for sfGuardUser users)

* creating a user (example)

        [php]
        $user = new User();
        $user->setUsername('davert');
        $user->setPassword('<PASSWORD>');
        $user->setEmail('<EMAIL>');
        $user->save();

* accessing user session class (example in controller)

{'fraction_non_alphanumeric': 0.07163378663091362, 'fraction_numerical': 0.0011492051331162612, 'mean_word_length': 3.0796875, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 15, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2524954', 'n_tokens_mistral': 1312, 'n_tokens_neox': 1246, 'n_words': 605}