root/cleversvg/trunk/elements/csGroup.class.php

<?php
/**
 * SVG Group class
 *
 * @author     Nicolas Perriault <nperriault@gmail.com>
 * @package    cleversvg
 * @subpackage elements
 */
class csGroup extends csElementsContainer
{

  /**
   * Definitions and elements container
   * @var csElementsContainer
   */
  protected $container = null;

  /**
   * SVG XML node name
   * @var string
   */
  protected $xml_node_name = 'g';

  /**
   * Class constructor
   *
   * @param  mixed  $id     The DOM id of the element
   * @param  array  $attrs  More attributes to affect
   */
  public function __construct($id = null, $attrs = array())
  {
    $this->setId($id);
    $this->attributes = array_merge($attrs, $this->attributes);
    $this->container = new csElementsContainer();
  }

  /**
   * Computes DOMXML Node
   *
   * @param  boolean  $embedded  Is SVG element embedded ?
   * @return DOMElement
   */
  public function compile($embedded = false)
  {
    $group_node = parent::compile($embedded);
    $dom = $this->getDomDocument();

    # Prefix
    $prefix = $embedded === true ? 'svg:' : '';

    // Add elements to current group node
    foreach ($this->getElements() as $element)
    {
      $node_element = $dom->importNode($element->compile($embedded), true);
      $group_node->appendChild($node_element);
    }

    // Add used definitions
    foreach ($this->used_definitions as $used_definition)
    {
      $element    = $used_definition[0];
      if (!$element instanceof csBaseElement)
      {
        throw new csException('A definition must be a csBaseElement');
      }
      $attributes = $used_definition[1];
      $use_node   = $dom->createElement($prefix.'use');
      $use_node->setAttribute('xlink:href', '#'.$element->getId());
      foreach ($attributes as $attr_name => $attr_value)
      {
        $use_node->setAttribute($attr_name, $attr_value);
      }
      $group_node->appendChild($use_node);
    }

    return $group_node;
  }

  /**
   * Adds a SVG shape or group to current SVG Document at a certain depth
   *
   * @param  mixed    $element  SVG element to add
   * @throws csException
   */
  public function addElement($element)
  {
    return $this->container->addElement($element);
  }

  /**
   * Retrieve an contained element instance by its DOM id
   *
   * @param  string  $id
   * @return csBaseElement
   * @throw  csException
   */
  public function getElementById($id)
  {
    return $this->container->getElementById($id);
  }

  /**
   * Returns an array containing current group elements
   *
   * @return array
   */
  public function getElements()
  {
    return $this->container->getElements();
  }

  /**
   * Checks if a DOM id already exists in current SVG Document
   *
   * @param  string  $id
   * @return boolean
   */
  public function hasId($id)
  {
    return $this->container->hasId($id);
  }

  /**
   * Uses a definition in current group
   *
   * @param  mixed  $element
   * @param  array  $attrs    More atributes to add to &lt;use/&gt; tag
   */
  public function useDefinition($definition, $attrs = array())
  {
    return $this->container->useDefinition($definition, $attrs);
  }

}