|
1
|
|
|
<?php |
|
2
|
|
|
/** |
|
3
|
|
|
* Twigfield for Craft CMS |
|
4
|
|
|
* |
|
5
|
|
|
* Provides a twig editor field with Twig & Craft API autocomplete |
|
6
|
|
|
* |
|
7
|
|
|
* @link https://nystudio107.com |
|
|
|
|
|
|
8
|
|
|
* @copyright Copyright (c) 2022 nystudio107 |
|
|
|
|
|
|
9
|
|
|
*/ |
|
|
|
|
|
|
10
|
|
|
|
|
11
|
|
|
namespace nystudio107\twigfield\validators; |
|
12
|
|
|
|
|
13
|
|
|
use Craft; |
|
14
|
|
|
use Exception; |
|
15
|
|
|
use nystudio107\twigfield\events\RegisterTwigValidatorVariablesEvent; |
|
16
|
|
|
use yii\base\Model; |
|
17
|
|
|
use yii\validators\Validator; |
|
18
|
|
|
use function is_string; |
|
19
|
|
|
|
|
20
|
|
|
/** |
|
|
|
|
|
|
21
|
|
|
* @author nystudio107 |
|
|
|
|
|
|
22
|
|
|
* @package Twigfield |
|
|
|
|
|
|
23
|
|
|
* @since 1.0.0 |
|
|
|
|
|
|
24
|
|
|
*/ |
|
|
|
|
|
|
25
|
|
|
class TwigObjectTemplateValidator extends Validator |
|
26
|
|
|
{ |
|
27
|
|
|
// Constants |
|
28
|
|
|
// ========================================================================= |
|
29
|
|
|
|
|
30
|
|
|
/** |
|
|
|
|
|
|
31
|
|
|
* @event RegisterTwigValidatorVariablesEvent The event that is triggered to allow |
|
32
|
|
|
* you to register Variables to be passed down to the Twig context during |
|
33
|
|
|
* Twig template validation |
|
34
|
|
|
* |
|
35
|
|
|
* ```php |
|
36
|
|
|
* use nystudio107\twigfield\validators\TwigTemplateValidator; |
|
37
|
|
|
* use nystudio107\twigfield\events\RegisterTwigValidatorVariablesEvent; |
|
38
|
|
|
* use yii\base\Event; |
|
39
|
|
|
* |
|
40
|
|
|
* Event::on(TwigTemplateValidator::class, |
|
41
|
|
|
* TwigTemplateValidator::EVENT_REGISTER_TWIG_VALIDATOR_VARIABLES, |
|
42
|
|
|
* function(RegisterTwigValidatorVariablesEvent $event) { |
|
43
|
|
|
* $event->object = $myObject; |
|
44
|
|
|
* $event->variables['variableName'] = $variableValue; |
|
45
|
|
|
* } |
|
46
|
|
|
* ); |
|
47
|
|
|
* ``` |
|
48
|
|
|
*/ |
|
49
|
|
|
const EVENT_REGISTER_TWIG_VALIDATOR_VARIABLES = 'registerTwigValidatorVariables'; |
|
50
|
|
|
|
|
51
|
|
|
/** |
|
|
|
|
|
|
52
|
|
|
* @var mixed The object that should be passed into `renderObjectTemplate()` during the template rendering |
|
53
|
|
|
*/ |
|
54
|
|
|
public $object = null; |
|
55
|
|
|
|
|
56
|
|
|
/** |
|
|
|
|
|
|
57
|
|
|
* @var array Variables in key => value format that should be available during the template rendering |
|
58
|
|
|
*/ |
|
59
|
|
|
public $variables = []; |
|
60
|
|
|
|
|
61
|
|
|
// Public Methods |
|
62
|
|
|
// ========================================================================= |
|
63
|
|
|
|
|
64
|
|
|
/** |
|
|
|
|
|
|
65
|
|
|
* @inheritdoc |
|
66
|
|
|
*/ |
|
|
|
|
|
|
67
|
|
|
public function validateAttribute($model, $attribute) |
|
68
|
|
|
{ |
|
69
|
|
|
/** @var Model $model */ |
|
|
|
|
|
|
70
|
|
|
$value = $model->$attribute; |
|
71
|
|
|
$error = null; |
|
72
|
|
|
if (!empty($value) && is_string($value)) { |
|
73
|
|
|
try { |
|
74
|
|
|
$event = new RegisterTwigValidatorVariablesEvent([ |
|
|
|
|
|
|
75
|
|
|
'object' => $this->object, |
|
76
|
|
|
'variables' => $this->variables, |
|
77
|
|
|
]); |
|
|
|
|
|
|
78
|
|
|
$this->trigger(self::EVENT_REGISTER_TWIG_VALIDATOR_VARIABLES, $event); |
|
79
|
|
|
Craft::$app->getView()->renderObjectTemplate($value, $event->object, $event->variables); |
|
80
|
|
|
} catch (Exception $e) { |
|
81
|
|
|
$error = Craft::t( |
|
82
|
|
|
'twigfield', |
|
83
|
|
|
'Error rendering template string -> {error}', |
|
84
|
|
|
['error' => $e->getMessage()] |
|
85
|
|
|
); |
|
86
|
|
|
} |
|
87
|
|
|
} else { |
|
88
|
|
|
$error = Craft::t('twigfield', 'Is not a string.'); |
|
89
|
|
|
} |
|
90
|
|
|
// If there's an error, add it to the model, and log it |
|
91
|
|
|
if ($error) { |
|
92
|
|
|
$model->addError($attribute, $error); |
|
93
|
|
|
Craft::error($error, __METHOD__); |
|
94
|
|
|
} |
|
95
|
|
|
} |
|
96
|
|
|
} |
|
97
|
|
|
|
nystudio107 /
craft-twigfield
Loading history...