Skip to content

Call setConfig() instead of config() in docs #179

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

Merged
merged 1 commit into from
Feb 7, 2023
Merged

Call setConfig() instead of config() in docs #179

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/listener-configuration/listener-options.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ like this:
public function initialize()
{
parent::initialize();
$this->Crud->config('listeners.jsonApi.withJsonApiVersion', true);
$this->Crud->setConfig('listeners.jsonApi.withJsonApiVersion', true);
}

withJsonApiVersion
Expand Down Expand Up @@ -88,7 +88,7 @@ to manipulate the generated json response. For example:
public function initialize()
{
parent::initialize();
$this->Crud->config('listeners.jsonApi.jsonOptions', [
$this->Crud->setConfig('listeners.jsonApi.jsonOptions', [
JSON_HEX_QUOT,
JSON_UNESCAPED_UNICODE,
]);
Expand All @@ -108,7 +108,7 @@ Please note that entity names:

.. code-block:: phpinline

$this->Crud->config('listeners.jsonApi.include', [
$this->Crud->setConfig('listeners.jsonApi.include', [
'currency', // belongsTo relationship and thus singular
'cultures', // hasMany relationship and thus plural
]);
Expand All @@ -127,7 +127,7 @@ generated json. For example:

.. code-block:: phpinline

$this->Crud->config('listeners.jsonApi.fieldSets', [
$this->Crud->setConfig('listeners.jsonApi.fieldSets', [
'countries' => [ // main record
'name',
],
Expand Down
2 changes: 1 addition & 1 deletion docs/preface/setup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ class and enabling it with the ``exceptionRenderer`` configuration option.
public function initialize()
{
parent::initialize();
$this->Crud->config(['listeners.jsonApi.exceptionRenderer' => 'App\Error\JsonApiExceptionRenderer']);
$this->Crud->setConfig(['listeners.jsonApi.exceptionRenderer' => 'App\Error\JsonApiExceptionRenderer']);
}
}

Expand Down