fobi.contrib.plugins.form_elements.fields.file package¶
Submodules¶
fobi.contrib.plugins.form_elements.fields.file.apps module¶
fobi.contrib.plugins.form_elements.fields.file.base module¶
-
class
fobi.contrib.plugins.form_elements.fields.file.base.
FileInputPlugin
(user=None)[source]¶ Bases:
fobi.base.FormFieldPlugin
File field plugin.
-
get_form_field_instances
(request=None, form_entry=None, form_element_entries=None, **kwargs)[source]¶ Get form field instances.
-
group
= <django.utils.functional.lazy.<locals>.__proxy__ object>¶
-
name
= <django.utils.functional.lazy.<locals>.__proxy__ object>¶
-
prepare_plugin_form_data
(cleaned_data)[source]¶ Prepare plugin form data.
Parameters: cleaned_data – Returns:
-
submit_plugin_form_data
(form_entry, request, form, form_element_entries=None, **kwargs)[source]¶ Submit plugin form data/process file upload.
Handling the posted data for file plugin when form is submitted. This method affects the original form and that’s why it returns it.
Parameters: - form_entry (fobi.models.FormEntry) – Instance
of
fobi.models.FormEntry
. - request (django.http.HttpRequest) –
- form (django.forms.Form) –
- form_element_entries –
- form_entry (fobi.models.FormEntry) – Instance
of
-
uid
= 'file'¶
-
fobi.contrib.plugins.form_elements.fields.file.conf module¶
-
fobi.contrib.plugins.form_elements.fields.file.conf.
get_setting
(setting, override=None)[source]¶ Get setting.
Get a setting from
fobi.contrib.plugins.form_elements.fields.conf
module, falling back to the default.If override is not None, it will be used instead of the setting.
Parameters: - setting – String with setting name
- override – Value to use when no setting is available. Defaults to None.
Returns: Setting value.
fobi.contrib.plugins.form_elements.fields.file.defaults module¶
fobi.contrib.plugins.form_elements.fields.file.fobi_form_elements module¶
-
class
fobi.contrib.plugins.form_elements.fields.file.fobi_form_elements.
FileInputPlugin
(user=None)[source]¶ Bases:
fobi.base.FormFieldPlugin
File field plugin.
-
get_form_field_instances
(request=None, form_entry=None, form_element_entries=None, **kwargs)[source]¶ Get form field instances.
-
group
= <django.utils.functional.lazy.<locals>.__proxy__ object>¶
-
name
= <django.utils.functional.lazy.<locals>.__proxy__ object>¶
-
prepare_plugin_form_data
(cleaned_data)[source]¶ Prepare plugin form data.
Parameters: cleaned_data – Returns:
-
submit_plugin_form_data
(form_entry, request, form, form_element_entries=None, **kwargs)[source]¶ Submit plugin form data/process file upload.
Handling the posted data for file plugin when form is submitted. This method affects the original form and that’s why it returns it.
Parameters: - form_entry (fobi.models.FormEntry) – Instance
of
fobi.models.FormEntry
. - request (django.http.HttpRequest) –
- form (django.forms.Form) –
- form_element_entries –
- form_entry (fobi.models.FormEntry) – Instance
of
-
uid
= 'file'¶
-
fobi.contrib.plugins.form_elements.fields.file.forms module¶
-
class
fobi.contrib.plugins.form_elements.fields.file.forms.
FileInputForm
(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=<class 'django.forms.utils.ErrorList'>, label_suffix=None, empty_permitted=False, field_order=None, use_required_attribute=None)[source]¶ Bases:
django.forms.forms.Form
,fobi.base.BaseFormFieldPluginForm
Form for
FileInputPlugin
.-
base_fields
= {'allowed_extensions': <django.forms.fields.CharField object>, 'help_text': <django.forms.fields.CharField object>, 'initial': <django.forms.fields.CharField object>, 'label': <django.forms.fields.CharField object>, 'max_length': <django.forms.fields.IntegerField object>, 'name': <django.forms.fields.CharField object>, 'required': <django.forms.fields.BooleanField object>}¶
-
clean
()[source]¶ Hook for doing any extra form-wide cleaning after Field.clean() has been called on every field. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field named ‘__all__’.
-
declared_fields
= {'allowed_extensions': <django.forms.fields.CharField object>, 'help_text': <django.forms.fields.CharField object>, 'initial': <django.forms.fields.CharField object>, 'label': <django.forms.fields.CharField object>, 'max_length': <django.forms.fields.IntegerField object>, 'name': <django.forms.fields.CharField object>, 'required': <django.forms.fields.BooleanField object>}¶
-
media
¶
-
plugin_data_fields
= [('label', ''), ('name', ''), ('help_text', ''), ('initial', ''), ('max_length', '255'), ('required', False), ('allowed_extensions', '')]¶
-
fobi.contrib.plugins.form_elements.fields.file.settings module¶
FILES_UPLOAD_DIR
(string)