Multiline.php

Go to the documentation of this file.

<?php
namespace Magento\Eav\Model\Attribute\Data;

use Magento\Framework\App\RequestInterface;

class Multiline extends \Magento\Eav\Model\Attribute\Data\Text
{
    public function extractValue(RequestInterface $request)
    {
        $value = $this->_getRequestValue($request);
        if (!is_array($value)) {
            $value = false;
        } else {
            $value = array_map([$this, '_applyInputFilter'], $value);
        }
        return $value;
    }

    public function validateValue($value)
    {
        $errors = [];
        $lines = $this->processValue($value);
        $attribute = $this->getAttribute();

        if ($attribute->getIsRequired() && empty($lines)) {
            $attributeLabel = __($attribute->getStoreLabel());
            $errors[] = __('"%1" is a required value.', $attributeLabel);
        }

        $maxAllowedLineCount = $attribute->getMultilineCount();
        if (count($lines) > $maxAllowedLineCount) {
            $attributeLabel = __($attribute->getStoreLabel());
            $errors[] = __('"%1" cannot contain more than %2 lines.', $attributeLabel, $maxAllowedLineCount);
        }

        foreach ($lines as $lineIndex => $line) {
            // First line must be always validated
            if ($lineIndex == 0 || !empty($line)) {
                $result = parent::validateValue($line);
                if ($result !== true) {
                    $errors = array_merge($errors, $result);
                }
            }
        }

        return (count($errors) == 0) ? true : $errors;
    }

    protected function processValue($value)
    {
        if ($value === false) {
            // try to load original value and validate it
            $attribute = $this->getAttribute();
            $entity = $this->getEntity();
            $value = $entity->getDataUsingMethod($attribute->getAttributeCode());
        }
        if (!is_array($value)) {
            $value = explode("\n", $value);
        }
        return $value;
    }

    public function compactValue($value)
    {
        if (is_array($value)) {
            $value = trim(implode("\n", $value));
        }
        return parent::compactValue($value);
    }

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

    public function outputValue($format = \Magento\Eav\Model\AttributeDataFactory::OUTPUT_FORMAT_TEXT)
    {
        $values = $this->getEntity()->getData($this->getAttribute()->getAttributeCode());
        if (!is_array($values)) {
            $values = explode("\n", $values);
        }
        $values = array_map([$this, '_applyOutputFilter'], $values);
        switch ($format) {
            case \Magento\Eav\Model\AttributeDataFactory::OUTPUT_FORMAT_ARRAY:
                $output = $values;
                break;
            case \Magento\Eav\Model\AttributeDataFactory::OUTPUT_FORMAT_HTML:
                $output = implode("<br />", $values);
                break;
            case \Magento\Eav\Model\AttributeDataFactory::OUTPUT_FORMAT_ONELINE:
                $output = implode(" ", $values);
                break;
            default:
                $output = implode("\n", $values);
                break;
        }
        return $output;
    }
}