Changeset 336 for cleversvg/trunk/document/csDocument.class.php

Timestamp:

03/07/08 08:33:04 (4 years ago)

Author:

nperriault

Message:

Clever Svg:

• refs #40: more elements tests
• Removed depth management, as svg handle it natively

Warning: breaks BC from 0.5.

Files:

• cleversvg/trunk/document/csDocument.class.php (modified) (29 diffs)

cleversvg/trunk/document/csDocument.class.php

@@ -17 +17 @@
 
   /**
-   * Definitions container
-   * @var array
-   */
-  protected $definitions = array();
+   * Definitions and elements container
+   * @var csElementsContainer
+   */
+  protected $container;
 
   /**
@@ -41 +41 @@
 
   /**
-   * Used definitions references container
-   * @var array
-   */
-  protected $used_definitions = array();
-
-  /**
-   * Document elements container
-   * @var array
-   */
-  protected $elements = array();
-
-  /**
-   * DOM document unique id attributes container
-   * @var array
-   */
-  protected $dom_ids = array();
-
-  /**
    * Document description
    * @var string
@@ -86 +68 @@
    * @var boolean
    */
-  protected $embedded = false;
+  public static $embedded = false;
 
   /**
@@ -107 +89 @@
     $this->setHeight($height);
     $this->setTitle($title);
+    $this->container = new csElementsContainer();
     $this->attributes = array_merge($attrs, $this->attributes);
     $this->initDefaults();
@@ -115 +98 @@
    *
    * @param  mixed    $element  SVG element to add
-   * @param  mixed    $depth    Depth (default: auto when set to NULL)
-   * @param  boolean  $replace_at_depth Replace element at depth if exist ?
    * @throws csException
    */
-  public function addElement($element, $depth = null, $replace_at_depth = false)
-  {
-    // Add DOM id to document list, if any
-    $id = $element->getId();
-    if (!is_null($id))
-    {
-      if (in_array($id, $this->dom_ids))
-      {
-        throw new csException(
-          sprintf('Document has already an element with id "%s"', $id));
-      }
-      $this->dom_ids[] = $id;
-    }
-
-    if (is_null($element->getDepth()))
-    {
-      if (!$replace_at_depth && array_key_exists($depth, $this->elements))
-      {
-        throw new csException(
-          sprintf('Unable to add element at depth "%d", a "%s" element already'.
-                  ' exist at this index',
-                  $depth, $this->elements[$depth]->getElementName(false)));
-      }
-      elseif (!is_int($depth))
-      {
-        $depth = ++$this->maxdepth;
-      }
-    }
-    else
-    {
-      $depth = $element->getDepth();
-    }
-    $this->elements[$depth] = $element;
-  }
-
-  /**
+  public function addElement($element)
+  {
+    return $this->container->addElement($element);
+  }
+
+/**
    * Create an svg element and returns its instance
    *
@@ -162 +113 @@
   public function createElement($name)
   {
-    $class_name = sprintf('cs%s', ucfirst($name));
-    if (!class_exists($class_name))
-    {
-      throw new csException(sprintf('Element class "%s" does not exist',
-                                   $class_name));
-    }
-    return new $class_name;
+    return $this->container->createElement($name);
   }
 
@@ -179 +124 @@
   public function dropElementById($id)
   {
-    foreach ($this->getElements() as $index => $element)
-    {
-      if ($element->getId() == $id)
-      {
-        foreach ($this->dom_ids as $dom_index => $dom_id)
-        {
-          if ($dom_id == $id)
-          {
-            unset($this->dom_ids[$dom_index]);
-          }
-        }
-        unset($this->elements[$index]);
-        return;
-      }
-    }
+    return $this->container->dropElementById($id);
   }
 
@@ -205 +136 @@
   public function getElementById($id)
   {
-    foreach ($this->elements as $element)
-    {
-      if ($element->getId() == $id)
-      {
-        return $element;
-      }
-    }
-    throw new csException(sprintf('No element with id "%s"', $id));
+    return $this->container->getElementById($id);
   }
 
@@ -222 +146 @@
   protected function getElements()
   {
-    return $this->elements;
+    return $this->container->getElements();
+  }
+
+  /**
+   * Checks if SVG output should be in embed mode
+   *
+   * @return boolean
+   */
+  public static function getIsEmbedded()
+  {
+    return self::$embedded;
   }
 
@@ -230 +164 @@
    * @return string
    */
-  protected function getNodeNS()
+  public static function getNodeNS()
   {
     $prefix = '';
-    if ($this->embedded === true)
+    if (self::$embedded === true)
     {
       $prefix = 'svg:';
@@ -293 +227 @@
   public function addAsDefinition($definition, $id = null)
   {
-    $is_element = is_callable(array($definition, 'setId'));
-    if (is_string($id) && trim($id) != '' && $is_element)
-    {
-      $definition->setId($id);
-    }
-    $id = $definition->getId();
-    if (is_null($id))
-    {
-      throw new csException(
-                  sprintf('A definition must have an id specified'));
-    }
-    elseif ($this->hasId($id))
-    {
-      throw new csException(
-                  sprintf('The DOM id "%s" has been already defined', $id));
-    }
-    else
-    {
-      $this->definitions[$id] = $definition;
-      $this->dom_ids[] = $id;
-    }
+    return $this->container->addAsDefinition($definition, $id);
   }
 
@@ -323 +237 @@
   protected function getDefinitions()
   {
-    return $this->definitions;
+    return $this->container->getDefinitions();
   }
 
@@ -333 +247 @@
   protected function getUsedDefinitions()
   {
-    return $this->used_definitions;
+    return $this->container->getUsedDefinitions();
   }
 
@@ -339 +253 @@
    * Returns a defined element alias (a <use/> tag)
    *
+   * @param  string  $id
    * @return array
+   * @throws csException
    */
   protected function getDefinition($id)
   {
-    if (!isset($this->definitions[$id]))
-    {
-      throw new csException(
-                  sprintf('Unable to find id "%s" in current document.'));
-    }
-    else
-    {
-      return $this->definitions[$id];
-    }
+    return $this->container->getDefinition($id);
   }
 
@@ -384 +292 @@
         break;
       }
-      if (true === $this->embedded)
+      if (true === self::$embedded)
       {
         $dom = new DOMDocument('1.0', 'UTF-8');
@@ -408 +316 @@
   public function useDefinition($id, $attrs = array())
   {
-    $this->used_definitions[] = array($this->getDefinition($id), $attrs);
+    return $this->container->useDefinition($id, $attrs);
   }
 
@@ -421 +329 @@
   public function swapDepths($id1, $id2)
   {
-    if ($id1 == $id2)
-    {
-      return;
-    }
-    $e1 = $this->getElementById($id1);
-    $e2 = $this->getElementById($id2);
-    $e1depth = $e1->getDepth();
-    $e2depth = $e2->getDepth();
-    $e2->setDepth($e1depth);
-    $e1->setDepth($e2depth);
-    $this->dropElementById($id1);
-    $this->dropElementById($id2);
-    $this->addElement($e1, $e1depth, true);
-    $this->addElement($e2, $e2depth, true);
+    return $this->container->swapDepths($id1, $id2);
   }
 
@@ -440 +335 @@
    * Checks if a DOM id already exists in current SVG Document
    *
-   * @param  string  $dom_id
+   * @param  string  $id
    * @return boolean
    */
-  public function hasId($dom_id)
-  {
-    return in_array($dom_id, $this->dom_ids);
+  public function hasId($id)
+  {
+    return $this->container->hasId($id);
   }
 
@@ -486 +381 @@
   public function setEmbedded($flag)
   {
-    $this->embedded = (boolean) $flag;
+    self::$embedded = (boolean) $flag;
   }
 
@@ -627 +522 @@
     $dom->normalizeDocument();
 
-    // Validation
-    $this->validate($dom);
+    // Validation if strict mode
+    if (true === $this->strict_mode)
+    {
+      $this->validate();
+    }
 
     // Output
-    if ($this->embedded === true)
+    if (self::$embedded === true)
     {
       return $dom->saveXml($dom->documentElement, LIBXML_NOXMLDECL);
@@ -642 +540 @@
 
   /**
-   * Process definitionsn if any
+   * Process definitions if any
    *
    */
   protected function processDefinitions()
   {
-    $dom = $this->getDomDocument();
-    if (count($this->getDefinitions()) > 0)
-    {
-      // Definitions declaration
-      $defs_node = $dom->createElement($this->getNodeNS().'defs');
-      foreach ($this->getDefinitions() as $definition)
-      {
-        // Define elements
-        $definition_node = $definition->compile($this->embedded);
-        $def_node = $dom->importNode($definition_node, true);
-        $defs_node->appendChild($def_node);
-      }
-      $dom->documentElement->appendChild($defs_node);
-    }
+    return $this->container->processDefinitions($this->getDomDocument());
   }
 
@@ -669 +554 @@
   protected function processElements()
   {
-    $dom = $this->getDomDocument();
-    foreach ($this->getElements() as $element)
-    {
-      $element_node = $element->compile($this->embedded);
-      $node_element = $dom->importNode($element_node, true);
-      $dom->documentElement->appendChild($node_element);
-    }
+    return $this->container->processElements($this->getDomDocument());
   }
 
@@ -690 +569 @@
       foreach ($this->embed_styles as $style)
       {
-        $style_node = $dom->createElement($this->getNodeNS().'style');
+        $style_node = $dom->createElement(self::getNodeNS().'style');
         $style_node->setAttribute('type',  $style['type']);
         $style_node->setAttribute('media', $style['media']);
@@ -733 +612 @@
     if (!is_null($this->title))
     {
-      $title_node = $dom->createElement($this->getNodeNS().'title',
+      $title_node = $dom->createElement(self::getNodeNS().'title',
                                         strip_tags($this->title));
       $dom->documentElement->appendChild($title_node);
@@ -742 +621 @@
     if (!is_null($this->description))
     {
-      $desc_node = $dom->createElement($this->getNodeNS().'desc',
+      $desc_node = $dom->createElement(self::getNodeNS().'desc',
                                        strip_tags($this->description));
       $dom->documentElement->appendChild($desc_node);
@@ -755 +634 @@
   {
     $dom = $this->getDomDocument();
-    $root = $this->dom_document->createElement($this->getNodeNS().'svg');
+    $root = $this->dom_document->createElement(self::getNodeNS().'svg');
     $dom->appendChild($root);
     foreach ($this->attributes as $attr_name => $attr_value)
@@ -767 +646 @@
 
   /**
+   * Process used definitions, if any
+   *
+   */
+  protected function processUsedDefinitions()
+  {
+    return $this->container->processUsedDefinitions($this->getDomDocument());
+  }
+
+  /**
    * Process scripts, if any
    *
@@ -778 +666 @@
       foreach ($this->scripts as $script)
       {
-        $script_node = $dom->createElement($this->getNodeNS().'script');
+        $script_node = $dom->createElement(self::getNodeNS().'script');
         $script_node->setAttribute('type', $script[1]);
         $script_content = $dom->createCDATASection($script[0]);
@@ -788 +676 @@
 
   /**
-   * Process used definitions, if any
-   *
-   */
-  protected function processUsedDefinitions()
-  {
-    $dom = $this->getDomDocument();
-    if (count($this->getUsedDefinitions()) > 0)
-    {
-      foreach ($this->getUsedDefinitions() as $used_definition)
+   * Validates document
+   *
+   * @throws csException
+   */
+  public function validate()
+  {
+    try
+    {
+      $this->getDomDocument()->validate();
+    }
+    catch (csException $e)
+    {
+      if (preg_match('/php_network_getaddresses/', $e->getMessage()))
       {
-        $element = $used_definition[0];
-        $attributes = $used_definition[1];
-        $use_node = $dom->createElement($this->getNodeNS().'use');
-        $use_node->setAttribute('xlink:href', '#'.$element->getId());
-        foreach ($attributes as $attr_name => $attr_value)
-        {
-          $use_node->setAttribute($attr_name, $attr_value);
-        }
-        $dom->documentElement->appendChild($use_node);
+        throw new csException(
+          'An internet connection is required to validate document');
       }
-    }
-  }
-
-  /**
-   * Validates document
-   *
-   * @throws csException
-   */
-  protected function validate(DOMDocument $dom)
-  {
-    if (true == $this->strict_mode && !$dom->validate())
-    {
-      throw new csException('This SVG Document does not validate');
+      throw new csException(
+        'SVG document validation failed: '.$e->getMessage());
     }
   }