Cms\Components\TranslatableBag
Overview
TranslatableBag stores translated template properties for each site, including the URL.
Extends
Implements
- Larajax\Contracts\ViewComponentInterface
- October\Contracts\Twig\CallsAnyMethod
- Stringable
Public Properties
There are no public properties in the class.
Show inherited public properties
Inherited Public Properties
- $id - is a unique identifier for this component. (defined in Cms\Classes\ComponentBase)
- $name - as a class name or class alias used in the component declaration in a template. (defined in Cms\Classes\ComponentBase)
- $isHidden - determines whether the component is hidden from the backend UI. (defined in Cms\Classes\ComponentBase)
- $pluginIcon - of the plugin that defines the component. (defined in Cms\Classes\ComponentBase)
- $componentCssClass - name for the backend page/layout component list. (defined in Cms\Classes\ComponentBase)
- $inspectorEnabled - determines whether Inspector can be used with the component. (defined in Cms\Classes\ComponentBase)
- $implement - extensions for this class. (defined in October\Rain\Extension\Extendable)
- $assetPath - specifies the relative path to the asset directory. (defined in Cms\Classes\ComponentBase)
- $assetUrlPath - specifies the public path to the asset directory. (defined in Cms\Classes\ComponentBase)
- $config - supplied. (defined in Cms\Classes\ComponentBase)
- $alias - defined for this widget. (defined in Cms\Classes\ComponentBase)
- $controller - object. (defined in Cms\Classes\ComponentBase)
Protected Properties
There are no protected properties in the class.
Show inherited protected properties
Inherited Protected Properties
- $dirName - specifies the component directory name. (defined in Cms\Classes\ComponentBase)
- $page - object object. (defined in Cms\Classes\ComponentBase)
- $externalPropertyNames - is a collection of external property names used by this component. (defined in Cms\Classes\ComponentBase)
- $componentGetPathCache - (defined in Cms\Classes\ComponentBase)
- $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)
- $assets - Collection of assets to display in the layout. (defined in Cms\Classes\ComponentBase)
- $assetBundles - Collection of combined and prioritized assets. (defined in Cms\Classes\ComponentBase)
- $assetDefaults - is the default attributes for assets. (defined in Cms\Classes\ComponentBase)
- $dependencyResolver - for AJAX handlers and controller actions. (defined in Cms\Classes\ComponentBase)
- $emitterSingleEventCollection - of events to be fired once only. (defined in Cms\Classes\ComponentBase)
- $emitterEventCollection - of all registered events. (defined in Cms\Classes\ComponentBase)
- $emitterEventSorted - collection. (defined in Cms\Classes\ComponentBase)
- $properties - contains the object property values. (defined in Cms\Classes\ComponentBase)
Public Methods
public static cleanProperties()
public static cleanProperties(array $properties): array
cleanProperties drops empty values and the locale key repeated inside each item before saving.
public componentDetails()
public componentDetails(): array
public defineProperties()
public defineProperties(): array
defineProperties uses an object list keyed by locale.
public property()
public property(string $name, mixed $default = null): mixed
property accepts bracket syntax (locales[fr][url]) in addition to dot syntax (locales.fr.url).
public siteProperties()
public siteProperties(
System\Models\SiteDefinition|null $site = null
): array
siteProperties returns all translated property values for a site as a single array.
public siteProperty()
public siteProperty(
string $name,
System\Models\SiteDefinition|null $site = null,
mixed $default = null
): mixed
siteProperty returns a translated property value for a site, matched by locale with language fallback.
public validateProperties()
public validateProperties(array $properties): array
Inherited Public Methods
- __call() - dynamically handles calls into the controller instance. (defined in Cms\Classes\ComponentBase)
- __callStatic() - calls an undefined static method. (defined in October\Rain\Extension\Extendable)
- __construct() - the component, which takes in the page or layout code section object. (defined in Cms\Classes\ComponentBase)
- __get() - an undefined property. (defined in October\Rain\Extension\Extendable)
- __set() - an undefined property. (defined in October\Rain\Extension\Extendable)
- __sleep() - prepare the object for serialization. (defined in October\Rain\Extension\Extendable)
- __toString() - returns the component's alias, used by SELF. (defined in Cms\Classes\ComponentBase)
- __wakeup() - when a model is being unserialized, check if it needs to be booted. (defined in October\Rain\Extension\Extendable)
- addCss() - includes a StyleSheet asset to the asset list. (defined in Cms\Classes\ComponentBase)
- addCssBundle() - includes a CSS asset to the bundled combiner pipeline. (defined in Cms\Classes\ComponentBase)
- 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)
- addJs() - includes a JavaScript asset to the asset list. (defined in Cms\Classes\ComponentBase)
- addJsBundle() - includes a JS asset to the bundled combiner pipeline. (defined in Cms\Classes\ComponentBase)
- addRss() - adds an RSS link asset to the asset list. Call $this->makeAssets(). (defined in Cms\Classes\ComponentBase)
- asExtension() - is short hand for
getClassExtension()method, except takes the short. (defined in October\Rain\Extension\Extendable) - bindEvent() - creates a new event binding. (defined in Cms\Classes\ComponentBase)
- bindEventOnce() - creates a new event binding that fires once only. (defined in Cms\Classes\ComponentBase)
- bindToController() - (defined in Cms\Classes\ComponentBase)
- clearExtendedClasses() - (defined in October\Rain\Extension\Extendable)
- combineAssets() - runs asset paths through the Asset Combiner. (defined in Cms\Classes\ComponentBase)
- createIn() - builds a component instance against the given controller, (defined in Cms\Classes\ComponentBase)
- extend() - this class with a closure. (defined in October\Rain\Extension\Extendable)
- extendClassWith() - dynamically extends a class with a specified behavior. (defined in October\Rain\Extension\Extendable)
- 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) - fireEvent() - and call the listeners. (defined in Cms\Classes\ComponentBase)
- fireSystemEvent() - fires a combination of local and global events. The first segment is removed. (defined in Cms\Classes\ComponentBase)
- fireViewEvent() - is a special event function used for extending within view files, (defined in Cms\Classes\ComponentBase)
- flushAssets() - disables the use, and subsequent broadcast, of assets. This is useful. (defined in Cms\Classes\ComponentBase)
- getAssetPath() - locates a file based on it's definition. If the file starts with. (defined in Cms\Classes\ComponentBase)
- getAssetPaths() - returns an array of all registered asset paths. (defined in Cms\Classes\ComponentBase)
- getAssetPathsWithAttributes() - returns an array of all registered asset paths. (defined in Cms\Classes\ComponentBase)
- 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)
- getController() - returns the controller using this component. (defined in Cms\Classes\ComponentBase)
- getDynamicProperties() - returns all dynamic properties and their values. (defined in October\Rain\Extension\Extendable)
- getPath() - returns the absolute component path. (defined in Cms\Classes\ComponentModuleBase)
- getProperties() - returns all properties. (defined in Cms\Classes\ComponentBase)
- getPropertyOptions() - returns options for multi-option properties (drop-downs, etc.). (defined in Cms\Classes\ComponentBase)
- hasAssetsDefined() - returns true if assets any have been added. (defined in Cms\Classes\ComponentBase)
- implementClassWith() - will implement an extension using non-interference and should. (defined in October\Rain\Extension\Extendable)
- init() - is executed when this component is first initialized, before AJAX requests. (defined in Cms\Classes\ComponentBase)
- 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)
- make() - builds the component and binds it to the current controller. (defined in Cms\Classes\ComponentBase)
- makeAssets() - outputs
<link>and<script>tags to load assets previously added with addJs and addCss method calls. (defined in Cms\Classes\ComponentBase) - makePrimaryAccessor() - returns the PHP object variable for the Twig view layer. (defined in Cms\Classes\ComponentBase)
- methodExists() - checks if a method exists, extension equivalent of method_exists(). (defined in October\Rain\Extension\Extendable)
- onRender() - is executed when this component is rendered on a page or layout. (defined in Cms\Classes\ComponentBase)
- onRun() - is executed when this component is bound to a page or layout, part of. (defined in Cms\Classes\ComponentBase)
- paramName() - returns the external property name when the property value is a routing. (defined in Cms\Classes\ComponentBase)
- propertyExists() - checks if a property exists, extension equivalent of
property_exists(). (defined in October\Rain\Extension\Extendable) - propertyName() - returns the external property name when the property value is an external. (defined in Cms\Classes\ComponentBase)
- renderPartial() - renders a requested partial in context of this component, (defined in Cms\Classes\ComponentBase)
- runAjaxHandler() - executes the event cycle when running an AJAX handler. (defined in Cms\Classes\ComponentBase)
- runLifeCycle() - executes the life cycle for the component. (defined in Cms\Classes\ComponentBase)
- setExternalPropertyName() - sets an external property name. (defined in Cms\Classes\ComponentBase)
- setExternalPropertyNames() - sets names used by external properties. (defined in Cms\Classes\ComponentBase)
- setProperties() - for multiple values. (defined in Cms\Classes\ComponentBase)
- setProperty() - for a single value. (defined in Cms\Classes\ComponentBase)
- unbindEvent() - destroys an event binding. (defined in Cms\Classes\ComponentBase)
Protected Methods
protected listCurrentPropertyNames()
protected listCurrentPropertyNames(): array
listCurrentPropertyNames returns the current property names in bracket syntax.
protected makeLocaleDescription()
protected makeLocaleDescription(): string
makeLocaleDescription lists the available site locales as a hint.
protected makeSiteKeyChain()
protected makeSiteKeyChain(System\Models\SiteDefinition $site): array
makeSiteKeyChain returns the locale lookup keys for a site in priority order.
protected normalizePropertyName()
protected normalizePropertyName(string $name): string
normalizePropertyName converts bracket syntax to a dot path.
Show inherited protected methods
Inherited Protected Methods
- combineBundledAssets() - spins over every bundle definition and combines them to an asset. (defined in Cms\Classes\ComponentBase)
- emitterEventSortEvents() - sorts the listeners for a given event by priority. (defined in Cms\Classes\ComponentBase)
- 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)
- getAssetEntryBuildPath() - is an internal marker that returns the asset path. (defined in Cms\Classes\ComponentBase)
- getAssetScheme() - is an internal helper to get the asset scheme. (defined in Cms\Classes\ComponentBase)
- getComponentAssetRelativePath() - (defined in Cms\Classes\ComponentBase)
- getComponentAssetUrlPath() - returns the public directory for the component assets. (defined in Cms\Classes\ComponentModuleBase)
- getExtendableMethodFromDynamicMethods() - (defined in October\Rain\Extension\Extendable)
- getExtendableMethodFromExtensions() - (defined in October\Rain\Extension\Extendable)
- getLocalPath() - converts a relative path to a local path. (defined in Cms\Classes\ComponentBase)
- makeCallMethod() - will prepare method args with DI and call the method. (defined in Cms\Classes\ComponentBase)
- processAssetAttributes() - (defined in Cms\Classes\ComponentBase)
- removeDuplicateAssets() - removes duplicate and global assets from the entire collection. (defined in Cms\Classes\ComponentBase)
- renderAssetAttributes() - takes an asset definition and returns the necessary HTML output. (defined in Cms\Classes\ComponentBase)