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

RdfaLite::parseXmlFile()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 1
Bugs 0 Features 0
Metric Value
dl 0
loc 4
ccs 2
cts 2
cp 1
rs 10
c 1
b 0
f 0
cc 1
eloc 2
nc 1
nop 1
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\RdfaLiteContext;
40
use Jkphl\RdfaLiteMicrodata\Infrastructure\Factories\DomDocumentFactory;
41
use Jkphl\RdfaLiteMicrodata\Infrastructure\Factories\HtmlDocumentFactory;
42
use Jkphl\RdfaLiteMicrodata\Infrastructure\Factories\XmlDocumentFactory;
43
use Jkphl\RdfaLiteMicrodata\Infrastructure\Parser\RdfaLiteElementProcessor;
44
45
/**
46
 * RDFa Lite 1.1 parser
47
 *
48
 * @package Jkphl\RdfaLiteMicrodata
49
 * @subpackage Jkphl\RdfaLiteMicrodata\Ports
50
 * @see https://www.w3.org/TR/rdfa-lite/
51
 */
52
class RdfaLite extends AbstractParser
53
{
54
    /**
55
     * Parse an XML file
56
     *
57
     * @param string $file XML file path
58
     * @return \stdClass Extracted things
59
     */
60 3
    public function parseXmlFile($file)
61
    {
62 3
        return $this->parseXml($this->getFileContents($file));
63
    }
64
65
    /**
66
     * Parse an XML string
67
     *
68
     * @param string $string XML string
69
     * @return \stdClass Extracted things
70
     */
71 3
    public function parseXml($string)
72
    {
73 3
        return $this->parseSource(
74 3
            $string,
75 3
            new XmlDocumentFactory(),
76 3
            new RdfaLiteElementProcessor(),
77 3
            new RdfaLiteContext()
78 3
        );
79
    }
80
81
    /**
82
     * Parse an HTML file
83
     *
84
     * @param string $file HTML file path
85
     * @param callable|null $errorHandler Custom HTML parsing error handler
86
     * @return \stdClass Extracted things
87
     */
88 5
    public function parseHtmlFile($file, array $errorHandler = null)
89
    {
90 5
        return $this->parseHtml($this->getFileContents($file), $errorHandler);
91
    }
92
93
    /**
94
     * Parse an HTML string
95
     *
96
     * @param string $string HTML string
97
     * @param callable|null $errorHandler Custom HTML parsing error handler
98
     * @return \stdClass Extracted things
99
     */
100 4
    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...
101
    {
102 4
        return $this->parseSource(
103 4
            $string,
104 4
            new HtmlDocumentFactory(),
105 4
            (new RdfaLiteElementProcessor())->setHtml(true),
106 4
            new RdfaLiteContext()
107 4
        );
108
    }
109
110
    /**
111
     * Parse a DOM document
112
     *
113
     * @param \DOMDocument $dom DOM document
114
     * @return \stdClass Extracted things
115
     */
116 1
    public function parseDom(\DOMDocument $dom)
117
    {
118 1
        return $this->parseSource(
119 1
            $dom,
120 1
            new DomDocumentFactory(),
121 1
            (new RdfaLiteElementProcessor())->setHtml(true),
122 1
            new RdfaLiteContext()
123 1
        );
124
    }
125
}
126