ILIAS\User\Settings\StartingPoint\StartingPoint Class Reference

Collaboration diagram for ILIAS\User\Settings\StartingPoint\StartingPoint:

Public Member Functions
	__construct (private ?int $id, private ?int $starting_point_type=null, private int $starting_object=0, private ?int $starting_position=null, private ?int $rule_type=null, private ?string $rule_options=null, private int $calendar_view=0, private int $calendar_period=0)
	getId ()
	setStartingPointType (int $starting_point_type)
	getStartingPointType ()
	setStartingObject (int $a_starting_object)
	getStartingObject ()
	setPosition (int $a_starting_position)
	getPosition ()
	getRuleType ()
	isRoleBasedStartingPoint ()
	setRuleTypeRoleBased ()
	getCalendarView ()
	Gets calendar view. More...
	setCalendarView (int $calendar_view)
	Sets calendar view. More...
	getCalendarPeriod ()
	setCalendarPeriod (int $calendar_period)
	getRuleOptions ()
	setRuleOptions (string $a_rule_options)

Private Attributes
const	ROLE_BASED = 2

Detailed Description

Definition at line 23 of file StartingPoint.php.

Constructor & Destructor Documentation

__construct()

ILIAS\User\Settings\StartingPoint\StartingPoint::__construct	(	private ?int	$id,
		private ?int	$starting_point_type = null,
		private int	$starting_object = 0,
		private ?int	$starting_position = null,
		private ?int	$rule_type = null,
		private ?string	$rule_options = null,
		private int	$calendar_view = 0,
		private int	$calendar_period = 0
	)

Definition at line 27 of file StartingPoint.php.

      {
    }

Member Function Documentation

getCalendarPeriod()

ILIAS\User\Settings\StartingPoint\StartingPoint::getCalendarPeriod

(

)

Definition at line 105 of file StartingPoint.php.

                                       : int
    {
        return $this->calendar_period;
    }

Referenced by ILIAS\User\Settings\StartingPoint\SettingsGUI\getCalenderSubInputs(), ILIAS\User\Settings\StartingPoint\Repository\save(), and ILIAS\User\Settings\StartingPoint\Repository\update().

Here is the caller graph for this function:

getCalendarView()

ILIAS\User\Settings\StartingPoint\StartingPoint::getCalendarView

(

)

Gets calendar view.

Definition at line 92 of file StartingPoint.php.

                                     : int
    {
        return $this->calendar_view;
    }

Referenced by ILIAS\User\Settings\StartingPoint\SettingsGUI\getCalenderSubInputs(), ILIAS\User\Settings\StartingPoint\Repository\save(), and ILIAS\User\Settings\StartingPoint\Repository\update().

Here is the caller graph for this function:

getId()

ILIAS\User\Settings\StartingPoint\StartingPoint::getId

(

)

Definition at line 39 of file StartingPoint.php.

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

References $id.

Referenced by ILIAS\User\Settings\StartingPoint\Repository\save(), and ILIAS\User\Settings\StartingPoint\Repository\update().

Here is the caller graph for this function:

getPosition()

ILIAS\User\Settings\StartingPoint\StartingPoint::getPosition

(

)

Definition at line 69 of file StartingPoint.php.

                                 : int
    {
        return $this->starting_position;
    }

Referenced by ILIAS\User\Settings\StartingPoint\Repository\update().

Here is the caller graph for this function:

getRuleOptions()

ILIAS\User\Settings\StartingPoint\StartingPoint::getRuleOptions

(

)

Definition at line 115 of file StartingPoint.php.

                                    : ?string
    {
        return $this->rule_options;
    }

Referenced by ILIAS\User\Settings\StartingPoint\Repository\save(), and ILIAS\User\Settings\StartingPoint\Repository\update().

Here is the caller graph for this function:

getRuleType()

ILIAS\User\Settings\StartingPoint\StartingPoint::getRuleType

(

)

Definition at line 74 of file StartingPoint.php.

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

Referenced by ILIAS\User\Settings\StartingPoint\Repository\save(), and ILIAS\User\Settings\StartingPoint\Repository\update().

Here is the caller graph for this function:

getStartingObject()

ILIAS\User\Settings\StartingPoint\StartingPoint::getStartingObject

(

)

Definition at line 59 of file StartingPoint.php.

                                       : int
    {
        return $this->starting_object;
    }

Referenced by ILIAS\User\Settings\StartingPoint\SettingsGUI\getRepositoryObjectInput(), ILIAS\User\Settings\StartingPoint\Repository\save(), and ILIAS\User\Settings\StartingPoint\Repository\update().

Here is the caller graph for this function:

getStartingPointType()

ILIAS\User\Settings\StartingPoint\StartingPoint::getStartingPointType

(

)

Definition at line 49 of file StartingPoint.php.

                                          : int
    {
        return $this->starting_point_type;
    }

Referenced by ILIAS\User\Settings\StartingPoint\SettingsGUI\getCurrentTypeForStartingPointForm(), ILIAS\User\Settings\StartingPoint\Repository\save(), and ILIAS\User\Settings\StartingPoint\Repository\update().

Here is the caller graph for this function:

isRoleBasedStartingPoint()

ILIAS\User\Settings\StartingPoint\StartingPoint::isRoleBasedStartingPoint

(

)

Definition at line 79 of file StartingPoint.php.

                                              : bool
    {
        return $this->rule_type === self::ROLE_BASED;
    }

References ILIAS\User\Settings\StartingPoint\StartingPoint\ROLE_BASED.

setCalendarPeriod()

ILIAS\User\Settings\StartingPoint\StartingPoint::setCalendarPeriod

(

int

$calendar_period

)

Definition at line 110 of file StartingPoint.php.

                                                           : void
    {
        $this->calendar_period = $calendar_period;
    }

setCalendarView()

ILIAS\User\Settings\StartingPoint\StartingPoint::setCalendarView

(

int

$calendar_view

)

Sets calendar view.

Definition at line 100 of file StartingPoint.php.

                                                       : void
    {
        $this->calendar_view = $calendar_view;
    }

setPosition()

ILIAS\User\Settings\StartingPoint\StartingPoint::setPosition

(

int

$a_starting_position

)

Definition at line 64 of file StartingPoint.php.

                                                         : void
    {
        $this->starting_position = $a_starting_position;
    }

setRuleOptions()

ILIAS\User\Settings\StartingPoint\StartingPoint::setRuleOptions

(

string

$a_rule_options

)

Definition at line 120 of file StartingPoint.php.

                                                          : void
    {
        $this->rule_options = $a_rule_options;
    }

setRuleTypeRoleBased()

ILIAS\User\Settings\StartingPoint\StartingPoint::setRuleTypeRoleBased

(

)

Definition at line 84 of file StartingPoint.php.

                                          : void
    {
        $this->rule_type = self::ROLE_BASED;
    }

References ILIAS\User\Settings\StartingPoint\StartingPoint\ROLE_BASED.

setStartingObject()

ILIAS\User\Settings\StartingPoint\StartingPoint::setStartingObject

(

int

$a_starting_object

)

Definition at line 54 of file StartingPoint.php.

                                                             : void
    {
        $this->starting_object = $a_starting_object;
    }

setStartingPointType()

ILIAS\User\Settings\StartingPoint\StartingPoint::setStartingPointType

(

int

$starting_point_type

)

Definition at line 44 of file StartingPoint.php.

                                                                  : void
    {
        $this->starting_point_type = $starting_point_type;
    }

Field Documentation

ROLE_BASED

const ILIAS\User\Settings\StartingPoint\StartingPoint::ROLE_BASED = 2

private

Definition at line 25 of file StartingPoint.php.

Referenced by ILIAS\User\Settings\StartingPoint\StartingPoint\isRoleBasedStartingPoint(), and ILIAS\User\Settings\StartingPoint\StartingPoint\setRuleTypeRoleBased().

---

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

• components/ILIAS/User/src/Settings/StartingPoint/StartingPoint.php