Component
abstract class Component (View source)
Properties
| protected array | $except | The properties / methods that should not be exposed to the component. |
|
| string | $componentName | The component alias name. |
|
| ComponentAttributeBag | $attributes | The component attributes. |
|
| static protected Factory|null | $factory | The view factory instance, if any. |
|
| static protected | $componentsResolver | The component resolver callback. |
|
| static protected array<string,string> | $bladeViewCache | The cache of blade view names, keyed by contents. |
|
| static protected array | $propertyCache | The cache of public property names, keyed by class. |
|
| static protected array | $methodCache | The cache of public method names, keyed by class. |
|
| static protected array<class-string,array<int,string>> | $constructorParametersCache | The cache of constructor parameters, keyed by class. |
|
| static protected array | $ignoredParameterNames | The cache of ignored parameter names. |
Methods
Extract the constructor parameters for the component.
Resolve the Blade view or view file that should be used when rendering the component.
Create a Blade view with the raw component string content.
Create a Blade view with the raw component string content.
Get the data that should be supplied to the view.
Extract the public properties for the component.
Extract the public methods for the component.
Create a callable variable from the given method.
Create an invokable, toStringable variable for the given component method.
Determine if the given property / method should be ignored.
Get the methods that should be ignored.
Set the component alias name.
Set the extra attributes that the component should make available.
Get a new attribute bag instance.
Determine if the component should be rendered.
Get the cached set of anonymous component constructor parameter names to exclude.
Flush the component's cached state.
Forget the component's factory instance.
Forget the component's resolver callback.
Set the callback that should be used to resolve components within views.
Details
abstract View|Htmlable|Closure|string
render()
Get the view / view contents that represent the component.
static Component
resolve(array $data)
Resolve the component instance with the given data.
static protected array
extractConstructorParameters()
Extract the constructor parameters for the component.
View|Htmlable|Closure|string
resolveView()
Resolve the Blade view or view file that should be used when rendering the component.
protected string
extractBladeViewFromString(string $contents)
Create a Blade view with the raw component string content.
protected string
createBladeViewFromString(Factory $factory, string $contents)
Create a Blade view with the raw component string content.
array
data()
Get the data that should be supplied to the view.
protected array
extractPublicProperties()
Extract the public properties for the component.
protected array
extractPublicMethods()
Extract the public methods for the component.
protected mixed
createVariableFromMethod(ReflectionMethod $method)
Create a callable variable from the given method.
protected InvokableComponentVariable
createInvokableVariable(string $method)
Create an invokable, toStringable variable for the given component method.
protected bool
shouldIgnore(string $name)
Determine if the given property / method should be ignored.
protected array
ignoredMethods()
Get the methods that should be ignored.
$this
withName(string $name)
Set the component alias name.
$this
withAttributes(array $attributes)
Set the extra attributes that the component should make available.
protected ComponentAttributeBag
newAttributeBag(array $attributes = [])
Get a new attribute bag instance.
bool
shouldRender()
Determine if the component should be rendered.
View
view(string|null $view, Arrayable|array $data = [], array $mergeData = [])
Get the evaluated view contents for the given view.
protected Factory
factory()
Get the view factory instance.
static array
ignoredParameterNames()
Get the cached set of anonymous component constructor parameter names to exclude.
static void
flushCache()
Flush the component's cached state.
static void
forgetFactory()
Forget the component's factory instance.
static void
forgetComponentsResolver()
| internal |
Forget the component's resolver callback.
static void
resolveComponentsUsing($resolver)
| internal |
Set the callback that should be used to resolve components within views.