api/laravel/View/Compilers/Compiler.yaml
2024-09-26 02:03:21 -07:00

118 lines
3 KiB
YAML

name: Compiler
class_comment: null
dependencies:
- name: ErrorException
type: class
source: ErrorException
- name: Filesystem
type: class
source: Illuminate\Filesystem\Filesystem
- name: Str
type: class
source: Illuminate\Support\Str
- name: InvalidArgumentException
type: class
source: InvalidArgumentException
properties:
- name: files
visibility: protected
comment: '# * The filesystem instance.
# *
# * @var \Illuminate\Filesystem\Filesystem'
- name: cachePath
visibility: protected
comment: '# * The cache path for the compiled views.
# *
# * @var string'
- name: basePath
visibility: protected
comment: '# * The base path that should be removed from paths before hashing.
# *
# * @var string'
- name: shouldCache
visibility: protected
comment: '# * Determines if compiled views should be cached.
# *
# * @var bool'
- name: compiledExtension
visibility: protected
comment: '# * The compiled view file extension.
# *
# * @var string'
methods:
- name: __construct
visibility: public
parameters:
- name: files
- name: cachePath
- name: basePath
default: ''''''
- name: shouldCache
default: 'true'
- name: compiledExtension
default: '''php'''
comment: "# * The filesystem instance.\n# *\n# * @var \\Illuminate\\Filesystem\\\
Filesystem\n# */\n# protected $files;\n# \n# /**\n# * The cache path for the compiled\
\ views.\n# *\n# * @var string\n# */\n# protected $cachePath;\n# \n# /**\n# *\
\ The base path that should be removed from paths before hashing.\n# *\n# * @var\
\ string\n# */\n# protected $basePath;\n# \n# /**\n# * Determines if compiled\
\ views should be cached.\n# *\n# * @var bool\n# */\n# protected $shouldCache;\n\
# \n# /**\n# * The compiled view file extension.\n# *\n# * @var string\n# */\n\
# protected $compiledExtension = 'php';\n# \n# /**\n# * Create a new compiler\
\ instance.\n# *\n# * @param \\Illuminate\\Filesystem\\Filesystem $files\n#\
\ * @param string $cachePath\n# * @param string $basePath\n# * @param bool\
\ $shouldCache\n# * @param string $compiledExtension\n# * @return void\n# *\n\
# * @throws \\InvalidArgumentException"
- name: getCompiledPath
visibility: public
parameters:
- name: path
comment: '# * Get the path to the compiled version of a view.
# *
# * @param string $path
# * @return string'
- name: isExpired
visibility: public
parameters:
- name: path
comment: '# * Determine if the view at the given path is expired.
# *
# * @param string $path
# * @return bool
# *
# * @throws \ErrorException'
- name: ensureCompiledDirectoryExists
visibility: protected
parameters:
- name: path
comment: '# * Create the compiled file directory if necessary.
# *
# * @param string $path
# * @return void'
traits:
- ErrorException
- Illuminate\Filesystem\Filesystem
- Illuminate\Support\Str
- InvalidArgumentException
interfaces: []