1. Documentation
  2. API
  3. Library
  4. Element
  5. ElementBase

October\Rain\Element\ElementBase

Overview

ElementBase class for all elements

Extends
Implements
  • Illuminate\Contracts\Support\Arrayable
  • ArrayAccess
  • Illuminate\Contracts\Support\Jsonable
  • JsonSerializable

Public Properties

public array $config

config values for this instance

Show inherited public properties

Inherited Public Properties

Protected Properties

There are no protected properties in the class.

Show inherited protected properties

Inherited Protected Properties

Public Methods

public __call()

public __call(string $method, array $parameters): $this

__call handles dynamic calls to the element instance to set config.

public __construct()

public __construct($config = []): void

public __get()

public __get(string $key): mixed

__get dynamically retrieves the value of an attribute.

public __isset()

public __isset(string $key): bool

__isset dynamically checks if an attribute is set.

public __set()

public __set(string $key, mixed $value): void

__set dynamically sets the value of an attribute.

public __unset()

public __unset(string $key): void

__unset dynamically unsets an attribute.

public evalConfig()

public evalConfig($config): void

evalConfig override method

public get()

public get(string $key, $default = null): void

get an attribute from the element instance.

public getConfig()

public getConfig($key = null, $default = null): void

getConfig returns the entire config array

public jsonSerialize()

public jsonSerialize(): array

jsonSerialize converts the object into something JSON serializable.

public offsetExists()

public offsetExists(string $offset): bool

offsetExists determines if the given offset exists.

public offsetGet()

public offsetGet(string $offset): mixed

offsetGet gets the value for a given offset.

public offsetSet()

public offsetSet(string $offset, mixed $value): void

offsetSet sets the value at the given offset.

public offsetUnset()

public offsetUnset(string $offset): void

offsetUnset unsets the value at the given offset.

public toArray()

public toArray(): array

toArray converts the element instance to an array.

public toJson()

public toJson(int $options = 0): string

toJson converts the element instance to JSON.

public useConfig()

public useConfig($config): October\Rain\Element\ElementBase

useConfig is used internally

Show inherited public methods

Inherited Public Methods

Protected Methods

protected initDefaultValues()

protected initDefaultValues(): void

initDefaultValues override method

Show inherited protected methods

Inherited Protected Methods