platform/api/laravel/Foundation/Console/ChannelListCommand.yaml
2024-09-02 10:44:11 -07:00

119 lines
2.9 KiB
YAML

name: ChannelListCommand
class_comment: null
dependencies:
- name: Closure
type: class
source: Closure
- name: Command
type: class
source: Illuminate\Console\Command
- name: Broadcaster
type: class
source: Illuminate\Contracts\Broadcasting\Broadcaster
- name: Collection
type: class
source: Illuminate\Support\Collection
- name: AsCommand
type: class
source: Symfony\Component\Console\Attribute\AsCommand
- name: Terminal
type: class
source: Symfony\Component\Console\Terminal
properties:
- name: name
visibility: protected
comment: '# * The console command name.
# *
# * @var string'
- name: description
visibility: protected
comment: '# * The console command description.
# *
# * @var string'
- name: terminalWidthResolver
visibility: protected
comment: '# * The terminal width resolver callback.
# *
# * @var \Closure|null'
methods:
- name: handle
visibility: public
parameters:
- name: broadcaster
comment: "# * The console command name.\n# *\n# * @var string\n# */\n# protected\
\ $name = 'channel:list';\n# \n# /**\n# * The console command description.\n#\
\ *\n# * @var string\n# */\n# protected $description = 'List all registered private\
\ broadcast channels';\n# \n# /**\n# * The terminal width resolver callback.\n\
# *\n# * @var \\Closure|null\n# */\n# protected static $terminalWidthResolver;\n\
# \n# /**\n# * Execute the console command.\n# *\n# * @param \\Illuminate\\Contracts\\\
Broadcasting\\Broadcaster $broadcaster\n# * @return void"
- name: displayChannels
visibility: protected
parameters:
- name: channels
comment: '# * Display the channel information on the console.
# *
# * @param Collection $channels
# * @return void'
- name: forCli
visibility: protected
parameters:
- name: channels
comment: '# * Convert the given channels to regular CLI output.
# *
# * @param \Illuminate\Support\Collection $channels
# * @return array'
- name: determineChannelCountOutput
visibility: protected
parameters:
- name: channels
- name: terminalWidth
comment: '# * Determine and return the output for displaying the number of registered
channels in the CLI output.
# *
# * @param \Illuminate\Support\Collection $channels
# * @param int $terminalWidth
# * @return string'
- name: getTerminalWidth
visibility: public
parameters: []
comment: '# * Get the terminal width.
# *
# * @return int'
- name: resolveTerminalWidthUsing
visibility: public
parameters:
- name: resolver
comment: '# * Set a callback that should be used when resolving the terminal width.
# *
# * @param \Closure|null $resolver
# * @return void'
traits:
- Closure
- Illuminate\Console\Command
- Illuminate\Contracts\Broadcasting\Broadcaster
- Illuminate\Support\Collection
- Symfony\Component\Console\Attribute\AsCommand
- Symfony\Component\Console\Terminal
interfaces: []