Developers

License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

Credits:

Dependencies

PHP

Javascript

Custom version of MooTools.More on a project level (http://mootools.net/more/db85d287cff2f9dcf4e970a2f6e688b0)

Datepicker requires MooTools.More:

More/Date

More/Date.Extras

More/Locale

More/Locale.en-GB.Date

MooEditable requires MooTools.More:

More/Class.Refactor

More/Locale

mooRainbow requires MooTools.More:

More/Slider

More/Drag

More/Color

MooEditable, Datepicker and mooRainbow in lib/vendor - see Setup

Setup

NOTE: Using custom forks of Mooditable and mooRainbow for easy to fix bugs with new versions of MooTools.NOTE: Using custom fork of Datepicker as file structure changed, also added 'datepicker_light' theme (default) with calendar icon - meshes better with symfony (and as above).

Note for SVN

If using SVN you will need to add these dependancies (custom forks) as svn:externals in the project's lib/vendor folder
(they cannot be added in the plugin, as the SVN bridge converts the existing submodules in Git to folders and svn:externals cannot override existing files)

Publish assets

Run ./symfony mootools:publish-assets after installation to ensure all the JavaScript and Stylesheet files are in place (and can be run subsequent times if need to upgrade to new widgets).

This plugin has a custom task due to symlinks in web being required from lib/vendor in the plugin or in the project, rather than just creating a symlink to the web/ folder as normal.

Slots or not?

By default, the accompanying JavaScript to configure the widgets are placed inline with the inputs themselves, which may cause problems if your JavaScript files (especially MooTools Core/More) are included in the footer.

As such, each of the widgets accepts a use_slots option, which defaults to the boolean value set in the appropriate config option (false by default). When this is set to true (either in app.yml or in the forms' options), the accompanying JavaScript added to a slot, which you should include in your template after JavaScript libraries are included, e.g.:

All of the widget initialisation JavaScript is fired on domready, so the slot is also safe to include in the head.

If you have multiple date picker widgets, then the javascript is concatenated safely.

Validators

Enhanced String Validator

Enhanced String Validator

An enhanced string validator which allows HTML strings to have a max length which doesn't include the tags (especially useful if the character limit is for display purposes).
Adds an extra dynamic option to the validator message to tell the user how many characters they have actually used, to make it easier to reduce. Can be used in conjunction with
other validators.

Changes:

Extends sfValidatorString so all options and messages for that are used

Adds %current_length% to the options for the validator messages

Strips HTML tags before calculating length, but returns the string with HTML

Widgets

Widget configuration options:

use_slots: All widgets have this option (detailed above) which allows the Javascript to be set into a slot rather than included in the flow of the page.

MooEditable text area

A configurable rich text editor widget, which includes (turned on by default) a clean paste from Word

Default configuration:

Controls all default configuration options

Controls base CSS for the editable area

Controls whether CleanPaste included (by default)

Controls base toolbar options, and allows extra CSS and JS to be added if the default toolbar for all widgets is changed

Widget configuration options:

config: Additional MooEditable configuration

width: The width of the editable area

height: The height of the editable area

extratoolbar: Any additional toolbar options - include | to separate

Example usage:

Default implementation:

$this->widgetSchema['text'] = new sfWidgetFormTextareaMooEditable();

Datepicker - input

A date picker with the calendar control appearing when the user clicks on the input box to enter the date

Default configuration:

Controls locale (defaults to en-GB), and location of locale files - must include all locales if local files

Controls the theme and location of the theme CSS files and images

Widget configuration options:

locale: if this is changed from the default, will require additional JS locale files

date_format: The JavaScript format of the date in the input box (defaults to %Y-%m-%d - see below) - see MooTools Date Format.
If this is changed should be paired with appropriate sfValidatorDate and regex - see Example usage.
Ensure includes time if below option is 'true'

php_date_format: If the date_format for display is changed to a more user friendly format than %Y-%m-%d - the value needs to be converted from the database format.
This field should contain the corresponding PHP date_format for use with date() - see PHP Date Format

with_time: defaults to 'false', include time in the date picker (date format defaults to %Y-%m-%d %H:%i instead of %Y-%m-%d)

year_picker: defaults to 'true', click on the month name twice to select year - if date range restricted within one year then set to 'false'

min_date: default is none, set to restrict date range (format: see above)

max_date: default is none, set to restrict date range (format: see above)