ImageGrid Class Reference

Inherits FacetFilterable.

Public Member Functions
	__construct ($id, $size=200, $puff=true, $useBackgroundImages=false)
	getID ()
	addItem ($image_id, $title, $text, $onclick="return false;")
	addFacetTaggingHandler ($handler)
	Adds a row tagging handler. More...
	writeScript ()
	drawView ()

Public Attributes
	$id
	$items
	$size
	$tagItemCallbacks = array()
	$puff
	$useBackgroundImages = false
	$retinaMode = false
	$cssClass = null
	$inlineSizing = true

Detailed Description

Definition at line 60 of file image_grid.inc.

Constructor & Destructor Documentation

__construct()

ImageGrid::__construct	(		$id,
			$size = 200,
			$puff = true,
			$useBackgroundImages = false
	)

Definition at line 72 of file image_grid.inc.

     {
          $this->id = $id;
          $this->items = array();
          $this->size = $size;
          $this->puff = $puff;
          $this->useBackgroundImages = $useBackgroundImages;
          $this->retinaMode = Settings::getValue("image", "retina_mode");
     }

Member Function Documentation

addFacetTaggingHandler()

ImageGrid::addFacetTaggingHandler

(

$handler

)

Adds a row tagging handler.

This function will receive the data item for each row and can add custom attributes to the row tag.

Definition at line 98 of file image_grid.inc.

     {
          $this->tagItemCallbacks[] = $handler;
     }

addItem()

ImageGrid::addItem	(		$image_id,
			$title,
			$text,
			$onclick = "return false;"
	)

Definition at line 87 of file image_grid.inc.

     {
          $item = new ImageGridItem($this, $image_id, $title, $text, $onclick);
          $this->items[] = $item;
          return $item;
     }

drawView()

ImageGrid::drawView

(

)

Definition at line 122 of file image_grid.inc.

     {
          $cssClass = $this->cssClass ? "image_grid {$this->cssClass}" : "image_grid";
?>
          <ul id="<?echo $this->id?>" class='<?echo $cssClass?>'>
<?
          foreach($this->items as $item)
          {
               $attrs = array();
               
               foreach($this->tagItemCallbacks as $handler)
               {
                    $attrs = call_user_func($handler, $item->item, $attrs);
               }
                
               $item->draw($this->size, $attrs);
          }
?>
          </ul>          
<?
     }

getID()

ImageGrid::getID

(

)

Definition at line 82 of file image_grid.inc.

     {
          return $this->id;
     }

writeScript()

ImageGrid::writeScript

(

)

Definition at line 104 of file image_grid.inc.

     {
          ob_start();
          
          $puff = $this->puff ? 'true' : 'false';
?>
<script type="text/javascript">
window.addEvent('domready', function() 
{
     new ImageGrid('<?echo $this->id?>', <?echo $this->size?>, {puff: <?echo $puff?>});
});
</script>
<?
          $script = ob_get_contents();
          ob_end_clean();
          return $script;
     }

Member Data Documentation

$cssClass

ImageGrid::$cssClass = null

Definition at line 69 of file image_grid.inc.

$id

ImageGrid::$id

Definition at line 62 of file image_grid.inc.

$inlineSizing

ImageGrid::$inlineSizing = true

Definition at line 70 of file image_grid.inc.

$items

ImageGrid::$items

Definition at line 63 of file image_grid.inc.

$puff

ImageGrid::$puff

Definition at line 66 of file image_grid.inc.

$retinaMode

ImageGrid::$retinaMode = false

Definition at line 68 of file image_grid.inc.

$size

ImageGrid::$size

Definition at line 64 of file image_grid.inc.

$tagItemCallbacks

ImageGrid::$tagItemCallbacks = array()

Definition at line 65 of file image_grid.inc.

$useBackgroundImages

ImageGrid::$useBackgroundImages = false

Definition at line 67 of file image_grid.inc.

---

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

• C:/code/cms.sonjara.com/cms/components/image/image_grid.inc