ilAccountCode Class Reference

Class ilAccountCode. More...

Collaboration diagram for ilAccountCode:

Static Public Member Functions
static	create ($valid_until, $stamp)
static	getCodesData ($order_field, $order_direction, $offset, $limit, $filter_code, $filter_valid_until, $filter_generated)
static	loadCodesByIds (array $ids)
static	deleteCodes (array $ids)
static	getGenerationDates ()
static	getCodesForExport ($filter_code, $filter_valid_until, $filter_generated)
static	isUnusedCode ($code)
static	useCode ($code)
static	getCodeValidUntil ($code)
static	applyRoleAssignments (ilObjUser $user, $code)
static	applyAccessLimits (ilObjUser $user, $code)

Data Fields
const	DB_TABLE = 'usr_account_codes'
const	CODE_LENGTH = 10

Static Protected Member Functions
static	generateRandomCode ()
static	filterToSQL ($filter_code, $filter_valid_until, $filter_generated)

Detailed Description

Class ilAccountCode.

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

Id

class.ilRegistrationSettingsGUI.php 23797 2010-05-07 15:54:03Z jluetzen

Definition at line 13 of file class.ilAccountCode.php.

Member Function Documentation

applyAccessLimits()

static ilAccountCode::applyAccessLimits ( ilObjUser  $user,   $code  )

static

Definition at line 256 of file class.ilAccountCode.php.

        {
                include_once './Services/Registration/classes/class.ilRegistrationCode.php';
                $code_data = ilRegistrationCode::getCodeData($code);
                
                if($code_data["alimit"])
                {
                        switch($code_data["alimit"])
                        {
                                case "absolute":
                                        $end = new ilDateTime($code_data['alimitdt'],IL_CAL_DATE);
                                        //$user->setTimeLimitFrom(time());
                                        $user->setTimeLimitUntil($end->get(IL_CAL_UNIX));
                                        $user->setTimeLimitUnlimited(0);
                                        break;
                                                
                                case "relative":                                        
 
                                        $rel = unserialize($code_data["alimitdt"]);
                                        
                                        include_once './Services/Calendar/classes/class.ilDateTime.php';
                                        $end = new ilDateTime(time(),IL_CAL_UNIX);
 
                                        if($rel['y'] > 0)
                                        {
                                                $end->increment(IL_CAL_YEAR, $rel['y']);
                                        }
 
                                        if($rel['m'] > 0)
                                        {
                                                $end->increment(IL_CAL_MONTH, $rel['m']);
                                        }
 
                                        if($rel['d'] > 0)
                                        {
                                                $end->increment(IL_CAL_DAY, $rel['d']);
                                        }
 
                                        //$user->setTimeLimitFrom(time());
                                        $user->setTimeLimitUntil($end->get(IL_CAL_UNIX));
                                        $user->setTimeLimitUnlimited(0);
                                        break;
                                
                                case 'unlimited':
                                        $user->setTimeLimitUnlimited(1);
                                        break;
                                        
                        }
                }
                else
                {
                        $user->setTimeLimitUnlimited(1);
                }
                
        }

References $code, ilRegistrationCode\getCodeData(), IL_CAL_DATE, IL_CAL_DAY, IL_CAL_MONTH, IL_CAL_UNIX, IL_CAL_YEAR, ilObjUser\setTimeLimitUnlimited(), and ilObjUser\setTimeLimitUntil().

Referenced by ilStartUpGUI\processCode().

Here is the call graph for this function:

Here is the caller graph for this function:

applyRoleAssignments()

static ilAccountCode::applyRoleAssignments ( ilObjUser  $user,   $code  )

static

Definition at line 223 of file class.ilAccountCode.php.

        {
                include_once './Services/Registration/classes/class.ilRegistrationCode.php';
                
                $grole = ilRegistrationCode::getCodeRole($code);
                if($grole)
                {
                        $GLOBALS['rbacadmin']->assignUser($grole,$user->getId());
                }
                $code_data = ilRegistrationCode::getCodeData($code);
                if($code_data["role_local"])
                {
                        $code_local_roles = explode(";", $code_data["role_local"]);
                        foreach((array) $code_local_roles as $role_id)
                        {
                                $GLOBALS['rbacadmin']->assignUser($role_id,$user->getId());
                                
                                // patch to remove for 45 due to mantis 21953
                                $role_obj = $GLOBALS['rbacreview']->getObjectOfRole($role_id);
                                switch(ilObject::_lookupType($role_obj))
                                {
                                        case 'crs':
                                        case 'grp':
                                                $role_refs = ilObject::_getAllReferences($role_obj);
                                                $role_ref = end($role_refs);
                                                ilObjUser::_addDesktopItem($user->getId(),$role_ref,ilObject::_lookupType($role_obj));
                                                break;
                                }
                        }
                }
                return true;
        }

References $code, $GLOBALS, ilObjUser\_addDesktopItem(), ilObject\_getAllReferences(), ilObject\_lookupType(), ilRegistrationCode\getCodeData(), ilRegistrationCode\getCodeRole(), and ilObject\getId().

Referenced by ilStartUpGUI\processCode().

Here is the call graph for this function:

Here is the caller graph for this function:

create()

static ilAccountCode::create (   $valid_until,   $stamp  )

static

Definition at line 18 of file class.ilAccountCode.php.

        {
                global $ilDB;
                
                $id = $ilDB->nextId(self::DB_TABLE);
                
                // create unique code
                $found = true;
                while ($found)
                {
                        $code = self::generateRandomCode();
                        $chk = $ilDB->queryF("SELECT code_id FROM ".self::DB_TABLE." WHERE code = %s", array("text"), array($code));
                        $found = (bool)$ilDB->numRows($chk);
                }
                
                $data = array(
                        'code_id' => array('integer', $id),
                        'code' => array('text', $code),
                        'generated' => array('integer', $stamp),
                        'valid_until' => array('text', $valid_until)
                        );
 
                $ilDB->insert(self::DB_TABLE, $data);
                return $id;
        }

References $code, $data, $ilDB, and generateRandomCode().

Referenced by ilAccountCodesGUI\createCodes().

Here is the call graph for this function:

Here is the caller graph for this function:

deleteCodes()

static ilAccountCode::deleteCodes ( array  $ids )

static

Definition at line 103 of file class.ilAccountCode.php.

        {
                global $ilDB;
 
                if(sizeof($ids))
                {
                        return $ilDB->manipulate("DELETE FROM ".self::DB_TABLE." WHERE ".$ilDB->in("code_id", $ids, false, "integer"));
                }
                return false;
        }

References $ilDB.

Referenced by ilAccountCodesGUI\deleteCodes().

Here is the caller graph for this function:

filterToSQL()

static ilAccountCode::filterToSQL (   $filter_code,   $filter_valid_until,   $filter_generated  )

staticprotected

Definition at line 127 of file class.ilAccountCode.php.

        {
                global $ilDB;
 
                $where = array();
                if($filter_code)
                {
                        $where[] = $ilDB->like("code", "text", "%".$filter_code."%");
                }
                if($filter_valid_until)
                {
                        $where[] ="valid_until = ".$ilDB->quote($filter_valid_until, "text");
                }
                if($filter_generated)
                {
                        $where[] ="generated = ".$ilDB->quote($filter_generated, "text");
                }
                if(sizeof($where))
                {
                        return " WHERE ".implode(" AND ", $where);
                }
                else
                {
                        return "";
                }
        }

References $ilDB.

Referenced by getCodesData(), and getCodesForExport().

Here is the caller graph for this function:

generateRandomCode()

static ilAccountCode::generateRandomCode ( )

staticprotected

Definition at line 44 of file class.ilAccountCode.php.

        {
                // missing : 01iloO
                $map = "23456789abcdefghjkmnpqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ";
                
                $code = "";
                $max = strlen($map)-1;
                for($loop = 1; $loop <= self::CODE_LENGTH; $loop++)
                {
                  $code .= $map[mt_rand(0, $max)];
                }
                return $code;
        }

References $code, and CODE_LENGTH.

Referenced by create().

Here is the caller graph for this function:

getCodesData()

static ilAccountCode::getCodesData (   $order_field,   $order_direction,   $offset,   $limit,   $filter_code,   $filter_valid_until,   $filter_generated  )

static

Definition at line 58 of file class.ilAccountCode.php.

        {
                global $ilDB;
                
                // filter
                $where = self::filterToSQL($filter_code, $filter_valid_until, $filter_generated);
 
                // count query
                $set = $ilDB->query("SELECT COUNT(*) AS cnt FROM ".self::DB_TABLE.$where);
                $cnt = 0;
                if ($rec = $ilDB->fetchAssoc($set))
                {
                        $cnt = $rec["cnt"];
                }
                
                $sql = "SELECT * FROM ".self::DB_TABLE.$where;
                if($order_field)
                {
                        $sql .= " ORDER BY ".$order_field." ".$order_direction;
                }
                
                // set query
                $ilDB->setLimit((int)$limit, (int)$offset);
                $set = $ilDB->query($sql);
                $result = array();
                while($rec = $ilDB->fetchAssoc($set))
                {
                        $result[] = $rec;
                }
                return array("cnt" => $cnt, "set" => $result);
        }

References $ilDB, $result, and filterToSQL().

Referenced by ilAccountCodesTableGUI\getItems().

Here is the call graph for this function:

Here is the caller graph for this function:

getCodesForExport()

static ilAccountCode::getCodesForExport (   $filter_code,   $filter_valid_until,   $filter_generated  )

static

Definition at line 154 of file class.ilAccountCode.php.

        {
                global $ilDB;
 
                // filter
                $where = self::filterToSQL($filter_code, $filter_valid_until, $filter_generated);
 
                // set query
                $set = $ilDB->query("SELECT code FROM ".self::DB_TABLE.$where." ORDER BY code_id");
                $result = array();
                while($rec = $ilDB->fetchAssoc($set))
                {
                        $result[] = $rec["code"];
                }
                return $result;
        }

References $ilDB, $result, and filterToSQL().

Referenced by ilAccountCodesGUI\exportCodes().

Here is the call graph for this function:

Here is the caller graph for this function:

getCodeValidUntil()

static ilAccountCode::getCodeValidUntil (   $code )

static

Definition at line 198 of file class.ilAccountCode.php.

    {
                global $ilDB;
                
                include_once './Services/Registration/classes/class.ilRegistrationCode.php';
                $code_data = ilRegistrationCode::getCodeData($code);
                
                if($code_data["alimit"])
                {
                        switch($code_data["alimit"])
                        {
                                case "absolute":
                                        return $code_data['alimitdt'];
                        }
                }
                return "0";
 
                $set = $ilDB->query("SELECT valid_until FROM ".self::DB_TABLE." WHERE code = ".$ilDB->quote($code, "text"));
                $row = $ilDB->fetchAssoc($set);
                if(isset($row["valid_until"]))
                {
                        return $row["valid_until"];
                }
        }

References $code, $ilDB, $row, and ilRegistrationCode\getCodeData().

Referenced by ilStartUpGUI\processCode().

Here is the call graph for this function:

Here is the caller graph for this function:

getGenerationDates()

static ilAccountCode::getGenerationDates ( )

static

Definition at line 114 of file class.ilAccountCode.php.

        {
                global $ilDB;
                
                $set = $ilDB->query("SELECT DISTINCT(generated) AS generated FROM ".self::DB_TABLE." ORDER BY generated");
                $result = array();
                while($rec = $ilDB->fetchAssoc($set))
                {
                        $result[] = $rec["generated"];
                }
                return $result;
        }

References $ilDB, and $result.

Referenced by ilAccountCodesTableGUI\initFilter().

Here is the caller graph for this function:

isUnusedCode()

static ilAccountCode::isUnusedCode (   $code )

static

Definition at line 171 of file class.ilAccountCode.php.

        {
                global $ilDB;
                
                include_once './Services/Registration/classes/class.ilRegistrationCode.php';
                return ilRegistrationCode::isUnusedCode($code);
                
                
                $set = $ilDB->query("SELECT used FROM ".self::DB_TABLE." WHERE code = ".$ilDB->quote($code, "text"));
                $set = $ilDB->fetchAssoc($set);
                if($set && !$set["used"])
                {
                        return true;
                }
                return false;
        }

References $code, $ilDB, and ilRegistrationCode\isUnusedCode().

Referenced by ilStartUpGUI\processCode().

Here is the call graph for this function:

Here is the caller graph for this function:

loadCodesByIds()

static ilAccountCode::loadCodesByIds ( array  $ids )

static

Definition at line 90 of file class.ilAccountCode.php.

        {
                global $ilDB;
 
                $set = $ilDB->query("SELECT * FROM ".self::DB_TABLE." WHERE ".$ilDB->in("code_id", $ids, false, "integer"));
                $result = array();
                while($rec = $ilDB->fetchAssoc($set))
                {
                        $result[] = $rec;
                }
                return $result;
        }

References $ilDB, and $result.

Referenced by ilAccountCodesGUI\deleteConfirmation().

Here is the caller graph for this function:

useCode()

static ilAccountCode::useCode (   $code )

static

Definition at line 188 of file class.ilAccountCode.php.

        {
                global $ilDB;
                
                include_once './Services/Registration/classes/class.ilRegistrationCode.php';
                return (bool) ilRegistrationCode::useCode($code);
 
                return (bool)$ilDB->update(self::DB_TABLE, array("used"=>array("timestamp", time())), array("code"=>array("text", $code)));
        }

References $code, $ilDB, and ilRegistrationCode\useCode().

Referenced by ilStartUpGUI\processCode().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

CODE_LENGTH

const ilAccountCode::CODE_LENGTH = 10

Definition at line 16 of file class.ilAccountCode.php.

Referenced by generateRandomCode(), and ilAccountCodesTableGUI\initFilter().

DB_TABLE

const ilAccountCode::DB_TABLE = 'usr_account_codes'

Definition at line 15 of file class.ilAccountCode.php.

---

The documentation for this class was generated from the following file:

• Services/User/classes/class.ilAccountCode.php