Collaboration diagram for ilLicense:

Public Member Functions
	__construct ($a_obj_id)
	Constructor. More...

	getObjId ()

	setObjId ($obj_id)

	setLicenses ($a_licenses=0)

	getLicenses ()

	setRemarks ($a_remarks='')

	getRemarks ()

	getAccesses ()

	getRemainingLicenses ()

	getPotentialAccesses ()
	Get the number of users who may access the object but don't have yet a license. More...

	read ()
	Read the license data from the database. More...

	update ()
	Update the license data in the database. More...

	delete ()
	Delete all data of the license. More...

Static Public Member Functions
static	_checkAccess ($a_usr_id, $a_obj_id)
	Check, if a user can access an object by license. More...

static	_noteAccess ($a_obj_id, $a_type, $a_ref_id)
	Note the access of the current usr to an object. More...

static	_getLicensedObjects ()
	Get a list of all objects with activated licensing. More...

static	_getLicensedChildObjects ($a_ref_id)
	Get a list of all sub objects with activated licensing. More...

static	_isLicensed ($a_obj_id)
	Check if an object has licensing activated. More...

Protected Attributes
	$obj_id = 0

	$licenses = 0

	$remarks = ''

	$accesses = 0

Detailed Description

Definition at line 12 of file class.ilLicense.php.

Constructor & Destructor Documentation

◆ __construct()

ilLicense::__construct ( $a_obj_id )

Constructor.

public

Definition at line 38 of file class.ilLicense.php.

References read().

     {
         $this->obj_id = (int) $a_obj_id;
         $this->read();
     }

Here is the call graph for this function:

Member Function Documentation

◆ _checkAccess()

static ilLicense::_checkAccess	(	$a_usr_id,
		$a_obj_id
	)

static

Check, if a user can access an object by license.

The user can access, if he/she already accessed the object or if a license is available for the object. This check is called from the ilAccessHandler class.

Deprecated:: use ilLicenseAccess::_checkAccess instead

Parameters

int	$a_usr_id
int	$a_obj_id	(not reference)

Returns: boolean access is possible (true/false)

Definition at line 243 of file class.ilLicense.php.

References ilLicenseAccess\_checkAccess().

     {
         // Implementation moved
         require_once("Services/License/classes/class.ilLicenseAccess.php");
 
         return ilLicenseAccess::_checkAccess($a_usr_id, $a_obj_id);
     }

Here is the call graph for this function:

◆ _getLicensedChildObjects()

static ilLicense::_getLicensedChildObjects ( $a_ref_id )

static

Get a list of all sub objects with activated licensing.

Parameters

int $a_ref_id of the repository node to check

Returns: array array of object data arrays (obj_id, title, desc)

Definition at line 328 of file class.ilLicense.php.

References $data, and array.

Referenced by ilObjCourseGUI\checkLicenses(), and ilLicenseOverviewTableGUI\getItems().

     {
         global $tree;
         $objects = array();
 
         $childs = $tree->getChilds($a_ref_id, 'title');
         foreach ($childs as $data) {
             if (in_array($data['type'], array( 'sahs', 'htlm' )) and self::_isLicensed($data['obj_id'])) {
                 $objects[] = $data;
             }
         }
 
         return $objects;
     }

Here is the caller graph for this function:

◆ _getLicensedObjects()

static ilLicense::_getLicensedObjects ( )

static

Get a list of all objects with activated licensing.

Returns: array array of object data arrays (obj_id, type, title, description)

Definition at line 300 of file class.ilLicense.php.

References $ilDB, $obj_id, $query, $result, $row, and array.

Referenced by ilLicenseOverviewTableGUI\getItems().

     {
         global $ilDB;
         $objects = array();
 
         $query = 'SELECT od.obj_id, od.type, od.title, od.description, re.ref_id ' . 'FROM license_data ld '
                  . 'INNER JOIN object_data od ON od.obj_id = ld.obj_id ' . 'INNER JOIN object_reference re ON re.obj_id = od.obj_id '
                  . 'WHERE ld.licenses > 0 ' . 'ORDER BY od.title, od.obj_id';
 
         $result = $ilDB->query($query);
         $obj_id = 0;
         while ($row = $ilDB->fetchAssoc($result)) {
             if ($row['obj_id'] != $obj_id) {
                 $objects[] = $row;
                 $obj_id = $row['obj_id'];
             }
         }
 
         return $objects;
     }

Here is the caller graph for this function:

◆ _isLicensed()

static ilLicense::_isLicensed ( $a_obj_id )

static

Check if an object has licensing activated.

Parameters

int $a_obj_id

Returns: boolean object has licensing (true/false)

Definition at line 350 of file class.ilLicense.php.

References $ilDB, $query, $result, $row, and array.

     {
         global $ilDB;
 
         $query = "SELECT licenses FROM license_data " . "WHERE obj_id = %s " . "AND licenses > 0";
         $result = $ilDB->queryF($query, array( 'integer' ), array( $a_obj_id ));
         if ($row = $ilDB->fetchObject($result)) {
             return true;
         }
     }

◆ _noteAccess()

static ilLicense::_noteAccess	(	$a_obj_id,
		$a_type,
		$a_ref_id
	)

static

Note the access of the current usr to an object.

This function has to be called if an object is accessed for viewing.

Parameters

int	$a_obj_id
string	$a_type
int	$a_ref_id

Definition at line 261 of file class.ilLicense.php.

References $a_type, $ilDB, $ilUser, $query, $result, $row, ilLicenseAccess\_isEnabled(), ilChangeEvent\_recordReadEvent(), and array.

Referenced by ilSAHSPresentationGUI\executeCommand().

     {
         global $ilDB, $ilUser;
 
         // don't note the access if licensing is globally disabled
         require_once("Services/License/classes/class.ilLicenseAccess.php");
         if (!ilLicenseAccess::_isEnabled()) {
             return;
         }
 
         // check if user has already accessed
         $query = 'SELECT read_count FROM read_event ' . 'WHERE usr_id = %s AND obj_id = %s';
         $result = $ilDB->queryF($query, array( 'integer', 'integer' ), array( $ilUser->getId(), $a_obj_id ));
 
         if ($row = $ilDB->fetchObject($result)) {
             // already accessed -> nothing to do
             return;
         } else {
             // note access
             require_once('Services/Tracking/classes/class.ilChangeEvent.php');
             ilChangeEvent::_recordReadEvent($a_type, $a_ref_id, $a_obj_id, $ilUser->getId());
 
             if (self::_isLicensed($a_obj_id)) {
                 // increase used licenses
                 $query = "UPDATE license_data SET used = used + 1 " . "WHERE obj_id = %s";
                 $ilDB->manipulateF($query, array( 'integer' ), array( $a_obj_id ));
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilLicense::delete ( )

Delete all data of the license.

public

Definition at line 218 of file class.ilLicense.php.

References $ilDB, $query, and array.

     {
         global $ilDB;
 
         $query = 'DELETE FROM license_data WHERE obj_id = %s';
         $ilDB->manipulateF($query, array( 'integer' ), array( $this->obj_id ));
     }

◆ getAccesses()

ilLicense::getAccesses ( )

Returns: int

Definition at line 102 of file class.ilLicense.php.

References $accesses.

     {
         return $this->accesses;
     }

◆ getLicenses()

ilLicense::getLicenses ( )

Returns: int

Definition at line 75 of file class.ilLicense.php.

References $licenses.

     {
         return $this->licenses;
     }

◆ getObjId()

ilLicense::getObjId ( )

Returns: int

Definition at line 48 of file class.ilLicense.php.

References $obj_id.

Referenced by getPotentialAccesses(), and read().

     {
         return $this->obj_id;
     }

Here is the caller graph for this function:

◆ getPotentialAccesses()

ilLicense::getPotentialAccesses ( )

Get the number of users who may access the object but don't have yet a license.

public

Returns: int number of potential accesses

Definition at line 123 of file class.ilLicense.php.

References $ilDB, $query, $result, $row, ilRbacReview\_getOperationIdsByName(), array, and getObjId().

     {
         global $ilDB;
 
         // get the operation id for read access
         $ops_ids = ilRbacReview::_getOperationIdsByName(array( 'read' ));
 
         // first get all roles with read access
         $role_ids = array();
         $query = 'SELECT DISTINCT pa.rol_id' . ' FROM rbac_pa pa' . ' INNER JOIN object_reference ob ON ob.ref_id = pa.ref_id' . ' WHERE '
                  . $ilDB->like('pa.ops_id', 'text', '%%i:' . $ops_ids[0] . ';%%') . ' AND ob.obj_id = ' . $ilDB->quote($this->getObjId(), 'integer');
 
         $result = $ilDB->query($query);
         while ($row = $ilDB->fetchObject($result)) {
             $role_ids[] = $row->rol_id;
         }
 
         if (!count($role_ids)) {
             return 0;
         }
 
         // then count all users of these roles without read events
         $query = 'SELECT COUNT(DISTINCT(usr_id)) accesses ' . ' FROM rbac_ua' . ' WHERE ' . $ilDB->in('rol_id', $role_ids, false, 'integer')
                  . ' AND usr_id NOT IN' . ' (SELECT usr_id FROM read_event' . '  WHERE obj_id = ' . $ilDB->quote($this->getObjId(), 'integer') . ')';
 
         $result = $ilDB->query($query);
         $row = $ilDB->fetchObject($result);
 
         return $row->accesses;
     }

Here is the call graph for this function:

◆ getRemainingLicenses()

ilLicense::getRemainingLicenses ( )

Returns: int

Definition at line 111 of file class.ilLicense.php.

     {
         return max(0, $this->licenses - $this->accesses);
     }

◆ getRemarks()

ilLicense::getRemarks ( )

Returns: string

Definition at line 93 of file class.ilLicense.php.

References $remarks.

     {
         return $this->remarks;
     }

◆ read()

ilLicense::read ( )

Read the license data from the database.

public

Definition at line 163 of file class.ilLicense.php.

References $ilDB, $query, $result, $row, array, and getObjId().

Referenced by __construct().

     {
         global $ilDB;
 
         $query = 'SELECT * FROM license_data WHERE obj_id = %s';
         $result = $ilDB->queryF($query, array( 'integer' ), array( $this->getObjId() ));
 
         if ($row = $ilDB->fetchObject($result)) {
             $this->licenses = $row->licenses;
             $this->accesses = $row->used;
             $this->remarks = $row->remarks;
         } else {
             $this->licenses = 0;
             $this->accesses = 0;
             $this->remarks = '';
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setLicenses()

ilLicense::setLicenses ( $a_licenses = 0 )

Parameters

int $a_licenses

Definition at line 66 of file class.ilLicense.php.

     {
         $this->licenses = (int) $a_licenses;
     }

◆ setObjId()

ilLicense::setObjId ( $obj_id )

Parameters

int $obj_id

Definition at line 57 of file class.ilLicense.php.

References $obj_id.

     {
         $this->obj_id = $obj_id;
     }

◆ setRemarks()

ilLicense::setRemarks ( $a_remarks = '' )

Parameters

string $a_remarks

Definition at line 84 of file class.ilLicense.php.

     {
         $this->remarks = $a_remarks;
     }

◆ update()

ilLicense::update ( )

Update the license data in the database.

public

Definition at line 187 of file class.ilLicense.php.

References $ilDB, $query, $result, $row, and array.

     {
         global $ilDB;
 
         $query = 'SELECT * FROM license_data WHERE obj_id = %s';
         $result = $ilDB->queryF($query, array( 'integer' ), array( $this->obj_id ));
 
         if ($row = $ilDB->fetchObject($result)) {
             $ilDB->update('license_data', array(
                 'licenses' => array( 'integer', $this->licenses ),
                 'used'     => array( 'integer', $this->accesses ),
                 'remarks'  => array( 'clob', $this->remarks ),
             ), array(
                 'obj_id' => array( 'integer', $this->obj_id ),
             ));
         } else {
             $ilDB->insert('license_data', array(
                 'obj_id'   => array( 'integer', $this->obj_id ),
                 'licenses' => array( 'integer', $this->licenses ),
                 'used'     => array( 'integer', $this->accesses ),
                 'remarks'  => array( 'clob', $this->remarks ),
             ));
         }
     }

Field Documentation

◆ $accesses

ilLicense::$accesses = 0

protected

Definition at line 30 of file class.ilLicense.php.

Referenced by getAccesses().

◆ $licenses

ilLicense::$licenses = 0

protected

Definition at line 22 of file class.ilLicense.php.

Referenced by getLicenses().

◆ $obj_id

ilLicense::$obj_id = 0

protected

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

Referenced by _getLicensedObjects(), getObjId(), and setObjId().

◆ $remarks

ilLicense::$remarks = ''

protected

Definition at line 26 of file class.ilLicense.php.

Referenced by getRemarks().

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

Services/License/classes/class.ilLicense.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _checkAccess()

◆ _getLicensedChildObjects()

◆ _getLicensedObjects()

◆ _isLicensed()

◆ _noteAccess()

◆ delete()

◆ getAccesses()

◆ getLicenses()

◆ getObjId()

◆ getPotentialAccesses()

◆ getRemainingLicenses()

◆ getRemarks()

◆ read()

◆ setLicenses()

◆ setObjId()

◆ setRemarks()

◆ update()

Field Documentation

◆ $accesses

◆ $licenses

◆ $obj_id

◆ $remarks