From b8e81983b93c7eca235601e9c3f6a890c3dc1fdb Mon Sep 17 00:00:00 2001 From: Robbie Averill Date: Fri, 13 Sep 2019 18:09:10 -0700 Subject: [PATCH] DOCS Update PSR-12 compliance in GridField_ActionProvider docs code examples [ci skip] --- .../04_Create_a_GridField_ActionProvider.md | 50 +++++++++++-------- 1 file changed, 28 insertions(+), 22 deletions(-) diff --git a/docs/en/02_Developer_Guides/03_Forms/How_Tos/04_Create_a_GridField_ActionProvider.md b/docs/en/02_Developer_Guides/03_Forms/How_Tos/04_Create_a_GridField_ActionProvider.md index a51b960a4..a188f30ad 100644 --- a/docs/en/02_Developer_Guides/03_Forms/How_Tos/04_Create_a_GridField_ActionProvider.md +++ b/docs/en/02_Developer_Guides/03_Forms/How_Tos/04_Create_a_GridField_ActionProvider.md @@ -39,7 +39,7 @@ class GridFieldCustomAction implements GridField_ColumnProvider, GridField_Actio public function augmentColumns($gridField, &$columns) { - if(!in_array('Actions', $columns)) { + if (!in_array('Actions', $columns)) { $columns[] = 'Actions'; } } @@ -51,7 +51,7 @@ class GridFieldCustomAction implements GridField_ColumnProvider, GridField_Actio public function getColumnMetadata($gridField, $columnName) { - if($columnName == 'Actions') { + if ($columnName === 'Actions') { return ['title' => '']; } } @@ -63,7 +63,9 @@ class GridFieldCustomAction implements GridField_ColumnProvider, GridField_Actio public function getColumnContent($gridField, $record, $columnName) { - if(!$record->canEdit()) return; + if (!$record->canEdit()) { + return; + } $field = GridField_FormAction::create( $gridField, @@ -83,15 +85,16 @@ class GridFieldCustomAction implements GridField_ColumnProvider, GridField_Actio public function handleAction(GridField $gridField, $actionName, $arguments, $data) { - if($actionName == 'docustomaction') { - // perform your action here - - // output a success message to the user - Controller::curr()->getResponse()->setStatusCode( - 200, - 'Do Custom Action Done.' - ); + if ($actionName !== 'docustomaction') { + return; } + // perform your action here + + // output a success message to the user + Controller::curr()->getResponse()->setStatusCode( + 200, + 'Do Custom Action Done.' + ); } } ``` @@ -186,7 +189,9 @@ class GridFieldCustomAction implements GridField_ColumnProvider, GridField_Actio public function getCustomAction($gridField, $record) { - if(!$record->canEdit()) return; + if (!$record->canEdit()) { + return; + } return GridField_FormAction::create( $gridField, @@ -215,7 +220,7 @@ class GridFieldCustomAction implements GridField_ColumnProvider, GridField_Actio public function augmentColumns($gridField, &$columns) { - if(!in_array('Actions', $columns)) { + if (!in_array('Actions', $columns)) { $columns[] = 'Actions'; } } @@ -227,7 +232,7 @@ class GridFieldCustomAction implements GridField_ColumnProvider, GridField_Actio public function getColumnMetadata($gridField, $columnName) { - if($columnName == 'Actions') { + if ($columnName === 'Actions') { return ['title' => '']; } } @@ -255,15 +260,16 @@ class GridFieldCustomAction implements GridField_ColumnProvider, GridField_Actio public function handleAction(GridField $gridField, $actionName, $arguments, $data) { - if($actionName == 'docustomaction') { - // perform your action here - - // output a success message to the user - Controller::curr()->getResponse()->setStatusCode( - 200, - 'Do Custom Action Done.' - ); + if ($actionName !== 'docustomaction') { + return; } + // perform your action here + + // output a success message to the user + Controller::curr()->getResponse()->setStatusCode( + 200, + 'Do Custom Action Done.' + ); } } ```