ilAdvancedMDRecordObjectOrderings Class Reference

Collaboration diagram for ilAdvancedMDRecordObjectOrderings:

Public Member Functions
	__construct ()
	deleteByObjId (int $obj_id)
	Delete entries by obj_id. More...
	sortRecords (array $records, int $obj_id=null)
	compareRecords (ilAdvancedMDRecord $a, ilAdvancedMDRecord $b)
	compareLocalRecords (ilAdvancedMDRecord $a, ilAdvancedMDRecord $b)

Protected Member Functions
	readPositionsForObject (int $obj_id)
	Read local positions for object. More...

Private Attributes
ilDBInterface	$db
array	$record_position_map = []

Detailed Description

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 10 of file class.ilAdvancedMDRecordObjectOrderings.php.

Constructor & Destructor Documentation

__construct()

ilAdvancedMDRecordObjectOrderings::__construct

(

)

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

References $DIC.

    {
        global $DIC;

        $this->db = $DIC->database();
    }

Member Function Documentation

compareLocalRecords()

ilAdvancedMDRecordObjectOrderings::compareLocalRecords	(	ilAdvancedMDRecord	$a,
		ilAdvancedMDRecord	$b
	)

Parameters

ilAdvancedMDRecord	$a
ilAdvancedMDRecord	$b

Returns

int

Definition at line 100 of file class.ilAdvancedMDRecordObjectOrderings.php.

References ilAdvancedMDRecord\getGlobalPosition(), and ilAdvancedMDRecord\getRecordId().

                                                                                     : int
    {
        $local_pos_a = $this->record_position_map[$a->getRecordId()] ??
            ($a->getGlobalPosition() ?: 999);
        $local_pos_b = $this->record_position_map[$b->getRecordId()] ??
            ($b->getGlobalPosition() ?: 999);
        if ($local_pos_a < $local_pos_b) {
            return -1;
        }
        if ($local_pos_a > $local_pos_b) {
            return 1;
        }
        return 0;
    }

Here is the call graph for this function:

compareRecords()

ilAdvancedMDRecordObjectOrderings::compareRecords	(	ilAdvancedMDRecord	$a,
		ilAdvancedMDRecord	$b
	)

Parameters

ilAdvancedMDRecord	$a
ilAdvancedMDRecord	$b

Returns

int

Definition at line 77 of file class.ilAdvancedMDRecordObjectOrderings.php.

References ilAdvancedMDRecord\getGlobalPosition(), and ilAdvancedMDRecord\setGlobalPosition().

                                                                                : int
    {
        if ($a->getGlobalPosition() == null) {
            $a->setGlobalPosition(999);
        }
        if ($b->getGlobalPosition() == null) {
            $b->setGlobalPosition(999);
        }

        if ($a->getGlobalPosition() < $b->getGlobalPosition()) {
            return -1;
        }
        if ($a->getGlobalPosition() > $b->getGlobalPosition()) {
            return 1;
        }
        return 0;
    }

Here is the call graph for this function:

deleteByObjId()

ilAdvancedMDRecordObjectOrderings::deleteByObjId

(

int

$obj_id

)

Delete entries by obj_id.

Definition at line 25 of file class.ilAdvancedMDRecordObjectOrderings.php.

References $query.

                                              : void
    {
        $query = 'DELETE FROM adv_md_record_obj_ord ' .
            'WHERE obj_id = ' . $this->db->quote($obj_id, 'integer');
        $this->db->manipulate($query);
    }

readPositionsForObject()

ilAdvancedMDRecordObjectOrderings::readPositionsForObject ( int  $obj_id )

protected

Read local positions for object.

Definition at line 118 of file class.ilAdvancedMDRecordObjectOrderings.php.

References $query, $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

Referenced by sortRecords().

                                                          : void
    {
        $query = 'SELECT record_id, position FROM adv_md_record_obj_ord ' .
            'WHERE obj_id = ' . $this->db->quote($obj_id, 'integer');
        $res = $this->db->query($query);

        $this->record_position_map = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->record_position_map[(int) $row->record_id] = (int) $row->position;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sortRecords()

ilAdvancedMDRecordObjectOrderings::sortRecords	(	array	$records,
		int	$obj_id = null
	)

Parameters

ilAdvancedMDRecord[]	$records
?int	$obj_id

Returns

ilAdvancedMDRecord[]

Definition at line 37 of file class.ilAdvancedMDRecordObjectOrderings.php.

References ilContainer\_lookupContainerSetting(), ilObjectServiceSettingsGUI\CUSTOM_METADATA, and readPositionsForObject().

                                                                   : array
    {
        // if local custom meta is not enabled use global sorting
        $use_global = true;
        if ($obj_id) {
            if (ilContainer::_lookupContainerSetting(
                $obj_id,
                ilObjectServiceSettingsGUI::CUSTOM_METADATA,
                ''
            )) {
                $use_global = false;
            }
        }
        if ($use_global) {
            usort(
                $records,
                [
                    __CLASS__,
                    'compareRecords'
                ]
            );
            return $records;
        } else {
            $this->readPositionsForObject($obj_id);
            usort(
                $records,
                [
                    __CLASS__,
                    'compareLocalRecords'
                ]
            );
        }
        return $records;
    }

Here is the call graph for this function:

Field Documentation

$db

ilDBInterface ilAdvancedMDRecordObjectOrderings::$db

private

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

$record_position_map

array ilAdvancedMDRecordObjectOrderings::$record_position_map = []

private

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

---

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

• Services/AdvancedMetaData/classes/Record/class.ilAdvancedMDRecordObjectOrderings.php