Tailor\ContentFields\RecordFinderField
Overview
RecordFinderField allows association to models
Extends
- Tailor\ContentFields\FallbackField
- Tailor\Classes\ContentFieldBase
- October\Rain\Element\Form\FieldDefinition
- October\Rain\Element\ElementBase
- October\Rain\Extension\Extendable
Implements
- Illuminate\Contracts\Support\Arrayable
- ArrayAccess
- Illuminate\Contracts\Support\Jsonable
- JsonSerializable
Public Properties
public string $modelClass
modelClass of the model to use for listing records
public int|null $maxItems
maxItems allowed
public string $inverse
inverse the relationship definition, set to the field name
public string $displayMode
displayMode for the relationship
public array $controller
controller config for displayMode: controller
Show inherited public properties
Inherited Public Properties
- $config - values for this instance. (defined in October\Rain\Element\ElementBase)
- $implement - extensions for this class. (defined in October\Rain\Extension\Extendable)
Protected Properties
There are no protected properties in the class.
Show inherited protected properties
Inherited Protected Properties
- $optionsCallback - (defined in October\Rain\Element\Form\FieldDefinition)
- $extensionData - contains class reflection information, including behaviors. (defined in October\Rain\Extension\Extendable)
- $extendableStaticMethods - is a collection of static methods used by behaviors. (defined in October\Rain\Extension\Extendable)
Public Methods
public defineConfig()
public defineConfig($config): void
defineConfig will process the field configuration.
public defineFilterScope()
public defineFilterScope($filter, $context = null): void
defineFilterScope will define how a field is displayed in a filter.
public defineFormField()
public defineFormField($form, $context = null): void
defineFormField will define how a field is displayed in a form.
public defineListColumn()
public defineListColumn($list, $context = null): void
public extendDatabaseTable()
public extendDatabaseTable($table): void
public extendModelObject()
public extendModelObject($model): void
extendModelObject will extend the record model.
public getSingularKeyName()
public getSingularKeyName(): void
Inherited Public Methods
- __call() - handles dynamic calls to the element instance to set config. (defined in October\Rain\Element\ElementBase)
- __callStatic() - calls an undefined static method. (defined in October\Rain\Extension\Extendable)
- __construct() - (defined in October\Rain\Element\ElementBase)
- __get() - dynamically retrieves the value of an attribute. (defined in October\Rain\Element\ElementBase)
- __isset() - dynamically checks if an attribute is set. (defined in October\Rain\Element\ElementBase)
- __set() - dynamically sets the value of an attribute. (defined in October\Rain\Element\ElementBase)
- __sleep() - prepare the object for serialization. (defined in October\Rain\Extension\Extendable)
- __unset() - dynamically unsets an attribute. (defined in October\Rain\Element\ElementBase)
- __wakeup() - when a model is being unserialized, check if it needs to be booted. (defined in October\Rain\Extension\Extendable)
- addDynamicMethod() - programmatically adds a method to the extendable class. (defined in October\Rain\Extension\Extendable)
- addDynamicProperty() - programmatically adds a property to the extendable class. (defined in October\Rain\Extension\Extendable)
- asExtension() - is short hand for
getClassExtension()method, except takes the short. (defined in October\Rain\Extension\Extendable) - asOptionsDefinition() - optionsDefinition. (defined in October\Rain\Element\Form\FieldDefinition)
- clearExtendedClasses() - (defined in October\Rain\Extension\Extendable)
- defineBatchFormField() - is used for import/export context. (defined in Tailor\Classes\ContentFieldBase)
- defineBatchListColumn() - (defined in Tailor\ContentFields\FallbackField)
- displayAs() - type for this field. (defined in October\Rain\Element\Form\FieldDefinition)
- evalConfig() - from an array and apply them to the object. (defined in Tailor\Classes\ContentFieldBase)
- extend() - this class with a closure. (defined in October\Rain\Extension\Extendable)
- extendBatchModelObject() - is used for import/export context. (defined in Tailor\Classes\ContentFieldBase)
- extendClassWith() - dynamically extends a class with a specified behavior. (defined in October\Rain\Extension\Extendable)
- extendModel() - (defined in Tailor\Classes\ContentFieldBase)
- extendModelMultisite() - flags relations as propagatable and must come after. (defined in Tailor\Classes\ContentFieldBase)
- extendModelValidation() - (defined in Tailor\Classes\ContentFieldBase)
- extendableCall() - magic method for
__call(). (defined in October\Rain\Extension\Extendable) - extendableCallStatic() - magic method for
__callStatic(). (defined in October\Rain\Extension\Extendable) - extendableConstruct() - should be called as part of the constructor. (defined in October\Rain\Extension\Extendable)
- extendableDestruct() - should be called when serializing the object. (defined in October\Rain\Extension\Extendable)
- extendableExtendCallback() - is a helper method for
::extend()static method. (defined in October\Rain\Extension\Extendable) - extendableGet() - magic method for
__get(). (defined in October\Rain\Extension\Extendable) - extendableSet() - magic method for
__set(). (defined in October\Rain\Extension\Extendable) - get() - an attribute from the element instance. (defined in October\Rain\Element\ElementBase)
- getClassExtension() - returns a behavior object from an extendable class, example:. (defined in October\Rain\Extension\Extendable)
- getClassMethodAsReflector() - (defined in October\Rain\Extension\Extendable)
- getClassMethods() - gets a list of class methods, extension equivalent of get_class_methods(). (defined in October\Rain\Extension\Extendable)
- getConfig() - returns the entire config array. (defined in October\Rain\Element\ElementBase)
- getDynamicProperties() - returns all dynamic properties and their values. (defined in October\Rain\Extension\Extendable)
- hasOptions() - returns true if options have been specified. (defined in October\Rain\Element\Form\FieldDefinition)
- implementClassWith() - will implement an extension using non-interference and should. (defined in October\Rain\Extension\Extendable)
- isClassExtendedWith() - checks if extendable class is extended with a behavior object. (defined in October\Rain\Extension\Extendable)
- isClassInstanceOf() - checks if the class implements the supplied interface methods. (defined in October\Rain\Extension\Extendable)
- jsonSerialize() - converts the object into something JSON serializable. (defined in October\Rain\Element\ElementBase)
- matchesContext() - returns true if the field matches the supplied context. (defined in October\Rain\Element\Form\FieldDefinition)
- methodExists() - checks if a method exists, extension equivalent of method_exists(). (defined in October\Rain\Extension\Extendable)
- offsetExists() - determines if the given offset exists. (defined in October\Rain\Element\ElementBase)
- offsetGet() - gets the value for a given offset. (defined in October\Rain\Element\ElementBase)
- offsetSet() - sets the value at the given offset. (defined in October\Rain\Element\ElementBase)
- offsetUnset() - unsets the value at the given offset. (defined in October\Rain\Element\ElementBase)
- options() - get/set for dropdowns, radio lists and checkbox lists. (defined in October\Rain\Element\Form\FieldDefinition)
- propertyExists() - checks if a property exists, extension equivalent of
property_exists(). (defined in October\Rain\Extension\Extendable) - span() - sets a side of the field on a form. (defined in October\Rain\Element\Form\FieldDefinition)
- toArray() - converts the element instance to an array. (defined in October\Rain\Element\ElementBase)
- toJson() - converts the element instance to JSON. (defined in October\Rain\Element\ElementBase)
- useConfig() - (defined in October\Rain\Element\Form\FieldDefinition)
- validate() - (defined in Tailor\Classes\ContentFieldBase)
- validateConfig() - for the field. (defined in Tailor\Classes\ContentFieldBase)
Protected Methods
protected defineFormFieldAsRelationController()
protected defineFormFieldAsRelationController($field): void
protected defineInverseModelRelationship()
protected defineInverseModelRelationship($model): void
defineInverseModelRelationship for the inverse relationship. These definitions do not rely on multisite via propagatable attribute. Inverse relations do not replicate and should be treated as read-only.
protected defineModelRelationship()
protected defineModelRelationship($model): void
defineModelRelationship for the direct relationship. These definitions rely on multisite modifying the relation definition.
See Also
protected getRelatedModel()
protected getRelatedModel(): void
getRelatedModel returns the related model to use
Show inherited protected methods
Inherited Protected Methods
- extendableIsAccessible() - checks if a property is accessible, property equivalent. (defined in October\Rain\Extension\Extendable)
- extensionExtractImplements() - will return classes to implement. (defined in October\Rain\Extension\Extendable)
- extensionExtractMethods() - extracts the available methods from a behavior and adds it. (defined in October\Rain\Extension\Extendable)
- getExtendableMethodFromDynamicMethods() - (defined in October\Rain\Extension\Extendable)
- getExtendableMethodFromExtensions() - (defined in October\Rain\Extension\Extendable)
- initDefaultValues() - for this field. (defined in October\Rain\Element\Form\FieldDefinition)
- transferConfig() - is used to reuse base configuration on a secondary definition, (defined in Tailor\Classes\ContentFieldBase)