hiqdev / hidev

src/handlers/BaseHandler.php

<?php
/**
 * Automation tool mixed with code generator for easier continuous development
 *
 * @link      https://github.com/hiqdev/hidev
 * @package   hidev
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2018, HiQDev (http://hiqdev.com/)
 */

namespace hidev\handlers;

use hidev\helpers\FileHelper;
use Yii;
use yii\base\InvalidConfigException;
use yii\helpers\ArrayHelper;

/**
 * Base Handler.
 * Knows how to parse and render it's file type.
 */
class BaseHandler extends \yii\base\BaseObject
{
    /**
     * @var Goal

The type hidev\handlers\Goal was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public $goal;

    /**
     * @var string template file name to be used for rendering
     */
    public $template;

    /**
     * @var View object

The type hidev\handlers\View was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    protected $_view;

    /**
     * Returns the view object that can be used to render views or view files.
     * If not set, it will default to the "view" application component.
     * @return View the view object that can be used to render views or view files
     */
    public function getView()
    {
        if ($this->_view === null) {
            $this->_view = Yii::$app->getView();

It seems like Yii::app->getView() of type yii\base\View or yii\web\View is incompatible with the declared type hidev\handlers\View of property $_view.

        }

        return $this->_view;

The expression return $this->_view also could return the type yii\base\View|yii\web\View which is incompatible with the documented return type hidev\handlers\View.

    }

    /**
     * Renders prepared data.
     * Must be redefined in child.
     * @param array $data
     * @throws InvalidConfigException
     * @return string file content
     */
    public function renderPrepared(array $data)
    {
        throw new InvalidConfigException('Render not available');
    }

    /**
     * Renders raw data.
     * Prepares data with ArrayHelper::toArray.
     * @param mixed $data
     * @return string file content
     */
    public function render($data)
    {
        return $this->renderPrepared($this->prepareData($data));
    }

    public function prepareData($data)
    {
        return ArrayHelper::toArray($data, [], false);
        //return $data;
    }

    /**
     * Renders file content using given data.
     * Converts to array with ArrayHelper::toArray.
     * @param mixed $data
     * @return string file content
     */
    public function renderPath($path, $data)
    {
        return $this->write($path, $this->render($data));

The expression return $this->write($path, $this->render($data)) returns the type boolean which is incompatible with the documented return type string.

    }

    public function parsePath($path, $minimal = null)

The parameter $minimal is not used and could be removed.

    {
        return $this->parse($this->read($path));
    }

    /**
     * Parses string input. To be redefined in real handlers.
     * @param string $input to parse
     * @return array
     */
    public function parse($input)

The parameter $input is not used and could be removed.

    {
        return [];
    }

    /**
     * Writes given content to the file.
     * Doesn't touch file if it has exactly same content.
     * Creates intermediate directories when necessary.
     * @param string $path
     * @param string $content
     * @return bool true if file was changed
     */
    public function write($path, $content)
    {
        return FileHelper::write($path, $content);
    }

    /**
     * Creates directory if not exists.
     * @param string $path
     * @return bool true if directory did not exist and was created
     */
    public function mkdir($path)
    {
        return FileHelper::mkdir($path);
    }

    /**
     * Read file into a string or array.
     * @param string $path
     * @param bool $asArray
     * @return string|array
     */
    public function read($path, $asArray = false)
    {
        if (file_exists($path)) {
            Yii::info('Read file: ' . $path, 'file');

            return $asArray ? file($path) : file_get_contents($path);

The expression return $asArray ? file($path) : file_get_contents($path) could also return false which is incompatible with the documented return type array|string. Did you maybe forget to handle an error condition?

        } else {
            Yii::warning('Couldn\'t read file: ' . $path, 'file');

            return;
        }
    }

    /**
     * Read file into array of strings.
     * @param string $path
     * @return array
     */
    public function readArray($path)
    {
        return $this->read($path, true);
    }
}