Tv2 documentation

Overview

Package

Tree

Index

Tv2 documentation

PREV NEXT

FRAMES NO FRAME

SUMMARY: FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

tv2-engine
Class tv2FileHelper

tv2Client
  |
  +--tv2FileHelper

class tv2FileHelper
extends tv2Client

A helper class for reading and writing files from ant to tv2Xdb documents.

Authors:: Emilis Dambauskas (emilis@gildija.lt)

Version:: $Id: tv2FileHelper.class.php,v 1.5 2003/12/13 11:14:46 lunaticlt Exp $

Copyright:: 2002–2003 Emilis Dambauskas under Artistic license

Field Summary
`string`	`$file_dir` Directory in which files from document fields are stored
`private object`	`$mime` ctlMimeType class instance

Constructor Summary
`void`	`tv2FileHelper()` Constructor

Method Summary
`void`	`backupToField(string& $fvalue)` extracts document field code from backup
`void`	`fieldToBackup(string& $fvalue)` prepares document field code for backup
`string`	`fileToField(string $name, [string $type], [string $old_value])` Moves local file or uploaded file into document field
`string`	`fileToString(string $name, [string $type], [string $old_value])` Alias of tv2FileHelper::fileToField
`boolean`	`isFieldStoredInFile(string $name)` Checks if the file field is new format (content stored in separate file)
`private string`	`newFileName(string $name)` checks if file name is available and constructs a new name if needed
`mixed`	`puvlic(string $name)` getFileName
`mixed`	`showFileField(string $name)` Outputs file from tv2Xdb document field

Methods inherited from class tv2Client and not overridden

error, loadFileHelper, loadXdb

Field Detail

file_dir

string $file_dir

Directory in which files from document fields are stored

mime

private object $mime

ctlMimeType class instance

Constructor Detail

tv2FileHelper()

void tv2FileHelper()

Constructor

Uses the global variables:: $xdb

Method Detail

backupToField()

void backupToField(string& $fvalue)

extracts document field code from backup

Parameters:: fvalue - field value

fieldToBackup()

void fieldToBackup(string& $fvalue)

prepares document field code for backup

Parameters:: fvalue - field value

fileToField()

string fileToField(string $name, [string $type], [string $old_value])

Moves local file or uploaded file into document field

Parameters:: name - file name
type - file type: local/upload
old_value - old field code (needed to remove old file)

Returns:: document field code

fileToString()

string fileToString(string $name, [string $type], [string $old_value])

Alias of tv2FileHelper::fileToField

Parameters:: name - file name
type - file type: local/upload
old_value - old field code (needed to remove old file)

Returns:: document field code

isFieldStoredInFile()

boolean isFieldStoredInFile(string $name)

Checks if the file field is new format (content stored in separate file)

Parameters:: name - field identifier, format: /path/name:field_name

Returns:: the answer

newFileName()

private string newFileName(string $name)

checks if file name is available and constructs a new name if needed

Parameters:: name - file name

Returns:: file name

puvlic()

mixed puvlic(string $name)

Returns file name for document external file of the document field

Parameters:: name - field identifier, format: /path/name:field_name

Returns:: filename on success, FALSE on failure

showFileField()

mixed showFileField(string $name)

Outputs file from tv2Xdb document field

Parameters:: name - document field. Format: /path/name:fieldname

Returns:: FALSE on error, NULL on success (and outputs file through protocol).