<?php
/**
 * @copyright  Copyright (C) Clay Freeman. All rights reserved.
 * @license    GNU General Public License version 3 or later.
 */

// No direct access
defined('_JEXEC') or die;

class PlgUserExample extends JPlugin {
  /**
   * This method intercepts the login process during the
   * post-authentication phase.
   *
   * @param   array    $user     Holds the user data.
   * @param   array    $options  Extra options.
   *
   * @return  boolean  True on success
   */
  public function onUserLogin($user, $options) {
    // Fetch the JUser from the database with the resulting ID
    $instance = $this->_getUser($user);
    // Other functionality here...
    return true;
  }

  /**
   * Attempt to fetch a user by username or create a user if it doesn't exist.
   *
   * @param   JAuthenticationResponse  $user  User account details.
   *
   * @return  JUser                           The resulting user.
   */
  protected function _getUser($user) {
    // Attempt to fetch the user by username
    $instance = JUser::getInstance();
    $id = (int) JUserHelper::getUserId($user['username']);

    // If the user already exists, load and return it
    if ($id > 0) $instance->load($id);
    else {
      // Fetch the default user creation group
      $config = JComponentHelper::getParams('com_users');
      $defaultGroup = $config->get('new_usertype', 2);

      // Fill in the values for the new user
      $instance->set('id', 0);
      $instance->set('name', $user['fullname']);
      $instance->set('username', $user['username']);
      $instance->set('groups', array($defaultGroup));
      // etc...
    }

    // Forcibly set the user's preferred editor
    $instance->setParam('editor', 'codemirror');

    // Attempt to create or update the user
    if (!$instance->save(false)) JLog::add('Error in login for user '.
      $user['username'].'.', JLog::WARNING, 'error');

    // Return the resulting JUser instance
    return $instance;
  }
}