From 356b2582f3e6a43ecf2607acad4a7fe0b37f659a Mon Sep 17 00:00:00 2001 From: Bot Date: Tue, 3 Jan 2017 03:22:48 +0100 Subject: PPHDoc, formatting, fixes, cleanup --- includes/controller/angeltypes_controller.php | 25 +++++++-- includes/controller/event_config_controller.php | 6 +++ includes/controller/rooms_controller.php | 23 ++++++-- includes/controller/shift_entries_controller.php | 22 ++++++-- includes/controller/shifts_controller.php | 34 +++++++++++- includes/controller/shifttypes_controller.php | 23 ++++++-- includes/controller/user_angeltypes_controller.php | 26 ++++++++- .../controller/user_driver_licenses_controller.php | 11 +++- includes/controller/users_controller.php | 63 +++++++++++++++++++--- 9 files changed, 208 insertions(+), 25 deletions(-) (limited to 'includes/controller') diff --git a/includes/controller/angeltypes_controller.php b/includes/controller/angeltypes_controller.php index de4b8a49..12d5287a 100644 --- a/includes/controller/angeltypes_controller.php +++ b/includes/controller/angeltypes_controller.php @@ -2,6 +2,8 @@ /** * Text for Angeltype related links. + * + * @return string */ function angeltypes_title() { @@ -10,15 +12,14 @@ function angeltypes_title() /** * Route angeltype actions. + * + * @return array */ function angeltypes_controller() { $action = strip_request_item('action', 'list'); switch ($action) { - default: - case 'list': - return angeltypes_list_controller(); case 'view': return angeltype_controller(); case 'edit': @@ -27,13 +28,17 @@ function angeltypes_controller() return angeltype_delete_controller(); case 'about': return angeltypes_about_controller(); + case 'list': + default: + return angeltypes_list_controller(); } } /** * Path to angeltype view. * - * @param AngelType $angeltype_id + * @param int $angeltype_id AngelType id + * @return string */ function angeltype_link($angeltype_id) { @@ -42,6 +47,8 @@ function angeltype_link($angeltype_id) /** * Job description for all angeltypes (public to everyone) + * + * @return array */ function angeltypes_about_controller() { @@ -61,6 +68,8 @@ function angeltypes_about_controller() /** * Delete an Angeltype. + * + * @return array */ function angeltype_delete_controller() { @@ -86,6 +95,8 @@ function angeltype_delete_controller() /** * Change an Angeltype. + * + * @return array */ function angeltype_edit_controller() { @@ -151,6 +162,8 @@ function angeltype_edit_controller() /** * View details of a given angeltype. + * + * @return array */ function angeltype_controller() { @@ -182,6 +195,8 @@ function angeltype_controller() /** * View a list of all angeltypes. + * + * @return array */ function angeltypes_list_controller() { @@ -242,6 +257,8 @@ function angeltypes_list_controller() /** * Loads an angeltype from given angeltype_id request param. + * + * @return array */ function load_angeltype() { diff --git a/includes/controller/event_config_controller.php b/includes/controller/event_config_controller.php index 623a2a7a..709d1b2a 100644 --- a/includes/controller/event_config_controller.php +++ b/includes/controller/event_config_controller.php @@ -1,10 +1,16 @@ ' . $user_angeltype['name'] . ' (+' . $user_angeltype['count'] . ')' . ''; + $unconfirmed_links[] = '' . $user_angeltype['name'] + . ' (+' . $user_angeltype['count'] . ')' + . ''; } return sprintf(ngettext("There is %d unconfirmed angeltype.", "There are %d unconfirmed angeltypes.", @@ -25,6 +32,8 @@ function user_angeltypes_unconfirmed_hint() /** * Remove all unconfirmed users from a specific angeltype. + * + * @return array */ function user_angeltypes_delete_all_controller() { @@ -62,6 +71,8 @@ function user_angeltypes_delete_all_controller() /** * Confirm all unconfirmed users for an angeltype. + * + * @return array */ function user_angeltypes_confirm_all_controller() { @@ -105,6 +116,8 @@ function user_angeltypes_confirm_all_controller() /** * Confirm an user for an angeltype. + * + * @return array */ function user_angeltype_confirm_controller() { @@ -165,6 +178,8 @@ function user_angeltype_confirm_controller() /** * Remove a user from an Angeltype. + * + * @return array */ function user_angeltype_delete_controller() { @@ -219,10 +234,13 @@ function user_angeltype_delete_controller() /** * Update an UserAngelType. + * + * @return array */ function user_angeltype_update_controller() { global $privileges; + $supporter = false; if (!in_array('admin_angel_types', $privileges)) { error(_("You are not allowed to set supporter rights.")); @@ -337,6 +355,9 @@ function user_angeltype_add_controller() /** * A user joins an angeltype. + * + * @param array $angeltype + * @return array */ function user_angeltype_join_controller($angeltype) { @@ -375,6 +396,8 @@ function user_angeltype_join_controller($angeltype) /** * Route UserAngelType actions. + * + * @return array */ function user_angeltypes_controller() { @@ -397,5 +420,6 @@ function user_angeltypes_controller() return user_angeltype_add_controller(); default: redirect(page_link_to('angeltypes')); + exit; } } diff --git a/includes/controller/user_driver_licenses_controller.php b/includes/controller/user_driver_licenses_controller.php index a499eff7..f2a1c521 100644 --- a/includes/controller/user_driver_licenses_controller.php +++ b/includes/controller/user_driver_licenses_controller.php @@ -3,6 +3,8 @@ /** * Generates a hint, if user joined angeltypes that require a driving license and the user has no driver license * information provided. + * + * @return string|null */ function user_driver_license_required_hint() { @@ -30,6 +32,8 @@ function user_driver_license_required_hint() /** * Route user driver licenses actions. + * + * @return array */ function user_driver_licenses_controller() { @@ -51,7 +55,8 @@ function user_driver_licenses_controller() /** * Link to user driver license edit page for given user. * - * @param User $user + * @param array $user + * @return string */ function user_driver_license_edit_link($user = null) { @@ -63,6 +68,8 @@ function user_driver_license_edit_link($user = null) /** * Loads the user for the driver license. + * + * @return array */ function user_driver_license_load_user() { @@ -82,6 +89,8 @@ function user_driver_license_load_user() /** * Edit a users driver license information. + * + * @return array */ function user_driver_license_edit_controller() { diff --git a/includes/controller/users_controller.php b/includes/controller/users_controller.php index 4a946aa8..a9f7dd61 100644 --- a/includes/controller/users_controller.php +++ b/includes/controller/users_controller.php @@ -4,6 +4,8 @@ use Engelsystem\ShiftsFilter; /** * Route user actions. + * + * @return array */ function users_controller() { @@ -18,22 +20,22 @@ function users_controller() } switch ($_REQUEST['action']) { - default: - case 'list': - return users_list_controller(); case 'view': return user_controller(); - case 'edit': - return user_edit_controller(); case 'delete': return user_delete_controller(); case 'edit_vouchers': return user_edit_vouchers_controller(); + case 'list': + default: + return users_list_controller(); } } /** * Delete a user, requires to enter own password for reasons. + * + * @return array */ function user_delete_controller() { @@ -85,26 +87,44 @@ function user_delete_controller() ]; } +/** + * @return string + */ function users_link() { return page_link_to('users'); } +/** + * @param array $user + * @return string + */ function user_edit_link($user) { return page_link_to('admin_user') . '&user_id=' . $user['UID']; } +/** + * @param array $user + * @return string + */ function user_delete_link($user) { return page_link_to('users') . '&action=delete&user_id=' . $user['UID']; } +/** + * @param array $user + * @return string + */ function user_link($user) { return page_link_to('users') . '&action=view&user_id=' . $user['UID']; } +/** + * @return array + */ function user_edit_vouchers_controller() { global $privileges, $user; @@ -122,6 +142,7 @@ function user_edit_vouchers_controller() if (isset($_REQUEST['submit'])) { $valid = true; + $vouchers = ''; if (isset($_REQUEST['vouchers']) && test_request_int('vouchers') && trim($_REQUEST['vouchers']) >= 0) { $vouchers = trim($_REQUEST['vouchers']); } else { @@ -151,6 +172,9 @@ function user_edit_vouchers_controller() ]; } +/** + * @return array + */ function user_controller() { global $privileges, $user; @@ -167,7 +191,13 @@ function user_controller() $shifts = Shifts_by_user($user_source, in_array("user_shifts_admin", $privileges)); foreach ($shifts as &$shift) { // TODO: Move queries to model - $shift['needed_angeltypes'] = sql_select("SELECT DISTINCT `AngelTypes`.* FROM `ShiftEntry` JOIN `AngelTypes` ON `ShiftEntry`.`TID`=`AngelTypes`.`id` WHERE `ShiftEntry`.`SID`='" . sql_escape($shift['SID']) . "' ORDER BY `AngelTypes`.`name`"); + $shift['needed_angeltypes'] = sql_select(" + SELECT DISTINCT `AngelTypes`.* + FROM `ShiftEntry` + JOIN `AngelTypes` ON `ShiftEntry`.`TID`=`AngelTypes`.`id` + WHERE `ShiftEntry`.`SID`='" . sql_escape($shift['SID']) . "' + ORDER BY `AngelTypes`.`name` + "); foreach ($shift['needed_angeltypes'] as &$needed_angeltype) { $needed_angeltype['users'] = sql_select(" SELECT `ShiftEntry`.`freeloaded`, `User`.* @@ -198,6 +228,8 @@ function user_controller() /** * List all users. + * + * @return array */ function users_list_controller() { @@ -238,6 +270,8 @@ function users_list_controller() /** * Second step of password recovery: set a new password using the token link from email + * + * @return string */ function user_password_recovery_set_new_controller() { @@ -273,6 +307,8 @@ function user_password_recovery_set_new_controller() /** * First step of password recovery: display a form that asks for your email and send email with recovery link + * + * @return string */ function user_password_recovery_start_controller() { @@ -317,18 +353,22 @@ function user_password_recovery_start_controller() /** * User password recovery in 2 steps. * (By email) + * + * @return string */ function user_password_recovery_controller() { if (isset($_REQUEST['token'])) { return user_password_recovery_set_new_controller(); - } else { - return user_password_recovery_start_controller(); } + + return user_password_recovery_start_controller(); } /** * Menu title for password recovery. + * + * @return string */ function user_password_recovery_title() { @@ -337,6 +377,8 @@ function user_password_recovery_title() /** * Loads a user from param user_id. + * + * return array */ function load_user() { @@ -357,6 +399,10 @@ function load_user() return $user; } +/** + * @param ShiftsFilter $shiftsFilter + * @return ShiftCalendarRenderer + */ function shiftCalendarRendererByShiftFilter(ShiftsFilter $shiftsFilter) { $shifts = Shifts_by_ShiftsFilter($shiftsFilter); @@ -392,6 +438,7 @@ function shiftCalendarRendererByShiftFilter(ShiftsFilter $shiftsFilter) $filtered_shifts = []; foreach ($shifts as $shift) { $needed_angels_count = 0; + $taken = 0; foreach ($needed_angeltypes[$shift['SID']] as $needed_angeltype) { $taken = 0; foreach ($shift_entries[$shift['SID']] as $shift_entry) { -- cgit v1.2.3-70-g09d2