chamilo / chamilo-lms

plugin/check_extra_field_author_company/CheckExtraFieldAuthorsCompanyPlugin.php

<?php

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

class CheckExtraFieldAuthorsCompanyPlugin extends Plugin
{
    /**
     * @var string
     */
    protected $tblExtraFieldOption;

    /**
     * @var string
     */
    protected $tblExtraField;

    /**
     * @var bool
     */
    protected $authorsExist;

    /**
     * @var bool
     */
    protected $companyExist;

    /**
     * @var array
     */
    protected $authorsField;

    /**
     * @var array
     */
    protected $companyField;

    public function __construct()
    {
        parent::__construct(
            '1.2',
            'Carlos Alvarado, Julio Montoya'
        );
        $this->tblExtraField = Database::get_main_table(TABLE_EXTRA_FIELD);
        $this->tblExtraFieldOption = Database::get_main_table(TABLE_EXTRA_FIELD_OPTIONS);
        $field = new ExtraField('user');
        $companyField = $field->get_handler_field_info_by_field_variable('company');
        $this->companyExist = false;
        if (empty($companyField)) {
            $this->companyExist = true;
            $this->companyField = $companyField;
        } else {
            $this->companyField = [
                'field_type' => ExtraField::FIELD_TYPE_RADIO,
                'variable' => 'company',
                'display_text' => 'Company',
                'default_value' => '',
                'field_order' => 0,
                'visible_to_self' => 0,
                'visible_to_others' => 0,
                'changeable' => 1,
                'filter' => 1,
            ];
        }
        $field = new ExtraField('lp');
        $authorsField = $field->get_handler_field_info_by_field_variable('authors');

        $this->authorsExist = false;
        if (empty($authorsField)) {
            $this->authorsExist = true;
            $this->authorsField = $authorsField;
        }
    }

    /**
     * Create a new instance of CheckExtraFieldAuthorsCompanyPlugin.
     *
     * @return CheckExtraFieldAuthorsCompanyPlugin
     */
    public static function create()
    {
        static $result = null;

        return $result ? $result : $result = new self();
    }

    /**
     * Perform the plugin installation.
     */
    public function install()
    {
        $this->saveCompanyField();
        $this->setCompanyExtrafieldData();
        $this->saveAuthorsField();
        $this->savePrice();
        $this->saveAuthorLPItem();
        $this->saveAuthorLp();
    }

    /**
     * Save the arrangement for company, it is adjusted internally so that the values match the necessary ones.
     */
    public function saveCompanyField()
    {
        $data = $this->companyField;
        $data['field_type'] = (int) $data['field_type'];
        $data['field_order'] = (int) $data['field_order'];
        $data['visible_to_self'] = (int) $data['visible_to_self'];
        $data['visible_to_others'] = (int) $data['visible_to_others'];
        $data['changeable'] = (int) $data['changeable'];
        $data['filter'] = (int) $data['filter'];
        $data['default_value'] = '';
        $data['variable'] = 'company';
        $data['visible'] = 1;
        $data['display_text'] = strtolower(Database::escape_string($data['display_text']));
        $schedule = new ExtraField('user');
        $this->companyField['id'] = $schedule->save($data);
    }

    /**
     * Insert the option fields for company with the generic values Company 1, company 2 and company 3.
     */
    public function setCompanyExtrafieldData()
    {
        $companies = [
            0 => 'Company 1',
            1 => 'Company 2',
            2 => 'Company 3',
        ];
        $companyId = (int) $this->companyField['id'];
        if ($companyId != 0) {
            for ($i = 0; $i < count($companies); $i++) {

It seems like you are calling the size function count() as part of the test condition. You might want to compute the size beforehand, and not on each iteration.

                $order = $i + 1;
                $extraFieldOptionValue = $companies[$i];
                if ($companyId != null) {
                    $query = "SELECT *
                              FROM ".$this->tblExtraFieldOption."
                              WHERE
                                    option_value = '$extraFieldOptionValue' AND
                                    field_id = $companyId";
                    $extraFieldOption = Database::fetch_assoc(Database::query($query));
                    if (isset($extraFieldOption['id']) && $extraFieldOption['id'] && $extraFieldOption['field_id'] == $companyId) {
                        // Update?
                    } else {
                        $query = "
                        INSERT INTO ".$this->tblExtraFieldOption."
                            (`field_id`, `option_value`, `display_text`, `priority`, `priority_message`, `option_order`) VALUES
                            ( '$companyId', '$extraFieldOptionValue', '$extraFieldOptionValue', NULL, NULL, '$order');
                        ";
                        Database::query($query);
                    }
                }
            }
        }
    }

    /**
     * Save the arrangement for authors, it is adjusted internally so that the values match the necessary ones.
     */
    public function saveAuthorsField()
    {
        $data = [
            'field_type' => ExtraField::FIELD_TYPE_SELECT_MULTIPLE,
            'variable' => 'authors',
            'display_text' => 'Authors',
            'default_value' => '',
            'field_order' => 0,
            'visible_to_self' => 1,
            'visible_to_others' => 0,
            'changeable' => 1,
            'filter' => 1,
        ];
        $schedule = new ExtraField('lp');
        $schedule->save($data);
    }

    /**
     * Save the arrangement for price, it is adjusted internally so that the values match the necessary ones.
     */
    public function savePrice()
    {
        $schedule = new ExtraField('lp_item');
        $data = [];
        $data['visible_to_self'] = 1;
        $data['visible_to_others'] = 1;
        $data['changeable'] = 1;
        $data['filter'] = 0;
        $data['variable'] = 'price';
        $data['display_text'] = 'SalePrice';
        $data['field_type'] = ExtraField::FIELD_TYPE_INTEGER;

        $schedule->save($data);
    }

    /**
     * Save the arrangement for AuthorLPItem, it is adjusted internally so that the values match the necessary ones.
     */
    public function saveAuthorLPItem()
    {
        $schedule = new ExtraField('lp_item');
        $data = [];
        $data['visible_to_self'] = 1;
        $data['visible_to_others'] = 0;
        $data['changeable'] = 1;
        $data['filter'] = 0;
        $data['variable'] = 'authorlpitem';
        $data['display_text'] = 'LearningPathItemByAuthor';
        $data['field_type'] = ExtraField::FIELD_TYPE_SELECT_MULTIPLE;
        $schedule->save($data);
    }

    /**
     * Save the arrangement for authorlp, it is adjusted internally so that the values match the necessary ones.
     */
    public function saveAuthorLp()
    {
        $schedule = new ExtraField('user');
        $data = [];
        $data['variable'] = 'authorlp';
        $data['display_text'] = 'authors';
        $data['changeable'] = 1;
        $data['visible_to_self'] = 1;
        $data['visible_to_others'] = 0;
        $data['filter'] = 0;
        $data['field_type'] = ExtraField::FIELD_TYPE_CHECKBOX;
        $schedule->save($data);
    }

    /**
     * Remove the extra fields set by the plugin.
     */
    public function uninstall()
    {
        $companyExist = $this->companyFieldExist();
        if ($companyExist == true) {

It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

            // $this->removeCompanyField();
        }
        $authorsExist = $this->authorsFieldExist();
        if ($authorsExist == true) {

It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

            // $this->removeAuthorsField();
        }
    }

    /**
     * Verify that the "company" field exists in the database.
     *
     * @return bool
     */
    public function companyFieldExist()
    {
        $this->getCompanyField();
        $this->companyExist = (isset($this->companyField['id'])) ? true : false;

        return $this->companyExist;
    }

    /**
     * Returns the content of the extra field "company" if it exists in the database, if not, it returns an arrangement
     * with the basic elements for its operation.
     *
     * @return array
     */
    public function getCompanyField()
    {
        $companyField = $this->getInfoExtrafield('company');
        if (count($companyField) > 1) {
            $this->companyField = $companyField;
        } else {
            $companyField = $this->companyField;
        }

        return $companyField;
    }

    /**
     * Verify that the "authors" field exists in the database.
     *
     * @return bool
     */
    public function authorsFieldExist()
    {
        $this->getAuthorsField();
        $this->authorsExist = (isset($this->authorsField['id'])) ? true : false;

        return $this->authorsExist;
    }

    /**
     * Returns the content of the extra field "authors" if it exists in the database, if not, it returns an arrangement
     * with the basic elements for its operation.
     *
     * @return array
     */
    public function getAuthorsField()
    {
        $schedule = new ExtraField('lp');
        $data = $schedule->get_handler_field_info_by_field_variable('authors');
        if (empty($data)) {
            $this->authorsField = $data;
        } else {
            $data = $this->authorsField;
        }

        return $data;
    }

    /**
     * Remove the extra fields "company".
     */
    public function removeCompanyField()
    {
        $data = $this->getCompanyField();
        // $this->deleteQuery($data);
    }

    /**
     * Remove the extra fields "authors".
     */
    public function removeAuthorsField()
    {
        $data = $this->getAuthorsField();
        // $this->deleteQuery($data);
    }

    /**
     * Executes fix removal for authors or company.
     *
     * @param $data
     */
    protected function deleteQuery($data)
    {
        $exist = null;
        $validVariable = false;
        $variable = $data['variable'];
        $extraFieldTypeInt = (int) $data['extra_field_type'];
        $FieldType = (int) $data['field_type'];
        $id = (int) $data['id'];
        $extraFieldType = null;
        if ($variable === 'company') {
            $validVariable = true;
            $extraFieldType = 'user';
        } elseif ($variable === 'authors') {
            $validVariable = true;
            $extraFieldType = 'lp';
        }
        if ($validVariable == true && $id != 0 && !empty($extraFieldType)) {

It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

            $query = "SELECT id
                        FROM
                            ".$this->tblExtraField."
                        WHERE
                            id = $id AND
                            variable = '$variable' AND
                            extra_field_type = $extraFieldTypeInt AND
                            field_type = $FieldType
                        ";
            $data = Database::fetch_assoc(Database::query($query));
            if (isset($data['id'])) {
                $obj = new ExtraField($extraFieldType);
                $obj->delete($data['id']);
            }
        }
    }

    /**
     * Returns the array of an element in the database that matches the variable.
     *
     * @param string $variableName
     *
     * @return array
     */
    protected function getInfoExtrafield($variableName = null)
    {
        if ($variableName == null) {

It seems like you are loosely comparing $variableName of type null|string against null; this is ambiguous if the string can be empty. Consider using a strict comparison === instead.

            return [];
        }
        $variableName = strtolower(Database::escape_string($variableName));
        $tblExtraField = $this->tblExtraField;
        $query = "SELECT * FROM $tblExtraField WHERE variable = '$variableName'";
        $data = Database::fetch_assoc(Database::query($query));
        if ($data == false || !isset($data['display_text'])) {
            return [];
        }

        return $data;
    }
}