BEdita API doc | 4-cactus
  • Class
  • Tree
  • Deprecated
  • Download

Classes

  • Addon
  • AddressbookController
  • AddressbookShell
  • AdminController
  • Alias
  • Annotation
  • ApiAuthComponent
  • ApiBaseController
  • ApiFormatterComponent
  • ApiUploadComponent
  • ApiValidatorComponent
  • AppController
  • AppError
  • AppHelper
  • Application
  • AppModel
  • Area
  • AreasController
  • Audio
  • AuthenticationsController
  • BannedIp
  • BEAppModel
  • BEAppObjectModel
  • BeAuthComponent
  • BeAuthFacebookComponent
  • BeAuthGoogleComponent
  • BeAuthTwitterComponent
  • BeCallbackManager
  • BeConfigure
  • BeCustomPropertyComponent
  • BeditaAnnotationModel
  • BeditaBaseShell
  • BeditaCollectionModel
  • BeditaContentModel
  • BeditaExportFilter
  • BeditaImportFilter
  • BeditaObjectModel
  • BeditaProductModel
  • BeditaShell
  • BeditaSimpleObjectModel
  • BeditaSimpleStreamModel
  • BeditaStreamModel
  • BeEmbedFlashHelper
  • BeEmbedHtml5Helper
  • BeEmbedMediaHelper
  • BeErrorCode
  • BeExceptionHandler
  • BEFile
  • BeFileHandlerComponent
  • BeFormHelper
  • BeFrontHelper
  • BeHashComponent
  • BeHtmlHelper
  • BeLangTextComponent
  • BeLib
  • BeMailComponent
  • BEObject
  • BeObjectCache
  • BePaginatorToolbarHelper
  • BeSchema
  • BeSecurityComponent
  • BeSystem
  • BeSystemComponent
  • BeThumb
  • BeTimeHelper
  • BeToolbarHelper
  • BeTreeComponent
  • BeTreeHelper
  • BeUploadToObjComponent
  • BeurlHelper
  • BeVimeoComponent
  • BeYoutubeComponent
  • BuildFilterBehavior
  • CacheableBehavior
  • CacheShell
  • CallbackBehavior
  • CaptchaComponent
  • Caption
  • CaptionsBehavior
  • Card
  • CardsImportFilter
  • Category
  • CleanupDataTask
  • CleanupTask
  • Comment
  • CommentsController
  • CompactResultBehavior
  • Content
  • CreateIndexFieldsBehavior
  • DataShell
  • DataTransfer
  • DateItem
  • DbadminShell
  • DeleteDependentObjectBehavior
  • DeleteObjectBehavior
  • DeployShell
  • Document
  • DocumentsController
  • DumpModel
  • EditorialContentsShell
  • EditorNote
  • Event
  • EventLog
  • EventsController
  • FilesController
  • ForeignDependenceSaveBehavior
  • FrontendController
  • FrontendShell
  • GalleriesController
  • Gallery
  • GeoTag
  • GettextShell
  • Git
  • GravatarHelper
  • Group
  • HashJob
  • History
  • HomeController
  • Image
  • ImageInfoHelper
  • JsonExportFilter
  • JsonImportFilter
  • JsonView
  • LangText
  • Link
  • MailGroup
  • MailGroupCard
  • MailJob
  • MailLog
  • MailMessage
  • MailShell
  • MailTemplate
  • Mask
  • MediaShell
  • MigrateDumpModel
  • MigrateShell
  • Migration
  • MigrationBase
  • MigrationDateItemsShell
  • Module
  • ModulesController
  • ModuleShell
  • MultimediaController
  • NewsController
  • NewsletterController
  • NewsletterShell
  • NotifyBehavior
  • ObjectEditor
  • ObjectProperty
  • ObjectRelation
  • ObjectType
  • ObjectUser
  • PagesController
  • Permission
  • PermissionModule
  • PermsHelper
  • Product
  • Property
  • PropertyOption
  • PublicationShell
  • RedisShell
  • RelationCheck
  • RelationRepair
  • RelationShell
  • RelationStats
  • RemoveDummyNameBehavior
  • ResponseHandlerComponent
  • RestClientModel
  • Revision
  • RevisionObjectBehavior
  • SearchText
  • SearchTextSaveBehavior
  • Section
  • SectionDummy
  • SessionFilterComponent
  • SessionFilterHelper
  • ShortNews
  • SmartyView
  • SoapClientModel
  • SplitterSql
  • StatisticsController
  • Stream
  • StreamLog
  • StreamsController
  • Svn
  • TagsController
  • ThemeSmartyView
  • ThumbnailHelper
  • ThumbShell
  • TransactionComponent
  • TransactionFS
  • TranslationsController
  • Tree
  • TrHelper
  • User
  • UserProperty
  • UsersController
  • Utility
  • Version
  • Video
  • VimeoHelper
  • WebmarksController
  • XmlExportFilter
  • XmlImportFilter
  • XmlJsonConverter
  • XmlView
  • YoutubeHelper

Interfaces

  • ApiAuthInterface
  • MediaProviderInterface
  • UploadableInterface

Exceptions

  • BeditaAjaxException
  • BEditaAllowURLException
  • BeditaBadRequestException
  • BeditaConflictException
  • BEditaDeleteStreamObjException
  • BeditaException
  • BEditaFileExistException
  • BeditaForbiddenException
  • BeditaFrontAccessException
  • BeditaHashException
  • BEditaInfoException
  • BeditaInternalErrorException
  • BEditaIOException
  • BeditaLengthRequiredException
  • BeditaMailException
  • BEditaMediaProviderException
  • BeditaMethodNotAllowedException
  • BEditaMIMEException
  • BeditaNotFoundException
  • BeditaNotImplementedException
  • BeditaPublicationException
  • BeditaRuntimeException
  • BEditaSaveStreamObjException
  • BeditaServiceUnavailableException
  • BeditaUnauthorizedException
  • BEditaUploadPHPException
  • BEditaURLException

Class Stream

Basic Stream

Model
Extended by AppModel
Extended by BEAppModel
Extended by Stream
Version: $Revision$
Modifiedby: $LastChangedBy$
Lastmodified:

$LastChangedDate$

$Id$


Located at models/objects/content/stream.php

Methods summary

public
# getIdFromFilename( string $filename )

Get id from filename

Get id from filename

Parameters

$filename
public
# getCategoryMediaType( string $mimeType, string $modelType )

Get default category media type from mime and model

Get default category media type from mime and model

Parameters

$mimeType
$mimeType, stream mime type
$modelType
$modelType, model type: "Image", "Video",...
public array
# updateStreamFields( integer $id = null )

Update fields in streams table: url friendly name, mime type, file size, hash

Update fields in streams table: url friendly name, mime type, file size, hash

Parameters

$id
$id, stream id to update - if empty update all streams

Returns

array
of updated streams (empty array if no array updated)
public mixed,
# clearMediaCache( integer $id = null )

Clears media cache, using both new cache structure ($mediaRoot/cache) and old structure. See: https://github.com/bedita/bedita/issues/352

Clears media cache, using both new cache structure ($mediaRoot/cache) and old structure. See: https://github.com/bedita/bedita/issues/352

Parameters

$id
$id, object id of which clear cache

Returns

mixed,

false if no stream was found empty array if cleaning operation proceeds without errors array with errors if something goes wrong. Itcontains: 'failed' => array of objects data on which clear media failed. Each item contains: 'id' => object id, 'error' => message error

public mixed
# getMediaProvider( $uri )

return media provider array or false if $uri it's not managed

return media provider array or false if $uri it's not managed

Parameters

$uri

Returns

mixed
array("provider" => "", "uri" => "", "video_uid" => "") or false if not found
public string
# getMimeType( $path, $filename = null )

get mime type by finfo_open (if function exist) or by file extension

get mime type by finfo_open (if function exist) or by file extension

Parameters

$path
path of file
$filename

Returns

string
or false if mime_type not found
public string
# getMimeTypeByExtension( $filename )

get mime type by file extension

get mime type by file extension

Parameters

$filename

Returns

string
or false if mime_type not found
public
# setMimeTypes( )

set Stream::mimeTypes array using bedita-app/config/mimi.types.php file

set Stream::mimeTypes array using bedita-app/config/mimi.types.php file

public array
# getMimeTypes( )

get Stream::mimeTypes

get Stream::mimeTypes

Returns

array
of mime type
public
# appendStreamFields( array $objects, array $options = array() )

append stream fields to objects array

append stream fields to objects array

Parameters

$objects
$options
public string
# copyFileToMediaFolder( string $source, string $destPath )

Copy $name to $destPath using BEdita media logic (it's not a direct copy of the file) Create md5-named subfolders for file

Copy $name to $destPath using BEdita media logic (it's not a direct copy of the file) Create md5-named subfolders for file

Return new relative path to file

Parameters

$source
file
$destPath
folder

Returns

string
new relative path to file
public array
# apiUploadQuota( array $uploadableObjects, array $user, object $event )

Given an array of uploadable object types and a user it calculate the quota occupied and the total number of multimedia objects for that user divided by type.

Given an array of uploadable object types and a user it calculate the quota occupied and the total number of multimedia objects for that user divided by type.

The result is merged with $event->result and returned in the form

array(
    'image' => array(
        'size' => 12345678,
        'number' => 256
     ),
     'video' => array(
        'size' => 123456789,
        'number' => 15
     ),
)

This method is intended to use as listener of event system Used for example by ApiUploadComponent

Parameters

$uploadableObjects
The array of uploadable object types
$user
The user data
$event
The event coming from BeCallbackManager

Returns

array

Methods inherited from BEAppModel

am(), buildQueryStatement(), checkDate(), checkDuration(), checkFloat(), checkNumber(), containLevel(), email(), fieldsString(), findObjects(), findObjectsAfterFilter(), findObjectsClauses(), findObjectsCount(), getBindingsLevel(), getDefaultDateFormat(), getDriver(), getEndQuote(), getLimitClausole(), getStartQuote(), setBindingsLevel(), setupDbParams(), toolbar()

Methods inherited from AppModel

apiTransformer()

Properties summary

private array $mimeTypes

of mime types

of mime types

# array()

Properties inherited from BEAppModel

$actsAs, $driver, $eQ, $modelBindings, $sQ

Properties inherited from AppModel

$apiTransformerOptions

BEdita API doc | 4-cactus API documentation generated by ApiGen