PayloadValidator.php

Go to the documentation of this file.

<?php
namespace Magento\Setup\Model;

class PayloadValidator
{
    private $moduleList;

    public function __construct(\Magento\Framework\Module\FullModuleList $moduleList)
    {
        $this->moduleList = $moduleList;
    }

    public function validatePayload(array $postPayload)
    {
        $jobType = $postPayload[UpdaterTaskCreator::KEY_POST_JOB_TYPE];
        $errorMessage = '';
        switch ($jobType) {
            case 'uninstall':
                $errorMessage = $this->validateUninstallPayload($postPayload);
                break;

            case 'update':
                $errorMessage = $this->validateUpdatePayload($postPayload);
                break;

            case 'enable':
            case 'disable':
                $errorMessage = $this->validateEnableDisablePayload($postPayload);
                break;
        }
        return $errorMessage;
    }

    private function validateUninstallPayload(array $postPayload)
    {
        $errorMessage = '';
        if (!isset($postPayload[UpdaterTaskCreator::KEY_POST_DATA_OPTION])) {
            $errorMessage = 'Missing dataOption' . PHP_EOL;
        }
        return $errorMessage;
    }

    private function validateUpdatePayload(array $postPayload)
    {
        $errorMessage = '';
        if (!isset($postPayload[UpdaterTaskCreator::KEY_POST_PACKAGES])) {
            $errorMessage = 'Missing packages' . PHP_EOL;
        } else {
            $packages = $postPayload[UpdaterTaskCreator::KEY_POST_PACKAGES];
            foreach ($packages as $package) {
                if ((!isset($package[UpdaterTaskCreator::KEY_POST_PACKAGE_NAME]))
                    || (!isset($package[UpdaterTaskCreator::KEY_POST_PACKAGE_VERSION]))
                ) {
                    $errorMessage .= 'Missing package information' . PHP_EOL;
                    break;
                }
            }
        }
        return $errorMessage;
    }

    private function validateEnableDisablePayload(array $postPayload)
    {
        $errorMessage = '';
        if (!isset($postPayload[UpdaterTaskCreator::KEY_POST_PACKAGES])) {
            $errorMessage = 'Missing packages' . PHP_EOL;
        } else {
            $packages = $postPayload[UpdaterTaskCreator::KEY_POST_PACKAGES];
            foreach ($packages as $package) {
                if (!$this->moduleList->has($package[UpdaterTaskCreator::KEY_POST_PACKAGE_NAME])) {
                    $errorMessage .= 'Invalid Magento module name: '
                        . $package[UpdaterTaskCreator::KEY_POST_PACKAGE_NAME] . PHP_EOL;
                    break;
                }
            }
        }
        return $errorMessage;
    }
}