/**
* Handle showing the box that allows a user to mark a unit as completed.
*/
function WPCW_units_processUnitContent($content)
{
// #### Ensure we're only showing a course unit, a single item
if (!is_single() || 'course_unit' != get_post_type()) {
return $content;
}
global $post;
// #### Get associated data for this unit. No course/module data, not a unit
$parentData = WPCW_units_getAssociatedParentData($post->ID);
if (!$parentData) {
return $content;
}
// #### Ensure we're logged in
$user_id = get_current_user_id();
if ($user_id == 0) {
// Return no access error without content
return WPCW_units_createErrorMessage($parentData->course_message_unit_not_logged_in);
}
$userProgress = new UserProgress($parentData->course_id, $user_id);
// #### User not allowed access to content, so certainly can't say they've done this unit.
if (!$userProgress->canUserAccessCourse()) {
// Return no access error without content
return WPCW_units_createErrorMessage($parentData->course_message_unit_no_access);
}
// #### Is user allowed to access this unit yet?
if (!$userProgress->canUserAccessUnit($post->ID)) {
// Return no access error without content
return WPCW_units_createErrorMessage($parentData->course_message_unit_not_yet);
}
// #### Determine if this unit has been completed or not.
$progressDetails = WPCW_units_getUserUnitDetails($user_id, $post->ID);
$completed = $progressDetails && $progressDetails->unit_completed_status == 'complete';
// #### Show completion box
if ($completed) {
$completionBox = WPCW_units_getCompletionBox_complete($parentData, $post->ID, $user_id);
} else {
$completionBox = WPCW_units_getCompletionBox_pending($parentData, $post->ID);
}
// #### Show the navigation box (disable the next item if not completed yet).
$navigationBox = WPCW_units_getNavigationBox($parentData, $post->ID, $userProgress, !$completed);
return $content . $completionBox . $navigationBox;
}
/**
* Can the user access this particular unit yet?
* @return Boolean True if yes, false otherwise.
*/
function check_user_canUserAccessUnit()
{
return $this->userProgress && $this->userProgress->canUserAccessUnit($this->unitPost->ID);
}
/**
* Function that creates a list of units.
*
* @param Integer $courseID The ID of the course to show.
* @param Array $options The list of options to show.
*/
function WPCW_courses_renderCourseList($courseID, $options)
{
extract(shortcode_atts(array('module' => 0, 'module_desc' => false, 'show_title' => false, 'show_desc' => false, 'widget_mode' => false, 'show_toggle_col' => false, 'show_modules_previous' => 'all', 'show_modules_next' => 'all', 'toggle_modules' => 'expand_all'), $options));
// Check settings to to see if they are true
$module_desc = $module_desc == 'true';
$show_title = $show_title == 'true';
$show_desc = $show_desc == 'true';
$courseDetails = false;
$parentData = false;
global $post;
// Show course based on current location for user. Use the currently shown post
// to work out which course to show using the associated parent data.
if ('current' == $courseID) {
$parentData = WPCW_units_getAssociatedParentData($post->ID);
if ($parentData) {
$courseDetails = WPCW_courses_getCourseDetails($parentData->parent_course_id);
$courseID = $parentData->parent_course_id;
} else {
return false;
}
} else {
// Check course ID is valid
$courseDetails = WPCW_courses_getCourseDetails($courseID);
if (!$courseDetails) {
return __('Unrecognised course ID.', 'wp_courseware');
}
// Course ID is fine, get associated parent data for
// hiding aspects of the widget
$parentData = WPCW_units_getAssociatedParentData($post->ID);
}
$moduleList = false;
// Do we just want a single module?
if ($module > 0) {
// Get module by module number within course (not the module ID)
$moduleDetailsSingle = WPCW_modules_getModuleDetails_byModuleNumber($courseDetails->course_id, $module);
if (!$moduleDetailsSingle) {
return __('Could not find module.', 'wp_courseware');
}
// Create module list of 1 using single module
$moduleList[$moduleDetailsSingle->module_id] = $moduleDetailsSingle;
} else {
// Check there are modules
$moduleList = WPCW_courses_getModuleDetailsList($courseID);
if (!$moduleList) {
return __('There are no modules in this training course.', 'wp_courseware');
}
}
$html = false;
// #### Show course title/description
if ($show_title) {
$html .= sprintf('<div class="wpcw_fe_course_title">%s</div>', $courseDetails->course_title);
}
if ($show_desc) {
$html .= sprintf('<div class="wpcw_fe_course_desc">%s</div>', $courseDetails->course_desc);
}
$html .= '<table id="wpcw_fe_course" cellspacing="0" cellborder="0">';
$showUnitLinks = false;
// If true, show links to the units
$colCount = 2;
// Number of columns in the table
// UP Object to determine what to show to the user.
$userProgress = false;
// Check user is logged in, and if they can access this course
$user_id = get_current_user_id();
if ($user_id != 0) {
$userProgress = new UserProgress($courseID, $user_id);
// Show links for user if they are allowed to access this course.
if ($userProgress->canUserAccessCourse()) {
// User is logged in and can do course, so show the stuff they can do.
$showUnitLinks = true;
// Got an extra column to show progress
$colCount = 3;
}
}
// If we're showing a widget, and we have the parent data based on the
// currently viewed unit, then change what's in the widget in terms
// of previous/next units.
$hideList = array();
if ($widget_mode && $module == 0 && $parentData) {
// Build a list of the modules before and after the current
// module, so that we can more easily control what's visible,
// and what's not.
$modulesBefore = array();
$modulesAfter = array();
$currentList =& $modulesBefore;
foreach ($moduleList as $moduleID => $moduleObj) {
// Switch lists, we've found the current module
if ($moduleID == $parentData->parent_module_id) {
$currentList =& $modulesAfter;
} else {
$currentList[] = $moduleID;
}
}
// Handle showing previous modules
switch ($show_modules_previous) {
// All all items in the before list to be hidden
case 'none':
$hideList = array_merge($hideList, $modulesBefore);
break;
case 'all':
break;
// Keep a specific number of modules to show.
// Keep a specific number of modules to show.
default:
$show_modules_previous += 0;
$modulesToPickFrom = count($modulesBefore);
// Remove the modules at the start of the list, leaving the right number of
// $show_modules_previous modules in the list.
if ($show_modules_previous > 0 && $modulesToPickFrom > $show_modules_previous) {
$hideList = array_merge($hideList, array_slice($modulesBefore, 0, $modulesToPickFrom - $show_modules_previous));
}
break;
}
// end switch
// Handle showing the next modules.
switch ($show_modules_next) {
// All all items in the after list to be hidden
case 'none':
$hideList = array_merge($hideList, $modulesAfter);
break;
case 'all':
break;
// Keep a specific number of modules to show.
// Keep a specific number of modules to show.
default:
$show_modules_next += 0;
$modulesToPickFrom = count($modulesAfter);
// Remove the modules at the start of the list, leaving the right number of
// $show_modules_previous modules in the list.
if ($show_modules_next > 0 && $modulesToPickFrom > $show_modules_next) {
$hideList = array_merge($hideList, array_slice($modulesAfter, $show_modules_next));
}
break;
}
// end switch
}
// Columns for marking item as being pending or complete.
$progress_Complete = '<td class="wpcw_fe_unit_progress wpcw_fe_unit_progress_complete"><span> </span></td>';
$progress_Pending = '<td class="wpcw_fe_unit_progress wpcw_fe_unit_progress_incomplete"><span> </span></td>';
$progress_Blank = '<td class="wpcw_fe_unit_progress"><span> </span></td>';
// Show modules
foreach ($moduleList as $moduleID => $moduleObj) {
// See if we're skipping this module
if (in_array($moduleID, $hideList)) {
continue;
}
// If $collapseTitleArea is set to true, then the module will be collapsed. So just check what to hide
// based on the contents of $toggle_modules
$collapseTitleArea = false;
if ($widget_mode && $parentData) {
switch ($toggle_modules) {
case 'contract_all':
$collapseTitleArea = true;
break;
// See if the currently visible unit module is the one being rendered.
// See if the currently visible unit module is the one being rendered.
case 'contract_all_but_current':
$collapseTitleArea = $moduleID != $parentData->parent_module_id;
break;
// Default is not to collapse.
}
}
// We're showing the toggle section, so add it.
if ($show_toggle_col) {
$moduleTitleArea = false;
$moduleTitleArea = sprintf('<td>%s</td><td class="wpcw_fe_toggle">%s</td>', $moduleObj->module_title, $collapseTitleArea ? '+' : '-');
} else {
$moduleTitleArea = sprintf('<td colspan="%d">%s</td>', $colCount - 1, $moduleObj->module_title);
}
// Render final title bit
$html .= sprintf('<tr class="wpcw_fe_module %s" id="wpcw_fe_module_group_%d">
<td>%s %d</td>
' . $moduleTitleArea . '
</tr>', $collapseTitleArea ? 'wpcw_fe_module_toggle_hide' : '', $moduleObj->module_number, __('Module', 'wp_courseware'), $moduleObj->module_number, $moduleTitleArea);
// ### Showing the module descriptions?
if ($module_desc) {
$html .= sprintf('<tr class="wpcw_fe_module_des"><td colspan="%d">%s</td></tr>', $colCount, $moduleObj->module_desc);
}
// Add the class for the row that matches the parent module ID.
$moduleRowClass = ' wpcw_fe_module_group_' . $moduleObj->module_number;
// ### No Units Line
$units = WPCW_units_getListOfUnits($moduleID);
if (!$units) {
$extraColSpan = 0;
if ($show_toggle_col) {
$extraColSpan = 1;
}
$html .= sprintf('<tr class="wpcw_fe_unit wpcw_fe_unit_none %s">
<td colspan="%d">%s</td>
</tr>', $moduleRowClass, $colCount + $extraColSpan, __('There are no units in this module.', 'wp_courseware'));
} else {
// Render each unit
foreach ($units as $unit) {
$progressRow = false;
$progressCol = false;
// Show links for units
if ($showUnitLinks) {
// Yes we are showing progress data... see what state we're at.
if ($userProgress) {
if ($userProgress->isUnitCompleted($unit->ID)) {
$progressCol = $progress_Complete;
$progressRow = 'wpcw_fe_unit_complete';
} else {
$progressCol = $progress_Pending;
$progressRow = 'wpcw_fe_unit_pending';
}
//$progressCol = ($userProgress->isUnitCompleted($unit->ID) ? $progress_Complete : $progress_Pending);
}
// See if the user is allowed to access this unit or not.
if ($userProgress->canUserAccessUnit($unit->ID)) {
// Main unit title, link and unit number
$html .= sprintf('
<tr class="wpcw_fe_unit ' . $progressRow . $moduleRowClass . '">
<td>%s %d</td>
<td class="wpcw_fe_unit"><a href="%s">%s</a></td>
' . $progressCol . '
</tr>', __('Unit', 'wp_courseware'), $unit->unit_meta->unit_number, get_permalink($unit->ID), $unit->post_title);
} else {
// If we're not allowed to access the unit, then it's always marked as pending.
$html .= sprintf('
<tr class="wpcw_fe_unit ' . $progressRow . $moduleRowClass . '">
<td>%s %d</td>
<td class="wpcw_fe_unit">%s</td>
' . $progress_Pending . '
</tr>', __('Unit', 'wp_courseware'), $unit->unit_meta->unit_number, $unit->post_title);
}
} else {
$colspan = 1;
if ($show_toggle_col) {
$colspan = 2;
}
$html .= sprintf('
<tr class="wpcw_fe_unit ' . $progressRow . $moduleRowClass . '">
<td>%s %d</td>
<td colspan="%d" class="wpcw_fe_unit">%s</td>
</tr>', __('Unit', 'wp_courseware'), $unit->unit_meta->unit_number, $colspan, $unit->post_title);
}
}
}
// end show units
}
$html .= '</table>';
// Add powered by link
$settings = TidySettings_getSettings(WPCW_DATABASE_SETTINGS_KEY);
$html .= WPCW_generatedPoweredByLink($settings);
return $html;
}
