ilBookingPreferencesManager Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilBookingPreferencesManager:

Public Member Functions
	__construct (ilObjBookingPool $pool, ilBookingPrefBasedBookGatewayRepository $book_repo, ?int $current_time=null, int $bookings_per_user=self::BOOKINGS_PER_USER_DEFAULT)
	isGivingPreferencesPossible ()
	Can participants hand in preferences. More...
	isPreferenceDeadlineReached ()
	Can participants hand in preferences. More...
	storeBookings (ilBookingPreferences $preferences, ?array $booking_object_ids=null)
	Calculate and store bookings. More...
	readBookings ()
	calculateBookings (ilBookingPreferences $preferences, ?array $booking_object_ids=null, ?array $availability=null)
	Calculate bookings. More...
	hasRun ()
	resetRun ()

Data Fields
const	BOOKINGS_PER_USER_DEFAULT = 1

Protected Member Functions
	addBooking (array &$bookings, array &$preferences, array &$availability, int $user_id, int $book_obj_id)
	selectRandomEntry (array $items)
	Select a random entry of an array. More...
	getUsersForObject (array $preferences, int $sel_obj_id)
	Get users for object. More...
	calculatePopularity (array $booking_object_ids, array $preferences)
	Calculate popularity (number of preferences each object got from users) More...
	getObjectWithLowestPopularity (array $popularity, array $availability)
	Get an availabe object with lowest popularity > 0. More...
	removePreference (int $user_id, int $obj_id, array $preferences)
	Remove a preference from the preference array. More...
	removeObjectFromPreferences (int $obj_id, array $preferences)
	Remove an object from the preference array. More...
	removeUserFromPreferences (int $user_id, array $preferences)
	Remove user from preference array. More...
	chooseRandomUserFromPreferences (array $preferences)
	Choose random user from the preference array. More...
	getMinimalAssignedEntryForUser (array $booking_object_ids, array $bookings, array $user_preferences, array $availability)
	Get an available object within the preferences (if no preferences left, even outside of preferences) of a user that is currently minimal assigned. More...

Protected Attributes
ilObjBookingPool	$pool
int	$current_time
int	$bookings_per_user
ilBookingPrefBasedBookGatewayRepository	$book_repo

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Booking preferences business logic

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ilBookingPreferencesManager::__construct	(	ilObjBookingPool	$pool,
		ilBookingPrefBasedBookGatewayRepository	$book_repo,
		?int	$current_time = null,
		int	$bookings_per_user = self::BOOKINGS_PER_USER_DEFAULT
	)

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

References $book_repo, $bookings_per_user, and $pool.

      {
        $this->current_time = ($current_time > 0)
            ? $current_time
            : time();
        $this->pool = $pool;
        $this->bookings_per_user = $bookings_per_user;
        $this->book_repo = $book_repo;
    }

Member Function Documentation

addBooking()

ilBookingPreferencesManager::addBooking ( array &  $bookings, array &  $preferences, array &  $availability, int  $user_id, int  $book_obj_id  )

protected

Definition at line 170 of file class.ilBookingPreferencesManager.php.

References removeObjectFromPreferences(), removePreference(), and removeUserFromPreferences().

Referenced by calculateBookings().

     : void {
        $bookings[$user_id][] = $book_obj_id;
        $availability[$book_obj_id]--;
        if (count($bookings[$user_id]) >= $this->bookings_per_user) {
            $preferences = $this->removeUserFromPreferences($user_id, $preferences);
        } else {
            $preferences = $this->removePreference($user_id, $book_obj_id, $preferences);
        }
        if ($availability[$book_obj_id] <= 0) {
            $preferences = $this->removeObjectFromPreferences($book_obj_id, $preferences);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

calculateBookings()

ilBookingPreferencesManager::calculateBookings	(	ilBookingPreferences	$preferences,
		?array	$booking_object_ids = null,
		?array	$availability = null
	)

Calculate bookings.

Parameters

int[]

$booking_object_ids

Exceptions

ilBookingCalculationException

Definition at line 95 of file class.ilBookingPreferencesManager.php.

References addBooking(), calculatePopularity(), chooseRandomUserFromPreferences(), ilBookingObject\getList(), getMinimalAssignedEntryForUser(), ilBookingReservation\getNumAvailablesNoSchedule(), getObjectWithLowestPopularity(), ilBookingPreferences\getPreferences(), getUsersForObject(), isPreferenceDeadlineReached(), removeObjectFromPreferences(), removeUserFromPreferences(), and selectRandomEntry().

Referenced by storeBookings().

     : array {
        $preferences = $preferences->getPreferences();

        // we calculate if a) any preferences are given and b) the deadline is reached
        /*if (!is_array($preferences) || count($preferences) == 0) {
            throw new ilBookingCalculationException("No preferences given.");
        }*/
        if (!$this->isPreferenceDeadlineReached()) {
            throw new ilBookingCalculationException("Preference deadline not reached.");
        }

        if ($booking_object_ids === null) {
            $booking_object_ids = array_map(function ($i) {
                return $i["booking_object_id"];
            }, ilBookingObject::getList($this->pool->getId()));
        }

        if ($availability === null) {
            $availability = [];
            foreach ($booking_object_ids as $book_obj_id) {
                $availability[$book_obj_id] = ilBookingReservation::getNumAvailablesNoSchedule($book_obj_id);
            }
        }

        // remove all objects from the preferences
        // that are already not available anymore
        // see bug 30204 (a tutor booked an object already before and made it unavailable)
        foreach ($availability as $book_obj_id => $cnt) {
            if ($cnt == 0) {
                $preferences = $this->removeObjectFromPreferences($book_obj_id, $preferences);
            }
        }

        $bookings = [];

        $end_phase_one = false;

        // phase one: assign lowest popular items to random user
        while (!$end_phase_one) {
            $popularity = $this->calculatePopularity($booking_object_ids, $preferences);
            $low_pop_book_obj_id = $this->getObjectWithLowestPopularity($popularity, $availability);
            if ($low_pop_book_obj_id > 0) {
                $user_ids = $this->getUsersForObject($preferences, $low_pop_book_obj_id);
                if (count($user_ids) > 0) {
                    $user_id = $this->selectRandomEntry($user_ids);
                    $this->addBooking($bookings, $preferences, $availability, $user_id, $low_pop_book_obj_id);
                }
            } else {
                $end_phase_one = true;
            }
        }

        $end_phase_two = false;

        // choose random user from and assign currently rarely assigned objects
        while (!$end_phase_two) {
            $random_user_id = $this->chooseRandomUserFromPreferences($preferences);
            if ($random_user_id > 0) {
                $rare_assigned_book_obj_id = $this->getMinimalAssignedEntryForUser($booking_object_ids, $bookings, $preferences[$random_user_id], $availability);
                if ($rare_assigned_book_obj_id > 0) {
                    $this->addBooking($bookings, $preferences, $availability, $random_user_id, $rare_assigned_book_obj_id);
                } else {
                    $preferences = $this->removeUserFromPreferences($random_user_id, $preferences);
                }
            } else {
                $end_phase_two = true;
            }
        }
        return $bookings;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

calculatePopularity()

ilBookingPreferencesManager::calculatePopularity ( array  $booking_object_ids, array  $preferences  )

protected

Calculate popularity (number of preferences each object got from users)

Definition at line 222 of file class.ilBookingPreferencesManager.php.

Referenced by calculateBookings().

     : array {
        $popularity = [];
        foreach ($booking_object_ids as $book_obj_id) {
            $popularity[$book_obj_id] = 0;
        }
        foreach ($preferences as $user_id => $bobj_ids) {
            foreach ($bobj_ids as $bobj_id) {
                ++$popularity[$bobj_id];
            }
        }

        return $popularity;
    }

Here is the caller graph for this function:

chooseRandomUserFromPreferences()

ilBookingPreferencesManager::chooseRandomUserFromPreferences ( array  $preferences )

protected

Choose random user from the preference array.

Definition at line 304 of file class.ilBookingPreferencesManager.php.

References selectRandomEntry().

Referenced by calculateBookings().

     : ?int {
        if (count($preferences) === 0) {
            return null;
        }
        $user_ids = array_keys($preferences);
        return $this->selectRandomEntry($user_ids);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMinimalAssignedEntryForUser()

ilBookingPreferencesManager::getMinimalAssignedEntryForUser ( array  $booking_object_ids, array  $bookings, array  $user_preferences, array  $availability  )

protected

Get an available object within the preferences (if no preferences left, even outside of preferences) of a user that is currently minimal assigned.

Parameters

int[]	$booking_object_ids
int[][]	$bookings
int[]	$user_preferences
int[]	$availability

Returns

int

Definition at line 324 of file class.ilBookingPreferencesManager.php.

Referenced by calculateBookings().

     : int {
        // count the assignments per object
        $count_assignments = [];
        foreach ($booking_object_ids as $obj_id) {
            $count_assignments[$obj_id] = 0;
        }
        foreach ($bookings as $user => $obj_ids) {
            foreach ($obj_ids as $obj_id) {
                $count_assignments[$obj_id]++;
            }
        }

        // sort the objects by number of assignments, return the first one being found in the user preferences
        asort($count_assignments, SORT_NUMERIC);
        foreach ($count_assignments as $obj_id => $cnt) {
            // if no preferences left for user, even assign object outside preferences
            // otherwise choose object from preferences
            if ($availability[$obj_id] > 0 && (count($user_preferences) === 0 || in_array($obj_id, $user_preferences))) {
                return (int) $obj_id;
            }
        }
        return 0;
    }

Here is the caller graph for this function:

getObjectWithLowestPopularity()

ilBookingPreferencesManager::getObjectWithLowestPopularity ( array  $popularity, array  $availability  )

protected

Get an availabe object with lowest popularity > 0.

Definition at line 243 of file class.ilBookingPreferencesManager.php.

Referenced by calculateBookings().

     : int {
        asort($popularity, SORT_NUMERIC);
        foreach ($popularity as $obj_id => $pop) {
            if ($pop > 0 && $availability[$obj_id] > 0) {
                return (int) $obj_id;
            }
        }
        return 0;
    }

Here is the caller graph for this function:

getUsersForObject()

ilBookingPreferencesManager::getUsersForObject ( array  $preferences, int  $sel_obj_id  )

protected

Get users for object.

Returns

int[]

Definition at line 203 of file class.ilBookingPreferencesManager.php.

References ILIAS\Repository\int().

Referenced by calculateBookings().

     : array {
        $user_ids = [];
        foreach ($preferences as $user_id => $obj_ids) {
            foreach ($obj_ids as $obj_id) {
                if ((int) $obj_id === $sel_obj_id) {
                    $user_ids[] = (int) $user_id;
                }
            }
        }
        return $user_ids;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasRun()

ilBookingPreferencesManager::hasRun

(

)

Definition at line 353 of file class.ilBookingPreferencesManager.php.

                            : bool
    {
        return $this->book_repo->hasRun($this->pool->getId());
    }

isGivingPreferencesPossible()

ilBookingPreferencesManager::isGivingPreferencesPossible

(

)

Can participants hand in preferences.

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

References $current_time, and ilObjBookingPool\TYPE_NO_SCHEDULE_PREFERENCES.

                                                 : bool
    {
        return $this->pool->getScheduleType() === ilObjBookingPool::TYPE_NO_SCHEDULE_PREFERENCES &&
            $this->pool->getPreferenceDeadline() > $this->current_time;
    }

isPreferenceDeadlineReached()

ilBookingPreferencesManager::isPreferenceDeadlineReached

(

)

Can participants hand in preferences.

Definition at line 58 of file class.ilBookingPreferencesManager.php.

References $current_time, and ilObjBookingPool\TYPE_NO_SCHEDULE_PREFERENCES.

Referenced by calculateBookings().

                                                 : bool
    {
        return $this->pool->getScheduleType() === ilObjBookingPool::TYPE_NO_SCHEDULE_PREFERENCES &&
            $this->pool->getPreferenceDeadline() < $this->current_time;
    }

Here is the caller graph for this function:

readBookings()

ilBookingPreferencesManager::readBookings

(

)

Returns

int[][]

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

References ilBookingObject\getList().

                                  : array
    {
        $booking_object_ids = array_map(static function ($i) {
            return $i["booking_object_id"];
        }, ilBookingObject::getList($this->pool->getId()));
        return $this->book_repo->getBookings($booking_object_ids);
    }

Here is the call graph for this function:

removeObjectFromPreferences()

ilBookingPreferencesManager::removeObjectFromPreferences ( int  $obj_id, array  $preferences  )

protected

Remove an object from the preference array.

Definition at line 275 of file class.ilBookingPreferencesManager.php.

Referenced by addBooking(), and calculateBookings().

     : array {
        $new_preferences = [];
        foreach ($preferences as $user_id => $obj_ids) {
            $new_preferences[$user_id] = array_filter($obj_ids, static function ($i) use ($obj_id) {
                return ($i !== $obj_id);
            });
        }
        return $new_preferences;
    }

Here is the caller graph for this function:

removePreference()

ilBookingPreferencesManager::removePreference ( int  $user_id, int  $obj_id, array  $preferences  )

protected

Remove a preference from the preference array.

Definition at line 259 of file class.ilBookingPreferencesManager.php.

Referenced by addBooking().

     : array {
        if (is_array($preferences[$user_id])) {
            $preferences[$user_id] = array_filter($preferences[$user_id], static function ($i) use ($obj_id) {
                return ($i !== $obj_id);
            });
        }
        return $preferences;
    }

Here is the caller graph for this function:

removeUserFromPreferences()

ilBookingPreferencesManager::removeUserFromPreferences ( int  $user_id, array  $preferences  )

protected

Remove user from preference array.

Definition at line 291 of file class.ilBookingPreferencesManager.php.

Referenced by addBooking(), and calculateBookings().

     : array {
        if (is_array($preferences[$user_id])) {
            unset($preferences[$user_id]);
        }
        return $preferences;
    }

Here is the caller graph for this function:

resetRun()

ilBookingPreferencesManager::resetRun

(

)

Definition at line 358 of file class.ilBookingPreferencesManager.php.

                              : void
    {
        $this->book_repo->resetRun($this->pool->getId());
    }

selectRandomEntry()

ilBookingPreferencesManager::selectRandomEntry ( array  $items )

protected

Select a random entry of an array.

Returns

mixed

Definition at line 193 of file class.ilBookingPreferencesManager.php.

Referenced by calculateBookings(), and chooseRandomUserFromPreferences().

    {
        return $items[array_rand($items)];
    }

Here is the caller graph for this function:

storeBookings()

ilBookingPreferencesManager::storeBookings	(	ilBookingPreferences	$preferences,
		?array	$booking_object_ids = null
	)

Calculate and store bookings.

Parameters

ilBookingPreferences	$preferences
	?int[]	$booking_object_ids

Exceptions

ilBookingCalculationException

Definition at line 71 of file class.ilBookingPreferencesManager.php.

References calculateBookings().

     : void {
        $bookings = $this->calculateBookings($preferences, $booking_object_ids);
        $this->book_repo->storeBookings($this->pool->getId(), $bookings);
    }

Here is the call graph for this function:

Field Documentation

$book_repo

ilBookingPrefBasedBookGatewayRepository ilBookingPreferencesManager::$book_repo

protected

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

Referenced by __construct().

$bookings_per_user

int ilBookingPreferencesManager::$bookings_per_user

protected

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

Referenced by __construct().

$current_time

int ilBookingPreferencesManager::$current_time

protected

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

Referenced by isGivingPreferencesPossible(), and isPreferenceDeadlineReached().

$pool

ilObjBookingPool ilBookingPreferencesManager::$pool

protected

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

Referenced by __construct().

BOOKINGS_PER_USER_DEFAULT

const ilBookingPreferencesManager::BOOKINGS_PER_USER_DEFAULT = 1

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

---

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

• Modules/BookingManager/Preferences/class.ilBookingPreferencesManager.php