restfullyii Follow @yiiframework

Hi acy,

thanks again! version 1.12 should resolve the issue. Now Put and Get response data should in insync.

Thanks for the fix evan! The PUT request returns the missing relations now.

But one thing is still weird. The responses of a GET and a PUT have a different structure (see "person"):

GET /api/person/123/

{
  "success": true,
  "message": "Record Retrieved Successfully",
  "data": {
    "totalCount": 1,
    "person": 
    {
      "id": "123",
      "name": "john",
      "update": {
        "id": "1",
        "version": "1.1.1"
      },
      "group": [
        {
          "id": "2",
          "name": "does"
        }
      ],
      "team": [
        {
          "id": "3",
          "comment": "Yay"
        }
      ],
    }
  }
}

PUT /api/person/123/

{
  "success": true,
  "message": "Record Updated",
  "data": {
    "totalCount": 1,
    "person": 
    [ // <-- NEW
        {
          "id": "123",
          "name": "john",
          "update": {
            "id": "1",
            "version": "1.1.1"
          },
          "group": [
            {
              "id": "2",
              "name": "does"
            }
          ],
          "team": [
            {
              "id": "3",
              "comment": "Yay"
            }
          ],
        }
    ]  // <-- NEW
  }
}

This happens only with 1.11 (not with 1.09)

Thanks a lot for your efforts!

You can use it without active record. Just override the default actions in your controller IE doRestList, doRestView, etc...

Thanks you are correct. Version 1.11 should address these issues. As well as add a new feature which allows you to use Scenarios to control field output.

Hello, how can I use this extension with CModel? (I dont want to use ActiveRecord.) Thank You!

I upgraded from 1.9 to 1.10 and it broke my application because the structure of the PUT response changed:

PUT {"name":"john"}

Version 1.9:

{
  "success": true,
  "message": "Record Updated",
  "data": {
    "totalCount": 1,
    "person": {
      "id": "123",
      "name": "john",
      "update": {
        "id": "1",
        "version": "1.1.1"
      },
      "group": [
        {
          "id": "2",
          "name": "does"
        }
      ],
      "team": [
        {
          "id": "3",
          "comment": "Yay"
        }
      ],
    }
  }
}

Version 1.10:

{
  "success": true,
  "message": "Record Updated",
  "data": {
    "totalCount": 1,
    "person": [
      {
        "id": "123",
        "name": "john"
      }
    ]
  }
}

Why is this happening?

Most notable is the change of the data type object becomes an array and I didn't even touch the database model etc. Also the many to many relations aren't visible anymore.

The structure of the GET output didn't change by the way.

I think I can handle the change but is this intentionally? I probably need to send another GET request because now I get less data than before.

I would like to thank the both of you for finding these bugs and submitting solutions! The new version 1.10 has your changes rolled in.

Should be: public function triggerCustomRestPut($method, $vars=array()) { $method = 'doCustomRestPut' . ucfirst($method);

    if(method_exists($this, $method))
    {
        if(count($vars) > 0)
            $this->$method($this->data(), $vars);
        else
            $this->$method($this->data());
    }
    else
    {
        throw new CHttpException(500, 'Method or Sub-Resource does not exist.');
    }

}

Instead of: public function triggerCustomRestPut($method, $vars=array()) { $method = 'doCustomRestPut' . ucfirst($method);

    if(method_exists($this, $method))
    {
        if(count($vars) > 0)
            $this->$method($this->data(), $vars);
        else
            $this->$method($this->data());
    }        
   throw new CHttpException(500, 'Method or Sub-Resource does not exist.');

}

If throw new CHttpException is out of ELSE statement, Custom PUT method will be never called.

The link to Git works for me. What happens when you click it?

The link to your git repo is wrong. Might want to fix it.

This is what I do: I post an update: {id:1,asset_id:3} The original code gets the model with all the related/nested models. So the model has now this: {id:1,asset_id:2,assets:{id:2,name:'john'}} (old record before save). Than there is a save, it saves the old asset_id, not the new one given in the $data param. But only when I have relations in the model. So what rest api returns is this {id:1,asset_id:2,assets:{id:2,name:'john'}} Other fields are saved correctly, only the indexed fields (in this case asset_id) are overwritten by the original value.

Can you give me a specific example? What exactly to you mean by "The requested relation id was over written by the original relation id"?

I found a bug when updating a record with nested relations. The requested relation id was over written by the original relation id. This will fix that.

Changed in ERestController.php:

/**
* Helper for loading a single model
*/
protected function loadOneModel($id, $nested=true) 
{
    if($nested)
        return $this->getModel()->with($this->nestedRelations)->findByPk($id);
    else
        return $this->getModel()->findByPk($id);
}

And this in the same file:

/**
 * This is broken out as a sperate method from actionResUpdate 
 * To allow for easy overriding in the controller
 * and to allow for easy unit testing
 */ 
public function doRestUpdate($id, $data) 
{       
    $model = $this->saveModel($this->loadOneModel($id,false), $data);
    $this->outputHelper(
        'Record Updated',
        $this->loadOneModel($id),
        1
    );
}

I don't think 'findByPk' with throw an exception when the PK is not found. I believe it just returns NULL...

If you have Model with Nested model, than in ERestController.php method loadOneModel should be: protected function loadOneModel($id) { try { $a=$this->getModel()->with($this->nestedRelations)->findByPk($id); } catch(Exception $ex) { $a=null; }

    if ($a)
    {
        return $a;
    }
    else
    {
        throw new CHttpException(404, 'Record Not Found');
    }

}

Otherwise PHP script return Error 500 Internal server error, for models who are not recorded in database :D

Enjoy, restfullyii -> fantastic extension

Evan,

I had a custom beforeAction() in my controller, and that threw off the "REST" - (haha)

thanks for your help and for this extension!

--iM

Hi imehesz,

I ran a test on my local and I can't replicate your problem, but I will go through the steps and you can confirm if this is what you are doing.

In your Controller (Lets say ItemController) add a method like this:

public function doCustomRestGetTesting($vars=null)
{
   $this->renderJson(array('vars'=>$vars));
}

So your GET request will look like: http://mysite/api/item/testing/cool

This should return: { "vars": [ "cool", null ] }

You can add a second param like: http://mysite/api/item/testing/cool/man

This should return: { "vars": [ "cool", "man" ] }

I hope that helps. If its still not working I would be happy to take a look at your code and give you a hand...

hello Evan,

First off, I love this extension, used it many times. Keep up the good work.

So far, I was able to use your code as is, but now I need to create some custom GET requests, and I can't seem to figure out what I'm missing...

I tried to implement your example: doCustomRestGetOrder($var=null) in my controller, but I keep getting 404 errors:

{"success":false,"message":"The requested page does not exist.","data":{"errorCode":404}}

Do I need to set something specific in my routes/accessRules/filters?

I tried to troubleshoot it a little bit, noticed that you call triggerCustomRestGet() in actionRestView(), but the thing actually breaks before it gets to that function :/

thanks for your help, --iM

Not sure what the previous two comments are referencing? This is not at all how you would use this extension. If you want to add a custom RESTFull route to your API its as simple as adding a method to your controller.

public function doCustomRestGetMyRoute($vars=array())
{
   //some logic
   $this->renderJson(array(
     'success'=>true, 
     'message'=>'I called a custom route', 
     'data'=>$vars;
   ));
}

You now have a route that looks like this:

http://yoursite.com/api/<controller>/myRoute/<optional_var1>/<optional_var2>

public function actionDelete($id) { $uri = 'http://localhost/xxx/app/index.php/api/table03/' . $id; $ch = curl_init($uri); curl_setopt_array($ch, array( CURLOPT_HEADER => FALSE, CURLOPT_HTTPHEADER => array('X-Rest-Username: admin@restuser', 'X-Rest-Password: admin@Access'), CURLOPT_RETURNTRANSFER => true, CURLOPT_VERBOSE => 1, CURLOPT_CUSTOMREQUEST => 'DELETE' )); $out = curl_exec($ch); curl_close($ch);

    echo $out;
}