Class ilOrguAuthority. More...

Collaboration diagram for ilOrgUnitAuthority:

Public Member Functions
	__construct ($id=0)

	__toString ()

	getId ()

	getOver ()

	withOver (int $over)

	getScope ()

	withScope (int $scope)

	getPositionId ()

	withPositionId (int $position_id)

Static Public Member Functions
static	getScopes ()

Data Fields
const	FIELD_OVER = 'over'

const	OVER_EVERYONE = -1

const	POSITION_ID = "position_id"

const	SCOPE_SAME_ORGU = 1

const	SCOPE_SUBSEQUENT_ORGUS = 2

const	SCOPES

Protected Attributes
int	$id

int	$over = self::OVER_EVERYONE

int	$scope = self::SCOPE_SAME_ORGU

int	$position_id = 0

Detailed Description

Class ilOrguAuthority.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilOrgUnitAuthority::__construct ( $id = 0 )

Definition at line 42 of file class.ilOrgUnitAuthority.php.

    {
        $this->id = $id;
    }

References $id.

Member Function Documentation

◆ __toString()

ilOrgUnitAuthority::__toString ( )

Definition at line 55 of file class.ilOrgUnitAuthority.php.

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

References $id.

◆ getId()

ilOrgUnitAuthority::getId ( )

Definition at line 60 of file class.ilOrgUnitAuthority.php.

                           : int
    {
        return $this->id;
    }

References $id.

Referenced by ilOrgUnitAuthorityDBRepository\store(), and ilOrgUnitAuthorityDBRepository\update().

Here is the caller graph for this function:

◆ getOver()

ilOrgUnitAuthority::getOver ( )

Definition at line 65 of file class.ilOrgUnitAuthority.php.

                             : int
    {
        return $this->over;
    }

References $over.

Referenced by ilOrgUnitAuthorityDBRepository\insert(), and ilOrgUnitAuthorityDBRepository\update().

Here is the caller graph for this function:

◆ getPositionId()

ilOrgUnitAuthority::getPositionId ( )

Definition at line 92 of file class.ilOrgUnitAuthority.php.

                                   : int
    {
        return $this->position_id;
    }

References $position_id.

Referenced by ilOrgUnitAuthorityDBRepository\insert(), and ilOrgUnitAuthorityDBRepository\update().

Here is the caller graph for this function:

◆ getScope()

ilOrgUnitAuthority::getScope ( )

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

                              : int
    {
        return $this->scope;
    }

References $scope.

Referenced by ilOrgUnitAuthorityDBRepository\insert(), and ilOrgUnitAuthorityDBRepository\update().

Here is the caller graph for this function:

◆ getScopes()

static ilOrgUnitAuthority::getScopes ( )

static

Returns: int[]

Definition at line 50 of file class.ilOrgUnitAuthority.php.

                                      : array
    {
        return self::SCOPES;
    }

References SCOPES.

Referenced by ilOrgUnitPositionFormGUI\initFormElements().

Here is the caller graph for this function:

◆ withOver()

ilOrgUnitAuthority::withOver ( int $over )

Definition at line 70 of file class.ilOrgUnitAuthority.php.

                                       : self
    {
        $clone = clone $this;
        $clone->over = $over;
        return $clone;
    }

References $over.

◆ withPositionId()

ilOrgUnitAuthority::withPositionId ( int $position_id )

Definition at line 97 of file class.ilOrgUnitAuthority.php.

                                                    : self
    {
        $clone = clone $this;
        $clone->position_id = $position_id;
        return $clone;
    }

References $position_id.

◆ withScope()

ilOrgUnitAuthority::withScope ( int $scope )

Definition at line 82 of file class.ilOrgUnitAuthority.php.

                                         : self
    {
        if (!in_array($scope, self::SCOPES)) {
            throw new ilException('Selected Scope in ' . self::class . ' not allowed');
        }
        $clone = clone $this;
        $clone->scope = $scope;
        return $clone;
    }

References $scope.

Field Documentation

◆ $id

int ilOrgUnitAuthority::$id

protected

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

Referenced by __construct(), __toString(), and getId().

◆ $over

int ilOrgUnitAuthority::$over = self::OVER_EVERYONE

protected

Definition at line 38 of file class.ilOrgUnitAuthority.php.

Referenced by getOver(), and withOver().

◆ $position_id

int ilOrgUnitAuthority::$position_id = 0

protected

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

Referenced by getPositionId(), and withPositionId().

◆ $scope

int ilOrgUnitAuthority::$scope = self::SCOPE_SAME_ORGU

protected

Definition at line 39 of file class.ilOrgUnitAuthority.php.

Referenced by getScope(), and withScope().

◆ FIELD_OVER

const ilOrgUnitAuthority::FIELD_OVER = 'over'

Definition at line 27 of file class.ilOrgUnitAuthority.php.

Referenced by ilOrgUnitAuthorityDBRepository\get().

◆ OVER_EVERYONE

const ilOrgUnitAuthority::OVER_EVERYONE = -1

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

Referenced by ilOrgUnitPositionDBRepository\getAuthorityDescription(), ilOrgUnitPositionGUI\getAuthorityDescription(), ilOrgUnitPositionFormGUI\initFormElements(), and ilModulesOrgUnitAuthorityTest\testOrgUnitAuthorityConstruction().

◆ POSITION_ID

const ilOrgUnitAuthority::POSITION_ID = "position_id"

Definition at line 29 of file class.ilOrgUnitAuthority.php.

Referenced by ilOrgUnitAuthorityDBRepository\get(), ilOrgUnitPositionDBRepository\get(), ilOrgUnitPositionDBRepository\getAllPositions(), and ilOrgUnitPositionDBRepository\getPositionsForOrgUnit().

◆ SCOPE_SAME_ORGU

const ilOrgUnitAuthority::SCOPE_SAME_ORGU = 1

Definition at line 30 of file class.ilOrgUnitAuthority.php.

Referenced by ilOrgUnitPositionDBRepository\getAuthorityDescription(), ilOrgUnitPositionGUI\getAuthorityDescription(), and ilModulesOrgUnitAuthorityTest\testOrgUnitAuthorityConstruction().

◆ SCOPE_SUBSEQUENT_ORGUS

const ilOrgUnitAuthority::SCOPE_SUBSEQUENT_ORGUS = 2

Definition at line 31 of file class.ilOrgUnitAuthority.php.

Referenced by ilOrgUnitPositionDBRepository\getAuthorityDescription(), ilOrgUnitPositionGUI\getAuthorityDescription(), and ilModulesOrgUnitAuthorityTest\testOrgUnitAuthorityModification().

◆ SCOPES

const ilOrgUnitAuthority::SCOPES

Initial value:

= [
        self::SCOPE_SAME_ORGU,
        self::SCOPE_SUBSEQUENT_ORGUS
    ]

Definition at line 32 of file class.ilOrgUnitAuthority.php.

Referenced by getScopes().

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

components/ILIAS/OrgUnit/classes/Positions/Authorities/class.ilOrgUnitAuthority.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __toString()

◆ getId()

◆ getOver()

◆ getPositionId()

◆ getScope()

◆ getScopes()

◆ withOver()

◆ withPositionId()

◆ withScope()

Field Documentation

◆ $id

◆ $over

◆ $position_id

◆ $scope

◆ FIELD_OVER

◆ OVER_EVERYONE

◆ POSITION_ID

◆ SCOPE_SAME_ORGU

◆ SCOPE_SUBSEQUENT_ORGUS

◆ SCOPES