SilverStripe 2.4 API Docs
  • Package
  • Class
  • Tree
  • Deprecated
Version: master
  • master
  • 3.1
  • 3.0
  • 2.4
  • tagfield

Packages

  • cms
    • assets
    • batchaction
    • batchactions
    • bulkloading
    • comments
    • content
    • core
    • export
    • publishers
    • reports
    • security
    • tasks
  • forms
    • actions
    • core
    • fields-basic
    • fields-dataless
    • fields-datetime
    • fields-files
    • fields-formatted
    • fields-formattedinput
    • fields-relational
    • fields-structural
    • transformations
    • validators
  • installer
  • None
  • PHP
  • sapphire
    • api
    • bulkloading
    • control
    • core
    • cron
    • dev
    • email
    • fields-formattedinput
    • filesystem
    • formatters
    • forms
    • i18n
    • integration
    • misc
    • model
    • parsers
    • search
    • security
    • tasks
    • testing
    • tools
    • validation
    • view
    • widgets

Classes

  • FileField
  • FileIFrameField
  • ImageField
  • SimpleImageField
  • SimpleImageField_Disabled

Class FileIFrameField

A field that allows you to attach a file to a DataObject without submitting the form it is part of, through the use of an iframe.

If all you need is a simple file upload, it is reccomended you use FileField

Object
Extended by ViewableData implements IteratorAggregate
Extended by RequestHandler
Extended by FormField
Extended by FileField
Extended by FileIFrameField

Direct known subclasses

ImageField

Package: forms\fields-files
Used by: ForeignKey
Located at sapphire/forms/FileIFrameField.php

Methods summary

public
# setCanUploadNewFile( boolean $can )

Sets whether or not files can be uploaded into the CMS from the user's local computer

Sets whether or not files can be uploaded into the CMS from the user's local computer

Parameters

$can
boolean
$can
public string
# dataClass( )

The data class that this field is editing.

The data class that this field is editing.

Returns

string
Class name
public string
# Field( )

Returns

string

Overrides

FileField::Field
public File|null
# AttachedFile( )

Attempt to retreive a File object that has already been attached to this forms data record

Attempt to retreive a File object that has already been attached to this forms data record

Returns

File|null
public string
# iframe( )

Returns

string
public Form
# EditFileForm( )

Returns

Form
public
# save( mixed $data, mixed $form )
public Form
# DeleteFileForm( )

Returns

Form
public
# delete( mixed $data, mixed $form )
public string
# FileTypeName( )

Get the type of file this field is used to attach (e.g. File, Image)

Get the type of file this field is used to attach (e.g. File, Image)

Returns

string

Methods inherited from FileField

Value(), __construct(), getAllowedExtensions(), getAllowedMaxFileSize(), getFolderName(), getValidator(), saveInto(), setAllowedExtensions(), setAllowedMaxFileSize(), setFolderName(), setValidator(), validate()

Methods inherited from FormField

FieldHolder(), LeftTitle(), Link(), Message(), MessageType(), Name(), Required(), RightTitle(), SmallFieldHolder(), Title(), Type(), addExtraClass(), attrName(), attrTitle(), attrValue(), createTag(), dataValue(), debug(), describe(), extraClass(), forTemplate(), getCustomValidationMessage(), getForm(), getTabIndex(), getTabIndexHTML(), hasClass(), hasData(), id(), isComposite(), isDisabled(), isReadonly(), jsValidation(), name_to_label(), performDisabledTransformation(), performReadonlyTransformation(), removeExtraClass(), rootFieldSet(), securityTokenEnabled(), setContainerFieldSet(), setCustomValidationMessage(), setDisabled(), setError(), setForm(), setLeftTitle(), setName(), setReadonly(), setRightTitle(), setTabIndex(), setTitle(), setValue(), transform()

Methods inherited from RequestHandler

allowedActions(), checkAccessAction(), getRequest(), handleRequest(), hasAction(), httpError()

Methods inherited from ViewableData

ATT_val(), BaseHref(), CSSClasses(), CurrentMember(), CurrentPage(), Debug(), Even(), EvenOdd(), First(), FirstLast(), HasPerm(), IsAjax(), JS_val(), Last(), Me(), Middle(), MiddleString(), Modulus(), MultipleOf(), Odd(), Pos(), RAW_val(), SQL_val(), ThemeDir(), Top(), TotalItems(), XML_val(), __get(), __isset(), __set(), buildCastingCache(), cachedCall(), castingClass(), castingHelper(), castingHelperPair(), castingObjectCreator(), castingObjectCreatorPair(), customise(), defineMethods(), escapeTypeForField(), getField(), getIterator(), getSecurityID(), getXMLValues(), hasField(), hasValue(), i18nLocale(), iteratorProperties(), obj(), renderWith(), setCustomisedObj(), setField()

Methods inherited from Object

__call(), __toString(), addMethodsFrom(), addStaticVars(), addWrapperMethod(), add_extension(), add_static_var(), allMethodNames(), cacheToFile(), cacheToFileWithArgs(), clearCache(), combined_static(), create(), createMethod(), create_from_string(), exists(), extInstance(), extend(), getCustomClass(), getExtensionInstance(), getExtensionInstances(), get_extensions(), get_static(), hasExtension(), hasMethod(), has_extension(), invokeWithExtensions(), is_a(), loadCache(), parentClass(), parse_class_spec(), remove_extension(), sanitiseCachename(), saveCache(), set_stat(), set_static(), set_uninherited(), stat(), strong_create(), uninherited(), uninherited_static(), useCustomClass()

Magic methods summary

Properties summary

public static array $allowed_actions
#

Define a list of action handling methods that are allowed to be called directly by URLs. The variable should be an array of action names. This sample shows the different values that it can contain:

Define a list of action handling methods that are allowed to be called directly by URLs. The variable should be an array of action names. This sample shows the different values that it can contain:

array(
        'someaction', // someaction can be accessed by anyone, any time
        'otheraction' => true, // So can otheraction
        'restrictedaction' => 'ADMIN', // restrictedaction can only be people with ADMIN privilege
        'complexaction' '->canComplexAction' // complexaction can only be accessed if $this->canComplexAction() returns true
);

Form getters count as URL actions as well, and should be included in allowed_actions. Form actions on the other handed (first argument to FormAction() should NOT be included, these are handled separately through Form->httpSubmission. You can control access on form actions either by conditionally removing FormAction in the form construction, or by defining $allowed_actions in your Form class.
protected boolean $canUploadNewFile
#

Flag that controls whether or not new files can be uploaded by the user from their local computer.

Flag that controls whether or not new files can be uploaded by the user from their local computer.

Properties inherited from FileField

$allowedExtensions, $allowedMaxFileSize, $folderName, $relationAutoSetting, $upload

Properties inherited from FormField

$containerFieldSet, $customValidationMessage, $description, $disabled, $dontEscape, $extraClass, $extraClasses, $form, $leftTitle, $message, $messageType, $name, $readonly, $rightTitle, $tabIndex, $title, $value

Properties inherited from RequestHandler

$brokenOnConstruct, $request, $url_handlers

Properties inherited from ViewableData

$casting, $customisedObject, $default_cast, $failover, $iteratorPos, $iteratorTotalItems

Properties inherited from Object

$class, $extension_instances, $extensions

Comments

Comment policy: Please use comments for tips and corrections about the described functionality. Comments are moderated, we reserve the right to remove comments that are inappropriate or are no longer relevant.
Use the Silverstripe Forum to ask questions.
blog comments powered by Disqus
SilverStripe 2.4 API Docs API documentation generated by ApiGen 2.8.0