{{ message }}
20 | -------------------------------------------------------------------------------- /src/templates/_components/widgets/ElasticraftWidget_settings.twig: -------------------------------------------------------------------------------- 1 | {# 2 | /** 3 | * Elasticraft plugin for Craft CMS 4 | * 5 | * ElasticraftWidget Widget Settings 6 | * 7 | * @author Peter Holme Obrestad 8 | * @copyright Copyright (c) 2017 Peter Holme Obrestad 9 | * @link https://dfo.no 10 | * @package Elasticraft 11 | * @since 1.0.0 12 | */ 13 | #} 14 | 15 | {% import "_includes/forms" as forms %} 16 | 17 | {% do view.registerAssetBundle("dfo\\elasticraft\\assetbundles\\elasticraft\\ElasticraftAsset") %} 18 | 19 | {{ forms.textField({ 20 | label: 'Message', 21 | instructions: 'Enter a message here.', 22 | id: 'message', 23 | name: 'message', 24 | value: widget['message']}) 25 | }} 26 | -------------------------------------------------------------------------------- /src/templates/entriesWidget.twig: -------------------------------------------------------------------------------- 1 | 20 | -------------------------------------------------------------------------------- /src/templates/settings.twig: -------------------------------------------------------------------------------- 1 | {# 2 | /** 3 | * Elasticraft plugin for Craft CMS 3.x 4 | * 5 | * Elasticraft Settings.twig 6 | * 7 | * @author Peter Holme Obrestad 8 | * @copyright Copyright (c) 2017 Peter Holme Obrestad 9 | * @link https://dfo.no 10 | * @package Elasticraft 11 | * @since 1.0.0 12 | */ 13 | #} 14 | 15 | {% import "_includes/forms" as forms %} 16 | 17 | {% do view.registerAssetBundle("dfo\\elasticraft\\assetbundles\\elasticraft\\ElasticraftAsset") %} 18 | 19 |Connection settings
20 | 21 | {{ forms.textField({ 22 | label: 'Elastic host', 23 | instructions: 'Enter Elasticsearch hosts here. Comma separated. Must be fully qualified urls.', 24 | id: 'hosts', 25 | name: 'hosts', 26 | value: settings['hosts']}) 27 | }} 28 | 29 | {{ forms.textField({ 30 | label: 'Elastic index name', 31 | instructions: 'Enter Elasticsearch index name here', 32 | id: 'indexName', 33 | name: 'indexName', 34 | value: settings['indexName']}) 35 | }} 36 | 37 | {# Apparently settings not shown here must be emptied out #} 38 | {{ forms.hidden({ 39 | id: 'transformers', 40 | name: 'transformers', 41 | value: null}) 42 | }} 43 | {{ forms.hidden({ 44 | id: 'indexOptions', 45 | name: 'indexOptions', 46 | value: null}) 47 | }} 48 | 49 |Other settings
50 | 51 |You should also specify indexOptions and transformers. Copy config.php from the plugin directory to elasticraft.php in the Craft main config directory and fill out as necessary.
Hello world.
'; 46 | } 47 | 48 | protected function getBodyText(Entry $entry) 49 | { 50 | // Build raw text body of the document for search 51 | return 'Hello world.'; 52 | } 53 | } -------------------------------------------------------------------------------- /src/translations/en/elasticraft.php: -------------------------------------------------------------------------------- 1 | 'Elasticraft-utvidelsen er innlastet', 25 | 'Last indexed' => 'Last indexed', 26 | 'Indexed date not found. Check your config.' => 'Indexed date not found. Check your config.', 27 | 'Save entry to index it.' => 'Save entry to index it.', 28 | ]; 29 | -------------------------------------------------------------------------------- /src/translations/nb/elasticraft.php: -------------------------------------------------------------------------------- 1 | 'Elasticraft-utvidelsen er innlastet', 25 | 'Last indexed' => 'Sist indeksert', 26 | 'Indexed date not found. Check your config.' => 'Fant ikke indekseringsdato. Sjekk config.', 27 | 'Save entry to index it.' => 'Lagre innlegg for å indeksere det.', 28 | ]; 29 | -------------------------------------------------------------------------------- /src/utilities/ElasticraftUtility.php: -------------------------------------------------------------------------------- 1 | elasticraftService->ping() === false 77 | ||Elasticraft::$plugin->elasticraftService->indexExists() === false 78 | ) return 1; 79 | return 0; 80 | } 81 | 82 | /** 83 | * Returns the utility's content HTML. 84 | * 85 | * @return string 86 | */ 87 | public static function contentHtml(): string 88 | { 89 | Craft::$app->getView()->registerAssetBundle(ElasticraftUtilityUtilityAsset::class); 90 | 91 | return Craft::$app->getView()->renderTemplate( 92 | 'elasticraft/_components/utilities/ElasticraftUtility_content', 93 | [ 94 | 'indexName' => Elasticraft::$plugin->elasticraftService->indexName, 95 | ] 96 | ); 97 | } 98 | } 99 | -------------------------------------------------------------------------------- /src/widgets/ElasticraftWidget.php: -------------------------------------------------------------------------------- 1 | 'Hello, world.'], 96 | ] 97 | ); 98 | return $rules; 99 | } 100 | 101 | /** 102 | * Returns the component’s settings HTML. 103 | * 104 | * An extremely simple implementation would be to directly return some HTML: 105 | * 106 | * ```php 107 | * return ''; 108 | * ``` 109 | * 110 | * For more complex settings, you might prefer to create a template, and render it via 111 | * [[\craft\web\View::renderTemplate()]]. For example, the following code would render a template loacated at 112 | * craft/plugins/myplugin/templates/_settings.html, passing the settings to it: 113 | * 114 | * ```php 115 | * return Craft::$app->getView()->renderTemplate('myplugin/_settings', [ 116 | * 'settings' => $this->getSettings() 117 | * ]); 118 | * ``` 119 | * 120 | * If you need to tie any JavaScript code to your settings, it’s important to know that any `name=` and `id=` 121 | * attributes within the returned HTML will probably get [[\craft\web\View::namespaceInputs() namespaced]], 122 | * however your JavaScript code will be left untouched. 123 | * 124 | * For example, if getSettingsHtml() returns the following HTML: 125 | * 126 | * ```html 127 | * 128 | * 129 | * 132 | * ``` 133 | * 134 | * …then it might actually look like this before getting output to the browser: 135 | * 136 | * ```html 137 | * 138 | * 139 | * 142 | * ``` 143 | * 144 | * As you can see, that JavaScript code will not be able to find the textarea, because the textarea’s `id=` 145 | * attribute was changed from `foo` to `namespace-foo`. 146 | * 147 | * Before you start adding `namespace-` to the beginning of your element ID selectors, keep in mind that the actual 148 | * namespace is going to change depending on the context. Often they are randomly generated. So it’s not quite 149 | * that simple. 150 | * 151 | * Thankfully, [[\craft\web\View]] service provides a couple handy methods that can help you deal 152 | * with this: 153 | * 154 | * - [[\craft\web\View::namespaceInputId()]] will give you the namespaced version of a given ID. 155 | * - [[\craft\web\View::namespaceInputName()]] will give you the namespaced version of a given input name. 156 | * - [[\craft\web\View::formatInputId()]] will format an input name to look more like an ID attribute value. 157 | * 158 | * So here’s what a getSettingsHtml() method that includes field-targeting JavaScript code might look like: 159 | * 160 | * ```php 161 | * public function getSettingsHtml() 162 | * { 163 | * // Come up with an ID value for 'foo' 164 | * $id = Craft::$app->getView()->formatInputId('foo'); 165 | * 166 | * // Figure out what that ID is going to be namespaced into 167 | * $namespacedId = Craft::$app->getView()->namespaceInputId($id); 168 | * 169 | * // Render and return the input template 170 | * return Craft::$app->getView()->renderTemplate('myplugin/_fieldinput', [ 171 | * 'id' => $id, 172 | * 'namespacedId' => $namespacedId, 173 | * 'settings' => $this->getSettings() 174 | * ]); 175 | * } 176 | * ``` 177 | * 178 | * And the _settings.html template might look like this: 179 | * 180 | * ```twig 181 | * 182 | * 183 | * 186 | * ``` 187 | * 188 | * The same principles also apply if you’re including your JavaScript code with 189 | * [[\craft\web\View::registerJs()]]. 190 | * 191 | * @return string|null 192 | */ 193 | public function getSettingsHtml() 194 | { 195 | return Craft::$app->getView()->renderTemplate( 196 | 'elasticraft/_components/widgets/ElasticraftWidget_settings', 197 | [ 198 | 'widget' => $this 199 | ] 200 | ); 201 | } 202 | 203 | /** 204 | * Returns the widget's body HTML. 205 | * 206 | * @return string|false The widget’s body HTML, or `false` if the widget 207 | * should not be visible. (If you don’t want the widget 208 | * to be selectable in the first place, use {@link isSelectable()}.) 209 | */ 210 | public function getBodyHtml() 211 | { 212 | Craft::$app->getView()->registerAssetBundle(ElasticraftWidgetWidgetAsset::class); 213 | 214 | return Craft::$app->getView()->renderTemplate( 215 | 'elasticraft/_components/widgets/ElasticraftWidget_body', 216 | [ 217 | 'message' => $this->message 218 | ] 219 | ); 220 | } 221 | } 222 | --------------------------------------------------------------------------------