ilStartingPoint Class Reference

Class ilStartingPoint. More...

Collaboration diagram for ilStartingPoint:

Public Member Functions
	__construct ($a_id=0)
	Constructor. More...
	setStartingPoint ($a_starting_point)
	Sets the starting point. More...
	getStartingPoint ()
	Gets the starting point. More...
	setStartingObject ($a_starting_object)
	Sets the starting object. More...
	getStartingObject ()
	Gets the starting object. More...
	setPosition ($a_starting_position)
	Sets the starting position. More...
	getPosition ()
	Gets the starting point position. More...
	setRuleType ($a_rule_type)
	Sets rule type. More...
	getRuleType ()
	Gets the rule type. More...
	setRuleOptions ($a_rule_options)
	Sets rule type options. More...
	getCalendarView ()
	Gets calendar view. More...
	setCalendarView (int $calendar_view)
	Sets calendar view. More...
	getCalendarPeriod ()
	Gets calendar Period. More...
	setCalendarPeriod (int $calendar_period)
	Sets calendar Period. More...
	getRuleOptions ()
	Gets the rule options. More...
	save ()
	insert starting point into database More...
	update ()
	update starting point More...
	delete ()
	delete starting point More...
	getMaxPosition ()
	saveOrder ($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 ($a_items)

Data Fields
const	ORDER_POSITION_MIN = 0
const	ORDER_POSITION_MAX = 9999
const	FALLBACK_RULE = 1
const	ROLE_BASED = 2
const	USER_SELECTION_RULE = 3

Protected Attributes
	$starting_point
	$starting_object
	$starting_position
	$rule_type
	$rule_options
	$id
	$calendar_view
	$calendar_period

Private Member Functions
	setData ($a_id)
	Set data for the starting point. More...

Detailed Description

Class ilStartingPoint.

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilStartingPoint::__construct

(

$a_id = 0

)

Constructor.

Parameters

a_id

public

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

References setData().

    {
        if ($a_id > 0) {
            $this->id = $a_id;
            $this->setData($a_id);
        }
    }

Here is the call graph for this function:

Member Function Documentation

delete()

ilStartingPoint::delete

(

)

delete starting point

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

References $DIC, $ilDB, and $query.

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

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

getCalendarPeriod()

ilStartingPoint::getCalendarPeriod

(

)

Gets calendar Period.

Returns

int

Definition at line 193 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.

Returns

int

Definition at line 173 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.

Returns

array

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

References $DIC, and ANONYMOUS_ROLE_ID.

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

    {
        global $DIC;

        $rbacreview = $DIC['rbacreview'];

        require_once "./Services/AccessControl/classes/class.ilObjRole.php";

        $global_roles = $rbacreview->getGlobalRoles();

        $roles_with_starting_point = self::getRolesWithStartingPoint();

        $ids_roles_with_sp = array();
        foreach ($roles_with_starting_point as $role) {
            array_push($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

(

)

Parameters

int

$a_ass_id

assignment id

Returns

int

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

References $DIC, $ilDB, and $result.

Referenced by save().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        //get max order number
        $result = $ilDB->query("SELECT max(position) as max_order FROM usr_starting_point");

        while ($row = $ilDB->fetchAssoc($result)) {
            $order_val = (int) $row['max_order'];
        }
        return $order_val;
    }

Here is the caller graph for this function:

getPosition()

ilStartingPoint::getPosition

(

)

Gets the starting point position.

public

Returns

int

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

References $starting_position.

Referenced by update().

    {
        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

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

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

Referenced by ilUserUtil\getStartingPoint().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = "SELECT * FROM usr_starting_point WHERE rule_options LIKE %s";
        $res = $ilDB->queryF($query, array('text'), array("%role_id%"));

        $roles = array();
        while ($sp = $ilDB->fetchAssoc($res)) {
            $options = unserialize($sp['rule_options']);

            $roles[$options['role_id']] = array(
                "id" => $sp['id'],
                "starting_point" => $sp['starting_point'],
                "starting_object" => $sp['starting_object'],
                "calendar_view"   => $sp['calendar_view'],
                "calendar_period"   => $sp['calendar_period'],
                "position" => $sp['position'],
                "role_id" => $options['role_id'],

            );
        }
        return $roles;
    }

Here is the caller graph for this function:

getRuleOptions()

ilStartingPoint::getRuleOptions

(

)

Gets the rule options.

public

Returns

int

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

References $rule_options.

Referenced by save(), and update().

    {
        return $this->rule_options;
    }

Here is the caller graph for this function:

getRuleType()

ilStartingPoint::getRuleType

(

)

Gets the rule type.

public

Returns

int

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

References $rule_type.

Referenced by save(), and update().

    {
        return $this->rule_type;
    }

Here is the caller graph for this function:

getStartingObject()

ilStartingPoint::getStartingObject

(

)

Gets the starting object.

public

Returns

int

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

References $starting_object.

Referenced by save(), and update().

    {
        return $this->starting_object;
    }

Here is the caller graph for this function:

getStartingPoint()

ilStartingPoint::getStartingPoint

(

)

Gets the starting point.

public

Returns

int

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

References $starting_point.

Referenced by save(), and update().

    {
        return $this->starting_point;
    }

Here is the caller graph for this function:

getStartingPoints()

static ilStartingPoint::getStartingPoints ( )

static

Get all the starting points in database.

Returns

array

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

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

Referenced by ilUserRoleStartingPointTableGUI\getItems().

    {
        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

Parameters

ilObjRole

$role

Returns

void

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

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

    {
        foreach (self::getRolesWithStartingPoint() as $roleId => $data) {
            if ((int) $roleId === (int) $role->getId()) {
                $sp = new self((int) $data['id']);
                $sp->delete();
            } elseif (
                false === ($maybeDeletedRole = ilObjectFactory::getInstanceByObjId((int) $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 (   $a_items )

static

Parameters

$a_items

Returns

mixed

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

Referenced by ilUserRoleStartingPointTableGUI\getItems().

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

Here is the caller graph for this function:

save()

ilStartingPoint::save

(

)

insert starting point into database

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

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

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        //get position
        $max_position = $this->getMaxPosition();
        $position = $max_position + 10;

        $next_id = $ilDB->nextId('usr_starting_point');
        $values = array(
                    $next_id,
                    $this->getStartingPoint(),
                    $this->getStartingObject(),
                    $position,
                    $this->getRuleType(),
                    $this->getRuleOptions(),
                    $this->getCalendarView(),
                    $this->getCalendarPeriod()
                );

        $ilDB->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

(

$a_items

)

Save all starting point positions.

Ordering values with increment +10

Parameters

$a_items

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

References $DIC, $id, and $ilDB.

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

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

setCalendarPeriod()

ilStartingPoint::setCalendarPeriod

(

int

$calendar_period

)

Sets calendar Period.

Parameters

int

$calendar_period

Definition at line 203 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.

Parameters

int

$calendar_view

Definition at line 183 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 (   $a_id )

private

Set data for the starting point.

Parameters

$a_id

integer starting point id

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

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

Referenced by __construct().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = "SELECT * FROM usr_starting_point WHERE id = " . $ilDB->quote($a_id, 'integer');
        $res = $ilDB->query($query);

        while ($point = $ilDB->fetchAssoc($res)) {
            $this->setStartingPoint($point['starting_point']);
            $this->setRuleOptions($point['rule_options']);
            $this->setPosition($point['position']);
            $this->setStartingObject($point['starting_object']);
            $this->setRuleType($point['rule_type']);
            $this->setCalendarView($point['calendar_view']);
            $this->setCalendarPeriod($point['calendar_period']);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setPosition()

ilStartingPoint::setPosition

(

$a_starting_position

)

Sets the starting position.

public

Parameters

int

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

Referenced by setData().

    {
        $this->starting_position = $a_starting_position;
    }

Here is the caller graph for this function:

setRuleOptions()

ilStartingPoint::setRuleOptions

(

$a_rule_options

)

Sets rule type options.

public

Parameters

int

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

Referenced by setData().

    {
        $this->rule_options = $a_rule_options;
    }

Here is the caller graph for this function:

setRuleType()

ilStartingPoint::setRuleType

(

$a_rule_type

)

Sets rule type.

public

Parameters

int

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

Referenced by setData().

    {
        $this->rule_type = $a_rule_type;
    }

Here is the caller graph for this function:

setStartingObject()

ilStartingPoint::setStartingObject

(

$a_starting_object

)

Sets the starting object.

public

Parameters

int

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

Referenced by setData().

    {
        $this->starting_object = $a_starting_object;
    }

Here is the caller graph for this function:

setStartingPoint()

ilStartingPoint::setStartingPoint

(

$a_starting_point

)

Sets the starting point.

public

Parameters

int

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

Referenced by setData().

    {
        $this->starting_point = $a_starting_point;
    }

Here is the caller graph for this function:

update()

ilStartingPoint::update

(

)

update starting point

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

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

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $ilDB->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

ilStartingPoint::$calendar_period

protected

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

Referenced by getCalendarPeriod(), and setCalendarPeriod().

$calendar_view

ilStartingPoint::$calendar_view

protected

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

Referenced by getCalendarView(), and setCalendarView().

$id

ilStartingPoint::$id

protected

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

Referenced by saveOrder().

$rule_options

ilStartingPoint::$rule_options

protected

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

Referenced by getRuleOptions().

$rule_type

ilStartingPoint::$rule_type

protected

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

Referenced by getRuleType().

$starting_object

ilStartingPoint::$starting_object

protected

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

Referenced by getStartingObject().

$starting_point

ilStartingPoint::$starting_point

protected

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

Referenced by getStartingPoint().

$starting_position

ilStartingPoint::$starting_position

protected

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

Referenced by getPosition().

FALLBACK_RULE

const ilStartingPoint::FALLBACK_RULE = 1

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

ORDER_POSITION_MAX

const ilStartingPoint::ORDER_POSITION_MAX = 9999

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

ORDER_POSITION_MIN

const ilStartingPoint::ORDER_POSITION_MIN = 0

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

ROLE_BASED

const ilStartingPoint::ROLE_BASED = 2

Definition at line 19 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 20 of file class.ilStartingPoint.php.

---

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

• Services/AccessControl/classes/class.ilStartingPoint.php