embient.plugin.php

Go to the documentation of this file.

<?php

require_once("embient.util.php");
require_once("embient.db.php");

class EmbientPlugin
{
  var $user;

  var $name;

  // -------------------------

  var $_db;

  var $_mapping = array();

  // -------------------------

  var $_common_fields = array
      (
        'name',
        'passwd',
        'mail',
        'firstname',
        'lastname',
        'signature',
        'timezone',
      );

  // -------------------------

  function EmbientPlugin($systemname)
  {
    $this->user = array();
    $this->name = $systemname;

    $this->_db  = new EmbientDatabase();
  }

  function Init($cfg)
  {
    return $this->_db->Init($cfg);
  }

  function Login($username)
  {
    // to be implented in derived class
    embient_error("Plugin does not implement Login function", __FILE__, __LINE__);
  }

  function Logout($username)
  {
    // to be implented in derived class
    embient_error("Plugin does not implement Logout function", __FILE__, __LINE__);
  }

  function Add($user)
  {
    // to be implented in derived class
    embient_error("Plugin does not implement Add function", __FILE__, __LINE__);
  }

  function Update($username, $user)
  {
    // to be implented in derived class
    embient_error("Plugin does not implement Update function", __FILE__, __LINE__);
  }

  function Delete($username)
  {
    // to be implented in derived class
    embient_error("Plugin does not implement Delete function", __FILE__, __LINE__);
    return false;
  }

  // -------------------------

  function _Load($username)
  {
    // to be implented in derived class
    embient_error("Plugin does not implement _Load function", __FILE__, __LINE__);
    return false;
  }

  function _ConvertUserInfo($embientuser, $default = true)
  {

    embient_debug("Mapping is ". print_r($this->_mapping, true));
    embient_debug("Input user info is ". print_r($embientuser, true));

    foreach ($this->_common_fields as $field)
    {
      embient_debug("Checking [$field] ...");
      embient_debug("   input   : user[$field] = ". $embientuser[$field]);
      embient_debug("   mapping : $field => ". $this->_mapping[$field]);

      // check, if mapping is not empty?
      if ( ! empty($this->_mapping[$field]) )
      {
        // check, if value for this field is available?
        if ( ! empty($embientuser[$field]) )
        {
          // load with value from Embient
          $this->user[$this->_mapping[$field]] = $embientuser[$field];
          embient_debug("   output  : user[". $this->_mapping[$field] ."] is set to ". $embientuser[$field]);
        }
        else
        {
          embient_debug("   output  : user[". $this->_mapping[$field] ."] is not set");
        }
      }
    }
  }
}

---