Back to ListHelper class

Method positions

public static array
positions
(mixed $name, mixed $active = null, mixed $javascript = null, mixed $none = true, mixed $center = true, mixed $left = true, mixed $right = true, mixed $id = false)
Select list of positions - generally used for location of images
Parameters
  • string $name Name of the field
  • string $active The active value
  • string $javascript Alternative javascript
  • bool $none Null if not assigned
  • bool $center Null if not assigned
  • bool $left Null if not assigned
  • bool $right Null if not assigned
  • bool $id Null if not assigned
Returns
  • array The positions
Since
  • 1.5
Class: ListHelper
Project: Joomla

Method positions - Source code

/**
 * Select list of positions - generally used for location of images
 *
 * @param   string   $name        Name of the field
 * @param   string   $active      The active value
 * @param   string   $javascript  Alternative javascript
 * @param   boolean  $none        Null if not assigned
 * @param   boolean  $center      Null if not assigned
 * @param   boolean  $left        Null if not assigned
 * @param   boolean  $right       Null if not assigned
 * @param   boolean  $id          Null if not assigned
 *
 * @return  array  The positions
 *
 * @since   1.5
 */
public static function positions($name, $active = null, $javascript = null, $none = true, $center = true, $left = true, $right = true, $id = false)
{
    $pos = array();
    if ($none) {
        $pos[''] = Text::_('JNONE');
    }
    if ($center) {
        $pos['center'] = Text::_('JGLOBAL_CENTER');
    }
    if ($left) {
        $pos['left'] = Text::_('JGLOBAL_LEFT');
    }
    if ($right) {
        $pos['right'] = Text::_('JGLOBAL_RIGHT');
    }
    $positions = HTMLHelper::_('select.genericlist', $pos, $name, array('id' => $id, 'list.attr' => 'size="1"' . $javascript, 'list.select' => $active, 'option.key' => null));
    return $positions;
}