Back to JGrid class

Method checkedout

public static string
checkedout
(mixed $i, mixed $editorName, mixed $time, mixed $prefix = '', mixed $enabled = false, mixed $checkbox = 'cb', mixed $formId = null)
Returns a checked-out icon
Parameters
  • int $i The row index.
  • string $editorName The name of the editor.
  • string $time The time that the object was checked out.
  • string|array $prefix An optional task prefix or an array of options
  • bool $enabled True to enable the action.
  • string $checkbox An optional prefix for checkboxes.
  • string $formId An optional form selector.
Returns
  • string The HTML markup
Since
  • 1.6
Class: JGrid
Project: Joomla

Method checkedout - Source code

/**
 * Returns a checked-out icon
 *
 * @param   integer       $i           The row index.
 * @param   string        $editorName  The name of the editor.
 * @param   string        $time        The time that the object was checked out.
 * @param   string|array  $prefix      An optional task prefix or an array of options
 * @param   boolean       $enabled     True to enable the action.
 * @param   string        $checkbox    An optional prefix for checkboxes.
 * @param   string        $formId      An optional form selector.
 *
 * @return  string  The HTML markup
 *
 * @since   1.6
 */
public static function checkedout($i, $editorName, $time, $prefix = '', $enabled = false, $checkbox = 'cb', $formId = null)
{
    if (is_array($prefix)) {
        $options = $prefix;
        $enabled = array_key_exists('enabled', $options) ? $options['enabled'] : $enabled;
        $checkbox = array_key_exists('checkbox', $options) ? $options['checkbox'] : $checkbox;
        $prefix = array_key_exists('prefix', $options) ? $options['prefix'] : '';
    }
    $text = $editorName . '<br>' . HTMLHelper::_('date', $time, Text::_('DATE_FORMAT_LC')) . '<br>' . HTMLHelper::_('date', $time, 'H:i');
    $activeTitle = HTMLHelper::_('tooltipText', Text::_('JLIB_HTML_CHECKIN'), $text, 0);
    $inactiveTitle = HTMLHelper::_('tooltipText', Text::_('JLIB_HTML_CHECKED_OUT'), $text, 0);
    return static::action($i, 'checkin', $prefix, html_entity_decode($activeTitle, ENT_QUOTES, 'UTF-8'), html_entity_decode($inactiveTitle, ENT_QUOTES, 'UTF-8'), true, 'checkedout', 'checkedout', $enabled, false, $checkbox, $formId);
}