Jump to content
owzim

Inputfield ACE Extended

Recommended Posts

Sounds good - could you post it as an issue on github? So I won't forget it :)

Share this post


Link to post
Share on other sites

just tried your module and i love it! great for my geowire project where i'm working on an update right now. i wanted to suggest a fullscreen mode, but i saw it's already on your roadmap... +1 for that. would really be great :)

thanks for the awesome work!

Share this post


Link to post
Share on other sites

Maybe this can be useful to people. It replaces a normal textarea in the backend with an ace instance.

class AdminHelper extends WireData implements Module{

	const phpFirstLine = "<?php //autmatically added but not saved";

	public function init() {
		// Inputfield Ace Extended for editing page fields
		$this->addHookAfter('InputfieldPage::getConfigInputfields', $this, 'makePHPFieldACEField');
		$this->addHookBefore('ProcessField::executeSave', $this, 'removeLeadingTag');
	}

	public function makePHPFieldACEField($event){
		$form = $event->return;

		$field = $form->get("findPagesCode");

    $ace = $this->modules->get("InputfieldAceExtended");
    // foreach (get_object_vars($field) as $key => $name) {
    //     $obj->$key = $name;
    // }
    $ace->setAttributes($field->getAttributes());
    $ace->setArray($field->getArray());
		$ace->modes = array("php");
		$linecount = substr_count($ace->attr("value"), "\n");

		// Preserve collapsed mode and do not add when build for saving
		if($ace->attr("value") !== "" && !$this->input->post->findPagesCode)
			$ace->attr("value", self::phpFirstLine."\n\n".$ace->attr("value"));
		$ace->rows = $linecount ? $linecount : 4;

		$field->parent->insertAfter($ace, $field);
		$field->parent->remove($field);

		$event->return = $form;
	}

	public function removeLeadingTag($event){
		if($this->input->post->findPagesCode && strpos($this->input->post->findPagesCode, self::phpFirstLine) !== false){
			$this->input->post->findPagesCode = trim(str_replace(self::phpFirstLine, "", $this->input->post->findPagesCode));
		}
	}
}
Edited by LostKobrakai
Small update
  • Like 2

Share this post


Link to post
Share on other sites

pretty interesting - what would be a good use case for this method, as opposed to making the field itself an AceExtended field? I might be being thick, but am not getting that...

  • Like 1

Share this post


Link to post
Share on other sites

The custom php code field for page fields is sometimes a little more complex on a current project and I wanted it to sport an better editing interface and syntax highlighting. My module does convert the standart textarea there to an ace textarea. There isn't a field behind this form, where one could simply change the inputfielClass for. So it's useful for all the process module forms.

Share this post


Link to post
Share on other sites

got it now- that is super cool and useful!!

Share this post


Link to post
Share on other sites

hi owzim,

i've used your module in the past quite a lot without problems. thank you for that. :)

now i tried to use it in the new matrix repeater on 3.0.12 and this is what it looks like:

post-2137-0-07256300-1458818415_thumb.pn

seems to work fine with 3.0.12 when you add it in the normal way to a template. in the repeater it does not support code highlighting and also the settings will get lost on save.

any chance that we get an update on this? although i have to say it is not critical for me as this is only ment to copy&paste some code to my blog and i will not write much code directly there...

edit: note that i also tried setting "PHP" not "plain text" as the screenshot shows...

  • Like 2

Share this post


Link to post
Share on other sites

Am I correct in assuming that this replaces Adam's version completely?

If so, I think it might be good to contact the ACE folks and get them to change the link on this page: https://ace.c9.io/#nav=production

Share this post


Link to post
Share on other sites

By default ACE requires an opening PHP tag for syntax highlighting to work, even when set to PHP mode. But there is an 'inline' mode that enables highlighting without needing the opening tag: https://github.com/ajaxorg/ace/issues/2542

Is it possible to set this inline mode via the API for Inputfield ACE Extended?

 

Share this post


Link to post
Share on other sites

@Robin S thanks for the report. I will add an extra json settings field for modes in the field config. I am sick right now but I'll look into it, later this week.

Edit: Can't test right now, but you might be able to set this in the advanced options of the field config.

  • Like 1

Share this post


Link to post
Share on other sites
15 minutes ago, owzim said:

I will add an extra json settings field for modes in the field config. I am sick right now but I'll look into it, later this week.

Thanks! Hope you feel better soon.

39 minutes ago, owzim said:

edit: can't test right now, but you might be able setting this in the advanced settings of the field config.

I tried a few things but I don't have a good grasp of how the recommended way to set inline mode...

session.setMode({path:"ace/mode/php", inline:true})

...relates to the module's implementation of Ace. The only thing I could find relating to the PHP inline mode is in mode-php.js:

...
"ace/mode/php-inline"
...

So maybe this is an alternative way to set PHP inline mode? Hard to make sense of it with the source being minified.

Share this post


Link to post
Share on other sites

Great plug in.  Working great.  Noticed an issue when trying to use it on a multi language textarea.  I only put html in the "English" field and after save this is what you get.  No big deal I just wanted to make you aware of it if you weren't already.

(see attached screen shot)5981f48995689_ScreenShot2017-08-02at10_47_02AM.thumb.png.67ffcd6ed434a54307433a78204865b8.png

Share this post


Link to post
Share on other sites

Hi - i'm not sure if @owzim is around, i don't have a multilanguage testing environment at the moment so might take a while to fix this; looks like a css issue, and possibly not that hard to fix..

Share this post


Link to post
Share on other sites

I agree probably CSS.  If I get a chance I'll dig through the issue deeper and see what I can come up with.  

Thanks for the reply, Macrura

  • Like 1

Share this post


Link to post
Share on other sites
On 3/24/2016 at 2:22 PM, bernhard said:

i tried to use it in the new matrix repeater on 3.0.12 and this is what it looks like:

post-2137-0-07256300-1458818415_thumb.pn

I'm having the same issue.

It appears that this happens because Repeater fields add new items using AJAX, and InputfieldAceExtended loads its scripts with $config->scripts in render() method. But it doesnt work as PW does not consider rendering the scripts in $config->scripts when loading an input with AJAX. Quick solution is to append <script> and <link> or <style> tags after inputfield markup. From a quick search, native and profields don't seem to have this issue because they use the scripts that are loaded on backend by default.

I think solution is up to @ryan at this point. When rendering the field PW should output scripts & styles too.

// InputfieldWrapper.php
public function ___renderInputfield(Inputfield $inputfield, $renderValueMode = false) {
    // ...
    if($ajaxInputfield) {
        
        $inputfieldID = $inputfield->attr('id');
        
        if($ajaxID && $ajaxID == $inputfieldID) {
            // render ajax inputfield
            $editable = $inputfield->editable();
            if($renderValueMode || !$editable) {
                echo $inputfield->renderValue();
            } else {
                echo $inputfield->render();
                echo "<input type='hidden' name='processInputfieldAjax[]' value='$inputfieldID' />";
                // Get scripts from $this->config->scripts and output to browser
            }
            exit;
        //...

 

  • Like 3

Share this post


Link to post
Share on other sites

I might be wrong but I think scripts get loaded when added inside the init method of the inputfield

Share this post


Link to post
Share on other sites
42 minutes ago, abdus said:

From a quick search, native and profields don't seem to have this issue because they use the scripts that are loaded on backend by default.

10 minutes ago, bernhard said:

I might be wrong but I think scripts get loaded when added inside the init method of the inputfield

I believe this is what Inputfield::renderReady() is for: adding dependencies to $config->scripts and $config->styles, and also adding JS objects to ProcessWire.config via $config->js().

But I think all this is not well understood by module developers, myself included. Would be great to get a tutorial some time, maybe in a weekly blog post @ryan?

 

  • Like 2

Share this post


Link to post
Share on other sites

For inputs that are loaded without ajax, scripts work fine, because they're served inside the whole page markup

But for ajax inputs that's not the case.

Here's the response to an AJAX request. I removed class, id, name, and for attributes because they were taking up too much space. The only script is at the end which initializes tabs and submit buttons.

Spoiler

<p>1024</p>
<form>
    <ul uk-grid>
        <li>
            <label><i></i> Content<i></i></label>
            <div>
                <ul uk-grid>
                    <li>
                        <label><span>Markdown {&bull; New}</span><i></i></label>
                        <div>
                            <ul uk-grid>
                                <li><label>loaded_repeater1114<i></i></label><div><input value="1" type="hidden" /></div></li>
                                <li><label>Sort<i></i></label><div><input value="0" type="hidden" /></div></li>
                                <li><label><span>Delete<i></i></span></label><div><label><input type='checkbox' value="1114" /><span>Delete</span></label></div></li>
                                <li><label>publish_repeater1114<i></i></label><div><input value="1" type="hidden" /></div></li>
                                <li>
                                    <ul uk-grid>
                                        <li><label><i></i> Content<i></i></label><div>
                                            <div data-input data-field>
                                                    <ul uk-grid>
                                                        <li><label><i></i> Options<i></i></label>
                                                            <div><span><span>Theme</span> <span><select><option
                                                                    value='tomorrow'>Tomorrow</option><option
                                                                    value='chrome'>Chrome</option><option
                                                                    value='monokai'>Monokai</option><option
                                                                    value='twilight'>Twilight</option></select></span></span><span><span>Language</span> <span><select><option value='plain_text'>Plain Text</option><option
                                                                    value='css'>CSS</option><option
                                                                    value='html'>HTML</option><option
                                                                    value='javascript'>JavaScript</option><option
                                                                    value='json'>JSON</option><option value='markdown'>Markdown</option><option
                                                                    value='php'>PHP</option><option
                                                                    value='yaml'>YAML</option><option value='python'>Python</option></select></span></span><span><span>Font size</span> <span><input
                                                                    value="14" type="number"
                                                                    min="10" max="28"
                                                                    size="10"/></span></span>
                                                            </div></li></ul><div>
                                                        <div></div>
                                                    </div>
                                                    <textarea rows="5"></textarea>
                                            </div>
                                        </div></li></ul></li></ul></div></li></ul></div></li>
        <li><div><button value="Save" type="submit"><span>Save</span></button></div></li>
        <li><label>id<i></i></label><div><input value="1024" type="hidden" /></div></li>
    </ul>
    <input type='hidden' value='Wbzssyv52R1o8qZzfEHZRFjKz/pwLU9b' />
</form>
<script>
    initPageEditForm();
</script>

 

Share this post


Link to post
Share on other sites

For inputs that are loaded without ajax, scripts work fine, because they're served inside the whole page markup

But for ajax inputs that's not the case.

Here's the response to an AJAX request. I removed class, id, name, and for attributes because they were taking up too much space. The only script is at the end which initializes tabs and submit buttons.

Spoiler

<p>1024</p>
<form>
    <ul uk-grid>
        <li>
            <label><i></i> Content<i></i></label>
            <div>
                <ul uk-grid>
                    <li>
                        <label><span>Markdown {&bull; New}</span><i></i></label>
                        <div>
                            <ul uk-grid>
                                <li><label>loaded_repeater1114<i></i></label><div><input value="1" type="hidden" /></div></li>
                                <li><label>Sort<i></i></label><div><input value="0" type="hidden" /></div></li>
                                <li><label><span>Delete<i></i></span></label><div><label><input type='checkbox' value="1114" /><span>Delete</span></label></div></li>
                                <li><label>publish_repeater1114<i></i></label><div><input value="1" type="hidden" /></div></li>
                                <li>
                                    <ul uk-grid>
                                        <li><label><i></i> Content<i></i></label><div>
                                            <div data-input data-field>
                                                    <ul uk-grid>
                                                        <li><label><i></i> Options<i></i></label>
                                                            <div><span><span>Theme</span> <span><select><option
                                                                    value='tomorrow'>Tomorrow</option><option
                                                                    value='chrome'>Chrome</option><option
                                                                    value='monokai'>Monokai</option><option
                                                                    value='twilight'>Twilight</option></select></span></span><span><span>Language</span> <span><select><option value='plain_text'>Plain Text</option><option
                                                                    value='css'>CSS</option><option
                                                                    value='html'>HTML</option><option
                                                                    value='javascript'>JavaScript</option><option
                                                                    value='json'>JSON</option><option value='markdown'>Markdown</option><option
                                                                    value='php'>PHP</option><option
                                                                    value='yaml'>YAML</option><option value='python'>Python</option></select></span></span><span><span>Font size</span> <span><input
                                                                    value="14" type="number"
                                                                    min="10" max="28"
                                                                    size="10"/></span></span>
                                                            </div></li></ul><div>
                                                        <div></div>
                                                    </div>
                                                    <textarea rows="5"></textarea>
                                            </div>
                                        </div></li></ul></li></ul></div></li></ul></div></li>
        <li><div><button value="Save" type="submit"><span>Save</span></button></div></li>
        <li><label>id<i></i></label><div><input value="1024" type="hidden" /></div></li>
    </ul>
    <input type='hidden' value='Wbzssyv52R1o8qZzfEHZRFjKz/pwLU9b' />
</form>
<script>
    initPageEditForm();
</script>

 

Share this post


Link to post
Share on other sites
7 minutes ago, Robin S said:

I believe this is what Inputfield::renderReady() is for: adding dependencies to $config->scripts and $config->styles, and also adding JS objects to ProcessWire.config via $config->js().

True, but still, inside InputfieldWrapper.php where a field is determined to be rendered with ajax or not, it calls renderReady(), it has no effect because Inputfield::renderReady() still uses $config->styles and $config->scripts (via Modules::loadModuleFileAssets() method), and only the inputfield markup is output to the browser.

//  InputfieldWrapper::renderInputfield
$inputfield->renderReady($this, $renderValueMode);
// ...
if($ajaxID && $ajaxID == $inputfieldID) {
    // render ajax inputfield
    $editable = $inputfield->editable();
    if($renderValueMode || !$editable) {
        echo $inputfield->renderValue();
    } else {
        echo $inputfield->render();
        echo "<input type='hidden' name='processInputfieldAjax[]' value='$inputfieldID' />";
    }
    exit;

}

 

// Inputfield.php
public function renderReady(Inputfield $parent = null, $renderValueMode = false) {
   if($parent) {}
   if($renderValueMode) {}
   $result = $this->wire('modules')->loadModuleFileAssets($this) > 0;
   if($this->wire('hooks')->isMethodHooked($this, 'renderReadyHook')) {
      $this->renderReadyHook($parent, $renderValueMode);
   }
   return $result;
}

 

// Modules.php
/**
 * Load module related CSS and JS files (where applicable)
 * 
 * - Applies only to modules that carry class-named CSS and/or JS files, such as Process, Inputfield and ModuleJS modules. 
 * - Assets are populated to `$config->styles` and `$config->scripts`.
 * 
 * #pw-internal
 * 
 * @param Module|int|string $module Module object or class name
 * @return array Returns number of files that were added
 * 
 */
public function loadModuleFileAssets($module) {}

Share this post


Link to post
Share on other sites
17 minutes ago, abdus said:

True, but still, inside InputfieldWrapper.php where a field is determined to be rendered with ajax or not, it calls renderReady(), it has no effect because Inputfield::renderReady() still uses $config->styles and $config->scripts (via Modules::loadModuleFileAssets() method), and only the inputfield markup is output to the browser.

You'd think so, but test it and I think you'll find that assets added in renderReady() are always loaded when the inputfield may appear in Page Edit, even if AJAX-loaded. So for example, you can put an inputfield with a JS dependency such as PageAutocomplete in a repeater, and put that repeater inside another repeater (so the PageAutocomplete inputfield is definitely not being rendered initially) and you'll find that the PageAutocomplete JS dependency is included in Page Edit. PW seems to be smart like that.

  • Like 2

Share this post


Link to post
Share on other sites
1 hour ago, Robin S said:

So for example, you can put an inputfield with a JS dependency such as PageAutocomplete in a repeater, and put that repeater inside another repeater (so the PageAutocomplete inputfield is definitely not being rendered initially) and you'll find that the PageAutocomplete JS dependency is included in Page Edit. PW seems to be smart like that.

Hmm, you're right. Scripts are output inside <head> during page load.

Then it's developer's responsibility to make sure that inputfields are initialized correctly. This requires a <script> tag to be appended to inputfield markup, which sets up the inputfield with given ID. This would also mean having to save the state somewhere (data attributes, ProcessWire.config etc) to prevent initializing an inputfield twice. Or using a library to listen to DOM mutations and initializing the inputfields inside.

https://github.com/muicss/sentineljs

I agree that a guideline/tutorial from @ryan would be great.

  • Like 2

Share this post


Link to post
Share on other sites

in my last update from InputfieldHandsontable I inject the scripts in the init method: https://gitlab.com/baumrock/FieldtypeHandsontable/blob/master/InputfieldHandsontable.module#L26-35

field-specific CSS is loaded inside the render method with jquery like this: https://gitlab.com/baumrock/FieldtypeHandsontable/blob/master/InputfieldHandsontable.module#L61-69

+1 for a comprehensive tutorial on this :)

thanks @abdus sentineljs looks nice!

  • Like 2

Share this post


Link to post
Share on other sites

Hi, I ran into this issue a while back and remember fixing it but haven't pushed to master. I will have to look into it. I think it might work on the dev branch, not sure though.

Edit: yup it's fixed on the dev branch. I use it on a production site, but I appreciate any quick testing in your environments, so that I can merge it into master, if no further issues arise.

Thanks for reporting!

  • Like 1

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By joshua
      This module is (yet another) way for implementing a cookie management solution.
      Of course there are several other possibilities:
      - https://processwire.com/talk/topic/22920-klaro-cookie-consent-manager/
      - https://github.com/webmanufaktur/CookieManagementBanner
      - https://github.com/johannesdachsel/cookiemonster
      - https://www.oiljs.org/
      - ... and so on ...
      In this module you can configure which kind of cookie categories you want to manage:

      You can also enable the support for respecting the Do-Not-Track (DNT) header to don't annoy users, who already decided for all their browsing experience.
      Currently there are four possible cookie groups:
      - Necessary (always enabled)
      - Statistics
      - Marketing
      - External Media
      All groups can be renamed, so feel free to use other cookie group names. I just haven't found a way to implement a "repeater like" field as configurable module field ...
      When you want to load specific scripts ( like Google Analytics, Google Maps, ...) only after the user's content to this specific category of cookies, just use the following script syntax:
      <script type="text/plain" data-type="text/javascript" data-category="statistics" data-src="/path/to/your/statistic/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="marketing" data-src="/path/to/your/mareketing/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="external_media" data-src="/path/to/your/external-media/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="marketing">console.log("Inline scripts are also working!");</script> The type has to be "optin" to get recognized by PrivacyWire, the data-attributes are giving hints, how the script shall be loaded, if the data-category is within the cookie consents of the user. These scripts are loaded asynchronously after the user made the decision.
      If you want to give the users the possibility to change their consent, you can use the following Textformatter:
      [[privacywire-choose-cookies]] It's planned to add also other Textformatters to opt-out of specific cookie groups or delete the whole consent cookie.
      You can also add a custom link to output the banner again with a link / button with following class:
      <a href="#" class="privacywire-show-options">Show Cookie Options</a> <button class="privacywire-show-options">Show Cookie Options</button> This module is still in development, but we already use it on several production websites.
      You find it here: PrivacyWire Git Repo
      Download as .zip
      I would love to hear your feedback 🙂
      CHANGELOG
      0.1.1 Debugging: fixed error during uninstall 0.1.0 Added new detection of async scripts for W3C Validation 0.0.6 CSS-Debugging for hiding unused buttons, added ProCache support for the JavaScript tag 0.0.5 Multi-language support included completely (also in TextFormatter). Added possibility to async load other assets (e.g. <img type="optin" data-category="marketing" data-src="https://via.placeholder.com/300x300">) 0.0.4 Added possibility to add an imprint link to the banner 0.0.3 Multi-language support for module config (still in development) 0.0.2 First release 0.0.1 Early development
    • By bernhard
      --- Please use RockFinder3 ---
    • By MoritzLost
      Cacheable Placeholders
      This module allows you to have pieces of dynamic content inside cached output. This aims to solve the common problem of having a mostly cacheable site, but with pieces of dynamic output here and there.  Consider this simple example, where you want to output a custom greeting to the current user:
      <h1>Good morning, <?= ucfirst($user->name) ?></h1> This snippet means you can't use the template cache (at least for logged-in users), because each user has a different name. Even if 99% of your output is static, you can only cache the pieces that you know won't include this personal greeting. A more common example would be CSRF tokens for HTML forms - those need to be unique by definition, so you can't cache the form wholesale.
      This module solves this problem by introducing cacheable placeholders - small placeholder tokens that get replaced during every request. The replacement is done inside a Page::render hook so it runs during every request, even if the response is served from the template cache. So you can use something like this:
      <h1>Good morning, {{{greeting}}}</h1> Replacement tokens are defined with a callback function that produces the appropriate output and added to the module through a simple hook:
      // site/ready.php wire()->addHookAfter('CachePlaceholders::getTokens', function (HookEvent $e) { $tokens = $e->return; $tokens['greeting'] = [ 'callback' => function (array $tokenData) { return ucfirst(wire('user')->name); } ]; $e->return = $tokens; }); Tokens can also include parameters that are parsed and passed to the callback function. There are more fully annotated examples and step-by-step instructions in the README on Github!
      Features
      A simple and fast token parser that calls the appropriate callback and runs automatically. Tokens may include multiple named or positional parameters, as well as multi-value parameters. A manual mode that allows you to replace tokens in custom pieces of cached content (useful if you're using the $cache API). Some built-in tokens for common use-cases: CSRF-Tokens, replacing values from superglobals and producing random hexadecimal strings. The token format is completely customizable, all delimiters can be changed to avoid collisions with existing tag parsers or template languages. Links
      Github Repository & documentation Module directory (pending approval) If you are interested in learning more, the README is very extensive, with more usage examples, code samples and usage instructions!
    • By Craig
      I've been using Fathom Analytics for a while now and on a growing number of sites, so thought it was about time there was a PW module for it.
      WayFathomAnalytics
      WayFathomAnalytics is a group of modules which will allow you to view your Fathom Analytics dashboard in the PW admin panel and (optionally) automatically add and configure the tracking code on front-end pages.
      Links
      GitHub Readme & documentation Download Zip Modules directory Module settings screenshot What is Fathom Analytics?
      Fathom Analytics is a simple, privacy-focused website analytics tool for bloggers and businesses.

      Stop scrolling through pages of reports and collecting gobs of personal data about your visitors, both of which you probably don't need. Fathom is a simple and private website analytics platform that lets you focus on what's important: your business.
      Privacy focused Fast-loading dashboards, all data is on a single screen Easy to get what you need, no training required Unlimited email reports Private or public dashboard sharing Cookie notices not required (it doesn't use cookies or collect personal data) Displays: top content, top referrers, top goals and more
    • By daniels
      This is a lightweight alternative to other newsletter & newsletter-subscription modules.
      You can find the Module in the Modules directory and on Github
      It can subscribe, update, unsubscribe & delete a user in a list in Mailchimp with MailChimp API 3.0. It does not provide any forms or validation, so you can feel free to use your own. To protect your users, it does not save any user data in logs or sends them to an admin.
      This module fits your needs if you...
      ...use Mailchimp as your newsletter / email-automation tool ...want to let users subscribe to your newsletter on your website ...want to use your own form, validation and messages (with or without the wire forms) ...don't want any personal user data saved in any way in your ProcessWire environment (cf. EU data regulation terms) ...like to subscribe, update, unsubscribe or delete users to/from different lists ...like the Mailchimp UI for creating / sending / reviewing email campaigns *I have only tested it with PHP 7.x so far, so use on owners risk
      EDIT:
      Since 0.0.4, instructions and changelog can be found in the README only. You can find it here  🙂
      If you have questions or like to contribute, just post a reply or create an issue or pr on github, thanks!
×
×
  • Create New...