ilCmiXapiLrsTypeList Class Reference

Collaboration diagram for ilCmiXapiLrsTypeList:

Static Public Member Functions
static	getTypesData (bool $a_extended=false, ?int $a_availability=null)
	Get basic data array of all types (without field definitions) More...
static	countUntrashedUsages (int $a_type_id)
	Count the number of untrashed usages of a type. More...
static	getTypeOptions (?int $a_availability=null)
	Get array of options for selecting the type. More...
static	getTypesStruct ()
static	getCountTypesForCreate ()

Detailed Description

Definition at line 28 of file class.ilCmiXapiLrsTypeList.php.

Member Function Documentation

countUntrashedUsages()

static ilCmiXapiLrsTypeList::countUntrashedUsages ( int  $a_type_id )

static

Count the number of untrashed usages of a type.

Definition at line 62 of file class.ilCmiXapiLrsTypeList.php.

                                                               : int
    {
        global $ilDB;
 
        $query = "
                        SELECT COUNT(*) untrashed
                        FROM cmix_settings s
                        INNER JOIN object_reference r
                        ON r.obj_id = s.obj_id
                        AND r.deleted IS NULL
                        WHERE s.lrs_type_id = %s
                ";
 
        $res = $ilDB->queryF($query, ['integer'], [$a_type_id]);
        $row = $ilDB->fetchObject($res);
        return (int) $row->untrashed;
    }

References $ilDB, and $res.

Referenced by getTypesData().

Here is the caller graph for this function:

getCountTypesForCreate()

static ilCmiXapiLrsTypeList::getCountTypesForCreate ( )

static

Definition at line 138 of file class.ilCmiXapiLrsTypeList.php.

                                                   : int
    {
        global $ilDB;
        $query = "SELECT COUNT(*) counter FROM " . ilCmiXapiLrsType::getDbTableName() . "
                                        WHERE availability = " . $ilDB->quote(ilCmiXapiLrsType::AVAILABILITY_CREATE, 'integer');
        $res = $ilDB->query($query);
        $row = $ilDB->fetchObject($res);
        return (int) $row->counter;
    }

References $ilDB, $res, ilCmiXapiLrsType\AVAILABILITY_CREATE, and ilCmiXapiLrsType\getDbTableName().

Here is the call graph for this function:

getTypeOptions()

static ilCmiXapiLrsTypeList::getTypeOptions ( ?int  $a_availability = null )

static

Get array of options for selecting the type.

Parameters

int | null

$a_availability

required availability or null

Returns

array id => title

Definition at line 85 of file class.ilCmiXapiLrsTypeList.php.

                                                                      : array
    {
        global $ilDB;
 
        $query = "SELECT * FROM " . ilCmiXapiLrsType::getDbTableName();
        if (isset($a_availability)) {
            $query .= " WHERE availability=" . $ilDB->quote($a_availability, 'integer');
        }
        $res = $ilDB->query($query);
 
        $options = array();
        while ($row = $ilDB->fetchObject($res)) {
            $options[$row->type_id] = $row->title;
        }
        return $options;
    }

References $ilDB, ILIAS\UI\Implementation\Component\Input\Field\$options, $res, and ilCmiXapiLrsType\getDbTableName().

Here is the call graph for this function:

getTypesData()

static ilCmiXapiLrsTypeList::getTypesData ( bool  $a_extended = false, ?int  $a_availability = null  )

static

Get basic data array of all types (without field definitions)

Parameters

boolean	get extended data ('usages')
mixed	required availability or null

Returns

array array of assoc data arrays

Definition at line 36 of file class.ilCmiXapiLrsTypeList.php.

                                                                                              : array
    {
        global $ilDB;
 
        $query = "SELECT * FROM " . ilCmiXapiLrsType::getDbTableName();
        if (isset($a_availability)) {
            $query .= " WHERE availability=" . $ilDB->quote($a_availability, 'integer');
        }
        $query .= " ORDER BY title";
        $res = $ilDB->query($query);
 
        $data = array();
        while ($row = $ilDB->fetchAssoc($res)) {
            $row['lrs_type_id'] = $row['type_id']; // indeed it is an lrs-type-id
 
            if ($a_extended) {
                $row['usages'] = self::countUntrashedUsages((int) $row['lrs_type_id']);
            }
            $data[] = $row;
        }
        return $data;
    }

References $data, $ilDB, $res, countUntrashedUsages(), and ilCmiXapiLrsType\getDbTableName().

Referenced by ilObjCmiXapiGUI\initCreateForm(), and ilObjCmiXapiAdministrationGUI\showLrsTypesListCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

getTypesStruct()

static ilCmiXapiLrsTypeList::getTypesStruct ( )

static

Returns

array<string, mixed[]>

Definition at line 105 of file class.ilCmiXapiLrsTypeList.php.

                                           : array
    {
        return array(
            'type_name' => array('type' => 'text', 'maxlength' => 32)
            ,
            'title' => array('type' => 'text', 'maxlength' => 255)
            ,
            'description' => array('type' => 'text', 'maxlength' => 4000)
            ,
            'availability' => array('type' => 'a_integer', 'maxlength' => 1, 'options' => array(2, 1, 0))
            //AVAILABILITY_CREATE,AVAILABILITY_EXISTING,AVAILABILITY_NONE
            // , 'lrs'                          => array('type'=>'headline')
            ,
            'lrs_type_id' => array('type' => 'a_integer', 'maxlength' => 1, 'options' => array(0))
            ,
            'lrs_endpoint' => array('type' => 'text', 'maxlength' => 64, 'required' => true)
            ,
            'lrs_key' => array('type' => 'text', 'maxlength' => 64, 'required' => true)
            ,
            'lrs_secret' => array('type' => 'text', 'maxlength' => 64, 'required' => true)
            ,
            'external_lrs' => array('type' => 'bool')
            ,
            'privacy_ident' => array('type' => 'a_integer', 'maxlength' => 1, 'options' => array(0, 1, 2, 3))
            ,
            'privacy_name' => array('type' => 'a_integer', 'maxlength' => 1, 'options' => array(0, 1, 2, 3))
            ,
            'privacy_comment_default' => array('type' => 'text', 'maxlength' => 2000)
            ,
            'remarks' => array('type' => 'text', 'maxlength' => 4000)
        );
    }

---

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

• components/ILIAS/CmiXapi/classes/class.ilCmiXapiLrsTypeList.php