samrap / acf-fluent

src/Fluent/Runner.php

<?php

namespace Samrap\Acf\Fluent;

use Samrap\Acf\Behaviors\BehaviorInterface;
use Samrap\Acf\Exceptions\RunnerException;

class Runner
{
    /**
     * The behavior to use for ACF function calls.
     *
     * @var \Samrap\Acf\Behaviors\BehaviorInterface
     */
    protected $behavior;

    /**
     * The \Samrap\Acf\Fluent\Builder components to run.
     *
     * The components will be executed in the order defined in this array. Only
     * the components defined on the \Samrap\Acf\Fluent\Builder will be run.
     *
     * @var array
     */
    protected $components = [
        'expect',
        'matches',
        'default',
        'shortcodes',
        'escape',
    ];

    /**
     * Create a new Runner instance.
     *
     * @param  \Samrap\Acf\Behaviors\BehaviorInterface  $behavior
     */
    public function __construct(BehaviorInterface $behavior)
    {
        $this->behavior = $behavior;
    }

    /**
     * Get the behavior instance.
     *
     * @return \Samrap\Acf\Behaviors\BehaviorInterface
     */
    public function getBehavior()
    {
        return $this->behavior;
    }

    /**
     * Set the behavior.
     *
     * @param  \Samrap\Acf\Behaviors\BehaviorInterface  $behavior
     * @return void
     */
    public function setBehavior(BehaviorInterface $behavior)
    {
        $this->behavior = $behavior;
    }

    /**
     * Run the ACF 'get' behavior from the given builder.
     *
     * @param  \Samrap\Acf\Fluent\Builder  $builder
     * @return mixed
     */
    public function get(Builder $builder)
    {
        // First, we will retrieve the field's value using our composed behavior.
        $value = $this->behavior->get(
            $builder->field,
            $builder->id,
            ! $builder->raw

The call to BehaviorInterface::get() has too many arguments starting with !$builder->raw.

        );

        // Next, we will iterate over the defined components and pass our value
        // through each component's method if it was defined on the builder.
        foreach ($this->components as $component) {
            if (! is_null($builder->$component)) {
                $method = 'run'.ucfirst($component);

                $value = $this->$method($builder->$component, $value);
            }
        }

        return $value;
    }

    /**
     * Run the ACF 'update' behavior from the given builder.
     *
     * @param  \Samrap\Acf\Fluent\Builder  $builder
     * @param  mixed  $value
     * @return void
     */
    public function update(Builder $builder, $value)
    {
        $this->behavior->update($builder->field, $value, $builder->id);
    }

    /**
     * Ensure that the value is of the expected type.
     *
     * @param  string  $expected
     * @param  mixed  $value
     * @return mixed
     */
    protected function runExpect($expected, $value)
    {
        return (gettype($value) === $expected) ? $value : null;
    }

    /**
     * Check that the value matches the given pattern.
     *
     * @param  string  $pattern
     * @param  string  $value
     * @return mixed
     */
    protected function runMatches($pattern, $value)
    {
        return preg_match($pattern, $value) ? $value : null;
    }

    /**
     * Return the default value if the given value is empty or null.
     *
     * @param  mixed  $default
     * @param  mixed  $value
     * @return mixed
     */
    protected function runDefault($default, $value)
    {
        if (is_string($value) && strlen($value) === 0) {
            return $default;
        } elseif (is_array($value) && empty($value)) {
            return $default;
        }

        return $value ?? $default;
    }

    /**
     * Escape the value with the given function.
     *
     * @param  callable  $func
     * @param  string  $value
     * @return string
     */
    protected function runEscape($func, $value)
    {
        if (! is_string($value)) {
            throw new RunnerException('Cannot escape value of type '.gettype($value));
        }

        $whitelist = [
            'esc_attr',
            'esc_html',
            'esc_js',
            'esc_textarea',
            'esc_url',
            'htmlspecialchars',
            'urlencode',
        ];

        return (in_array($func, $whitelist))
            ? call_user_func($func, $value)
            : $value;
    }

    /**
     * Do shortcodes on the given value.
     *
     * @param  bool  $_
     * @param  mixed  $value
     * @return mixed
     */
    protected function runShortcodes($_, $value)

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

    {
        if (! is_string($value)) {
            throw new RunnerException(
                'Cannot do shortcode on value of type '.gettype($value)
            );
        }

        return do_shortcode($value);
    }
}