shawe / FSConsoleTools

src/Console/Command/OrderXmlTables.php

<?php
/**
 * This file is part of FSConsoleTools
 * Copyright (C) 2018 Francesc Pineda Segarra <francesc.pineda.segarra@gmail.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

namespace FacturaScriptsUtils\Console\Command;

use DOMDocument;
use FacturaScripts\Core\Base\FileManager;

The type FacturaScripts\Core\Base\FileManager was not found. Maybe you did not declare it correctly or list all dependencies?

use FacturaScriptsUtils\Console\ConsoleAbstract;
use SimpleXMLElement;

/**
 * Class OrderXmlTable
 *
 * @author Francesc Pineda Segarra <francesc.pineda.segarra@gmail.com>
 */
class OrderXmlTables extends ConsoleAbstract
{
    /**
     * Constant values for return, to easy know how execution ends.
     */
    const RETURN_SUCCESS = 0;
    const RETURN_SRC_FOLDER_NOT_SET = 1;
    const RETURN_DST_FOLDER_NOT_SET = 2;
    const RETURN_TAG_NAME_NOT_SET = 3;
    const RETURN_CANT_CREATE_FOLDER = 4;
    const RETURN_FAIL_SAVING_FILE = 5;
    const RETURN_NO_FILES = 6;
    const RETURN_SRC_FOLDER_NOT_EXISTS = 7;
    const RETURN_INCORRECT_FILE = 8;

    /**
     * Folder source path.
     *
     * @var string
     */
    private $srcFolder;

    /**
     * Folder destiny path.
     *
     * @var string
     */
    private $dstFolder;

    /**
     * Tagname used for order.
     *
     * @var string
     */
    private $tagName;

    /**
     * Set default source folder.
     *
     * @param string $srcFolder
     *
     * @return $this
     */
    public function setSrcFolder(string $srcFolder): self
    {
        $this->srcFolder = $srcFolder;
        return $this;
    }

    /**
     * Set default destiny folder.
     *
     * @param string $dstFolder
     *
     * @return $this
     */
    public function setDstFolder(string $dstFolder): self
    {
        $this->dstFolder = $dstFolder;
        return $this;
    }

    /**
     * Set tag name.
     *
     * @param string $tagName
     *
     * @return $this
     */
    public function setTagName(string $tagName): self
    {
        $this->tagName = $tagName;
        return $this;
    }

    /**
     * Run the OrderXmlTable script.
     *
     * @param array $params
     *
     * @return int
     * @throws \Exception
     */
    public function run(...$params): int
    {
        $this->autoReply = (bool) $params[2] ?? false;
        $this->autoHide = (bool) $params[3] ?? false;

        $status = $this->checkOptions($params);
        if ($status !== 0) {
            return $status;
        }

        $this->setSrcFolder(\FS_FOLDER . ($params[0] ?? 'Core/Table/'));
        $this->setDstFolder(\FS_FOLDER . ($params[1] ?? 'Core/Table/'));
        $this->setTagName($params[2] ?? 'name');

        $this->showMessage('Ordering XML table content' . \PHP_EOL . \PHP_EOL);
        $this->showMessage('   Options setted:' . \PHP_EOL);
        $this->showMessage('      Source path: ' . $this->srcFolder . \PHP_EOL);
        $this->showMessage('      Destiny path: ' . $this->dstFolder . \PHP_EOL);
        $this->showMessage('      Tag name: ' . $this->tagName . \PHP_EOL);

        if (!$this->areYouSure($this->autoReply)) {
            $this->showMessage('   Options [SRC] [DST] [TAG]' . \PHP_EOL);
            return self::RETURN_SUCCESS;
        }

        $status = $this->check();
        if ($status !== 0) {
            return $status;
        }

        $files = FileManager::scanFolder($this->srcFolder);

        if (\count($files) === 0) {
            trigger_error('ERROR: No files on folder' . \PHP_EOL . \PHP_EOL);
            return self::RETURN_NO_FILES;
        }

        return $this->orderXml($files);
    }

    /**
     * Return description about this class.
     *
     * @return string
     */
    public function getDescription(): string
    {
        return 'Order XML content files by tag name.';
    }

    /**
     * Print help information to the user.
     *
     * @return string
     */
    public function getHelpMsg(): string
    {
        $array = \explode('\\', __CLASS__);
        $class = array_pop($array);
        return 'Use as: php vendor/bin/console ' . $class . ' [OPTIONS]' . \PHP_EOL
            . 'Available options:' . \PHP_EOL
            . '   -h, --help        Show this help.' . \PHP_EOL
            . \PHP_EOL
            . '   OPTION1           Source path' . \PHP_EOL
            . '   OPTION2           Destiny path' . \PHP_EOL
            . '   OPTION3           Tag name' . \PHP_EOL
            . \PHP_EOL;
    }

    /**
     * Returns an associative array of available methods for the user.
     * Add more options if you want to add support for custom methods.
     *      [
     *          '-h'        => 'getHelpMsg',
     *          '--help'    => 'getHelpMsg',
     *      ]
     *
     * @return array
     */
    public function getUserMethods(): array
    {
        return parent::getUserMethods();
    }

    /**
     * Order Xml files
     *
     * @param array $files
     *
     * @return int
     * @throws \Exception
     */
    private function orderXml(array $files): int
    {
        try {
            foreach ($files as $fileName) {
                $xml = simplexml_load_string(file_get_contents($this->srcFolder . $fileName));
                // Get all children of table into an array
                $table = (array) $xml->children();
                $this->checkStructure($fileName, $table);
                $dom = new DOMDocument();
                $dom->loadXML($this->generateXML($fileName, $table));
                $filePath = $this->dstFolder . '/' . $fileName;
                if ($dom->save($filePath) === false) {
                    trigger_error("ERROR: Can't save file " . $filePath . \PHP_EOL);
                    return self::RETURN_FAIL_SAVING_FILE;
                }
            }
        } catch (\Exception $e) {
            trigger_error($e->getMessage(), \PHP_EOL);

PHP_EOL of type string is incompatible with the type integer expected by parameter $error_type of trigger_error().

            return self::RETURN_INCORRECT_FILE;
        }
        $this->showMessage('Finished! Look at "' . $this->dstFolder . '"' . \PHP_EOL);
        return self::RETURN_SUCCESS;
    }

    /**
     * Check if basic structure is correct
     *
     * @param string $fileName
     * @param array  $table
     *
     * @throws \Exception
     */
    private function checkStructure(string $fileName, array $table)
    {
        if (!isset($table['column'])) {
            throw new \RuntimeException(
                'File is incorrect ' . $this->srcFolder . $fileName . \PHP_EOL
                . 'File does not contain any column.' . \PHP_EOL
                . 'Execution stopped'
            );
        }
        foreach ($table as $key => $row) {
            $item = isset($key) ? 'column' : null;
            $item = $item ?? (isset($key) ? 'constraint' : null);
            if ($item === null) {
                throw new \RuntimeException(
                    'File is incorrect ' . $this->srcFolder . $fileName . \PHP_EOL
                    . 'Unexpected data ' . print_r($key, true) . ' => ' . print_r($row, true) . '.'
                    . 'Execution stopped'
                );
            }
            if (isset($row[$item]) && !isset($row[$item]['name'], $row[$item]['type'])) {
                throw new \RuntimeException(
                    'File is incorrect ' . $this->srcFolder . $fileName . \PHP_EOL
                    . \ucfirst($item) . ' ' . print_r($row[$item], true) . ' does not contain name or type.'
                    . 'Execution stopped'
                );
            }
        }
    }

    /**
     * Return the final content of the XML file.
     *
     * @param string $fileName
     * @param array  $table
     *
     * @return string
     */
    private function generateXML(string $fileName, array $table): string
    {
        $columns = $table['column'];
        // Call usort on the array
        if (!\is_object($columns)) {
            usort($columns, [$this, 'sortName']);
        }
        // Generate string XML result
        $strXML = $this->generateXMLHeader($fileName);
        $strXML .= '<table>' . PHP_EOL;
        $strXML .= $this->generateXMLContent($columns);
        if (isset($table['constraint'])) {
            $constraints = $table['constraint'];
            if (!\is_object($constraints)) {
                usort($constraints, [$this, 'sortName']);
            }
            $strXML .= $this->generateXMLContent($constraints, 'constraint');
        }
        $strXML .= '</table>';
        return $strXML;
    }

    /**
     * Check if options are looking for help.
     *
     * @param array $params
     *
     * @return int
     */
    private function checkOptions(array $params = []): int
    {
        if (isset($params[0])) {
            switch ($params[0]) {
                case '-h':
                case '--help':
                    $this->showMessage($this->getHelpMsg());
                    return -1;
            }
        }
        return 0;
    }

    /**
     * Launch basic checks.
     *
     * @return int
     */
    private function check(): int
    {
        if ($this->srcFolder === null) {
            trigger_error('ERROR: Source folder not setted.' . \PHP_EOL . \PHP_EOL);
            return self::RETURN_SRC_FOLDER_NOT_SET;
        }
        if ($this->dstFolder === null) {
            trigger_error('ERROR: Destiny folder not setted.' . \PHP_EOL . \PHP_EOL);
            return self::RETURN_DST_FOLDER_NOT_SET;
        }
        if ($this->tagName === null) {
            trigger_error('ERROR: Tag name not setted.' . \PHP_EOL . \PHP_EOL);
            return self::RETURN_TAG_NAME_NOT_SET;
        }
        if (!is_dir($this->srcFolder)) {
            trigger_error('ERROR: Source folder ' . $this->srcFolder . ' not exists.' . \PHP_EOL . \PHP_EOL);
            return self::RETURN_SRC_FOLDER_NOT_EXISTS;
        }
        if (!is_file($this->dstFolder) && !@mkdir($this->dstFolder) && !is_dir($this->dstFolder)) {
            trigger_error("ERROR: Can't create folder " . $this->dstFolder . '.' . \PHP_EOL . \PHP_EOL);
            return self::RETURN_CANT_CREATE_FOLDER;
        }
        return self::RETURN_SUCCESS;
    }

    /**
     * Custom function to re-order with usort.
     *
     * @param SimpleXMLElement $xmlA
     * @param SimpleXMLElement $xmlB
     *
     * @return int
     */
    private function sortName(SimpleXMLElement $xmlA, SimpleXMLElement $xmlB): int
    {
        return strcasecmp($xmlA->{$this->tagName}, $xmlB->{$this->tagName});
    }

    /**
     * Generate the content of the XML.
     *
     * @param array|object $data
     * @param string       $tagName
     *
     * @return string
     */
    private function generateXMLContent($data, $tagName = 'column'): string
    {
        $str = '';
        if (\is_array($data)) {
            foreach ($data as $field) {
                $str .= '    <' . $tagName . '>' . PHP_EOL;
                foreach ((array) $field as $key => $value) {
                    $str .= '        <' . $key . '>' . $value . '</' . $key . '>' . PHP_EOL;
                }
                $str .= '    </' . $tagName . '>' . PHP_EOL;
            }
        }
        if (\is_object($data)) {
            $str .= '    <' . $tagName . '>' . PHP_EOL;
            foreach ((array) $data as $key => $value) {
                $str .= '        <' . $key . '>' . $value . '</' . $key . '>' . PHP_EOL;
            }
            $str .= '    </' . $tagName . '>' . PHP_EOL;
        }

        return $str;
    }

    /**
     * Generate the header of the XML.
     *
     * @param string $fileName
     *
     * @return string
     */
    private function generateXMLHeader(string $fileName): string
    {
        $str = '<?xml version="1.0" encoding="UTF-8"?>' . PHP_EOL;
        $str .= '<!--' . PHP_EOL;
        $str .= '    Document   : ' . $fileName . PHP_EOL;
        $str .= '    Author     : Ordered with OrderXmlTables from FSConsoleTools' . PHP_EOL;
        $str .= '    Description: Structure for the ' . str_replace('.xml', '', $fileName) . ' table.' . PHP_EOL;
        $str .= '-->' . PHP_EOL;
        return $str;
    }
}