Skip to content

Commit 58c1c24

Browse files
committed
Merge branch 'master' of github.com:JordanRL/Roster
2 parents f02f314 + b3ba4c0 commit 58c1c24

File tree

10 files changed

+272
-88
lines changed

10 files changed

+272
-88
lines changed

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
"license": "GPL-3.0-only",
2525
"require": {
2626
"symfony/console": "^v5.3",
27-
"samsara/mason": "^0.1",
27+
"samsara/mason": "^0.2",
2828
"hassankhan/config": "^2.2",
2929
"symfony/yaml": "^5.3",
3030
"php": ">=8.0"

docs/roster/latest/Samsara/Roster/App.md

Lines changed: 27 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Samsara\Roster > App
22

3-
*No description available*
3+
Class App
4+
5+
This class configures and sets up the Symfony/Console application so that it is ready for the command to be executed.
46

57

68
## Inheritance
@@ -33,7 +35,7 @@
3335

3436
!!! signature constant "App::VERSION"
3537
value
36-
: 'v0.1.0-alpha'
38+
: 'v0.1.0'
3739

3840

3941

@@ -99,7 +101,7 @@
99101
: string[][]
100102

101103
description
102-
: An array of abbreviations
104+
: *No description available*
103105

104106
Returns an array of possible abbreviations given a set of names.
105107

@@ -190,7 +192,7 @@ Returns an array of possible abbreviations given a set of names.
190192
: int
191193

192194
description
193-
: 0 if everything went fine, or an error code
195+
: *No description available*
194196

195197
Runs the current application.
196198

@@ -227,7 +229,7 @@ Runs the current application.
227229
: HelperSet
228230

229231
description
230-
: The HelperSet instance associated with this command
232+
: *No description available*
231233

232234
Get the helper set associated with the command.
233235

@@ -255,7 +257,7 @@ Get the helper set associated with the command.
255257
: InputDefinition
256258

257259
description
258-
: The InputDefinition instance
260+
: *No description available*
259261

260262
Gets the InputDefinition related to this Application.
261263

@@ -266,7 +268,7 @@ Gets the InputDefinition related to this Application.
266268
: string
267269

268270
description
269-
: A help message
271+
: *No description available*
270272

271273
Gets the help message.
272274

@@ -277,7 +279,7 @@ Gets the help message.
277279
: bool
278280

279281
description
280-
: Whether to catch exceptions or not during commands execution
282+
: *No description available*
281283

282284
Gets whether to catch exceptions or not during commands execution.
283285

@@ -305,7 +307,7 @@ Gets whether to catch exceptions or not during commands execution.
305307
: bool
306308

307309
description
308-
: Whether to automatically exit after a command execution or not
310+
: *No description available*
309311

310312
Gets whether to automatically exit after a command execution or not.
311313

@@ -333,7 +335,7 @@ Gets whether to automatically exit after a command execution or not.
333335
: string
334336

335337
description
336-
: The application name
338+
: *No description available*
337339

338340
Gets the name of the application.
339341

@@ -361,7 +363,7 @@ Gets the name of the application.
361363
: string
362364

363365
description
364-
: The application version
366+
: *No description available*
365367

366368
Gets the application version.
367369

@@ -389,7 +391,7 @@ Gets the application version.
389391
: string
390392

391393
description
392-
: The long application version
394+
: *No description available*
393395

394396
Returns the long version of the application.
395397

@@ -408,7 +410,7 @@ Returns the long version of the application.
408410
: Command
409411

410412
description
411-
: The newly created command
413+
: *No description available*
412414

413415
Registers a new command.
414416

@@ -448,7 +450,7 @@ Adds an array of command objects.
448450
: Command|null
449451

450452
description
451-
: The registered command if enabled or null
453+
: *No description available*
452454

453455
Adds a command object.
454456

@@ -469,9 +471,7 @@ Adds a command object.
469471
: Command
470472

471473
description
472-
: A Command object
473-
474-
474+
: *No description available*
475475

476476
Returns a registered command by name or alias.
477477

@@ -490,7 +490,7 @@ Returns a registered command by name or alias.
490490
: bool
491491

492492
description
493-
: true if the command exists, false otherwise
493+
: *No description available*
494494

495495
Returns true if the command exists, false otherwise.
496496

@@ -501,7 +501,7 @@ Returns true if the command exists, false otherwise.
501501
: string[]
502502

503503
description
504-
: An array of namespaces
504+
: *No description available*
505505

506506
Returns an array of all unique namespaces used by currently registered commands.
507507

@@ -522,9 +522,7 @@ Returns an array of all unique namespaces used by currently registered commands.
522522
: string
523523

524524
description
525-
: A registered namespace
526-
527-
525+
: *No description available*
528526

529527
Finds a registered namespace by a name or an abbreviation.
530528

@@ -543,9 +541,7 @@ Finds a registered namespace by a name or an abbreviation.
543541
: Command
544542

545543
description
546-
: A Command instance
547-
548-
544+
: *No description available*
549545

550546
Finds a command by name or alias.
551547

@@ -566,7 +562,7 @@ Finds a command by name or alias.
566562
: Command[]
567563

568564
description
569-
: An array of Command instances
565+
: *No description available*
570566

571567
Gets the commands (registered in the given namespace if provided).
572568

@@ -620,7 +616,7 @@ Gets the commands (registered in the given namespace if provided).
620616
: string
621617

622618
description
623-
: The namespace of the command
619+
: *No description available*
624620

625621
Returns the namespace part of the command name.
626622

@@ -743,7 +739,7 @@ Sets the default Command name.
743739
: int
744740

745741
description
746-
: 0 if everything went fine, or an error code
742+
: *No description available*
747743

748744
Runs the current command.
749745

@@ -775,7 +771,7 @@ Gets the name of the command based on input.
775771
: InputDefinition
776772

777773
description
778-
: An InputDefinition instance
774+
: *No description available*
779775

780776
Gets the default input definition.
781777

@@ -786,7 +782,7 @@ Gets the default input definition.
786782
: Command[]
787783

788784
description
789-
: An array of default Command instances
785+
: *No description available*
790786

791787
Gets the default commands that should always be available.
792788

@@ -797,7 +793,7 @@ Gets the default commands that should always be available.
797793
: HelperSet
798794

799795
description
800-
: A HelperSet instance
796+
: *No description available*
801797

802798
Gets the default helper set with the helpers that should always be available.
803799

0 commit comments

Comments
 (0)