nextcloud/lib/public/json.php

173 lines
5.3 KiB
PHP
Raw Normal View History

2012-05-03 14:23:29 +04:00
<?php
/**
* ownCloud
*
* @author Frank Karlitschek
2012-05-26 21:14:24 +04:00
* @copyright 2012 Frank Karlitschek frank@owncloud.org
2012-05-03 14:23:29 +04:00
*
* 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.
* JSON Class
*
*/
2012-08-29 10:38:33 +04:00
// use OCP namespace for all classes that are considered public.
2012-05-03 14:23:29 +04:00
// This means that they should be used by apps instead of the internal ownCloud classes
namespace OCP;
2012-05-19 12:36:57 +04:00
/**
* This class provides convinient functions to generate and send JSON data. Usefull for Ajax calls
*/
2012-05-03 14:23:29 +04:00
class JSON {
/**
* @brief Encode and print $data in JSON format
* @param array $data The data to use
* @param string $setContentType the optional content type
* @return string json formatted string.
2012-05-03 14:23:29 +04:00
*/
2012-09-07 17:22:01 +04:00
public static function encodedPrint( $data, $setContentType=true ) {
return(\OC_JSON::encodedPrint( $data, $setContentType ));
2012-05-03 14:23:29 +04:00
}
/**
* Check if the user is logged in, send json error msg if not.
2012-08-29 10:38:33 +04:00
*
* This method checks if a user is logged in. If not, a json error
* response will be return and the method will exit from execution
* of the script.
* The returned json will be in the format:
2012-08-29 10:38:33 +04:00
*
* {"status":"error","data":{"message":"Authentication error."}}
2012-08-29 10:38:33 +04:00
*
* Add this call to the start of all ajax method files that requires
* an authenticated user.
2012-08-29 10:38:33 +04:00
*
* @return string json formatted error string if not authenticated.
*/
2012-09-07 17:22:01 +04:00
public static function checkLoggedIn() {
2012-05-03 14:23:29 +04:00
return(\OC_JSON::checkLoggedIn());
}
/**
* Check an ajax get/post call if the request token is valid.
2012-08-29 10:38:33 +04:00
*
* This method checks for a valid variable 'requesttoken' in $_GET,
* $_POST and $_SERVER. If a valid token is not found, a json error
* response will be return and the method will exit from execution
* of the script.
* The returned json will be in the format:
2012-08-29 10:38:33 +04:00
*
* {"status":"error","data":{"message":"Token expired. Please reload page."}}
2012-08-29 10:38:33 +04:00
*
* Add this call to the start of all ajax method files that creates,
* updates or deletes anything.
* In cases where you e.g. use an ajax call to load a dialog containing
* a submittable form, you will need to add the requesttoken first as a
* parameter to the ajax call, then assign it to the template and finally
* add a hidden input field also named 'requesttoken' containing the value.
2012-08-29 10:38:33 +04:00
*
* @return string json formatted error string if not valid.
*/
2012-09-07 17:22:01 +04:00
public static function callCheck() {
return(\OC_JSON::callCheck());
}
2012-05-03 14:23:29 +04:00
/**
* Send json success msg
2012-08-29 10:38:33 +04:00
*
* Return a json success message with optional extra data.
2012-08-29 22:34:44 +04:00
* @see OCP\JSON::error() for the format to use.
2012-08-29 10:38:33 +04:00
*
* @param array $data The data to use
* @return string json formatted string.
2012-05-03 14:23:29 +04:00
*/
2012-09-07 17:22:01 +04:00
public static function success( $data = array() ) {
return(\OC_JSON::success( $data ));
2012-05-03 14:23:29 +04:00
}
/**
* Send json error msg
2012-08-29 10:38:33 +04:00
*
* Return a json error message with optional extra data for
* error message or app specific data.
2012-08-29 10:38:33 +04:00
*
* Example use:
2012-08-29 10:38:33 +04:00
*
* $id = [some value]
* OCP\JSON::error(array('data':array('message':'An error happened', 'id': $id)));
2012-08-29 10:38:33 +04:00
*
* Will return the json formatted string:
2012-08-29 10:38:33 +04:00
*
* {"status":"error","data":{"message":"An error happened", "id":[some value]}}
2012-08-29 10:38:33 +04:00
*
* @param array $data The data to use
* @return string json formatted error string.
2012-05-03 14:23:29 +04:00
*/
2012-09-07 17:22:01 +04:00
public static function error( $data = array() ) {
return(\OC_JSON::error( $data ));
2012-05-03 14:23:29 +04:00
}
/**
* @brief set Content-Type header to jsonrequest
* @param array $type The contwnt type header
* @return string json formatted string.
*/
2012-09-07 17:22:01 +04:00
public static function setContentTypeHeader( $type='application/json' ) {
return(\OC_JSON::setContentTypeHeader( $type ));
2012-05-03 14:23:29 +04:00
}
/**
* Check if the App is enabled and send JSON error message instead
2012-08-29 10:38:33 +04:00
*
* This method checks if a specific app is enabled. If not, a json error
* response will be return and the method will exit from execution
* of the script.
* The returned json will be in the format:
2012-08-29 10:38:33 +04:00
*
* {"status":"error","data":{"message":"Application is not enabled."}}
2012-08-29 10:38:33 +04:00
*
* Add this call to the start of all ajax method files that requires
* a specific app to be enabled.
2012-08-29 10:38:33 +04:00
*
* @param string $app The app to check
* @return string json formatted string if not enabled.
*/
2012-09-07 17:22:01 +04:00
public static function checkAppEnabled( $app ) {
return(\OC_JSON::checkAppEnabled( $app ));
2012-05-03 14:23:29 +04:00
}
/**
* Check if the user is a admin, send json error msg if not
2012-08-29 10:38:33 +04:00
*
* This method checks if the current user has admin rights. If not, a json error
* response will be return and the method will exit from execution
* of the script.
* The returned json will be in the format:
2012-08-29 10:38:33 +04:00
*
* {"status":"error","data":{"message":"Authentication error."}}
2012-08-29 10:38:33 +04:00
*
* Add this call to the start of all ajax method files that requires
* administrative rights.
2012-08-29 10:38:33 +04:00
*
* @return string json formatted string if not admin user.
2012-05-03 14:23:29 +04:00
*/
2012-09-07 17:22:01 +04:00
public static function checkAdminUser() {
2012-05-03 14:23:29 +04:00
return(\OC_JSON::checkAdminUser());
}
}