1<?php
2
3/**
4 * Hoa
5 *
6 *
7 * @license
8 *
9 * New BSD License
10 *
11 * Copyright © 2007-2017, Hoa community. All rights reserved.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions are met:
15 *     * Redistributions of source code must retain the above copyright
16 *       notice, this list of conditions and the following disclaimer.
17 *     * Redistributions in binary form must reproduce the above copyright
18 *       notice, this list of conditions and the following disclaimer in the
19 *       documentation and/or other materials provided with the distribution.
20 *     * Neither the name of the Hoa nor the names of its contributors may be
21 *       used to endorse or promote products derived from this software without
22 *       specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE
28 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37namespace Hoa\Stream\IStream;
38
39/**
40 * Interface \Hoa\Stream\IStream\Structural.
41 *
42 * Interface for structural input/output.
43 *
44 * @copyright  Copyright © 2007-2017 Hoa community
45 * @license    New BSD License
46 */
47interface Structural extends Stream
48{
49    /**
50     * Select root of the document: :root.
51     *
52     * @return  \Hoa\Stream\IStream\Structural
53     */
54    public function selectRoot();
55
56    /**
57     * Select any elements: *.
58     *
59     * @return  array
60     */
61    public function selectAnyElements();
62
63    /**
64     * Select elements of type E: E.
65     *
66     * @param   string  $E    Element E.
67     * @return  array
68     */
69    public function selectElements($E = null);
70
71    /**
72     * Select F elements descendant of an E element: E F.
73     *
74     * @param   string  $F    Element F.
75     * @return  array
76     */
77    public function selectDescendantElements($F = null);
78
79    /**
80     * Select F elements children of an E element: E > F.
81     *
82     * @param   string  $F    Element F.
83     * @return  array
84     */
85    public function selectChildElements($F = null);
86
87    /**
88     * Select an F element immediately preceded by an E element: E + F.
89     *
90     * @param   string  $F    Element F.
91     * @return  \Hoa\Stream\IStream\Structural
92     */
93    public function selectAdjacentSiblingElement($F);
94
95    /**
96     * Select F elements preceded by an E element: E ~ F.
97     *
98     * @param   string  $F    Element F.
99     * @return  array
100     */
101    public function selectSiblingElements($F = null);
102
103    /**
104     * Execute a query selector and return the first result.
105     *
106     * @param   string  $query    Query.
107     * @return  \Hoa\Stream\IStream\Structural
108     */
109    public function querySelector($query);
110
111    /**
112     * Execute a query selector and return one or many results.
113     *
114     * @param   string  $query    Query.
115     * @return  array
116     */
117    public function querySelectorAll($query);
118}
119