DraggableList provides a simple user interface for sorting a list of items. More...

Public Member Functions
	__construct ($items, $id="draggable_list", $format=null, $handler=null)

	enableDragReorder ($handler)

	writeScript ()

	drawList ()

Public Attributes
	$items

	$id

	$format

	$listTag = "ul"
	The HTML list tag type. More...

	$CSSclass = null
	CSS class(es) to be applied to the list. More...

	$styles = null
	Specific CSS styles to be applied to the list. More...

	$emptyList = "No items in the list"
	Message to display when the list is empty. More...

	$reorderHandler = null
	Handler script that implements reordering records. More...

	$dragText = ""
	Optional text to display above reorderable table. More...

Detailed Description

DraggableList provides a simple user interface for sorting a list of items.

Users can click and drag items within the list. Sorting is updated on the server via a sort handler that must be able to parse pairs of primary keys and sort order values.

Author: andy

Definition at line 46 of file draggable_list.inc.

Constructor & Destructor Documentation

◆ __construct()

DraggableList::__construct	(	$items,
		$id = `"draggable_list"`,
		$format = `null`,
		$handler = `null`
	)

Definition at line 59 of file draggable_list.inc.

      {
           $this->items = $items;
           $this->id = $id;
           $this->format = $format;
           $this->reorderHandler = $handler;
      }

Member Function Documentation

◆ drawList()

DraggableList::drawList ( )

Definition at line 88 of file draggable_list.inc.

      {
           if (!count($this->items))
           {
                echo "<p>{$this->emptyList}</p>";
                return;
           }
  
           $attrs = "";
           if ($this->CSSclass) 
           {
                $attrs .= " class='draggable {$this->CSSclass}'";
           }
           else
           {
                $attrs .= " class='draggable'";
           }
           
           if ($this->styles) $attrs .= " style='{$this->styles}'";         
 ?>
  
           <? echo $this->dragText;?>
           <<?echo $this->listTag?> id="<?echo $this->id?>"<?echo $attrs?>>
 <?
           foreach($this->items as $item)
           {
                $pkTag = " data-pk='".$item->getPrimaryKeyValue()."'"; 
                
                echo "<li{$pkTag}>";
                
                if (is_callable($this->format))
                {
                     echo call_user_func($this->format, $item);
                }
                else echo $item->format($this->format);
                
                echo "</li>\n";
           }
           echo "</{$this->listTag}>\n";
      }

◆ enableDragReorder()

DraggableList::enableDragReorder ( $handler )

Definition at line 67 of file draggable_list.inc.

      {
           $this->reorderHandler = $handler;
      }

◆ writeScript()

DraggableList::writeScript ( )

Definition at line 72 of file draggable_list.inc.

      {
           if (!count($this->items)) return;
           $pk = $this->items[0]->getPrimaryKey();
           
           $script = <<<ENDSCRIPT
 <script type='text/javascript'>
 window.addEvent('domready', function()
 {
      new DraggableList('{$this->id}', '{$this->reorderHandler}', '{$pk}');
 });
 </script>
 ENDSCRIPT;
           return $script;
      }

Member Data Documentation

◆ $CSSclass

DraggableList::$CSSclass = null

CSS class(es) to be applied to the list.

Definition at line 52 of file draggable_list.inc.

◆ $dragText

DraggableList::$dragText = ""

Optional text to display above reorderable table.

Definition at line 57 of file draggable_list.inc.

◆ $emptyList

DraggableList::$emptyList = "No items in the list"

Message to display when the list is empty.

Definition at line 54 of file draggable_list.inc.

◆ $format

DraggableList::$format

Definition at line 50 of file draggable_list.inc.

◆ $id

DraggableList::$id

Definition at line 49 of file draggable_list.inc.

◆ $items

DraggableList::$items

Definition at line 48 of file draggable_list.inc.

◆ $listTag

DraggableList::$listTag = "ul"

The HTML list tag type.

Definition at line 51 of file draggable_list.inc.

◆ $reorderHandler

DraggableList::$reorderHandler = null

Handler script that implements reordering records.

Definition at line 56 of file draggable_list.inc.

◆ $styles

DraggableList::$styles = null

Specific CSS styles to be applied to the list.

Definition at line 53 of file draggable_list.inc.

The documentation for this class was generated from the following file:

C:/code/cms.sonjara.com/framework/draggable_list.inc

Public Member Functions

Public Attributes