Merge pull request #2137 from phpDocumentor/remove-xml-writer-and-sup…

…porting-classes

Remove XML Writer and Supporting classes

README.md

@@ -68,9 +68,6 @@ There are 3 ways to install phpDocumentor:
 2. Via [Docker](https://hub.docker.com/r/phpdoc/phpdoc/)
 3. Via [Composer](https://getcomposer.org)
 
-_*Please note* that it is required that the installation path of phpDocumentor does not
-contain spaces. This is a requirement imposed by an external library (libxml)_
-
 ### Using the PHAR
 
 1. Download the phar file from https://github.com/phpDocumentor/phpDocumentor/releases

config/services.yaml

@@ -246,8 +246,6 @@ services:
 
     phpDocumentor\Transformer\Writer\FileIo: ~
     phpDocumentor\Transformer\Writer\Sourcecode: ~
-    phpDocumentor\Transformer\Writer\Xml:
-      arguments: ['@phpDocumentor\Transformer\Router\StandardRouter']
     phpDocumentor\Transformer\Writer\Graph: ~
     phpDocumentor\Transformer\Writer\Twig: ~
     phpDocumentor\Transformer\Writer\Twig\EnvironmentFactory: ~
@@ -256,7 +254,6 @@ services:
       calls:
         - { method: offsetSet, arguments: ['FileIo', '@phpDocumentor\Transformer\Writer\FileIo']}
         - { method: offsetSet, arguments: ['sourcecode', '@phpDocumentor\Transformer\Writer\Sourcecode']}
-        - { method: offsetSet, arguments: ['xml', '@phpDocumentor\Transformer\Writer\Xml']}
         - { method: offsetSet, arguments: ['Graph', '@phpDocumentor\Transformer\Writer\Graph']}
         - { method: offsetSet, arguments: ['twig', '@phpDocumentor\Transformer\Writer\Twig']}
 

docs/glossary.rst

@@ -41,18 +41,6 @@ Glossary
              * @return string
              */
 
-    AST
-    Abstract Syntax Tree
-    Abstract Syntax Tree (AST)
-        phpDocumentor generates a XML file between parsing your source code and generating the HTML output. This
-        structure file (called *structure.xml*) contains the raw analyzed data of your project, also called: an Abstract
-        Syntax Tree.
-
-        This same file is also used by phpDocumentor to do incremental parsing of your project by comparing the contents
-        of this file with the content on disk.
-
-        It is thus recommended to keep your structure file and allow phpDocumentor to re-use the contained information.
-
     PHPDoc
         This is a section of documentation which provides information on several aspects of :term:`Structural Elements`.
 

docs/references/configuration.rst

@@ -109,10 +109,9 @@ elements which are explained in more detail in the sub-chapters.
 
 -  Title, the title for this project, *may contain HTML*
 -  Parser, all settings related to the conversion of the source
-   code to the intermediate structure file (structure.xml).
+   code to the cache.
 -  Transformer, all settings related to the process of transforming
-   the intermediate structure file (structure.xml) to a human readable
-   format, such as HTML or PDF.
+   the cache to a human readable format, such as HTML or PDF.
 -  Logging, all settings related to the generation of logs.
 -  Transformations, the default template and additional
    transformations can be specified in this section.

docs/references/writers/index.rst

@@ -7,4 +7,3 @@ Writers
    fileio
    twig
    checkstyle
-   xml

src/phpDocumentor/Application/Stage/Transform.php

@@ -35,9 +35,8 @@
  * Transforms the structure file into the specified output format
  *
  * This task will execute the transformation rules described in the given
- * template (defaults to 'responsive') with the given source (defaults to
- * output/structure.xml) and writes these to the target location (defaults to
- * 'output').
+ * template with the given source and writes these to the target location
+ * (defaults to 'output').
  *
  * It is possible for the user to receive additional information using the
  * verbose option or stop additional information using the quiet option. Please

src/phpDocumentor/Console/Command/Project/ParseCommand.php

@@ -25,8 +25,7 @@
  * Parses the given source code and creates a structure file.
  *
  * The parse task uses the source files defined either by -f or -d options and
- * generates a structure file (structure.xml) at the target location (which is
- * the folder 'output' unless the option -t is provided).
+ * generates a cached representation of the project structure.
  */
 final class ParseCommand extends Command
 {

src/phpDocumentor/Console/Command/Project/TransformCommand.php

@@ -26,8 +26,7 @@
  * Transforms the structure file into the specified output format
  *
  * This task will execute the transformation rules described in the given
- * template (defaults to 'responsive') with the given source (defaults to
- * output/structure.xml) and writes these to the target location (defaults to
+ * template with the cache and writes these to the target location (defaults to
  * 'output').
  *
  * It is possible for the user to receive additional information using the
@@ -63,9 +62,8 @@ protected function configure(): void
             ->setHelp(
                 <<<TEXT
                 This task will execute the transformation rules described in the given
-                template (defaults to 'responsive') with the given source (defaults to
-                output/structure.xml) and writes these to the target location (defaults to
-                'output').
+                template with the cache generated by the parse command and writes these 
+                to the target location (defaults to 'output').
                 
                 It is possible for the user to receive additional information using the
                 verbose option or stop additional information using the quiet option. Please