README

#Doctype Validator Test to see if an HTML doctype is valid according to the W3C specifications.

##Installation##

Install with Composer

$ composer require beutnagel/doctype-validator

For the current alpha release

{
	"require": {
        "beutnagel/doctype-validator": "^0.1.1@alpha"
    },
    "minimum-stability": "alpha"
}

##Basic Usage The Doctype_Validator can be used to check the validity of a doctype, find errors and match it with existing official doctypes.

$dtv = new Doctype_Validator();

$doctype = "<!DOCTYPE html>";

Checking to see if a doctype is valid.

$valid = $dtv->validate($doctype)->isValid();

@return boolean TRUE or FALSE.

A check can be performed with isMatch() to see if there is a match.

$match = $dtv->validate($doctype)->isMatch();

@return boolean TRUE or FALSE

$matches = $dtv->validate($doctype)->matches();

@return string of name of match, or NULL if no match.

If a doctype is not valid, Doctype_Validator will try to analyse why it is not valid. A list of errors can be found in Doctype_Error.php.

A simple check if a doctype has errors in it can be performed by the hasError() function.

$error = $dtv->validate($doctype)->hasError();

@return boolean TRUE or FALSE.

You can retrieve errors with the getErrors() method.

$result  = $dtv->validate($doctype);
if($result->hasErrors())
{
  $errors = $result->getErrors();
}

@return array of errors.

The doctype will be dissected into smaller fragments and these can be access with getFragments().

$fragments = $dtv->validate($doctype)->getFragments();

@return array of fragmentens

License

Doctype Validator is licensed under the MIT License - see the LICENSE file for details