ilOrgUnitObjectPositionSetting Class Reference

Stores object activation status of orgunit position settings. More...

Collaboration diagram for ilOrgUnitObjectPositionSetting:

Public Member Functions
	__construct ($a_obj_id)
	Constructor. More...
	lookupActive ($a_obj_id)
	Lookup activation status. More...
	isActive ()
	Check if position access is active. More...
	setActive ($a_status)
	Set active for object. More...
	update ()
	Update object entry. More...
	delete ()
	Delete record. More...
	hasObjectSpecificActivation ()

Protected Member Functions
	readSettings ()
	Read from db. More...

Protected Attributes
	$db

Private Attributes
	$obj_id
	$active

Detailed Description

Stores object activation status of orgunit position settings.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 11 of file class.ilOrgUnitObjectPositionSetting.php.

Constructor & Destructor Documentation

__construct()

ilOrgUnitObjectPositionSetting::__construct

(

$a_obj_id

)

Constructor.

Parameters

int

$a_obj_id

Definition at line 33 of file class.ilOrgUnitObjectPositionSetting.php.

References $GLOBALS, and readSettings().

    {
        $this->db = $GLOBALS['DIC']->database();
        $this->obj_id = $a_obj_id;
        $this->readSettings();
    }

Here is the call graph for this function:

Member Function Documentation

delete()

ilOrgUnitObjectPositionSetting::delete

(

)

Delete record.

Definition at line 99 of file class.ilOrgUnitObjectPositionSetting.php.

References $query.

    {
        $query = 'DELETE from orgu_obj_pos_settings ' . 'WHERE obj_id = '
                 . $this->db->quote($this->obj_id, 'integer');
        $this->db->manipulate($query);
    }

hasObjectSpecificActivation()

ilOrgUnitObjectPositionSetting::hasObjectSpecificActivation

(

)

Returns

bool Returns true if the object has a specific setting false if there is no object specific setting, take the global setting in this case.

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

    {
        return $this->active !== null;
    }

isActive()

ilOrgUnitObjectPositionSetting::isActive

(

)

Check if position access is active.

This returns true or false if it is object specific or null if the object has no setting.

Returns

null|bool

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

References $active.

Referenced by update().

    {
        return $this->active;
    }

Here is the caller graph for this function:

lookupActive()

ilOrgUnitObjectPositionSetting::lookupActive

(

$a_obj_id

)

Lookup activation status.

Parameters

int

$a_obj_id

Returns

bool active status

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

References $db, $GLOBALS, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

    {
        $db = $GLOBALS['DIC']->database();

        $query = 'select *  from orgu_obj_pos_settings ' . 'where obj_id = '
                 . $db->quote($a_obj_id, 'integer');
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return (bool) $row->active;
        }
    }

readSettings()

ilOrgUnitObjectPositionSetting::readSettings ( )

protected

Read from db.

Definition at line 120 of file class.ilOrgUnitObjectPositionSetting.php.

References $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by __construct().

    {
        if (!$this->obj_id) {
            return;
        }
        $query = 'select * from orgu_obj_pos_settings ' . 'where obj_id = '
                 . $this->db->quote($this->obj_id, 'integer');
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->active = (bool) $row->active;
        }

        return;
    }

Here is the caller graph for this function:

setActive()

ilOrgUnitObjectPositionSetting::setActive

(

$a_status

)

Set active for object.

Parameters

bool

$a_status

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

    {
        $this->active = $a_status;
    }

update()

ilOrgUnitObjectPositionSetting::update

(

)

Update object entry.

Definition at line 86 of file class.ilOrgUnitObjectPositionSetting.php.

References isActive().

    {
        $this->db->replace('orgu_obj_pos_settings', [
                'obj_id' => [ 'integer', $this->obj_id ],
            ], [
                'active' => [ 'integer', (int) $this->isActive() ],
            ]);
    }

Here is the call graph for this function:

Field Documentation

$active

ilOrgUnitObjectPositionSetting::$active

private

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

Referenced by isActive().

$db

ilOrgUnitObjectPositionSetting::$db

protected

Definition at line 17 of file class.ilOrgUnitObjectPositionSetting.php.

Referenced by lookupActive().

$obj_id

ilOrgUnitObjectPositionSetting::$obj_id

private

Definition at line 21 of file class.ilOrgUnitObjectPositionSetting.php.

---

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

• Modules/OrgUnit/classes/Settings/class.ilOrgUnitObjectPositionSetting.php