Docs For Class atkFileAttribute

Inherited Properties	Inherited Methods
Inherited From atkAttribute atkAttribute::$m_column atkAttribute::$m_cssclasses atkAttribute::$m_dbfieldtype atkAttribute::$m_dependencies atkAttribute::$m_disabledModes atkAttribute::$m_editCallback atkAttribute::$m_flags atkAttribute::$m_forceinsert atkAttribute::$m_forcereload atkAttribute::$m_forceupdate atkAttribute::$m_htmlid atkAttribute::$m_index atkAttribute::$m_initialValue atkAttribute::$m_initial_hidden atkAttribute::$m_jsObservers atkAttribute::$m_label atkAttribute::$m_loadType atkAttribute::$m_maxsize atkAttribute::$m_module atkAttribute::$m_name atkAttribute::$m_onchangecode atkAttribute::$m_onchangehandler_init atkAttribute::$m_order atkAttribute::$m_owner atkAttribute::$m_ownerInstance atkAttribute::$m_postfixlabel atkAttribute::$m_searchmode atkAttribute::$m_searchsize atkAttribute::$m_sections atkAttribute::$m_size atkAttribute::$m_storageType atkAttribute::$m_tabs atkAttribute::$m_viewCallback	Inherited From atkAttribute atkAttribute::atkAttribute() Constructor atkAttribute::addCSSClass() Add a CSS class for this attribute on an HTML form. atkAttribute::addDependee() Add a depended attribute for this attribute, which means the depended attribute will be refreshed (using Ajax) if the value for this attribute changes. atkAttribute::addDependency() Special case of an on-change handler which gets executed server-side and can manipulate the DOM using PHP wrapper methods available in the atkFormModifier class or by outputting JavaScript code directly. atkAttribute::addDisabledMode() Adds a disabled mode flag to the attribute (use DISABLED_VIEW and DISABLED_EDIT flags). atkAttribute::addFlag() Adds a flag to the attribute. atkAttribute::addOnChangeHandler() Add a javascript onchange event handler. atkAttribute::addToEditArray() Adds the attribute's edit / hide HTML code to the edit array. atkAttribute::addToListArrayHeader() Adds the attribute / field to the list header. This includes the column name and search field. atkAttribute::addToListArrayRow() Adds the attribute / field to the list row. And if the row is totalisable also to the total. atkAttribute::addToQuery() Adds this attribute to database queries. atkAttribute::addToSearchformFields() Adds the needed searchbox(es) for this attribute to the fields array. This method should only be called by the atkSearchHandler. atkAttribute::addToViewArray() Adds the attribute's view / hide HTML code to the view array. atkAttribute::db2value() Converts a database value to an internal value. atkAttribute::dbFieldSize() Return the size of the field in the database. atkAttribute::dbFieldType() Return the database field type of the attribute. atkAttribute::delete() The delete method is called by the framework to inform the attribute that a record is deleted. atkAttribute::deleteAllowed() Check if delete of the record is allowed. atkAttribute::display() Returns a displayable string for this value, to be used in HTML pages. atkAttribute::edit() Returns a piece of html code that can be used in a form to edit this attribute's value. atkAttribute::equal() This function is called to compare if two records are considered equal by this attribute. atkAttribute::escapeSQL() Escape string for use in a query. atkAttribute::extendedSort() Retrieves the sort options and sort order. atkAttribute::fetchMeta() Fetch the metadata about this attrib from the table metadata, and process it. atkAttribute::fetchValue() Convert values from an HTML form posting to an internal value for this attribute. atkAttribute::fieldName() Returns the name of the attribute. atkAttribute::formName() Retrieve the name of the attribute in HTML forms. atkAttribute::getAdditionalTabs() Get list of additional tabs. atkAttribute::getAttributeHtmlId() Returns the html identifier of the attribute without setting it Created because getHtmlId would always SET the htmlid while getting it. atkAttribute::getColumn() Get column. atkAttribute::getCSSClassAttribute() Retrieve the attribute for the HTML-tag for this atkAttribute. atkAttribute::getCSSClasses() Retrieve the CSS classes that were registered for this attribute atkAttribute::getDb() Get database instance for this attribute. Will return the owner instance database instance unless the owner instance is not set in which case the default instance will be returned. atkAttribute::getDependencies() Retrieve the dependees for this attribute. atkAttribute::getEdit() Retrieve the HTML code for placing this attribute in an edit page. atkAttribute::getEditCallback() Returns the edit callback (if set). atkAttribute::getError() Check if this attribute has errors in the specified error list. atkAttribute::getFlags() Returns the full set of flags of the attribute. atkAttribute::getForceInsert() Getter for wether or not an attribute is forced to insert atkAttribute::getForceUpdate() Getter for wether or not an attribute is forced to update atkAttribute::getHtmlId() Return the html identifier (id="") of the attribute. (unique within a atkAttribute::getLabel() Get the HTML label of the attribute. atkAttribute::getModule() Get the module that this attribute originated from. atkAttribute::getOrderByStatement() Retrieves the ORDER BY statement for this attribute's node. atkAttribute::getOwnerInstance() Returns the owner instance. atkAttribute::getSearchCondition() Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition. atkAttribute::getSearchFieldName() Retrieve the fieldname of the attribute in an atksearch form. atkAttribute::getSearchMode() Retrieve the current set or default searchmode of this attribute atkAttribute::getSearchModeFieldname() Retrieve the searchmode name of the attribute in an atksearch form. atkAttribute::getSearchModes() Retrieve the list of searchmodes supported by the attribute. atkAttribute::getSections() retrieve the tabs and/or sections for this attribute. atkAttribute::getTabs() retrieve the tabs for this attribute. atkAttribute::getToolTip() Retrieve the html/javascript code for showing the tooltip for this attribute. atkAttribute::getView() Retrieve the html code for placing this attribute in a view page. atkAttribute::getViewCallback() Returns the view callback (if set). atkAttribute::hasDisabledMode() Check if the attribute is disabled in some mode (use DISABLED_VIEW and DISABLED_EDIT flags). atkAttribute::hasFlag() Check if the attribute has a certain flag. atkAttribute::hasStore() This function is used to check whether a attribute has a store function or not. atkAttribute::hide() Returns a piece of html code for hiding this attribute in an HTML form, while still posting its value. (<input type="hidden">) atkAttribute::init() This function is called right after the attribute is added to the node. atkAttribute::initDependencies() Initialize and calls the dependencies. atkAttribute::initialValue() Initial value. Returns the initial value for this attribute which will be used in the add form etc. atkAttribute::isEmpty() Check if a record has an empty value for this attribute. atkAttribute::isInitialHidden() check whether initially hidden or not atkAttribute::isNotNullInDb() Checks if this attribute is really not null in the database. atkAttribute::isPosted() Is there a value posted for this attribute? atkAttribute::label() Return the label of the attribute. atkAttribute::listHeaderSortOrder() Retrieve the sortorder for the listheader based on the atkColumnConfig atkAttribute::loadType() Determine the load type of this attribute. atkAttribute::maxInputSize() Determine the maximum length an input field may be. atkAttribute::needsInsert() This function is called by the framework to determine if the attribute needs to be saved to the database in an addDb call. atkAttribute::needsReload() This function is called by the framework to determine if the attribute needs to be updated from the db regardless of the attribute being present in the postvars/session atkAttribute::needsUpdate() This function is called by the framework to determine if the attribute needs to be saved to the database in an updateDb call. atkAttribute::observeJS() Observe the given JavaScript event and execute the given JavaScript statements when the event occurs. atkAttribute::parseStringValue() Convert a String representation into an internal value. atkAttribute::partial() Handle a partial request for this attribute, different attributes support different partials. atkAttribute::partial_dependencies() Call dependencies for this attribute and output JavaScript. atkAttribute::partial_refresh() Partial method to refresh the add/edit field for this attribute. atkAttribute::postInit() This function is called at the end of the node's init method. atkAttribute::preAddToEditArray() Prepare for edit. Is called before all attributes are added to the edit array and allows for last minute manipulations based on the record but also manipulations on the record itself. atkAttribute::preAddToViewArray() Prepare for view. Is called before all attributes are added to the view array and allows for last minute manipulations based on the record but also manipulations on the record itself. atkAttribute::registerJavaScriptObservers() Register JavaScript event handlers. atkAttribute::registerKeyListener() Register keyboard navigation for this attribute. atkAttribute::removeDisabledMode() Removes a disabled mode from the attribute. atkAttribute::removeFlag() Removes a flag from the attribute. atkAttribute::search() Returns a piece of html code that can be used to get search terms input from the user. atkAttribute::searchCondition() Creates a search condition for a given search value, and adds it to the query that will be used for performing the actual search. atkAttribute::searchMode() Returns piece of html which is used for setting/selecting the search mode for this attribute. atkAttribute::setAttribSize() Set the size(s) of the attribute atkAttribute::setAttributeSearchmode() Sets the searchmode for an attribute This will cause attributes that respect this to use the attributes searchmode for that particulair attribute instead of the general searchmode. atkAttribute::setColumn() Set column. atkAttribute::setDisabledModes() Sets the disabled mode flag of the attribute atkAttribute::setEditCallback() Sets the edit callback. atkAttribute::setFlags() Sets the flags of the attribute atkAttribute::setForceInsert() Used to force an attribute to update with every addDb() call atkAttribute::setForceReload() Used to force an attribute to update from the db regardless of the atkAttribute::setForceUpdate() Used to force an attribute to update with every updateDb() call atkAttribute::setInitialHidden() Set whether initially hidden or not. A field is "hidden" by adding the class atkAttrRowHidden. atkAttribute::setInitialValue() Set initial value for this attribute. atkAttribute::setLabel() Set the label of the attribute atkAttribute::setLoadType() Sets the load type. atkAttribute::setOwnerInstance() Sets the owner instance. atkAttribute::setPostFixLabel() Set the label of the attribute atkAttribute::setSections() Put the attribute on one or more tabs and/or sections. atkAttribute::setStorageType() Sets the storage type. atkAttribute::setTabs() Put the attribute on one or more tabs. atkAttribute::setViewCallback() Sets the view callback. atkAttribute::showOnTab() Check if the attribute wants to be shown on a certain tab. atkAttribute::smartSearchCondition() Creates a smart search condition for a given search value, and adds it to the query that will be used for performing the actual search. atkAttribute::sortOptions() Retrieves the sort options for this attribute which is used in recordlists and search actions. atkAttribute::sortOrder() Sets the sortorder options for this attribute which is used in recordlists and search actions. atkAttribute::storageType() Determine the storage type of this attribute. atkAttribute::sum() Calculate the sum of 2 records. atkAttribute::text() Translate using the owner instance's module and type. atkAttribute::validate() Checks if a value is valid. atkAttribute::value2db() Converts the internal attribute value to one that is understood by the database. atkAttribute::_callDependencies() Calls the dependency callbacks for this attribute. atkAttribute::_renderChangeHandler() Renders the onchange code on the page. atkAttribute::__toString() String representation for this attribute (PHP5 only).

Inherited Properties

Inherited Methods

Inherited From atkAttribute

atkAttribute::$m_column

atkAttribute::$m_cssclasses

atkAttribute::$m_dbfieldtype

atkAttribute::$m_dependencies

atkAttribute::$m_disabledModes

atkAttribute::$m_editCallback

atkAttribute::$m_flags

atkAttribute::$m_forceinsert

atkAttribute::$m_forcereload

atkAttribute::$m_forceupdate

atkAttribute::$m_htmlid

atkAttribute::$m_index

atkAttribute::$m_initialValue

atkAttribute::$m_initial_hidden

atkAttribute::$m_jsObservers

atkAttribute::$m_label

atkAttribute::$m_loadType

atkAttribute::$m_maxsize

atkAttribute::$m_module

atkAttribute::$m_name

atkAttribute::$m_onchangecode

atkAttribute::$m_onchangehandler_init

atkAttribute::$m_order

atkAttribute::$m_owner

atkAttribute::$m_ownerInstance

atkAttribute::$m_postfixlabel

atkAttribute::$m_searchmode

atkAttribute::$m_searchsize

atkAttribute::$m_sections

atkAttribute::$m_size

atkAttribute::$m_storageType

atkAttribute::$m_tabs

atkAttribute::$m_viewCallback

Inherited From atkAttribute

atkAttribute::atkAttribute()

Constructor

atkAttribute::addCSSClass()

Add a CSS class for this attribute on an HTML form.

atkAttribute::addDependee()

Add a depended attribute for this attribute, which means the depended attribute will be refreshed (using Ajax) if the value for this attribute changes.

atkAttribute::addDependency()

Special case of an on-change handler which gets executed server-side and can manipulate the DOM using PHP wrapper methods available in the atkFormModifier class or by outputting JavaScript code directly.

atkAttribute::addDisabledMode()

Adds a disabled mode flag to the attribute (use DISABLED_VIEW and DISABLED_EDIT flags).

atkAttribute::addFlag()

Adds a flag to the attribute.

atkAttribute::addOnChangeHandler()

Add a javascript onchange event handler.

atkAttribute::addToEditArray()

Adds the attribute's edit / hide HTML code to the edit array.

atkAttribute::addToListArrayHeader()

Adds the attribute / field to the list header. This includes the column name and search field.

atkAttribute::addToListArrayRow()

Adds the attribute / field to the list row. And if the row is totalisable also to the total.

atkAttribute::addToQuery()

Adds this attribute to database queries.

atkAttribute::addToSearchformFields()

Adds the needed searchbox(es) for this attribute to the fields array. This method should only be called by the atkSearchHandler.

atkAttribute::addToViewArray()

Adds the attribute's view / hide HTML code to the view array.

atkAttribute::db2value()

Converts a database value to an internal value.

atkAttribute::dbFieldSize()

Return the size of the field in the database.

atkAttribute::dbFieldType()

Return the database field type of the attribute.

atkAttribute::delete()

The delete method is called by the framework to inform the attribute that a record is deleted.

atkAttribute::deleteAllowed()

Check if delete of the record is allowed.

atkAttribute::display()

Returns a displayable string for this value, to be used in HTML pages.

atkAttribute::edit()

Returns a piece of html code that can be used in a form to edit this attribute's value.

atkAttribute::equal()

This function is called to compare if two records are considered equal by this attribute.

atkAttribute::escapeSQL()

Escape string for use in a query.

atkAttribute::extendedSort()

Retrieves the sort options and sort order.

atkAttribute::fetchMeta()

Fetch the metadata about this attrib from the table metadata, and process it.

atkAttribute::fetchValue()

Convert values from an HTML form posting to an internal value for this attribute.

atkAttribute::fieldName()

Returns the name of the attribute.

atkAttribute::formName()

Retrieve the name of the attribute in HTML forms.

atkAttribute::getAdditionalTabs()

Get list of additional tabs.

atkAttribute::getAttributeHtmlId()

Returns the html identifier of the attribute without setting it Created because getHtmlId would always SET the htmlid while getting it.

atkAttribute::getColumn()

Get column.

atkAttribute::getCSSClassAttribute()

Retrieve the attribute for the HTML-tag for this atkAttribute.

atkAttribute::getCSSClasses()

Retrieve the CSS classes that were registered for this attribute

atkAttribute::getDb()

Get database instance for this attribute. Will return the owner instance database instance unless the owner instance is not set in which case the default instance will be returned.

atkAttribute::getDependencies()

Retrieve the dependees for this attribute.

atkAttribute::getEdit()

Retrieve the HTML code for placing this attribute in an edit page.

atkAttribute::getEditCallback()

Returns the edit callback (if set).

atkAttribute::getError()

Check if this attribute has errors in the specified error list.

atkAttribute::getFlags()

Returns the full set of flags of the attribute.

atkAttribute::getForceInsert()

Getter for wether or not an attribute is forced to insert

atkAttribute::getForceUpdate()

Getter for wether or not an attribute is forced to update

atkAttribute::getHtmlId()

Return the html identifier (id="") of the attribute. (unique within a

atkAttribute::getLabel()

Get the HTML label of the attribute.

atkAttribute::getModule()

Get the module that this attribute originated from.

atkAttribute::getOrderByStatement()

Retrieves the ORDER BY statement for this attribute's node.

atkAttribute::getOwnerInstance()

Returns the owner instance.

atkAttribute::getSearchCondition()

Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition.

atkAttribute::getSearchFieldName()

Retrieve the fieldname of the attribute in an atksearch form.

atkAttribute::getSearchMode()

Retrieve the current set or default searchmode of this attribute

atkAttribute::getSearchModeFieldname()

Retrieve the searchmode name of the attribute in an atksearch form.

atkAttribute::getSearchModes()

Retrieve the list of searchmodes supported by the attribute.

atkAttribute::getSections()

retrieve the tabs and/or sections for this attribute.

atkAttribute::getTabs()

retrieve the tabs for this attribute.

atkAttribute::getToolTip()

Retrieve the html/javascript code for showing the tooltip for this attribute.

atkAttribute::getView()

Retrieve the html code for placing this attribute in a view page.

atkAttribute::getViewCallback()

Returns the view callback (if set).

atkAttribute::hasDisabledMode()

Check if the attribute is disabled in some mode (use DISABLED_VIEW and DISABLED_EDIT flags).

atkAttribute::hasFlag()

Check if the attribute has a certain flag.

atkAttribute::hasStore()

This function is used to check whether a attribute has a store function or not.

atkAttribute::hide()

Returns a piece of html code for hiding this attribute in an HTML form, while still posting its value. (<input type="hidden">)

atkAttribute::init()

This function is called right after the attribute is added to the node.

atkAttribute::initDependencies()

Initialize and calls the dependencies.

atkAttribute::initialValue()

Initial value. Returns the initial value for this attribute which will be used in the add form etc.

atkAttribute::isEmpty()

Check if a record has an empty value for this attribute.

atkAttribute::isInitialHidden()

check whether initially hidden or not

atkAttribute::isNotNullInDb()

Checks if this attribute is really not null in the database.

atkAttribute::isPosted()

Is there a value posted for this attribute?

atkAttribute::label()

Return the label of the attribute.

atkAttribute::listHeaderSortOrder()

Retrieve the sortorder for the listheader based on the atkColumnConfig

atkAttribute::loadType()

Determine the load type of this attribute.

atkAttribute::maxInputSize()

Determine the maximum length an input field may be.

atkAttribute::needsInsert()

This function is called by the framework to determine if the attribute needs to be saved to the database in an addDb call.

atkAttribute::needsReload()

This function is called by the framework to determine if the attribute needs to be updated from the db regardless of the attribute being present in the postvars/session

atkAttribute::needsUpdate()

This function is called by the framework to determine if the attribute needs to be saved to the database in an updateDb call.

atkAttribute::observeJS()

Observe the given JavaScript event and execute the given JavaScript statements when the event occurs.

atkAttribute::parseStringValue()

Convert a String representation into an internal value.

atkAttribute::partial()

Handle a partial request for this attribute, different attributes support different partials.

atkAttribute::partial_dependencies()

Call dependencies for this attribute and output JavaScript.

atkAttribute::partial_refresh()

Partial method to refresh the add/edit field for this attribute.

atkAttribute::postInit()

This function is called at the end of the node's init method.

atkAttribute::preAddToEditArray()

Prepare for edit. Is called before all attributes are added to the edit array and allows for last minute manipulations based on the record but also manipulations on the record itself.

atkAttribute::preAddToViewArray()

Prepare for view. Is called before all attributes are added to the view array and allows for last minute manipulations based on the record but also manipulations on the record itself.

atkAttribute::registerJavaScriptObservers()

Register JavaScript event handlers.

atkAttribute::registerKeyListener()

Register keyboard navigation for this attribute.

atkAttribute::removeDisabledMode()

Removes a disabled mode from the attribute.

atkAttribute::removeFlag()

Removes a flag from the attribute.

atkAttribute::search()

Returns a piece of html code that can be used to get search terms input from the user.

atkAttribute::searchCondition()

Creates a search condition for a given search value, and adds it to the query that will be used for performing the actual search.

atkAttribute::searchMode()

Returns piece of html which is used for setting/selecting the search mode for this attribute.

atkAttribute::setAttribSize()

Set the size(s) of the attribute

atkAttribute::setAttributeSearchmode()

Sets the searchmode for an attribute This will cause attributes that respect this to use the attributes searchmode for that particulair attribute instead of the general searchmode.

atkAttribute::setColumn()

Set column.

atkAttribute::setDisabledModes()

Sets the disabled mode flag of the attribute

atkAttribute::setEditCallback()

Sets the edit callback.

atkAttribute::setFlags()

Sets the flags of the attribute

atkAttribute::setForceInsert()

Used to force an attribute to update with every addDb() call

atkAttribute::setForceReload()

Used to force an attribute to update from the db regardless of the

atkAttribute::setForceUpdate()

Used to force an attribute to update with every updateDb() call

atkAttribute::setInitialHidden()

Set whether initially hidden or not. A field is "hidden" by adding the class atkAttrRowHidden.

atkAttribute::setInitialValue()

Set initial value for this attribute.

atkAttribute::setLabel()

Set the label of the attribute

atkAttribute::setLoadType()

Sets the load type.

atkAttribute::setOwnerInstance()

Sets the owner instance.

atkAttribute::setPostFixLabel()

Set the label of the attribute

atkAttribute::setSections()

Put the attribute on one or more tabs and/or sections.

atkAttribute::setStorageType()

Sets the storage type.

atkAttribute::setTabs()

Put the attribute on one or more tabs.

atkAttribute::setViewCallback()

Sets the view callback.

atkAttribute::showOnTab()

Check if the attribute wants to be shown on a certain tab.

atkAttribute::smartSearchCondition()

Creates a smart search condition for a given search value, and adds it to the query that will be used for performing the actual search.

atkAttribute::sortOptions()

Retrieves the sort options for this attribute which is used in recordlists and search actions.

atkAttribute::sortOrder()

Sets the sortorder options for this attribute which is used in recordlists and search actions.

atkAttribute::storageType()

Determine the storage type of this attribute.

atkAttribute::sum()

Calculate the sum of 2 records.

atkAttribute::text()

Translate using the owner instance's module and type.

atkAttribute::validate()

Checks if a value is valid.

atkAttribute::value2db()

Converts the internal attribute value to one that is understood by the database.

atkAttribute::_callDependencies()

Calls the dependency callbacks for this attribute.

atkAttribute::_renderChangeHandler()

Renders the onchange code on the page.

atkAttribute::__toString()

String representation for this attribute (PHP5 only).

[ Top ]

Property Summary

array	$m_allowedFileTypes	List of mime types which a uses is allowed to upload Example: array('image/jpeg');
boolean	$m_autonumbering	When set to true, a file is auto-renumbered if another record exists with the same filename.
mixed	$m_dir	Directory with images
mixed	$m_filenameTpl	Name mangle feature. If you set filename tpl, then uploaded files are renamed to what you set in the template. You can use fieldnames between brackets to have the filename determined by the record.
mixed	$m_url

[ Top ]

Method Summary

static string	fetchFileErrorType()	Tests the $_FILE error code and returns the corresponding atk error text token.
static success/failure	mkdir()	Recursive mkdir.
static succes/failure	rmdir()	Recursive rmdir.
atkFileAttribute	atkFileAttribute()	Constructor
string	AddSlash()	returns a string with a / on the end
array	db2value()	Convert value to string
"string"	dbFieldType()	Return the database field type of the attribute.
boolean	delete()	Deletes file from HD
string	display()	Display values
string	edit()	Returns a piece of html code that can be used in a form to edit this attribute's value.
array	fetchValue()	Get filename out of Array
The	filenameMangle()	Determine the real filename of a file (based on m_filenameTpl).
string	getFileExtension()	Get the file extension
array	getFiles()	Returns an array containing files in specified directory optionally filtered by settings from setAllowedFileTypes method.
array	getSearchModes()	Retrieve the list of searchmodes which are supported.
string	hide()	Returns a piece of html code that can be used in a form to display hidden values for this attribute.
boolean	isAllowedFileType()	Check whether the filetype is is one of the allowed file formats. If the FileType array is empty this assumes that all formats are allowed!
boolean	isEmpty()	Check if the attribute is empty..
void	processFile()	Perform processing on an image right after it is uploaded.
boolean	setAllowedFileTypes()	Set the allowed file types. This can either be mime types (detected by the / in the middle or file extensions (without the leading dot!).
void	setAutonumbering()	Turn auto-numbering of filenames on/off.
void	setDir()	Sets the directory into which uploaded files are saved. (See setAutonumbering() and setFilenameTemplate() for some other ways of manipulating the names of uploaded files.)
void	setFilenameTemplate()	Set filename template.
void	validate()	Checks if the file has a valid filetype.
string	value2db()	Convert value to record for database
The	_filenameMangle()	Determine the real filename of a file.
String	_filenameUnique()	Give the file a uniquely numbered filename.

[ Top ]

Properties

array $m_allowedFileTypes = array() [line 103]

List of mime types which a uses is allowed to upload Example: array('image/jpeg');

[ Top ]

boolean $m_autonumbering = false [line 95]

When set to true, a file is auto-renumbered if another record exists with the same filename.

[ Top ]

mixed $m_dir = "" [line 68]

Directory with images

[ Top ]

mixed $m_filenameTpl = "" [line 87]

Name mangle feature. If you set filename tpl, then uploaded files are renamed to what you set in the template. You can use fieldnames between brackets to have the filename determined by the record.

This is useful in the following case: Say, you have a class for managing users. Each user has a photo associated with them. Now, if two users would upload 'gandalf.gif', then you would have a naming conflicht and the picture of one user is overwritten with the one from the other user. If you set m_filenameTpl to "picture_[name]", then the file is renamed before it is stored. If the user's name is 'Ivo Jansch', and he uploads 'gandalf.gif', then the file that is stored is picture_Ivo_Jansch.gif. This way, you have a unique filename per user.

[ Top ]

mixed $m_url = "" [line 69]

[ Top ]

Methods

static method fetchFileErrorType [line 580]

static string fetchFileErrorType(
int
$error 
)

Tests the $_FILE error code and returns the corresponding atk error text token.

Parameters:

int

$error:

API Tags:

Return:

error text token

[ Top ]

static method mkdir [line 385]

static success/failure mkdir(
string
$path 
)

Recursive mkdir.

Parameters:

string

$path:

path to create

API Tags:

See:

http://nl2.php.net/mkdir

[ Top ]

static method rmdir [line 411]

static succes/failure rmdir(
string
$dir 
)

Recursive rmdir.

Parameters:

string

$dir:

path to remove

API Tags:

See:

http://nl3.php.net/rmdir

[ Top ]

Constructor atkFileAttribute [line 112]

atkFileAttribute atkFileAttribute(
string
$name, array
$dir, [int
$flags = 0], [int
$size = 0] 
)

Constructor

Parameters:

string	$name:	Name of the attribute
array	$dir:	Can be a string with the Directory with images/files or an array with a Directory and a Display Url
int	$flags:	Flags for this attribute
int	$size:	Filename size

[ Top ]

AddSlash [line 164]

string AddSlash(
string
$dir_url 
)

returns a string with a / on the end

Parameters:

string

$dir_url:

String with the url/dir

API Tags:

Return:	with a / on the end
Access:	public

[ Top ]

db2value [line 527]

array db2value(
array
$rec 
)

Convert value to string

Parameters:

array

$rec:

Array with fields

API Tags:

Return:

Array with tmpfile, orgfilename,filesize

Redefinition of:

atkAttribute::db2value(): Converts a database value to an internal value.

Redefined in descendants as:

atkMultipleFileAttribute::db2value() : Convert value to string

[ Top ]

dbFieldType [line 938]

"string" dbFieldType(
)

Return the database field type of the attribute.

API Tags:

Return:

which is the 'generic' type of the database field for this attribute.

Redefinition of:

atkAttribute::dbFieldType(): Return the database field type of the attribute.

Redefined in descendants as:

atkMultipleFileAttribute::dbFieldType() : Return the database field type of the attribute.

[ Top ]

delete [line 705]

boolean delete(
array
$record 
)

Deletes file from HD

Parameters:

array

$record:

Array with fields

API Tags:

Return:

False if the delete went wrong

Redefinition of:

atkAttribute::delete(): The delete method is called by the framework to inform the attribute that a record is deleted.

[ Top ]

display [line 722]

string display(
array
$record, [
$mode = ""] 
)

Display values

Parameters:

array	$record:	Array with fields
	$mode:

API Tags:

Return:

Filename or Nothing

Redefinition of:

atkAttribute::display(): Returns a displayable string for this value, to be used in HTML pages.

Redefined in descendants as:

atkMultipleFileAttribute::display() : Display values

[ Top ]

edit [line 220]

string edit(
[array
$record = ""], [string
$fieldprefix = ""], [String
$mode = ""] 
)

Returns a piece of html code that can be used in a form to edit this attribute's value.

Parameters:

array	$record:	Record
string	$fieldprefix:	Field prefix
String	$mode:	The mode we're in ('add' or 'edit')

API Tags:

Return:

piece of html code with a browsebox

Redefinition of:

atkAttribute::edit(): Returns a piece of html code that can be used in a form to edit this attribute's value.

Redefined in descendants as:

atkMultipleFileAttribute::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.

[ Top ]

fetchValue [line 604]

array fetchValue(
array
$rec 
)

Get filename out of Array

Parameters:

array

$rec:

Record

API Tags:

Return:

Array with tmpfile,filename,filesize,orgfilename

Redefinition of:

atkAttribute::fetchValue(): Convert values from an HTML form posting to an internal value for this attribute.

[ Top ]

filenameMangle [line 832]

The filenameMangle(
array
$rec, string
$default 
)

Determine the real filename of a file (based on m_filenameTpl).

Parameters:

array	$rec:	The record
string	$default:	The default filename

API Tags:

Return:	real filename based on the filename template
Access:	public

[ Top ]

getFileExtension [line 770]

string getFileExtension(
string
$filename 
)

Get the file extension

Parameters:

string

$filename:

Filename

API Tags:

Return:

The file extension

[ Top ]

getFiles [line 181]

array getFiles(
string
$dir 
)

Returns an array containing files in specified directory optionally filtered by settings from setAllowedFileTypes method.

Parameters:

string

$dir:

Directory to read files from

API Tags:

Return:

Array with files in specified dir

Redefined in descendants as:

atkMultipleFileAttribute::getFiles() : Returns an array with files extracted from the content of a databasefield

[ Top ]

getSearchModes [line 784]

array getSearchModes(
)

Retrieve the list of searchmodes which are supported.

API Tags:

Return:

List of supported searchmodes

Redefinition of:

atkAttribute::getSearchModes(): Retrieve the list of searchmodes supported by the attribute.

[ Top ]

hide [line 919]

string hide(
[array
$record = ""], [String
$fieldprefix = ""] 
)

Returns a piece of html code that can be used in a form to display hidden values for this attribute.

Parameters:

array	$record:	Array with values
String	$fieldprefix:	The fieldprefix to put in front of the name of any html form element for this attribute.

API Tags:

Return:

Piece of htmlcode

Redefinition of:

atkAttribute::hide(): Returns a piece of html code for hiding this attribute in an HTML form, while still posting its value. (<input type="hidden">)

[ Top ]

isAllowedFileType [line 480]

boolean isAllowedFileType(

&$rec, array
$rec 
)

Check whether the filetype is is one of the allowed file formats. If the FileType array is empty this assumes that all formats are allowed!

Parameters:

array	$rec:
	&$rec:

Information Tags:

Todo:

It turns out that handling mimetypes is not that easy the mime_content_type has been deprecated and there is no Os independend alternative! For now we only support a few image mime types.

[ Top ]

isEmpty [line 695]

boolean isEmpty(
array
$record 
)

Check if the attribute is empty..

Parameters:

array

$record:

the record

API Tags:

Return:

true if empty

Redefinition of:

atkAttribute::isEmpty(): Check if a record has an empty value for this attribute.

[ Top ]

processFile [line 445]

void processFile(
String
$filepath, String
$filename 
)

Perform processing on an image right after it is uploaded.

If you need any resizing or other postprocessing to be done on a file after it is uploaded, you can create a derived attribute that implements the processFile($filepath) method. The default implementation does not do any processing.

Parameters:

String	$filepath:	The path of the uploaded file.
String	$filename:	The name of the uploaded file.

[ Top ]

setAllowedFileTypes [line 456]

boolean setAllowedFileTypes(
array
$types 
)

Set the allowed file types. This can either be mime types (detected by the / in the middle or file extensions (without the leading dot!).

Parameters:

array

$types:

[ Top ]

setAutonumbering [line 152]

void setAutonumbering(
[bool
$autonumbering = true] 
)

Turn auto-numbering of filenames on/off.

When autonumbering is turned on, uploading a file with the same name as the file of another record, will result in the file getting a unique sequence number.

Parameters:

bool

$autonumbering:

API Tags:

Access:

public

[ Top ]

setDir [line 128]

void setDir(
mixed
$dir 
)

Sets the directory into which uploaded files are saved. (See setAutonumbering() and setFilenameTemplate() for some other ways of manipulating the names of uploaded files.)

Parameters:

mixed

$dir:

string with directory path or array with directory path and display url (see constructor)

API Tags:

Access:

public

[ Top ]

setFilenameTemplate [line 799]

void setFilenameTemplate(
string
$template 
)

Set filename template.

Parameters:

string

$template:

[ Top ]

validate [line 560]

void validate(

&$record, String
$mode, array
$record 
)

Checks if the file has a valid filetype.

Note that obligatory and unique fields are checked by the atkNodeValidator, and not by the validate() method itself.

Parameters:

array	$record:	The record that holds the value for this attribute. If an error occurs, the error will be stored in the 'atkerror' field of the record.
String	$mode:	The mode for which should be validated ("add" or "update")
	&$record:

Redefinition of:

atkAttribute::validate(): Checks if a value is valid.

[ Top ]

value2db [line 304]

string value2db(
array
$rec 
)

Convert value to record for database

Parameters:

array

$rec:

Array with Fields

API Tags:

Return:

Nothing or Fieldname or Original filename

Redefinition of:

atkAttribute::value2db(): Converts the internal attribute value to one that is understood by the database.

Redefined in descendants as:

atkMultipleFileAttribute::value2db() : Convert value to record for database

[ Top ]

_filenameMangle [line 817]

The _filenameMangle(
array
$rec, string
$default 
)

Determine the real filename of a file.

If a method <fieldname>_filename exists in the owner instance this method is called with the record and default filename to determine the filename. Else if a file template is set this is used instead and otherwise the default filename is returned.

Parameters:

array	$rec:	The record
string	$default:	The default filename

API Tags:

Return:	real filename
Access:	private

[ Top ]

_filenameUnique [line 859]

String _filenameUnique(
array
$rec, String
$filename 
)

Give the file a uniquely numbered filename.

Parameters:

array	$rec:	The record for thish the file was uploaded
String	$filename:	The name of the uploaded file

API Tags:

Return:	The name of the uploaded file, renumbered if necessary
Access:	private

[ Top ]