FuelPHP Forums

Have you seen this page? http://fuelphp.com/docs/general/controllers/rest.html

class Controller_Test extends Controller_Rest {

    public function get_list()
    {
        $this->response(array(
            'foo' => Input::get('foo'),
            'baz' => array(
                1, 50, 219
            ),
            'empty' => null
        ));
    }
}

http://localhost/test/list.json?foo=bar

Samit Rimal wrote on Tuesday 8th of November 2011:

Yes i have seen the page . I didnt have how to use it with ajax calls. having a big trouble in using when try to do ajax calls.

There's a tutorial about ajax login http://saaboke.com/?p=257 hope this helps.

try removing $this->response->set_header('Content-Type','application/json'); I'll try to post some code for you tonight from my project.

That probably means format detection doesn't work, hasn't been set or passed properly in the request, or is misconfigured. You don't mention which FuelPHP version you are using. For 1.1, see http://fuelphp.com/dev-docs/general/controllers/rest.html. You'll see that it detects the format used based on the extension of the request (in the example list.json). If you don't have a format like that, you need to either configure the default format in the rest.php config file (by default it is xml), or the $this->rest_format property of your rest controller.

FuelPHP only outputs what you put in the response. So it's not a problem for a standard controller method to return json, the only difference is that you'll have to hard-code ajax detection, json encoding/decoding, http headers, etc. This is what the Rest Controller does for you in the background.

This is how i have it working

controller/ajax.php
<?php
class Controller_Ajax extends Controller_Rest &#123;

    public function post_search() &#123;

        $search = \Input::post("term") . "%";
        $result = DB::select()->from('customers')->where_open()
                        ->where('firstname', 'like', $search )
                        ->where_close()
                        ->or_where_open()
                        ->where('postcode', 'like', $search )
                        ->or_where('telephone', 'like', $search 

)
                        ->or_where_close()->execute();

        $data['response'] = 'true';
        $data['message'] = array();
        foreach ($result as $row) &#123;
            $data['message'][] = array('label' => $row['firstname'],
                'value' => $row['firstname'],
                'details' => $row);
        }
        $this->response($data);
    }
}

view

<.Script type="text/javascript">
    jQuery(document).ready(function($) &#123;
        $(function() &#123;
            $("#query").autocomplete(&#123;
                minLength: 2,
                source: function(req, add)
                &#123;
                    $.ajax(&#123;
                        url: '/ajax/search.json',
                        dataType: 'json',
                        type: 'POST',
                        data: req,
                        success:
                            function(data)
                        &#123;
                            if(data.response =='true')
                            &#123;
                                add(data.message);
                            }
                        }
                    });
                },
                select: function(event, ui) &#123;
                    var data = ui.item.details;
                    $('#query').val(ui.item.label);
                    $("#title").val(data.title);
                    $("#firstname").val(data.firstname);
                    $("#lastname").val(data.lastname);
                    $("#address1").val(data.address1);
                    $("#address2").val(data.address2);
                    $("#town").val(data.town);
                    $("#county").val(data.county);
                    $("#postcode").val(data.postcode);
                    $("#telephone").val(data.telephone);
                    $("#mobile").val(data.mobile);
                    $("#email").val(data.address1);
                    $("#nationality_id").val(data.nationality_id);
                    $("#dob").val(data.dob);
                    $("#identity_id").val(data.identity_id);
                    $("#notes").val(data.notes); 
                }
            });
        });

    });
<.Script>

The default format issue still does not appear to be fixed in 1.4. In my case the default format is php (even though I've set it to json in the rest config) and apart from the results, the executed query is also being exposed in the obj props -- great security issue imo

return array(

	/*
	| What format should the data be returned in by default?
	|
	|	Default: xml
	|
	*/
	'default_format' => 'json',

This is inside app/config/rest.php

class Controller_Api_1_User extends Controller_Rest

{
   public function before()
  {
      parent::before();
      if ( ! \Gm::gm_verify_credentials())
      {
          return $this -> response(array('errors' => 'Unauthorized request.', ), 403);
      }
    }
   
    public function after($response)
    {
      return $response;
    }

    public function get_user_profile()
    {
      $user  = \Gm::gm_profile_info($this->param('screen_name')); //Retrieve a user model
         return $this->response(array(
            'user' => $user
         ), 200);
    }
}

Yes, you're right the default format is XML when you don't specify the dataType in an $.ajax call. This returns json perfectly

  self.screen_name.subscribe(function(newScreenName) {
      self.user([]);
      self.pending_request(true);
      $.ajax({
        url : self.base_api() + 'get/user/' + newScreenName,
        type: 'GET',
        dataType : 'json',
        success : function(d) {
          if (d.user)
          {
            self.user(new ProfileUser(d.user));
          }
        },
        error : function(d) {
        }
      }).done(function() {
        self.pending_request(false);
      });
  }.bind(self));

But if you do not specify the format (by either adding dataType: 'json' or appending .json to the url), it returns XML. If you just call the API method in a browser, the entire object is being returned in a php format. Any way to at least prevent the exposure of the executed query in the response object in this type of case?

Worked like a charm! Thanks so much, Pascal! :)

Agreed!

Harro, the doc says: 

thanks!

Good suggestion.

There is no such thing as a "default_format", but there is a "rest_format" property which is used if no valid accepted language is found, so I've updated the Controller_Rest to use that.