This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. 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 (?int $id)

	getTitle ()

	setTitle (string $title)

	getDescription ()

	setDescription (string $description)

	isCorePosition ()

	setCorePosition (bool $core_position)

	getAuthorities ()

	setAuthorities (array $authorities)

	getCoreIdentifier ()

	setCoreIdentifier (int $core_identifier)

Public Member Functions inherited from ActiveRecord
	getArConnector ()

	getArFieldList ()

	getConnectorContainerName ()
	Return the Name of your Connector Table More...

	setConnectorContainerName (string $connector_container_name)

	getPrimaryFieldValue ()

	setPrimaryFieldValue ($value)

	__construct ($primary_key=0)

	storeObjectToCache ()

	asStdClass ()

	buildFromArray (array $array)

	fixDateField ($field_name, $value)

	sleep ($field_name)

	wakeUp ($field_name, $field_value)

	getArrayForConnector ()

	installConnector ()

	store ()

	save ()

	create ()

	copy (int $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 (int $core_identifier)

static	getCorePositionId (int $core_identifier)

static	getActive ()

static	getActiveForPosition (int $orgu_ref_id)

Static Public Member Functions inherited from ActiveRecord
static	returnDbTableName ()

static	installDB ()

static	renameDBField (string $old_name, string $new_name)

static	tableExists ()

static	fieldExists (string $field_name)

static	removeDBField (string $field_name)

static	updateDB ()

static	resetDB ()

static	truncateDB ()

static	flushDB ()
	never use in ILIAS Core, Plugins only More...

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, array $fields=array(' *'), string $operator='=', $both_external=false)

static	innerjoin ( $tablename, $on_this, $on_external, array $fields=array(' *'), string $operator='=', bool $both_external=false)

static	leftjoin ( $tablename, $on_this, $on_external, array $fields=array(' *'), string $operator='=', bool $both_external=false)

static	orderBy ($orderBy, string $orderDirection='ASC')

static	dateFormat (string $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 (bool $set_raw=true)

static	getArray (?string $key=null, $values=null)

static	_toCamelCase (string $str, bool $capitalise_first_char=false)

Data Fields
const	CORE_POSITION_EMPLOYEE = 1

const	CORE_POSITION_SUPERIOR = 2

Protected Attributes
int	$id = 0

string	$title = ""

string	$description = ""

bool	$core_position = false

int	$core_identifier = 0

array	$authorities = array()

Protected Attributes inherited from ActiveRecord
bool	$ar_safe_read = true

string	$connector_container_name = ''

bool	$is_new = true

Private Member Functions
	storeAuthorities ()

Additional Inherited Members
Protected Member Functions inherited from ActiveRecord
	installDatabase ()

Static Protected Member Functions inherited from ActiveRecord
static	getCalledClass ()
	Returns an instance of the instatiated calling active record (needs to be done in static methods) : This should be cached somehow More...

static	fromCamelCase (string $str)

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilOrgUnitPosition

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

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

Member Function Documentation

◆ __toString()

ilOrgUnitPosition::__toString ( )

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

References getTitle().

                                 : string
     {
         return $this->getTitle();
     }

Here is the call graph for this function:

◆ afterObjectLoad()

ilOrgUnitPosition::afterObjectLoad ( )

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

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

                                      : void
     {
         $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 174 of file class.ilOrgUnitPosition.php.

References storeAuthorities().

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

Here is the call graph for this function:

◆ delete()

ilOrgUnitPosition::delete ( )

Exceptions

ilException

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

References isCorePosition().

                             : void
     {
         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 209 of file class.ilOrgUnitPosition.php.

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

                                                : void
     {
         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: ilOrgUnitPosition[]

PhpIncompatibleReturnTypeInspection

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

References ILIAS\Repository\get().

Referenced by ilOrgUnitPermissionTableGUI\collectData().

                                 : array
     {
         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 69 of file class.ilOrgUnitPosition.php.

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

                                       : array
     {
         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 ( int $orgu_ref_id )

static

Parameters

int $orgu_ref_id

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

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

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

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

                                                                  : array
     {
         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: ilOrgUnitAuthority[]

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

References $authorities.

Referenced by storeAuthorities().

                                     : array
     {
         return $this->authorities;
     }

Here is the caller graph for this function:

◆ getAuthoritiesAsArray()

ilOrgUnitPosition::getAuthoritiesAsArray ( )

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

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

◆ getCoreIdentifier()

ilOrgUnitPosition::getCoreIdentifier ( )

Returns: int

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

References $core_identifier.

                                        : int
     {
         return $this->core_identifier;
     }

◆ getCorePosition()

static ilOrgUnitPosition::getCorePosition ( int $core_identifier )

static

PhpIncompatibleReturnTypeInspection

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

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

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

Here is the caller graph for this function:

◆ getCorePositionId()

static ilOrgUnitPosition::getCorePositionId ( int $core_identifier )

static

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

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

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

Here is the caller graph for this function:

◆ getDependentAuthorities()

ilOrgUnitPosition::getDependentAuthorities ( )

Returns: ilOrgUnitAuthority[] it's own authorities and also all which use this position

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

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

Referenced by deleteWithAllDependencies().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDescription()

ilOrgUnitPosition::getDescription ( )

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

References $description.

                                     : string
     {
         return $this->description;
     }

◆ getId()

ilOrgUnitPosition::getId ( )

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

References $id.

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

                            : ?int
     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getTitle()

ilOrgUnitPosition::getTitle ( )

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

References $title.

Referenced by ilOrgUnitUserAssignmentTableGUI\__construct(), ilOrgUnitRecursiveUserAssignmentTableGUI\__construct(), and __toString().

                               : string
     {
         return $this->title;
     }

Here is the caller graph for this function:

◆ isCorePosition()

ilOrgUnitPosition::isCorePosition ( )

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

References $core_position.

Referenced by delete().

                                     : bool
     {
         return $this->core_position;
     }

Here is the caller graph for this function:

◆ returnDbTableName()

static ilOrgUnitPosition::returnDbTableName ( )

static

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

                                               : string
     {
         return "il_orgu_positions";
     }

◆ setAuthorities()

ilOrgUnitPosition::setAuthorities ( array $authorities )

Parameters

ilOrgUnitAuthority[] $authorities

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

References $authorities.

     {
         $this->authorities = $authorities;
     }

◆ setCoreIdentifier()

ilOrgUnitPosition::setCoreIdentifier ( int $core_identifier )

Parameters

int $core_identifier

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

References $core_identifier.

     {
         $this->core_identifier = $core_identifier;
     }

◆ setCorePosition()

ilOrgUnitPosition::setCorePosition ( bool $core_position )

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

References $core_position.

     {
         $this->core_position = $core_position;
     }

◆ setDescription()

ilOrgUnitPosition::setDescription ( string $description )

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

References $description.

     {
         $this->description = $description;
     }

◆ setId()

ilOrgUnitPosition::setId ( ?int $id )

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

References $id.

     {
         $this->id = $id;
     }

◆ setTitle()

ilOrgUnitPosition::setTitle ( string $title )

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

References $title.

     {
         $this->title = $title;
     }

◆ storeAuthorities()

ilOrgUnitPosition::storeAuthorities ( )

private

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

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

Referenced by create(), and update().

                                        : void
     {
         $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 168 of file class.ilOrgUnitPosition.php.

References storeAuthorities().

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

Here is the call graph for this function:

Field Documentation

◆ $authorities

array ilOrgUnitPosition::$authorities = array()

protected

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

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

◆ $core_identifier

int ilOrgUnitPosition::$core_identifier = 0

protected

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

Referenced by getCoreIdentifier(), and setCoreIdentifier().

◆ $core_position

bool ilOrgUnitPosition::$core_position = false

protected

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

Referenced by isCorePosition(), and setCorePosition().

◆ $description

string ilOrgUnitPosition::$description = ""

protected

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

Referenced by getDescription(), and setDescription().

◆ $id

int ilOrgUnitPosition::$id = 0

protected

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

Referenced by getId(), and setId().

◆ $title

string ilOrgUnitPosition::$title = ""

protected

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

Referenced by getTitle(), and setTitle().

◆ CORE_POSITION_EMPLOYEE

const ilOrgUnitPosition::CORE_POSITION_EMPLOYEE = 1

Definition at line 25 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 26 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

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ __toString()

◆ afterObjectLoad()

◆ create()

◆ delete()

◆ deleteWithAllDependencies()

◆ get()

◆ getActive()

◆ getActiveForPosition()

◆ getAuthorities()

◆ getAuthoritiesAsArray()

◆ getCoreIdentifier()

◆ getCorePosition()

◆ getCorePositionId()

◆ getDependentAuthorities()

◆ getDescription()

◆ getId()

◆ getTitle()

◆ isCorePosition()

◆ returnDbTableName()

◆ setAuthorities()

◆ setCoreIdentifier()

◆ setCorePosition()

◆ setDescription()

◆ setId()

◆ setTitle()

◆ storeAuthorities()

◆ update()

Field Documentation

◆ $authorities

◆ $core_identifier

◆ $core_position

◆ $description

◆ $id

◆ $title

◆ CORE_POSITION_EMPLOYEE

◆ CORE_POSITION_SUPERIOR