Blame view

sources/lib/public/api.php 1.67 KB
03e52840d   Kload   Init
1
2
  <?php
  /**
31b7f2792   Kload   Upgrade to ownclo...
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
   * ownCloud
   *
   * @author Tom Needham
   * @copyright 2012 Tom Needham tom@owncloud.com
   *
   * This library is free software; you can redistribute it and/or
   * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
   * License as published by the Free Software Foundation; either
   * version 3 of the License, or any later version.
   *
   * This library 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 AFFERO GENERAL PUBLIC LICENSE for more details.
   *
   * You should have received a copy of the GNU Affero General Public
   * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
   *
   */
  
  /**
   * Public interface of ownCloud for apps to use.
   * API Class
   *
   */
03e52840d   Kload   Init
28

31b7f2792   Kload   Upgrade to ownclo...
29
30
  // use OCP namespace for all classes that are considered public.
  // This means that they should be used by apps instead of the internal ownCloud classes
03e52840d   Kload   Init
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
  namespace OCP;
  
  /**
   * This class provides functions to manage apps in ownCloud
   */
  class API {
  
  	/**
  	 * registers an api call
  	 * @param string $method the http method
  	 * @param string $url the url to match
  	 * @param callable $action the function to run
  	 * @param string $app the id of the app registering the call
  	 * @param int $authLevel the level of authentication required for the call (See OC_API constants)
  	 * @param array $defaults
  	 * @param array $requirements
  	 */
  	public static function register($method, $url, $action, $app, $authLevel = OC_API::USER_AUTH,
  		$defaults = array(), $requirements = array()){
  		\OC_API::register($method, $url, $action, $app, $authLevel, $defaults, $requirements);
  	}
  
  }