Allow getDisplayableAttribute() to be used in custom replacers (#18895)

Author: adam-prickett

src/Illuminate/Validation/Concerns/FormatsMessages.php

@@ -205,7 +205,7 @@ public function makeReplacements($message, $attribute, $rule, $parameters)
         );
 
         if (isset($this->replacers[Str::snake($rule)])) {
-            return $this->callReplacer($message, $attribute, Str::snake($rule), $parameters);
+            return $this->callReplacer($message, $attribute, Str::snake($rule), $parameters, $this);
         } elseif (method_exists($this, $replacer = "replace{$rule}")) {
             return $this->$replacer($message, $attribute, $rule, $parameters);
         }
@@ -219,7 +219,7 @@ public function makeReplacements($message, $attribute, $rule, $parameters)
      * @param  string  $attribute
      * @return string
      */
-    protected function getDisplayableAttribute($attribute)
+    public function getDisplayableAttribute($attribute)
     {
         $primaryAttribute = $this->getPrimaryAttribute($attribute);
 
@@ -328,16 +328,17 @@ protected function getAttributeList(array $values)
      * @param  string  $attribute
      * @param  string  $rule
      * @param  array   $parameters
+     * @param  Illuminate\Validation\Validator  $validator
      * @return string|null
      */
-    protected function callReplacer($message, $attribute, $rule, $parameters)
+    protected function callReplacer($message, $attribute, $rule, $parameters, $validator)
     {
         $callback = $this->replacers[$rule];
 
         if ($callback instanceof Closure) {
             return call_user_func_array($callback, func_get_args());
         } elseif (is_string($callback)) {
-            return $this->callClassBasedReplacer($callback, $message, $attribute, $rule, $parameters);
+            return $this->callClassBasedReplacer($callback, $message, $attribute, $rule, $parameters, $validator);
         }
     }
 
@@ -349,9 +350,10 @@ protected function callReplacer($message, $attribute, $rule, $parameters)
      * @param  string  $attribute
      * @param  string  $rule
      * @param  array   $parameters
+     * @param  Illuminate\Validation\Validator  $validator
      * @return string
      */
-    protected function callClassBasedReplacer($callback, $message, $attribute, $rule, $parameters)
+    protected function callClassBasedReplacer($callback, $message, $attribute, $rule, $parameters, $validator)
     {
         list($class, $method) = Str::parseCallback($callback, 'replace');
 

tests/Validation/ValidationValidatorTest.php

@@ -422,6 +422,48 @@ public function testDisplayableValuesAreReplaced()
         $this->assertEquals('type must be included in Short, Long.', $v->messages()->first('type'));
     }
 
+    public function testDisplayableAttributesAreReplacedInCustomReplacers()
+    {
+        $trans = $this->getIlluminateArrayTranslator();
+        $trans->addLines(['validation.alliteration' => ':attribute needs to begin with the same letter as :other'], 'en');
+        $trans->addLines(['validation.attributes.firstname' => 'Firstname'], 'en');
+        $trans->addLines(['validation.attributes.lastname' => 'Lastname'], 'en');
+        $v = new Validator($trans, ['firstname' => 'Bob', 'lastname' => 'Smith'], ['lastname' => 'alliteration:firstname']);
+        $v->addExtension('alliteration', function ($attribute, $value, $parameters, $validator) {
+            $other = array_get($validator->getData(), $parameters[0]);
+
+            return $value{0} == $other{0};
+        });
+        $v->addReplacer('alliteration', function ($message, $attribute, $rule, $parameters, $validator) {
+            return str_replace(':other', $validator->getDisplayableAttribute($parameters[0]), $message);
+        });
+        $this->assertFalse($v->passes());
+        $v->messages()->setFormat(':message');
+        $this->assertEquals('Lastname needs to begin with the same letter as Firstname', $v->messages()->first('lastname'));
+
+        $trans = $this->getIlluminateArrayTranslator();
+        $trans->addLines(['validation.alliteration' => ':attribute needs to begin with the same letter as :other'], 'en');
+        $customAttributes = ['firstname' => 'Firstname', 'lastname' => 'Lastname'];
+        $v = new Validator($trans, ['firstname' => 'Bob', 'lastname' => 'Smith'], ['lastname' => 'alliteration:firstname']);
+        $v->addCustomAttributes($customAttributes);
+        $v->addExtension('alliteration', function ($attribute, $value, $parameters, $validator) {
+            $other = array_get($validator->getData(), $parameters[0]);
+
+            return $value{0} == $other{0};
+        });
+        $v->addReplacer('alliteration', function ($message, $attribute, $rule, $parameters, $validator) {
+            return str_replace(':other', $validator->getDisplayableAttribute($parameters[0]), $message);
+        });
+        $this->assertFalse($v->passes());
+        $v->messages()->setFormat(':message');
+        $this->assertEquals('Lastname needs to begin with the same letter as Firstname', $v->messages()->first('lastname'));
+
+        $trans = $this->getIlluminateArrayTranslator();
+        $trans->addLines(['validation.alliteration' => ':attribute needs to begin with the same letter as :other'], 'en');
+        $customAttributes = ['firstname' => 'Firstname', 'lastname' => 'Lastname'];
+        $v = new Validator($trans, ['firstname' => 'Bob', 'lastname' => 'Smith'], ['lastname' => 'alliteration:firstname']);
+    }
+
     public function testCustomValidationLinesAreRespected()
     {
         $trans = $this->getIlluminateArrayTranslator();