Model
This is a base template object. Equivalent to a Model in ORM.
class Winter\Storm\Halcyon\Model
extends Winter\Storm\Extension\Extendable
implements
Winter\Storm\Halcyon\ModelInterface,
ArrayAccess,
Illuminate\Contracts\Support\Arrayable,
Illuminate\Contracts\Support\Jsonable,
JsonSerializable
Extends
Class | Description |
---|---|
Extendable
|
Extension class |
Traits
Trait | Description |
---|---|
Emitter
|
Adds event related features to any class. |
ExtendableTrait
|
This extension trait is used when access to the underlying base class is not available, such as classes that belong to the foundation framework (Laravel). It is currently used by the Controller and Model classes. |
Properties
public
$attributes
:
array
= []
The model's attributes, saved to the settings area.
public
$exists
:
bool
= false
Indicates if the model exists.
protected
$allowedExtensions
:
array
= ["htm"]
Allowable file extensions.
protected
$appends
:
array
= []
The accessors to append to the model's array form.
protected
static
$booted
:
array
= []
The array of booted models.
protected static $cache : Illuminate\Cache\CacheManager | null
The cache manager instance.
protected $datasource : string | null
The data source for the model, a directory path.
protected
$defaultExtension
:
string
= "htm"
Default file extension.
protected $dirName : string | null
The container name associated with the model, eg: pages.
protected static $dispatcher : Winter\Storm\Events\Dispatcher | null
The event dispatcher instance.
protected
static
$eventsBooted
:
array
= []
The array of models booted events.
protected
$fillable
:
array
= []
The attributes that are mass assignable.
protected
$isCompoundObject
:
bool
= true
Model supports code and settings sections.
protected
$loadedFromCache
:
bool
= false
Indicated whether the object was loaded from the cache.
protected
$maxNesting
:
int
= 2
The maximum allowed path nesting level. The default value is 2, meaning that files can only exist in the root directory, or in a subdirectory. Set to null if any level is allowed.
protected
static
$mutatorCache
:
array
= []
The cache of the mutated attributes for each class.
protected
$observables
:
array
= []
User exposed observable events.
protected
$original
:
array
= []
The model attribute's original state.
protected
$purgeable
:
array
= []
List of attribute names which are not considered "settings".
protected static $resolver : Winter\Storm\Halcyon\Datasource\ResolverInterface | null
The datasource resolver instance.
protected
$wrapCode
:
bool
= true
Wrap code section in PHP tags.
inherited
public
$implement
:
string
|
array
|
null
= null
Extensions implemented by this class.
inherited
protected
$emitterEventCollection
:
array
= []
Collection of registered events.
inherited
protected
$emitterEventSorted
:
array
= []
Sorted collection of events.
inherited
protected
$emitterSingleEventCollection
:
array
= []
Collection of registered events to be fired once only.
inherited
protected
static
$extendableCallbacks
:
array
= []
Used to extend the constructor of an extendable class. Eg:
Class::extend(function($obj) { })
inherited
protected
static
$extendableClassLoader
:
ClassLoader
|
null
= null
Class loader instance.
inherited
protected
$extendableConstructed
:
bool
= false
Indicates if the extendable constructor has completed.
inherited
protected
static
$extendableStaticMethods
:
array
= []
Collection of static methods used by behaviors.
inherited
protected
$extensionData
:
array
= {"extensions":[],"methods":[],"dynamicMethods":[],"dynamicProperties":[]}
Class reflection information, including behaviors.
inherited
protected
$localCallbacks
:
array
= []
This stores any locally-scoped callbacks fired before the extendable constructor had completed.
Methods
public __call (string $method, array $parameters) : mixed
Handle dynamic method calls into the model.
Property | Type | Description |
---|---|---|
$method | string |
string
|
$parameters | array |
array
|
public static __callStatic (string $method, array $parameters) : mixed
Handle dynamic static method calls into the method.
Property | Type | Description |
---|---|---|
$method | string |
string
|
$parameters | array |
array
|
public
__construct (array $attributes = []
)
Constructor
Property | Type | Description |
---|---|---|
$attributes | array |
array
|
public __get (string $key) : mixed
Dynamically retrieve attributes on the model.
Property | Type | Description |
---|---|---|
$key | string |
string
|
public __isset (string $key) : bool
Determine if an attribute exists on the model.
Property | Type | Description |
---|---|---|
$key | string |
string
|
public __set (string $key, mixed $value) : void
Dynamically set attributes on the model.
Property | Type | Description |
---|---|---|
$key | string |
string
|
$value | mixed |
mixed
|
public __toString () : string
Convert the model to its string representation.
public __unset (string $key) : void
Unset an attribute on the model.
Property | Type | Description |
---|---|---|
$key | string |
string
|
public addObservableEvents (array | mixed $observables) : void
Add an observable event name.
Property | Type | Description |
---|---|---|
$observables | array | mixed |
array | mixed
|
public
addPurgeable (array | string | null $attributes = null
)
: $this
Adds an attribute to the purgeable attributes list
Property | Type | Description |
---|---|---|
$attributes | array | string | null |
array | string | null
|
public static all () : Winter\Storm\Halcyon\Collection
public attributesToArray () : array
Convert the model's attributes to an array.
public static cacheMutatedAttributes (string $class) : void
Extract and cache all the mutated attributes of a class.
Property | Type | Description |
---|---|---|
$class | string |
string
|
public static clearBootedModels () : void
Clear the list of booted models so they will be re-booted.
public
static
create (array $attributes = []
)
: static
Save a new model and return the instance.
Property | Type | Description |
---|---|---|
$attributes | array |
array
|
public static created (Closure | string $callback, integer $priority) : void
Register a created model event with the dispatcher.
Property | Type | Description |
---|---|---|
$callback | Closure | string |
Closure | string
|
$priority | integer |
integer
|
public static creating (Closure | string $callback, integer $priority) : void
Register a creating model event with the dispatcher.
Property | Type | Description |
---|---|---|
$callback | Closure | string |
Closure | string
|
$priority | integer |
integer
|
public delete () : bool | null
Delete the model from the database.
public static deleted (Closure | string $callback, integer $priority) : void
Register a deleted model event with the dispatcher.
Property | Type | Description |
---|---|---|
$callback | Closure | string |
Closure | string
|
$priority | integer |
integer
|
public static deleting (Closure | string $callback, integer $priority) : void
Register a deleting model event with the dispatcher.
Property | Type | Description |
---|---|---|
$callback | Closure | string |
Closure | string
|
$priority | integer |
integer
|
public static fetched (Closure | string $callback) : void
Create a new native event for handling afterFetch().
Property | Type | Description |
---|---|---|
$callback | Closure | string |
Closure | string
|
public static fetching (Closure | string $callback) : void
Create a new native event for handling beforeFetch().
Property | Type | Description |
---|---|---|
$callback | Closure | string |
Closure | string
|
public fill (array $attributes) : $this
Fill the model with an array of attributes.
Property | Type | Description |
---|---|---|
$attributes | array |
array
|
public static flushDuplicateCache () : void
Flush the memory cache.
public static flushEventListeners () : void
Remove all of the event listeners for the model.
public getAllowedExtensions () : array
Returns the allowable file extensions supported by this model.
public getAttribute (string $key) : mixed
Get a plain attribute.
Property | Type | Description |
---|---|---|
$key | string |
string
|
public getAttributes () : array
Get all of the current attributes on the model.
public getBaseFileNameAttribute () : string
Returns the file name without the extension.
public static getCacheManager () : Illuminate\Cache\CacheManager | null
Get the cache manager instance.
public getDatasource () : Winter\Storm\Halcyon\Datasource\DatasourceInterface
public getDatasourceName () : string
Get the current datasource name for the model.
public static getDatasourceResolver () : Winter\Storm\Halcyon\Datasource\ResolverInterface
public getDirty () : array
Get the attributes that have been changed since last sync.
public static getEventDispatcher () : Winter\Storm\Events\Dispatcher
public
getFileNameParts ($fileName = null
)
Returns the base file name and extension. Applies a default extension, if none found.
Property | Type | Description |
---|---|---|
$fileName | mixed |
mixed
|
public getIdAttribute () : string
Helper for {{ page.id }} or {{ layout.id }} twig vars Returns a semi-unique string for this object.
public getMaxNesting () : int
Returns the maximum directory nesting allowed by this template.
public getMutatedAttributes () : array
Get the mutated attributes for a given instance.
public getObjectTypeDirName () : string
Returns the directory name corresponding to the object type.
For pages the directory name is "pages", for layouts - "layouts", etc.
public getObservableEvents () : array
Get the observable event names.
public
getOriginal (string | null $key = null
, mixed $default = null
)
: array
Get the model's original attribute values.
Property | Type | Description |
---|---|---|
$key | string | null |
string | null
|
$default | mixed |
mixed
|
public getSettingsAttribute () : array
The settings is attribute contains everything that should be saved to the settings area.
public getWrapCode () : bool
Returns true if the code section will be wrapped in PHP tags.
public hasGetMutator (string $key) : bool
Determine if a get mutator exists for an attribute.
Property | Type | Description |
---|---|---|
$key | string |
string
|
public hasSetMutator (string $key) : bool
Determine if a set mutator exists for an attribute.
Property | Type | Description |
---|---|---|
$key | string |
string
|
public
static
hydrate (array $items, string | null $datasource = null
)
: Winter\Storm\Halcyon\Collection
Create a collection of models from plain arrays.
Property | Type | Description |
---|---|---|
$items | array |
array
|
$datasource | string | null |
string | null
|
public static initCacheItem (mixed $item)
Initializes the object properties from the cached data. The extra data set here becomes available as attributes set on the model after fetch.
Property | Type | Description |
---|---|---|
$item | mixed |
mixed
|
public isCompoundObject () : bool
Returns true if this template supports code and settings sections.
public
isDirty (array | string | null $attributes = null
)
: bool
Determine if the model or given attribute(s) have been modified.
Property | Type | Description |
---|---|---|
$attributes | array | string | null |
array | string | null
|
public isFillable (string $key) : bool
Determine if the given attribute may be mass assigned.
Property | Type | Description |
---|---|---|
$key | string |
string
|
public isLoadedFromCache () : bool
Returns true if the object was loaded from the cache.
public jsonSerialize () : array
Convert the object into something JSON serializable.
public
newCollection (array $models = []
)
: Winter\Storm\Halcyon\Collection
Create a new Halcyon Collection instance.
Property | Type | Description |
---|---|---|
$models | array |
array
|
public
newFromBuilder (array $attributes = []
, string | null $datasource = null
)
: static
Create a new model instance that is existing.
Property | Type | Description |
---|---|---|
$attributes | array |
array
|
$datasource | string | null |
string | null
|
public
newInstance (array $attributes = []
, boolean $exists = false
)
: static
Create a new instance of the given model.
Property | Type | Description |
---|---|---|
$attributes | array |
array
|
$exists | boolean |
boolean
|
public newQuery () : Winter\Storm\Halcyon\Builder
public offsetExists (mixed $offset) : bool
Determine if the given attribute exists.
Property | Type | Description |
---|---|---|
$offset | mixed |
mixed
|
public offsetGet (mixed $offset) : mixed
Get the value for a given offset.
Property | Type | Description |
---|---|---|
$offset | mixed |
mixed
|
public offsetSet (mixed $offset, mixed $value) : void
Set the value for a given offset.
Property | Type | Description |
---|---|---|
$offset | mixed |
mixed
|
$value | mixed |
mixed
|
public offsetUnset (mixed $offset) : void
Unset the value for a given offset.
Property | Type | Description |
---|---|---|
$offset | mixed |
mixed
|
public
static
on (string | null $datasource = null
)
: Winter\Storm\Halcyon\Model
Begin querying the model on a given datasource.
Property | Type | Description |
---|---|---|
$datasource | string | null |
string | null
|
public static query () : Winter\Storm\Halcyon\Builder
public removeObservableEvents (array | mixed $observables) : void
Remove an observable event name.
Property | Type | Description |
---|---|---|
$observables | array | mixed |
array | mixed
|
public
static
resolveDatasource (string | null $datasource = null
)
: Winter\Storm\Halcyon\Datasource\DatasourceInterface
Resolve a datasource instance.
Property | Type | Description |
---|---|---|
$datasource | string | null |
string | null
|
public
save (array $options = []
)
: bool
Save the model to the datasource.
Property | Type | Description |
---|---|---|
$options | array |
array
|
public
saveInternal (array $options = []
)
: bool
Save the model to the database. Is used by {@link save()} and {@link forceSave()}.
Property | Type | Description |
---|---|---|
$options | array |
array
|
public static saved (Closure | string $callback, integer $priority) : void
Register a saved model event with the dispatcher.
Property | Type | Description |
---|---|---|
$callback | Closure | string |
Closure | string
|
$priority | integer |
integer
|
public static saving (Closure | string $callback, integer $priority) : void
Register a saving model event with the dispatcher.
Property | Type | Description |
---|---|---|
$callback | Closure | string |
Closure | string
|
$priority | integer |
integer
|
public setAttribute (string $key, mixed $value) : $this
Set a given attribute on the model.
Property | Type | Description |
---|---|---|
$key | string |
string
|
$value | mixed |
mixed
|
public static setCacheManager (Illuminate\Cache\CacheManager $cache) : void
Set the cache manager instance.
Property | Type | Description |
---|---|---|
$cache | Illuminate\Cache\CacheManager |
Illuminate\Cache\CacheManager
|
public setDatasource (string $name) : $this
Set the datasource associated with the model.
Property | Type | Description |
---|---|---|
$name | string |
string
|
public static setDatasourceResolver (Winter\Storm\Halcyon\Datasource\ResolverInterface $resolver) : void
Set the datasource resolver instance.
Property | Type | Description |
---|---|---|
$resolver | Winter\Storm\Halcyon\Datasource\ResolverInterface |
Winter\Storm\Halcyon\Datasource\ResolverInterface
|
public static setEventDispatcher (Illuminate\Contracts\Events\Dispatcher $dispatcher) : void
Set the event dispatcher instance.
Property | Type | Description |
---|---|---|
$dispatcher | Illuminate\Contracts\Events\Dispatcher |
Illuminate\Contracts\Events\Dispatcher
|
public setFileNameAttribute (mixed $value)
File name should always contain an extension.
Property | Type | Description |
---|---|---|
$value | mixed |
mixed
|
public setLoadedFromCache ($value) : void
Returns true if the object was loaded from the cache.
Property | Type | Description |
---|---|---|
$value | mixed |
mixed
|
public setObservableEvents (array $observables) : $this
Set the observable event names.
Property | Type | Description |
---|---|---|
$observables | array |
array
|
public
setRawAttributes (array $attributes, boolean $sync = false
)
: $this
Set the array of model attributes. No checking is done.
Property | Type | Description |
---|---|---|
$attributes | array |
array
|
$sync | boolean |
boolean
|
public setSettingsAttribute (mixed $value)
Filling the settings should merge it with attributes.
Property | Type | Description |
---|---|---|
$value | mixed |
mixed
|
public syncOriginal () : $this
Sync the original attributes with the current.
public syncOriginalAttribute (string $attribute) : $this
Sync a single original attribute with its current value.
Property | Type | Description |
---|---|---|
$attribute | string |
string
|
public toArray () : array
Convert the model instance to an array.
public toJson (integer $options) : string
Convert the model instance to JSON.
Property | Type | Description |
---|---|---|
$options | integer |
integer
|
public static unsetCacheManager () : void
Unset the cache manager for models.
public static unsetDatasourceResolver () : void
Unset the datasource resolver for models.
public static unsetEventDispatcher () : void
Unset the event dispatcher for models.
public
update (array $attributes = []
)
: bool | int
Update the model in the database.
Property | Type | Description |
---|---|---|
$attributes | array |
array
|
public static updated (Closure | string $callback, integer $priority) : void
Register an updated model event with the dispatcher.
Property | Type | Description |
---|---|---|
$callback | Closure | string |
Closure | string
|
$priority | integer |
integer
|
public static updating (Closure | string $callback, integer $priority) : void
Register an updating model event with the dispatcher.
Property | Type | Description |
---|---|---|
$callback | Closure | string |
Closure | string
|
$priority | integer |
integer
|
protected static boot () : void
The "booting" method of the model.
protected bootIfNotBooted () : void
Check if the model needs to be booted and if so, do it.
protected bootNicerEvents ()
Bind some nicer events to this model, in the format of method overrides.
protected static bootTraits () : void
Boot all of the bootable traits on the model.
protected fillableFromArray (array $attributes) : array
Get the fillable attributes of a given array.
Property | Type | Description |
---|---|---|
$attributes | array |
array
|
protected finishSave () : void
Finish processing on a successful save operation.
protected
fireModelEvent (string $event, boolean $halt = true
)
: mixed
Fire the given event for the model.
Property | Type | Description |
---|---|---|
$event | string |
string
|
$halt | boolean |
boolean
|
protected getArrayableAppends () : array
Get all of the appendable values that are arrayable.
protected getAttributeFromArray (string $key) : mixed
Get an attribute from the $attributes array.
Property | Type | Description |
---|---|---|
$key | string |
string
|
protected mutateAttribute (string $key, mixed $value) : mixed
Get the value of an attribute using its mutator.
Property | Type | Description |
---|---|---|
$key | string |
string
|
$value | mixed |
mixed
|
protected mutateAttributeForArray (string $key, mixed $value) : mixed
Get the value of an attribute using its mutator for array conversion.
Property | Type | Description |
---|---|---|
$key | string |
string
|
$value | mixed |
mixed
|
protected originalIsNumericallyEquivalent (string $key) : bool
Determine if the new and old values for a given key are numerically equivalent.
Property | Type | Description |
---|---|---|
$key | string |
string
|
protected performDeleteOnModel () : void
Perform the actual delete query on this model instance.
protected performInsert (Winter\Storm\Halcyon\Builder $query) : bool
Perform a model insert operation.
Property | Type | Description |
---|---|---|
$query | Winter\Storm\Halcyon\Builder |
Winter\Storm\Halcyon\Builder
|
protected performUpdate (Winter\Storm\Halcyon\Builder $query) : bool
Perform a model update operation.
Property | Type | Description |
---|---|---|
$query | Winter\Storm\Halcyon\Builder |
Winter\Storm\Halcyon\Builder
|
protected static registerModelEvent (string $event, Closure | string $callback, integer $priority) : void
Register a model event with the dispatcher.
Property | Type | Description |
---|---|---|
$event | string |
string
|
$callback | Closure | string |
Closure | string
|
$priority | integer |
integer
|
inherited
public
addDynamicMethod (string $dynamicName, callable $method, string $extension = null
)
Programmatically adds a method to the extendable class
Property | Type | Description |
---|---|---|
$dynamicName | string |
string
|
$method | callable |
callable
|
$extension | string |
string
|
inherited
public
addDynamicProperty (string $dynamicName, mixed $value = null
)
: void
Programmatically adds a property to the extendable class
Property | Type | Description |
---|---|---|
$dynamicName | string |
string
The name of the property to add |
$value | mixed |
mixed
The value of the property |
inherited public asExtension (string $shortName) : mixed
Short hand for getClassExtension()
method, except takes the short
extension name, example:
$this->asExtension('FormController')
Property | Type | Description |
---|---|---|
$shortName | string |
string
|
inherited
public
bindEvent (string | Closure | QueuedClosure $event, mixed $callback = null
, integer $priority)
: self
Create a new event binding.
Property | Type | Description |
---|---|---|
$event | string | Closure | QueuedClosure |
string | Closure | QueuedClosure
|
$callback | mixed |
mixed
when the third parameter is omitted and a Closure or QueuedClosure is provided this parameter is used as an integer this is used as priority variable |
$priority | integer |
integer
|
inherited
public
bindEventOnce (string | Closure | QueuedClosure $event, QueuedClosure | Closure | null $callback = null
)
: self
Create a new event binding that fires once only
Property | Type | Description |
---|---|---|
$event | string | Closure | QueuedClosure |
string | Closure | QueuedClosure
|
$callback | QueuedClosure | Closure | null |
QueuedClosure | Closure | null
When a Closure or QueuedClosure is provided as the first parameter this parameter can be omitted |
inherited public static clearExtendedClasses () : void
Clear the list of extended classes so they will be re-extended.
inherited public extendClassWith (string $extensionName) : void
Dynamically extend a class with a specified behavior
Property | Type | Description |
---|---|---|
$extensionName | string |
string
|
inherited
public
static
extendableAddExtension (callable $callback, boolean $scoped = false
, $outerScope = null
)
: void
Extends the class using a closure.
The closure will be provided a single parameter which is the instance of the extended class, by default.
You may optionally specify the callback as a scoped callback, which inherits the scope of the extended class and
provides access to protected and private methods and properties. This makes any call using $this
act on the
extended class, not the class providing the extension.
If you use a scoped callback, you can provide the "outer" scope - or the scope of the class providing the extension, with the third parameter. The outer scope object will then be passed as the single parameter to the closure.
Property | Type | Description |
---|---|---|
$callback | callable |
callable
|
$scoped | boolean |
boolean
|
$outerScope | mixed |
mixed
|
inherited
public
extendableCall (string $name, array $params = null
)
: mixed
Magic method for __call()
.
Callback priority is as follows:
- "Dynamic Methods" added locally to the object via addDynamicMethod($name, $callable)
- Methods available on Behaviors that have been implemented by the object
- Pass it to the parent's __call() method if it defines one
Property | Type | Description |
---|---|---|
$name | string |
string
|
$params | array |
array
|
inherited
public
static
extendableCallStatic (string $name, array $params = null
)
: mixed
Magic method for __callStatic()
Property | Type | Description |
---|---|---|
$name | string |
string
|
$params | array |
array
|
inherited public extendableConstruct ()
This method should be called as part of the constructor.
inherited
public
static
extendableExtendCallback (callable $callback, boolean $scoped = false
, $outerScope = null
)
: void
Helper method for ::extend()
static method.
Property | Type | Description |
---|---|---|
$callback | callable |
callable
|
$scoped | boolean |
boolean
|
$outerScope | mixed |
mixed
|
inherited public extendableGet (string $name) : mixed | null
Magic method for __get()
Property | Type | Description |
---|---|---|
$name | string |
string
|
inherited public extendableSet (string $name, mixed $value) : void
Magic method for __set()
Property | Type | Description |
---|---|---|
$name | string |
string
|
$value | mixed |
mixed
|
inherited
public
fireEvent (string $event, array $params = []
, boolean $halt = false
)
: array | mixed | null
Fire an event and call the listeners.
Property | Type | Description |
---|---|---|
$event | string |
string
Event name |
$params | array |
array
Event parameters |
$halt | boolean |
boolean
Halt after first non-null result |
If halted, the first non-null result. If not halted, an array of event results. Returns null if no listeners returned a result.
inherited public getClassExtension (string $name) : mixed
Returns a behavior object from an extendable class, example:
$this->getClassExtension('Backend.Behaviors.FormController')
Property | Type | Description |
---|---|---|
$name | string |
string
Fully qualified behavior name |
inherited public getClassMethods () : array
Get a list of class methods, extension equivalent of get_class_methods()
inherited public getDynamicProperties () : array
Returns all dynamic properties and their values
['property' => 'value']
inherited public isClassExtendedWith (string $name) : bool
Check if extendable class is extended with a behavior object
Property | Type | Description |
---|---|---|
$name | string |
string
Fully qualified behavior name |
inherited public methodExists (string $name) : bool
Checks if a method exists, extension equivalent of method_exists()
Property | Type | Description |
---|---|---|
$name | string |
string
|
inherited public propertyExists (string $name) : bool
Checks if a property exists, extension equivalent of property_exists()
Property | Type | Description |
---|---|---|
$name | string |
string
|
inherited
public
unbindEvent (string | array | object $event = null
)
: self
Destroys an event binding.
Property | Type | Description |
---|---|---|
$event | string | array | object |
string | array | object
Event to destroy |
inherited protected emitterEventSortEvents (string $eventName) : void
Sort the listeners for a given event by priority.
Property | Type | Description |
---|---|---|
$eventName | string |
string
|
inherited
protected
extendableAddLocalExtension (Closure $callback, $outerScope = null
)
Adds local extensibility to the current instance.
This rebinds a given closure to the current instance, making it able to access protected and private methods. This
makes any call using $this
within the closure act on the extended class, not the class providing the extension.
An outer scope may be provided by providing a second parameter, which will then be passed through to the closure as its first parameter. If this is not given, the current instance will be provided as the first parameter.
Property | Type | Description |
---|---|---|
$callback | Closure |
Closure
|
$outerScope | mixed |
mixed
|
inherited protected extendableIsAccessible (mixed $class, string $propertyName) : bool
Checks if a property is accessible, property equivalent of is_callable()
Property | Type | Description |
---|---|---|
$class | mixed |
mixed
|
$propertyName | string |
string
|
inherited protected extensionCallMethod (ReflectionClass $class, string $method, array $params)
Calls a method through reflection.
Property | Type | Description |
---|---|---|
$class | ReflectionClass |
ReflectionClass
|
$method | string |
string
|
$params | array |
array
|
inherited protected extensionExtractMethods (string $extensionName, object $extensionObject) : void
Extracts the available methods from a behavior and adds it to the list of callable methods.
Property | Type | Description |
---|---|---|
$extensionName | string |
string
|
$extensionObject | object |
object
|
inherited protected extensionGetClassLoader () : Winter\Storm\Support\ClassLoader | null
Gets the class loader
inherited
protected
extensionGetParentClass ($instance = null
)
: ReflectionClass | false
Gets the parent class using reflection.
The parent class must either not be the Extendable
class, or must not be using the ExtendableTrait
trait,
in order to prevent infinite loops.
Property | Type | Description |
---|---|---|
$instance | mixed |
mixed
|
inherited protected extensionMethodExists (ReflectionClass $class, string $methodName) : bool
Determines if the given class reflection contains the given method.
Property | Type | Description |
---|---|---|
$class | ReflectionClass |
ReflectionClass
|
$methodName | string |
string
|
inherited protected extensionNormalizeClassName (string $name) : string
Normalizes the provided extension name allowing for the ClassLoader to inject aliased classes
Property | Type | Description |
---|---|---|
$name | string |
string
|
inherited
protected
parseEventAndPayload (mixed $event, mixed $payload = null
)
: array
Parse the given event and payload and prepare them for dispatching.
Property | Type | Description |
---|---|---|
$event | mixed |
mixed
|
$payload | mixed |
mixed
|
Extended by
Class | Description |
---|---|
CmsObject
|
This is a base class for all CMS objects - content files, pages, partials and layouts. |