silverstripe-framework/forms/ImageField.php
Ingo Schommer 71a9ff089d MINOR Moved class-specific documentation from doc.silverstripe.org back into class-level PHPDoc
git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/branches/2.4@107725 467b73ca-7a2a-4603-9d3b-597d59a354a9
2011-02-02 14:19:38 +13:00

53 lines
1.5 KiB
PHP
Executable File

<?php
/**
* A field that allows you to attach an image to a record from within a iframe - designed for use in AJAX forms where it
* is not possible to use {@link SimpleImageField}.
*
* <b>Usage</b>
*
* If you want to upload all assets from this field to a given folder you can define the folder in 2 ways. Either in the constructor or as a method on the field
*
* <code>
* $myField = new ImageField("myName", "Upload image below", null, null, null, "myFolder");
* </code>
*
* Will upload images into the assets/myFolder folder. If that folder does not exist it will create it for you. You can also define it as a method
*
* <code>
* $myField = new ImageField("myName");
* $myField->setFolderName('myFolder');
* </code>
*
* @package forms
* @subpackage fields-files
*/
class ImageField extends FileIFrameField {
/**
* @return SimpleImageField_Disabled
*/
public function performReadonlyTransformation() {
return new SimpleImageField_Disabled($this->name, $this->title, $this->value, $this->form);
}
/**
* @return string
*/
public function FileTypeName() {
return _t('ImageField.IMAGE', 'Image');
}
/**
* Adds the filter, so the dropdown displays only images and folders.
*
* @return Form
*/
public function EditFileForm() {
$filter = create_function('$item', 'return (in_array("Folder", ClassInfo::ancestry($item->ClassName)) || in_array("Image", ClassInfo::ancestry($item->ClassName)));');
$form = parent::EditFileForm();
$form->dataFieldByName('ExistingFile')->setFilterFunction($filter);
return $form;
}
}