mirror of
https://github.com/moodle/moodle.git
synced 2025-01-19 06:18:28 +01:00
ba1f804ffa
This has been generated running the following Sniffs, all them part of the Moodle's CodeSniffer standard: - PSR12.Functions.ReturnTypeDeclaration - PSR12.Functions.NullableTypeDeclaration - moodle.Methods.MethodDeclarationSpacing - Squiz.Whitespace.ScopeKeywordSpacing All them are, exclusively, about correct spacing, so the changes are, all them, only white space changes. Only exceptions to the above are 3 changes what were setting the return type in a new line, and, when that happens, the closing parenthesis (bracket) has to go to the same line than the colon.
60 lines
2.5 KiB
PHP
60 lines
2.5 KiB
PHP
<?php
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle 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, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle 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 Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
/**
|
|
* Contains the service_factory, a locator for services for the favourites subsystem.
|
|
*
|
|
* Services encapsulate the business logic, and any data manipulation code, and are what clients should interact with.
|
|
*
|
|
* @package core_favourites
|
|
* @copyright 2018 Jake Dallimore <jrhdallimore@gmail.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
namespace core_favourites;
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
/**
|
|
* Class service_factory, providing functions for location of service objects for the favourites subsystem.
|
|
*
|
|
* This class is responsible for providing service objects to clients only.
|
|
*
|
|
* @copyright 2018 Jake Dallimore <jrhdallimore@gmail.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class service_factory {
|
|
|
|
/**
|
|
* Returns a basic service object providing operations for user favourites.
|
|
*
|
|
* @param \context_user $context the context of the user to which the service should be scoped.
|
|
* @return \core_favourites\local\service\user_favourite_service the service object.
|
|
*/
|
|
public static function get_service_for_user_context(\context_user $context): local\service\user_favourite_service {
|
|
return new local\service\user_favourite_service($context, new local\repository\favourite_repository());
|
|
}
|
|
|
|
/**
|
|
* Returns a basic service object providing operations for favourites belonging to a given component.
|
|
*
|
|
* @param string $component frankenstyle component name.
|
|
* @return local\service\component_favourite_service the service object.
|
|
*/
|
|
public static function get_service_for_component(string $component): local\service\component_favourite_service {
|
|
return new local\service\component_favourite_service($component, new local\repository\favourite_repository());
|
|
}
|
|
}
|
|
|