ilUserStartingPoint Class Reference

Collaboration diagram for ilUserStartingPoint:

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 21 of file class.ilUserStartingPoint.php.

Constructor & Destructor Documentation

__construct()

ilUserStartingPoint::__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 25 of file class.ilUserStartingPoint.php.

      {
    }

Member Function Documentation

getCalendarPeriod()

ilUserStartingPoint::getCalendarPeriod

(

)

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

Referenced by ilUserStartingPointGUI\getCalenderSubInputs(), ilUserStartingPointRepository\save(), ilUserStartingPointRepository\setSystemDefaultStartingPoint(), and ilUserStartingPointRepository\update().

                                       : int
    {
        return $this->calendar_period;
    }

Here is the caller graph for this function:

getCalendarView()

ilUserStartingPoint::getCalendarView

(

)

Gets calendar view.

Definition at line 90 of file class.ilUserStartingPoint.php.

Referenced by ilUserStartingPointGUI\getCalenderSubInputs(), ilUserStartingPointRepository\save(), ilUserStartingPointRepository\setSystemDefaultStartingPoint(), and ilUserStartingPointRepository\update().

                                     : int
    {
        return $this->calendar_view;
    }

Here is the caller graph for this function:

getId()

ilUserStartingPoint::getId

(

)

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

References $id.

Referenced by ilUserStartingPointRepository\save(), and ilUserStartingPointRepository\update().

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

Here is the caller graph for this function:

getPosition()

ilUserStartingPoint::getPosition

(

)

Definition at line 67 of file class.ilUserStartingPoint.php.

Referenced by ilUserStartingPointRepository\update().

                                 : int
    {
        return $this->starting_position;
    }

Here is the caller graph for this function:

getRuleOptions()

ilUserStartingPoint::getRuleOptions

(

)

Definition at line 113 of file class.ilUserStartingPoint.php.

Referenced by ilUserStartingPointRepository\save(), and ilUserStartingPointRepository\update().

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

Here is the caller graph for this function:

getRuleType()

ilUserStartingPoint::getRuleType

(

)

Definition at line 72 of file class.ilUserStartingPoint.php.

Referenced by ilUserStartingPointRepository\save(), and ilUserStartingPointRepository\update().

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

Here is the caller graph for this function:

getStartingObject()

ilUserStartingPoint::getStartingObject

(

)

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

Referenced by ilUserStartingPointGUI\getRepositoryObjectInput(), ilUserStartingPointRepository\save(), ilUserStartingPointRepository\setSystemDefaultStartingPoint(), and ilUserStartingPointRepository\update().

                                       : int
    {
        return $this->starting_object;
    }

Here is the caller graph for this function:

getStartingPointType()

ilUserStartingPoint::getStartingPointType

(

)

Definition at line 47 of file class.ilUserStartingPoint.php.

Referenced by ilUserStartingPointGUI\getCurrentTypeForStartingPointForm(), ilUserStartingPointRepository\save(), ilUserStartingPointRepository\setSystemDefaultStartingPoint(), and ilUserStartingPointRepository\update().

                                          : int
    {
        return $this->starting_point_type;
    }

Here is the caller graph for this function:

isRoleBasedStartingPoint()

ilUserStartingPoint::isRoleBasedStartingPoint

(

)

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

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

setCalendarPeriod()

ilUserStartingPoint::setCalendarPeriod

(

int

$calendar_period

)

Definition at line 108 of file class.ilUserStartingPoint.php.

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

setCalendarView()

ilUserStartingPoint::setCalendarView

(

int

$calendar_view

)

Sets calendar view.

Definition at line 98 of file class.ilUserStartingPoint.php.

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

setPosition()

ilUserStartingPoint::setPosition

(

int

$a_starting_position

)

Definition at line 62 of file class.ilUserStartingPoint.php.

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

setRuleOptions()

ilUserStartingPoint::setRuleOptions

(

string

$a_rule_options

)

Definition at line 118 of file class.ilUserStartingPoint.php.

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

setRuleTypeRoleBased()

ilUserStartingPoint::setRuleTypeRoleBased

(

)

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

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

setStartingObject()

ilUserStartingPoint::setStartingObject

(

int

$a_starting_object

)

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

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

setStartingPointType()

ilUserStartingPoint::setStartingPointType

(

int

$starting_point_type

)

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

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

Field Documentation

ROLE_BASED

const ilUserStartingPoint::ROLE_BASED = 2

private

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

---

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

• Services/User/classes/class.ilUserStartingPoint.php