383 lines
8.5 KiB
YAML
383 lines
8.5 KiB
YAML
name: DocsCommand
|
|
class_comment: null
|
|
dependencies:
|
|
- name: CarbonInterval
|
|
type: class
|
|
source: Carbon\CarbonInterval
|
|
- name: Command
|
|
type: class
|
|
source: Illuminate\Console\Command
|
|
- name: Cache
|
|
type: class
|
|
source: Illuminate\Contracts\Cache\Repository
|
|
- name: Http
|
|
type: class
|
|
source: Illuminate\Http\Client\Factory
|
|
- name: Arr
|
|
type: class
|
|
source: Illuminate\Support\Arr
|
|
- name: Collection
|
|
type: class
|
|
source: Illuminate\Support\Collection
|
|
- name: Env
|
|
type: class
|
|
source: Illuminate\Support\Env
|
|
- name: Str
|
|
type: class
|
|
source: Illuminate\Support\Str
|
|
- name: AsCommand
|
|
type: class
|
|
source: Symfony\Component\Console\Attribute\AsCommand
|
|
- name: ProcessFailedException
|
|
type: class
|
|
source: Symfony\Component\Process\Exception\ProcessFailedException
|
|
- name: ExecutableFinder
|
|
type: class
|
|
source: Symfony\Component\Process\ExecutableFinder
|
|
- name: Process
|
|
type: class
|
|
source: Symfony\Component\Process\Process
|
|
- name: Throwable
|
|
type: class
|
|
source: Throwable
|
|
properties:
|
|
- name: signature
|
|
visibility: protected
|
|
comment: '# * The name and signature of the console command.
|
|
|
|
# *
|
|
|
|
# * @var string'
|
|
- name: description
|
|
visibility: protected
|
|
comment: '# * The console command description.
|
|
|
|
# *
|
|
|
|
# * @var string'
|
|
- name: help
|
|
visibility: protected
|
|
comment: '# * The console command help text.
|
|
|
|
# *
|
|
|
|
# * @var string'
|
|
- name: http
|
|
visibility: protected
|
|
comment: '# * The HTTP client instance.
|
|
|
|
# *
|
|
|
|
# * @var \Illuminate\Http\Client\Factory'
|
|
- name: cache
|
|
visibility: protected
|
|
comment: '# * The cache repository implementation.
|
|
|
|
# *
|
|
|
|
# * @var \Illuminate\Contracts\Cache\Repository'
|
|
- name: urlOpener
|
|
visibility: protected
|
|
comment: '# * The custom URL opener.
|
|
|
|
# *
|
|
|
|
# * @var callable|null'
|
|
- name: version
|
|
visibility: protected
|
|
comment: '# * The custom documentation version to open.
|
|
|
|
# *
|
|
|
|
# * @var string|null'
|
|
- name: systemOsFamily
|
|
visibility: protected
|
|
comment: '# * The operating system family.
|
|
|
|
# *
|
|
|
|
# * @var string'
|
|
methods:
|
|
- name: configure
|
|
visibility: protected
|
|
parameters: []
|
|
comment: "# * The name and signature of the console command.\n# *\n# * @var string\n\
|
|
# */\n# protected $signature = 'docs {page? : The documentation page to open}\
|
|
\ {section? : The section of the page to open}';\n# \n# /**\n# * The console command\
|
|
\ description.\n# *\n# * @var string\n# */\n# protected $description = 'Access\
|
|
\ the Laravel documentation';\n# \n# /**\n# * The console command help text.\n\
|
|
# *\n# * @var string\n# */\n# protected $help = 'If you would like to perform\
|
|
\ a content search against the documentation, you may call: <fg=green>php artisan\
|
|
\ docs -- </><fg=green;options=bold;>search query here</>';\n# \n# /**\n# * The\
|
|
\ HTTP client instance.\n# *\n# * @var \\Illuminate\\Http\\Client\\Factory\n#\
|
|
\ */\n# protected $http;\n# \n# /**\n# * The cache repository implementation.\n\
|
|
# *\n# * @var \\Illuminate\\Contracts\\Cache\\Repository\n# */\n# protected $cache;\n\
|
|
# \n# /**\n# * The custom URL opener.\n# *\n# * @var callable|null\n# */\n# protected\
|
|
\ $urlOpener;\n# \n# /**\n# * The custom documentation version to open.\n# *\n\
|
|
# * @var string|null\n# */\n# protected $version;\n# \n# /**\n# * The operating\
|
|
\ system family.\n# *\n# * @var string\n# */\n# protected $systemOsFamily = PHP_OS_FAMILY;\n\
|
|
# \n# /**\n# * Configure the current command.\n# *\n# * @return void"
|
|
- name: handle
|
|
visibility: public
|
|
parameters:
|
|
- name: http
|
|
- name: cache
|
|
comment: '# * Execute the console command.
|
|
|
|
# *
|
|
|
|
# * @param \Illuminate\Http\Client\Factory $http
|
|
|
|
# * @param \Illuminate\Contracts\Cache\Repository $cache
|
|
|
|
# * @return int'
|
|
- name: openUrl
|
|
visibility: protected
|
|
parameters: []
|
|
comment: '# * Open the documentation URL.
|
|
|
|
# *
|
|
|
|
# * @return void'
|
|
- name: url
|
|
visibility: protected
|
|
parameters: []
|
|
comment: '# * The URL to the documentation page.
|
|
|
|
# *
|
|
|
|
# * @return string'
|
|
- name: page
|
|
visibility: protected
|
|
parameters: []
|
|
comment: '# * The page the user is opening.
|
|
|
|
# *
|
|
|
|
# * @return string'
|
|
- name: resolvePage
|
|
visibility: protected
|
|
parameters: []
|
|
comment: '# * Determine the page to open.
|
|
|
|
# *
|
|
|
|
# * @return string|null'
|
|
- name: didNotRequestPage
|
|
visibility: protected
|
|
parameters: []
|
|
comment: '# * Determine if the user requested a specific page when calling the command.
|
|
|
|
# *
|
|
|
|
# * @return bool'
|
|
- name: askForPage
|
|
visibility: protected
|
|
parameters: []
|
|
comment: '# * Ask the user which page they would like to open.
|
|
|
|
# *
|
|
|
|
# * @return string|null'
|
|
- name: askForPageViaCustomStrategy
|
|
visibility: protected
|
|
parameters: []
|
|
comment: '# * Ask the user which page they would like to open via a custom strategy.
|
|
|
|
# *
|
|
|
|
# * @return string|null'
|
|
- name: askForPageViaAutocomplete
|
|
visibility: protected
|
|
parameters: []
|
|
comment: '# * Ask the user which page they would like to open using autocomplete.
|
|
|
|
# *
|
|
|
|
# * @return string|null'
|
|
- name: guessPage
|
|
visibility: protected
|
|
parameters:
|
|
- name: search
|
|
comment: '# * Guess the page the user is attempting to open.
|
|
|
|
# *
|
|
|
|
# * @return string|null'
|
|
- name: section
|
|
visibility: protected
|
|
parameters:
|
|
- name: page
|
|
comment: '# * The section the user specifically asked to open.
|
|
|
|
# *
|
|
|
|
# * @param string $page
|
|
|
|
# * @return string|null'
|
|
- name: didNotRequestSection
|
|
visibility: protected
|
|
parameters: []
|
|
comment: '# * Determine if the user requested a specific section when calling the
|
|
command.
|
|
|
|
# *
|
|
|
|
# * @return bool'
|
|
- name: guessSection
|
|
visibility: protected
|
|
parameters:
|
|
- name: page
|
|
comment: '# * Guess the section the user is attempting to open.
|
|
|
|
# *
|
|
|
|
# * @param string $page
|
|
|
|
# * @return string|null'
|
|
- name: open
|
|
visibility: protected
|
|
parameters:
|
|
- name: url
|
|
comment: '# * Open the URL in the user''s browser.
|
|
|
|
# *
|
|
|
|
# * @param string $url
|
|
|
|
# * @return void'
|
|
- name: openViaCustomStrategy
|
|
visibility: protected
|
|
parameters:
|
|
- name: url
|
|
comment: '# * Open the URL via a custom strategy.
|
|
|
|
# *
|
|
|
|
# * @param string $url
|
|
|
|
# * @return void'
|
|
- name: openViaBuiltInStrategy
|
|
visibility: protected
|
|
parameters:
|
|
- name: url
|
|
comment: '# * Open the URL via the built in strategy.
|
|
|
|
# *
|
|
|
|
# * @param string $url
|
|
|
|
# * @return void'
|
|
- name: sectionsFor
|
|
visibility: public
|
|
parameters:
|
|
- name: page
|
|
comment: '# * The available sections for the page.
|
|
|
|
# *
|
|
|
|
# * @param string $page
|
|
|
|
# * @return \Illuminate\Support\Collection'
|
|
- name: pages
|
|
visibility: public
|
|
parameters: []
|
|
comment: '# * The pages available to open.
|
|
|
|
# *
|
|
|
|
# * @return \Illuminate\Support\Collection'
|
|
- name: docs
|
|
visibility: public
|
|
parameters: []
|
|
comment: '# * Get the documentation index as a collection.
|
|
|
|
# *
|
|
|
|
# * @return \Illuminate\Support\Collection'
|
|
- name: refreshDocs
|
|
visibility: protected
|
|
parameters: []
|
|
comment: '# * Refresh the cached copy of the documentation index.
|
|
|
|
# *
|
|
|
|
# * @return void'
|
|
- name: fetchDocs
|
|
visibility: protected
|
|
parameters: []
|
|
comment: '# * Fetch the documentation index from the Laravel website.
|
|
|
|
# *
|
|
|
|
# * @return \Illuminate\Http\Client\Response'
|
|
- name: version
|
|
visibility: protected
|
|
parameters: []
|
|
comment: '# * Determine the version of the docs to open.
|
|
|
|
# *
|
|
|
|
# * @return string'
|
|
- name: searchQuery
|
|
visibility: protected
|
|
parameters: []
|
|
comment: '# * The search query the user provided.
|
|
|
|
# *
|
|
|
|
# * @return string'
|
|
- name: isSearching
|
|
visibility: protected
|
|
parameters: []
|
|
comment: '# * Determine if the command is intended to perform a search.
|
|
|
|
# *
|
|
|
|
# * @return bool'
|
|
- name: setVersion
|
|
visibility: public
|
|
parameters:
|
|
- name: version
|
|
comment: '# * Set the documentation version.
|
|
|
|
# *
|
|
|
|
# * @param string $version
|
|
|
|
# * @return $this'
|
|
- name: setUrlOpener
|
|
visibility: public
|
|
parameters:
|
|
- name: opener
|
|
comment: '# * Set a custom URL opener.
|
|
|
|
# *
|
|
|
|
# * @param callable|null $opener
|
|
|
|
# * @return $this'
|
|
- name: setSystemOsFamily
|
|
visibility: public
|
|
parameters:
|
|
- name: family
|
|
comment: '# * Set the system operating system family.
|
|
|
|
# *
|
|
|
|
# * @param string $family
|
|
|
|
# * @return $this'
|
|
traits:
|
|
- Carbon\CarbonInterval
|
|
- Illuminate\Console\Command
|
|
- Illuminate\Support\Arr
|
|
- Illuminate\Support\Collection
|
|
- Illuminate\Support\Env
|
|
- Illuminate\Support\Str
|
|
- Symfony\Component\Console\Attribute\AsCommand
|
|
- Symfony\Component\Process\Exception\ProcessFailedException
|
|
- Symfony\Component\Process\ExecutableFinder
|
|
- Symfony\Component\Process\Process
|
|
- Throwable
|
|
interfaces: []
|