1. Documentation
  2. API
  3. Backend
  4. FormWidgets
  5. Repeater

Backend\FormWidgets\Repeater

Extends:

Repeater Form Widget

Public properties

public array $form

Form field configuration

public string $prompt

Prompt text for adding new items.

public bool $sortable

Items can be sorted.

public string $titleFrom

Field name to use for the title of collapsed items

public int $minItems

Minimum items required. Pre-displays those items when not using groups

public int $maxItems

Maximum items permitted

public string $style

The style of the repeater. Can be one of three values:

  • "default": Shows all repeater items expanded on load.
  • "collapsed": Shows all repeater items collapsed on load.
  • "accordion": Shows only the first repeater item expanded on load. When another item is clicked, all other open items are collapsed.

Show inherited public properties

Inherited public properties

Protected properties

protected $defaultAlias

A unique alias to identify this widget.

protected array $indexMeta

Meta data associated to each field, organised by index

protected array $formWidgets

Collection of form widgets.

protected static bool $onAddItemCalled

Stops nested repeaters populating from previous sibling.

protected bool $useGroups

useGroups

protected array $groupDefinitions

groupDefinitions

protected boolean $loaded

Determines if repeater has been initialised previously

Show inherited protected properties

Inherited protected properties

Public methods

public string getGroupCodeFromIndex($index $index)

getGroupCodeFromIndex returns a field group code from its index

Parameters
  • $index $index - Int

public string getGroupTitle($groupCode $groupCode)

getGroupTitle returns the group title from its unique code

Parameters
  • $groupCode $groupCode - String

public void getSaveValue($value)

Process the postback value for this widget. If the value is omitted from postback data, it will be NULL, otherwise it will be an empty string.

Parameters
  • $value

public void init()

Initialize the widget, called by the constructor and free from its parameters.

public void onAddItem()

onAddItem handler

public void onRefresh()

onRefresh

public void onRemoveItem()

onRemoveItem

public void prepareVars()

prepareVars for display

public void render()

Renders the widget's primary contents.

Show inherited public methods

Inherited public methods

  • public void __call($name, $params) - defined in October\Rain\Extension\Extendable.
  • public static void __callStatic($name, $params) - defined in October\Rain\Extension\Extendable.
  • public void __construct($controller $controller, $formField $formField, $configuration $configuration=array()) - defined in Backend\Classes\FormWidgetBase. Constructor.
  • public void __get($name) - defined in October\Rain\Extension\Extendable.
  • public void __set($name, $value) - defined in October\Rain\Extension\Extendable.
  • public void addCss($name, $attributes=array()) - defined in Backend\Classes\WidgetBase. addCss includes a StyleSheet asset to the asset list.
  • public void addCssBundle($name, $attributes=array()) - defined in Backend\Classes\WidgetBase. addCssBundle includes a CSS asset to the bundled combiner stream.
  • public void addDynamicMethod(string $dynamicName, callable $method, string $extension=NULL) - defined in October\Rain\Extension\Extendable. Programmatically adds a method to the extendable class.
  • public void addDynamicProperty(string $dynamicName, string $value=NULL) - defined in October\Rain\Extension\Extendable. Programmatically adds a property to the extendable class.
  • public void addJs($name, $attributes=array()) - defined in Backend\Classes\WidgetBase. addJs includes a JavaScript asset to the asset list.
  • public void addJsBundle($name, $attributes=array()) - defined in Backend\Classes\WidgetBase. addJsBundle includes a JS asset to the bundled combiner stream.
  • public void addRss($name, $attributes=array()) - defined in Backend\Classes\WidgetBase. addRss adds an RSS link asset to the asset list. Call $this->makeAssets().
  • public void addViewPath(string|array $path) - defined in Backend\Classes\WidgetBase. addViewPath prepends a path on the available view path locations.
  • public mixed asExtension(string $shortName) - defined in October\Rain\Extension\Extendable. Short hand for getClassExtension() method, except takes the short.
  • public self bindEvent($event, $callback, $priority=0) - defined in Backend\Classes\WidgetBase. Create a new event binding.
  • public self bindEventOnce($event, $callback) - defined in Backend\Classes\WidgetBase. Create a new event binding that fires once only.
  • public void bindToController() - defined in Backend\Classes\WidgetBase. Binds a widget to the controller for safe use.
  • public static void clearExtendedClasses() - defined in October\Rain\Extension\Extendable. Clear the list of extended classes so they will be re-extended.
  • public void combineAssets($assets, $localPath='') - defined in Backend\Classes\WidgetBase. combineAssets runs asset paths through the Asset Combiner.
  • public static void extend($callback) - defined in October\Rain\Extension\Extendable.
  • public void extendClassWith(string $extensionName) - defined in October\Rain\Extension\Extendable. Dynamically extend a class with a specified behavior.
  • public mixed extendableCall(string $name, array $params=NULL) - defined in October\Rain\Extension\Extendable. Magic method for __call().
  • public static mixed extendableCallStatic(string $name, array $params=NULL) - defined in October\Rain\Extension\Extendable. Magic method for __callStatic().
  • public void extendableConstruct() - defined in October\Rain\Extension\Extendable. extendableConstruct should be called as part of the constructor.
  • public static void extendableExtendCallback(callable $callback) - defined in October\Rain\Extension\Extendable. extendableExtendCallback is a helper method for ::extend() static method.
  • public string extendableGet(string $name) - defined in October\Rain\Extension\Extendable. Magic method for __get().
  • public string extendableSet(string $name, string $value) - defined in October\Rain\Extension\Extendable. Magic method for __set().
  • public array fireEvent(string $event, array $params=array(), boolean $halt=false) - defined in Backend\Classes\WidgetBase. Fire an event and call the listeners.
  • public mixed fireSystemEvent(string $event, array $params=array(), boolean $halt=true) - defined in Backend\Classes\WidgetBase. Fires a combination of local and global events. The first segment is removed.
  • public string fireViewEvent(string $event, array $params=array()) - defined in Backend\Classes\WidgetBase. Special event function used for extending within view files,
  • public void flushAssets() - defined in Backend\Classes\WidgetBase. Disables the use, and subequent broadcast, of assets. This is useful.
  • public string getAssetPath(string $fileName, string $assetPath=NULL) - defined in Backend\Classes\WidgetBase. Locates a file based on it's definition. If the file starts with.
  • public array getAssetPaths() - defined in Backend\Classes\WidgetBase. Returns an array of all registered asset paths.
  • public mixed getClassExtension(string $name) - defined in October\Rain\Extension\Extendable. Returns a behavior object from an extendable class, example:.
  • public array getClassMethods() - defined in October\Rain\Extension\Extendable. Get a list of class methods, extension equivalent of get_class_methods().
  • public string getConfig(string $name, string $default=NULL) - defined in Backend\Classes\WidgetBase. Safe accessor for configuration values.
  • public string getConfigPath(string $fileName, mixed $configPath=NULL) - defined in Backend\Classes\WidgetBase. Locates a file based on it's definition. If the file starts with.
  • public void getController() - defined in Backend\Classes\WidgetBase. Returns the controller using this widget.
  • public array getDynamicProperties() - defined in October\Rain\Extension\Extendable. Returns all dynamic properties and their values.
  • public string getEventHandler(string $name) - defined in Backend\Classes\WidgetBase. Returns a fully qualified event handler name for this widget.
  • public void getFatalError() - defined in Backend\Classes\WidgetBase. getFatalError returns error message.
  • public string getFieldName() - defined in Backend\Classes\FormWidgetBase. Returns the HTML element field name for this widget, used for capturing.
  • public void getId($suffix=NULL) - defined in Backend\Classes\FormWidgetBase. Returns a unique ID for this widget. Useful in creating HTML markup.
  • public string getLoadValue() - defined in Backend\Classes\FormWidgetBase. Returns the value for this form field,
  • public Backend\Widgets\Form|null getParentForm() - defined in Backend\Classes\FormWidgetBase. Retrieve the parent form for this formwidget.
  • public string getViewPath(string $fileName, mixed $viewPath=NULL) - defined in Backend\Classes\WidgetBase. getViewPath locates a file based on its definition. The file name can be prefixed.
  • public array getViewPaths() - defined in Backend\Classes\WidgetBase. getViewPaths returns the active view path locations.
  • public string guessConfigPath(string $suffix='') - defined in Backend\Classes\WidgetBase. Guess the package path for the called class.
  • public string guessConfigPathFrom(string $class, string $suffix='') - defined in Backend\Classes\WidgetBase. Guess the package path from a specified class.
  • public string guessViewPath(string $suffix='', bool $isPublic=false) - defined in Backend\Classes\WidgetBase. guessViewPath guesses the package path for the called class.
  • public string guessViewPathFrom(string $class, string $suffix='', bool $isPublic=false) - defined in Backend\Classes\WidgetBase. guessViewPathFrom guesses the package path from a specified class.
  • public void handleError($exception) - defined in Backend\Classes\WidgetBase. Sets standard page variables in the case of a controller error.
  • public void hasAssetsDefined() - defined in Backend\Classes\WidgetBase. hasAssetsDefined returns true if assets any have been added.
  • public boolean hasFatalError() - defined in Backend\Classes\WidgetBase. Determines whether a fatal error has been set or not.
  • public boolean isClassExtendedWith(string $name) - defined in October\Rain\Extension\Extendable. Check if extendable class is extended with a behavior object.
  • public string makeAssets(string $type=NULL) - defined in Backend\Classes\WidgetBase. Outputs <link> and <script> tags to load assets previously added with addJs and addCss method calls.
  • public object makeConfig(array $configFile=array(), array $requiredConfig=array()) - defined in Backend\Classes\WidgetBase. Reads the contents of the supplied file and applies it to this object.
  • public stdClass makeConfigFromArray(array $configArray=array()) - defined in Backend\Classes\WidgetBase. Makes a config object from an array, making the first level keys properties of a new object.
  • public string makeFileContents(string $filePath, array $extraParams=array()) - defined in Backend\Classes\WidgetBase. makeFileContents includes a file path using output buffering.
  • public Backend\Classes\FormWidgetBase makeFormWidget(string $class, mixed $fieldConfig=array(), array $widgetConfig=array()) - defined in Backend\Classes\WidgetBase. Makes a form widget object with the supplied form field and widget configuration.
  • public mixed makeLayout(string $name=NULL, array $params=array(), bool $throwException=true) - defined in Backend\Classes\WidgetBase. makeLayout renders a layout.
  • public string makeLayoutPartial(string $partial, array $params=array()) - defined in Backend\Classes\WidgetBase. makeLayoutPartial renders a layout partial.
  • public mixed makePartial(string $partial, array $params=array(), bool $throwException=true) - defined in Backend\Classes\WidgetBase. makePartial renders a partial file contents located in the views folder.
  • public string makeView(string $view) - defined in Backend\Classes\WidgetBase. makeView loads a view with the name specified. Applies layout if its name is provided.
  • public string makeViewContent(string $contents, string $layout=NULL) - defined in Backend\Classes\WidgetBase. makeViewContent renders supplied contents inside a layout.
  • public Backend\Classes\WidgetBase makeWidget(string $class, array $widgetConfig=array()) - defined in Backend\Classes\WidgetBase. Makes a widget object with the supplied configuration file.
  • public stdClass mergeConfig(mixed $configA, mixed $configB) - defined in Backend\Classes\WidgetBase. Merges two configuration sources, either prepared or not, and returns.
  • public boolean methodExists(string $name) - defined in October\Rain\Extension\Extendable. Checks if a method exists, extension equivalent of method_exists().
  • public boolean propertyExists(string $name) - defined in October\Rain\Extension\Extendable. Checks if a property exists, extension equivalent of property_exists().
  • public void resetSession() - defined in Backend\Classes\WidgetBase. Resets all session data related to this widget.
  • public self unbindEvent(string $event=NULL) - defined in Backend\Classes\WidgetBase. Destroys an event binding.

Protected methods

protected array|null getGroupFormFieldConfig(string $code)

getGroupFormFieldConfig returns the form field configuration for a group, identified by code

Parameters
  • string $code

protected void getNextIndex()

getNextIndex determines the next available index number for assigning to a new repeater item

protected void getValueFromIndex(int $index)

getValueFromIndex returns the data at a given index

Parameters
  • int $index

protected void loadAssets()

Adds widget specific asset files. Use $this->addJs() and $this->addCss() to register new assets to include on the page.

protected Backend\Widgets\Form makeItemFormWidget(int $index=0, string $index=NULL)

makeItemFormWidget creates a form widget based on a field index and optional group code

Parameters
  • int $index
  • string $index

protected void processGroupMode()

processGroupMode processes features related to group mode

protected void processItems()

processItems processes form data and applies it to the form widgets

protected array processSaveValue(array $value)

processSaveValue splices in some meta data (group and index values) to the dataset

Parameters
  • array $value

Show inherited protected methods

Inherited protected methods

  • protected void combineBundledAssets($type) - defined in Backend\Classes\WidgetBase. combineBundledAssets spins over every bundle definition and combines them to an asset.
  • protected array emitterEventSortEvents(string $eventName) - defined in Backend\Classes\WidgetBase. Sort the listeners for a given event by priority.
  • protected boolean extendableIsAccessible(mixed $class, string $propertyName) - defined in October\Rain\Extension\Extendable. Checks if a property is accessible, property equivalent of is_callable().
  • protected void extensionExtractMethods(string $extensionName, object $extensionObject) - defined in October\Rain\Extension\Extendable. Extracts the available methods from a behavior and adds it to the.
  • protected void fillFromConfig(array $properties=NULL) - defined in Backend\Classes\WidgetBase. Transfers config values stored inside the $config property directly.
  • protected string getAssetEntryBuildPath(array $asset) - defined in Backend\Classes\WidgetBase. Internal helper, attaches a build code to an asset path.
  • protected string getAssetScheme(string $asset) - defined in Backend\Classes\WidgetBase. Internal helper, get asset scheme.
  • protected void getLocalPath($relativePath) - defined in Backend\Classes\WidgetBase. getLocalPath converts a relative path to a local path.
  • protected string getSession(string $key=NULL, string $default=NULL) - defined in Backend\Classes\WidgetBase. Retrieves a widget related key/value pair from session data.
  • protected void handleViewException($e, $obLevel) - defined in Backend\Classes\WidgetBase. handleViewException handles a view exception.
  • protected string makeSessionId() - defined in Backend\Classes\WidgetBase. Returns a unique session identifier for this widget and controller action.
  • protected void putSession(string $key, string $value) - defined in Backend\Classes\WidgetBase. Saves a widget related key/value pair in to session data.
  • protected void removeDuplicates() - defined in Backend\Classes\WidgetBase. Removes duplicate assets from the entire collection.
  • protected void renderAssetAttributes($type, $asset) - defined in Backend\Classes\WidgetBase. renderAssetAttributes takes an asset definition and returns the necessary HTML output.