Skip to content

Commit 925d03f

Browse files
committed
Fix doc
1 parent 104afed commit 925d03f

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

docs/guide/testing-with-sharp.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -23,39 +23,39 @@ The trait adds a few helpers:
2323

2424
Logs in the given user as a Sharp user.
2525

26-
#### `getSharpShow(string $entityKey, $instanceId)`
26+
#### `getSharpShow(string $entityClassNameOrKey, $instanceId)`
2727

28-
Call the Sharp API to display the Show Page for the Entity `$entityKey` and instance `$instanceId`.
28+
Call the Sharp API to display the Show Page for the Entity `$entityClassNameOrKey` and instance `$instanceId`.
2929

30-
#### `getSharpForm(string $entityKey, $instanceId = null)`
30+
#### `getSharpForm(string $entityClassNameOrKey, $instanceId = null)`
3131

32-
Call the Sharp API to display the Form for the Entity `$entityKey`. If `$instanceId` is provided, it will be an edit form, and otherwise a creation one.
32+
Call the Sharp API to display the Form for the Entity `$entityClassNameOrKey`. If `$instanceId` is provided, it will be an edit form, and otherwise a creation one.
3333

34-
#### `getSharpSingleForm(string $entityKey)`
34+
#### `getSharpSingleForm(string $entityClassNameOrKey)`
3535

36-
Call the Sharp API to display the edit Form for the single Entity `$entityKey`.
36+
Call the Sharp API to display the edit Form for the single Entity `$entityClassNameOrKey`.
3737

38-
#### `updateSharpForm(string $entityKey, $instanceId, array $data)`
38+
#### `updateSharpForm(string $entityClassNameOrKey, $instanceId, array $data)`
3939

40-
Call the Sharp API to update the Entity `$entityKey` of id `$instanceId`, with `$data`.
40+
Call the Sharp API to update the Entity `$entityClassNameOrKey` of id `$instanceId`, with `$data`.
4141

42-
#### `updateSharpSingleForm(string $entityKey, array $data)`
42+
#### `updateSharpSingleForm(string $entityClassNameOrKey, array $data)`
4343

44-
Call the Sharp API to update the single Entity `$entityKey` with `$data`.
44+
Call the Sharp API to update the single Entity `$entityClassNameOrKey` with `$data`.
4545

46-
#### `storeSharpForm(string $entityKey, array $data)`
46+
#### `storeSharpForm(string $entityClassNameOrKey, array $data)`
4747

48-
Call the Sharp API to store a new Entity `$entityKey` with `$data`.
48+
Call the Sharp API to store a new Entity `$entityClassNameOrKey` with `$data`.
4949

50-
#### `deleteFromSharpList(string $entityKey, $instanceId)`
50+
#### `deleteFromSharpList(string $entityClassNameOrKey, $instanceId)`
5151

52-
Call the Sharp API to delete an `$entityKey` instance on the Entity List.
52+
Call the Sharp API to delete an `$entityClassNameOrKey` instance on the Entity List.
5353

54-
#### `deleteFromSharpShow(string $entityKey, $instanceId)`
54+
#### `deleteFromSharpShow(string $entityClassNameOrKey, $instanceId)`
5555

56-
Call the Sharp API to delete an `$entityKey` instance on the Show Page.
56+
Call the Sharp API to delete an `$entityClassNameOrKey` instance on the Show Page.
5757

58-
#### `callSharpEntityCommandFromList(string $entityKey, string $commandKeyOrClassName, array $data, ?string $commandStep = null)`
58+
#### `callSharpEntityCommandFromList(string $entityClassNameOrKey, string $commandKeyOrClassName, array $data, ?string $commandStep = null)`
5959

6060
Call the `$commandKeyOrClassName` Entity Command with the optional `$data`.
6161

@@ -66,7 +66,7 @@ it('allows the user to use the wizard', function () {
6666
// First step, no need to declare any previous step
6767
$step = $this
6868
->callSharpEntityCommandFromList(
69-
entityKey: 'myCommand',
69+
entityClassNameOrKey: MyEntity::class,
7070
commandKeyOrClassName: MyWizardCommand::class,
7171
data: ['some_key' => 'some value'],
7272
)
@@ -76,7 +76,7 @@ it('allows the user to use the wizard', function () {
7676
// Second step
7777
$this
7878
->callSharpEntityCommandFromList(
79-
entityKey: 'myCommand',
79+
entityClassNameOrKey: MyEntity::class,
8080
commandKeyOrClassName: MyWizardCommand::class,
8181
data: ['another_key' => 'another value'],
8282
commandStep: $step // We must specify the step we got from the first call
@@ -87,13 +87,13 @@ it('allows the user to use the wizard', function () {
8787
});
8888
```
8989

90-
#### `callSharpInstanceCommandFromList(string $entityKey, $instanceId, string $commandKeyOrClassName, array $data, ?string $commandStep = null)`
90+
#### `callSharpInstanceCommandFromList(string $entityClassNameOrKey, $instanceId, string $commandKeyOrClassName, array $data, ?string $commandStep = null)`
9191

9292
Call the `$commandKeyOrClassName` Instance Command with the optional `$data`.
9393

9494
For a wizard command, you can refer to the [previous example](#callsharpentitycommandfromlist-string-entitykey-string-commandkeyorclassname-array-data-string-commandstep-null).
9595

96-
#### `callSharpInstanceCommandFromShow(string $entityKey, $instanceId, string $commandKeyOrClassName, array $data, ?string $commandStep = null)`
96+
#### `callSharpInstanceCommandFromShow(string $entityClassNameOrKey, $instanceId, string $commandKeyOrClassName, array $data, ?string $commandStep = null)`
9797

9898
Call the `$commandKeyOrClassName` Instance Command with the optional `$data`.
9999

0 commit comments

Comments
 (0)