Helick\Blocks\Traits\Renderable

Complexity

Total Complexity

6

Size/Duplication

Total Lines	71
Duplicated Lines	0 %

Importance

Changes	3
Bugs	2	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	capture()	0	15	2
A	template()	0	12	3
A	render()	0	8	1

<?php

namespace Helick\Blocks\Traits;

use Exception;
use Helick\Blocks\Exceptions\BlockException;

trait Renderable
{
    /**
     * Captures the output that is generated when a template is included.
     * This property is static to prevent object scope resolution.
     *
     * @param string $template
     * @param array  $data
     *
     * @return string
     *
     * @throws Exception
     */
    protected static function capture(string $template, array $data): string
    {
        extract($data, EXTR_SKIP);

        ob_start();

        try {
            include $template;
        } catch (Exception $e) {
            ob_end_clean();

            throw $e;
        }

        return ob_get_clean();
    }

    /**
     * Render the block.
     *
     * [!!] Global variables with the same key name as local variables will be
     * overwritten by the local variable.
     *
     * @param array  $fields
     * @param array  $attributes
     * @param string $blocks
     *
     * @return void
     *
     * @throws Exception
     */
    public function render(array $fields, array $attributes, string $blocks): void
    {
        $globalVariables = compact('fields', 'attributes', 'blocks');
        $localVariables  = $this->with($fields);

It seems like with() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $data = array_merge($globalVariables, $localVariables);

        echo static::capture($this->template(), $data);
    }

    /**
     * Get the block's template.
     *
     * @return string
     */
    protected function template(): string
    {
        if (empty($this->template)) {
            throw BlockException::forEmptyTemplate();
        }

        $template = locate_template($this->template);

The function locate_template was not found. Maybe you did not declare it correctly or list all dependencies?

        if ($template === '') {
            throw BlockException::forNotFoundTemplate($this->template);
        }

        return $template;
    }
}