Procedural File: mime.default.php

Source Location: d:\website\PhpDocumentor\/treasury/plugins/mime.default.php

Page Details:

Tags:

filesource:	Source Code for this file
todo:	since plugins can do just about anything here, we might need the option to create specific tables during install. if required we can scan for files called: table.plugin_guid.php where plugins can insert their own tables
author:	xing <xing@synapse.plus.com>
version:	$Header: /cvsroot/bitweaver/_bit_treasury/plugins/mime.default.php,v 1.30 2007/02/12 15:37:50 squareing Exp $
version:	$Revision: 1.30 $ created Sunday Jul 02, 2006 14:42:13 CEST

TREASURY_MIME_GUID_DEFAULT [line 29]

TREASURY_MIME_GUID_DEFAULT = 'mime_default'

This is the name of the plugin - max char length is 16

As a naming convention, the treasury mime handler definition should start with: TREASURY_MIME_GUID_

[ Top ]

treasury_default_download [line 240]

TRUE treasury_default_download(
 &$pFileHash, array $pFileHash)

Takes care of the entire download process. Make sure it doesn't die at the end.

in this functioin it would be possible to add download resume possibilites and the like

Tags:

return:	on success, FALSE on failure - $pParamHash['errors'] will contain reason for failure
access:	public

Parameters

array	$pFileHash	Basically the same has as returned by the load function
	&$pFileHash

[ Top ]

treasury_default_expunge [line 298]

TRUE treasury_default_expunge(
 &$pParamHash, array $pParamHash)

Nuke data in tables when content is removed

Tags:

return:	on success, FALSE on failure - $pParamHash['errors'] will contain reason for failure
access:	public

Parameters

array	$pParamHash	The contents of TreasuryItem->mInfo
	&$pParamHash

[ Top ]

treasury_default_load [line 194]

TRUE treasury_default_load(
 &$pFileHash, array $pRow)

Load file data from the database

Tags:

return:	on success, FALSE on failure - ['errors'] will contain reason for failure
access:	public

Parameters

array	$pRow
	&$pFileHash

[ Top ]

treasury_default_store [line 158]

TRUE treasury_default_store(
 &$pStoreRow,  &$pCommonObject, array $pStoreRow)

Store the data in the database

Tags:

return:	on success, FALSE on failure - $pStoreRow['errors'] will contain reason
access:	public

Parameters

array	$pStoreRow	File data needed to store details in the database - sanitised and generated in the verify function
	&$pStoreRow
	&$pCommonObject

[ Top ]

treasury_default_update [line 125]

TRUE treasury_default_update(
 &$pStoreRow,  &$pCommonObject, array $pStoreRow)

When a file is edited

Tags:

return:	on success, FALSE on failure - $pStoreRow['errors'] will contain reason
access:	public

Parameters

array	$pStoreRow	File data needed to store details in the database - sanitised and generated in the verify function
	&$pStoreRow
	&$pCommonObject

[ Top ]

treasury_default_verify [line 70]

TRUE treasury_default_verify(
 &$pStoreRow, array $pStoreRow, array $pStoreRow['upload'])

Sanitise and validate data before it's stored

Tags:

return:	on success, FALSE on failure - $pStoreRow['errors'] will contain reason
access:	public

Parameters

array	$pStoreRow	Hash of data that needs to be stored
array	$pStoreRow['upload']	Hash passed in by $_FILES upload
	&$pStoreRow

[ Top ]

Documentation generated on Thu, 15 Feb 2007 20:44:03 +0000 by phpDocumentor 1.3.0