| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
Joomla! Content Management System
| Copyright: | (C) 2005 Open Source Matters, Inc. |
| License: | GNU General Public License version 2 or later; see LICENSE.txt |
| File Size: | 1220 lines (46 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| extract($key) X-Ref |
| Method to extract a key param: string $key The name of helper method to load, (prefix).(class).function return: array Contains lowercase key, prefix, file, function. |
| _(string $key, ...$methodArgs) X-Ref |
| Class loader method Additional arguments may be supplied and are passed to the sub-class. Additional include paths are also able to be specified for third-party use param: string $key The name of helper method to load, (prefix).(class).function param: array $methodArgs The arguments to pass forward to the method being called return: mixed Result of HTMLHelper::call($function, $args) |
| register($key, callable $function) X-Ref |
| Registers a function to be called with a specific key param: string $key The name of the key param: callable $function Function or method return: boolean True if the function is callable |
| unregister($key) X-Ref |
| Removes a key for a method from registry. param: string $key The name of the key return: boolean True if a set key is unset |
| isRegistered($key) X-Ref |
| Test if the key is registered. param: string $key The name of the key return: boolean True if the key is registered. |
| getServiceRegistry() X-Ref |
| Retrieves the service registry. return: Registry |
| call(callable $function, $args) X-Ref |
| Function caller method param: callable $function Function or method to call param: array $args Arguments to be passed to function return: mixed Function result or false on error. |
| link($url, $text, $attribs = null) X-Ref |
| Write a `<a>` element param: string $url The relative URL to use for the href attribute param: string $text The target attribute to use param: array|string $attribs Attributes to be added to the `<a>` element return: string |
| iframe($url, $name, $attribs = null, $noFrames = '') X-Ref |
| Write a `<iframe>` element param: string $url The relative URL to use for the src attribute. param: string $name The target attribute to use. param: array|string $attribs Attributes to be added to the `<iframe>` element param: string $noFrames The message to display if the iframe tag is not supported. return: string |
| includeRelativeFiles($folder, $file, $relative, $detectBrowser, $detectDebug) X-Ref |
| Compute the files to be included param: string $folder Folder name to search in (i.e. images, css, js). param: string $file Path to file. param: boolean $relative Flag if the path to the file is relative to the /media folder (and searches in template). param: boolean $detectBrowser Flag if the browser should be detected to include specific browser files. param: boolean $detectDebug Flag if debug mode is enabled to include uncompressed files if debug is on. return: array files to be included. |
| cleanImageURL($url) X-Ref |
| Gets a URL, cleans the Joomla specific params and returns an object param: string $url The relative or absolute URL to use for the src attribute. return: object |
| image($file, $alt, $attribs = null, $relative = false, $returnPath = 0) X-Ref |
| Write a `<img>` element param: string $file The relative or absolute URL to use for the src attribute. param: string $alt The alt text. param: array|string $attribs Attributes to be added to the `<img>` element param: boolean $relative Flag if the path to the file is relative to the /media folder (and searches in template). param: integer $returnPath Defines the return value for the method: return: string|null HTML markup for the image, relative path to the image, or null if path is to be returned but image is not found |
| stylesheet($file, $options = array() X-Ref |
| Write a `<link>` element to load a CSS file param: string $file Path to file param: array $options Array of options. Example: array('version' => 'auto', 'conditional' => 'lt IE 9') param: array $attribs Array of attributes. Example: array('id' => 'scriptid', 'async' => 'async', 'data-test' => 1) return: array|string|null nothing if $returnPath is false, null, path or array of path if specific CSS browser files were detected |
| script($file, $options = array() X-Ref |
| Write a `<script>` element to load a JavaScript file param: string $file Path to file. param: array $options Array of options. Example: array('version' => 'auto', 'conditional' => 'lt IE 9') param: array $attribs Array of attributes. Example: array('id' => 'scriptid', 'async' => 'async', 'data-test' => 1) return: array|string|null Nothing if $returnPath is false, null, path or array of path if specific JavaScript browser files were detected |
| setFormatOptions($options) X-Ref |
| Set format related options. Updates the formatOptions array with all valid values in the passed array. param: array $options Option key/value pairs. return: void |
| date($input = 'now', $format = null, $tz = true, $gregorian = false) X-Ref |
| Returns formatted date according to a given format and time zone. param: string $input String in a format accepted by date(), defaults to "now". param: string $format The date format specification string (see {@link PHP_MANUAL#date}). param: mixed $tz Time zone to be used for the date. Special cases: boolean true for user param: boolean $gregorian True to use Gregorian calendar. return: string A date translated by the given format and time zone. |
| tooltip($tooltip, $title = '', $image = 'tooltip.png', $text = '', $href = '', $alt = 'Tooltip', $class = 'hasTooltip') X-Ref |
| Creates a tooltip with an image as button param: string $tooltip The tip string. param: mixed $title The title of the tooltip or an associative array with keys contained in param: string $image The image for the tip, if no text is provided. param: string $text The text for the tip. param: string $href A URL that will be used to create the link. param: string $alt The alt attribute for img tag. param: string $class CSS class for the tool tip. return: string |
| tooltipText($title = '', $content = '', $translate = true, $escape = true) X-Ref |
| Converts a double colon separated string or 2 separate strings to a string ready for bootstrap tooltips param: string $title The title of the tooltip (or combined '::' separated string). param: string $content The content to tooltip. param: boolean $translate If true will pass texts through Text. param: boolean $escape If true will pass texts through htmlspecialchars. return: string The tooltip string |
| calendar($value, $name, $id, $format = '%Y-%m-%d', $attribs = array() X-Ref |
| Displays a calendar control field param: string $value The date value param: string $name The name of the text field param: string $id The id of the text field param: string $format The date format param: mixed $attribs Additional HTML attributes return: string HTML markup for a calendar field |
| addIncludePath($path = '') X-Ref |
| Add a directory where HTMLHelper should search for helpers. You may either pass a string or an array of directories. param: string $path A path to search. return: array An array with directory elements |
| addFileToBuffer($path = '', $ext = '', $debugMode = false) X-Ref |
| Method that searches if file exists in given path and returns the relative path. If a minified version exists it will be preferred. param: string $path The actual path of the file param: string $ext The extension of the file param: boolean $debugMode Signifies if debug is enabled return: string The relative path of the file |
| convertToRelativePath($path) X-Ref |
| Method that takes a file path and converts it to a relative path param: string $path The actual path of the file return: string The relative path of the file |
| checkFileOrder($first, $second) X-Ref |
| Method that takes two paths and checks if the files exist with different order param: string $first the path of the minified file param: string $second the path of the non minified file return: string |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |