Inheritance diagram for MP3_File:

Public Member Functions
	__construct ($assetid=0)

	getAvailableKeywords ()

	getKeywordReplacement ($keyword)

	saveAttributes ($dont_run_updated=FALSE)

	getFilePath ($file_name=NULL)

	initID3 ()

	extractID3Metadata ($file_name=NULL)

Public Member Functions inherited from File
	File ($assetid=0)

	create (Array &$link, $info=Array())

	createAdditional (Array &$link)

	cloneComponents (Asset $clone, Array $components, $override=FALSE)

	lockTypes ()

	saveSystemVersion ()

	revertToSystemVersion ()

	clearSystemVersion ()

	morph ($new_type_code)

	processStatusChange ($new_status, $update_parents=TRUE, $run_updated=TRUE)

	_getAllowedLinks ()

	_updated ($update_parents=TRUE)

	permissionsUpdated ()

	usePublicPath ()

	updateLookups ($auto_add_remaps=TRUE)

	processBackend (Backend_Outputter $o, Array &$link)

	saveAttributes ($dont_run_updated=FALSE)

	setAttrValue ($name, $value)

	validFile (Array $info)

	printFrontend ()

	getURL ($base_url=NULL, $ignore_rollback=FALSE)

	getHref ($base_url=NULL, $ignore_rollback=FALSE)

	getExistingFile ()

	_getName ($short_name=FALSE, $contextid=NULL)

	getAvailableKeywords ()

	getAssetFileSizeInBytesKeywordReplacement ()

	getAssetFileSizeReadableKeywordReplacement ()

	getAssetFileContentsKeywordReplacement ()

	delete ($release_lock=TRUE)

	scanFile ($path='')

	getFileTypeKeywordReplacement ()

	getAssetSummary ()

	getOriginalURL ($data_url, $site_url)

Public Member Functions inherited from Asset
	Asset ($assetid=0)

	create (Array &$link)

	load ($assetid)

	_loadDataPaths ()

	reload ()

	canDelete ()

	delete ($release_lock=TRUE, $check_locked=TRUE)

	useSystemVersion ()

	loadSystemVersion ()

	saveSystemVersion ()

	clearSystemVersion ()

	revertToSystemVersion ()

	revertNoticeLinksToSystemVersion ()

	_updated ($update_parents=TRUE)

	type ()

	getTypeAncestors ($include_asset=TRUE)

	incrementVersion ($number='micro', $update_parents=TRUE)

	getLanguages ()

	setLanguages (Array $languages)

	setCharset ($charset)

	setForceSecure ($force_secure)

	remapAssetids (Array $map)

	morph ($new_type_code)

	_morphCleanup ($new_type_code)

	onRequestKeywords (Asset $broadcaster, Array $vars=Array())

	canClone ()

	cloneComponents (Asset $clone, Array $components, $override=FALSE)

	cloneComponentsAdditional (Asset $clone, Array $components)

	cloneLinks (Asset $clone)

	getStatus ()

	getAvailableStatii ()

	getStatusDescription ()

	processStatusChange ($new_status, $update_parents=TRUE, $run_updated=TRUE)

	setDate ($date_type, $time=NULL, $userid=NULL)

	lockTypes ()

	canForceablyAcquireLock ($lock_type)

	getEditingLocks ($keywords)

	_getAllowedLinks ()

	createLink (Asset $minor, $link_type, $value='', $sort_order=NULL, $dependant='0', $exclusive='0', $moving=FALSE, $locked=0)

	prepareLink (Asset $asset, $side_of_link, &$link_type, &$value, &$sort_order, &$dependant, &$exclusive)

	canCreateLink (Asset $minor, $link_type, $exclusive)

	canMoveLink (Asset $minor, Asset $old_major, $link_type)

	describeLink ($linkid)

	isDeletableLink ($linkid)

	canDeleteLink ($linkid)

	deleteLink ($linkid, $check_locked=TRUE)

	linksUpdated ()

	canCloneLink ()

	saveAttributes ($dont_run_updated=FALSE, $log_message=TRUE)

	setAttrValue ($name, $value)

	attr ($name)

&	attrByRef ($name)

	getAttribute ($name, $mute_errors=FALSE)

	getAssetKeywords ($descriptions=FALSE)

	getAvailableKeywords ()

	getKeywordReplacement ($keyword)

	getAssetWebPathKeywordReplacement ()

	getCustomKeywordReplacements ($keywords=Array(), $invoke_backend=FALSE)

	processCustomKeywords ($keywords=Array())

	getContent ()

	setContent ()

	getEffectiveLastUpdatedTime ($assetids)

	readAccess (Array $assetids=Array())

	writeAccess ($lock_type='', Array $assetids=Array(), $only_workflow=TRUE)

	adminAccess ($lock_type='', Array $assetids=Array())

	backendAccess ()

	liveEditAccess ($lock_type)

	canliveEdit ($lock_type)

	effectiveUnrestricted ()

	checkAccess ($perm, $lock_type, Array $assetids=Array(), $only_workflow=TRUE)

	accessEffective ()

	permissionsUpdated ()

	printFrontend ()

	printFrontendAsset (Asset $asset, $design=NULL)

	getValidProtocols ()

	printHead ()

	printBody ()

	getCurrentPaintLayoutName ()

	getCurrentDesignName ()

	printBodyWithPaintLayout ($layout_id='')

	initLimbo ()

	printLimbo ()

	paintBackend (Backend_Outputter $o)

	getPrefix ()

	processBackend (Backend_Outputter $o, Array &$link)

	getEI ()

	getEditFns ()

	getBackendHref ($screen='', $backend_page=TRUE)

	getURL ($base_url=NULL, $ignore_rollback=FALSE, $base_contextid=NULL)

	getURLs ()

	getHref ($base_url=NULL, $ignore_rollback=FALSE)

	getWebDataPath ()

	getWebPaths ()

	saveWebPaths ($paths, $auto_add_remaps=TRUE)

	getLookups ($field='')

	getDesignLookups ()

	getLookupValues ($inherited=NULL, $prefix='', $like_search=TRUE, $ignore_override=FALSE)

	deleteLookupValue ($layout_name, $layout_value)

	setPaintLayouts ($layouts)

	updateLookups ($auto_add_remaps=TRUE)

	setLookupValues (Array $values)

	getAssetStatusDescriptionKeywordReplacement ()

	getAssetStatusColourKeywordReplacement ()

	replaceKeywordsInString ($string)

	fastTrack ($tasks)

	unFastTrack ($tasks)

	shouldFastTrack ($task, $assetid=NULL)

	getFaskTrackedTaskAssetids ($task)

	getDependantParentsURL ()

Public Member Functions inherited from MySource_Object
	MySource_Object ()

	__sleep ()

	__wakeup ()

Data Fields
	$allowed_extensions = Array('mp3')

Data Fields inherited from File
	$allowed_extensions = Array()

	$ignore_update = FALSE

Data Fields inherited from Asset
	$id = 0

	$version = ''

	$name = ''

	$short_name = ''

	$status

	$languages = ''

	$charset = ''

	$force_secure = '0'

	$created

	$created_userid

	$updated

	$updated_userid

	$published

	$published_userid

	$status_changed

	$status_changed_userid

	$_is_cacheable = FALSE

	$vars = Array()

	$_available_keywords = Array()

	$data_path_suffix = ''

	$data_path = ''

	$data_path_public = ''

	$_ser_attrs = FALSE

Data Fields inherited from MySource_Object
	$_tmp

Additional Inherited Members
Protected Member Functions inherited from File
	_preCreateCheck (Array &$link)

	_createAdditional (Array &$link)

	_checkFileState ()

	_removePublicFile ()

	_updatePublicFile ()

	insertDataLookup ()

	_renameFile ($data_path, $old_filename, $new_filename)

	_validFileSize (Array &$info, $pre_uploaded=FALSE)

	_validFileExtension (Array &$info, $pre_uploaded=FALSE)

Detailed Description

Definition at line 37 of file mp3_file.inc.

Constructor & Destructor Documentation

__construct ( $assetid = 0 )

Constructor

Parameters

int $assetid the asset id to be loaded

Definition at line 50 of file mp3_file.inc.

Member Function Documentation

extractID3Metadata ( $file_name = NULL )

Pulls out metadata from a specified file using getID3() and returns them in a more friendly format

Returns FALSE if extraction is disabled, or there was a problem with extraction.

ID3 tags returned: title, album, artist, track, year, genre. ID3v2 tags are checked first, if they don't exist then ID3v1 is. For ID3v2, the "content type" tag is either converted to an ID3v1 genre if in the correct format, or the whole field is returned as genre. Only those fields actually extracted are returned.

Audio-related tags returned (these will be returned even if there is no ID3 data to return):

length: Duration of track in seconds. Probably fractional.
bitrate: The bitrate (or average bitrate if VBR) in bits/s. Likely fractional if VBR.
sample_rate: The sample rate in Hz
is_vbr: TRUE if encoded with variable bit rate
channels: 1 for mono, 2 for stereo, 5/6 for MP3 Surround files

Parameters

string $file_name The file to check for metadata. Defaults To the current file.

Returns: mixed

Definition at line 461 of file mp3_file.inc.

getAvailableKeywords ( )

Return the keywords for this asset type.

This function is called in asset-listing situations like the asset listing, search page etc The $replacement = value is in the form:

Array(
  'name' => 'description' => 'the asset name',
);

$replacement = array public

Definition at line 71 of file mp3_file.inc.

getFilePath ( $file_name = NULL )

Gets the correct file path

Parameters

string $file_name An optional file name to pass

Returns: string

Definition at line 372 of file mp3_file.inc.

getKeywordReplacement ( $keyword )

Get bodycopy keyword replacement

Provides a mechanism for dynamically extracting ID3 data from an MP3 file and using it in place of the keyword. Keywords data is pulled from the file itself and does not rely on the data being in the database.

Parameters

string $keyword Keyword to find a replacement for

$replacement = string public

Definition at line 111 of file mp3_file.inc.

initID3 ( )

This function initialises getID3() and returns the id3 object It is useful so that we don't have to do this multiple times

Returns: object

Definition at line 393 of file mp3_file.inc.

saveAttributes ( $dont_run_updated = FALSE )

Save attributes for this asset

Overrides the setting of the extract_id3 attribute. If set, it will reset the attribute, and set the appropriate metadata fields to the extracted ID3 data.

Parameters

boolean $dont_run_updated If TRUE, saveAttributes() in Asset class won't run _updated() afterward. (Only to be called from create() function.)

Returns: boolean

Definition at line 254 of file mp3_file.inc.

The documentation for this class was generated from the following file:

/Users/webmaster/Desktop/squiz_matrix/core/assets/files/mp3_file/mp3_file.inc

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation