chamilo /
chamilo-lms
| Conditions | 25 |
| Total Lines | 252 |
| Code Lines | 158 |
| Lines | 0 |
| Ratio | 0 % |
| Changes | 1 | ||
| Bugs | 0 | Features | 0 |
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
| 1 | <?php |
||
| 563 | public static function switchItem($lpId, $user_id, $view_id, $current_item, $next_item) |
||
| 564 | { |
||
| 565 | $debug = 0; |
||
| 566 | $return = ''; |
||
| 567 | if ($debug > 0) { |
||
| 568 | error_log('--------------------------------------'); |
||
| 569 | error_log('SWITCH'); |
||
| 570 | error_log('Params('.$lpId.','.$user_id.','.$view_id.','.$current_item.','.$next_item.')'); |
||
| 571 | } |
||
| 572 | //$objResponse = new xajaxResponse(); |
||
| 573 | /*$item_id may be one of: |
||
| 574 | * -'next' |
||
| 575 | * -'previous' |
||
| 576 | * -'first' |
||
| 577 | * -'last' |
||
| 578 | * - a real item ID |
||
| 579 | */ |
||
| 580 | $mylp = learnpath::getLpFromSession(api_get_course_id(), $lpId, $user_id); |
||
| 581 | $new_item_id = 0; |
||
| 582 | switch ($next_item) { |
||
| 583 | case 'next': |
||
| 584 | $mylp->set_current_item($current_item); |
||
| 585 | $mylp->next(); |
||
| 586 | $new_item_id = $mylp->get_current_item_id(); |
||
| 587 | if ($debug > 1) { |
||
| 588 | error_log('In {next} - next item is '.$new_item_id.'(current: '.$current_item.')'); |
||
| 589 | } |
||
| 590 | break; |
||
| 591 | case 'previous': |
||
| 592 | $mylp->set_current_item($current_item); |
||
| 593 | $mylp->previous(); |
||
| 594 | $new_item_id = $mylp->get_current_item_id(); |
||
| 595 | if ($debug > 1) { |
||
| 596 | error_log('In {previous} - next item is '.$new_item_id.'(current: '.$current_item.')'); |
||
| 597 | } |
||
| 598 | break; |
||
| 599 | case 'first': |
||
| 600 | $mylp->set_current_item($current_item); |
||
| 601 | $mylp->first(); |
||
| 602 | $new_item_id = $mylp->get_current_item_id(); |
||
| 603 | if ($debug > 1) { |
||
| 604 | error_log('In {first} - next item is '.$new_item_id.'(current: '.$current_item.')'); |
||
| 605 | } |
||
| 606 | break; |
||
| 607 | case 'last': |
||
| 608 | break; |
||
| 609 | default: |
||
| 610 | // Should be filtered to check it's not hacked. |
||
| 611 | if ($next_item == $current_item) { |
||
| 612 | // If we're opening the same item again. |
||
| 613 | $mylp->items[$current_item]->restart(); |
||
| 614 | } |
||
| 615 | $new_item_id = $next_item; |
||
| 616 | $mylp->set_current_item($new_item_id); |
||
| 617 | if ($debug > 1) { |
||
| 618 | error_log('In {default} - next item is '.$new_item_id.'(current: '.$current_item.')'); |
||
| 619 | } |
||
| 620 | break; |
||
| 621 | } |
||
| 622 | |||
| 623 | if (WhispeakAuthPlugin::isLpItemMarked($new_item_id)) { |
||
| 624 | ChamiloSession::write( |
||
| 625 | WhispeakAuthPlugin::SESSION_LP_ITEM, |
||
| 626 | ['lp' => $lpId, 'lp_item' => $new_item_id, 'src' => ''] |
||
| 627 | ); |
||
| 628 | } |
||
| 629 | |||
| 630 | $mylp->start_current_item(true); |
||
| 631 | if ($mylp->force_commit) { |
||
| 632 | $mylp->save_current(); |
||
| 633 | } |
||
| 634 | |||
| 635 | if (is_object($mylp->items[$new_item_id])) { |
||
| 636 | $mylpi = $mylp->items[$new_item_id]; |
||
| 637 | } else { |
||
| 638 | if ($debug > 1) { |
||
| 639 | error_log('In switch_item_details - generating new item object', 0); |
||
| 640 | } |
||
| 641 | $mylpi = new learnpathItem($new_item_id, $user_id); |
||
| 642 | $mylpi->set_lp_view($view_id); |
||
| 643 | } |
||
| 644 | /* |
||
| 645 | * now get what's needed by the SCORM API: |
||
| 646 | * -score |
||
| 647 | * -max |
||
| 648 | * -min |
||
| 649 | * -lesson_status |
||
| 650 | * -session_time |
||
| 651 | * -suspend_data |
||
| 652 | */ |
||
| 653 | $myscore = $mylpi->get_score(); |
||
| 654 | $mymax = $mylpi->get_max(); |
||
| 655 | if ('' === $mymax) { |
||
| 656 | $mymax = "''"; |
||
| 657 | } |
||
| 658 | $mymin = $mylpi->get_min(); |
||
| 659 | $mylesson_status = $mylpi->get_status(); |
||
| 660 | $mylesson_location = $mylpi->get_lesson_location(); |
||
| 661 | $mytotal_time = $mylpi->get_scorm_time('js'); |
||
| 662 | $mymastery_score = $mylpi->get_mastery_score(); |
||
| 663 | $mymax_time_allowed = $mylpi->get_max_time_allowed(); |
||
| 664 | $mylaunch_data = $mylpi->get_launch_data(); |
||
| 665 | /* |
||
| 666 | if ($mylpi->get_type() == 'asset') { |
||
| 667 | // Temporary measure to save completion of an asset. Later on, |
||
| 668 | // Chamilo should trigger something on unload, maybe... |
||
| 669 | // (even though that would mean the last item cannot be completed) |
||
| 670 | $mylesson_status = 'completed'; |
||
| 671 | $mylpi->set_status('completed'); |
||
| 672 | $mylpi->save(); |
||
| 673 | } |
||
| 674 | */ |
||
| 675 | $mysession_time = $mylpi->get_total_time(); |
||
| 676 | $mysuspend_data = $mylpi->get_suspend_data(); |
||
| 677 | $mylesson_location = $mylpi->get_lesson_location(); |
||
| 678 | $myic = $mylpi->get_interactions_count(); |
||
| 679 | $myistring = ''; |
||
| 680 | for ($i = 0; $i < $myic; $i++) { |
||
| 681 | $myistring .= ",[".$i.",'','','','','','','']"; |
||
| 682 | } |
||
| 683 | if (!empty($myistring)) { |
||
| 684 | $myistring = substr($myistring, 1); |
||
| 685 | } |
||
| 686 | /* |
||
| 687 | * The following lines should reinitialize the values for the SCO |
||
| 688 | * However, due to many complications, we are now relying more on the |
||
| 689 | * LMSInitialize() call and its underlying lp_ajax_initialize.php call |
||
| 690 | * so this code is technically deprecated (but the change of item_id should |
||
| 691 | * remain). However, due to numerous technical issues with SCORM, we prefer |
||
| 692 | * leaving it as a double-lock security. If removing, please test carefully |
||
| 693 | * with both SCORM and proper learning path tracking. |
||
| 694 | */ |
||
| 695 | $return .= |
||
| 696 | "olms.score=".$myscore.";". |
||
| 697 | "olms.max=".$mymax.";". |
||
| 698 | "olms.min=".$mymin.";". |
||
| 699 | "olms.lesson_status='".$mylesson_status."';". |
||
| 700 | "olms.lesson_location='".$mylesson_location."';". |
||
| 701 | "olms.session_time='".$mysession_time."';". |
||
| 702 | "olms.suspend_data='".$mysuspend_data."';". |
||
| 703 | "olms.total_time = '".$mytotal_time."';". |
||
| 704 | "olms.mastery_score = '".$mymastery_score."';". |
||
| 705 | "olms.max_time_allowed = '".$mymax_time_allowed."';". |
||
| 706 | "olms.launch_data = '".$mylaunch_data."';". |
||
| 707 | "olms.interactions = new Array(".$myistring.");". |
||
| 708 | "olms.item_objectives = new Array();". |
||
| 709 | "olms.G_lastError = 0;". |
||
| 710 | "olms.G_LastErrorMessage = 'No error';". |
||
| 711 | "olms.finishSignalReceived = 0;"; |
||
| 712 | /* |
||
| 713 | * and re-initialise the rest |
||
| 714 | * -lms_lp_id |
||
| 715 | * -lms_item_id |
||
| 716 | * -lms_old_item_id |
||
| 717 | * -lms_new_item_id |
||
| 718 | * -lms_initialized |
||
| 719 | * -lms_progress_bar_mode |
||
| 720 | * -lms_view_id |
||
| 721 | * -lms_user_id |
||
| 722 | */ |
||
| 723 | $mytotal = $mylp->getTotalItemsCountWithoutDirs(); |
||
| 724 | $mycomplete = $mylp->get_complete_items_count(); |
||
| 725 | $myprogress_mode = $mylp->get_progress_bar_mode(); |
||
| 726 | $myprogress_mode = ('' == $myprogress_mode ? '%' : $myprogress_mode); |
||
| 727 | $mynext = $mylp->get_next_item_id(); |
||
| 728 | $myprevious = $mylp->get_previous_item_id(); |
||
| 729 | $myitemtype = $mylpi->get_type(); |
||
| 730 | $mylesson_mode = $mylpi->get_lesson_mode(); |
||
| 731 | $mycredit = $mylpi->get_credit(); |
||
| 732 | $mylaunch_data = $mylpi->get_launch_data(); |
||
| 733 | $myinteractions_count = $mylpi->get_interactions_count(); |
||
| 734 | //$myobjectives_count = $mylpi->get_objectives_count(); |
||
| 735 | $mycore_exit = $mylpi->get_core_exit(); |
||
| 736 | |||
| 737 | $return .= |
||
| 738 | //"saved_lesson_status='not attempted';" . |
||
| 739 | "olms.lms_lp_id=".$lpId.";". |
||
| 740 | "olms.lms_item_id=".$new_item_id.";". |
||
| 741 | "olms.lms_old_item_id=0;". |
||
| 742 | //"lms_been_synchronized=0;" . |
||
| 743 | "olms.lms_initialized=0;". |
||
| 744 | //"lms_total_lessons=".$mytotal.";" . |
||
| 745 | //"lms_complete_lessons=".$mycomplete.";" . |
||
| 746 | //"lms_progress_bar_mode='".$myprogress_mode."';" . |
||
| 747 | "olms.lms_view_id=".$view_id.";". |
||
| 748 | "olms.lms_user_id=".$user_id.";". |
||
| 749 | "olms.next_item=".$new_item_id.";".// This one is very important to replace possible literal strings. |
||
| 750 | "olms.lms_next_item=".$mynext.";". |
||
| 751 | "olms.lms_previous_item=".$myprevious.";". |
||
| 752 | "olms.lms_item_type = '".$myitemtype."';". |
||
| 753 | "olms.lms_item_credit = '".$mycredit."';". |
||
| 754 | "olms.lms_item_lesson_mode = '".$mylesson_mode."';". |
||
| 755 | "olms.lms_item_launch_data = '".$mylaunch_data."';". |
||
| 756 | "olms.lms_item_interactions_count = '".$myinteractions_count."';". |
||
| 757 | "olms.lms_item_objectives_count = '".$myinteractions_count."';". |
||
| 758 | "olms.lms_item_core_exit = '".$mycore_exit."';". |
||
| 759 | "olms.asset_timer = 0;"; |
||
| 760 | |||
| 761 | $sessionId = api_get_session_id(); |
||
| 762 | $updateMinTime = ''; |
||
| 763 | if (Tracking::minimumTimeAvailable($sessionId, api_get_course_int_id())) { |
||
| 764 | $timeLp = $mylp->getAccumulateWorkTime(); |
||
| 765 | $timeTotalCourse = $mylp->getAccumulateWorkTimeTotalCourse(); |
||
| 766 | // Minimum connection percentage |
||
| 767 | $perc = 100; |
||
| 768 | // Time from the course |
||
| 769 | $tc = $timeTotalCourse; |
||
| 770 | // Percentage of the learning paths |
||
| 771 | $pl = 0; |
||
| 772 | if (!empty($timeTotalCourse)) { |
||
| 773 | $pl = $timeLp / $timeTotalCourse; |
||
| 774 | } |
||
| 775 | |||
| 776 | // Minimum time for each learning path |
||
| 777 | $time_total = intval($pl * $tc * $perc / 100) * 60; |
||
| 778 | $lpTimeList = Tracking::getCalculateTime($user_id, api_get_course_int_id(), $sessionId); |
||
| 779 | $lpTime = isset($lpTimeList[TOOL_LEARNPATH][$lpId]) ? $lpTimeList[TOOL_LEARNPATH][$lpId] : 0; |
||
| 780 | |||
| 781 | if ($lpTime >= $time_total) { |
||
| 782 | $time_spent = $time_total; |
||
| 783 | } else { |
||
| 784 | $time_spent = $lpTime; |
||
| 785 | } |
||
| 786 | |||
| 787 | $hour = (intval($lpTime / 3600)) < 10 ? '0'.intval($lpTime / 3600) : intval($lpTime / 3600); |
||
| 788 | $minute = date('i', $lpTime); |
||
| 789 | $second = date('s', $lpTime); |
||
| 790 | $updateMinTime = "update_time_bar('$time_spent','$time_total','%');". |
||
| 791 | "update_chronometer('$hour','$minute','$second');"; |
||
| 792 | } |
||
| 793 | |||
| 794 | $return .= |
||
| 795 | "update_toc('unhighlight','".$current_item."');". |
||
| 796 | "update_toc('highlight','".$new_item_id."');". |
||
| 797 | "update_toc('$mylesson_status','".$new_item_id."');". |
||
| 798 | "update_progress_bar('$mycomplete','$mytotal','$myprogress_mode');". |
||
| 799 | $updateMinTime |
||
| 800 | ; |
||
| 801 | |||
| 802 | //$return .= 'updateGamificationValues(); '; |
||
| 803 | $mylp->set_error_msg(''); |
||
| 804 | $mylp->prerequisites_match(); // Check the prerequisites are all complete. |
||
| 805 | if ($debug > 1) { |
||
| 806 | error_log($return); |
||
| 807 | error_log('Prereq_match() returned '.htmlentities($mylp->error), 0); |
||
| 808 | } |
||
| 809 | // Save the new item ID for the exercise tool to use. |
||
| 810 | Session::write('scorm_item_id', $new_item_id); |
||
| 811 | Session::write('lpobject', serialize($mylp)); |
||
| 812 | Session::write('oLP', $mylp); |
||
| 813 | |||
| 814 | return $return; |
||
| 815 | } |
||
| 818 |
Loading history...
This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.
Consider making the comparison explicit by using
empty(..)or! empty(...)instead.