Source for file Active_User.php

Documentation is available at Active_User.php

  1. <?php
  2. /**
  3.  *    LAIKA FRAMEWORK Release Notes:
  4.  *
  5.  *    @filesource     Active_User.php
  6.  *
  7.  *    @version        0.1.0b
  8.  *    @package        Laika
  9.  *    @subpackage     module
  10.  *    @category       model
  11.  *    @date           2012-05-18 22:05:37 -0400 (Fri, 18 May 2012)
  12.  *
  13.  *    @author         Leonard M. Witzel <witzel@post.harvard.edu>
  14.  *    @copyright      Copyright (c) 2012  Laika Soft <{@link http://oafbot.com}>
  15.  *
  16.  */
  17. /**
  18.  * Laika_Active_User class.
  19.  *
  20.  * Class representing the user currently logged in.
  21.  * A Singleton representation of the User Model Class.
  22.  * 
  23.  * @extends Laika_Abstract_Singleton_Model
  24.  */
  25. class Laika_Active_User extends Laika_Abstract_Singleton_Model{
  26.  
  27. //-------------------------------------------------------------------
  28. //    PROPERTIES
  29. //-------------------------------------------------------------------
  30.  
  31.     protected static $instance;
  32.     protected        $model;
  33.     protected        $table;
  34.     protected        $accessibles = array('username','email','firstname','lastname','logged_in');
  35.         
  36.     protected        $id;
  37.     protected        $username;
  38.     protected        $password;
  39.     protected        $salt;
  40.     protected        $email;
  41.     protected        $level;
  42.     protected        $firstname;
  43.     protected        $lastname;
  44.     protected        $logged_in;
  45.  
  46.     protected        $created;
  47.     protected        $updated;
  48.     
  49. //-------------------------------------------------------------------
  50. //    METHODS
  51. //-------------------------------------------------------------------
  52.  
  53.     /**
  54.      * init function.
  55.      * 
  56.      * @access public
  57.      * @static
  58.      * @return object 
  59.      */
  60.     public static function init(){       
  61.         parent::init();
  62.         self::$instance->model = 'Active_User';
  63.         self::$instance->table = 'users';
  64.         return self::$instance;    
  65.     }
  66.  
  67.     /**
  68.      * bind function.
  69.      * 
  70.      * @access public
  71.      * @static
  72.      * @param int $id 
  73.      * @return void 
  74.      */
  75.     public static function bind($id){
  76.         Laika_Active_Session::unregister($id,false);
  77.         $user = self::load($id);
  78.         Laika_Registry::register('Active_User',$user);
  79.         Laika_Active_Session::register($id);
  80.     }
  81.  
  82.     /**
  83.      * active function.
  84.      * 
  85.      * @access public
  86.      * @static
  87.      * @return Active_User Object
  88.      */
  89.     public static function active(){
  90.         if(Laika_Registry::peek('Active_User'))
  91.             self::$instance = Laika_Registry::get_record('Active_User');            
  92.         elseif( isset($_SESSION['PREVIOUS_TOKEN']) ) 
  93.             self::$instance = self::wake_up();
  94.         else self::init();
  95.         
  96.         return self::$instance;            
  97.     }
  98.     
  99.     /**
  100.      * wake_up function.
  101.      * 
  102.      * @access public
  103.      * @static
  104.      * @return Active_User Object
  105.      */
  106.     public static function wake_up(){
  107.         $id = Laika_Active_Session::find_user($_SESSION['PREVIOUS_TOKEN']);
  108.         self::bind($id);
  109.         return Laika_Registry::get_record('Active_User');
  110.     }
  111.     
  112.     /**
  113.      * sleep function.
  114.      * 
  115.      * @access public
  116.      * @static
  117.      * @return void 
  118.      */
  119.     public static function sleep(){
  120.         $user = self::active();
  121.         $id = $user::get('id');
  122.         Laika_Active_Session::unregister($id,true);    
  123.     }
  124.     
  125.     public static function deactivate(){}
  126.     
  127.     /**
  128.      * name function.
  129.      * 
  130.      * @access public
  131.      * @return string 
  132.      */
  133.     public function name(){
  134.         if(func_num_args()==0)
  135.             $user = self::init();
  136.         else
  137.             $user = self::load(func_get_arg(0));
  138.         return $user->firstname." ".$user->lastname;
  139.     }
  140.     
  141.     /**
  142.      * activated function.
  143.      * 
  144.      * @access public
  145.      * @return void 
  146.      */
  147.     public static function valid_account(){
  148.         $account = Laika_Account::find('user',self::init()->id);
  149.         if(!$account->confirmed() || $account->deactivated())
  150.             return false;
  151.         return true;
  152.     }
  153.     
  154.     /**
  155.      * account function.
  156.      * 
  157.      * @access public
  158.      * @return void 
  159.      */
  160.     public function account(){
  161.         return Laika_Account::find('user',self::init()->id);
  162.     }
  163.     
  164.     /**
  165.      * logged_in function.
  166.      * 
  167.      * @access public
  168.      * @return void 
  169.      */
  170.     public function logged_in(){        
  171.         if(func_num_args()>0)          
  172.             return $this->dset('logged_in', func_get_arg(0));
  173.         return $this->dset('logged_in', true);
  174.     }   
  175.  
  176.     /**
  177.      * avatar function.
  178.      * 
  179.      * @access public
  180.      * @param mixed $size 
  181.      * @return void 
  182.      */
  183.     public function avatar($size){
  184.         $link = '<a href="'.HTTP_ROOT.'/user/'.$this->username.'" >';
  185.         return $link.Laika_Avatar::img(self::init()->email,$size).'</a>';
  186.     }                            
  187. }

Documentation generated on Sat, 19 May 2012 02:16:56 -0400 by phpDocumentor 1.4.4