Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
FLV_File Class Reference
Inheritance diagram for FLV_File:
File Asset MySource_Object

Public Member Functions

 __construct ($assetid=0)
 
 getAvailableKeywords ()
 
 getKeywordReplacement ($keyword)
 
 saveAttributes ($dont_run_updated=FALSE)
 
 extractMetadata ()
 
- 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 ()
 

Static Public Member Functions

static convertTimeToString ($time)
 

Data Fields

 $allowed_extensions = Array('flv')
 
- 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 33 of file flv_file.inc.

Constructor & Destructor Documentation

__construct (   $assetid = 0)

Constructor

Parameters
int$assetidthe asset id to be loaded

Definition at line 50 of file flv_file.inc.

Member Function Documentation

static convertTimeToString (   $time)
static

Convert a float time in seconds to a time string with the format Minutes:Second

Parameters
$timethe input time in float
Returns
string the return time public

Definition at line 312 of file flv_file.inc.

extractMetadata ( )

Return the metadata of the FLV file of this asset. The result array has the following format

Array ( metadata name => metadata value )

Returns
mixed Return FALSE if the getID3() tool is disabled or there is no FLV file; otherwise, return the array of FLV metadata public

Definition at line 256 of file flv_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 return value is in the form:

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

Definition at line 78 of file flv_file.inc.

getKeywordReplacement (   $keyword)

Get bodycopy keyword replacement

The keywords begin with flv_metadata_ will return the FLV metadata from this asset attributes if they exist, otherwise fresh metadata from the FLV file will be returned.

The keywords begin with dynamic_flv_metadata_ always return fresh metadata from the FLV file.

Parameters
string$keywordKeyword to find a replacement for
Returns
string public
See Also
_getKeywordReplacement

Definition at line 117 of file flv_file.inc.

saveAttributes (   $dont_run_updated = FALSE)

Save attributes set with setAttrValue to the database

This method is overrided here because we want to use the freshly extracted metadata if the checkbox Extract Metadata in the details screen is checked. Setting the extract_metadata attribute to TRUE will trigger this asset to get fresh metadata from the FLV file and store them in its attributes.

Parameters
boolean$dont_run_updatedif TRUE this->_updated() won't be run (THIS IS ONLY EVER CALLED FROM Asset::create())
Returns
boolean public
See Also
setAttrValue()

Definition at line 205 of file flv_file.inc.


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