Validator.php

Go to the documentation of this file.

<?php
namespace Magento\Backend\Model\Menu\Item;

class Validator
{
    protected $_required = ['id', 'title', 'resource'];

    protected $_ids = [];

    protected $_validators = [];

    public function __construct()
    {
        $idValidator = new \Zend_Validate();
        $idValidator->addValidator(new \Zend_Validate_StringLength(['min' => 3]));
        $idValidator->addValidator(new \Zend_Validate_Regex('/^[A-Za-z0-9\/:_]+$/'));

        $resourceValidator = new \Zend_Validate();
        $resourceValidator->addValidator(new \Zend_Validate_StringLength(['min' => 8]));
        $resourceValidator->addValidator(
            new \Zend_Validate_Regex('/^[A-Z][A-Za-z0-9]+_[A-Z][A-Za-z0-9]+::[A-Za-z_0-9]+$/')
        );

        $attributeValidator = new \Zend_Validate();
        $attributeValidator->addValidator(new \Zend_Validate_StringLength(['min' => 3]));
        $attributeValidator->addValidator(new \Zend_Validate_Regex('/^[A-Za-z0-9\/_]+$/'));

        $textValidator = new \Zend_Validate_StringLength(['min' => 3, 'max' => 50]);

        $titleValidator = $tooltipValidator = $textValidator;
        $actionValidator = $moduleDepValidator = $configDepValidator = $attributeValidator;

        $this->_validators['id'] = $idValidator;
        $this->_validators['title'] = $titleValidator;
        $this->_validators['action'] = $actionValidator;
        $this->_validators['resource'] = $resourceValidator;
        $this->_validators['dependsOnModule'] = $moduleDepValidator;
        $this->_validators['dependsOnConfig'] = $configDepValidator;
        $this->_validators['toolTip'] = $tooltipValidator;
    }

    public function validate($data)
    {
        if ($this->checkMenuItemIsRemoved($data)) {
            return;
        }

        $this->assertContainsRequiredParameters($data);
        $this->assertIdentifierIsNotUsed($data['id']);

        foreach ($data as $param => $value) {
            $this->validateMenuItemParameter($param, $value);
        }
        $this->_ids[] = $data['id'];
    }

    private function checkMenuItemIsRemoved($data)
    {
        return isset($data['id'], $data['removed']) && $data['removed'] === true;
    }

    private function assertContainsRequiredParameters($data)
    {
        foreach ($this->_required as $param) {
            if (!isset($data[$param])) {
                throw new \BadMethodCallException('Missing required param ' . $param);
            }
        }
    }

    private function assertIdentifierIsNotUsed($id)
    {
        if (array_search($id, $this->_ids) !== false) {
            throw new \InvalidArgumentException('Item with id ' . $id . ' already exists');
        }
    }

    private function validateMenuItemParameter($param, $value)
    {
        if ($value === null) {
            return;
        }
        if (!isset($this->_validators[$param])) {
            return;
        }

        $validator = $this->_validators[$param];
        if ($validator->isValid($value)) {
            return;
        }

        throw new \InvalidArgumentException(
            "Param " . $param . " doesn't pass validation: " . implode(
                '; ',
                $validator->getMessages()
            )
        );
    }

    public function validateParam($param, $value)
    {
        if (in_array($param, $this->_required) && $value === null) {
            throw new \InvalidArgumentException('Param ' . $param . ' is required');
        }

        if ($value !== null && isset($this->_validators[$param]) && !$this->_validators[$param]->isValid($value)) {
            throw new \InvalidArgumentException(
                'Param ' . $param . ' doesn\'t pass validation: ' . implode(
                    '; ',
                    $this->_validators[$param]->getMessages()
                )
            );
        }
    }
}