刀片视图模板中使用的所有变量的请求列表

Question

We have a series of blade view templates that are out going emails and would like to create a simple way for our in house administration to preview these emails without actually sending them.

I could keep tract of, and provide filler variables but am very curious if there is a way to request a list of variables used in a view?

For example, I have a basic view "greeting.blade.php" that says:

Dear {{$customerFirstName}} {{$customerLastName}},

I'd like to:

$usedVariablesArray = getVariablesFromView("greeting");

And have it return:

['customerFirstName', 'customerLastName']

Is there anything built into laravel that provides this kind of functionality?

[EDIT] I'd like to do this from outside the view file in question.

public function previewEmailTemplate($templateName) {
    $usedVariables = $getArrayOfVariables($template);
    // Would return ['customerFirstName', 'customerLastName']

    foreach($usedVariables as $aUsedVariable) {
        $dummyValues[$aUsedVariable] = $aUsedVariable;
    }

    return view($template, $dummyValues)->render();
}

So this function would render the template with the variable names in the place of the variables.

Does that make my question clearer?

Answer 1

I also need such function but not find on the net.

I write a simple function to do it.

May help you

greeting.blade.php

Dear {{$customerFirstName}} {{$customerLastName}},

functions.php

function getVariablesFromView($templatePath)
{
    // $templatePath = '/resources/views/mails/greeting.blade.php'
    $contents = file_get_contents($templatePath);

    $re = '/{{[\ ]*\$[a-zA-Z]+[\ ]*}}/m';
    preg_match_all($re, $contents, $matches, PREG_SET_ORDER, 0);
    $flatternArray = [];
    array_walk_recursive($matches, function ($a) use (&$flatternArray) {$flatternArray[] = $a;});
    $variables = str_replace(['{{', '}}', '$', ' '], '', $flatternArray);

    return $variables;
    // ['customerFirstName', 'customerLastName']
}

ps this function doesn't support advanced blade syntax such like @extend('xxx')

Answer 2

Thank you for the first answer to this question 董承樺, my answer is merely an extension of what you wrote to cover slightly more use cases. Feel free to update your answer with this improved code if you like.

Specifically, this version support php variable names that contain underscore like $very_good_variable etc. It also supports the "unescaped" Laravel Blade syntax, which is {., $something_something,.} instead of {{ $something_something }}. Regex is not my strong suit, and I am sure there is way to get this to work with more succint code, but it does seem to work effectively.

function getVariablesFromView(($templatePath){
                        //this version tests for standard blade variables... of the form {{ $something_something }}
                        $re = '/{{[\ ]*\$[a-zA-Z_]+[\ ]*}}/m';
                        preg_match_all($re, $contents, $matches, PREG_SET_ORDER, 0);
                        $flatternArray = [];
                        array_walk_recursive($matches, function ($a) use (&$flatternArray) {$flatternArray[] = $a;});
                        $regular_variables = str_replace(['{{', '}}', '$', ' '], '', $flatternArray);

                        //this version tests for unescaped blade variables... of the form {!! $something_something !!}
                        $re = '/{!![\ ]*\$[a-zA-Z_]+[\ ]*!!}/m';
                        preg_match_all($re, $contents, $matches, PREG_SET_ORDER, 0);
                        $flatternArray = [];
                        array_walk_recursive($matches, function ($a) use (&$flatternArray) {$flatternArray[] = $a;});
                        $unescaped_variables = str_replace(['{!!', '!!}', '$', ' '], '', $flatternArray);

                        $variables = array_merge($regular_variables,$unescaped_variables);
                        return $variables;

}