UI
class UI
Class UI
Traits
Trait ObjectManager XELOS Framework
Constants
JQUERY_NOCONFLICT_SCRIPT |
Used in get_js_files_base_files to start jQuery in noConflict mode
meaning Prototype can use $. |
Properties
protected array | $object_cache | Each object created by a success call of |
from ObjectManager |
protected array[] | $registry | The instantiation of a requested object can be processed only if the class of the object is registered with the class name as key and its information as array in this property. The element should have at least the class name or the relative path to "class" folder. |
from ObjectManager |
protected string | $lib_class_dir | This property contains the path to the folder served as root for all requested classes. This folder can contains other folder or classes. All requested and registered classes will be searched in this folder by concating this path with the relative path defined in the registration of the requested class. If the class is not included it will be done on the fly. |
from ObjectManager |
protected string | $lib_class_prefix | An optional possibility to pretend a prefix for all registered classes. |
from ObjectManager |
protected string | $ns_class_prefix | An optional possibility to pretend a namespace prefix for classes have no namespace yet. |
from ObjectManager |
protected bool | $factory_mode | This property effects the object cache. By default it is set to false to enable the object cache for all requested objects. If this property is set true, the object cache will be disabled. |
from ObjectManager |
protected array | $injection_objects | This is an assoc array and contains objects that will be injected into each requested object. Each containing object will be injected by the name of the key. E.g. ['mod' => $object] this would inject the property named mod with the value of $object. |
from ObjectManager |
protected bool | $auto_init | This property controls if the init method of requested objects is called by this trait or not. |
from ObjectManager |
bool | $use_js | ||
array | $flash_messages | ||
protected array | $js_blocks | ||
protected array | $js_files | ||
protected array | $associated_content | ||
protected array | $css_files | ||
protected array | $css_files_meta | ||
protected array | $admin_links | ||
protected array | $admin_link_instances | ||
protected array | $primary_admin_links | ||
protected array | $template_links | ||
protected array | $feed_links | ||
static array | $used_uids | ||
Html | $html |
Methods
UI constructor.
No description
Shows passed instance's admin links as additional links in admin bar
No description
No description
No description
No description
No description
No description
Stores the passed message as admin message until the message expires or is marked read
Is being triggered before the page get's redirected
No description
No description
Converts a ressourc web path to the local hdd path
Stores the passed message as flash message until the next page call
Get the CSP Nonce to secure JS/CSS Blocks https://content-security-policy.com/nonce/
Returns the Classname from a given Namespace.
Builds a css class for the given Namespace like [vendor]-[module]-[name] e.g.: blueend-ui-carousel
No description
This method will return an object without killing the whole process by triggering a fatal error You can use this method if its possible that the object is not available, e.g. due to user configurations
Get Inline Script Tag with CSP Nonce and Subresource Integrity Attribute
No description
Returns all available Adminbar Options as JSON Object
Returns array of admin messages
Get Associated Content (for SPDY Push)
No description
No description
No description
Returns a pre-rendered flash message output and clears messages from flash list
Returns array of flash messages
No description
No description
No description
No description
Get JS Files
No description
Return last JS Block and remove from array
Get LESS variable files
No description
No description
No description
Initilized before VIEW execution with Event Trigger, Restore session values
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
Resets all internal counters (e.g. DOM ID references)
Set Associated Content (for SPDY Push)
Add given objects to injection object list that will be inject into object by magic call. The array should consists of property name as key and object as value.
No description
trait constructor This method have to be called from constructor of each class that uses this trait.
Details
at line 83
Carousel
Carousel()
No description
in
ObjectManager at line 249
mixed
__call($class, $args)
Magic method.
Returns the requested object. If the object is not cached, it will be instantiated with given arguments.
This method calls xf_trait::get_object
.
at line 132
__construct()
UI constructor.
in
ObjectManager at line 231
mixed
__get($class)
Magic method.
First it checks if the requested property is defined and returns it if null. If not defined of null, it calls
xf_trait::get_object
and returns its return value.
in
ObjectManager at line 199
bool
__isset($property)
Magic method.
This method checks whether the property is defined or injected by __set
. If not
injected or defined, it will check the registry for an entry of requested property.
in
ObjectManager at line 219
__set($name, $value)
Magic method.
Sets the given value by $name
at line 1071
void
add_admin_link($link_params)
No description
at line 1082
add_admin_link_for_instance($instance_id)
Shows passed instance's admin links as additional links in admin bar
at line 270
void
add_css_file(string $file, string $position = 'bottom', string $media = null, string $if_condition = null)
No description
at line 1059
void
add_feed_link($params = array(), Core $mod = null)
No description
at line 419
add_i18n_js()
No description
at line 432
void
add_js_block(string $js)
No description
at line 327
void
add_js_file(string $file, string $position = 'bottom')
No description
at line 1086
add_primary_admin_link($link_params)
No description
at line 1098
void
add_template_link(string $templatefile, $custom)
No description
at line 197
admin_message(string $message, string $type = 'note', bool|int $expires_at = false, bool $uid = false)
Stores the passed message as admin message until the message expires or is marked read
at line 83
Amchart
amchart(mixed $link_id)
No description
at line 160
catch_before_redirect()
Is being triggered before the page get's redirected
at line 537
clear_css_files()
No description
at line 540
clear_js_files()
No description
at line 956
string
convert_www_to_hdd_path(string $web_path)
Converts a ressourc web path to the local hdd path
at line 170
flash_message(string $message, string $type = 'note')
Stores the passed message as flash message until the next page call
at line 1892
string
getCSPNonce()
Get the CSP Nonce to secure JS/CSS Blocks https://content-security-policy.com/nonce/
at line 1785
string
getClassShortForNs(string $ns)
Returns the Classname from a given Namespace.
XELOS\Framework\Module\UI -> ui \Something\Else -> else \Something\Completely\Different\ -> different xui_carousel -> xui_carousel
at line 1809
string
getCssClassForNs(string $ns, bool $legacy = false)
Builds a css class for the given Namespace like [vendor]-[module]-[name] e.g.: blueend-ui-carousel
at line 1797
getCssClassForObject($object, $legacy = false)
No description
in
ObjectManager at line 266
object|null
getObjectIfAvailable(string $class)
This method will return an object without killing the whole process by triggering a fatal error You can use this method if its possible that the object is not available, e.g. due to user configurations
at line 1881
string
getSecureInlineScriptTag($content)
Get Inline Script Tag with CSP Nonce and Subresource Integrity Attribute
at line 1129
get_admin_bar()
No description
at line 1447
get_admin_bar_config()
Returns all available Adminbar Options as JSON Object
at line 214
array
get_admin_messages($clear_id = false)
Returns array of admin messages
at line 549
array|bool
get_associated_content()
Get Associated Content (for SPDY Push)
at line 461
array
get_css_files(bool $convert_less = false)
No description
at line 487
string
get_css_files_meta()
No description
at line 1016
string
get_feed_links_meta()
No description
at line 239
get_flash_message_html()
Returns a pre-rendered flash message output and clears messages from flash list
at line 183
array
get_flash_messages(bool $clear = true)
Returns array of flash messages
at line 1581
string
get_js_blocks(bool $clear = true)
No description
at line 1550
get_js_blocks_raw($clear = true)
No description
at line 449
array
get_js_files()
No description
at line 752
string
get_js_files_base()
No description