Kolyunya/codeception-markup-validator

View on GitHub
sources/Lib/MarkupValidator/MarkupValidatorInterface.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php

namespace Kolyunya\Codeception\Lib\MarkupValidator;

use Kolyunya\Codeception\Lib\Base\ComponentInterface;
use Kolyunya\Codeception\Lib\MarkupValidator\MarkupValidatorMessageInterface;

/**
 * An interface of a markup validator.
 */
interface MarkupValidatorInterface extends ComponentInterface
{
    /**
     * Constructs a markup provider. Injects configuration parameters.
     *
     * @param array $config Configuration parameters.
     */
    public function __construct(array $config);

    /**
     * Validates markup and returns validation messages.
     *
     * @param string $markup Markup to validate.
     *
     * @return MarkupValidatorMessageInterface[] An array of messages.
     */
    public function validate($markup);
}