Collaboration diagram for ilStartingPoint:

Public Member Functions
	__construct (int $a_id=0)

	setStartingPoint (int $a_starting_point)

	getStartingPoint ()

	setStartingObject (int $a_starting_object)

	getStartingObject ()

	setPosition (int $a_starting_position)

	getPosition ()

	setRuleType (int $a_rule_type)

	getRuleType ()

	setRuleOptions (string $a_rule_options)
	serialized string More...

	getCalendarView ()
	Gets calendar view. More...

	setCalendarView (int $calendar_view)
	Sets calendar view. More...

	getCalendarPeriod ()

	setCalendarPeriod (int $calendar_period)

	getRuleOptions ()

	save ()
	insert starting point into database More...

	update ()
	update starting point More...

	delete ()
	delete starting point More...

	getMaxPosition ()

	saveOrder (array $a_items)
	Save all starting point positions. More...

Static Public Member Functions
static	getStartingPoints ()
	Get all the starting points in database. More...

static	onRoleDeleted (ilObjRole $role)

static	getRolesWithStartingPoint ()
	get array with all roles which have starting point defined. More...

static	getGlobalRolesWithoutStartingPoint ()
	Get id and title of the roles without starting points. More...

static	reArrangePositions (array $a_items)

Data Fields
const	FALLBACK_RULE = 1

const	ROLE_BASED = 2

const	USER_SELECTION_RULE = 3

Protected Attributes
const	ORDER_POSITION_MIN = 0

const	ORDER_POSITION_MAX = 9999

int	$starting_point = null

int	$starting_object = null

int	$starting_position = null

int	$rule_type = null

string	$rule_options = null

int	$id

int	$calendar_view = null

int	$calendar_period = null

ilDBInterface	$db

Private Member Functions
	setData ()

Detailed Description

Class ilStartingPoint.

Author: Jesús López lopez.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

◆ __construct()

ilStartingPoint::__construct ( int $a_id = 0 )

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

References $DIC, and setData().

     {
         global $DIC;
 
         $this->db = $DIC->database();
         $this->id = $a_id;
         $this->setData();
     }

Here is the call graph for this function:

Member Function Documentation

◆ delete()

ilStartingPoint::delete ( )

delete starting point

Definition at line 333 of file class.ilStartingPoint.php.

References $query.

                             : void
     {
         $query = "DELETE FROM usr_starting_point WHERE id = " . $this->db->quote($this->id, "integer");
         $this->db->manipulate($query);
     }

◆ getCalendarPeriod()

ilStartingPoint::getCalendarPeriod ( )

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

References $calendar_period.

Referenced by save(), and update().

                                        : int
     {
         return $this->calendar_period;
     }

Here is the caller graph for this function:

◆ getCalendarView()

ilStartingPoint::getCalendarView ( )

Gets calendar view.

Definition at line 123 of file class.ilStartingPoint.php.

References $calendar_view.

Referenced by save(), and update().

                                      : int
     {
         return $this->calendar_view;
     }

Here is the caller graph for this function:

◆ getGlobalRolesWithoutStartingPoint()

static ilStartingPoint::getGlobalRolesWithoutStartingPoint ( )

static

Get id and title of the roles without starting points.

Definition at line 228 of file class.ilStartingPoint.php.

References $DIC, and ANONYMOUS_ROLE_ID.

Referenced by ilUserStartingPointGUI\getRoleStartingPointForm(), and ilUserStartingPointGUI\startingPoints().

                                                                : array
     {
         global $DIC;
 
         $rbacreview = $DIC['rbacreview'];
         $global_roles = $rbacreview->getGlobalRoles();
         $roles_with_starting_point = self::getRolesWithStartingPoint();
 
         $ids_roles_with_sp = array();
         foreach ($roles_with_starting_point as $role) {
             $ids_roles_with_sp[] = $role['role_id'];
         }
 
         $ids_roles_without_sp = array_diff($global_roles, $ids_roles_with_sp);
 
         $roles = array();
         foreach ($ids_roles_without_sp as $roleid) {
             if ($roleid === ANONYMOUS_ROLE_ID) {
                 continue;
             }
             $role_obj = new ilObjRole($roleid);
             $roles[] = array(
                 "id" => $role_obj->getId(),
                 "title" => $role_obj->getTitle(),
             );
         }
 
         return $roles;
     }

Here is the caller graph for this function:

◆ getMaxPosition()

ilStartingPoint::getMaxPosition ( )

Definition at line 339 of file class.ilStartingPoint.php.

References ILIAS\Repository\int().

Referenced by save().

                                     : int
     {
         //get max order number
         $result = $this->db->query("SELECT max(position) as max_order FROM usr_starting_point");
 
         $order_val = 0;
         while ($row = $this->db->fetchAssoc($result)) {
             $order_val = (int) $row['max_order'];
         }
         return $order_val;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPosition()

ilStartingPoint::getPosition ( )

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

References $starting_position.

Referenced by update().

                                  : int
     {
         return $this->starting_position;
     }

Here is the caller graph for this function:

◆ getRolesWithStartingPoint()

static ilStartingPoint::getRolesWithStartingPoint ( )

static

get array with all roles which have starting point defined.

Returns: array<int, array{"id": int, "starting_point": int, "starting_object": int, "calendar_view": int, "calendar_period": int, "position": int, "role_id": int}>

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

References $DIC, $ilDB, $query, $res, and ILIAS\Repository\int().

Referenced by ilUserUtil\getStartingPoint().

                                                       : array
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
         $query = "SELECT * FROM usr_starting_point WHERE rule_options LIKE %s";
         $res = $ilDB->queryF($query, ['text'], ["%role_id%"]);
 
         $roles = [];
         while ($sp = $ilDB->fetchAssoc($res)) {
             $options = unserialize($sp['rule_options']);
 
             $roles[(int) $options['role_id']] = [
                 "id" => (int) $sp['id'],
                 "starting_point" => (int) $sp['starting_point'],
                 "starting_object" => (int) $sp['starting_object'],
                 "calendar_view" => (int) $sp['calendar_view'],
                 "calendar_period" => (int) $sp['calendar_period'],
                 "position" => (int) $sp['position'],
                 "role_id" => (int) $options['role_id'],
 
             ];
         }
         return $roles;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRuleOptions()

ilStartingPoint::getRuleOptions ( )

Definition at line 146 of file class.ilStartingPoint.php.

References $rule_options.

Referenced by save(), and update().

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

Here is the caller graph for this function:

◆ getRuleType()

ilStartingPoint::getRuleType ( )

Definition at line 107 of file class.ilStartingPoint.php.

References $rule_type.

Referenced by save(), and update().

                                  : int
     {
         return $this->rule_type;
     }

Here is the caller graph for this function:

◆ getStartingObject()

ilStartingPoint::getStartingObject ( )

Definition at line 87 of file class.ilStartingPoint.php.

References $starting_object.

Referenced by save(), and update().

                                        : int
     {
         return $this->starting_object;
     }

Here is the caller graph for this function:

◆ getStartingPoint()

ilStartingPoint::getStartingPoint ( )

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

References $starting_point.

Referenced by save(), and update().

                                       : int
     {
         return $this->starting_point;
     }

Here is the caller graph for this function:

◆ getStartingPoints()

static ilStartingPoint::getStartingPoints ( )

static

Get all the starting points in database.

Definition at line 154 of file class.ilStartingPoint.php.

References $DIC, $ilDB, $query, and $res.

Referenced by ilUserRoleStartingPointTableGUI\getItems().

                                               : array
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $query = "SELECT * FROM usr_starting_point";
         $res = $ilDB->query($query);
         $points = array();
         while ($point = $ilDB->fetchAssoc($res)) {
             $points[] = array(
                 "id" => $point["id"],
                 "position" => $point["position"],
                 "starting_point" => $point['starting_point'],
                 "starting_object" => $point['starting_object'],
                 "calendar_view" => $point['calendar_view'],
                 "calendar_period" => $point['calendar_period'],
                 "rule_type" => $point['rule_type'],
                 "rule_options" => $point['rule_options']
             );
         }
 
         return $points;
     }

Here is the caller graph for this function:

◆ onRoleDeleted()

static ilStartingPoint::onRoleDeleted ( ilObjRole $role )

static

Definition at line 179 of file class.ilStartingPoint.php.

References $data, ilObject\getId(), ilObjectFactory\getInstanceByObjId(), and ILIAS\Repository\int().

                                                          : void
     {
         foreach (self::getRolesWithStartingPoint() as $roleId => $data) {
             if ($roleId === $role->getId()) {
                 $sp = new self((int) $data['id']);
                 $sp->delete();
             } elseif (
                 is_null($maybeDeletedRole = ilObjectFactory::getInstanceByObjId($roleId, false)) ||
                 !($maybeDeletedRole instanceof ilObjRole)
             ) {
                 $sp = new self((int) $data['id']);
                 $sp->delete();
             }
         }
     }

Here is the call graph for this function:

◆ reArrangePositions()

static ilStartingPoint::reArrangePositions ( array $a_items )

static

Definition at line 351 of file class.ilStartingPoint.php.

Referenced by ilUserRoleStartingPointTableGUI\getItems().

                                                              : array
     {
         $ord_const = 0;
         $rearranged = [];
         foreach ($a_items as $v) {
             $v['starting_position'] = $ord_const;
             $rearranged[$ord_const] = $v;
             $ord_const += 10;
         }
         return $rearranged;
     }

Here is the caller graph for this function:

◆ save()

ilStartingPoint::save ( )

insert starting point into database

Definition at line 261 of file class.ilStartingPoint.php.

References getCalendarPeriod(), getCalendarView(), getMaxPosition(), getRuleOptions(), getRuleType(), getStartingObject(), getStartingPoint(), ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

                           : void
     {
         //get position
         $max_position = $this->getMaxPosition();
         $position = $max_position + 10;
 
         $next_id = $this->db->nextId('usr_starting_point');
         $values = array(
             $next_id,
             $this->getStartingPoint(),
             $this->getStartingObject(),
             $position,
             $this->getRuleType(),
             $this->getRuleOptions(),
             $this->getCalendarView(),
             $this->getCalendarPeriod()
         );
 
         $this->db->manipulateF(
             "INSERT INTO usr_starting_point (id, starting_point, starting_object, position, rule_type, rule_options, calendar_view, calendar_period) VALUES (%s, %s, %s, %s, %s, %s, %s, %s)",
             array(ilDBConstants::T_INTEGER,
                   ilDBConstants::T_INTEGER,
                   ilDBConstants::T_INTEGER,
                   ilDBConstants::T_INTEGER,
                   ilDBConstants::T_INTEGER,
                   ilDBConstants::T_TEXT,
                   ilDBConstants::T_INTEGER,
                   ilDBConstants::T_INTEGER
             ),
             $values
         );
     }

Here is the call graph for this function:

◆ saveOrder()

ilStartingPoint::saveOrder ( array $a_items )

Save all starting point positions.

Ordering values with increment +10

Definition at line 366 of file class.ilStartingPoint.php.

                                              : void
     {
         asort($a_items);
         $nr = 10;
         foreach ($a_items as $id => $position) {
             if ($position > self::ORDER_POSITION_MIN && $position < self::ORDER_POSITION_MAX) {
                 $this->db->manipulate(
                     "UPDATE usr_starting_point SET" .
                     " position = " . $this->db->quote($nr, 'integer') .
                     " WHERE id = " . $this->db->quote($id, 'integer')
                 );
                 $nr += 10;
             }
         }
     }

◆ setCalendarPeriod()

ilStartingPoint::setCalendarPeriod ( int $calendar_period )

Definition at line 141 of file class.ilStartingPoint.php.

References $calendar_period.

Referenced by setData().

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

Here is the caller graph for this function:

◆ setCalendarView()

ilStartingPoint::setCalendarView ( int $calendar_view )

Sets calendar view.

Definition at line 131 of file class.ilStartingPoint.php.

References $calendar_view.

Referenced by setData().

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

Here is the caller graph for this function:

◆ setData()

ilStartingPoint::setData ( )

private

Definition at line 56 of file class.ilStartingPoint.php.

References $query, $res, setCalendarPeriod(), setCalendarView(), setPosition(), setRuleOptions(), setRuleType(), setStartingObject(), and setStartingPoint().

Referenced by __construct().

                               : void
     {
         $query = "SELECT * FROM usr_starting_point WHERE id = " . $this->db->quote($this->id, 'integer');
         $res = $this->db->query($query);
 
         while ($point = $this->db->fetchAssoc($res)) {
             $this->setStartingPoint((int) $point['starting_point']);
             $this->setRuleOptions((string) $point['rule_options']);
             $this->setPosition((int) $point['position']);
             $this->setStartingObject((int) $point['starting_object']);
             $this->setRuleType((int) $point['rule_type']);
             $this->setCalendarView((int) $point['calendar_view']);
             $this->setCalendarPeriod((int) $point['calendar_period']);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setPosition()

ilStartingPoint::setPosition ( int $a_starting_position )

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

Referenced by setData().

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

Here is the caller graph for this function:

◆ setRuleOptions()

ilStartingPoint::setRuleOptions ( string $a_rule_options )

serialized string

Definition at line 115 of file class.ilStartingPoint.php.

Referenced by setData().

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

Here is the caller graph for this function:

◆ setRuleType()

ilStartingPoint::setRuleType ( int $a_rule_type )

Definition at line 102 of file class.ilStartingPoint.php.

Referenced by setData().

                                                  : void
     {
         $this->rule_type = $a_rule_type;
     }

Here is the caller graph for this function:

◆ setStartingObject()

ilStartingPoint::setStartingObject ( int $a_starting_object )

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

Referenced by setData().

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

Here is the caller graph for this function:

◆ setStartingPoint()

ilStartingPoint::setStartingPoint ( int $a_starting_point )

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

Referenced by setData().

                                                            : void
     {
         $this->starting_point = $a_starting_point;
     }

Here is the caller graph for this function:

◆ update()

ilStartingPoint::update ( )

update starting point

Definition at line 297 of file class.ilStartingPoint.php.

References getCalendarPeriod(), getCalendarView(), getPosition(), getRuleOptions(), getRuleType(), getStartingObject(), getStartingPoint(), ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

                             : void
     {
         $this->db->manipulateF(
             'UPDATE usr_starting_point
                         SET starting_point = %s,
                                 starting_object = %s,
                                 position = %s,
                                 rule_type = %s,
                                 rule_options = %s,
                                 calendar_view = %s,
                                 calendar_period = %s
                         WHERE id = %s',
             array(ilDBConstants::T_INTEGER,
                   ilDBConstants::T_INTEGER,
                   ilDBConstants::T_INTEGER,
                   ilDBConstants::T_INTEGER,
                   ilDBConstants::T_TEXT,
                   ilDBConstants::T_INTEGER,
                   ilDBConstants::T_INTEGER,
                   ilDBConstants::T_INTEGER
             ),
             array($this->getStartingPoint(),
                   $this->getStartingObject(),
                   $this->getPosition(),
                   $this->getRuleType(),
                   $this->getRuleOptions(),
                   $this->getCalendarView(),
                   $this->getCalendarPeriod(),
                   $this->id
             )
         );
     }

Here is the call graph for this function:

Field Documentation

◆ $calendar_period

int ilStartingPoint::$calendar_period = null

protected

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

Referenced by getCalendarPeriod(), and setCalendarPeriod().

◆ $calendar_view

int ilStartingPoint::$calendar_view = null

protected

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

Referenced by getCalendarView(), and setCalendarView().

◆ $db

ilDBInterface ilStartingPoint::$db

protected

Definition at line 45 of file class.ilStartingPoint.php.

◆ $id

int ilStartingPoint::$id

protected

Definition at line 41 of file class.ilStartingPoint.php.

◆ $rule_options

string ilStartingPoint::$rule_options = null

protected

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

Referenced by getRuleOptions().

◆ $rule_type

int ilStartingPoint::$rule_type = null

protected

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

Referenced by getRuleType().

◆ $starting_object

int ilStartingPoint::$starting_object = null

protected

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

Referenced by getStartingObject().

◆ $starting_point

int ilStartingPoint::$starting_point = null

protected

Definition at line 36 of file class.ilStartingPoint.php.

Referenced by getStartingPoint().

◆ $starting_position

int ilStartingPoint::$starting_position = null

protected

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

Referenced by getPosition().

◆ FALLBACK_RULE

const ilStartingPoint::FALLBACK_RULE = 1

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

◆ ORDER_POSITION_MAX

const ilStartingPoint::ORDER_POSITION_MAX = 9999

protected

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

◆ ORDER_POSITION_MIN

const ilStartingPoint::ORDER_POSITION_MIN = 0

protected

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

◆ ROLE_BASED

const ilStartingPoint::ROLE_BASED = 2

Definition at line 33 of file class.ilStartingPoint.php.

Referenced by ilUserRoleStartingPointTableGUI\fillRow(), ilUserRoleStartingPointTableGUI\getItems(), ilUserStartingPointGUI\getRoleStartingPointForm(), and ilUserStartingPointGUI\saveStartingPoint().

◆ USER_SELECTION_RULE

const ilStartingPoint::USER_SELECTION_RULE = 3

Definition at line 34 of file class.ilStartingPoint.php.

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

Services/AccessControl/classes/class.ilStartingPoint.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ delete()

◆ getCalendarPeriod()

◆ getCalendarView()

◆ getGlobalRolesWithoutStartingPoint()

◆ getMaxPosition()

◆ getPosition()

◆ getRolesWithStartingPoint()

◆ getRuleOptions()

◆ getRuleType()

◆ getStartingObject()

◆ getStartingPoint()

◆ getStartingPoints()

◆ onRoleDeleted()

◆ reArrangePositions()

◆ save()

◆ saveOrder()

◆ setCalendarPeriod()

◆ setCalendarView()

◆ setData()

◆ setPosition()

◆ setRuleOptions()

◆ setRuleType()

◆ setStartingObject()

◆ setStartingPoint()

◆ update()

Field Documentation

◆ $calendar_period

◆ $calendar_view

◆ $db

◆ $id

◆ $rule_options

◆ $rule_type

◆ $starting_object

◆ $starting_point

◆ $starting_position

◆ FALLBACK_RULE

◆ ORDER_POSITION_MAX

◆ ORDER_POSITION_MIN

◆ ROLE_BASED

◆ USER_SELECTION_RULE