tao-test/app/tao/models/classes/resources/ResourceLookup.php

67 lines
2.3 KiB
PHP

<?php
/**
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; under version 2
* of the License (non-upgradable).
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* Copyright (c) 2017 (original work) Open Assessment Technologies SA (under the project TAO-PRODUCT);
*
*/
namespace oat\tao\model\resources;
/**
* How to lookup resources
*
* @author Bertrand Chevrier <bertrand@taotesting.com>
*/
interface ResourceLookup
{
/**
* Retrieve Resources for the given parameters
*
* @param \core_kernel_classes_Class $rootClass the resources class
* @param array $propertyFilters propUri/propValue to search resources
* @param string[] $selectedUris the resources to open
* @param int $offset for paging
* @param int $limit for paging
* @return array the resources
*/
public function getResources(
\core_kernel_classes_Class $rootClass,
array $selectedUris = [],
array $propertyFilters = [],
$offset = 0,
$limit = 30
);
/**
* Retrieve Classes for the given parameters
*
* @param \core_kernel_classes_Class $rootClass the resources class
* @param array $propertyFilters propUri/propValue to search resources
* @param string[] $selectedUris the resources to open
* @param int $offset for paging
* @param int $limit for paging
* @return array the classes
*/
public function getClasses(
\core_kernel_classes_Class $rootClass,
array $selectedUris = [],
array $propertyFilters = [],
$offset = 0,
$limit = 30
);
}