Class TableFile

TableAccess

TableFile

Copyright: 2004-2016 The Admidio Team
License: GNU General Public License v2.0 only **********************************************************************************************
Class:

TableFile Diese Klasse dient dazu ein Fileobjekt zu erstellen. Eine Datei kann ueber diese Klasse in der Datenbank verwaltet werden

Beside the methods of the parent class there are the following additional methods:

getFileForDownload($fileId) - File mit der uebergebenen ID aus der Datenbank auslesen fuer das Downloadmodul. Hier wird auch direkt ueberprueft ob die Datei oder der Ordner gesperrt ist. getCompletePathOfFile() - Gibt den kompletten Pfad der Datei zurueck

Located at tablefile.php

Methods summary

`public`	# `__construct( Database & $database, integer $fil_id = 0 )` Constructor that will create an object of a recordset of the table adm_files. If the id is set than the specific files will be loaded. Constructor that will create an object of a recordset of the table adm_files. If the id is set than the specific files will be loaded. Parameters `$database` Object of the class Database. This should be the default global object @b $gDb. `$fil_id` The recordset of the files with this id will be loaded. If id isn't set than an empty object of the table is created. Overrides `TableAccess::__construct`
`public boolean`	# `delete( )` Deletes the selected record of the table and the associated file in the file system. After that the class will be initialize. Deletes the selected record of the table and the associated file in the file system. After that the class will be initialize. Returns boolean @b true if no error occurred Overrides `TableAccess::delete`
`public string`	# `getCompletePathOfFile( )` Gibt den kompletten Pfad der Datei zurueck Gibt den kompletten Pfad der Datei zurueck Returns string
`public true`	# `getFileForDownload( integer $fileId )` Reads the file recordset from database table @b adm_folders and throws an AdmException if the user has no right to see the corresponding folder or the file id doesn't exists. Reads the file recordset from database table @b adm_folders and throws an AdmException if the user has no right to see the corresponding folder or the file id doesn't exists. Parameters `$fileId` The id of the file. Returns true Returns @b true if everything is ok otherwise an AdmException is thrown. Throws `AdmException` DOW_FOLDER_NO_RIGHTS SYS_INVALID_PAGE_VIEW
`public integer\|string\|boolean`	# `getValue( string $columnName, string $format = '' )` If the value was manipulated before with @b setValue than the manipulated value is returned. If the value was manipulated before with @b setValue than the manipulated value is returned. Parameters `$columnName` The name of the database column whose value should be read `$format` For date or timestamp columns the format should be the date/time format e.g. @b d.m.Y = '02.04.2011'. @n For text columns the format can be @b database that would return the original database value without any transformations Returns integer\|string\|boolean Returns the value of the database column. If the value was manipulated before with @b setValue than the manipulated value is returned. Overrides `TableAccess::getValue`
`public boolean`	# `save( boolean $updateFingerPrint = true )` Save all changed columns of the recordset in table of database. Therefore the class remembers if it's a new record or if only an update is necessary. The update statement will only update the changed columns. If the table has columns for creator or editor than these column with their timestamp will be updated. For new records the user and timestamp will be set per default. Save all changed columns of the recordset in table of database. Therefore the class remembers if it's a new record or if only an update is necessary. The update statement will only update the changed columns. If the table has columns for creator or editor than these column with their timestamp will be updated. For new records the user and timestamp will be set per default. Parameters `$updateFingerPrint` Default @b true. Will update the creator or editor of the recordset if table has columns like @b usr_id_create or @b usr_id_changed Returns boolean If an update or insert into the database was done then return true, otherwise false. Overrides `TableAccess::save`

Methods inherited from TableAccess

__sleep(), clear(), connectAdditionalTable(), countAllRecords(), hasColumnsValueChanged(), isNewRecord(), readData(), readDataByColumns(), readDataById(), setArray(), setDatabase(), setValue()

Properties summary

Properties inherited from TableAccess

$additionalTables, $columnPrefix, $columnsInfos, $columnsValueChanged, $db, $dbColumns, $keyColumnName, $new_record, $tableName

Packages

Classes

Exceptions

Functions

Class TableFile

Methods summary

Parameters

Overrides

Returns

Overrides

Returns

Parameters

Returns

Throws

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Methods inherited from TableAccess

Properties summary

Properties inherited from TableAccess