Completed
Push — master ( 5f0f6a...9c755e )
by Joschi
03:58
created

Microdata::parseHtml()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 9
Code Lines 6

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 7
CRAP Score 1

Importance

Changes 0
Metric Value
dl 0
loc 9
ccs 7
cts 7
cp 1
rs 9.6666
c 0
b 0
f 0
cc 1
eloc 6
nc 1
nop 2
crap 1
1
<?php
2
3
/**
4
 * rdfa-lite-microdata
5
 *
6
 * @category Jkphl
7
 * @package Jkphl\RdfaLiteMicrodata
8
 * @subpackage Jkphl\RdfaLiteMicrodata\Ports
9
 * @author Joschi Kuphal <[email protected]> / @jkphl
10
 * @copyright Copyright © 2017 Joschi Kuphal <[email protected]> / @jkphl
11
 * @license http://opensource.org/licenses/MIT The MIT License (MIT)
12
 */
13
14
/***********************************************************************************
15
 *  The MIT License (MIT)
16
 *
17
 *  Copyright © 2017 Joschi Kuphal <[email protected]> / @jkphl
18
 *
19
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
20
 *  this software and associated documentation files (the "Software"), to deal in
21
 *  the Software without restriction, including without limitation the rights to
22
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
23
 *  the Software, and to permit persons to whom the Software is furnished to do so,
24
 *  subject to the following conditions:
25
 *
26
 *  The above copyright notice and this permission notice shall be included in all
27
 *  copies or substantial portions of the Software.
28
 *
29
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
31
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
32
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
33
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
34
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35
 ***********************************************************************************/
36
37
namespace Jkphl\RdfaLiteMicrodata\Ports\Parser;
38
39
use Jkphl\RdfaLiteMicrodata\Application\Context\MicrodataContext;
40
use Jkphl\RdfaLiteMicrodata\Infrastructure\Factories\DomDocumentFactory;
41
use Jkphl\RdfaLiteMicrodata\Infrastructure\Factories\HtmlDocumentFactory;
42
use Jkphl\RdfaLiteMicrodata\Infrastructure\Parser\MicrodataElementProcessor;
43
44
/**
45
 * RDFa Lite 1.1 parser
46
 *
47
 * @package Jkphl\RdfaLiteMicrodata
48
 * @subpackage Jkphl\RdfaLiteMicrodata\Ports
49
 * @see https://www.w3.org/TR/microdata/
50
 * @see https://www.w3.org/TR/microdata/#json
51
 */
52
class Microdata extends AbstractParser
53
{
54
    /**
55
     * Parse an HTML file
56
     *
57
     * @param string $file HTML file path
58
     * @param callable|null $errorHandler Custom HTML parsing error handler
59
     * @return \stdClass Extracted things
60
     */
61 4
    public function parseHtmlFile($file, array $errorHandler = null)
0 ignored issues
show
Unused Code introduced by
The parameter $errorHandler is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
62
    {
63 4
        return $this->parseHtml($this->getFileContents($file));
64
    }
65
66
    /**
67
     * Parse an HTML string
68
     *
69
     * @param string $string HTML string
70
     * @param callable|null $errorHandler Custom HTML parsing error handler
71
     * @return \stdClass Extracted things
72
     */
73 3
    public function parseHtml($string, array $errorHandler = null)
0 ignored issues
show
Unused Code introduced by
The parameter $errorHandler is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
74
    {
75 3
        return $this->parseSource(
76 3
            $string,
77 3
            new HtmlDocumentFactory(),
78 3
            new MicrodataElementProcessor(),
79 3
            new MicrodataContext()
80 3
        );
81
    }
82
83
    /**
84
     * Parse a DOM document
85
     *
86
     * @param \DOMDocument $dom DOM document
87
     * @return \stdClass Extracted things
88
     */
89 1
    public function parseDom(\DOMDocument $dom)
90
    {
91 1
        return $this->parseSource(
92 1
            $dom,
93 1
            new DomDocumentFactory(),
94 1
            new MicrodataElementProcessor(),
95 1
            new MicrodataContext()
96 1
        );
97
    }
98
}
99