From 1f5a000624117b60e76be0b005049393824fb210 Mon Sep 17 00:00:00 2001 From: Angel Fernando Quiroz Campos Date: Mon, 15 Oct 2018 14:20:41 -0500 Subject: [PATCH] Rename highlighted document to read-out text - refs BT#14334 --- ...ghted_document.png => lp_readout_text.png} | Bin main/inc/lib/api.lib.php | 2 +- .../css/start.css | 0 .../js/start.js | 0 main/lp/learnpath.class.php | 35 ++++++++++-------- main/lp/lp_controller.php | 6 +-- ...hlighted_document.php => readout_text.php} | 6 +-- 7 files changed, 26 insertions(+), 23 deletions(-) rename main/img/{lp_highlighted_document.png => lp_readout_text.png} (100%) rename main/inc/lib/javascript/{highlighted_document => readout_text}/css/start.css (100%) rename main/inc/lib/javascript/{highlighted_document => readout_text}/js/start.js (100%) rename main/lp/{highlighted_document.php => readout_text.php} (93%) diff --git a/main/img/lp_highlighted_document.png b/main/img/lp_readout_text.png similarity index 100% rename from main/img/lp_highlighted_document.png rename to main/img/lp_readout_text.png diff --git a/main/inc/lib/api.lib.php b/main/inc/lib/api.lib.php index f22e6ddd8c..938ab392fa 100644 --- a/main/inc/lib/api.lib.php +++ b/main/inc/lib/api.lib.php @@ -107,7 +107,7 @@ define('SURVEY_VISIBLE_PUBLIC', 2); /* When you add a new tool you must add it into function api_get_tools_lists() too */ define('TOOL_DOCUMENT', 'document'); define('TOOL_LP_FINAL_ITEM', 'final_item'); -define('TOOL_HIGHLIGHTED_DOCUMENT', 'highlighted_document'); +define('TOOL_READOUT_TEXT', 'readout_text'); define('TOOL_THUMBNAIL', 'thumbnail'); define('TOOL_HOTPOTATOES', 'hotpotatoes'); define('TOOL_CALENDAR_EVENT', 'calendar_event'); diff --git a/main/inc/lib/javascript/highlighted_document/css/start.css b/main/inc/lib/javascript/readout_text/css/start.css similarity index 100% rename from main/inc/lib/javascript/highlighted_document/css/start.css rename to main/inc/lib/javascript/readout_text/css/start.css diff --git a/main/inc/lib/javascript/highlighted_document/js/start.js b/main/inc/lib/javascript/readout_text/js/start.js similarity index 100% rename from main/inc/lib/javascript/highlighted_document/js/start.js rename to main/inc/lib/javascript/readout_text/js/start.js diff --git a/main/lp/learnpath.class.php b/main/lp/learnpath.class.php index 3faa079d0d..c86ac443c7 100755 --- a/main/lp/learnpath.class.php +++ b/main/lp/learnpath.class.php @@ -2320,7 +2320,7 @@ class learnpath } } break; - case 'highlighted_document': + case TOOL_READOUT_TEXT:; $autostart_audio = 'false'; break; default: @@ -6262,7 +6262,7 @@ class learnpath $title_cut = cut($arrLP[$i]['title'], self::MAX_LP_ITEM_TITLE_LENGTH); // Link for the documents - if ($arrLP[$i]['item_type'] == 'document' || $arrLP[$i]['item_type'] == TOOL_HIGHLIGHTED_DOCUMENT) { + if ($arrLP[$i]['item_type'] == 'document' || $arrLP[$i]['item_type'] == TOOL_READOUT_TEXT) { $url = $mainUrl.'&action=view_item&mode=preview_document&id='.$arrLP[$i]['id'].'&lp_id='.$this->lp_id; $title_cut = Display::url( $title_cut, @@ -6475,7 +6475,7 @@ class learnpath switch ($arrLP[$i]['item_type']) { case TOOL_DOCUMENT: case TOOL_LP_FINAL_ITEM: - case TOOL_HIGHLIGHTED_DOCUMENT: + case TOOL_READOUT_TEXT: $urlPreviewLink = $mainUrl.'&action=view_item&mode=preview_document&id='.$arrLP[$i]['id'].'&lp_id='.$this->lp_id; $previewIcon = Display::url( $previewImage, @@ -7346,7 +7346,7 @@ class learnpath $return .= $this->getSavedFinalItem(); break; case TOOL_DOCUMENT: - case TOOL_HIGHLIGHTED_DOCUMENT: + case TOOL_READOUT_TEXT: $tbl_doc = Database::get_course_table(TABLE_DOCUMENT); $sql_doc = "SELECT path FROM ".$tbl_doc." WHERE c_id = ".$course_id." AND iid = ".intval($row['path']); @@ -7450,7 +7450,7 @@ class learnpath $row_step ); break; - case TOOL_HIGHLIGHTED_DOCUMENT: + case TOOL_READOUT_TEXT: $tbl_doc = Database::get_course_table(TABLE_DOCUMENT); $sql = "SELECT lp.*, doc.path as dir FROM $tbl_lp_item as lp @@ -7465,7 +7465,7 @@ class learnpath $item_id, $row['item_type'] ); - $return .= $this->displayFrmHighlightedDocument( + $return .= $this->displayFrmReadOutText( 'edit', $item_id, $row_step @@ -9137,7 +9137,7 @@ class learnpath } /** - * Returns the form to update or create a highlighted document. + * Returns the form to update or create a read-out text. * * @param string $action "add" or "edit" * @param int $id ID of the lp_item (if already exists) @@ -9148,7 +9148,7 @@ class learnpath * * @return string HTML form */ - public function displayFrmHighlightedDocument($action = 'add', $id = 0, $extra_info = 'new') + public function displayFrmReadOutText($action = 'add', $id = 0, $extra_info = 'new') { $course_id = api_get_course_int_id(); $_course = api_get_course_info(); @@ -9385,7 +9385,7 @@ class learnpath $item_type = isset($extra_info['item_type']) ? $extra_info['item_type'] : null; $edit = isset($_GET['edit']) ? $_GET['edit'] : null; - if ($extra_info == 'new' || $item_type == TOOL_HIGHLIGHTED_DOCUMENT || $edit == 'true') { + if ($extra_info == 'new' || $item_type == TOOL_READOUT_TEXT || $edit == 'true') { if (!$no_display_edit_textarea) { $content = ''; @@ -9410,6 +9410,9 @@ class learnpath } $form->addTextarea('content_lp', get_lang('Content'), ['rows' => 20]); + $form + ->defaultRenderer() + ->setElementTemplate($form->getDefaultElementTemplate(), 'content_lp'); $form->addButtonSave($text, 'submit_button'); $defaults['content_lp'] = $content; } @@ -9427,7 +9430,7 @@ class learnpath $form->addElement('hidden', 'path', $extra_info['path']); } - $form->addElement('hidden', 'type', TOOL_HIGHLIGHTED_DOCUMENT); + $form->addElement('hidden', 'type', TOOL_READOUT_TEXT); $form->addElement('hidden', 'post_time', time()); $form->setDefaults($defaults); @@ -9445,7 +9448,7 @@ class learnpath * @throws \Doctrine\ORM\OptimisticLockException * @throws \Doctrine\ORM\TransactionRequiredException */ - public function createHighlightedDocument($courseInfo, $content = '', $title = '', $parentId = 0) { + public function createReadOutText($courseInfo, $content = '', $title = '', $parentId = 0) { $creatorId = api_get_user_id(); $sessionId = api_get_session_id(); @@ -10497,7 +10500,7 @@ class learnpath $headers = [ get_lang('Files'), get_lang('CreateTheDocument'), - get_lang('CreateHighlightedDocument'), + get_lang('CreateReadOutText'), get_lang('Upload'), ]; @@ -10569,10 +10572,10 @@ class learnpath $url = api_get_path(WEB_AJAX_PATH).'document.ajax.php?'.api_get_cidreq().'&a=upload_file&curdirpath='; $form->addMultipleUpload($url); $new = $this->display_document_form('add', 0); - $newHighlighted = $this->displayFrmHighlightedDocument('add'); + $frmReadOutText = $this->displayFrmReadOutText('add'); $tabs = Display::tabs( $headers, - [$documentTree, $new, $newHighlighted, $form->returnForm()], + [$documentTree, $new, $frmReadOutText, $form->returnForm()], 'subtab' ); @@ -13369,8 +13372,8 @@ EOD; return $main_dir_path.'forum/viewthread.php?post='.$id.'&thread='.$myrow['thread_id'].'&forum=' .$myrow['forum_id'].'&lp=true&'.$extraParams; - case TOOL_HIGHLIGHTED_DOCUMENT: - return api_get_path(WEB_CODE_PATH).'lp/highlighted_document.php?&id='.$id.'&lp_id='.$learningPathId.'&' + case TOOL_READOUT_TEXT: + return api_get_path(WEB_CODE_PATH).'lp/readout_text.php?&id='.$id.'&lp_id='.$learningPathId.'&' .$extraParams; case TOOL_DOCUMENT: $document = $em diff --git a/main/lp/lp_controller.php b/main/lp/lp_controller.php index deb44a85be..bf89c0eada 100755 --- a/main/lp/lp_controller.php +++ b/main/lp/lp_controller.php @@ -451,11 +451,11 @@ switch ($action) { $description, $prerequisites ); - } elseif ($_POST['type'] == TOOL_HIGHLIGHTED_DOCUMENT) { + } elseif ($_POST['type'] == TOOL_READOUT_TEXT) { if (isset($_POST['path']) && $_GET['edit'] != 'true') { $document_id = $_POST['path']; } else { - $document_id = $_SESSION['oLP']->createHighlightedDocument( + $document_id = $_SESSION['oLP']->createReadOutText( $_course, $_POST['content_lp'], $_POST['title'], @@ -466,7 +466,7 @@ switch ($action) { $new_item_id = $_SESSION['oLP']->add_item( $parent, $previous, - TOOL_HIGHLIGHTED_DOCUMENT, + TOOL_READOUT_TEXT, $document_id, $post_title, $description, diff --git a/main/lp/highlighted_document.php b/main/lp/readout_text.php similarity index 93% rename from main/lp/highlighted_document.php rename to main/lp/readout_text.php index b01d52e654..e291b5217e 100644 --- a/main/lp/highlighted_document.php +++ b/main/lp/readout_text.php @@ -2,7 +2,7 @@ /* For licensing terms, see /license.txt */ /** - * Print a highlighted document inside a session + * Print a read-out text inside a session * * @package chamilo.learnpath */ @@ -68,8 +68,8 @@ $htmlHeadXtra[] = ''; -$htmlHeadXtra[] = api_get_js('highlighted_document/js/start.js'); -$htmlHeadXtra[] = api_get_css(api_get_path(WEB_LIBRARY_JS_PATH).'highlighted_document/css/start.css'); +$htmlHeadXtra[] = api_get_js('readout_text/js/start.js'); +$htmlHeadXtra[] = api_get_css(api_get_path(WEB_LIBRARY_JS_PATH).'readout_text/css/start.css'); $template = new Template(strip_tags($document->getTitle())); $template->display_blank_template();