|
1
|
|
|
<?php |
|
2
|
|
|
/** |
|
3
|
|
|
* Copyright (c) 2014 Roave, LLC. |
|
4
|
|
|
* All rights reserved. |
|
5
|
|
|
* |
|
6
|
|
|
* Redistribution and use in source and binary forms, with or without |
|
7
|
|
|
* modification, are permitted provided that the following conditions |
|
8
|
|
|
* are met: |
|
9
|
|
|
* |
|
10
|
|
|
* * Redistributions of source code must retain the above copyright |
|
11
|
|
|
* notice, this list of conditions and the following disclaimer. |
|
12
|
|
|
* |
|
13
|
|
|
* * Redistributions in binary form must reproduce the above copyright |
|
14
|
|
|
* notice, this list of conditions and the following disclaimer in |
|
15
|
|
|
* the documentation and/or other materials provided with the |
|
16
|
|
|
* distribution. |
|
17
|
|
|
* |
|
18
|
|
|
* * Neither the names of the copyright holders nor the names of the |
|
19
|
|
|
* contributors may be used to endorse or promote products derived |
|
20
|
|
|
* from this software without specific prior written permission. |
|
21
|
|
|
* |
|
22
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
|
23
|
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
|
24
|
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS |
|
25
|
|
|
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE |
|
26
|
|
|
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, |
|
27
|
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, |
|
28
|
|
|
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
|
29
|
|
|
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
|
30
|
|
|
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
|
31
|
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN |
|
32
|
|
|
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
|
33
|
|
|
* POSSIBILITY OF SUCH DAMAGE. |
|
34
|
|
|
* |
|
35
|
|
|
* @author Antoine Hedgecock |
|
36
|
|
|
* |
|
37
|
|
|
* @copyright 2014 Roave, LLC |
|
38
|
|
|
* @license http://www.opensource.org/licenses/bsd-license.php BSD License |
|
39
|
|
|
*/ |
|
40
|
|
|
|
|
41
|
|
|
namespace Roave\EmailTemplates\Options; |
|
42
|
|
|
|
|
43
|
|
|
use Zend\Stdlib\AbstractOptions; |
|
44
|
|
|
|
|
45
|
|
|
/** |
|
46
|
|
|
* Class TemplateServiceOptions |
|
47
|
|
|
* |
|
48
|
|
|
* Contains all the available configuration for the template service |
|
49
|
|
|
* |
|
50
|
|
|
* @property string $engine |
|
51
|
|
|
* @property string $defaultSubject |
|
52
|
|
|
* @property string $defaultBody |
|
53
|
|
|
*/ |
|
54
|
|
|
class TemplateServiceOptions extends AbstractOptions |
|
55
|
|
|
{ |
|
56
|
|
|
/** |
|
57
|
|
|
* The name of the engine to use for rendering |
|
58
|
|
|
* |
|
59
|
|
|
* @var string |
|
60
|
|
|
*/ |
|
61
|
|
|
protected $engine = 'twig'; |
|
62
|
|
|
|
|
63
|
|
|
/** |
|
64
|
|
|
* @var bool |
|
65
|
|
|
*/ |
|
66
|
|
|
protected $alwaysUpdateParameters = false; |
|
67
|
|
|
|
|
68
|
|
|
/** |
|
69
|
|
|
* Default subject set on all template on initial creation |
|
70
|
|
|
* |
|
71
|
|
|
* @var string |
|
72
|
|
|
*/ |
|
73
|
|
|
protected $defaultSubject = 'Subject has not yet been set'; |
|
74
|
|
|
|
|
75
|
|
|
/** |
|
76
|
|
|
* Default body set on all templates on initial creation |
|
77
|
|
|
* |
|
78
|
|
|
* @var string |
|
79
|
|
|
*/ |
|
80
|
|
|
protected $defaultBody = 'This is the default message for the template with id: %s,locale: %s'; |
|
81
|
|
|
|
|
82
|
|
|
/** |
|
83
|
|
|
* Set predefined parameters that will exist in all templates |
|
84
|
|
|
* |
|
85
|
|
|
* @var array |
|
86
|
|
|
*/ |
|
87
|
|
|
protected $predefinedParams = []; |
|
88
|
|
|
|
|
89
|
|
|
/** |
|
90
|
|
|
* @return bool |
|
91
|
|
|
*/ |
|
92
|
|
|
public function isAlwaysUpdateParameters(): bool |
|
93
|
|
|
{ |
|
94
|
|
|
return $this->alwaysUpdateParameters; |
|
95
|
|
|
} |
|
96
|
|
|
|
|
97
|
|
|
/** |
|
98
|
|
|
* @param bool $alwaysUpdateParameters |
|
99
|
|
|
*/ |
|
100
|
|
|
public function setAlwaysUpdateParameters(bool $alwaysUpdateParameters): void |
|
101
|
|
|
{ |
|
102
|
|
|
$this->alwaysUpdateParameters = $alwaysUpdateParameters; |
|
103
|
|
|
} |
|
104
|
|
|
|
|
105
|
|
|
/** |
|
106
|
|
|
* @param string $defaultBody |
|
107
|
|
|
*/ |
|
108
|
1 |
|
public function setDefaultBody(string $defaultBody): void |
|
109
|
|
|
{ |
|
110
|
1 |
|
$this->defaultBody = $defaultBody; |
|
111
|
1 |
|
} |
|
112
|
|
|
|
|
113
|
|
|
/** |
|
114
|
|
|
* @return string |
|
115
|
|
|
*/ |
|
116
|
1 |
|
public function getDefaultBody(): string |
|
117
|
|
|
{ |
|
118
|
1 |
|
return $this->defaultBody; |
|
119
|
|
|
} |
|
120
|
|
|
|
|
121
|
|
|
/** |
|
122
|
|
|
* @param string $defaultSubject |
|
123
|
|
|
*/ |
|
124
|
1 |
|
public function setDefaultSubject(string $defaultSubject): void |
|
125
|
|
|
{ |
|
126
|
1 |
|
$this->defaultSubject = $defaultSubject; |
|
127
|
1 |
|
} |
|
128
|
|
|
|
|
129
|
|
|
/** |
|
130
|
|
|
* @return string |
|
131
|
|
|
*/ |
|
132
|
1 |
|
public function getDefaultSubject(): string |
|
133
|
|
|
{ |
|
134
|
1 |
|
return $this->defaultSubject; |
|
135
|
|
|
} |
|
136
|
|
|
|
|
137
|
|
|
/** |
|
138
|
|
|
* @param string $engine |
|
139
|
|
|
*/ |
|
140
|
1 |
|
public function setEngine(string $engine): void |
|
141
|
|
|
{ |
|
142
|
1 |
|
$this->engine = $engine; |
|
143
|
1 |
|
} |
|
144
|
|
|
|
|
145
|
|
|
/** |
|
146
|
|
|
* @return string |
|
147
|
|
|
*/ |
|
148
|
1 |
|
public function getEngine(): string |
|
149
|
|
|
{ |
|
150
|
1 |
|
return $this->engine; |
|
151
|
|
|
} |
|
152
|
|
|
|
|
153
|
|
|
/** |
|
154
|
|
|
* @param array $predefinedParams |
|
155
|
|
|
*/ |
|
156
|
1 |
|
public function setPredefinedParams(array $predefinedParams): void |
|
157
|
|
|
{ |
|
158
|
1 |
|
$this->predefinedParams = $predefinedParams; |
|
159
|
1 |
|
} |
|
160
|
|
|
|
|
161
|
|
|
/** |
|
162
|
|
|
* @return array |
|
163
|
|
|
*/ |
|
164
|
1 |
|
public function getPredefinedParams(): array |
|
165
|
|
|
{ |
|
166
|
1 |
|
return $this->predefinedParams; |
|
167
|
|
|
} |
|
168
|
|
|
} |
|
169
|
|
|
|
Roave /
EmailTemplates
