REST JSONP response serialization

[progmult]

I use JSONP as a response format when creating REST API:

public function actionIndex()
{
            \Yii::$app->response->format = \yii\web\Response::FORMAT_JSONP;
            $callback = \Yii::$app->request->queryParams['callback'];

            $searchModel = new RaspisanSearch();
            $data = $searchModel->search(\Yii::$app->request->queryParams);

            return ['data' => $data, 'callback' => $callback];
}

But actual response is serialized ActiveProvider:

callbackfunctionname({"query":{"sql":null,"on":null,"joinWith":null,"select":null,"selectOption":null,"distinct":null,"from":null,"groupBy":null,"join":null,"having":null,"union":null,"params":[],"where":null,"limit":null,"offset":null,"orderBy":null,"indexBy":null,"modelClass":"app\\models\\Raspisan","with":null,"asArray":null,"multiple":null,"primaryModel":null,"link":null,"via":null,"inverseOf":null},"key":null,"db":null,"id":null});

A problem orrurs in yii\rest\Serializer, which serialize() method don't understand ['data' => $data, 'callback' => $callback] format and return data without serialization.

public function serialize($data)
    {
        if ($data instanceof Model && $data->hasErrors()) {
            return $this->serializeModelErrors($data);
        } elseif ($data instanceof Arrayable) {
            return $this->serializeModel($data);
        } elseif ($data instanceof DataProviderInterface) {
            return $this->serializeDataProvider($data);
        } else {
            return $data;
        }
    }

[progmult]

As a solution I add new property in \yii\base\Response

/**
 * @var array of parameters. This parameters provided to response $format
 */
public $formatParams;

and then change yii\web\JsonResponseFormatter

protected function formatJsonp($response)
{
    $response->getHeaders()->set('Content-Type', 'application/javascript; charset=UTF-8');
    if ($response->data !== null && isset($response->formatParams['jsonpCallback'])) {
        $response->content = sprintf('%s(%s);', $response->formatParams['jsonpCallback'], Json::htmlEncode($response->data));
    } elseif ($response->data !== null) {
        $response->content = '';
        Yii::warning("The 'jsonp' response requires that jsonpCallback parameter to be set", __METHOD__);
    }
}

Fin

public function actionIndex()
{       
    \Yii::$app->response->format = \yii\web\Response::FORMAT_JSONP;
    \Yii::$app->response->formatParams['jsonpCallback'] = \Yii::$app->request->queryParams['callback'];

    $searchModel = new RaspisanSearch();
    return $searchModel->search(array(\Yii::$app->request->queryParams));
}

[mdmunir]

👍
prever directly use Yii::$app->request->get('callback') in yii\web\JsonResponseFormatter.
But it going break bc.

if (($callback = Yii::$app->request->get('callback')) !== null) {
    $response->content = sprintf('%s(%s);', $callback, Json::htmlEncode($response->data));
} elseif ($response->data !== null) {
    $response->content = '';
    Yii::warning("The 'jsonp' response requires that jsonpCallback parameter to be set", __METHOD__);
}

[mdmunir]

Also prefer to split jsonformater and jsonpformater into two classes. Both of class are totally diferent.
I can submit PR for this

[yii-bot]

Issue moved to yiisoft/yii-api#8