29 | 
32 |
46 |
30 |
31 |
32 | Thanks for using Rich Variables!
33 |Rich Variables allows you to easily use Craft Globals as variables in Rich Text fields.
34 | 35 |For more information, please see the documentation. 36 |
37 |38 | 39 |
40 |41 | 42 | 43 | 44 |
45 |
47 |
51 | {% endblock %}
52 |
--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
1 | Copyright © nystudio107
2 |
3 | Permission is hereby granted to any person obtaining a copy of this software
4 | (the “Software”) to use, copy, modify, merge, publish and/or distribute copies
5 | of the Software, and to permit persons to whom the Software is furnished to do
6 | so, subject to the following conditions:
7 |
8 | 1. **Don’t plagiarize.** The above copyright notice and this license shall be
9 | included in all copies or substantial portions of the Software.
10 |
11 | 2. **Don’t use the same license on more than one project.** Each licensed copy
12 | of the Software shall be actively installed in no more than one production
13 | environment at a time.
14 |
15 | 3. **Don’t mess with the licensing features.** Software features related to
16 | licensing shall not be altered or circumvented in any way, including (but
17 | not limited to) license validation, payment prompts, feature restrictions,
18 | and update eligibility.
19 |
20 | 4. **Pay up.** Payment shall be made immediately upon receipt of any notice,
21 | prompt, reminder, or other message indicating that a payment is owed.
22 |
23 | 5. **Follow the law.** All use of the Software shall not violate any applicable
24 | law or regulation, nor infringe the rights of any other person or entity.
25 |
26 | Failure to comply with the foregoing conditions will automatically and
27 | immediately result in termination of the permission granted hereby. This
28 | license does not include any right to receive updates to the Software or
29 | technical support. Licensees bear all risk related to the quality and
30 | performance of the Software and any modifications made or obtained to it,
31 | including liability for actual and consequential harm, such as loss or
32 | corruption of data, and any necessary service, repair, or correction.
33 |
34 | THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
35 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
36 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
37 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER
38 | LIABILITY, INCLUDING SPECIAL, INCIDENTAL AND CONSEQUENTIAL DAMAGES, WHETHER IN
39 | AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
40 | WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
41 |
--------------------------------------------------------------------------------
/src/controllers/DefaultController.php:
--------------------------------------------------------------------------------
1 | getSettings();
61 | $globalsSet = Craft::$app->getGlobals()->getSetByHandle($settings['globalSetHandle']);
62 | // Grab the first global set if they haven't specified one yet
63 | if (!$globalsSet) {
64 | $allGlobalsSetIds = Craft::$app->getGlobals()->getAllSetIds();
65 | if (!empty($allGlobalsSetIds)) {
66 | $globalsSet = Craft::$app->globals->getSetById($allGlobalsSetIds[0]);
67 | }
68 | }
69 | if ($globalsSet) {
70 | // Get the field layout fields used for this global set
71 | $layout = $globalsSet->getFieldLayout();
72 | if ($layout) {
73 | $fieldLayoutFields = $layout->getFields();
74 | /** @var Field $field */
75 | foreach ($fieldLayoutFields as $field) {
76 | foreach (self::VALID_FIELD_CLASSES as $fieldClass) {
77 | if ($field instanceof $fieldClass) {
78 | // Add the field title and Reference Tag as per https://craftcms.com/docs/reference-tags
79 | $thisVar = [
80 | 'title' => $field->name,
81 | 'text' => '{globalset:' . $globalsSet->attributes['id'] . ':' . $field->handle . '}',
82 | ];
83 | $variablesList[] = $thisVar;
84 | }
85 | }
86 | }
87 | }
88 | }
89 |
90 | // Get the URL to our menu icon from our resource bundle
91 | try {
92 | Craft::$app->getView()->registerAssetBundle(RichVariablesAsset::class);
93 | } catch (InvalidConfigException $e) {
94 | Craft::error($e->getMessage(), __METHOD__);
95 | }
96 | $menuIconUrl = Craft::$app->assetManager->getPublishedUrl(
97 | '@nystudio107/richvariables/web/assets/dist',
98 | true
99 | ) . '/img/RichVariables-menu-icon.svg';
100 |
101 | // Return everything to our JavaScript encoded as JSON
102 | $result['variablesList'] = $variablesList;
103 | $result['menuIconUrl'] = $menuIconUrl;
104 | $result['useIconForMenu'] = $settings['useIconForMenu'];
105 |
106 | return Json::encode($result);
107 | }
108 | }
109 |
--------------------------------------------------------------------------------
/src/redactor/plugins/v2/richvariables.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Rich Variables plugin for Craft CMS
3 | *
4 | * Rich Variables JS
5 | *
6 | * @author nystudio107
7 | * @copyright Copyright (c) 2017 nystudio107
8 | * @link https://nystudio107.com
9 | * @package RichVariables
10 | * @since 1.0.18
11 | */
12 |
13 | (function($R)
14 | {
15 | function setWithExpiry(key, value, ttl) {
16 | const now = new Date()
17 | // `item` is an object which contains the original value
18 | // as well as the time when it's supposed to expire
19 | const item = {
20 | value: value,
21 | expiry: now.getTime() + ttl,
22 | }
23 | localStorage.setItem(key, JSON.stringify(item))
24 | }
25 |
26 | function getWithExpiry(key) {
27 | const itemStr = localStorage.getItem(key)
28 | // if the item doesn't exist, return null
29 | if (!itemStr) {
30 | return null
31 | }
32 | const item = JSON.parse(itemStr)
33 | const now = new Date()
34 | // compare the expiry time of the item with the current time
35 | if (now.getTime() > item.expiry) {
36 | // If the item is expired, delete the item from storage
37 | // and return null
38 | localStorage.removeItem(key)
39 | return null
40 | }
41 | return item.value
42 | }
43 |
44 | $R.add('plugin', 'richvariables', {
45 | translations: {
46 | en: {
47 | "variables": "Variables"
48 | }
49 | },
50 | init: function(app)
51 | {
52 | this.app = app;
53 | this.lang = app.lang;
54 | this.inline = app.inline;
55 | this.toolbar = app.toolbar;
56 | this.insertion = app.insertion;
57 |
58 | // Try to grab the menu from our local storage cache if possible
59 | var cachedResponseVars = getWithExpiry('rich-variables-menu-cache');
60 | if (cachedResponseVars === null) {
61 | // Grab the globals set Reference Tags from our controller
62 | var request = new XMLHttpRequest();
63 | request.open('GET', Craft.getActionUrl('rich-variables'), false);
64 | request.onload = function() {
65 | if (request.status >= 200 && request.status < 400) {
66 | } else {
67 | }
68 | };
69 | request.send();
70 | this.request = request;
71 | }
72 | },
73 | start: function()
74 | {
75 | var dropdown = {};
76 | // Try to grab the menu from our local storage cache if possible
77 | var responseVars = getWithExpiry('rich-variables-menu-cache');
78 | if (responseVars === null && this.request) {
79 | responseVars = JSON.parse(this.request.responseText);
80 | setWithExpiry('rich-variables-menu-cache', responseVars, 60 * 1000)
81 | }
82 | // Iterate through each menu item, adding them to our dropdown
83 | responseVars.variablesList.forEach(function(menuItem, index) {
84 | var key = 'point' + (index + 1);
85 | var refTag = '' + menuItem.text + '';
86 | dropdown[key] = {
87 | title: menuItem.title,
88 | api: 'plugin.richvariables.insert',
89 | args: refTag
90 | };
91 | });
92 | // Handle empty menu items
93 | if (responseVars.variablesList.length === 0) {
94 | dropdown.point1 = {
95 | title: "No Globals Found",
96 | func: function(buttonName) {
97 | // NOP
98 | },
99 | };
100 | }
101 | // Add the button and dropdown
102 | var $button = this.toolbar.addButton('variables', { title: this.lang.get('variables') });
103 | $button.setDropdown(dropdown);
104 | if (responseVars.useIconForMenu) {
105 | $button.setIcon('48 | Brought to you by nystudio107 49 |
50 |