ExtraFieldValue::getExtraField() - Code Metrics - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

ExtraFieldValue::getExtraField() A
last analyzed 2025-12-26 22:47 UTC

↳ Parent: ExtraFieldValue
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0
<?php

/* For licensing terms, see /license.txt */

use Chamilo\CoreBundle\Entity\Asset;
use Chamilo\CoreBundle\Entity\ExtraField as EntityExtraField;
use Chamilo\CoreBundle\Entity\ExtraFieldOptions;
use Chamilo\CoreBundle\Entity\ExtraFieldRelTag;
use Chamilo\CoreBundle\Entity\ExtraFieldValues;
use Chamilo\CoreBundle\Entity\Tag;
use Chamilo\CoreBundle\Framework\Container;
use Chamilo\CoreBundle\Repository\ExtraFieldOptionsRepository;
use Chamilo\CoreBundle\Repository\ExtraFieldValuesRepository;
use ChamiloSession as Session;
use Doctrine\ORM\Exception\NotSupported;
use Symfony\Component\HttpFoundation\File\UploadedFile;

/**
 * Class ExtraFieldValue
 * Declaration for the ExtraFieldValue class, managing the values in extra
 * fields for any data type.
 */
class ExtraFieldValue extends Model
{
    public $type = '';
    public $columns = [
        'id',
        'field_id',
        'field_value',
        'comment',
        'item_id',
        'asset_id',
        'created_at',
        'updated_at',
    ];
    /** @var ExtraField */
    public $extraField;

    /**
     * Formats the necessary elements for the given datatype.
     *
     * @param string $type The type of data to which this extra field
     *                     applies (user, course, session, ...)
     *
     * @assert (-1) === false
     */
    public function __construct($type)
    {
        parent::__construct();
        $this->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 int Number of rows in the table
     * @assert () !== false
     */
    public function get_count()
    {
        $em = Database::getManager();
        $query = $em->getRepository(ExtraFieldValues::class)->createQueryBuilder('e');
        $query->select('count(e.id)');
        $query->where('e.itemType = :type');
        $query->setParameter('type', $this->getExtraField()->getItemType());

        return $query->getQuery()->getSingleScalarResult();
    }

    /**
     * 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 (each label must be prefixed by 'extra_')
     * @param bool  $onlySubmittedFields Only save parameters in the $param array
     * @param bool  $showQuery
     * @param array $saveOnlyThisFields
     * @param array $avoidFields         do not insert/modify this field
     * @param bool  $forceSave
     *
     * @return mixed false on empty params, void otherwise
     * @assert (array()) === false
     */
    public function saveFieldValues(
        $params,
        $onlySubmittedFields = false,
        $showQuery = false,
        $saveOnlyThisFields = [],
        $avoidFields = [],
        $forceSave = false
    ) {
        foreach ($params as $key => $value) {
            $found = strpos($key, '__persist__');

            if (false === $found) {
                continue;
            }

            $tempKey = str_replace('__persist__', '', $key);
            if (!isset($params[$tempKey])) {
                $params[$tempKey] = [];
            }
        }

        if (empty($params['item_id'])) {
            return false;
        }

        $type = $this->getExtraField()->getItemType();

        $extraField = new ExtraField($this->type);
        $extraFields = $extraField->get_all([], 'option_order');
        $resultsExist = [];
        $em = Database::getManager();

        // Parse params.
        foreach ($extraFields as $fieldDetails) {
            if (false === $forceSave) {
                // if the field is not visible to the user in the end, we need to apply special rules
                if (1 != $fieldDetails['visible_to_self']) {
                    //only admins should be able to add those values
                    if (!api_is_platform_admin(true, true)) {
                        // although if not admin but sent through a CLI script, we should accept it as well
                        if (PHP_SAPI !== 'cli') {
                            continue; //not a CLI script, so don't write the value to DB
                        }
                    }
                }
            }

            $field_variable = $fieldDetails['variable'];
            $fieldVariableWithExtra = 'extra_'.$field_variable;
            if ($onlySubmittedFields && !isset($params[$fieldVariableWithExtra])) {
                continue;
            }

            if (!empty($avoidFields)) {
                if (in_array($field_variable, $avoidFields)) {
                    continue;
                }
            }

            if (!empty($saveOnlyThisFields)) {
                if (!in_array($field_variable, $saveOnlyThisFields)) {
                    continue;
                }
            }

            $value = '';
            if (isset($params[$fieldVariableWithExtra])) {
                $value = $params[$fieldVariableWithExtra];
            }

            $resultsExist[$field_variable] = isset($value) && '' !== $value ? true : false;
            $extraFieldInfo = $this->getExtraField()->get_handler_field_info_by_field_variable($field_variable);

            if (!$extraFieldInfo) {
                continue;
            }

            $commentVariable = 'extra_'.$field_variable.'_comment';
            $comment = $params[$commentVariable] ?? null;

            switch ($extraFieldInfo['value_type']) {
                case ExtraField::FIELD_TYPE_GEOLOCALIZATION_COORDINATES:
                case ExtraField::FIELD_TYPE_GEOLOCALIZATION:
                    if (!empty($value)) {
                        if (isset($params['extra_'.$extraFieldInfo['variable'].'_coordinates'])) {
                            $value = $value.'::'.$params['extra_'.$extraFieldInfo['variable'].'_coordinates'];
                        }
                        $newParams = [
                            'item_id' => $params['item_id'],
                            'field_id' => $extraFieldInfo['id'],
                            'field_value' => $value,
                            'comment' => $comment,
                        ];
                        self::save($newParams, $showQuery);
                              save($newParams, $showQuery);
                    }
                    break;
                case ExtraField::FIELD_TYPE_TAG:
                    if (EntityExtraField::USER_FIELD_TYPE == $type) {
                        UserManager::delete_user_tags(
                            $params['item_id'],
                            $extraFieldInfo['id']
                        );
                        UserManager::process_tags(
                            $value,
                            $params['item_id'],
                            $extraFieldInfo['id']
                        );
                        break;
                    }

                    $currentTags = $em
                        ->getRepository(ExtraFieldRelTag::class)
                        ->findBy([
                            'field' => $extraFieldInfo['id'],
                            'itemId' => $params['item_id'],
                        ]);

                    foreach ($currentTags as $extraFieldtag) {
                        $em->remove($extraFieldtag);
                    }
                    $em->flush();

                    /** @var \Chamilo\CoreBundle\Entity\ExtraField $fieldEntity */
                    $fieldEntity = Container::getExtraFieldRepository()->find($extraFieldInfo['id']);
                    $tagRepo = Container::getTagRepository();
                    $tagValues = is_array($value) ? $value : [$value];

                    $tags = [];
                    foreach ($tagValues as $tagValue) {
                        if (is_array($tagValue)) {
                            $tagValue = reset($tagValue);
                        }

                        if (empty($tagValue)) {
                            continue;
                        }

                        $tagsResult = $tagRepo->findOneBy(['tag' => $tagValue, 'field' => $fieldEntity]);
                        if (null === $tagsResult) {
                            $tag = (new Tag())
                                ->setField($fieldEntity)
                                ->setTag($tagValue)
                            ;
                            $em->persist($tag);
                            $tags[] = $tag;
                        } else {
                            $tags[] = $tagsResult;
                        }
                    }
                    $em->flush();

                    if (!empty($tags)) {
                        foreach ($tags as $tag) {
                            $tagUses = $em
                                ->getRepository(ExtraFieldRelTag::class)
                                ->findBy([
                                    'tag' => $tag,
                                ]);

                            $tag->setCount(count($tagUses) + 1);
                            $em->persist($tag);
                        }
                    }
                    $em->flush();

                    foreach ($tags as $tag) {
                        $fieldRelTag = (new ExtraFieldRelTag())
                            ->setField($fieldEntity)
                            ->setItemId($params['item_id'])
                            ->setTag($tag)
                        ;
                        $em->persist($fieldRelTag);
                    }

                    $em->flush();
                    break;
                case ExtraField::FIELD_TYPE_FILE_IMAGE:
                    $fileName = ExtraField::FIELD_TYPE_FILE_IMAGE."_{$params['item_id']}.png";
                    if (!empty($value['tmp_name']) && isset($value['error']) && 0 === (int) $value['error']) {
                        $repo = Container::getAssetRepository();
                        $asset = (new Asset())
                            ->setCategory(Asset::EXTRA_FIELD)
                            ->setTitle($fileName)
                        ;
                        $cropVariable = 'extra_'.$field_variable.'_crop_result';
                        if (isset($params[$cropVariable])) {
                            $asset->setCrop($params[$cropVariable]);
                        }
                        $asset = $repo->createFromRequest($asset, $value);
                        if ($asset) {
                            $field = Container::getExtraFieldRepository()->find($extraFieldInfo['id']);
                            $extraFieldValues = (new ExtraFieldValues())
                                ->setItemId((int) $params['item_id'])
                                ->setField($field)
                                ->setFieldValue(1)
                                ->setAsset($asset)
                                ->setComment($comment ?? '')
                            ;
                            $em->persist($extraFieldValues);
                            $em->flush();
                        }
                    }
                    break;
                case ExtraField::FIELD_TYPE_FILE:
                    if (isset($value['name']) && !empty($value['tmp_name']) && isset($value['error']) && 0 == $value['error']) {
                        $cleanedName = api_replace_dangerous_char($value['name']);
                        $cleanedName = disable_dangerous_file($cleanedName);
                        $fileName = ExtraField::FIELD_TYPE_FILE."_{$params['item_id']}_$cleanedName";

                        $mimeType = mime_content_type($value['tmp_name']);
                        $file = new UploadedFile($value['tmp_name'], $fileName, $mimeType, null, true);
                        $asset = (new Asset())
                            ->setCategory(Asset::EXTRA_FIELD)
                            ->setTitle($fileName)
                            ->setFile($file);

                        $em->persist($asset);
                        $em->flush();
                        $assetId = $asset->getId();

                        if ($assetId) {
                            $field = Container::getExtraFieldRepository()->find($extraFieldInfo['id']);
                            $extraFieldValues = (new ExtraFieldValues())
                                ->setItemId((int) $params['item_id'])
                                ->setField($field)
                                ->setFieldValue(1)
                                ->setAsset($asset)
                                ->setComment($comment ?? '')
                            ;
                            $em->persist($extraFieldValues);
                            $em->flush();
                        }
                    }
                    break;
                case ExtraField::FIELD_TYPE_CHECKBOX:
                    $fieldToSave = 0;
                    if (is_array($value)) {
                        if (isset($value['extra_'.$field_variable])) {
                            $fieldToSave = 1;
                        }
                    }

                    $newParams = [
                        'item_id' => $params['item_id'],
                        'field_id' => $extraFieldInfo['id'],
                        'field_value' => $fieldToSave,
                        'comment' => $comment,
                    ];
                    $this->save($newParams);

                    break;
                case ExtraField::FIELD_TYPE_DATE:
                    if (is_array($value)) {
                        if (empty($value)) {
                            break;
                        }
                        $value = reset($value);
                    }

                    if (is_string($value) && !empty($value)) {
                        $d = DateTime::createFromFormat('Y-m-d', $value);
                        $valid = $d && $d->format('Y-m-d') === $value;

                        if ($valid) {
                            $newParams = [
                                'item_id' => $params['item_id'],
                                'field_id' => $extraFieldInfo['id'],
                                'field_value' => $value,
                                'comment' => $comment,
                            ];
                            $this->save($newParams, $showQuery);
                        }
                    }
                    break;
                case ExtraField::FIELD_TYPE_DATETIME:
                    $d = DateTime::createFromFormat('Y-m-d H:i', $value);
                    $valid = $d && $d->format('Y-m-d H:i') === $value;
                    if ($valid) {
                        $newParams = [
                            'item_id' => $params['item_id'],
                            'field_id' => $extraFieldInfo['id'],
                            'field_value' => $value,
                            'comment' => $comment,
                        ];
                        $this->save($newParams, $showQuery);
                    }
                    break;
                default:
                    $newParams = [
                        'item_id' => $params['item_id'],
                        'field_id' => $extraFieldInfo['id'],
                        'field_value' => $value,
                        'comment' => $comment,
                    ];
                    $this->save($newParams, $showQuery);
            }
        }

        // ofaj
        // Set user.profile_completed = 1
        /*if ('user' === $this->type) {
            if ('true' === api_get_setting('show_terms_if_profile_completed')) {
                $justTermResults = [];
                foreach ($resultsExist as $term => $value) {
                    if (false !== strpos($term, 'terms_')) {
                        $justTermResults[$term] = $value;
                    }
                }

                $profileCompleted = 0;
                if (!in_array(false, $justTermResults)) {
                    $profileCompleted = 1;
                }

                $userId = $params['item_id'];

                // Check if user has a photo
                $userInfo = api_get_user_info($userId);
                if (empty($userInfo['picture_uri'])) {
                    $profileCompleted = 0;
                }

                $table = Database::get_main_table(TABLE_MAIN_USER);
                $sql = "UPDATE $table SET profile_completed = $profileCompleted WHERE id = $userId";
                Database::query($sql);
                Session::write('profile_completed_result', $justTermResults);
            }
        }*/
    }

    /**
     * Save values in the *_field_values table.
     *
     * @param array $params    Structured array with the values to save
     * @param bool  $showQuery Whether to show the insert query (passed to the parent save() method)
     *
     * @return mixed The result sent from the parent method
     * @assert (array()) === false
     */
    public function save($params, $showQuery = false)
    {
        $extra_field = $this->getExtraField();

        // Setting value to insert.
        $value = $params['field_value'];
        $value_to_insert = null;

        if (is_array($value)) {
            $value_to_insert = implode(';', $value);
        } else {
            $value_to_insert = $value;
        }

        $params['field_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']
            );
            if ($extraFieldInfo) {
                $params['field_id'] = $extraFieldInfo['id'];
            }
        }

        if ($extraFieldInfo) {
            switch ($extraFieldInfo['value_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:
                case ExtraField::FIELD_TYPE_SELECT_WITH_TEXT_FIELD:
                    if (is_array($value)) {
                        $value_to_insert = null;
                        if (isset($value['extra_'.$extraFieldInfo['variable']]) &&
                            isset($value['extra_'.$extraFieldInfo['variable'].'_second'])
                        ) {
                            $value_to_insert = $value['extra_'.$extraFieldInfo['variable']].'::'.$value['extra_'.$extraFieldInfo['variable'].'_second'];
                        }
                    }
                    break;
                default:
                    break;
            }

            if (ExtraField::FIELD_TYPE_TAG == $extraFieldInfo['value_type']) {
                $field_values = self::getAllValuesByItemAndFieldAndValue(
                $field_values = self::getAllValuesByItemAndFieldAndValue(
                    $params['item_id'],
                    $params['field_id'],
                    $value
                );
            } else {
                $field_values = self::get_values_by_handler_and_field_id(
                $field_values = self::get_values_by_handler_and_field_id(
                    $params['item_id'],
                    $params['field_id']
                );
            }

            $params['field_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 (ExtraField::FIELD_TYPE_TAG == $extraFieldInfo['value_type']) {
                    $option = new ExtraFieldOption($this->type);
                    $optionExists = $option->get($params['field_value']);
                    if (empty($optionExists)) {
                        $optionParams = [
                            'field_id' => $params['field_id'],
                            'option_value' => $params['field_value'],
                        ];
                        $optionId = $option->saveOptions($optionParams);
                    } else {
                        $optionId = $optionExists['id'];
                    }

                    $params['field_value'] = $optionId;
                    if ($optionId) {
                        return parent::save($params, $showQuery);
                    }
                } else {
                    return parent::save($params, $showQuery);
                }
            } else {
                // Update
                /* Enable this when field_loggeable is introduced as a table field (2.0)
                if ($extraFieldInfo['field_loggeable'] == 1) {
                */
                $params['id'] = $field_values['id'];

                return parent::update($params, $showQuery);
            }
        }
    }

    /**
     * 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
     *
     * @throws NotSupported
     */
    public function get_values_by_handler_and_field_id($item_id, $field_id, $transform = false)
    {
        /** @var ExtraFieldValuesRepository $efvRepo */
        $efvRepo = Database::getManager()->getRepository(ExtraFieldValues::class);
        /** @var ExtraFieldOptionsRepository $efoRepo */
        $efoRepo = Database::getManager()->getRepository(ExtraFieldOptions::class);

        $results = $efvRepo->getByHandlerAndFieldId(
            (int) $item_id,
            (int) $field_id,
            $this->getExtraField()->getItemType(),
            $transform
        );

        if ($results) {

            /** @var ExtraFieldValues $efv */
            $efv = current($results);

            $result = [
                'id' => $efv->getId(),
                'field_id' => $efv->getField()->getId(),
                'asset_id' => $efv->getAsset()?->getId(),
                'field_value' => $efv->getFieldValue(),
                'item_id' => $efv->getItemId(),
                'comment' => $efv->getComment(),
                'created_at' => $efv->getCreatedAt()->format('Y-m-d H:i:s'),
                'updated_at' => $efv->getUpdatedAt()->format('Y-m-d H:i:s'),
                'value_type' => $efv->getField()->getValueType(),
            ];

            if ($transform) {
                if (!empty($result['field_value'])) {
                    switch ($result['value_type']) {
                        case ExtraField::FIELD_TYPE_DOUBLE_SELECT:
                            $field_option = new ExtraFieldOption($this->type);
                            $options = explode('::', $result['field_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_MULTIPLE:
                            $optionIds = explode(';', $result['field_value']);
                            $optionValues = [];
                            $objEfOption = new ExtraFieldOption($this->type);
                            $options = $objEfOption->get_field_options_by_field($result['field_id']);
                            if (!empty($options)) {
                                $options = array_column($options, 'display_text', 'option_value');
                            }
                            foreach ($optionIds as $option) {
                                if (!empty($options) && isset($options[$option])) {
                                    $optionValues[] = $options[$option];
                                    continue;
                                }
                                $optionValues[] = $option;
                            }

                            $result['value'] = implode(' <br /> ', $optionValues);
                            break;
                        case ExtraField::FIELD_TYPE_SELECT:
                            $extra_field_option_result = $efoRepo->getFieldOptionByFieldAndOption(
                                (int) $result['field_id'],
                                (string) $result['field_value'],
                                $this->getExtraField()->getItemType()
                            );

                            if ($extra_field_option_result) {

                                $result['value'] = $extra_field_option_result[0]->getDisplayText();
                            }

                            break;
                        case ExtraField::FIELD_TYPE_SELECT_WITH_TEXT_FIELD:
                            $options = explode('::', $result['field_value']);
                            $field_option = new ExtraFieldOption($this->type);
                            $result = $field_option->get($options[0]);

                            if (!empty($result)) {
                                $result['value'] = $result['display_text'].'&rarr;'.$options[1];
                            }
                            break;
                        case ExtraField::FIELD_TYPE_TRIPLE_SELECT:
                            $optionIds = explode(';', $result['field_value']);
                            $optionValues = [];
                            foreach ($optionIds as $optionId) {
                                $objEfOption = new ExtraFieldOption($this->type);
                                $optionInfo = $objEfOption->get($optionId);
                                $optionValues[] = $optionInfo['display_text'];
                            }

                            $result['value'] = implode(' / ', $optionValues);
                            break;
                    }
                }
            }

            return $result;
        }

        return false;
    }

    /**
     * @param string $tag
     * @param int    $field_id
     * @param int    $limit
     *
     * @return array
     */
    public function searchValuesByField($tag, $field_id, $limit = 10)
    {
        $field_id = (int) $field_id;
        $limit = (int) $limit;
        $tag = Database::escape_string($tag);

        $extraFieldType = $this->getExtraField()->getItemType();

        $sql = "SELECT DISTINCT s.field_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
                    field_value LIKE '%$tag%' AND
                    sf.item_type = ".$extraFieldType."
                ORDER BY field_value
                LIMIT 0, $limit
                ";
        $result = Database::query($sql);
        $values = [];
        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   $filterByVisibility
     * @param int    $visibility
     *
     * @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 = (int) $item_id;
        $field_variable = Database::escape_string($field_variable);
        $extraFieldType = $this->getExtraField()->getItemType();

        $sql = "SELECT s.*, value_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.item_type = $extraFieldType
                ";
        if ($filterByVisibility) {
            $visibility = (int) $visibility;
            $sql .= " AND visible_to_self = $visibility ";
        }
        $sql .= ' ORDER BY id';

        $repo = Container::getAssetRepository();

        $result = Database::query($sql);
        if (Database::num_rows($result)) {
            $result = Database::fetch_assoc($result);
            $result['value'] = $result['field_value'];
            if ($transform) {
                $fieldType = $result['value_type'];
                if (ExtraField::FIELD_TYPE_DOUBLE_SELECT == $fieldType) {
                    if (!empty($result['field_value'])) {
                        $field_option = new ExtraFieldOption($this->type);
                        $options = explode('::', $result['field_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'];
                        }
                    }
                }
                if (ExtraField::FIELD_TYPE_SELECT_WITH_TEXT_FIELD == $fieldType) {
                    if (!empty($result['field_value'])) {
                        $options = explode('::', $result['field_value']);
                        $field_option = new ExtraFieldOption($this->type);
                        $result = $field_option->get($options[0]);
                        if (!empty($result)) {
                            $result['value'] = $result['display_text']
                                .'&rarr;'
                                .$options[1];
                        }
                    }
                }
                if (ExtraField::FIELD_TYPE_TRIPLE_SELECT == $fieldType) {
                    if (!empty($result['field_value'])) {
                        $optionIds = explode(';', $result['field_value']);
                        $optionValues = [];
                        foreach ($optionIds as $optionId) {
                            $objEfOption = new ExtraFieldOption('user');
                            $optionInfo = $objEfOption->get($optionId);

                            $optionValues[] = $optionInfo['display_text'];
                        }

                        $result['value'] = implode(' / ', $optionValues);
                    }
                }

                if (in_array($result['value_type'], ExtraField::getExtraFieldTypesWithFiles())) {
                    $result['url'] = '';
                    if (!empty($result['asset_id'])) {
                        $asset = $repo->find($result['asset_id']);
                        if ($asset) {
                            $url = $repo->getAssetUrl($asset);
                            $result['url'] = $url;
                        }
                    }
                }
            }

            return $result;
        }

        return false;
    }

    /**
     * Gets the ID from the item (course, session, etc) for which
     * the given field is defined with the given value.
     *
     * @param string $variable  Field (type of data) we want to check
     * @param string $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
     * @param bool   $useLike
     *
     * @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(
        $variable,
        $value,
        $transform = false,
        $last = false,
        $all = false,
        $useLike = false
    ) {
        $value = Database::escape_string($value);
        $variable = Database::escape_string($variable);

        $valueCondition = " field_value  = '$value' AND ";
        if ($useLike) {
            $valueCondition = " field_value LIKE '%".$value."%' AND ";
        }
        $extraFieldType = $this->getExtraField()->getItemType();

        $sql = "SELECT item_id FROM {$this->table} s
                INNER JOIN {$this->table_handler_field} sf
                ON (s.field_id = sf.id)
                WHERE
                    $valueCondition
                    variable = '".$variable."' AND
                    sf.item_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 (false !== $result && Database::num_rows($result)) {
            if ($all) {
                $result = Database::store_result($result, 'ASSOC');
            } else {
                $result = Database::fetch_assoc($result);
            }

            return $result;
        }

        return false;
    }

    /**
     * Get all the values stored for one specific field.
     *
     * @param int $fieldId
     *
     * @return array|bool
     */
    public function getValuesByFieldId($fieldId)
    {
        $fieldId = (int) $fieldId;
        $extraFieldType = $this->getExtraField()->getItemType();

        $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.item_type = $extraFieldType
                ORDER BY s.field_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 = (int) $fieldId;
        $itemId = (int) $itemId;
        $extraFieldType = $this->getExtraField()->getItemType();

        $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.item_type = $extraFieldType
                ORDER BY s.field_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 = (int) $itemId;
        $extraFieldType = $this->getExtraField()->getItemType();

        $sql = "SELECT s.field_value, s.field_value as value, sf.variable, sf.value_type, sf.id, sf.display_text, s.asset_id
                FROM {$this->table} s
                INNER JOIN {$this->table_handler_field} sf
                ON (s.field_id = sf.id)
                WHERE
                    item_id = '$itemId' AND
                    sf.item_type = $extraFieldType
                ORDER BY s.field_value";

        $result = Database::query($sql);
        $idList = [];
        if (Database::num_rows($result)) {
            $result = Database::store_result($result, 'ASSOC');
            $finalResult = [];

            $repo = Container::getAssetRepository();
            foreach ($result as $item) {
                $fieldType = (int) $item['value_type'];
                $item['url'] = '';
                if (!empty($item['asset_id']) &&
                    in_array($fieldType, ExtraField::getExtraFieldTypesWithFiles(), true)
                ) {
                    $asset = $repo->find($item['asset_id']);
                    if ($asset) {
                        $url = $repo->getAssetUrl($asset);
                        $item['url'] = $url;
                    }
                }
                $finalResult[$item['id']] = $item;
            }
            $idList = array_column($result, 'id');
        }

        $em = Database::getManager();

        $extraField = new ExtraField($this->type);
        $allData = $extraField->get_all(['filter = ?' => 1]);
        $allResults = [];
        foreach ($allData as $field) {
            $fieldType = (int) $field['value_type'];
            if (in_array($field['id'], $idList)) {
                $allResults[] = $finalResult[$field['id']];

            } else {
                if (ExtraField::FIELD_TYPE_TAG === $fieldType) {
                    $tagResult = [];
                    $tags = $em->getRepository(ExtraFieldRelTag::class)
                        ->findBy(
                            [
                                'field' => $field['id'],
                                'itemId' => $itemId,
                            ]
                        );
                    if ($tags) {
                        /** @var ExtraFieldRelTag $extraFieldTag */
                        foreach ($tags as $extraFieldTag) {
                            $tag = $extraFieldTag->getTag();
                            $tagResult[] = [
                                'id' => $extraFieldTag->getTag()->getId(),
                                'value' => $tag->getTag(),
                            ];
                        }
                    }
                    $allResults[] = [
                        'value' => $tagResult,
                        'variable' => $field['variable'],
                        'value_type' => $field['value_type'],
                        'id' => $field['id'],
                    ];
                }
            }
        }

        return $allResults;
    }

    /**
     * @param int    $itemId
     * @param int    $fieldId
     * @param string $fieldValue
     *
     * @return array|bool
     */
    public function getAllValuesByItemAndFieldAndValue($itemId, $fieldId, $fieldValue)
    {
        $fieldId = (int) $fieldId;
        $itemId = (int) $itemId;
        $extraFieldType = $this->getExtraField()->getItemType();

        $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
                    field_value = '$fieldValue' AND
                    sf.item_type = $extraFieldType
                ORDER BY field_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
     *
     * @assert ('a') == null
     */
    public function delete_all_values_by_field_id($field_id)
    {
        $field_id = (int) $field_id;
        $sql = "DELETE FROM {$this->table}
                WHERE
                    field_id = $field_id ";
        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 = (int) $itemId;
        $extraFieldType = $this->getExtraField()->getItemType();
        $sql = "SELECT DISTINCT fv.id, field_value, value_type FROM {$this->table} fv
                INNER JOIN {$this->table_handler_field} f
                ON (fv.field_id = f.id)
                WHERE item_type = $extraFieldType AND item_id = $itemId";
        $result = Database::query($sql);
        $result = Database::store_result($result, 'ASSOC');
        $em = Database::getManager();
        $repo = Container::getAssetRepository();
        foreach ($result as $item) {
            $valueType = (int) $item['value_type'];
            if (!empty($item['asset_id']) &&
                in_array($valueType, ExtraField::getExtraFieldTypesWithFiles(), true)
            ) {
                $asset = $repo->find($item['asset_id']);
                if ($asset) {
                    $em->remove($asset);
                }
            }
        }
        $em->flush();

        $sql = "DELETE FROM {$this->table}
                WHERE
                    item_id = '$itemId' AND
                    field_id IN (
                        SELECT id FROM {$this->table_handler_field}
                        WHERE item_type = $extraFieldType
                    )
                ";
        Database::query($sql);
    }

    /**
     * @param int        $itemId
     * @param int        $fieldId
     * @param string|int $fieldValue
     *
     * @return bool
     */
    public function deleteValuesByHandlerAndFieldAndValue($itemId, $fieldId, $fieldValue)
    {
        $itemId = (int) $itemId;
        $fieldId = (int) $fieldId;
        $fieldData = $this->getExtraField()->get($fieldId);
        if ($fieldData) {
            $fieldValue = Database::escape_string($fieldValue);

            $sql = "DELETE FROM {$this->table}
                    WHERE
                        item_id = '$itemId' AND
                        field_id = '$fieldId' AND
                        field_value = '$fieldValue'
                    ";
            Database::query($sql);

            // Delete file from uploads.
            if (isset($fieldData['asset_id']) &&
                in_array($fieldData['value_type'], ExtraField::getExtraFieldTypesWithFiles())
            ) {
                $repo = Container::getAssetRepository();
                $asset = $repo->find($fieldData['asset_id']);
                if (null !== $asset) {
                    $repo->delete($asset);
                }
            }

            return true;
        }

        return false;
    }

    /**
     * Get all values for an item.
     *
     * @param int  $itemId          The item ID
     * @param bool $visibleToSelf   Get the visible extra field only
     * @param bool $visibleToOthers
     *
     * @return array
     */
    public function getAllValuesForAnItem($itemId, $visibleToSelf = null, $visibleToOthers = null)
    {
        $em = Database::getManager();
        $qb = $em->createQueryBuilder();
        $qb = $qb->select('fv')
            ->from(ExtraFieldValues::class, 'fv')
            ->join('fv.field', 'f')
            ->where(
                $qb->expr()->eq('fv.itemId', ':item')
            )
            ->andWhere(
                $qb->expr()->eq('f.itemType', ':item_type')
            );

        if (is_bool($visibleToSelf)) {
            $qb
                ->andWhere($qb->expr()->eq('f.visibleToSelf', ':visibleToSelf'))
                ->setParameter('visibleToSelf', $visibleToSelf);
        }

        if (is_bool($visibleToOthers)) {
            $qb
                ->andWhere($qb->expr()->eq('f.visibleToOthers', ':visibleToOthers'))
                ->setParameter('visibleToOthers', $visibleToOthers);
        }

        $fieldValues = $qb
            ->setParameter('item', $itemId)
            ->setParameter('item_type', $this->getExtraField()->getItemType())
            ->getQuery()
            ->getResult();

        $fieldOptionsRepo = $em->getRepository(ExtraFieldOptions::class);

        $valueList = [];
        /** @var ExtraFieldValues $fieldValue */
        foreach ($fieldValues as $fieldValue) {
            $item = ['value' => $fieldValue];
            switch ($fieldValue->getField()->getValueType()) {
                case ExtraField::FIELD_TYPE_SELECT:
                    $item['option'] = $fieldOptionsRepo->findOneBy([
                        'field' => $fieldValue->getField(),
                        'value' => $fieldValue->getFieldValue(),
                    ]);
                    break;
            }
            $valueList[] = $item;
        }

        return $valueList;
    }

    public function copy($sourceId, $destinationId)
    {
        if (empty($sourceId) || empty($destinationId)) {
            return false;
        }

        $extraField = new ExtraField($this->type);
        $allFields = $extraField->get_all();
        $extraFieldValue = new ExtraFieldValue($this->type);
        foreach ($allFields as $field) {
            $variable = $field['variable'];
            $sourceValues = $extraFieldValue->get_values_by_handler_and_field_variable($sourceId, $variable);
            if (!empty($sourceValues) && isset($sourceValues['value']) && '' != $sourceValues['value']) {
                $params = [
                    'extra_'.$variable => $sourceValues['value'],
                    'item_id' => $destinationId,
                ];
                $extraFieldValue->saveFieldValues($params, true);
            }
        }

        return true;
    }
}

chamilo / chamilo-lms

ExtraFieldValue::getExtraField() A last analyzed 2025-12-26 22:47 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ExtraFieldValue::getExtraField() A
last analyzed 2025-12-26 22:47 UTC
