api.php 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. <?php
  2. /**
  3. * @author Bart Visscher <bartv@thisnet.nl>
  4. * @author Morris Jobke <hey@morrisjobke.de>
  5. * @author Tom Needham <tom@owncloud.com>
  6. *
  7. * @copyright Copyright (c) 2015, ownCloud, Inc.
  8. * @license AGPL-3.0
  9. *
  10. * This code is free software: you can redistribute it and/or modify
  11. * it under the terms of the GNU Affero General Public License, version 3,
  12. * as published by the Free Software Foundation.
  13. *
  14. * This program is distributed in the hope that it will be useful,
  15. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17. * GNU Affero General Public License for more details.
  18. *
  19. * You should have received a copy of the GNU Affero General Public License, version 3,
  20. * along with this program. If not, see <http://www.gnu.org/licenses/>
  21. *
  22. */
  23. /**
  24. * Public interface of ownCloud for apps to use.
  25. * API Class
  26. *
  27. */
  28. // use OCP namespace for all classes that are considered public.
  29. // This means that they should be used by apps instead of the internal ownCloud classes
  30. namespace OCP;
  31. /**
  32. * This class provides functions to manage apps in ownCloud
  33. */
  34. class API {
  35. /**
  36. * registers an api call
  37. * @param string $method the http method
  38. * @param string $url the url to match
  39. * @param callable $action the function to run
  40. * @param string $app the id of the app registering the call
  41. * @param int $authLevel the level of authentication required for the call (See OC_API constants)
  42. * @param array $defaults
  43. * @param array $requirements
  44. */
  45. public static function register($method, $url, $action, $app, $authLevel = OC_API::USER_AUTH,
  46. $defaults = array(), $requirements = array()){
  47. \OC_API::register($method, $url, $action, $app, $authLevel, $defaults, $requirements);
  48. }
  49. }