ConditionalRules.php

TLDR

This file contains the class ConditionalRules which has methods for determining if rules should be added to an attribute based on a condition, as well as getting the rules and default rules.

Classes

ConditionalRules

This class represents a set of conditional rules that can be added to an attribute. It has the following properties:

• condition (callable|bool): The boolean condition indicating if the rules should be added to the attribute.
• rules (array|string|\Closure): The rules to be added to the attribute.
• defaultRules (array|string|\Closure): The rules to be added to the attribute if the condition fails.

It has the following methods:

__construct($condition, $rules, $defaultRules = [])

Create a new conditional rules instance.

• $condition (callable|bool): The boolean condition indicating if the rules should be added to the attribute.
• $rules (array|string|\Closure): The rules to be added to the attribute.
• $defaultRules (array|string|\Closure): The rules to be added to the attribute if the condition fails.

passes(array $data = [])

Determine if the conditional rules should be added.

• $data (array): The data to evaluate the condition against. Default is an empty array.
• Returns: bool

rules(array $data = [])

Get the rules based on the condition.

• $data (array): The data to evaluate the rules against. Default is an empty array.
• Returns: array

defaultRules(array $data = [])

Get the default rules based on the condition.

• $data (array): The data to evaluate the default rules against. Default is an empty array.
• Returns: array

<?php

namespace Illuminate\Validation;

use Illuminate\Support\Fluent;

class ConditionalRules
{
    /**
     * The boolean condition indicating if the rules should be added to the attribute.
     *
     * @var callable|bool
     */
    protected $condition;

    /**
     * The rules to be added to the attribute.
     *
     * @var array|string|\Closure
     */
    protected $rules;

    /**
     * The rules to be added to the attribute if the condition fails.
     *
     * @var array|string|\Closure
     */
    protected $defaultRules;

    /**
     * Create a new conditional rules instance.
     *
     * @param  callable|bool  $condition
     * @param  array|string|\Closure  $rules
     * @param  array|string|\Closure  $defaultRules
     * @return void
     */
    public function __construct($condition, $rules, $defaultRules = [])
    {
        $this->condition = $condition;
        $this->rules = $rules;
        $this->defaultRules = $defaultRules;
    }

    /**
     * Determine if the conditional rules should be added.
     *
     * @param  array  $data
     * @return bool
     */
    public function passes(array $data = [])
    {
        return is_callable($this->condition)
                    ? call_user_func($this->condition, new Fluent($data))
                    : $this->condition;
    }

    /**
     * Get the rules.
     *
     * @param  array  $data
     * @return array
     */
    public function rules(array $data = [])
    {
        return is_string($this->rules)
                    ? explode('|', $this->rules)
                    : value($this->rules, new Fluent($data));
    }

    /**
     * Get the default rules.
     *
     * @param  array  $data
     * @return array
     */
    public function defaultRules(array $data = [])
    {
        return is_string($this->defaultRules)
                    ? explode('|', $this->defaultRules)
                    : value($this->defaultRules, new Fluent($data));
    }
}