class OpignoGroupManagerController in Opigno group manager 8
Same name and namespace in other branches
- 3.x src/Controller/OpignoGroupManagerController.php \Drupal\opigno_group_manager\Controller\OpignoGroupManagerController
Controller for all the actions of the Opigno group manager app.
Hierarchy
- class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\opigno_group_manager\Controller\OpignoGroupManagerController
Expanded class hierarchy of OpignoGroupManagerController
File
- src/
Controller/ OpignoGroupManagerController.php, line 40
Namespace
Drupal\opigno_group_manager\ControllerView source
class OpignoGroupManagerController extends ControllerBase {
/**
* Opigno group content type manager.
*
* @var \Drupal\opigno_group_manager\OpignoGroupContentTypesManager
*/
private $content_types_manager;
/**
* Database connection.
*
* @var \Drupal\Core\Database\Connection
*/
protected $database;
/**
* {@inheritdoc}
*/
public function __construct(OpignoGroupContentTypesManager $content_types_manager, Connection $database) {
$this->content_types_manager = $content_types_manager;
$this->database = $database;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('opigno_group_manager.content_types.manager'), $container
->get('database'));
}
/**
* Root page for angular app.
*/
public function index(Group $group, Request $request) {
// Check if user has uncompleted steps.
LearningPathValidator::stepsValidate($group);
if ($group instanceof GroupInterface) {
$current_step = opigno_learning_path_get_current_step();
$next_step = $current_step < 5 ? $current_step + 1 : NULL;
$link_text = !$next_step ? $this
->t('Publish') : $this
->t('Next');
$next_link = Link::createFromRoute($link_text, 'opigno_learning_path.content_steps', [
'group' => $group
->id(),
'current' => $current_step ? $current_step : 0,
], [
'attributes' => [
'class' => [
'btn',
'btn-success',
'color-white',
],
],
])
->toRenderable();
}
$tempstore = \Drupal::service('user.private_tempstore')
->get('opigno_group_manager');
return [
'#theme' => 'opigno_group_manager',
'#attached' => [
'library' => [
'opigno_group_manager/manage_app',
],
],
'#base_path' => $request
->getBasePath(),
'#base_href' => $request
->getPathInfo(),
'#group_id' => $group
->id(),
'#next_link' => isset($next_link) ? render($next_link) : NULL,
'#user_has_info_card' => $tempstore
->get('hide_info_card') ? FALSE : TRUE,
'#text_add_a_link' => $this
->t('add a link')
->render(),
'#text_add_your_first_item' => $this
->t('Add your first item')
->render(),
'#text_guided_navigation' => $this
->t('Guided navigation')
->render(),
'#text_free_navigation' => $this
->t('Free navigation')
->render(),
'#text_if_entity_dropped_under_children' => $this
->t('Cannot drop under or at the same level as children, move children before')
->render(),
'#text_cannot_drop_over_or_at_the_same_level' => $this
->t('Cannot drop over or at the same level as parent')
->render(),
'#text_click_now_on_the_two_steps_of_your_training' => $this
->t('Click now on the two steps of your training to be linked in order to create the link')
->render(),
'#text_status_message' => $this
->t('Status message')
->render(),
'#text_conditions' => $this
->t('Conditions')
->render(),
'#text_score' => $this
->t('Score:')
->render(),
'#text_edit' => $this
->t('edit')
->render(),
'#text_delete' => $this
->t('delete')
->render(),
'#text_last_step' => $this
->t('Last step:')
->render(),
'#text_add' => $this
->t('add')
->render(),
'#text_validate' => $this
->t('Validate')
->render(),
'#text_cancel' => $this
->t('cancel')
->render(),
'#text_delete_link' => $this
->t('delete link')
->render(),
'#text_this_action_create_an_orphan' => $this
->t('This action create an orphan, confirm:')
->render(),
'#text_confirm' => $this
->t('confirm')
->render(),
'#language_prefix' => opigno_group_manager_get_language_prefix(),
];
}
/**
* Returns next link.
*/
public function getNextLink(Group $group) {
$next_link = NULL;
if ($group instanceof GroupInterface) {
$current_step = opigno_learning_path_get_current_step();
$next_step = $current_step < 5 ? $current_step + 1 : NULL;
$link_text = !$next_step ? $this
->t('Publish') : $this
->t('Next');
$next_link = Link::createFromRoute($link_text, 'opigno_learning_path.content_steps', [
'group' => $group
->id(),
'current' => $current_step ? $current_step : 0,
], [
'attributes' => [
'class' => [
'btn',
'btn-success',
'color-white',
],
],
])
->toRenderable();
}
return $next_link;
}
/**
* Method called when the LP manager needs a create or edit form.
*/
public function getItemForm(Group $group, $type = NULL, $item = 0) {
// Get the good form from the corresponding content type.
$content_type = $this->content_types_manager
->createInstance($type);
$form = $content_type
->getFormObject($item);
if ($type === 'ContentTypeModule' && $item !== NULL && ($module = OpignoModule::load($item)) !== NULL) {
/** @var \Drupal\opigno_module\Entity\OpignoModuleInterface $module */
if (!$module
->access('update')) {
throw new AccessDeniedHttpException();
}
}
elseif ($type === 'ContentTypeCourse' && $item !== NULL && ($group = Group::load($item)) !== NULL) {
/** @var \Drupal\group\Entity\GroupInterface $group */
if (!$group
->access('update')) {
throw new AccessDeniedHttpException();
}
}
// Add parent learning path id to the form
// in the case if current group is a course.
$keys = \Drupal::request()->query
->keys();
if ($keys && in_array('learning_path', $keys)) {
$learning_path = \Drupal::request()->query
->get('learning_path');
}
// Adds some information used
// in the method opigno_learning_path_form_alter().
$form_build = \Drupal::formBuilder()
->getForm($form, [
'opigno_group_info' => [
'group_id' => $group ? $group
->id() : NULL,
'opigno_group_content_type' => $type,
'learning_path' => isset($learning_path) ? $learning_path : NULL,
],
]);
// Returns the form.
return $form_build;
}
/**
* Form ajax callback.
*/
public static function ajaxFormEntityCallback(&$form, FormStateInterface $form_state) {
$response = new AjaxResponse();
// If errors, returns the form with errors and messages.
if ($form_state
->hasAnyErrors()) {
// Add class for displaying form errors in iframe.
$form['#attributes']['class'][] = 'lp-content-item-errors';
return $form;
}
$entity = $form_state
->getBuildInfo()['callback_object']
->getEntity();
// Load image.
if ($entity
->hasField('field_course_media_image')) {
$image_field = 'field_course_media_image';
}
elseif ($entity
->hasField('module_media_image')) {
$image_field = 'module_media_image';
}
if ($entity
->hasField($image_field)) {
$media = $entity
->get($image_field)->entity;
$file = isset($media) ? File::load($media
->get('field_media_image')->target_id) : NULL;
}
$item = [];
$item['cid'] = $entity
->id();
$item['contentType'] = \Drupal::routeMatch()
->getParameter('type');
$item['entityId'] = $entity
->id();
$item['entityBundle'] = \Drupal::routeMatch()
->getParameter('type');
$item['title'] = $entity
->label();
$item['imageUrl'] = isset($file) && $file ? file_create_url($file
->getFileUri()) : self::getDefaultBundleImageUrl($entity
->bundle());
$item['in_skills_system'] = FALSE;
$item['isMandatory'] = FALSE;
if ($item['contentType'] == 'ContentTypeModule') {
$item['in_skills_system'] = $entity
->getSkillsActive();
$group = \Drupal::routeMatch()
->getParameter('group');
$managed_contents = OpignoGroupManagedContent::loadByProperties([
'group_content_type_id' => 'ContentTypeModule',
'group_id' => $group
->id(),
'entity_id' => $entity
->id(),
]);
if (!empty($managed_contents)) {
$content = reset($managed_contents);
$item['isMandatory'] = $content
->isMandatory();
}
}
$response
->addCommand(new SettingsCommand([
'formValues' => $item,
'messages' => \Drupal::messenger()
->all(),
], TRUE));
\Drupal::messenger()
->deleteAll();
return $response;
}
/**
* Submit handler added by opigno_learning_path_form_alter().
*
* @see opigno_learning_path_form_alter()
*/
public static function ajaxFormEntityFormSubmit($form, FormState &$form_state) {
// Gets back the content type and learning path id.
$build_info = $form_state
->getBuildInfo();
foreach ($build_info['args'][0] as $arg_key => $arg_value) {
if ($arg_key === 'opigno_group_info') {
$lp_id = $arg_value['group_id'];
$lp_content_type_id = $arg_value['opigno_group_content_type'];
break;
}
}
// If one information missing, return an error.
if (!isset($lp_id) || !isset($lp_content_type_id)) {
// TODO: Add an error message here.
return;
}
// Get the newly or edited entity.
$entity = $build_info['callback_object']
->getEntity();
$moduleHandler = \Drupal::service('module_handler');
if ($moduleHandler
->moduleExists('opigno_skills_system') && $lp_content_type_id == 'ContentTypeModule') {
$managed_contents = OpignoGroupManagedContent::loadByProperties([
'group_content_type_id' => 'ContentTypeModule',
'group_id' => $lp_id,
'entity_id' => $entity
->id(),
]);
if (!empty($managed_contents)) {
$content = reset($managed_contents);
$content
->setSkillSystem($entity
->getSkillsActive());
if ($entity
->getSkillsActive()) {
$content
->setMandatory(0);
}
$content
->save();
}
}
// Clear user input.
$input = $form_state
->getUserInput();
// We should not clear the system items from the user input.
$clean_keys = $form_state
->getCleanValueKeys();
$clean_keys[] = 'ajax_page_state';
foreach ($input as $key => $item) {
if (!in_array($key, $clean_keys) && substr($key, 0, 1) !== '_') {
unset($input[$key]);
}
}
// Store new entity for display in the AJAX callback.
$input['entity'] = $entity;
$form_state
->setUserInput($input);
// Rebuild the form state values.
$form_state
->setRebuild();
$form_state
->setStorage([]);
}
/**
* Method called when a step is set as mandatory or not.
*/
public function updateItemMandatory(Group $group, Request $request) {
// Get the data and ensure that all data are okay.
$datas = json_decode($request
->getContent());
if (empty($datas->cid) || isset($datas->isMandatory) === FALSE) {
return new JsonResponse(NULL, Response::HTTP_BAD_REQUEST);
}
$cid = $datas->cid;
$mandatory = $datas->isMandatory;
// Load the good content, update it and save it.
$content = OpignoGroupManagedContent::load($cid);
$content
->setMandatory($mandatory);
$content
->save();
// Finally, return the JSON response.
return new JsonResponse(NULL, Response::HTTP_OK);
}
/**
* Method called when an item success score is set or not.
*/
public function updateItemMinScore(Group $group, Request $request) {
// Ensure all data are okay.
$datas = json_decode($request
->getContent());
if (empty($datas->cid)) {
return new JsonResponse(NULL, Response::HTTP_BAD_REQUEST);
}
$cid = $datas->cid;
$success_score_min = empty($datas->successScoreMin) ? 0 : $datas->successScoreMin;
// Update the item.
$content = OpignoGroupManagedContent::load($cid);
$content
->setSuccessScoreMin($success_score_min);
$content
->save();
// Return the JSON response.
return new JsonResponse(NULL, Response::HTTP_OK);
}
/**
* This method is called on learning path load.
*
* It returns all the steps and their links in JSON format.
*/
public function getItems(Group $group) {
$courses_storage = \Drupal::entityTypeManager()
->getStorage('group');
// Init the response and get all the contents from this learning path.
$entities = [];
$managed_contents = OpignoGroupManagedContent::loadByProperties([
'group_id' => $group
->id(),
]);
// TODO: Maybe extend the class LPManagedContent
// with LearningPathContent
// (and use Parent::__constructor() to fill the params).
// Convert all the LPManagedContent to LearningPathContent
// and convert it to an array.
foreach ($managed_contents as $managed_content) {
// Need the content type object to get the LearningPathContent object.
$content_type_id = $managed_content
->getGroupContentTypeId();
$content_type = $this->content_types_manager
->createInstance($content_type_id);
$lp_content = $content_type
->getContent($managed_content
->getEntityId());
if ($lp_content === FALSE) {
continue;
}
// Create the array that is ready for JSON.
$manager_array = $lp_content
->toManagerArray($managed_content);
if ($lp_content
->getGroupContentTypeId() == 'ContentTypeCourse') {
$course = $courses_storage
->load($lp_content
->getEntityId());
$group_content = $course
->getContent('opigno_module_group');
$manager_array['modules_count'] = count($group_content);
}
// Add translatable values into Angular.
switch ($lp_content
->getGroupContentTypeId()) {
case 'ContentTypeCourse':
$manager_array['translate']['content_type_title'] = $this
->t('Course')
->render();
break;
case 'ContentTypeModule':
$manager_array['translate']['content_type_title'] = $this
->t('Opigno module')
->render();
break;
case 'ContentTypeMeeting':
$manager_array['translate']['content_type_title'] = $this
->t('Live meeting')
->render();
break;
case 'ContentTypeILT':
$manager_array['translate']['content_type_title'] = $this
->t('Instructor-Led Training')
->render();
break;
}
$manager_array['translate']['text_close'] = $this
->t('close')
->render();
$manager_array['translate']['text_add_a_new_item'] = $this
->t('Click here to add a new item')
->render();
$manager_array['translate']['text_do_not_show_this_message_again'] = $this
->t('Do not show this message again')
->render();
$manager_array['translate']['text_modules'] = $this
->t('modules')
->render();
$manager_array['translate']['text_module'] = $this
->t('module')
->render();
$manager_array['translate']['text_add'] = $this
->t('add')
->render();
$manager_array['translate']['text_score'] = $this
->t('score')
->render();
$manager_array['translate']['text_update'] = $this
->t('update')
->render();
$manager_array['translate']['text_delete'] = $this
->t('delete')
->render();
$manager_array['translate']['text_mandatory'] = $this
->t('Mandatory')
->render();
$manager_array['translate']['text_minimum_score_to_validate_step'] = $this
->t('Minimum score to validate step')
->render();
$entities[] = $manager_array;
}
// Return all the contents in JSON format.
return new JsonResponse($entities, Response::HTTP_OK);
}
/**
* This function is called on learning path load.
*
* It return the coordinates of every steps.
*
* @param \Drupal\group\Entity\Group $group
* Group object.
*
* @return \Symfony\Component\HttpFoundation\JsonResponse
* Response.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
public function getPositions(Group $group) {
// Get the positions from DB.
$entityPositions = [];
try {
$managed_contents = OpignoGroupManagedContent::loadByProperties([
'group_id' => $group
->id(),
]);
} catch (InvalidPluginDefinitionException $e) {
return new JsonResponse(NULL, Response::HTTP_INTERNAL_SERVER_ERROR);
}
// Then, create a big array with the positions and return OK.
foreach ($managed_contents as $managed_content) {
// Check if it's not deleted.
$content_type_id = $managed_content
->getGroupContentTypeId();
$content_type = $this->content_types_manager
->createInstance($content_type_id);
$lp_content = $content_type
->getContent($managed_content
->getEntityId());
if ($lp_content === FALSE) {
continue;
}
$entityPositions[] = [
'cid' => $managed_content
->id(),
'col' => $managed_content
->getCoordinateX() ? $managed_content
->getCoordinateX() : 1,
'row' => $managed_content
->getCoordinateY() ? $managed_content
->getCoordinateY() : 1,
];
}
return new JsonResponse($entityPositions, Response::HTTP_OK);
}
/**
* Called after each update on learning path structure (add/remove/move node).
*
* It update the position of a content.
*/
public function setPositions(Request $request) {
// Get the data and check if it's correct.
$datas = json_decode($request
->getContent());
if (empty($datas->mainItemPositions)) {
return new JsonResponse(NULL, Response::HTTP_BAD_REQUEST);
}
$content_positions = $datas->mainItemPositions;
// Then, for each content, update the position in DB and return OK.
foreach ($content_positions as $content_position) {
$content = OpignoGroupManagedContent::load($content_position->cid);
if (empty($content)) {
continue;
}
$content
->setCoordinateX($content_position->col);
$content
->setCoordinateY($content_position->row);
$content
->save();
}
return new JsonResponse(NULL, Response::HTTP_OK);
}
/**
* Checking if the group contain item.
*
* @param int $group_id
* @param int $entity_id
* @param string $content_type
*
* @return bool
*/
protected function hasItem($group_id, $entity_id, $content_type) {
if (empty($group_id) || empty($entity_id) || empty($content_type)) {
return FALSE;
}
$query = $this->database
->select('opigno_group_content', 'gc')
->condition('gc.group_id', $group_id)
->condition('gc.group_content_type_id', $content_type)
->condition('gc.entity_id', $entity_id)
->fields('gc', [
'id',
]);
$result = $query
->execute()
->fetchField();
if (!empty($result)) {
return TRUE;
}
return FALSE;
}
/**
* This method adds an item (content) in the learning path.
*/
public function addItem(Group $group, Request $request) {
$moduleHandler = \Drupal::service('module_handler');
// First, check if all parameters are here.
$datas = json_decode($request
->getContent());
$entity_id = !empty($datas->entityId) ? $datas->entityId : 0;
$content_type = !empty($datas->contentType) ? $datas->contentType : 0;
$exist = $this
->hasItem($group
->id(), $entity_id, $content_type);
if ($exist) {
return new JsonResponse(NULL, Response::HTTP_OK);
}
if (empty($datas->entityId) || empty($datas->contentType)) {
return new JsonResponse(NULL, Response::HTTP_BAD_REQUEST);
}
// Get the params.
$entityId = $datas->entityId;
$contentType = $datas->contentType;
$parentCid = empty($datas->parentCid) ? NULL : $datas->parentCid;
// Create the added item as an LP content.
$new_content = OpignoGroupManagedContent::createWithValues($group
->id(), $contentType, $entityId);
// Check if the content type is a module.
// If yes then check if the module in the skills system.
if ($moduleHandler
->moduleExists('opigno_skills_system') && $contentType === 'ContentTypeModule') {
$module = \Drupal::entityTypeManager()
->getStorage('opigno_module')
->load($entityId);
$new_content
->set('in_skills_system', $module
->getSkillsActive());
}
$new_content
->save();
// Then, create the links to the parent content.
if (!empty($parentCid)) {
OpignoGroupManagedLink::createWithValues($group
->id(), $parentCid, $new_content
->id())
->save();
}
// Add created entity as Group content.
$plugin_definition = $this->content_types_manager
->getDefinition($datas->contentType);
if (!empty($plugin_definition['group_content_plugin_id'])) {
// Load Course (Group) entity and save as content using specific plugin.
$added_entity = \Drupal::entityTypeManager()
->getStorage($plugin_definition['entity_type'])
->load($datas->entityId);
$group
->addContent($added_entity, $plugin_definition['group_content_plugin_id']);
}
$response = new JsonResponse([
'cid' => $new_content
->id(),
], Response::HTTP_OK);
sleep(1);
return $response;
}
/**
* Remove item from learning path.
*/
public function removeItem(Request $request) {
// Get and check the params of the ajax request.
$datas = json_decode($request
->getContent());
if (empty($datas->cid)) {
return new JsonResponse(NULL, Response::HTTP_BAD_REQUEST);
}
$cid = $datas->cid;
// Load Learning path content entity.
$lp_content_entity = OpignoGroupManagedContent::load($cid);
$learning_path_plugin = $lp_content_entity
->getGroupContentType();
$plugin_definition = $this->content_types_manager
->getDefinition($learning_path_plugin
->getPluginId());
if (!empty($plugin_definition['group_content_plugin_id'])) {
$lp_group = \Drupal::entityTypeManager()
->getStorage('group')
->load($lp_content_entity
->get('group_id')->entity
->id());
// Remove Learning path course if it's exist.
$group_contents = $lp_group
->getContentByEntityId($plugin_definition['group_content_plugin_id'], $lp_content_entity
->get('entity_id')->value);
if (!empty($group_contents)) {
// Probably, there can be a few same items. Get only last.
$group_content = end($group_contents);
$group_content
->delete();
}
}
// Then delete the content and return OK.
$lp_content_entity
->delete();
return new JsonResponse(NULL, Response::HTTP_OK);
}
/**
* Add a new link in the Learning Path.
*/
public function addLink(Group $group, Request $request) {
// First, check if all params are okay.
$datas = json_decode($request
->getContent());
if (empty($datas->parentCid) || empty($datas->childCid)) {
return new JsonResponse(NULL, Response::HTTP_BAD_REQUEST);
}
// Get the request params.
$parentCid = $datas->parentCid;
$childCid = $datas->childCid;
// Create the new link and return OK.
$new_link = OpignoGroupManagedLink::createWithValues($group
->id(), $parentCid, $childCid, 0);
$new_link
->save();
return new JsonResponse(NULL, Response::HTTP_OK);
}
/**
* Update a link minimum score to go to next step.
*/
public function updateLink(Group $group, Request $request) {
// First, check the params.
$datas = json_decode($request
->getContent());
if (empty($datas->parentCid) || empty($datas->childCid)) {
return new JsonResponse(NULL, Response::HTTP_BAD_REQUEST);
}
// Then get the params.
$parentCid = $datas->parentCid;
$childCid = $datas->childCid;
$requiredScore = !empty($datas->requiredScore) ? $datas->requiredScore : 0;
$requiredActivities = !empty($datas->requiredActivities) ? serialize($datas->requiredActivities) : NULL;
// Get the links that use the same LP ID,
// parent CID and child CID. Should be only one.
try {
$links = OpignoGroupManagedLink::loadByProperties([
'group_id' => $group
->id(),
'parent_content_id' => $parentCid,
'child_content_id' => $childCid,
]);
} catch (InvalidPluginDefinitionException $e) {
return new JsonResponse(NULL, Response::HTTP_INTERNAL_SERVER_ERROR);
}
// If no link returned, create it and return OK.
if (empty($links)) {
$new_link = OpignoGroupManagedLink::createWithValues($group
->id(), $parentCid, $childCid, $requiredScore, $requiredActivities);
$new_link
->save();
return new JsonResponse(NULL, Response::HTTP_OK);
}
// If the link is found, update it and return OK.
foreach ($links as $link) {
$link
->setRequiredScore($requiredScore);
$link
->setRequiredActivities($requiredActivities);
$link
->save();
}
return new JsonResponse(NULL, Response::HTTP_OK);
}
/**
* Removes a link.
*/
public function removeLink(Group $group, Request $request) {
// First, check that the params are okay.
$datas = json_decode($request
->getContent());
if (empty($datas->parentCid) || empty($datas->childCid)) {
return new JsonResponse(NULL, Response::HTTP_BAD_REQUEST);
}
// Get the params.
$parentCid = $datas->parentCid;
$childCid = $datas->childCid;
// Get the links. Should be only one.
try {
$links = OpignoGroupManagedLink::loadByProperties([
'group_id' => $group
->id(),
'parent_content_id' => $parentCid,
'child_content_id' => $childCid,
]);
} catch (InvalidPluginDefinitionException $e) {
return new JsonResponse(NULL, Response::HTTP_INTERNAL_SERVER_ERROR);
}
// Delete the links and return OK.
foreach ($links as $link) {
$link
->delete();
}
return new JsonResponse(NULL, Response::HTTP_OK);
}
/**
* Return contents availables when you want add content to learning path.
*
* @param int $mainItem
* The main level content ID.
*
* @return \Symfony\Component\HttpFoundation\JsonResponse
* Response.
*
* @throws \Drupal\Component\Plugin\Exception\PluginException
*/
public function getAvailableItems($mainItem = NULL) {
// Init the return array and get all the content types available.
$available_contents = [];
$content_types_definitions = $this->content_types_manager
->getDefinitions();
// For each content type,
// get the available contents from them and store it in the return array.
foreach ($content_types_definitions as $content_type_id => $content_type_definition) {
// Get the available contents from the content type.
$content_type = $this->content_types_manager
->createInstance($content_type_id);
$content_type_contents = $content_type
->getAvailableContents();
// For each content, convert it to an array.
foreach ($content_type_contents as $content_type_content) {
$available_contents[] = $content_type_content
->toManagerArray();
}
}
// Return the available contents in JSON.
return new JsonResponse($available_contents, Response::HTTP_OK);
}
/**
* Return content types available for learning paths.
*
* @param \Drupal\group\Entity\Group $group
* Group object.
* @param bool $json_output
* JSON format flag.
*
* @return array|\Symfony\Component\HttpFoundation\JsonResponse
* Response.
*/
public function getItemTypes(Group $group, $json_output = TRUE) {
// Init the return array and get all the content types available.
$available_types = [];
$content_types_definitions = $this->content_types_manager
->getDefinitions();
// Get the group bundle name.
$group_type = $group
->getGroupType();
// Check if module 'Opigno Moxtra' is enabled and configured.
$moxtra_status = \Drupal::moduleHandler()
->moduleExists('opigno_moxtra') && _opigno_moxtra_get_organization_status();
// For each content type available,
// convert it to an array and store it in the return array.
foreach ($content_types_definitions as $content_type_definition) {
// Add available content type only if it's allowed by plugin.
if (in_array($group_type
->id(), $content_type_definition['allowed_group_types'])) {
if ($content_type_definition['id'] == 'ContentTypeMeeting' && !$moxtra_status) {
continue;
}
$available_types[] = [
'bundle' => $content_type_definition['id'],
'contentType' => $content_type_definition['id'],
'name' => $this
->t($content_type_definition['readable_name']),
];
}
}
// If a JSON response is asked, return JSON.
// Else, return the array.
if ($json_output) {
return new JsonResponse($available_types, Response::HTTP_OK);
}
else {
return $available_types;
}
}
/**
* TODO: Create item from ajax drupal entity form.
*/
public function createItem(Request $request, $type = NULL) {
// TODO: Wait for Fred move first.
}
/**
* Update entities ancestors.
*
* Eg. if user switch two entities in learning path.
*/
public function updateEntities(Group $group, Request $request) {
$datas = Json::decode($request
->getContent());
// TODO Update parents links if changed.
foreach ($datas['entities'] as $entity) {
if (!$entity['cid']) {
return new JsonResponse(NULL, Response::HTTP_BAD_REQUEST);
}
$current_cid = $entity['cid'];
$content = OpignoGroupManagedContent::load($current_cid);
// Parent content id.
if (!empty($entity['parents'])) {
$parent_cid = $entity['parents'][0]['cid'];
}
else {
$parent_cid = NULL;
}
// Can be null if there is not parent.
$parent_link = $content
->getParentsLinks();
if ($parent_link) {
$parent_link = reset($parent_link);
// Update parent link if was changed.
if ($parent_cid == NULL) {
// Delete parent link.
$parent_link
->delete();
}
elseif ($parent_link
->getParentContentId() != $parent_cid) {
$parent_link
->setParentContentId($parent_cid);
$parent_link
->save();
}
}
else {
if ($parent_cid) {
// Create new parent link instance.
$new_link = OpignoGroupManagedLink::createWithValues($group
->id(), $parent_cid, $current_cid, $entity['successScoreMin']);
$new_link
->save();
}
}
}
return new JsonResponse([], Response::HTTP_OK);
}
/**
* Update Learning Path guided navigation field.
*
* @param \Drupal\group\Entity\Group $group
* Group object.
* @param \Symfony\Component\HttpFoundation\Request $request
* Request array.
*
* @return \Symfony\Component\HttpFoundation\JsonResponse
* Response array.
*/
public function updateGuidedNavigation(Group $group, Request $request) {
$data = json_decode($request
->getContent());
if (!isset($data->guidedNavigation)) {
return new JsonResponse(NULL, Response::HTTP_BAD_REQUEST);
}
$guidedNavigation = 0;
if ($group
->hasField('field_guided_navigation')) {
$guidedNavigation = $data->guidedNavigation;
$group
->set('field_guided_navigation', $guidedNavigation);
try {
$group
->save();
} catch (EntityStorageException $e) {
return new JsonResponse(NULL, Response::HTTP_INTERNAL_SERVER_ERROR);
}
}
return new JsonResponse([
'guidedNavigation' => $guidedNavigation,
], Response::HTTP_OK);
}
/**
* Return Learning Path guided navigation field.
*
* @param \Drupal\group\Entity\Group $group
* Group object.
*
* @return \Symfony\Component\HttpFoundation\JsonResponse
* Response array.
*/
public function getGuidedNavigationResponse(Group $group) {
$guidedNavigation = self::getGuidedNavigation($group);
// Return the JSON response.
return new JsonResponse($guidedNavigation, Response::HTTP_OK);
}
/**
* Get Learning Path guided navigation field.
*
* @param \Drupal\group\Entity\Group $group
* Group object.
*
* @return bool
* Training guided navigation flag
*/
public static function getGuidedNavigation(Group $group) {
if ($group
->getGroupType()
->id() == 'opigno_course') {
// $route = \Drupal::routeMatch();
// $route_name = $route->getRouteName();
$group_id = OpignoGroupContext::getCurrentGroupId();
if ($group_id) {
$group = Group::load($group_id);
}
// if (in_array($route_name, [
// 'entity.group.canonical',
// 'opigno_learning_path.steps.start',
// 'opigno_module.take_module',
// 'opigno_module.group.answer_form',
// 'opigno_module.module_result',
// 'opigno_learning_path.steps.next',
// ]) &&
// (($entity = $route->getParameter('group')) !== NULL)) {
// $group = $entity;
// }
// if ($route_name == 'opigno_module.module_result') {
// $group_id = OpignoGroupContext::getCurrentGroupId();
// $group = Group::load($group_id);
// }
}
$guidedNavigation = NULL;
if (is_object($group) && $group
->hasField('field_guided_navigation')) {
$guidedNavigation = $group
->get('field_guided_navigation')->value;
}
return $guidedNavigation ? FALSE : TRUE;
}
/**
* Duplicate course.
*
* @param \Drupal\group\Entity\Group $group
* Group object.
*/
public function courseDuplicate(Group $group) {
$duplicate = $group
->createDuplicate();
$current_name = $duplicate
->label();
$duplicate
->set('label', $this
->t('Duplicate of ') . $current_name);
$current_time = \Drupal::time()
->getCurrentTime();
$duplicate
->setOwnerId(\Drupal::currentUser()
->id());
$duplicate
->set('created', $current_time);
$duplicate
->set('changed', $current_time);
$duplicate
->save();
$duplicate_id = $duplicate
->id();
$course_content = $group
->getContentEntities();
foreach ($course_content as $content) {
if ($content instanceof OpignoModule) {
$duplicate
->addContent($content, 'opigno_module_group');
$managed_content_array = OpignoGroupManagedContent::loadByProperties([
'group_content_type_id' => 'ContentTypeModule',
'entity_id' => $content
->id(),
'group_id' => $group
->id(),
]);
$managed_content = reset($managed_content_array);
$parent_links = $managed_content
->getParentsLinks();
$new_content = OpignoGroupManagedContent::createWithValues($duplicate
->id(), $managed_content
->getGroupContentTypeId(), $content
->id(), $managed_content
->getSuccessScoreMin(), $managed_content
->isMandatory(), $managed_content
->getCoordinateX(), $managed_content
->getCoordinateY());
$new_content
->save();
foreach ($parent_links as $link) {
$parent_old_content = OpignoGroupManagedContent::load($link
->getParentContentId());
$parent_module_id = $parent_old_content
->getEntityId();
$parent_new_content_array = OpignoGroupManagedContent::loadByProperties([
'group_content_type_id' => 'ContentTypeModule',
'entity_id' => $parent_module_id,
'group_id' => $duplicate_id,
]);
$parent_new_content = reset($parent_new_content_array);
if ($parent_new_content) {
OpignoGroupManagedLink::createWithValues($duplicate_id, $parent_new_content
->id(), $new_content
->id(), $link
->getRequiredScore(), serialize($link
->getRequiredActivities()))
->save();
}
}
}
}
$duplicate
->save();
return $this
->redirect('entity.group.edit_form', [
'group' => $duplicate_id,
]);
}
/**
* Export course.
*
* @param \Drupal\group\Entity\Group $group
* Group object.
*/
public function courseExport(Group $group) {
$course_content = $group
->getContentEntities();
$course_fields = $group
->getFields();
$files_to_export = [];
foreach ($course_fields as $field_key => $field) {
$data_structure[$group
->id()][$field_key] = $field
->getValue();
}
$course_name = $data_structure[$group
->id()]['label'][0]['value'];
$format = 'json';
$dir = 'sites/default/files/opigno-export';
\Drupal::service('file_system')
->deleteRecursive($dir);
\Drupal::service('file_system')
->prepareDirectory($dir, FileSystemInterface::MODIFY_PERMISSIONS | FileSystemInterface::CREATE_DIRECTORY);
$serializer = \Drupal::service('serializer');
$content = $serializer
->serialize($data_structure, $format);
$filename = "export-course_{$course_name}_{$group->id()}.{$format}";
$filename_path = "{$dir}/{$filename}";
$files_to_export['course'] = $filename;
$context['results']['file'] = \Drupal::service('file_system')
->saveData($content, $filename_path, FileSystemInterface::EXISTS_REPLACE);
$new_filename = "opigno-course_{$course_name}_{$group->id()}.opi";
$zip = new \ZipArchive();
$zip
->open($dir . '/' . $new_filename, \ZipArchive::CREATE | \ZipArchive::OVERWRITE);
$zip
->addFile($filename_path, $filename);
foreach ($course_content as $entity) {
if ($entity instanceof OpignoModule) {
$activities = $entity
->getModuleActivities();
$module_fields = $entity
->getFields();
$data_structure = [];
foreach ($module_fields as $field_key => $field) {
$data_structure[$entity
->id()][$field_key] = $field
->getValue();
}
$managed_content_array = OpignoGroupManagedContent::loadByProperties([
'group_content_type_id' => 'ContentTypeModule',
'entity_id' => $entity
->id(),
'group_id' => $group
->id(),
]);
$managed_content = reset($managed_content_array);
$parent_links = $managed_content
->getParentsLinks();
foreach ($parent_links as $link) {
$parent_old_content = OpignoGroupManagedContent::load($link
->getParentContentId());
$parent_module_id = $parent_old_content
->getEntityId();
$parent_new_content_array = OpignoGroupManagedContent::loadByProperties([
'group_content_type_id' => 'ContentTypeModule',
'entity_id' => $parent_module_id,
'group_id' => $group
->id(),
]);
$parent_new_content = reset($parent_new_content_array);
if ($parent_new_content) {
$link = [
'group_id' => $group
->id(),
'parent_content_id' => $parent_new_content
->id(),
'child_content_id' => $entity
->id(),
'required_score' => $link
->getRequiredScore(),
'required_activities' => $link
->getRequiredActivities(),
];
$data_structure[$entity
->id()]['parent_links'][] = $link;
}
}
$data_structure[$entity
->id()]['managed_content'] = $managed_content;
$module_name = $data_structure[$entity
->id()]['name'][0]['value'];
$content = $serializer
->serialize($data_structure, $format);
$filename = "export-module_{$module_name}_{$entity->id()}.{$format}";
$filename_path = "{$dir}/{$filename}";
$files_to_export['modules'][$module_name . '_' . $entity
->id()] = $filename;
$context['results']['file'] = \Drupal::service('file_system')
->saveData($content, $filename_path, FileSystemInterface::EXISTS_REPLACE);
$zip
->addFile($filename_path, $filename);
foreach ($activities as $activity) {
$opigno_activity = OpignoActivity::load($activity->id);
$fields = $opigno_activity
->getFields();
$data_structure = [];
foreach ($fields as $field_key => $field) {
$data_structure[$opigno_activity
->id()][$field_key] = $field
->getValue();
}
$activity_name = $data_structure[$opigno_activity
->id()]['name'][0]['value'];
$filename = "export-activity_{$activity_name}_{$opigno_activity->id()}.{$format}";
$filename_path = "{$dir}/{$filename}";
$files_to_export['activities'][$module_name . '_' . $entity
->id()][] = $filename;
switch ($opigno_activity
->bundle()) {
case 'opigno_scorm':
if (isset($opigno_activity
->get('opigno_scorm_package')->target_id)) {
$file = File::load($opigno_activity
->get('opigno_scorm_package')->target_id);
if ($file) {
$file_uri = $file
->getFileUri();
$file_path = \Drupal::service('file_system')
->realpath($file_uri);
$scorm_filename = $file
->id() . '-' . $file
->getFilename();
$data_structure[$opigno_activity
->id()]['files'][$scorm_filename] = [
'file_name' => $file
->getFilename(),
'filemime' => $file
->getMimeType(),
'status' => $file
->get('status')
->getValue()[0]['value'],
];
$zip
->addFile($file_path, $scorm_filename);
}
}
break;
case 'opigno_tincan':
if (isset($opigno_activity
->get('opigno_tincan_package')->target_id)) {
$file = File::load($opigno_activity
->get('opigno_tincan_package')->target_id);
if ($file) {
$file_uri = $file
->getFileUri();
$file_path = \Drupal::service('file_system')
->realpath($file_uri);
$tincan_filename = $file
->id() . '-' . $file
->getFilename();
$data_structure[$opigno_activity
->id()]['files'][$tincan_filename] = [
'file_name' => $file
->getFilename(),
'filemime' => $file
->getMimeType(),
'status' => $file
->get('status')
->getValue()[0]['value'],
];
$zip
->addFile($file_path, $tincan_filename);
}
}
break;
case 'opigno_slide':
if (isset($opigno_activity
->get('opigno_slide_pdf')->target_id)) {
$media = Media::load($opigno_activity
->get('opigno_slide_pdf')->target_id);
$file_id = $media
->get('field_media_file')
->getValue()[0]['target_id'];
$file = File::load($file_id);
if ($file) {
$file_uri = $file
->getFileUri();
$file_path = \Drupal::service('file_system')
->realpath($file_uri);
$pdf_filename = $file
->id() . '-' . $file
->getFilename();
$data_structure[$opigno_activity
->id()]['files'][$pdf_filename] = [
'file_name' => $file
->getFilename(),
'filemime' => $file
->getMimeType(),
'status' => $file
->get('status')
->getValue()[0]['value'],
'bundle' => $media
->bundle(),
];
$zip
->addFile($file_path, $pdf_filename);
}
}
break;
case 'opigno_video':
if (isset($opigno_activity
->get('field_video')->target_id)) {
$file = File::load($opigno_activity
->get('field_video')->target_id);
if ($file) {
$file_uri = $file
->getFileUri();
$file_path = \Drupal::service('file_system')
->realpath($file_uri);
$video_filename = $file
->id() . '-' . $file
->getFilename();
$data_structure[$opigno_activity
->id()]['files'][$video_filename] = [
'file_name' => $file
->getFilename(),
'filemime' => $file
->getMimeType(),
'status' => $file
->get('status')
->getValue()[0]['value'],
];
$zip
->addFile($file_path, $video_filename);
}
}
break;
}
if ($opigno_activity
->bundle() == 'opigno_h5p') {
$hp5_id = $data_structure[$opigno_activity
->id()]['opigno_h5p'][0]['h5p_content_id'];
$h5p_content = H5PContent::load($hp5_id);
$h5p_content
->getFilteredParameters();
$hp5_archive = "interactive-content-{$hp5_id}.h5p";
$zip
->addFile('sites/default/files/h5p/exports/' . $hp5_archive, $hp5_archive);
}
$content = $serializer
->serialize($data_structure, $format);
$context['results']['file'] = \Drupal::service('file_system')
->saveData($content, $filename_path, FileSystemInterface::EXISTS_REPLACE);
$zip
->addFile($filename_path, $filename);
}
}
}
$content = $serializer
->serialize($files_to_export, $format);
$filename = "list_of_files.{$format}";
$filename_path = "{$dir}/{$filename}";
$files_to_export['activities'][] = $filename;
$context['results']['file'] = \Drupal::service('file_system')
->saveData($content, $filename_path, FileSystemInterface::EXISTS_REPLACE);
$zip
->addFile($filename_path, $filename);
$zip
->close();
$headers = [
'Content-Type' => 'application/opi',
'Content-Disposition' => 'attachment; filename="' . $new_filename . '"',
];
if (strpos($_SERVER['HTTP_USER_AGENT'], 'MSIE')) {
$headers['Cache-Control'] = 'must-revalidate, post-check=0, pre-check=0';
$headers['Pragma'] = 'public';
}
else {
$headers['Pragma'] = 'no-cache';
}
return new BinaryFileResponse($dir . '/' . $new_filename, 200, $headers);
}
/**
* Export training.
*
* @param \Drupal\group\Entity\Group $group
* Group object.
*/
public function trainingExport(Group $group) {
$group_content = $group
->getContentEntities();
$group_fields = $group
->getFields();
$files_to_export = [];
$modules_in_courses = [];
$activity_ids = [];
$skipped_delta = [
1 => 0,
2 => 0,
3 => 0,
];
foreach ($group_content as $entity) {
if ($entity instanceof Group && $entity
->bundle() == 'opigno_course') {
$course_content = $entity
->getContentEntities('opigno_module_group');
$group_content = array_merge($group_content, $course_content);
foreach ($course_content as $module) {
$modules_in_courses[$module
->id()] = $entity
->id();
}
}
elseif (in_array($entity
->bundle(), [
'opigno_moxtra_meeting',
'opigno_ilt',
])) {
$skipped_entities[$entity
->id()] = $entity;
}
}
foreach ($group_fields as $field_key => $field) {
$data_structure[$group
->id()][$field_key] = $field
->getValue();
}
$training_name = $data_structure[$group
->id()]['label'][0]['value'];
$format = 'json';
$dir = 'sites/default/files/opigno-export';
\Drupal::service('file_system')
->deleteRecursive($dir);
\Drupal::service('file_system')
->prepareDirectory($dir, FileSystemInterface::MODIFY_PERMISSIONS | FileSystemInterface::CREATE_DIRECTORY);
// Load image data.
$img_filename = '';
if (!empty($data_structure[$group
->id()]['field_learning_path_media_image'][0]['target_id'])) {
$media = Media::load($data_structure[$group
->id()]['field_learning_path_media_image'][0]['target_id']);
if (!empty($media)) {
$file_id = $media
->get('field_media_image')
->getValue()[0]['target_id'];
$file = File::load($file_id);
if ($file) {
$file_uri = $file
->getFileUri();
$file_path = \Drupal::service('file_system')
->realpath($file_uri);
$img_filename = $file
->id() . '-' . $file
->getFilename();
$data_structure[$group
->id()]['field_learning_path_media_image'] = [
'file_name' => $file
->getFilename(),
'filemime' => $file
->getMimeType(),
'status' => $file
->get('status')
->getValue()[0]['value'],
'bundle' => $media
->bundle(),
'media' => $media
->get('field_media_image')
->getValue(),
];
}
}
}
$serializer = \Drupal::service('serializer');
$content = $serializer
->serialize($data_structure, $format);
$filename = "export-training_{$training_name}_{$group->id()}.{$format}";
$filename_path = "{$dir}/{$filename}";
$files_to_export['training'] = $filename;
$context['results']['file'] = \Drupal::service('file_system')
->saveData($content, $filename_path, FileSystemInterface::EXISTS_REPLACE);
$new_filename = "opigno-training_{$training_name}_{$group->id()}.opi";
$zip = new \ZipArchive();
$zip
->open($dir . '/' . $new_filename, \ZipArchive::CREATE | \ZipArchive::OVERWRITE);
$zip
->addFile($filename_path, $filename);
if (!empty($img_filename) && !empty($file_path)) {
$zip
->addFile($file_path, $img_filename);
}
foreach ($group_content as $entity) {
if ($entity instanceof OpignoModule || $entity instanceof Group && $entity
->bundle() == 'opigno_course') {
$eid = $entity
->id();
if ($entity instanceof OpignoModule) {
$activities = $entity
->getModuleActivities();
$group_content_type_id = 'ContentTypeModule';
}
else {
$activities = [];
$group_content_type_id = 'ContentTypeCourse';
}
$module_fields = $entity
->getFields();
$data_structure = [];
$data_structure[$eid]['parent_links'] = [];
foreach ($module_fields as $field_key => $field) {
$data_structure[$eid][$field_key] = $field
->getValue();
}
$managed_content_array = OpignoGroupManagedContent::loadByProperties([
'group_content_type_id' => $group_content_type_id,
'entity_id' => $eid,
'group_id' => $group
->id(),
]);
$managed_content = reset($managed_content_array);
$link_group_id = $group
->id();
if (!$managed_content && isset($modules_in_courses[$entity
->id()])) {
$managed_content_array = OpignoGroupManagedContent::loadByProperties([
'group_content_type_id' => $group_content_type_id,
'entity_id' => $entity
->id(),
'group_id' => $modules_in_courses[$entity
->id()],
]);
$managed_content = reset($managed_content_array);
$data_structure[$eid]['course_rel'] = $modules_in_courses[$eid];
$link_group_id = $modules_in_courses[$eid];
}
if ($managed_content) {
$parent_links = $managed_content
->getParentsLinks();
foreach ($parent_links as $link) {
$parent_old_content = OpignoGroupManagedContent::load($link
->getParentContentId());
$parent_module_id = $parent_old_content
->getEntityId();
if (!empty($skipped_entities[$parent_module_id])) {
// Recalculate position of module if some steps of Training were skipped.
$coordinate_x = $managed_content
->getCoordinateX();
$coordinate_y = $managed_content
->getCoordinateY();
$skipped_delta[$coordinate_x]++;
$managed_content
->setCoordinateY($coordinate_y - $skipped_delta[$coordinate_x]);
}
$parent_new_content_array = OpignoGroupManagedContent::loadByProperties([
'group_content_type_id' => 'ContentTypeModule',
'entity_id' => $parent_module_id,
'group_id' => $link_group_id,
]);
$parent_new_content = reset($parent_new_content_array);
if ($parent_new_content) {
$parent_id = $parent_new_content
->id();
$link = [
'group_id' => $link_group_id,
'parent_content_id' => $parent_id,
'child_content_id' => $eid,
'required_score' => $link
->getRequiredScore(),
'required_activities' => $link
->getRequiredActivities(),
];
$data_structure[$eid]['parent_links'][] = $link;
}
}
}
$data_structure[$eid]['managed_content'] = $managed_content;
if ($group_content_type_id == 'ContentTypeModule') {
$entity_name = $data_structure[$entity
->id()]['name'][0]['value'];
$entity_name = preg_replace('/[^a-zA-Z0-9-_\\.]/', '-', $entity_name);
$filename = "export-module_{$entity_name}_{$entity->id()}.{$format}";
$files_to_export['modules'][$entity_name . '_' . $entity
->id()] = $filename;
}
else {
$entity_name = $data_structure[$entity
->id()]['label'][0]['value'];
$entity_name = preg_replace('/[^a-zA-Z0-9-_\\.]/', '-', $entity_name);
$filename = "export-course_{$entity_name}_{$entity->id()}.{$format}";
$files_to_export['courses'][$entity_name . '_' . $entity
->id()] = $filename;
}
$content = $serializer
->serialize($data_structure, $format);
$filename_path = "{$dir}/{$filename}";
\Drupal::service('file_system')
->saveData($content, $filename_path, \Drupal\Core\File\FileSystemInterface::EXISTS_REPLACE);
$zip
->addFile($filename_path, $filename);
foreach ($activities as $activity) {
$opigno_activity = OpignoActivity::load($activity->id);
$fields = $opigno_activity
->getFields();
$data_structure = [];
$aid = $opigno_activity
->id();
$activity_ids[$eid . '-' . $aid] = $aid;
foreach ($fields as $field_key => $field) {
$data_structure[$eid . '-' . $aid][$field_key] = $field
->getValue();
}
$max_score = [];
if ($entity instanceof OpignoModule) {
$max_score = $this
->getMaxScore($entity, $activity);
$max_score = isset($max_score['max_score']) ? $max_score['max_score'] : 10;
}
if (empty($data_structure[$eid . '-' . $aid]['max_score'])) {
$data_structure[$eid . '-' . $aid]['max_score'] = $max_score;
}
$activity_name = $data_structure[$eid . '-' . $aid]['name'][0]['value'];
$activity_name = preg_replace('/[^a-zA-Z0-9-_\\.]/', '-', $activity_name);
$filename = "export-activity_{$activity_name}_{$eid}_{$aid}.{$format}";
$filename_path = "{$dir}/{$filename}";
$files_to_export['activities'][$entity_name . '_' . $entity
->id()][] = $filename;
switch ($opigno_activity
->bundle()) {
case 'opigno_scorm':
if (isset($opigno_activity
->get('opigno_scorm_package')->target_id)) {
$file = File::load($opigno_activity
->get('opigno_scorm_package')->target_id);
if ($file) {
$file_uri = $file
->getFileUri();
$file_path = \Drupal::service('file_system')
->realpath($file_uri);
$scorm_filename = $file
->id() . '-' . $file
->getFilename();
$data_structure[$eid . '-' . $aid]['files'][$scorm_filename] = [
'file_name' => $file
->getFilename(),
'filemime' => $file
->getMimeType(),
'status' => $file
->get('status')
->getValue()[0]['value'],
];
$zip
->addFile($file_path, $scorm_filename);
}
}
break;
case 'opigno_tincan':
if (isset($opigno_activity
->get('opigno_tincan_package')->target_id)) {
$file = File::load($opigno_activity
->get('opigno_tincan_package')->target_id);
if ($file) {
$file_uri = $file
->getFileUri();
$file_path = \Drupal::service('file_system')
->realpath($file_uri);
$tincan_filename = $file
->id() . '-' . $file
->getFilename();
$data_structure[$eid . '-' . $aid]['files'][$tincan_filename] = [
'file_name' => $file
->getFilename(),
'filemime' => $file
->getMimeType(),
'status' => $file
->get('status')
->getValue()[0]['value'],
];
$zip
->addFile($file_path, $tincan_filename);
}
}
break;
case 'opigno_slide':
if (isset($opigno_activity
->get('opigno_slide_pdf')->target_id)) {
$media = Media::load($opigno_activity
->get('opigno_slide_pdf')->target_id);
$file_id = $media
->get('field_media_file')
->getValue()[0]['target_id'];
$file = File::load($file_id);
if ($file) {
$file_uri = $file
->getFileUri();
$file_path = \Drupal::service('file_system')
->realpath($file_uri);
$pdf_filename = $file
->id() . '-' . $file
->getFilename();
$data_structure[$eid . '-' . $aid]['files'][$pdf_filename] = [
'file_name' => $file
->getFilename(),
'filemime' => $file
->getMimeType(),
'status' => $file
->get('status')
->getValue()[0]['value'],
'bundle' => $media
->bundle(),
];
$zip
->addFile($file_path, $pdf_filename);
}
}
break;
case 'opigno_video':
if (isset($opigno_activity
->get('field_video')->target_id)) {
$file = File::load($opigno_activity
->get('field_video')->target_id);
if ($file) {
$file_uri = $file
->getFileUri();
$file_path = \Drupal::service('file_system')
->realpath($file_uri);
$video_filename = $file
->id() . '-' . $file
->getFilename();
$data_structure[$eid . '-' . $aid]['files'][$video_filename] = [
'file_name' => $file
->getFilename(),
'filemime' => $file
->getMimeType(),
'status' => $file
->get('status')
->getValue()[0]['value'],
];
$zip
->addFile($file_path, $video_filename);
}
}
break;
}
if ($opigno_activity
->bundle() == 'opigno_h5p') {
$hp5_id = $data_structure[$eid . '-' . $aid]['opigno_h5p'][0]['h5p_content_id'];
$h5p_content = H5PContent::load($hp5_id);
$h5p_content
->getFilteredParameters();
$hp5_archive = "interactive-content-{$hp5_id}.h5p";
$zip
->addFile('sites/default/files/h5p/exports/' . $hp5_archive, $hp5_archive);
}
$content = $serializer
->serialize($data_structure, $format);
$context['results']['file'] = \Drupal::service('file_system')
->saveData($content, $filename_path, \Drupal\Core\File\FileSystemInterface::EXISTS_REPLACE);
$zip
->addFile($filename_path, $filename);
}
$skipped_entity = FALSE;
}
}
// Export documents library.
$main_tid = $group
->get('field_learning_path_folder')
->getString();
$items_list = $this
->documentsLibraryList($main_tid);
$folder_library = $dir . '/library';
\Drupal::service('file_system')
->prepareDirectory($folder_library, FileSystemInterface::MODIFY_PERMISSIONS | FileSystemInterface::CREATE_DIRECTORY);
$zip
->addEmptyDir('library');
foreach ($items_list as $item) {
if ($item['type'] == 'file') {
$media = Media::load($item['id']);
$filename = $media
->id() . '_media_' . $media
->label() . '.' . $format;
$filename_path = "{$folder_library}/{$filename}";
$files_to_export['files'][$item['id']]['media'] = $filename;
$content = $serializer
->serialize($media, $format);
$context['results']['file'] = \Drupal::service('file_system')
->saveData($content, $filename_path, \Drupal\Core\File\FileSystemInterface::EXISTS_REPLACE);
$zip
->addFile($filename_path, 'library/' . $filename);
$file_id = $media
->get('tft_file')
->getValue()[0]['target_id'];
$file = File::load($file_id);
if ($file) {
$file_uri = $file
->getFileUri();
$filename = $file
->id() . '-' . $file
->getFilename();
$file_path = \Drupal::service('file_system')
->realpath($file_uri);
$zip
->addFile($file_path, 'library/' . $filename);
$filename = $file
->id() . '_file_' . $file
->label() . '.' . $format;
$files_to_export['files'][$item['id']]['file'] = $filename;
$filename_path = "{$folder_library}/{$filename}";
$content = $serializer
->serialize($file, $format);
$context['results']['file'] = \Drupal::service('file_system')
->saveData($content, $filename_path, \Drupal\Core\File\FileSystemInterface::EXISTS_REPLACE);
$zip
->addFile($filename_path, 'library/' . $filename);
}
}
elseif ($item['type'] == 'term') {
$term = Term::load($item['id']);
if ($term) {
$filename = $term
->id() . '_' . $term
->label() . '.' . $format;
$filename_path = "{$folder_library}/{$filename}";
$files_to_export['terms'][] = $filename;
$content = $serializer
->serialize($term, $format);
$context['results']['file'] = \Drupal::service('file_system')
->saveData($content, $filename_path, \Drupal\Core\File\FileSystemInterface::EXISTS_REPLACE);
$zip
->addFile($filename_path, 'library/' . $filename);
}
}
}
$content = $serializer
->serialize($files_to_export, $format);
$filename = "list_of_files.{$format}";
$filename_path = "{$dir}/{$filename}";
$files_to_export['activities'][] = $filename;
\Drupal::service('file_system')
->saveData($content, $filename_path, \Drupal\Core\File\FileSystemInterface::EXISTS_REPLACE);
$zip
->addFile($filename_path, $filename);
if (file_exists($filename_path)) {
$zip
->close();
}
$headers = [
'Content-Type' => 'application/opi',
'Content-Disposition' => 'attachment; filename="' . $new_filename . '"',
];
if (strpos($_SERVER['HTTP_USER_AGENT'], 'MSIE')) {
$headers['Cache-Control'] = 'must-revalidate, post-check=0, pre-check=0';
$headers['Pragma'] = 'public';
}
else {
$headers['Pragma'] = 'no-cache';
}
return new BinaryFileResponse($dir . '/' . $new_filename, 200, $headers);
}
/**
* Duplicate training.
*
* @param \Drupal\group\Entity\Group $group
* Group object.
*/
protected function getMaxScore($module, $activity) {
$query = \Drupal::service('database')
->select('opigno_module_relationship', 'omr')
->fields('omr', [])
->condition('omr.parent_id', $module
->id())
->condition('omr.parent_vid', $module
->getRevisionId())
->condition('omr.child_id', $activity->id)
->condition('omr.child_vid', $activity->vid)
->condition('omr.activity_status', 1);
$results = $query
->execute()
->fetchAll();
$omr = !empty($results[0]) ? $results[0] : [];
return (array) $omr;
}
/**
* Duplicate training.
*
* @param \Drupal\group\Entity\Group $group
* Group object.
*/
public function trainingDuplicate(Group $group) {
$duplicate = $group
->createDuplicate();
$current_name = $duplicate
->label();
$new_name = $this
->t('Duplicate of ') . $current_name;
$duplicate
->set('label', $new_name);
$current_time = \Drupal::time()
->getCurrentTime();
$user = \Drupal::currentUser();
$user_id = $user
->id();
$duplicate
->setOwnerId($user_id);
$duplicate
->set('created', $current_time);
$duplicate
->set('changed', $current_time);
$duplicate
->set('field_learning_path_enable_forum', 0);
$duplicate
->set('field_learning_path_forum', NULL);
$duplicate
->set('field_learning_path_folder', NULL);
$duplicate
->save();
if ($this
->moduleHandler()
->moduleExists('opigno_moxtra')) {
// Create workspace.
$moxtra_api = _opigno_moxtra_get_moxtra_api();
$response = $moxtra_api
->createWorkspace($user_id, $new_name);
$binder_id = $response['data']['id'];
$workspace = Workspace::create();
$workspace
->setName($new_name);
$workspace
->setBinderId($binder_id);
$workspace
->save();
// Attach workspace to the training.
$duplicate
->set('field_workspace', [
'target_id' => $workspace
->id(),
]);
}
// Duplicate documents library.
$tid = $group
->get('field_learning_path_folder')
->getString();
$items_list = $this
->documentsLibraryList($tid);
$main_tid = $duplicate
->get('field_learning_path_folder')
->getString();
$tids_relashionships = [];
$tids_relashionships[$tid] = $main_tid;
foreach ($items_list as $item) {
if ($item['type'] == 'file') {
$media = Media::load($item['id']);
$media_copy = $media
->createDuplicate();
$file_id = $media
->get('tft_file')
->getValue()[0]['target_id'];
$old_tid = $media
->get('tft_folder')
->getValue()[0]['target_id'];
$file = File::load($file_id);
if ($file) {
$file_copy = $file
->createDuplicate();
$new_name = $file
->id() . '-' . $file
->label();
$new_name = substr($new_name, 0, 200);
$new_uri = str_replace($file
->label(), $new_name, $file
->getFileUri());
$file_copy
->setFilename($new_name);
$file_copy
->setFileUri($new_uri);
$file_copy
->save();
$file_copy_id = $file_copy
->id();
if (isset($tids_relashionships[$old_tid])) {
$new_tid = $tids_relashionships[$old_tid];
}
else {
$new_tid = $main_tid;
}
$media_copy
->set('tft_file', $file_copy_id);
$media_copy
->set('tft_folder', $new_tid);
copy($file
->getFileUri(), $new_uri);
$media_copy
->save();
}
}
elseif ($item['type'] == 'term') {
$old_term = Term::load($item['id']);
if ($old_term) {
$legacy_parent_id = $old_term
->get('parent')
->getValue()[0]['target_id'];
if ($tids_relashionships[$legacy_parent_id]) {
$parent = $tids_relashionships[$legacy_parent_id];
}
else {
$parent = $main_tid;
}
$new_term = Term::create([
'vid' => 'tft_tree',
'name' => $item['name'],
'parent' => $parent,
]);
$new_term
->save();
$new_term_id = $new_term
->id();
$tids_relashionships[$item['id']] = $new_term_id;
}
}
}
$duplicate_id = $duplicate
->id();
$group_content = $group
->getContentEntities();
foreach ($group_content as $content) {
if ($content instanceof OpignoModule || $content instanceof Group) {
if ($content instanceof OpignoModule) {
$duplicate
->addContent($content, 'opigno_module_group');
$group_content_type_id = 'ContentTypeModule';
}
else {
$duplicate
->addContent($content, 'subgroup:opigno_course');
$group_content_type_id = 'ContentTypeCourse';
}
$managed_content_array = OpignoGroupManagedContent::loadByProperties([
'group_content_type_id' => $group_content_type_id,
'entity_id' => $content
->id(),
'group_id' => $group
->id(),
]);
$managed_content = reset($managed_content_array);
$parent_links = $managed_content
->getParentsLinks();
$new_content = OpignoGroupManagedContent::createWithValues($duplicate
->id(), $managed_content
->getGroupContentTypeId(), $content
->id(), $managed_content
->getSuccessScoreMin(), $managed_content
->isMandatory(), $managed_content
->getCoordinateX(), $managed_content
->getCoordinateY());
$new_content
->save();
foreach ($parent_links as $link) {
$parent_old_content = OpignoGroupManagedContent::load($link
->getParentContentId());
$parent_module_id = $parent_old_content
->getEntityId();
$parent_new_content_array = OpignoGroupManagedContent::loadByProperties([
'group_content_type_id' => 'ContentTypeModule',
'entity_id' => $parent_module_id,
'group_id' => $duplicate_id,
]);
$parent_new_content = reset($parent_new_content_array);
if ($parent_new_content) {
OpignoGroupManagedLink::createWithValues($duplicate_id, $parent_new_content
->id(), $new_content
->id(), $link
->getRequiredScore(), serialize($link
->getRequiredActivities()))
->save();
}
}
}
}
$duplicate
->save();
return $this
->redirect('entity.group.edit_form', [
'group' => $duplicate_id,
]);
}
/**
* Helper function.
*
* Get a list of all files and folders from the documents library.
*/
public function documentsLibraryList($tid) {
$main_content = _tft_folder_content($tid);
$all_content = [];
foreach ($main_content as $content) {
$all_content[] = $content;
if ($content['type'] == 'term') {
$term_content = $this
->documentsLibraryList($content['id']);
$all_content = array_merge($all_content, $term_content);
}
}
return $all_content;
}
/**
* Check if step is required meeting.
*
* @param array $step
* Step options.
*
* @param \Drupal\group\Entity\Group $group
* Group object.
*
* @return bool
*/
public static function mustBeVisitedMeeting($step, Group $group) {
if (self::getGuidedNavigation($group) && $step['typology'] == 'Meeting' && $step['mandatory'] == 1 && empty($step['presence'])) {
return TRUE;
}
return FALSE;
}
/**
* Returns default image url.
*
* @param string $bundle
*
* @return string
*/
public static function getDefaultBundleImageUrl($bundle) {
switch ($bundle) {
case 'opigno_course':
$module = 'opigno_course';
$image = 'img_course.svg';
break;
default:
$module = 'opigno_module';
$image = 'img_module.svg';
break;
}
$request = \Drupal::request();
$path = \Drupal::service('module_handler')
->getModule($module)
->getPath();
return $request
->getBasePath() . '/' . $path . '/img/' . $image;
}
}Members
Name |
Modifiers | Type | Description | Overrides |
|---|---|---|---|---|
|
ControllerBase:: |
protected | property | The configuration factory. | |
|
ControllerBase:: |
protected | property | The current user service. | 1 |
|
ControllerBase:: |
protected | property | The entity form builder. | |
|
ControllerBase:: |
protected | property | The entity manager. | |
|
ControllerBase:: |
protected | property | The entity type manager. | |
|
ControllerBase:: |
protected | property | The form builder. | 2 |
|
ControllerBase:: |
protected | property | The key-value storage. | 1 |
|
ControllerBase:: |
protected | property | The language manager. | 1 |
|
ControllerBase:: |
protected | property | The module handler. | 2 |
|
ControllerBase:: |
protected | property | The state service. | |
|
ControllerBase:: |
protected | function | Returns the requested cache bin. | |
|
ControllerBase:: |
protected | function | Retrieves a configuration object. | |
|
ControllerBase:: |
private | function | Returns the service container. | |
|
ControllerBase:: |
protected | function | Returns the current user. | 1 |
|
ControllerBase:: |
protected | function | Retrieves the entity form builder. | |
|
ControllerBase:: |
protected | function | Retrieves the entity manager service. | |
|
ControllerBase:: |
protected | function | Retrieves the entity type manager. | |
|
ControllerBase:: |
protected | function | Returns the form builder service. | 2 |
|
ControllerBase:: |
protected | function | Returns a key/value storage collection. | 1 |
|
ControllerBase:: |
protected | function | Returns the language manager service. | 1 |
|
ControllerBase:: |
protected | function | Returns the module handler. | 2 |
|
ControllerBase:: |
protected | function |
Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait:: |
|
|
ControllerBase:: |
protected | function | Returns the state storage service. | |
|
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
|
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
|
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
|
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
|
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
|
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
|
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
|
MessengerTrait:: |
protected | property | The messenger. | 29 |
|
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
|
MessengerTrait:: |
public | function | Sets the messenger. | |
|
OpignoGroupManagerController:: |
private | property | Opigno group content type manager. | |
|
OpignoGroupManagerController:: |
protected | property | Database connection. | |
|
OpignoGroupManagerController:: |
public | function | This method adds an item (content) in the learning path. | |
|
OpignoGroupManagerController:: |
public | function | Add a new link in the Learning Path. | |
|
OpignoGroupManagerController:: |
public static | function | Form ajax callback. | |
|
OpignoGroupManagerController:: |
public static | function | Submit handler added by opigno_learning_path_form_alter(). | |
|
OpignoGroupManagerController:: |
public | function | Duplicate course. | |
|
OpignoGroupManagerController:: |
public | function | Export course. | |
|
OpignoGroupManagerController:: |
public static | function |
Instantiates a new instance of this class. Overrides ControllerBase:: |
|
|
OpignoGroupManagerController:: |
public | function | TODO: Create item from ajax drupal entity form. | |
|
OpignoGroupManagerController:: |
public | function | Helper function. | |
|
OpignoGroupManagerController:: |
public | function | Return contents availables when you want add content to learning path. | |
|
OpignoGroupManagerController:: |
public static | function | Returns default image url. | |
|
OpignoGroupManagerController:: |
public static | function | Get Learning Path guided navigation field. | |
|
OpignoGroupManagerController:: |
public | function | Return Learning Path guided navigation field. | |
|
OpignoGroupManagerController:: |
public | function | Method called when the LP manager needs a create or edit form. | |
|
OpignoGroupManagerController:: |
public | function | This method is called on learning path load. | |
|
OpignoGroupManagerController:: |
public | function | Return content types available for learning paths. | |
|
OpignoGroupManagerController:: |
protected | function | Duplicate training. | |
|
OpignoGroupManagerController:: |
public | function | Returns next link. | |
|
OpignoGroupManagerController:: |
public | function | This function is called on learning path load. | |
|
OpignoGroupManagerController:: |
protected | function | Checking if the group contain item. | |
|
OpignoGroupManagerController:: |
public | function | Root page for angular app. | |
|
OpignoGroupManagerController:: |
public static | function | Check if step is required meeting. | |
|
OpignoGroupManagerController:: |
public | function | Remove item from learning path. | |
|
OpignoGroupManagerController:: |
public | function | Removes a link. | |
|
OpignoGroupManagerController:: |
public | function | Called after each update on learning path structure (add/remove/move node). | |
|
OpignoGroupManagerController:: |
public | function | Duplicate training. | |
|
OpignoGroupManagerController:: |
public | function | Export training. | |
|
OpignoGroupManagerController:: |
public | function | Update entities ancestors. | |
|
OpignoGroupManagerController:: |
public | function | Update Learning Path guided navigation field. | |
|
OpignoGroupManagerController:: |
public | function | Method called when a step is set as mandatory or not. | |
|
OpignoGroupManagerController:: |
public | function | Method called when an item success score is set or not. | |
|
OpignoGroupManagerController:: |
public | function | Update a link minimum score to go to next step. | |
|
OpignoGroupManagerController:: |
public | function | ||
|
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
|
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
|
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
|
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
|
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
|
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
|
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
|
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
|
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
|
UrlGeneratorTrait:: |
protected | property | The url generator. | |
|
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
|
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
|
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |