DocumentFormField::getHelpText() - Code Metrics - Inspection of "Context sensitive help texts for fields." - kitodo/kitodo-publication - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 211177...134b43 )

by Ralf
created 2021-06-04 13:08 UTC
DocumentFormField::getHelpText() A

↳ Parent: DocumentFormField
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	1
c	0
b	0
f	0
dl	0
loc	3
rs	10
cc	1
nc	1
nop	0
<?php
namespace EWW\Dpf\Domain\Model;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

class DocumentFormField extends AbstractFormElement
{

    protected $value;

    protected $inputField;

    protected $selectOptions;

    protected $inputOptions;

    protected $fillOutService;

    protected $defaultInputOption;

    protected $hasDefaultValue = false;

    protected $validation;

    protected $depositLicense = null;

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

    /**
     * @var int
     */
    protected $gndFieldUid;

    /**
     * consent
     *
     * @var boolean
     */
    protected $consent;

    /**
     * @var int
     */
    protected $maxInputLength;

    /**
     * help text
     *
     * @var string
     */
    protected $helpText = '';

    /**
     * @var string
     */
    protected $objectType = '';

    public function getValue()
    {
        return $this->value;
    }

    public function setValue($value, $defaultValue = '')
    {

        $this->hasDefaultValue = !empty($defaultValue);

        if (empty($value)) {
            switch ($this->inputField) {
                case \EWW\Dpf\Domain\Model\MetadataObject::select:
                    if (!empty($defaultValue)) {
                        $this->value = $this->defaultInputOption;
                    } else {
                        $this->value = '';
                    }
                    break;

                case \EWW\Dpf\Domain\Model\MetadataObject::checkbox:
                    if (!empty($defaultValue)) {
                        $this->value = 'yes';
                    } else {
                        $this->value = '';
                    }
                    break;

                default:
                    $this->value = $defaultValue;
                    break;
            }
        } else {
            $this->value = $value;
        }
    }

    public function getInputField()
    {
        return $this->inputField;
    }

    public function setInputField($inputField)
    {
        $this->inputField = $inputField;
    }

    /**
     *
     * @return array
     */
    public function getInputOptions()
    {
        return $this->inputOptions;
    }

    /**
     *
     * @param \EWW\Dpf\Domain\Model\InputOptionList $inputOptionList
     */
    public function setInputOptions(\EWW\Dpf\Domain\Model\InputOptionList $inputOptionList = null)
    {

        $this->inputOptions = array();

        if ($inputOptionList) {
            $this->inputOptions[''] = '';
            foreach ($inputOptionList->getInputOptions() as $option => $label) {
                $this->inputOptions[$option] = $label;
            }

            $this->defaultInputOption = trim($inputOptionList->getDefaultValue());
        }

    }

    /**
     * Returns the fillOutService
     *
     * @return string $fillOutService
     */
    public function getFillOutService()
    {
        return $this->fillOutService;
    }

    /**
     * Sets the fillOutService
     *
     * @param string $fillOutService
     * @return void
     */
    public function setFillOutService($fillOutService)
    {
        $this->fillOutService = $fillOutService;
    }

    /**
     * Returns the consent
     *
     * @return boolean $consent
     */
    public function getConsent()
    {
        return $this->consent;
    }

    /**
     * Sets the consent
     *
     * @param boolean $consent
     * @return void
     */
    public function setConsent($consent)
    {
        $this->consent = boolval($consent);
    }

    public function getHasDefaultValue()
    {
        return $this->hasDefaultValue;
    }

    public function getValidation()
    {
        return $this->validation;
    }

    public function setValidation($validation)
    {
        $this->validation = $validation;
    }

    /**
     * Gets the data type of the field, e.g. DATE
     *
     * @return string
     */
    public function getDataType()
    {
        return $this->dataType;
    }

    /**
     * Sets the data type of the field, e.g. DATE
     *
     * @param string $dataType
     * @return void
     */
    public function setDataType($dataType)
    {
        $this->dataType = $dataType;
    }

    /**
     * Gets the uid of the field which is
     * linked with the gnd field
     *
     * @return int
     */
    public function getGndFieldUid() {
        return $this->gndFieldUid;
    }

    /**
     * Sets the uid of the field which is
     * linked with the gnd field
     *
     * @param int $fieldId
     * @return void
     */
    public function setGndFieldUid($fieldId) {
        $this->gndFieldUid = $fieldId;
    }

    /**
     * Gets the max length of characters for the input field.
     *
     * @return int
     */
    public function getMaxInputLength() {
        return $this->maxInputLength;
    }

    /**
     * Sets the max length of characters for the input field.
     *
     * @return int
     */
    public function setMaxInputLength($maxInputLength) {
        $this->maxInputLength = $maxInputLength;
    }

    /**
     * @return string
     */
    public function getObjectType(): string
    {
        return $this->objectType;
    }

    /**
     * @param string $objectType
     */
    public function setObjectType(string $objectType): void
    {
        $this->objectType = $objectType;
    }

    /**
     * @return mixed
     */
    public function getDepositLicense()
    {
        return $this->depositLicense;
    }

    /**
     * @param mixed $depositLicense
     */
    public function setDepositLicense($depositLicense): void
    {
        $this->depositLicense = $depositLicense;
    }

    /**
     * @return string
     */
    public function getHelpText(): string
    {
        return $this->helpText;
    }

    /**
     * @param string $helpText
     */
    public function setHelpText(string $helpText): void
    {
        $this->helpText = $helpText;
    }

    public function getHelpTextLong()
    {
        if ($this->helpText) {
            $domDocument = new \DOMDocument();
            $domDocument->loadXML("<html>".$this->helpText."</html>");
            $xpath = \EWW\Dpf\Helper\XPath::create($domDocument);
            $nodes = $xpath->query("//p");
            if ($nodes->length > 1) {
                $domDocument->firstChild->removeChild($nodes->item(0));
                                          removeChild($nodes->item(0));
                return str_replace(['<html>','</html>'], '', $domDocument->saveHTML());
            }
        }
    }

    public function getHelpTextShort()
    {
        if ($this->helpText) {
            $domDocument = new \DOMDocument();
            $domDocument->loadXML("<html>".$this->helpText."</html>");
            $xpath = \EWW\Dpf\Helper\XPath::create($domDocument);
            $nodes = $xpath->query("//p");
            if ($nodes->length > 0) {
                return $nodes->item(0)->nodeValue;
            }
        }
    }

}

kitodo / kitodo-publication

Push — master ( 211177...134b43 )

DocumentFormField::getHelpText() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
