summaryrefslogtreecommitdiff
path: root/src/ReadabilityInterface.php
blob: 0dee01b9b0610ca6bd796d61a1cd7fef13605a9a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
<?php

namespace andreskrey\Readability;

use League\HTMLToMarkdown\ElementInterface;

interface ReadabilityInterface extends ElementInterface
{
    /**
     * @param string $value
     *
     * @return bool
     */
    public function tagNameEqualsTo($value);

    /**
     * @return int
     */
    public function getNodeAncestors();

    /**
     * @return Readability|null
     */
    public function getAllLinks();

    /**
     * @return int
     */
    public function getContentScore();

    /**
     * @return Readability
     */
    public function initializeNode();

    /**
     * @return int
     */
    public function getClassWeight();

    /**
     * @param int $score
     *
     * @return int
     */
    public function setContentScore($score);

    /**
     * @param bool $normalize Normalize white space?
     *
     * @return string
     */
    public function getTextContent($normalize);

    /**
     * @param string $value
     */
    public function setNodeTag($value);

    /**
     * @return \DOMNode
     */
    public function getDOMNode();

    /**
     * @param Readability $node
     *
     * @return Readability
     */
    public function removeAndGetNext($node);

    /**
     * @param Readability $originalNode
     * @param bool        $ignoreSelfAndKids
     *
     * @return Readability
     */
    public function getNextNode($originalNode, $ignoreSelfAndKids = false);

    /**
     * @param Readability $node1
     * @param Readability $node2
     *
     * @return bool
     */
    public function compareNodes($node1, $node2);

    /**
     * @param Readability $newNode
     */
    public function replaceChild(Readability $newNode);
}