type = $type; $extraField = new ExtraField($this->type); $this->extraField = $extraField; $this->table = Database::get_main_table(TABLE_EXTRA_FIELD_VALUES); $this->table_handler_field = Database::get_main_table(TABLE_EXTRA_FIELD); } /** * @return ExtraField */ public function getExtraField() { return $this->extraField; } /** * Gets the number of values stored in the table (all fields together) * for this type of resource * @return integer Number of rows in the table * @assert () !== false */ public function get_count() { $query = Database::getManager()->getRepository('ChamiloCoreBundle:ExtraFieldValues')->createQueryBuilder('e'); $query->select('count(e.id)'); $query->where('e.extraFieldType = :type'); $query->setParameter('type', $this->getExtraField()->getExtraFieldType()); return $query->getQuery()->getScalarResult(); } /** * Save the extra fields values * In order to save this function needs a item_id (user id, course id, etc) * This function is used with $extraField->addElements() * @param array $params array for the insertion into the *_field_values table * * @return mixed false on empty params, void otherwise * @assert (array()) === false */ public function saveFieldValues($params) { foreach ($params as $key => $value) { $found = strpos($key, '__persist__'); if ($found) { $tempKey = str_replace('__persist__', '', $key); if (!isset($params[$tempKey])) { $params[$tempKey] = array(); } } } if (empty($params['item_id'])) { return false; } $type = $this->getExtraField()->getExtraFieldType(); // Parse params. foreach ($params as $key => $value) { if (substr($key, 0, 6) == 'extra_' || substr($key, 0, 7) == '_extra_' ) { // An extra field. $field_variable = substr($key, 6); $extraFieldInfo = $this->getExtraField()->get_handler_field_info_by_field_variable($field_variable); if ($extraFieldInfo) { $commentVariable = 'extra_'.$field_variable.'_comment'; $comment = isset($params[$commentVariable]) ? $params[$commentVariable] : null; switch ($extraFieldInfo['field_type']) { case ExtraField::FIELD_TYPE_TAG: if ($type == EntityExtraField::USER_FIELD_TYPE) { UserManager::delete_user_tags( $params['item_id'], $extraFieldInfo['id'] ); UserManager::process_tags( $value, $params['item_id'], $extraFieldInfo['id'] ); } else { $em = Database::getManager(); $currentTags = $em ->getRepository('ChamiloCoreBundle:ExtraFieldRelTag') ->findBy([ 'fieldId' => $extraFieldInfo['id'], 'itemId' => $params['item_id'] ]); foreach ($currentTags as $extraFieldtag) { $em->remove($extraFieldtag); } $tagValues = is_array($value) ? $value : [$value]; $tags = []; foreach ($tagValues as $tagValue) { $tagsResult = $em->getRepository('ChamiloCoreBundle:Tag')->findBy([ 'tag' => $tagValue, 'fieldId' => $extraFieldInfo['id'] ]); if (empty($tagsResult)) { $tag = new \Chamilo\CoreBundle\Entity\Tag(); $tag->setCount(0); $tag->setFieldId($extraFieldInfo['id']); $tag->setTag($tagValue); $tags[] = $tag; } else { $tags = array_merge($tags, $tagsResult); } } foreach ($tags as $tag) { $tag->setCount($tag->getCount() + 1); $em->persist($tag); $fieldRelTag = new Chamilo\CoreBundle\Entity\ExtraFieldRelTag(); $fieldRelTag->setFieldId($extraFieldInfo['id']); $fieldRelTag->setItemId($params['item_id']); $fieldRelTag->setTagId($tag->getId()); $em->persist($fieldRelTag); } $em->flush(); } break; case ExtraField::FIELD_TYPE_FILE_IMAGE: $dirPermissions = api_get_permissions_for_new_directories(); switch ($this->type) { case 'course': $fileDir = api_get_path(SYS_UPLOAD_PATH)."courses/"; $fileDirStored = "courses/"; break; case 'session': $fileDir = api_get_path(SYS_UPLOAD_PATH)."sessions/"; $fileDirStored = "sessions/"; break; case 'user': $fileDir = UserManager::getUserPathById($params['item_id'], 'system'); $fileDirStored = UserManager::getUserPathById($params['item_id'], 'last'); break; } $fileName = ExtraField::FIELD_TYPE_FILE_IMAGE . "_{$params['item_id']}.png"; if (!file_exists($fileDir)) { mkdir($fileDir, $dirPermissions, true); } if ($value['error'] == 0) { $imageExtraField = new Image($value['tmp_name']); $imageExtraField->send_image($fileDir . $fileName, -1, 'png'); $newParams = array( 'item_id' => $params['item_id'], 'field_id' => $extraFieldInfo['id'], 'value' => $fileDirStored . $fileName, 'comment' => $comment ); self::save($newParams); } break; case ExtraField::FIELD_TYPE_FILE: $dirPermissions = api_get_permissions_for_new_directories(); switch ($this->type) { case 'course': $fileDir = api_get_path(SYS_UPLOAD_PATH)."courses/"; $fileDirStored = "courses/"; break; case 'session': $fileDir = api_get_path(SYS_UPLOAD_PATH)."sessions/"; $fileDirStored = "sessions/"; break; case 'user': $fileDir = UserManager::getUserPathById($params['item_id'], 'system'); $fileDirStored = UserManager::getUserPathById($params['item_id'], 'last'); break; } $cleanedName = api_replace_dangerous_char($value['name']); $fileName = ExtraField::FIELD_TYPE_FILE . "_{$params['item_id']}_$cleanedName"; if (!file_exists($fileDir)) { mkdir($fileDir, $dirPermissions, true); } if ($value['error'] == 0) { moveUploadedFile($value, $fileDir . $fileName); $new_params = array( 'item_id' => $params['item_id'], 'field_id' => $extraFieldInfo['id'], 'value' => $fileDirStored . $fileName ); if ($this->type !== 'session' && $this->type !== 'course') { $new_params['comment'] = $comment; } self::save($new_params); } break; default: $newParams = array( 'item_id' => $params['item_id'], 'field_id' => $extraFieldInfo['id'], 'value' => $value, 'comment' => $comment ); self::save($newParams); } } } } } /** * Save values in the *_field_values table * @param array $params Structured array with the values to save * @param boolean $show_query Whether to show the insert query (passed to the parent save() method) * @result mixed The result sent from the parent method * @assert (array()) === false */ public function save($params, $show_query = false) { $extra_field = $this->getExtraField(); // Setting value to insert. $value = $params['value']; $value_to_insert = null; if (is_array($value)) { $value_to_insert = implode(';', $value); } else { $value_to_insert = Database::escape_string($value); } $params['value'] = $value_to_insert; // If field id exists if (isset($params['field_id'])) { $extraFieldInfo = $extra_field->get($params['field_id']); } else { // Try the variable $extraFieldInfo = $extra_field->get_handler_field_info_by_field_variable( $params['variable'] ); $params['field_id'] = $extraFieldInfo['id']; } if ($extraFieldInfo) { switch ($extraFieldInfo['field_type']) { case ExtraField::FIELD_TYPE_RADIO: case ExtraField::FIELD_TYPE_SELECT: break; case ExtraField::FIELD_TYPE_SELECT_MULTIPLE: //$field_options = $session_field_option->get_field_options_by_field($params['field_id']); //$params['field_value'] = split(';', $value_to_insert); /* if ($field_options) { $check = false; foreach ($field_options as $option) { if (in_array($option['option_value'], $values)) { $check = true; break; } } if (!$check) { return false; //option value not found } } else { return false; //enumerated type but no option found }*/ break; case ExtraField::FIELD_TYPE_TEXT: case ExtraField::FIELD_TYPE_TEXTAREA: break; case ExtraField::FIELD_TYPE_DOUBLE_SELECT: if (is_array($value)) { if (isset($value['extra_'.$extraFieldInfo['variable']]) && isset($value['extra_'.$extraFieldInfo['variable'].'_second']) ) { $value_to_insert = $value['extra_'.$extraFieldInfo['variable']].'::'.$value['extra_'.$extraFieldInfo['variable'].'_second']; } else { $value_to_insert = null; } } break; default: break; } if ($extraFieldInfo['field_type'] == ExtraField::FIELD_TYPE_TAG) { $field_values = self::getAllValuesByItemAndFieldAndValue( $params['item_id'], $params['field_id'], $value ); } else { $field_values = self::get_values_by_handler_and_field_id( $params['item_id'], $params['field_id'] ); } $params['value'] = $value_to_insert; $params['author_id'] = api_get_user_id(); // Insert if (empty($field_values)) { /* Enable this when field_loggeable is introduced as a table field (2.0) if ($extraFieldInfo['field_loggeable'] == 1) { */ if (false) { global $app; switch($this->type) { case 'question': $extraFieldValue = new ChamiloLMS\Entity\QuestionFieldValues(); $extraFieldValue->setUserId(api_get_user_id()); $extraFieldValue->setQuestionId($params[$this->handler_id]); break; case 'course': $extraFieldValue = new ChamiloLMS\Entity\CourseFieldValues(); $extraFieldValue->setUserId(api_get_user_id()); $extraFieldValue->setQuestionId($params[$this->handler_id]); break; case 'user': $extraFieldValue = new ChamiloLMS\Entity\UserFieldValues(); $extraFieldValue->setUserId($params[$this->handler_id]); $extraFieldValue->setAuthorId(api_get_user_id()); break; case 'session': $extraFieldValue = new ChamiloLMS\Entity\SessionFieldValues(); $extraFieldValue->setUserId(api_get_user_id()); $extraFieldValue->setSessionId($params[$this->handler_id]); break; } if (isset($extraFieldValue)) { if (!empty($params['value'])) { $extraFieldValue->setComment($params['comment']); $extraFieldValue->setFieldValue($params['value']); $extraFieldValue->setFieldId($params['field_id']); $extraFieldValue->setTms(api_get_utc_datetime(null, false, true)); $app['orm.ems']['db_write']->persist($extraFieldValue); $app['orm.ems']['db_write']->flush(); } } } else { if ($extraFieldInfo['field_type'] == ExtraField::FIELD_TYPE_TAG) { $option = new ExtraFieldOption($this->type); $optionExists = $option->get($params['value']); if (empty($optionExists)) { $optionParams = array( 'field_id' => $params['field_id'], 'option_value' => $params['value'] ); $optionId = $option->saveOptions($optionParams); } else { $optionId = $optionExists['id']; } $params['value'] = $optionId; if ($optionId) { return parent::save($params, $show_query); } } else { return parent::save($params, $show_query); } } } else { // Update /* Enable this when field_loggeable is introduced as a table field (2.0) if ($extraFieldInfo['field_loggeable'] == 1) { */ if (false) { global $app; switch($this->type) { case 'question': $extraFieldValue = $app['orm.ems']['db_write']->getRepository('ChamiloLMS\Entity\QuestionFieldValues')->find($field_values['id']); $extraFieldValue->setUserId(api_get_user_id()); $extraFieldValue->setQuestionId($params[$this->handler_id]); break; case 'course': $extraFieldValue = $app['orm.ems']['db_write']->getRepository('ChamiloLMS\Entity\CourseFieldValues')->find($field_values['id']); $extraFieldValue->setUserId(api_get_user_id()); $extraFieldValue->setCourseCode($params[$this->handler_id]); break; case 'user': $extraFieldValue = $app['orm.ems']['db_write']->getRepository('ChamiloLMS\Entity\UserFieldValues')->find($field_values['id']); $extraFieldValue->setUserId(api_get_user_id()); $extraFieldValue->setAuthorId(api_get_user_id()); break; case 'session': $extraFieldValue = $app['orm.ems']['db_write']->getRepository('ChamiloLMS\Entity\SessionFieldValues')->find($field_values['id']); $extraFieldValue->setUserId(api_get_user_id()); $extraFieldValue->setSessionId($params[$this->handler_id]); break; } if (isset($extraFieldValue)) { if (!empty($params['value'])) { /* * If the field value is similar to the previous value then the comment will be the same in order to no save in the log an empty record */ if ($extraFieldValue->getFieldValue() == $params['value']) { if (empty($params['comment'])) { $params['comment'] = $extraFieldValue->getComment(); } } $extraFieldValue->setComment($params['comment']); $extraFieldValue->setFieldValue($params['value']); $extraFieldValue->setFieldId($params['field_id']); $extraFieldValue->setTms(api_get_utc_datetime(null, false, true)); $app['orm.ems']['db_write']->persist($extraFieldValue); $app['orm.ems']['db_write']->flush(); } } } else { $params['id'] = $field_values['id']; return parent::update($params, $show_query); } } } } /** * Returns the value of the given extra field on the given resource * @param int $item_id Item ID (It could be a session_id, course_id or user_id) * @param int $field_id Field ID (the ID from the *_field table) * @param bool $transform Whether to transform the result to a human readable strings * @return mixed A structured array with the field_id and field_value, or false on error * @assert (-1,-1) === false */ public function get_values_by_handler_and_field_id($item_id, $field_id, $transform = false) { $field_id = intval($field_id); $item_id = Database::escape_string($item_id); $sql = "SELECT s.*, field_type FROM {$this->table} s INNER JOIN {$this->table_handler_field} sf ON (s.field_id = sf.id) WHERE item_id = '$item_id' AND field_id = '".$field_id."' AND sf.extra_field_type = ".$this->getExtraField()->getExtraFieldType()." ORDER BY id"; $result = Database::query($sql); if (Database::num_rows($result)) { $result = Database::fetch_array($result, 'ASSOC'); if ($transform) { if (!empty($result['value'])) { switch ($result['field_type']) { case ExtraField::FIELD_TYPE_DOUBLE_SELECT: $field_option = new ExtraFieldOption($this->type); $options = explode('::', $result['value']); // only available for PHP 5.4 :( $result['field_value'] = $field_option->get($options[0])['id'].' -> '; $result = $field_option->get($options[0]); $result_second = $field_option->get($options[1]); if (!empty($result)) { $result['value'] = $result['display_text'].' -> '; $result['value'] .= $result_second['display_text']; } break; case ExtraField::FIELD_TYPE_SELECT: $field_option = new ExtraFieldOption($this->type); $extra_field_option_result = $field_option->get_field_option_by_field_and_option( $result['field_id'], $result['value'] ); if (isset($extra_field_option_result[0])) { $result['value'] = $extra_field_option_result[0]['display_text']; } break; } } } return $result; } else { return false; } } /** * @param string $tag * @param int $field_id * @param int $limit * * @return array */ public function searchValuesByField($tag, $field_id, $limit = 10) { $field_id = intval($field_id); $limit = intval($limit); $extraFieldType = $this->getExtraField()->getExtraFieldType(); $tag = Database::escape_string($tag); $sql = "SELECT DISTINCT s.value, s.field_id FROM {$this->table} s INNER JOIN {$this->table_handler_field} sf ON (s.field_id = sf.id) WHERE field_id = '".$field_id."' AND value LIKE '%$tag%' AND sf.extra_field_type = ".$extraFieldType." ORDER BY value LIMIT 0, $limit "; $result = Database::query($sql); $values = array(); if (Database::num_rows($result)) { $values = Database::store_result($result, 'ASSOC'); } return $values; } /** * Gets a structured array of the original item and its extra values, using * a specific original item and a field name (like "branch", or "birthdate") * @param int $item_id Item ID from the original table * @param string $field_variable The name of the field we are looking for * @param bool $transform * @param bool $allVisibility * * @return mixed Array of results, or false on error or not found * @assert (-1,'') === false */ public function get_values_by_handler_and_field_variable( $item_id, $field_variable, $transform = false, $filterByVisibility = false, $visibility = 0 ) { $item_id = intval($item_id); $field_variable = Database::escape_string($field_variable); $extraFieldType = $this->getExtraField()->getExtraFieldType(); $sql = "SELECT s.*, field_type FROM {$this->table} s INNER JOIN {$this->table_handler_field} sf ON (s.field_id = sf.id) WHERE item_id = '$item_id' AND variable = '".$field_variable."' AND sf.extra_field_type = $extraFieldType "; if ($filterByVisibility) { $visibility = intval($visibility); $sql .= " AND visible = $visibility "; } $sql .= " ORDER BY id"; $result = Database::query($sql); if (Database::num_rows($result)) { $result = Database::fetch_array($result, 'ASSOC'); if ($transform) { if ($result['field_type'] == ExtraField::FIELD_TYPE_DOUBLE_SELECT) { if (!empty($result['value'])) { $field_option = new ExtraFieldOption($this->type); $options = explode('::', $result['value']); $result = $field_option->get($options[0]); $result_second = $field_option->get($options[1]); if (!empty($result)) { $result['value'] = $result['display_text'].' -> '; $result['value'] .= $result_second['display_text']; } } } } return $result; } else { return false; } } /** * Gets the ID from the item (course, session, etc) for which * the given field is defined with the given value * @param string $field_variable Field (type of data) we want to check * @param string $field_value Data we are looking for in the given field * @param bool $transform Whether to transform the result to a human readable strings * @param bool $last Whether to return the last element or simply the first one we get * @return mixed Give the ID if found, or false on failure or not found * @assert (-1,-1) === false */ public function get_item_id_from_field_variable_and_field_value( $field_variable, $field_value, $transform = false, $last = false ) { $field_value = Database::escape_string($field_value); $field_variable = Database::escape_string($field_variable); $extraFieldType = $this->getExtraField()->getExtraFieldType(); $sql = "SELECT item_id FROM {$this->table} s INNER JOIN {$this->table_handler_field} sf ON (s.field_id = sf.id) WHERE value = '$field_value' AND variable = '".$field_variable."' AND sf.extra_field_type = $extraFieldType ORDER BY item_id "; if ($last) { // If we want the last element instead of the first // This is useful in special cases where there might // (erroneously) be more than one row for an item $sql .= ' DESC'; } $result = Database::query($sql); if ($result !== false && Database::num_rows($result)) { $result = Database::fetch_array($result, 'ASSOC'); return $result; } else { return false; } } /** * @param int $fieldId * * @return array|bool */ public function getValuesByFieldId($fieldId) { $fieldId = intval($fieldId); $extraFieldType = $this->getExtraField()->getExtraFieldType(); $sql = "SELECT s.* FROM {$this->table} s INNER JOIN {$this->table_handler_field} sf ON (s.field_id = sf.id) WHERE field_id = '".$fieldId."' AND sf.extra_field_type = $extraFieldType ORDER BY s.value"; $result = Database::query($sql); if (Database::num_rows($result)) { return Database::store_result($result, 'ASSOC'); } return false; } /** * @param int $itemId * @param int $fieldId * @return array */ public function getAllValuesByItemAndField($itemId, $fieldId) { $fieldId = intval($fieldId); $itemId = intval($itemId); $extraFieldType = $this->getExtraField()->getExtraFieldType(); $sql = "SELECT s.* FROM {$this->table} s INNER JOIN {$this->table_handler_field} sf ON (s.field_id = sf.id) WHERE field_id = '".$fieldId."' AND item_id = '$itemId' AND sf.extra_field_type = $extraFieldType ORDER BY s.value"; $result = Database::query($sql); if (Database::num_rows($result)) { return Database::store_result($result, 'ASSOC'); } return false; } /** * @param int $itemId * * @return array */ public function getAllValuesByItem($itemId) { $itemId = intval($itemId); $extraFieldType = $this->getExtraField()->getExtraFieldType(); $sql = "SELECT s.value, sf.variable FROM {$this->table} s INNER JOIN {$this->table_handler_field} sf ON (s.field_id = sf.id) WHERE item_id = '$itemId' AND sf.extra_field_type = $extraFieldType ORDER BY s.value"; $result = Database::query($sql); if (Database::num_rows($result)) { return Database::store_result($result, 'ASSOC'); } return false; } /** * @param int $itemId * @param int $fieldId * @param string $fieldValue * * @return array|bool */ public function getAllValuesByItemAndFieldAndValue($itemId, $fieldId, $fieldValue) { $fieldId = intval($fieldId); $itemId = intval($itemId); $extraFieldType = $this->getExtraField()->getExtraFieldType(); $fieldValue = Database::escape_string($fieldValue); $sql = "SELECT s.* FROM {$this->table} s INNER JOIN {$this->table_handler_field} sf ON (s.field_id = sf.id) WHERE field_id = '$fieldId' AND item_id = '$itemId' AND value = '$fieldValue' AND sf.extra_field_type = $extraFieldType ORDER BY value"; $result = Database::query($sql); if (Database::num_rows($result)) { return Database::store_result($result, 'ASSOC'); } return false; } /** * Deletes all the values related to a specific field ID * @param int $field_id * * @return void * @assert ('a') == null */ public function delete_all_values_by_field_id($field_id) { $field_id = intval($field_id); $sql = "DELETE FROM {$this->table} WHERE field_id = $field_id "; Database::query($sql); } /** * Deletes values of a specific field for a specific item * @param int $item_id (session id, course id, etc) * @param int $field_id * @return void * @assert (-1,-1) == null */ public function delete_values_by_handler_and_field_id($item_id, $field_id) { $field_id = intval($field_id); $item_id = intval($item_id); $extraFieldType = $this->getExtraField()->getExtraFieldType(); $sql = "DELETE FROM {$this->table} WHERE item_id = '$item_id' AND field_id = '".$field_id."' AND extra_field_type = $extraFieldType "; Database::query($sql); } /** * Deletes all values from an item * @param int $itemId (session id, course id, etc) * @assert (-1,-1) == null */ public function deleteValuesByItem($itemId) { $itemId = intval($itemId); $extraFieldType = $this->getExtraField()->getExtraFieldType(); $sql = "DELETE FROM {$this->table} WHERE item_id = '$itemId' AND field_id IN ( SELECT id FROM {$this->table_handler_field} WHERE extra_field_type = ".$extraFieldType." ) "; Database::query($sql); } /** * @param int $itemId * @param int $fieldId * @param int $fieldValue */ public function deleteValuesByHandlerAndFieldAndValue($itemId, $fieldId, $fieldValue) { $itemId = intval($itemId); $fieldId = intval($fieldId); $fieldValue = Database::escape_string($fieldValue); //$extraFieldType = $this->getExtraField()->getExtraFieldType(); $sql = "DELETE FROM {$this->table} WHERE item_id = '$itemId' AND field_id = '".$fieldId."' AND value = '$fieldValue' "; Database::query($sql); } /** * Not yet implemented - Compares the field values of two items * @param int $item_id Item 1 * @param int $item_to_compare Item 2 * @todo * @return mixed Differential array generated from the comparison */ public function compareItemValues($item_id, $item_to_compare) { } /** * Get all values for an item * @param int $itemId The item ID * @param boolean $onlyVisibleFields Get the visible extra field only * @return array */ public function getAllValuesForAnItem($itemId, $onlyVisibleFields = false) { $em = Database::getManager(); $queryBuilder = $em->createQueryBuilder(); $fieldOptionsRepo = $em->getRepository('ChamiloCoreBundle:ExtraFieldOptions'); $queryBuilder = $queryBuilder->select('fv') ->from('ChamiloCoreBundle:ExtraFieldValues', 'fv') ->innerJoin( 'ChamiloCoreBundle:ExtraField', 'f', Doctrine\ORM\Query\Expr\Join::WITH, 'fv.field = f' ) ->where( $queryBuilder->expr()->andX( $queryBuilder->expr()->eq('fv.itemId', ':item'), $queryBuilder->expr()->eq('f.extraFieldType', ':field_type') ) ); if ($onlyVisibleFields) { $queryBuilder->andWhere( $queryBuilder->expr()->eq('f.visible', true) ); } $fieldValues = $queryBuilder ->setParameter('item', $itemId) ->setParameter('field_type', $this->getExtraField()->getExtraFieldType()) ->getQuery() ->getResult(); $valueList = []; foreach ($fieldValues as $fieldValue) { $item = [ 'value' => $fieldValue ]; switch ($fieldValue->getField()->getFieldType()) { case ExtraField::FIELD_TYPE_SELECT: $item['option'] = $fieldOptionsRepo->findOneBy([ 'field' => $fieldValue->getField(), 'value' => $fieldValue->getValue() ]); break; } $valueList[] = $item; } return $valueList; } }