Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
1<?php
2
3/**
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; under version 2
7 * of the License (non-upgradable).
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
17 *
18 * Copyright (c) 2020 (original work) Open Assessment Technologies SA;
19 */
20
21declare(strict_types=1);
22
23namespace oat\tao\model\search\index\DocumentBuilder;
24
25use oat\tao\model\search\index\IndexDocument;
26
27interface IndexDocumentBuilderInterface
28{
29    /**
30     * Creates IndexDocument object from the \core_kernel_classes_Resource data
31     * @param \core_kernel_classes_Resource $resource
32     * @return IndexDocument
33     * @throws \common_Exception
34     * @throws \common_exception_InconsistentData
35     */
36    public function createDocumentFromResource(\core_kernel_classes_Resource $resource): IndexDocument;
37
38    /**
39     * Creates IndexDocument object from the array data
40     * @param $resourceData $array
41     * @return IndexDocument
42     * @throws \common_Exception
43     */
44    public function createDocumentFromArray(array $resourceData = []): IndexDocument;
45}