Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Deprecate OC_JSON and OCP\JSON #14129

Merged
merged 1 commit into from
Feb 12, 2015
Merged

Deprecate OC_JSON and OCP\JSON #14129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
46 changes: 30 additions & 16 deletions lib/private/json.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,15 @@
* See the COPYING-README file.
*/

/**
* Class OC_JSON
* @deprecated Use a AppFramework JSONResponse instead
*/
class OC_JSON{
static protected $send_content_type_header = false;
/**
* set Content-Type header to jsonrequest
* @deprecated Use a AppFramework JSONResponse instead
*/
public static function setContentTypeHeader($type='application/json') {
if (!self::$send_content_type_header) {
Expand All @@ -20,9 +25,10 @@ public static function setContentTypeHeader($type='application/json') {
}

/**
* Check if the app is enabled, send json error msg if not
* @param string $app
*/
* Check if the app is enabled, send json error msg if not
* @param string $app
* @deprecated Use the AppFramework instead. It will automatically check if the app is enabled.
*/
public static function checkAppEnabled($app) {
if( !OC_App::isEnabled($app)) {
$l = \OC::$server->getL10N('lib');
Expand All @@ -32,8 +38,9 @@ public static function checkAppEnabled($app) {
}

/**
* Check if the user is logged in, send json error msg if not
*/
* Check if the user is logged in, send json error msg if not
* @deprecated Use annotation based ACLs from the AppFramework instead
*/
public static function checkLoggedIn() {
if( !OC_User::isLoggedIn()) {
$l = \OC::$server->getL10N('lib');
Expand All @@ -44,6 +51,7 @@ public static function checkLoggedIn() {

/**
* Check an ajax get/post call if the request token is valid, send json error msg if not.
* @deprecated Use annotation based CSRF checks from the AppFramework instead
*/
public static function callCheck() {
if( !OC_Util::isCallRegistered()) {
Expand All @@ -54,8 +62,9 @@ public static function callCheck() {
}

/**
* Check if the user is a admin, send json error msg if not.
*/
* Check if the user is a admin, send json error msg if not.
* @deprecated Use annotation based ACLs from the AppFramework instead
*/
public static function checkAdminUser() {
if( !OC_User::isAdminUser(OC_User::getUser())) {
$l = \OC::$server->getL10N('lib');
Expand All @@ -67,6 +76,7 @@ public static function checkAdminUser() {
/**
* Check is a given user exists - send json error msg if not
* @param string $user
* @deprecated Use a AppFramework JSONResponse instead
*/
public static function checkUserExists($user) {
if (!OCP\User::userExists($user)) {
Expand All @@ -77,10 +87,10 @@ public static function checkUserExists($user) {
}



/**
* Check if the user is a subadmin, send json error msg if not
*/
* Check if the user is a subadmin, send json error msg if not
* @deprecated Use annotation based ACLs from the AppFramework instead
*/
public static function checkSubAdminUser() {
if(!OC_SubAdmin::isSubAdmin(OC_User::getUser())) {
$l = \OC::$server->getL10N('lib');
Expand All @@ -90,16 +100,18 @@ public static function checkSubAdminUser() {
}

/**
* Send json error msg
*/
* Send json error msg
* @deprecated Use a AppFramework JSONResponse instead
*/
public static function error($data = array()) {
$data['status'] = 'error';
self::encodedPrint($data);
}

/**
* Send json success msg
*/
* Send json success msg
* @deprecated Use a AppFramework JSONResponse instead
*/
public static function success($data = array()) {
$data['status'] = 'success';
self::encodedPrint($data);
Expand All @@ -115,8 +127,9 @@ protected static function to_string(&$value) {
}

/**
* Encode and print $data in json format
*/
* Encode and print $data in json format
* @deprecated Use a AppFramework JSONResponse instead
*/
public static function encodedPrint($data, $setContentType=true) {
if($setContentType) {
self::setContentTypeHeader();
Expand All @@ -126,6 +139,7 @@ public static function encodedPrint($data, $setContentType=true) {

/**
* Encode JSON
* @deprecated Use a AppFramework JSONResponse instead
*/
public static function encode($data) {
if (is_array($data)) {
Expand Down