1. Documentation
  2. API
  3. Cms
  4. Components
  5. UnknownComponent

Cms\Components\UnknownComponent

Extends:

Public properties

There are no public properties in the class.

Show inherited public properties

Inherited public properties

Protected properties

protected string $errorMessage

Error message that is shown with this error component.

Show inherited protected properties

Inherited protected properties

Public methods

public void __construct($cmsObject, $properties, $errorMessage)

Component constructor. Takes in the page or layout code section object and properties set by the page or layout.

Parameters
  • $cmsObject
  • $properties
  • $errorMessage

public array componentDetails()

componentDetails returns information about this component, including name and description

Show inherited public methods

Inherited public methods

  • public mixed __call(string $method, array $parameters) - defined in Cms\Classes\ComponentBase. Dynamically handle calls into the controller instance.
  • public static void __callStatic($name, $params) - defined in October\Rain\Extension\Extendable.
  • public void __get($name) - defined in October\Rain\Extension\Extendable.
  • public void __set($name, $value) - defined in October\Rain\Extension\Extendable.
  • public void __toString() - defined in Cms\Classes\ComponentBase. Returns the component's alias, used by SELF.
  • public void addCss($name, $attributes=array()) - defined in Cms\Classes\ComponentBase. addCss includes a StyleSheet asset to the asset list.
  • public void addCssBundle($name, $attributes=array()) - defined in Cms\Classes\ComponentBase. 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 Cms\Classes\ComponentBase. addJs includes a JavaScript asset to the asset list.
  • public void addJsBundle($name, $attributes=array()) - defined in Cms\Classes\ComponentBase. addJsBundle includes a JS asset to the bundled combiner stream.
  • public void addRss($name, $attributes=array()) - defined in Cms\Classes\ComponentBase. addRss adds an RSS link asset to the asset list. Call $this->makeAssets().
  • 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 Cms\Classes\ComponentBase. Create a new event binding.
  • public self bindEventOnce($event, $callback) - defined in Cms\Classes\ComponentBase. Create a new event binding that fires once only.
  • 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 Cms\Classes\ComponentBase. combineAssets runs asset paths through the Asset Combiner.
  • public void defineProperties() - defined in Cms\Classes\ComponentBase. Defines the properties used by this class.
  • 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 Cms\Classes\ComponentBase. Fire an event and call the listeners.
  • public mixed fireSystemEvent(string $event, array $params=array(), boolean $halt=true) - defined in Cms\Classes\ComponentBase. Fires a combination of local and global events. The first segment is removed.
  • public string fireViewEvent(string $event, array $params=array()) - defined in Cms\Classes\ComponentBase. Special event function used for extending within view files,
  • public void flushAssets() - defined in Cms\Classes\ComponentBase. Disables the use, and subequent broadcast, of assets. This is useful.
  • public string getAssetPath(string $fileName, string $assetPath=NULL) - defined in Cms\Classes\ComponentBase. Locates a file based on it's definition. If the file starts with.
  • public array getAssetPaths() - defined in Cms\Classes\ComponentBase. 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 array getDynamicProperties() - defined in October\Rain\Extension\Extendable. Returns all dynamic properties and their values.
  • public void getPath() - defined in Cms\Classes\ComponentBase. getPath returns the absolute component path.
  • public array getProperties() - defined in Cms\Classes\ComponentBase. Returns all properties.
  • public array getPropertyOptions(string $property) - defined in Cms\Classes\ComponentBase. Returns options for multi-option properties (drop-downs, etc.).
  • public void hasAssetsDefined() - defined in Cms\Classes\ComponentBase. hasAssetsDefined returns true if assets any have been added.
  • public void init() - defined in Cms\Classes\ComponentBase. Executed when this component is first initialized, before AJAX requests.
  • 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 Cms\Classes\ComponentBase. Outputs <link> and <script> tags to load assets previously added with addJs and addCss method calls.
  • public boolean methodExists(string $name) - defined in October\Rain\Extension\Extendable. Checks if a method exists, extension equivalent of method_exists().
  • public void onRender() - defined in Cms\Classes\ComponentBase. Executed when this component is rendered on a page or layout.
  • public void onRun() - defined in Cms\Classes\ComponentBase. Executed when this component is bound to a page or layout, part of.
  • public string paramName(string $name, mixed $default=NULL) - defined in Cms\Classes\ComponentBase. Returns the external property name when the property value is a routing parameter reference.
  • public string property(string $name, string $default=NULL) - defined in Cms\Classes\ComponentBase. Returns a defined property value or default if one is not set.
  • public boolean propertyExists(string $name) - defined in October\Rain\Extension\Extendable. Checks if a property exists, extension equivalent of property_exists().
  • public string propertyName(string $name, mixed $default=NULL) - defined in Cms\Classes\ComponentBase. Returns the external property name when the property value is an external property reference.
  • public void renderPartial() - defined in Cms\Classes\ComponentBase. Renders a requested partial in context of this component,
  • public boolean runAjaxHandler($handler) - defined in Cms\Classes\ComponentBase. Executes the event cycle when running an AJAX handler.
  • public string setExternalPropertyName(string $name, string $extName) - defined in Cms\Classes\ComponentBase. Sets an external property name.
  • public void setExternalPropertyNames(array $names) - defined in Cms\Classes\ComponentBase. Sets names used by external properties.
  • public void setProperties(array $properties) - defined in Cms\Classes\ComponentBase. Sets multiple properties.
  • public void setProperty(string $name, mixed $value) - defined in Cms\Classes\ComponentBase. Sets a property value.
  • public self unbindEvent(string $event=NULL) - defined in Cms\Classes\ComponentBase. Destroys an event binding.
  • public array validateProperties(array $properties) - defined in Cms\Classes\ComponentBase. Validates the properties against the defined properties of the class.

Protected methods

Show inherited protected methods

Inherited protected methods

  • protected void combineBundledAssets($type) - defined in Cms\Classes\ComponentBase. combineBundledAssets spins over every bundle definition and combines them to an asset.
  • protected array emitterEventSortEvents(string $eventName) - defined in Cms\Classes\ComponentBase. 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 string getAssetEntryBuildPath(array $asset) - defined in Cms\Classes\ComponentBase. Internal helper, attaches a build code to an asset path.
  • protected string getAssetScheme(string $asset) - defined in Cms\Classes\ComponentBase. Internal helper, get asset scheme.
  • protected void getComponentAssetPath() - defined in Cms\Classes\ComponentBase. getComponentAssetPath returns the public directory for the component assets.
  • protected void getLocalPath($relativePath) - defined in Cms\Classes\ComponentBase. getLocalPath converts a relative path to a local path.
  • protected void removeDuplicates() - defined in Cms\Classes\ComponentBase. Removes duplicate assets from the entire collection.
  • protected void renderAssetAttributes($type, $asset) - defined in Cms\Classes\ComponentBase. renderAssetAttributes takes an asset definition and returns the necessary HTML output.