Webylon 3.1 API Docs
  • Package
  • Class
  • Tree
  • Deprecated
  • Download
Version: current
  • 3.2
  • 3.1

Packages

  • auth
  • Booking
  • cart
    • shipping
    • steppedcheckout
  • Catalog
  • cms
    • assets
    • batchaction
    • batchactions
    • bulkloading
    • comments
    • content
    • core
    • export
    • newsletter
    • publishers
    • reports
    • security
    • tasks
  • Dashboard
  • DataObjectManager
  • event
  • faq
  • forms
    • actions
    • core
    • fields-basic
    • fields-dataless
    • fields-datetime
    • fields-files
    • fields-formatted
    • fields-formattedinput
    • fields-relational
    • fields-structural
    • transformations
    • validators
  • googlesitemaps
  • guestbook
  • installer
  • newsletter
  • None
  • photo
    • gallery
  • PHP
  • polls
  • recaptcha
  • sapphire
    • api
    • bulkloading
    • control
    • core
    • cron
    • dev
    • email
    • fields-formattedinput
    • filesystem
    • formatters
    • forms
    • i18n
    • integration
    • misc
    • model
    • parsers
    • search
    • security
    • tasks
    • testing
    • tools
    • validation
    • view
    • widgets
  • seo
    • open
      • graph
  • sfDateTimePlugin
  • spamprotection
  • stealth
    • captha
  • subsites
  • userform
    • pagetypes
  • userforms
  • webylon
  • widgets

Classes

  • Archive
  • File
  • Filesystem
  • FlushGeneratedImagesTask
  • FLV
  • Folder
  • Folder_UnusedAssetsField
  • GD
  • Image
  • Image_Cached
  • MediawebPage_Image
  • MP3
  • SaveFileSizeTask
  • TarballArchive
  • Upload
  • Upload_Validator
  • VideoFile

Class FLV

This class handles the representation of a File within Sapphire Note: The files are stored in the assets/ directory, but sapphire looks at the db object to gather information about a file such as URL It then uses this for all processing functions (like image manipulation).

Object
Extended by ViewableData implements IteratorAggregate
Extended by DataObject implements DataObjectInterface, i18nEntityProvider
Extended by File
Extended by FLV

Direct known subclasses

VideoFile

Package: sapphire\filesystem
Located at dataobject_manager/code/flv/FLV.php

Methods summary

public static
# set_ffmpeg_root( mixed $path )
public static
# has_ffmpeg( )
public static
# echo_ffmpeg_test( )
protected static
# ffmpeg( mixed $args )
public
# Icon( )

Return the URL of an icon for the file type

Return the URL of an icon for the file type

Overrides

File::Icon
public
# FLVPath( )
public
# FLVLink( )
public
# getThumbnail( )
public
# onBeforeWrite( )

Event handler called before deleting from the database. You can overload this to clean up or otherwise process data before delete this record. Don't forget to call parent::onBeforeWrite(), though!

Event handler called before deleting from the database. You can overload this to clean up or otherwise process data before delete this record. Don't forget to call parent::onBeforeWrite(), though!

Overrides

File::onBeforeWrite
public
# Player( mixed $width = null, mixed $height = null )
public
# forTemplate( )
public
# VideoThumbnail( )
public
# VideoPopup( mixed $arg1 = null, mixed $arg2 = null )

SSViewer doesn't accept more than two arguments for template functions. Here's a hack. If an arg is, e.g. 200x400 it will split that into width/height for thumb for first arg, and popup for second arg.

SSViewer doesn't accept more than two arguments for template functions. Here's a hack. If an arg is, e.g. 200x400 it will split that into width/height for thumb for first arg, and popup for second arg.

Examples: $VideoPopup(450,200) : Returns a video popup with thumbnail 450 width, 200 height. Popup is default dimensions

$VideoPopup(450x200,800x600) : Returns a video popup with thumbnail 450 width, 200 height. Popup is 800 width, 600 height.

$VideoPopup(450x200) : Same as first example.

Methods inherited from File

BackLinkTrackingCount(), CMSThumbnail(), DeleteLink(), Link(), RelativeLink(), TreeTitle(), appCategory(), autosetFilename(), canCreate(), canDelete(), canEdit(), canView(), collateDescendants(), deleteDatabaseOnly(), fieldLabels(), find(), flushCache(), format_size(), getAbsoluteSize(), getAbsoluteURL(), getExtension(), getFileType(), getFilename(), getFullPath(), getLinkedURL(), getRelativePath(), getSize(), getURL(), getUsageCount(), get_file_extension(), instance_get(), onAfterDelete(), onAfterUpload(), onBeforeDelete(), resetFilename(), setField(), setFilename(), setName(), setParentID(), updateLinks(), uploadMetadataFields(), validate()

Methods inherited from DataObject

Aggregate(), RelationshipAggregate(), __construct(), baseTable(), belongs_to(), buildDataObjectSet(), buildSQL(), can(), castedUpdate(), composite_fields(), context_obj(), customDatabaseFields(), custom_database_fields(), data(), databaseFields(), databaseIndexes(), database_extensions(), database_fields(), db(), dbObject(), debug(), defaultSearchFilters(), defineMethods(), delete(), delete_by_id(), destroy(), disableCMSFieldsExtensions(), disable_subclass_access(), duplicate(), enableCMSFieldsExtensions(), enable_subclass_access(), exists(), extendedSQL(), fieldLabel(), flush_and_destroy_cache(), forceChange(), get(), getAllFields(), getCMSActions(), getCMSFields(), getChangedFields(), getClassAncestry(), getComponent(), getComponents(), getComponentsQuery(), getDefaultSearchContext(), getField(), getFrontEndFields(), getManyManyComponents(), getManyManyComponentsQuery(), getManyManyFilter(), getManyManyJoin(), getRemoteJoinField(), getReverseAssociation(), getTitle(), get_by_id(), get_one(), get_validation_enabled(), hasDatabaseField(), hasField(), hasOwnTableDatabaseField(), hasValue(), has_many(), has_one(), has_own_table(), i18n_plural_name(), i18n_singular_name(), inheritedDatabaseFields(), instance_get_one(), isChanged(), isEmpty(), isInDB(), is_composite_field(), many_many(), many_many_extraFields(), merge(), newClassInstance(), onAfterWrite(), plural_name(), populateDefaults(), provideI18nEntities(), relObject(), requireDefaultRecords(), requireTable(), reset(), scaffoldFormFields(), scaffoldSearchFields(), searchableFields(), setCastedField(), setClassName(), setComponent(), set_context_obj(), set_validation_enabled(), singular_name(), summaryFields(), toMap(), update(), write(), writeComponents(), writeWithoutVersion()

Methods inherited from ViewableData

ATT_val(), BaseHref(), CSSClasses(), ColumnBreak(), ColumnCalc(), ColumnNumber(), ColumnPad(), ColumnPos(), CurrentMember(), CurrentPage(), Debug(), Even(), EvenOdd(), First(), FirstLast(), HasPerm(), IsAjax(), JS_val(), Last(), Me(), Middle(), MiddleString(), Modulus(), MultipleOf(), Odd(), Pos(), RAW_val(), SQL_val(), ThemeDir(), ThemeName(), Top(), TotalItems(), XML_val(), __get(), __isset(), __set(), buildCastingCache(), cachedCall(), castingClass(), castingHelper(), castingHelperPair(), castingObjectCreator(), castingObjectCreatorPair(), customise(), escapeTypeForField(), getIterator(), getSecurityID(), getXMLValues(), i18nLocale(), iteratorProperties(), obj(), renderWith(), setCustomisedObj()

Methods inherited from Object

__call(), __toString(), __wakeup(), addMethodsFrom(), addStaticVars(), addWrapperMethod(), add_extension(), add_static_var(), allMethodNames(), cacheToFile(), cacheToFileWithArgs(), clearCache(), combined_static(), create(), createMethod(), create_from_string(), extInstance(), extend(), getCustomClass(), getExtensionInstance(), getExtensionInstances(), get_extensions(), get_static(), hasExtension(), hasMethod(), has_extension(), invokeWithExtensions(), is_a(), loadCache(), parentClass(), parse_class_spec(), remove_extension(), sanitiseCachename(), saveCache(), set_stat(), set_static(), set_uninherited(), stat(), strong_create(), uninherited(), uninherited_static(), useCustomClass()

Magic methods summary

Properties summary

public static array $allowed_file_types
#
public static integer $player_count
#
public static integer $video_width
#
public static integer $video_height
#
public static integer $default_thumbnail_width
#
public static integer $default_thumbnail_height
#
public static string $thumbnail_folder
#
public static string $log_file_path
#
public static integer $default_popup_width
#
public static integer $default_popup_height
#
public static integer $thumbnail_seconds
#
public static integer $audio_sampling_rate
#
public static integer $audio_bit_rate
#
public static boolean $play_button_overlay
#
public static string $default_video_icon_path
#

Properties inherited from File

$allowed_extensions, $apply_restrictions_to_admin, $belongs_many_many, $cache_file_fields, $db, $default_sort, $defaults, $extensions, $has_many, $has_one, $indexes, $many_many, $plural_name, $singular_name

Properties inherited from DataObject

$allowed_actions, $ancestry, $api_access, $belongs_to, $brokenOnDelete, $brokenOnWrite, $cache_get_one, $cache_has_own_table, $cache_has_own_table_field, $casting, $componentCache, $components, $create_table_options, $default_records, $destroyed, $field_labels, $many_many_extraFields, $original, $record, $searchable_fields, $summary_fields

Properties inherited from ViewableData

$customisedObject, $default_cast, $failover, $iteratorPos, $iteratorTotalItems

Properties inherited from Object

$class, $extension_instances

[Raise a SilverStripe Framework issue/bug](https://github.com/silverstripe/silverstripe-framework/issues/new)
- [Raise a SilverStripe CMS issue/bug](https://github.com/silverstripe/silverstripe-cms/issues/new)
- Please use the Silverstripe Forums to ask development related questions. -
Webylon 3.1 API Docs API documentation generated by ApiGen 2.8.0