framework/main/interfaces/template/xml/class_CompileableXmlTemplate.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Template\Xml;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Template\CompileableTemplate;
   7
   8 /**
   9  * An interface for template engines
  10  *
  11  * @author              Roland Haeder <webmaster@shipsimu.org>
  12  * @version             0.0.0
  13  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2022 Core Developer Team
  14  * @license             GNU GPL 3.0 or any newer version
  15  * @link                http://www.shipsimu.org
  16  *
  17  * This program is free software: you can redistribute it and/or modify
  18  * it under the terms of the GNU General Public License as published by
  19  * the Free Software Foundation, either version 3 of the License, or
  20  * (at your option) any later version.
  21  *
  22  * This program is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU General Public License
  28  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  29  */
  30 interface CompileableXmlTemplate extends CompileableTemplate {
  31
  32         /**
  33          * Renders the given XML content
  34          *
  35          * @param       $content        Valid XML content or if not set the current loaded raw content
  36          * @return      void
  37          * @throws      XmlParserException      If an XML error was found
  38          */
  39         function renderXmlContent (string $content = NULL);
  40
  41         /**
  42          * Enables or disables XML compacting
  43          *
  44          * @param       $xmlCompacting  New XML compacting setting
  45          * @return      void
  46          */
  47         function enableXmlCompacting (bool $xmlCompacting = true);
  48
  49         /**
  50          * Checks whether XML compacting is enabled
  51          *
  52          * @return      $xmlCompacting  Whether XML compacting is enabled or disabled
  53          */
  54         function isXmlCompactingEnabled ();
  55
  56         /**
  57          * Removes all comments, tabs and new-line charcters to compact the content
  58          *
  59          * @param       $uncompactedContent             The uncompacted content
  60          * @return      $compactedContent               The compacted content
  61          */
  62         function compactContent (string $uncompactedContent);
  63
  64 }