CodeIgniter - How to return Json response from controller

Question

How do I return response from the controller back to the Jquery Javascript?

Javascript

$('.signinform').submit(function() { 
   $(this).ajaxSubmit({ 
       type : "POST",
       url: 'index.php/user/signin', // target element(s) to be updated with server response 
       cache : false,
       success : onSuccessRegistered,
       error: onFailRegistered
   });        
   return false; 
});

Data is returned null (blank)!

function onSuccessRegistered(data){
    alert(data);
};

Controller -

public function signin() {
    $arr = array('a' => 1, 'b' => 2, 'c' => 3, 'd' => 4, 'e' => 5);    
    echo json_encode( $arr );
}

verify have you call the particular method.. The call is reached signin method — Sundar, Sep 16 '13 at 06:27
success : function(response){ console.log(response)} modify this line and add the header //add the header here header('Content-Type: application/json') — Sundar, Sep 16 '13 at 06:31

score 95 · Answer 1 · edited Feb 08 '23 at 15:01

95

return $this->output
    ->set_content_type('application/json')
    ->set_status_header(500)
    ->set_output(json_encode([
        'text' => 'Error 500',
        'type' => 'danger'
    ]));

edited Feb 08 '23 at 15:01

Mr.Singh

1,421
6
21
46

answered Feb 27 '15 at 10:02

Cliff Richard Anfone

1,426
12
14

Why is the "type" value "danger"? – Victor S Mar 30 '18 at 17:55
1

@VictorS that is your response data, basicly anything you want – Muhammad Ibnuh May 14 '18 at 15:07
Working great with `'type' => 'danger'` thank you for that tip! – Wesley Murch Jun 20 '18 at 00:43
3

Please, for Codeigniter 4 use something like: ```return $this->response->setJSON( array( 'text' => 'Error 500', 'type' => 'danger' ) );``` – Arnis Juraga May 27 '20 at 13:19
1

This answer is missing its educational explanation. – mickmackusa Dec 22 '20 at 22:34
Sorry for the late reaction but I found this as helper for me `return $this->response->setStatusCode(500)->setJSON(['text' => 'Error 500', 'type' => 'danger'] );` when using CI4 – Ruberandinda Patience May 30 '22 at 05:07

score 53 · Accepted Answer · edited Aug 10 '16 at 18:45

53

//do the edit in your javascript

$('.signinform').submit(function() { 
   $(this).ajaxSubmit({ 
       type : "POST",
       //set the data type
       dataType:'json',
       url: 'index.php/user/signin', // target element(s) to be updated with server response 
       cache : false,
       //check this in Firefox browser
       success : function(response){ console.log(response); alert(response)},
       error: onFailRegistered
   });        
   return false; 
}); 


//controller function

public function signin() {
    $arr = array('a' => 1, 'b' => 2, 'c' => 3, 'd' => 4, 'e' => 5);    

   //add the header here
    header('Content-Type: application/json');
    echo json_encode( $arr );
}

edited Aug 10 '16 at 18:45

clami219

2,958
1
31
45

answered Sep 16 '13 at 06:30

Sundar

4,580
6
35
61

Returned (an empty string) – Bryan Learn Sep 16 '13 at 06:33
Shown: {"a":1,"b":2,"c":3,"d":4,"e":5} – Bryan Learn Sep 16 '13 at 06:35
that's correct then you have to add full URL in that ajax url: 'http:///index.php/user/signin' then check it – Sundar Sep 16 '13 at 06:36
I added ../index.php/user/signin – Bryan Learn Sep 16 '13 at 06:38
But it is not working still. Since Domain name will change, I cannot put a static domain name there. – Bryan Learn Sep 16 '13 at 06:38
Submit is an function so it's trying to send the form details into your form action URL. I think your action URL is empty so it's does the self post instead of ajax submit. Add the Action URL in from tag and you can try http://api.jquery.com/submit/ – Sundar Sep 16 '13 at 06:54
Hi Sundar, I am using code igniter. I am not able to parse the json_encode. – Bryan Learn Sep 16 '13 at 07:30
http://php.net/manual/en/function.json-encode.php try here above 5.2 version this is inbuild functionalty otherwise you have to install it – Sundar Sep 16 '13 at 08:52
1

It worked . But it overrited some features such as cache in Output class. So Cliff Richard Anfone's answer is better. – mbo Feb 18 '16 at 09:27
1

`set_status_header` is not always to be 500. My response return the status code as 200 is for success. Cliff Richard Anfone explains about how to return internal server error response. – Sundar Feb 18 '16 at 09:41

Player1 · Answer 3 · 2020-10-07T19:29:16.573

6

For CodeIgniter 4, you can use the built-in API Response Trait

Here's sample code for reference:

<?php namespace App\Controllers;

use CodeIgniter\API\ResponseTrait;

class Home extends BaseController
{
    use ResponseTrait;

    public function index()
    {
        $data = [
            'data' => 'value1',
            'data2' => 'value2',
        ];

        return $this->respond($data);
    }
}

edited Oct 07 '20 at 19:29

answered Oct 07 '20 at 19:19

Player1

2,878
2
26
38

score 5 · Answer 4 · answered Jul 10 '21 at 06:42

5

in my case , I'm using ci4 , I send response to clinet like this: e.g in App\Controllers\Category:setOrder my Category controller extends BaseController

  return $this->response->setJson(['msg'=>'update-success']);

answered Jul 10 '21 at 06:42

Ghazaleh Javaheri

1,829
19
25

score 0 · Answer 5 · edited Sep 16 '13 at 07:14

0

This is not your answer and this is an alternate way to process the form submission

$('.signinform').click(function(e) { 
      e.preventDefault();
      $.ajax({
      type: "POST",
      url: 'index.php/user/signin', // target element(s) to be updated with server response 
      dataType:'json',
      success : function(response){ console.log(response); alert(response)}
     });
});

edited Sep 16 '13 at 07:14

plain jane

1,009
1
8
19

answered Sep 16 '13 at 06:53

Sundar

4,580
6
35
61

score 0 · Answer 6 · answered Mar 07 '23 at 17:12

In Codeigniter 4.3, I've used this within a before Filter, that doesn't have a $this->response as Controllers do:

return response()->setContentType('application/json')                             
                 ->setStatusCode(401)
                 ->setJSON(['error' => 'Access Denied']);

score 0 · Answer 7 · answered Mar 24 '23 at 02:10

0

If anyone is looking for a 4.3.x version solution it is this:

return $this->response->setJSON($data);

Source: https://codeigniter4.github.io/userguide/outgoing/response.html#setting-the-output

answered Mar 24 '23 at 02:10

Sohan Arafat

93
2
16

CodeIgniter - How to return Json response from controller

7 Answers7

Linked