Skip to content

Console

Michał Golon edited this page Jul 27, 2018 · 3 revisions

The package adds 4 console commands for generating actions and responders.

All commands use configuration for resolving placement of the generated classes.

artisan make:adr:action

Running php artisan make:adr:action MyAwesomeAction will create new MyAwesomeAction class in proper directory.

Command takes one argument:

  • name - action's class name.

Command takes two options:

  • -r or --responder - flag to generate responder class along with the action class (giving example above, MyAwesomeActionResponder class will be generated in proper directory; action class will have $responderClass property automatically set),
  • -t or --responder_type - flag to indicate responder's type: plain or extended.

artisan make:adr:action_resource

Running php artisan make:adr:action_resource Users will create resource-like actions (5 or 7). All classes will be generated in proper directory.

Command takes one argument:

  • name - resource name (with namespace).

Command takes four options:

  • -a or --api - flag to generate API-like resource actions
  • -r or --responder - flag to generate responder classes along with actions (it will behave in the same way as command above, i.e. generate set or responders and bind them with controller via class property),
  • -t or --responder_type - flag to indicate responders type: plain or extended,
  • -o or --only - flag to set which resource type to generate (similar to route options),
  • -e or --except - flag to set which resource type not to generate (similar to route options).

Example:

php artisan make:adr:action_resource Users -r -a

will generate 5 action classes and 5 responders classes:

  • DestroyUserAction, IndexUsersAction, ShowUserAction, StoreUserAction, UpdateUserAction,
  • DestroyUserActionResponder, IndexUsersActionResponder, ShowUserActionResponder, StoreUserActionResponder, UpdateUserActionResponder.

artisan make:adr:responder

Running php artisan make:adr:responder MyAwesomeActionResponder will create new MyAwesomeActionResponder class in proper directory.

Command takes one argument:

  • name - responder's class name.

Command takes one option:

  • -t or --type - flag to indicate responder's type: plain or extended.

artisan make:adr:responder_resource

Running php artisan make:adr:responder_resource Users will create resource-like responders (5 or 7). All classes will be generated in proper directory.

Command takes one argument:

  • name - resource name (with namespace).

Command takes three options:

  • -a or --api - flag to generate API-like resource responders
  • -t or --type - flag to indicate responders type: plain or extended,
  • -o or --only - flag to set which resource type to generate (similar to route options),
  • -e or --except - flag to set which resource type not to generate (similar to route options).