manager/assets/modext/widgets/element/modx.panel.snippet.js
/**
* @class MODx.panel.Snippet
* @extends MODx.FormPanel
* @param {Object} config An object of configuration properties
* @xtype panel-snippet
*/
MODx.panel.Snippet = function(config) {
config = config || {};
config.record = config.record || {};
config = MODx.setStaticElementsConfig(config, 'snippet');
Ext.applyIf(config,{
url: MODx.config.connector_url
,baseParams: {
action: 'element/snippet/get'
}
,id: 'modx-panel-snippet'
,cls: 'container form-with-labels'
,class_key: 'modSnippet'
,plugin: ''
,bodyStyle: ''
,allowDrop: false
,items: [{
html: _('snippet_new')
,id: 'modx-snippet-header'
,xtype: 'modx-header'
},MODx.getPageStructure([{
title: _('snippet_title')
,defaults: { border: false ,msgTarget: 'side' }
,layout: 'form'
,id: 'modx-snippet-form'
,labelWidth: 150
,items: [{
html: '<p>'+_('snippet_msg')+'</p>'
,id: 'modx-snippet-msg'
,xtype: 'modx-description'
},{
layout: 'column'
,border: false
,defaults: {
layout: 'form'
,labelAlign: 'top'
,anchor: '100%'
,border: false
,cls:'main-wrapper'
,labelSeparator: ''
,defaults: {
msgTarget: 'under'
,validationEvent: 'change'
,validateOnBlur: false
}
}
,items: [{
columnWidth: .6
,items: [{
xtype: 'hidden'
,name: 'id'
,id: 'modx-snippet-id'
,value: config.snippet
},{
xtype: 'hidden'
,name: 'props'
,id: 'modx-snippet-props'
,value: config.record.props || null
},{
xtype: 'textfield'
,fieldLabel: _('name')+'<span class="required">*</span>'
,description: MODx.expandHelp ? '' : _('snippet_desc_name')
,name: 'name'
,id: 'modx-snippet-name'
,anchor: '100%'
,maxLength: 255
,enableKeyEvents: true
,allowBlank: false
,value: config.record.name
,listeners: {
'keyup': {scope:this,fn:function(f,e) {
var title = Ext.util.Format.stripTags(f.getValue());
title = _('snippet')+': '+Ext.util.Format.htmlEncode(title);
if (MODx.request.a !== 'element/snippet/create' && MODx.perm.tree_show_element_ids === 1) {
title = title+ ' <small>('+this.config.record.id+')</small>';
}
Ext.getCmp('modx-snippet-header').getEl().update(title);
MODx.setStaticElementPath('snippet');
}}
}
},{
xtype: MODx.expandHelp ? 'label' : 'hidden'
,forId: 'modx-snippet-name'
,html: _('snippet_desc_name')
,cls: 'desc-under'
},{
xtype: 'textarea'
,fieldLabel: _('snippet_desc')
,description: MODx.expandHelp ? '' : _('snippet_desc_description')
,name: 'description'
,id: 'modx-snippet-description'
,anchor: '100%'
,maxLength: 255
,value: config.record.description || ''
},{
xtype: MODx.expandHelp ? 'label' : 'hidden'
,forId: 'modx-snippet-description'
,html: _('snippet_desc_description')
,cls: 'desc-under'
},{
xtype: 'modx-combo-browser'
,browserEl: 'modx-browser'
,fieldLabel: _('static_file')
,description: MODx.expandHelp ? '' : _('static_file_msg')
,name: 'static_file'
// ,hideFiles: true
,source: config.record.source != null ? config.record.source : MODx.config.default_media_source
,openTo: config.record.openTo || ''
,id: 'modx-snippet-static-file'
,triggerClass: 'x-form-code-trigger'
,anchor: '100%'
,maxLength: 255
,value: config.record.static_file || ''
,hidden: !config.record['static']
,hideMode: 'offsets'
,validator: function(value){
if (Ext.getCmp('modx-snippet-static').getValue() === true) {
if (Ext.util.Format.trim(value) != '') {
return true;
} else {
return _('static_file_ns');
}
}
return true;
}
},{
xtype: MODx.expandHelp ? 'label' : 'hidden'
,forId: 'modx-snippet-static-file'
,id: 'modx-snippet-static-file-help'
,html: _('static_file_msg')
,cls: 'desc-under'
,hidden: !config.record['static']
,hideMode: 'offsets'
},{
html: MODx.onSnipFormRender
,border: false
}]
},{
columnWidth: .4
,items: [{
xtype: 'modx-combo-category'
,fieldLabel: _('category')
,description: MODx.expandHelp ? '' : _('snippet_desc_category')
,name: 'category'
,id: 'modx-snippet-category'
,anchor: '100%'
,value: config.record.category || 0
,listeners: {
'afterrender': {scope:this,fn:function(f,e) {
MODx.setStaticElementPath('snippet');
}}
,'change': {scope:this,fn:function(f,e) {
MODx.setStaticElementPath('snippet');
}}
}
},{
xtype: MODx.expandHelp ? 'label' : 'hidden'
,forId: 'modx-snippet-category'
,id: 'modx-snippet-category-help'
,html: _('snippet_desc_category')
,cls: 'desc-under'
},{
xtype: 'xcheckbox'
,boxLabel: _('snippet_lock')
,description: MODx.expandHelp ? '' : _('snippet_lock_msg')
,name: 'locked'
,id: 'modx-snippet-locked'
,inputValue: 1
,checked: config.record.locked || 0
},{
xtype: MODx.expandHelp ? 'label' : 'hidden'
,forId: 'modx-snippet-locked'
,html: _('snippet_lock_msg')
,cls: 'desc-under'
},{
xtype: 'xcheckbox'
,boxLabel: _('clear_cache_on_save')
,description: MODx.expandHelp ? '' : _('clear_cache_on_save_msg')
,hideLabel: true
,name: 'clearCache'
,id: 'modx-snippet-clear-cache'
,inputValue: 1
,checked: Ext.isDefined(config.record.clearCache) || true
},{
xtype: MODx.expandHelp ? 'label' : 'hidden'
,forId: 'modx-snippet-clear-cache'
,html: _('clear_cache_on_save_msg')
,cls: 'desc-under'
},{
xtype: 'xcheckbox'
,hideLabel: true
,boxLabel: _('is_static')
,description: MODx.expandHelp ? '' : _('is_static_msg')
,name: 'static'
,id: 'modx-snippet-static'
,inputValue: 1
,checked: config.record['static'] || false
},{
xtype: MODx.expandHelp ? 'label' : 'hidden'
,forId: 'modx-snippet-static'
,id: 'modx-snippet-static-help'
,html: _('is_static_msg')
,cls: 'desc-under'
},{
xtype: 'modx-combo-source'
,fieldLabel: _('static_source')
,description: MODx.expandHelp ? '' : _('static_source_msg')
,name: 'source'
,id: 'modx-snippet-static-source'
,anchor: '100%'
,maxLength: 255
,value: config.record.source != null ? config.record.source : MODx.config.default_media_source
,hidden: !config.record['static']
,hideMode: 'offsets'
,baseParams: {
action: 'source/getList'
,showNone: true
,streamsOnly: true
}
,listeners: {
select: {
fn: this.changeSource
,scope: this
}
}
},{
xtype: MODx.expandHelp ? 'label' : 'hidden'
,forId: 'modx-snippet-static-source'
,id: 'modx-snippet-static-source-help'
,html: _('static_source_msg')
,cls: 'desc-under'
,hidden: !config.record['static']
,hideMode: 'offsets'
}]
}]
},{
xtype: 'panel'
,border: false
,layout: 'form'
,cls:'main-wrapper'
,labelAlign: 'top'
,items: [{
xtype: 'textarea'
,fieldLabel: _('snippet_code')
,name: 'snippet'
,id: 'modx-snippet-snippet'
,anchor: '100%'
,height: 400
,value: config.record.snippet || "<?php\n"
}]
}]
},{
xtype: 'modx-panel-element-properties'
,elementPanel: 'modx-panel-snippet'
,elementId: config.snippet
,elementType: 'modSnippet'
,record: config.record
}],{
id: 'modx-snippet-tabs'
})]
,useLoadingMask: true
,listeners: {
'setup': {fn:this.setup,scope:this}
,'success': {fn:this.success,scope:this}
,'failure': {fn:this.failure,scope:this}
,'beforeSubmit': {fn:this.beforeSubmit,scope:this}
,'failureSubmit': {
fn: function () {
this.showErroredTab(['modx-snippet-form'], 'modx-snippet-tabs')
},
scope: this
}
}
});
MODx.panel.Snippet.superclass.constructor.call(this,config);
var isStatic = Ext.getCmp('modx-snippet-static');
if (isStatic) { isStatic.on('check',this.toggleStaticFile); }
};
Ext.extend(MODx.panel.Snippet,MODx.FormPanel,{
initialized: false
,setup: function() {
if (!this.initialized) {
/*
The itemId (not id) of each form tab to be included/excluded; these correspond to the
keys in each tab component's items property
*/
this.errorHandlingTabs = ['modx-snippet-form'];
this.errorHandlingIgnoreTabs = ['modx-panel-element-properties'];
this.getForm().setValues(this.config.record);
}
if (this.initialized) { this.clearDirty(); return true; }
if (!Ext.isEmpty(this.config.record.name)) {
var title = _('snippet')+': '+this.config.record.name;
if (MODx.perm.tree_show_element_ids === 1) {
title = title+ ' <small>('+this.config.record.id+')</small>';
}
Ext.getCmp('modx-snippet-header').getEl().update(title);
}
if (!Ext.isEmpty(this.config.record.properties)) {
var d = this.config.record.properties;
var g = Ext.getCmp('modx-grid-element-properties');
if (g) {
g.defaultProperties = d;
g.getStore().loadData(d);
}
}
this.fireEvent('ready',this.config.record);
if (MODx.onLoadEditor) { MODx.onLoadEditor(this); }
this.clearDirty();
this.initialized = true;
return true;
}
/**
* Set the browser window "media source" source
*/
,changeSource: function() {
var browser = Ext.getCmp('modx-snippet-static-file')
,source = Ext.getCmp('modx-snippet-static-source').getValue();
browser.config.source = source;
}
,beforeSubmit: function(o) {
this.cleanupEditor();
Ext.apply(o.form.baseParams,{
propdata: Ext.getCmp('modx-grid-element-properties').encode()
});
return this.fireEvent('save',{
values: this.getForm().getValues()
,stay: MODx.config.stay
});
}
,success: function(r) {
if (MODx.request.id) Ext.getCmp('modx-grid-element-properties').save();
this.getForm().setValues(r.result.object);
var t = Ext.getCmp('modx-tree-element');
if (t) {
var c = Ext.getCmp('modx-snippet-category').getValue();
var u = c != '' && c != null && c != 0 ? 'n_snippet_category_'+c : 'n_type_snippet';
var node = t.getNodeById('n_snippet_element_' + Ext.getCmp('modx-snippet-id').getValue() + '_' + r.result.object.previous_category);
if (node) node.destroy();
t.refreshNode(u,true);
}
}
,changeEditor: function() {
this.cleanupEditor();
this.on('success',function(o) {
var id = o.result.object.id;
var w = Ext.getCmp('modx-snippet-which-editor').getValue();
MODx.request.a = 'element/snippet/update';
location.href = '?'+Ext.urlEncode(MODx.request)+'&which_editor='+w+'&id='+id;
});
this.submit();
}
,cleanupEditor: function() {
if (MODx.onSaveEditor) {
var fld = Ext.getCmp('modx-snippet-snippet');
MODx.onSaveEditor(fld);
}
}
,toggleStaticFile: function(cb) {
var flds = ['modx-snippet-static-file','modx-snippet-static-file-help','modx-snippet-static-source','modx-snippet-static-source-help'];
var fld,i;
if (cb.checked) {
for (i in flds) {
fld = Ext.getCmp(flds[i]);
if (fld) { fld.show(); }
}
} else {
for (i in flds) {
fld = Ext.getCmp(flds[i]);
if (fld) { fld.hide(); }
}
}
}
});
Ext.reg('modx-panel-snippet',MODx.panel.Snippet);