ExportYmlItems.php

<?php
/**
 * JBZoo CCK Cli
 *
 * This file is part of the JBZoo CCK package.
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @package   CCK Cli
 * @license   MIT
 * @copyright Copyright (C) JBZoo.com,  All rights reserved.
 * @link      https://github.com/JBZoo/CCK-Cli
 * @author    Sergey Kalistratov <kalistratov.s.m@gmail.com>
 */

namespace JBZoo\Console\Command;

use JBZoo\Utils\FS;
use JBZoo\Utils\Slug;
use JBZoo\Console\CommandJBZoo;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

/**
 * Class ExportYmlItems
 *
 * @package JBZoo\Console\Command
 */
class ExportYmlItems extends CommandJBZoo
{

    /**
     * @var \JBConfigHelper
     */
    protected $_jbconfig = null;

    /**
     * @var \JBYmlHelper
     */
    protected $_jbyml = null;

    /**
     * @var string
     */
    protected $_commandName = 'export:yml-items';

    /**
     * @return void
     */
    protected function _browserEmulator()
    {
        $_SERVER['SCRIPT_NAME']   = '/index.php';
        $_SERVER['REQUEST_URI']   = '/index.php';
        $_SERVER['PHP_SELF']      = '/index.php';
        $_SERVER['HTTP_HOST']     = $this->_getSiteUrl();
        $_SERVER['SERVER_NAME']   = $this->_getSiteUrl();
        $_SERVER['DOCUMENT_ROOT'] = JBZOO_CLI_JOOMLA_ROOT;
    }

    /**
     * @return mixed|string
     */
    protected function _getFileName()
    {
        return $this->_config->find('params.file_name', 'yml');
    }

    /**
     * @return mixed|string
     */
    protected function _getFilePath()
    {
        return $this->_config->find('params.file_path', 'cli/jbzoo/resources/sources');
    }

    /**
     * @return string
     */
    protected function _getProfFileName()
    {
        return Slug::filter($this->_getFileName() . '-' . $this->_getOpt('profile'));
    }

    /**
     * @return mixed
     */
    protected function _getSiteUrl()
    {
        return $this->_globConfig->get('host');
    }

    /**
     * {@inheritdoc}
     */
    protected function _init()
    {
        parent::_init();

        $this->_jbyml     = $this->app->jbyml;
        $this->_jbconfig  = $this->app->jbconfig;
    }

    /**
     * Init Joomla Framework.
     *
     * @SuppressWarnings(PHPMD.Superglobals)
     * @return void
     */
    protected function _loadJoomla()
    {
        define('_JEXEC', 1);
        define('JPATH_BASE', JBZOO_CLI_JOOMLA_ROOT); // website root directory

        /** @noinspection PhpIncludeInspection */
        require_once JPATH_BASE . '/includes/defines.php';
        /** @noinspection PhpIncludeInspection */
        require_once JPATH_BASE . '/includes/framework.php';

        // prepare env (emulate browser)
        $this->_browserEmulator();

        if (!$_SERVER['HTTP_HOST']) {
            $this->_('Host is undefined. Please, check global config "./config/_global.php"', 'Error');
            $this->_('Joomla need it for browser simulation', 'Error', 1);
        }

        // no output
        $_GET['tmpl'] = $_REQUEST['tmpl'] = 'raw';
        $_GET['lang'] = $_REQUEST['lang'] = 'ru';

        // init Joomla App ( Front-end emulation )
        \JFactory::getApplication('site');
    }

    /**
     * @return \JBModelConfig
     */
    protected function _setupConfigure()
    {
        $configModel = \JBModelConfig::model();
        $configModel->setGroup('config.yml', array(
            'site_url'      => rtrim(\JUri::root(), '/'),
            'file_path'     => $this->_getFilePath(),
            'file_name'     => $this->_getProfFileName(),
            'site_name'     => $this->_config->find('params.site_name', 'My site name'),
            'company_name'  => $this->_config->find('params.company_name', 'My company name'),
            'currency_rate' => $this->_config->find('params.currency_rate', 'default'),
        ));

        $configModel->set('app_list', $this->_config->find('params.app_list', array(1)));
        $configModel->set('type_list', $this->_config->find('params.type_list', array('product')));

        return $configModel;
    }

    /**
     * Configuration of command.
     *
     * @return void
     */
    protected function configure() // @codingStandardsIgnoreLine
    {
        $this
            ->setName($this->_commandName)
            ->setDescription('Export items to YML file')
            ->addOption(
                'profile',
                null,
                InputOption::VALUE_REQUIRED,
                'Profile name is PHP-file in \'config\' directory like \'export-yml-items-<NAME>.php\'  ',
                'default'
            )->addOption(
                'stepmode',
                null,
                InputOption::VALUE_NONE,
                'Enable step mode. Each step call itself. Experimental for memory optimization'
            )
            ->addOption(
                'step',
                null,
                InputOption::VALUE_OPTIONAL,
                'Current step number for step mode (Set automatically if enabled stepmode)',
                -1
            );
    }

    /**
     * Executes the current command.
     *
     * @param InputInterface $input
     * @param OutputInterface $output
     * @return void
     */
    protected function execute(InputInterface $input, OutputInterface $output) // @codingStandardsIgnoreLine
    {
        $this->_executePrepare($input, $output);

        $this->_init();
        $this->_setupConfigure();

        $this->_jbyml->init();
        $totalItems = $this->_jbyml->getTotal();
        $filePath   = $this->_getFilePath() . '/' . $this->_getProfFileName() . '.xml';
        $fullPath   = FS::clean(JBZOO_CLI_JOOMLA_ROOT . '/' . $filePath);
        $stepMode   = $this->_getOpt('stepmode');
        $stepSize   = $this->_config->find('params.step_size', 25);

        $this->_showProfiler('YML Export - prepared');
        $this->_('YML File: ' . $fullPath, 'Info');
        $this->_('Total items: ' . $totalItems, 'Info');
        $this->_('Step size: ' . $stepSize, 'Info');
        $this->_('Step mode: ' . ($stepMode ? 'on' : 'off'), 'Info');

        $this->_progressWrap(
            $this->_commandName,
            $totalItems,
            $stepSize,

            //  On start.
            function () use ($totalItems, $stepSize) {
                $this->_jbyml->renderStart();
                $this->_progressBar('yml-export', $totalItems, $stepSize, function ($currentStep, $stepSize) {
                    $offset = $stepSize * $currentStep;
                    $this->_jbyml->exportItems($offset, $stepSize);
                });

                return true;
            },

            // On step.
            function ($step) use ($stepSize) {
                $offset = $stepSize * $step;

                if ($step == 0) {
                    $this->_jbyml->renderStart();
                }

                $this->_jbyml->exportItems($offset, $stepSize);
            },

            // On finish.
            function ($isFinished) {
                if ($isFinished) {
                    $this->_jbyml->renderFinish();
                    $this->_showProfiler('Import - finished');
                }
            }
        );
    }
}