ilOrgUnitPosition Class Reference

Class ilOrgUnitPosition. More...

Inheritance diagram for ilOrgUnitPosition:

Collaboration diagram for ilOrgUnitPosition:

Public Member Functions
	delete ()
	afterObjectLoad ()
	update ()
	create ()
	getAuthoritiesAsArray ()
	__toString ()
	getDependentAuthorities ()
	deleteWithAllDependencies ()
	This deletes the Position, it's Authorities, dependent Authorities and all User-Assignements! More...
	getId ()
	setId ($id)
	getTitle ()
	setTitle ($title)
	getDescription ()
	setDescription ($description)
	isCorePosition ()
	setCorePosition ($core_position)
	getAuthorities ()
	setAuthorities ($authorities)
	getCoreIdentifier ()
	setCoreIdentifier ($core_identifier)
Public Member Functions inherited from ActiveRecord
	getArConnector ()
	getArFieldList ()
	getConnectorContainerName ()
	setConnectorContainerName ($connector_container_name)
	getPrimaryFieldValue ()
	setPrimaryFieldValue ($value)
	__construct ($primary_key=0, arConnector $connector=null)
	storeObjectToCache ()
	__getConvertedDateFieldsAsArray ($format=null)
	__asCsv ($separator=';', $header=false)
	__asArray ()
	__asStdClass ()
	__asSerializedObject ()
	buildFromArray (array $array)
	fixDateField ($field_name, $value)
	sleep ($field_name)
	wakeUp ($field_name, $field_value)
	getArrayForDb ()
	getArrayForConnector ()
	installConnector ()
	store ()
	save ()
	create ()
	copy ($new_id=0)
	afterObjectLoad ()
	read ()
	update ()
	delete ()
	__call ($name, $arguments)

Static Public Member Functions
static	returnDbTableName ()
static	get ()
	Override for correct on return value. More...
static	getCorePosition ($core_identifier)
static	getCorePositionId ($core_identifier)
static	getActive ()
static	getActiveForPosition ($orgu_ref_id)
Static Public Member Functions inherited from ActiveRecord
static	returnDbTableName ()
static	installDB ()
static	renameDBField ($old_name, $new_name)
static	tableExists ()
static	fieldExists ($field_name)
static	removeDBField ($field_name)
static	updateDB ()
static	resetDB ()
static	truncateDB ()
static	flushDB ()
static	preloadObjects ()
static	additionalParams (array $additional_params)
static	findOrFail ($primary_key, array $add_constructor_args=array())
	Tries to find the object and throws an Exception if object is not found, instead of returning null. More...
static	findOrGetInstance ($primary_key, array $add_constructor_args=array())
static	where ($where, $operator=null)
static	innerjoinAR (ActiveRecord $ar, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)
static	innerjoin ($tablename, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)
static	leftjoin ($tablename, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false)
static	orderBy ($orderBy, $orderDirection='ASC')
static	dateFormat ($date_format='d.m.Y - H:i:s')
static	limit ($start, $end)
static	affectedRows ()
static	count ()
static	get ()
static	debug ()
static	first ()
static	getCollection ()
static	last ()
static	getFirstFromLastQuery ()
static	connector (arConnector $connector)
static	raw ($set_raw=true)
static	getArray ($key=null, $values=null)
static	_toCamelCase ($str, $capitalise_first_char=false)

Data Fields
const	CORE_POSITION_EMPLOYEE = 1
const	CORE_POSITION_SUPERIOR = 2
Data Fields inherited from ActiveRecord
const	ACTIVE_RECORD_VERSION = '2.0.7'

Protected Attributes
	$id = 0
	$title = ""
	$description = ""
	$core_position = false
	$core_identifier = 0
	$authorities = array()
Protected Attributes inherited from ActiveRecord
	$ar_safe_read = true
	$connector_container_name = ''

Private Member Functions
	storeAuthorities ()

Additional Inherited Members
Protected Member Functions inherited from ActiveRecord
	serializeToCSV ($field)
	This method is called for every field of your instance if you use __asCsv. More...
	installDatabase ()
Static Protected Member Functions inherited from ActiveRecord
static	getCalledClass ()
static	fromCamelCase ($str)

Detailed Description

Class ilOrgUnitPosition.

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 8 of file class.ilOrgUnitPosition.php.

Member Function Documentation

__toString()

ilOrgUnitPosition::__toString

(

)

Returns

string

Definition at line 213 of file class.ilOrgUnitPosition.php.

References getTitle().

    {
        return $this->getTitle();
    }

Here is the call graph for this function:

afterObjectLoad()

ilOrgUnitPosition::afterObjectLoad

(

)

Definition at line 175 of file class.ilOrgUnitPosition.php.

References getId(), ilOrgUnitAuthority\POSITION_ID, and ActiveRecord\where().

    {
        $this->authorities = ilOrgUnitAuthority::where(array(ilOrgUnitAuthority::POSITION_ID => $this->getId()))
            ->get();
    }

Here is the call graph for this function:

create()

ilOrgUnitPosition::create

(

)

Definition at line 189 of file class.ilOrgUnitPosition.php.

References storeAuthorities().

    {
        parent::create();
        $this->storeAuthorities();
    }

Here is the call graph for this function:

delete()

ilOrgUnitPosition::delete

(

)

Exceptions

Definition at line 61 of file class.ilOrgUnitPosition.php.

References isCorePosition().

    {
        if ($this->isCorePosition()) {
            throw new ilException('Cannot delete Core-Position');
        }
        parent::delete();
    }

Here is the call graph for this function:

deleteWithAllDependencies()

ilOrgUnitPosition::deleteWithAllDependencies

(

)

This deletes the Position, it's Authorities, dependent Authorities and all User-Assignements!

Definition at line 236 of file class.ilOrgUnitPosition.php.

References getDependentAuthorities(), and ilOrgUnitUserAssignmentQueries\getInstance().

    {
        foreach ($this->getDependentAuthorities() as $authority) {
            $authority->delete();
        }

        $ilOrgUnitUserAssignmentQueries = ilOrgUnitUserAssignmentQueries::getInstance();
        foreach ($ilOrgUnitUserAssignmentQueries->getUserAssignmentsOfPosition($this->getId()) as $assignment) {
            $assignment->delete();
        }
        parent::delete();
    }

Here is the call graph for this function:

get()

static ilOrgUnitPosition::get ( )

static

Override for correct on return value.

Returns

[]

PhpIncompatibleReturnTypeInspection

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

References ILIAS\GlobalScreen\get().

Referenced by ilOrgUnitPermissionTableGUI\collectData().

    {
        return parent::get();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getActive()

static ilOrgUnitPosition::getActive ( )

static

Returns

[] array of Positions (all core-positions and all positions which have already UserAssignments)

Definition at line 74 of file class.ilOrgUnitPosition.php.

References $data, $GLOBALS, and arObjectCache\flush().

    {
        arObjectCache::flush(self::class);
        $q = "SELECT DISTINCT il_orgu_positions.id, il_orgu_positions.*
                                FROM il_orgu_positions 
                                 LEFT JOIN il_orgu_ua ON il_orgu_positions.id = il_orgu_ua.position_id  
                                WHERE il_orgu_ua.user_id IS NOT NULL 
                                        OR il_orgu_positions.core_position = 1";
        $database = $GLOBALS['DIC']->database();
        $st = $database->query($q);

        $positions = array();

        while ($data = $database->fetchAssoc($st)) {
            $position = new self();
            $position->buildFromArray($data);
            $positions[] = $position;
        }

        return $positions;
    }

Here is the call graph for this function:

getActiveForPosition()

static ilOrgUnitPosition::getActiveForPosition (   $orgu_ref_id )

static

Parameters

int

$orgu_ref_id

Returns

[] array of Positions (all core-positions and all positions which have already UserAssignments at this place)

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

References $data, $GLOBALS, and arObjectCache\flush().

Referenced by ilOrgUnitUserAssignmentGUI\assignmentsRecursive(), and ilOrgUnitUserAssignmentGUI\index().

    {
        arObjectCache::flush(self::class);
        $q = "SELECT DISTINCT il_orgu_positions.id, il_orgu_positions.*
                                FROM il_orgu_positions 
                                LEFT JOIN il_orgu_ua ON il_orgu_positions.id = il_orgu_ua.position_id AND il_orgu_ua.orgu_id = %s 
                                WHERE il_orgu_ua.user_id IS NOT NULL 
                                        OR core_position = 1";
        $database = $GLOBALS['DIC']->database();
        $st = $database->queryF($q, array('integer'), array($orgu_ref_id));

        $positions = array();

        while ($data = $database->fetchAssoc($st)) {
            $position = new self();
            $position->buildFromArray($data);
            $positions[] = $position;
        }

        return $positions;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAuthorities()

ilOrgUnitPosition::getAuthorities

(

)

Returns

[]

Definition at line 325 of file class.ilOrgUnitPosition.php.

References $authorities.

Referenced by storeAuthorities().

    {
        return $this->authorities;
    }

Here is the caller graph for this function:

getAuthoritiesAsArray()

ilOrgUnitPosition::getAuthoritiesAsArray

(

)

Returns

array

Definition at line 199 of file class.ilOrgUnitPosition.php.

    {
        $return = array();
        foreach ($this->authorities as $authority) {
            $return[] = $authority->__toArray();
        }

        return $return;
    }

getCoreIdentifier()

ilOrgUnitPosition::getCoreIdentifier

(

)

Returns

int

Definition at line 343 of file class.ilOrgUnitPosition.php.

References $core_identifier.

    {
        return $this->core_identifier;
    }

getCorePosition()

static ilOrgUnitPosition::getCorePosition (   $core_identifier )

static

Parameters

$core_identifier

Returns

PhpIncompatibleReturnTypeInspection

Definition at line 40 of file class.ilOrgUnitPosition.php.

References $core_identifier, and ActiveRecord\where().

Referenced by ilOrgUnitPositionGUI\assign(), ilObjOrgUnitTree\getEmployees(), and ilObjOrgUnitTree\getSuperiors().

    {
        return ilOrgUnitPosition::where(['core_identifier' => $core_identifier])->first();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCorePositionId()

static ilOrgUnitPosition::getCorePositionId (   $core_identifier )

static

Parameters

$core_identifier

Returns

int

Definition at line 52 of file class.ilOrgUnitPosition.php.

References $core_identifier.

Referenced by ilObjOrgUnit\assignUsersToEmployeeRole(), ilObjOrgUnit\assignUsersToSuperiorRole(), ilObjOrgUnit\deassignUserFromEmployeeRole(), ilObjOrgUnit\deassignUserFromSuperiorRole(), ILIAS\OrgUnit\Webservices\SOAP\EmployeePositionId\run(), and ILIAS\OrgUnit\Webservices\SOAP\SuperiorPositionId\run().

    {
        return self::getCorePosition($core_identifier)->getId();
    }

Here is the caller graph for this function:

getDependentAuthorities()

ilOrgUnitPosition::getDependentAuthorities

(

)

Returns

array it's own authorities and also all which use this position

Definition at line 222 of file class.ilOrgUnitPosition.php.

References $authorities, ilOrgUnitAuthority\FIELD_OVER, getId(), and ActiveRecord\where().

Referenced by deleteWithAllDependencies().

    {
        $dependent = ilOrgUnitAuthority::where(array(ilOrgUnitAuthority::FIELD_OVER => $this->getId()))
            ->get();

        $arr = $dependent + $this->authorities;

        return (array) $arr;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDescription()

ilOrgUnitPosition::getDescription

(

)

Returns

string

Definition at line 289 of file class.ilOrgUnitPosition.php.

References $description.

    {
        return $this->description;
    }

getId()

ilOrgUnitPosition::getId

(

)

Returns

int

Definition at line 253 of file class.ilOrgUnitPosition.php.

References $id.

Referenced by afterObjectLoad(), ilObjOrgUnitTree\getAssignements(), getDependentAuthorities(), and storeAuthorities().

    {
        return $this->id;
    }

Here is the caller graph for this function:

getTitle()

ilOrgUnitPosition::getTitle

(

)

Returns

string

Definition at line 271 of file class.ilOrgUnitPosition.php.

References $title.

Referenced by __toString().

    {
        return $this->title;
    }

Here is the caller graph for this function:

isCorePosition()

ilOrgUnitPosition::isCorePosition

(

)

Returns

bool

Definition at line 307 of file class.ilOrgUnitPosition.php.

References $core_position.

Referenced by delete().

    {
        return $this->core_position;
    }

Here is the caller graph for this function:

returnDbTableName()

static ilOrgUnitPosition::returnDbTableName ( )

static

Returns

string

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

    {
        return "il_orgu_positions";
    }

setAuthorities()

ilOrgUnitPosition::setAuthorities

(

$authorities

)

Parameters

Definition at line 334 of file class.ilOrgUnitPosition.php.

References $authorities.

    {
        $this->authorities = $authorities;
    }

setCoreIdentifier()

ilOrgUnitPosition::setCoreIdentifier

(

$core_identifier

)

Parameters

int

$core_identifier

Definition at line 352 of file class.ilOrgUnitPosition.php.

References $core_identifier.

    {
        $this->core_identifier = $core_identifier;
    }

setCorePosition()

ilOrgUnitPosition::setCorePosition

(

$core_position

)

Parameters

bool

$core_position

Definition at line 316 of file class.ilOrgUnitPosition.php.

References $core_position.

    {
        $this->core_position = $core_position;
    }

setDescription()

ilOrgUnitPosition::setDescription

(

$description

)

Parameters

string

$description

Definition at line 298 of file class.ilOrgUnitPosition.php.

References $description.

    {
        $this->description = $description;
    }

setId()

ilOrgUnitPosition::setId

(

$id

)

Parameters

int

$id

Definition at line 262 of file class.ilOrgUnitPosition.php.

References $id.

    {
        $this->id = $id;
    }

setTitle()

ilOrgUnitPosition::setTitle

(

$title

)

Parameters

string

$title

Definition at line 280 of file class.ilOrgUnitPosition.php.

References $title.

    {
        $this->title = $title;
    }

storeAuthorities()

ilOrgUnitPosition::storeAuthorities ( )

private

Definition at line 358 of file class.ilOrgUnitPosition.php.

References ActiveRecord\count(), getAuthorities(), getId(), and ActiveRecord\where().

Referenced by create(), and update().

    {
        $ids = [];
        foreach ($this->getAuthorities() as $authority) {
            $authority->setPositionId($this->getId());
            if ($authority->getId()) {
                $authority->update();
            } else {
                $authority->create();
            }
            $ids[] = $authority->getId();
        }
        if (count($ids) > 0) {
            foreach (
                ilOrgUnitAuthority::where(array(
                    'id' => $ids,
                    'position_id' => $this->getId(),
                ), array('id' => 'NOT IN', 'position_id' => '='))->get() as $authority
            ) {
                $authority->delete();
            }
        }

        if (count($ids) === 0) {
            foreach (
                ilOrgUnitAuthority::where(array(
                    'position_id' => $this->getId(),
                ))->get() as $authority
            ) {
                $authority->delete();
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

update()

ilOrgUnitPosition::update

(

)

Definition at line 182 of file class.ilOrgUnitPosition.php.

References storeAuthorities().

    {
        parent::update();
        $this->storeAuthorities();
    }

Here is the call graph for this function:

Field Documentation

$authorities

ilOrgUnitPosition::$authorities = array()

protected

Definition at line 172 of file class.ilOrgUnitPosition.php.

Referenced by getAuthorities(), getDependentAuthorities(), and setAuthorities().

$core_identifier

ilOrgUnitPosition::$core_identifier = 0

protected

Definition at line 168 of file class.ilOrgUnitPosition.php.

Referenced by getCoreIdentifier(), getCorePosition(), getCorePositionId(), and setCoreIdentifier().

$core_position

ilOrgUnitPosition::$core_position = false

protected

Definition at line 160 of file class.ilOrgUnitPosition.php.

Referenced by isCorePosition(), and setCorePosition().

$description

ilOrgUnitPosition::$description = ""

protected

Definition at line 152 of file class.ilOrgUnitPosition.php.

Referenced by getDescription(), and setDescription().

$id

ilOrgUnitPosition::$id = 0

protected

Definition at line 136 of file class.ilOrgUnitPosition.php.

Referenced by getId(), and setId().

$title

ilOrgUnitPosition::$title = ""

protected

Definition at line 144 of file class.ilOrgUnitPosition.php.

Referenced by getTitle(), and setTitle().

CORE_POSITION_EMPLOYEE

const ilOrgUnitPosition::CORE_POSITION_EMPLOYEE = 1

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

Referenced by ilOrgUnitUserAssignmentGUI\addStaff(), ilOrgUnitUserAssignmentGUI\addStaffFromSearch(), ilOrgUnitPositionGUI\assign(), ilObjOrgUnit\assignUsersToEmployeeRole(), ilObjOrgUnit\deassignUserFromEmployeeRole(), ilObjOrgUnitTree\getEmployees(), ilObjOrgUnitTree\getEmployeesUnderUser(), OrgUnit\Positions\UserAssignment\ilOrgUnitUserAssignmentRepository\getEmplSuperiorList(), OrgUnit\User\ilOrgUnitUserRepository\getSuperiorsSql(), ILIAS\OrgUnit\Webservices\SOAP\EmployeePositionId\run(), and ilOrgUnitSimpleUserImport\simpleUserImportElement().

CORE_POSITION_SUPERIOR

const ilOrgUnitPosition::CORE_POSITION_SUPERIOR = 2

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

Referenced by ilObjOrgUnit\assignUsersToSuperiorRole(), ilObjOrgUnit\deassignUserFromSuperiorRole(), ilObjOrgUnitTree\getEmployeesUnderUser(), OrgUnit\Positions\UserAssignment\ilOrgUnitUserAssignmentRepository\getEmplSuperiorList(), ilObjOrgUnitTree\getSuperiors(), OrgUnit\User\ilOrgUnitUserRepository\getSuperiorsSql(), ILIAS\OrgUnit\Webservices\SOAP\SuperiorPositionId\run(), and ilOrgUnitSimpleUserImport\simpleUserImportElement().

---

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

• Modules/OrgUnit/classes/Positions/class.ilOrgUnitPosition.php