felixarntz/boilerplate

<?php
/**
 * Class FelixArntz\Boilerplate\Task\RequestSettingValuesTask
 *
 * @package FelixArntz\Boilerplate
 * @license GNU General Public License v2 (or later)
 * @link    https://github.com/felixarntz/boilerplate
 */

namespace FelixArntz\Boilerplate\Task;

use Exception;

/**
 * Class representing a task that asks the user to provide values for config placeholders.
 *
 * @since 1.0.0
 */
class RequestSettingValuesTask extends AbstractTask implements ConfigAware, IOAware
{
    use ConfigAwareTrait, RequestValueTrait;

    /**
     * Gets the initial status message to show before the task starts execution.
     *
     * @since 1.0.0
     *
     * @return string Status message.
     */
    public function getStatusMessage() : string
    {
        return 'Requesting setting values...';
    }

    /**
     * Completes the task.
     *
     * @since 1.0.0
     */
    public function complete()
    {
        if (empty($this->config['settings'])) {
            return;
        }

        foreach ($this->config['settings'] as $key => $data) {
            $default = $this->getSettingDefault($data);

            if ($this->shouldSkipSetting($data)) {
                $this->config['settings'][$key]['value'] = $default;
                continue;
            }

            $this->config['settings'][$key]['value'] = $this->requestValue($data, $default);
        }
    }

    /**
     * Checks whether requesting the setting value for the given data should be skipped.
     *
     * @since 1.0.0
     *
     * @param array $data Data for the setting.
     * @return bool True if the setting should be skipped, false otherwise.
     */
    protected function shouldSkipSetting(array $data) : bool
    {
        if (!isset($data['skip'])) {
            return false;
        }

        if (is_callable($data['skip'])) {
            return (bool) call_user_func($data['skip'], $this->config['settings']);
        }

        return (bool) $data['skip'];
    }

    /**
     * Gets the default setting value for the given data.
     *
     * @since 1.0.0
     *
     * @param array $data Data for the setting.
     * @return mixed Setting default value.
     */
    protected function getSettingDefault(array $data)
    {
        if (!isset($data['default'])) {
            return null;
        }

        if (is_callable($data['default'])) {
            return call_user_func($data['default'], $this->config['settings']);
        }

        return $data['default'];
    }
}