Backend\Widgets\MediaManager

Source: ~/modules/backend/widgets/MediaManager.php

Extends:

Media Manager widget.

Public properties

public boolean $bottomToolbar

Determines whether the bottom toolbar is visible.

public boolean $cropAndInsertButton

Determines whether the Crop & Insert button is visible.

Show inherited public properties

Inherited public properties

Protected properties

protected $brokenImageHash

Show inherited protected properties

Inherited protected properties

Public methods

public void __construct($controller, $alias)

Constructor.

Parameters
  • $controller
  • $alias

public void onApplyName()

public void onChangeView()

public void onCreateFolder()

public void onCropImage()

public void onDeleteItem()

public void onEndCroppingSession()

public void onGenerateThumbnails()

public void onGetSidebarThumbnail()

public void onGoToFolder()

public void onLoadImageCropPopup()

public void onLoadMovePopup()

public void onLoadPopup()

public void onLoadRenamePopup()

public void onMoveItems()

public void onResizeImage()

public void onSearch()

public void onSetFilter()

public void onSetSidebarVisible()

public void onSetSorting()

public string render()

Renders the widget.

Show inherited public methods

Inherited public methods

  • public void __call($name, $params) - defined in October\Rain\Extension\Extendable.
  • public static void __callStatic($name, $params) - defined in October\Rain\Extension\Extendable.
  • public void __get($name) - defined in October\Rain\Extension\Extendable.
  • public void __set($name, $value) - defined in October\Rain\Extension\Extendable.
  • public void addCss(string $name, array $attributes=array()) - defined in Backend\Classes\WidgetBase. Adds StyleSheet asset to the asset list. Call $this->makeAssets() in a view.
  • public void addDynamicMethod(string $dynamicName, callable $method, string $extension=NULL) - defined in October\Rain\Extension\Extendable. Programatically adds a method to the extendable class.
  • public void addDynamicProperty(string $dynamicName, string $value=NULL) - defined in October\Rain\Extension\Extendable. Programatically adds a property to the extendable class.
  • public void addJs(string $name, array $attributes=array()) - defined in Backend\Classes\WidgetBase. Adds JavaScript asset to the asset list. Call $this->makeAssets() in a view.
  • public void addRss(string $name, array $attributes=array()) - defined in Backend\Classes\WidgetBase. Adds an RSS link asset to the asset list. Call $this->makeAssets() in a view.
  • public void addViewPath(string|array $path) - defined in Backend\Classes\WidgetBase. Prepends a path on the available view path locations.
  • public mixed asExtension(string $shortName) - defined in October\Rain\Extension\Extendable. Short hand for getClassExtension() method, except takes the short.
  • public self bindEvent($event, $callback, $priority=0) - defined in Backend\Classes\WidgetBase. Create a new event binding.
  • public self bindEventOnce($event, $callback) - defined in Backend\Classes\WidgetBase. Create a new event binding that fires once only.
  • public void bindToController() - defined in Backend\Classes\WidgetBase. Binds a widget to the controller for safe use.
  • public static void clearExtendedClasses() - defined in October\Rain\Extension\Extendable. Clear the list of extended classes so they will be re-extended.
  • public string combineAssets(array $assets, string $localPath='') - defined in Backend\Classes\WidgetBase. Run the provided assets through the Asset Combiner.
  • public static void extend($callback) - defined in October\Rain\Extension\Extendable.
  • public void extendClassWith(string $extensionName) - defined in October\Rain\Extension\Extendable. Dynamically extend a class with a specified behavior.
  • public mixed extendableCall(string $name, array $params=NULL) - defined in October\Rain\Extension\Extendable. Magic method for __call().
  • public static mixed extendableCallStatic(string $name, array $params=NULL) - defined in October\Rain\Extension\Extendable. Magic method for __callStatic().
  • public void extendableConstruct() - defined in October\Rain\Extension\Extendable. This method should be called as part of the constructor.
  • public static void extendableExtendCallback(callable $callback) - defined in October\Rain\Extension\Extendable. Helper method for ::extend() static method.
  • public string extendableGet(string $name) - defined in October\Rain\Extension\Extendable. Magic method for __get().
  • public string extendableSet(string $name, string $value) - defined in October\Rain\Extension\Extendable. Magic method for __set().
  • public array fireEvent(string $event, array $params=array(), boolean $halt=false) - defined in Backend\Classes\WidgetBase. Fire an event and call the listeners.
  • public mixed fireSystemEvent(string $event, array $params=array(), boolean $halt=true) - defined in Backend\Classes\WidgetBase. Fires a combination of local and global events. The first segment is removed.
  • public string fireViewEvent(string $event, array $params=array()) - defined in Backend\Classes\WidgetBase. Special event function used for extending within view files,
  • public void flushAssets() - defined in Backend\Classes\WidgetBase. Disables the use, and subequent broadcast, of assets. This is useful.
  • public string getAssetPath(string $fileName, string $assetPath=NULL) - defined in Backend\Classes\WidgetBase. Locates a file based on it's definition. If the file starts with.
  • public array getAssetPaths() - defined in Backend\Classes\WidgetBase. Returns an array of all registered asset paths.
  • public mixed getClassExtension(string $name) - defined in October\Rain\Extension\Extendable. Returns a behavior object from an extendable class, example:.
  • public string getConfig(string $name, string $default=NULL) - defined in Backend\Classes\WidgetBase. Safe accessor for configuration values.
  • public string getConfigPath(string $fileName, mixed $configPath=NULL) - defined in Backend\Classes\WidgetBase. Locates a file based on it's definition. If the file starts with.
  • public void getController() - defined in Backend\Classes\WidgetBase. Returns the controller using this widget.
  • public string getEventHandler(string $name) - defined in Backend\Classes\WidgetBase. Returns a fully qualified event handler name for this widget.
  • public string getId(string $suffix=NULL) - defined in Backend\Classes\WidgetBase. Returns a unique ID for this widget. Useful in creating HTML markup.
  • public string getViewPath(string $fileName, mixed $viewPath=NULL) - defined in Backend\Classes\WidgetBase. Locates a file based on its definition. The file name can be prefixed with a.
  • public array getViewPaths() - defined in Backend\Classes\WidgetBase. Returns the active view path locations.
  • public string guessConfigPath(string $suffix='') - defined in Backend\Classes\WidgetBase. Guess the package path for the called class.
  • public string guessConfigPathFrom(string $class, string $suffix='') - defined in Backend\Classes\WidgetBase. Guess the package path from a specified class.
  • public string guessViewPath(string $suffix='', bool $isPublic=false) - defined in Backend\Classes\WidgetBase. Guess the package path for the called class.
  • public string guessViewPathFrom(string $class, string $suffix='', bool $isPublic=false) - defined in Backend\Classes\WidgetBase. Guess the package path from a specified class.
  • public void handleError($exception) - defined in Backend\Classes\WidgetBase. Sets standard page variables in the case of a controller error.
  • public bool hasAssetsDefined() - defined in Backend\Classes\WidgetBase. Returns true if assets any have been added.
  • public void init() - defined in Backend\Classes\WidgetBase. Initialize the widget, called by the constructor and free from its parameters.
  • public boolean isClassExtendedWith(string $name) - defined in October\Rain\Extension\Extendable. Check if extendable class is extended with a behavior object.
  • public string makeAssets(string $type=NULL) - defined in Backend\Classes\WidgetBase. Outputs <link> and <script> tags to load assets previously added with addJs and addCss method calls.
  • public array|stdClass makeConfig(array $configFile=array(), array $requiredConfig=array()) - defined in Backend\Classes\WidgetBase. Reads the contents of the supplied file and applies it to this object.
  • public stdClass makeConfigFromArray(array $configArray=array()) - defined in Backend\Classes\WidgetBase. Makes a config object from an array, making the first level keys properties a new object.
  • public string makeFileContents(string $filePath, array $extraParams=array()) - defined in Backend\Classes\WidgetBase. Includes a file path using output buffering.
  • public Backend\Classes\FormWidgetBase makeFormWidget(string $class, mixed $fieldConfig=array(), array $widgetConfig=array()) - defined in Backend\Classes\WidgetBase. Makes a form widget object with the supplied form field and widget configuration.
  • public mixed makeLayout(string $name=NULL, array $params=array(), bool $throwException=true) - defined in Backend\Classes\WidgetBase. Render a layout.
  • public string makeLayoutPartial(string $partial, array $params=array()) - defined in Backend\Classes\WidgetBase. Renders a layout partial.
  • public mixed makePartial(string $partial, array $params=array(), bool $throwException=true) - defined in Backend\Classes\WidgetBase. Render a partial file contents located in the views folder.
  • public string makeView(string $view) - defined in Backend\Classes\WidgetBase. Loads a view with the name specified. Applies layout if its name is provided by the parent object.
  • public string makeViewContent(string $contents, string $layout=NULL) - defined in Backend\Classes\WidgetBase. Renders supplied contents inside a layout.
  • public Backend\Classes\WidgetBase makeWidget(string $class, array $widgetConfig=array()) - defined in Backend\Classes\WidgetBase. Makes a widget object with the supplied configuration file.
  • public stdClass mergeConfig(mixed $configA, mixed $configB) - defined in Backend\Classes\WidgetBase. Merges two configuration sources, either prepared or not, and returns.
  • public boolean methodExists(string $name) - defined in October\Rain\Extension\Extendable. Checks if a method exists, extension equivalent of method_exists().
  • public boolean propertyExists(string $name) - defined in October\Rain\Extension\Extendable. Checks if a property exists, extension equivalent of property_exists().
  • public void resetSession() - defined in Backend\Classes\WidgetBase. Resets all session data related to this widget.
  • public self unbindEvent(string $event=NULL) - defined in Backend\Classes\WidgetBase. Destroys an event binding.

Protected methods

protected void checkUploadPostback()

protected string cleanFileName(string $name)

Creates a slug form the string. A modified version of Str::slug with the main difference that it accepts @-signs

Parameters
  • string $name

protected void copyBrokenImage($path)
Parameters
  • $path

protected void cropImage($imageSrcPath, $selectionData, $cropSessionKey, $path)
Parameters
  • $imageSrcPath
  • $selectionData
  • $cropSessionKey
  • $path

protected void findFiles($searchTerm, $filter, $sortBy)
Parameters
  • $searchTerm
  • $filter
  • $sortBy

protected void generateThumbnail($thumbnailInfo, $thumbnailParams=NULL)
Parameters
  • $thumbnailInfo
  • $thumbnailParams

protected void getBrokenImageHash()

protected void getBrokenImagePath()

protected void getCropEditImageUrlAndSize($path, $cropSessionKey, $params=NULL)
Parameters
  • $path
  • $cropSessionKey
  • $params

protected void getCropSessionDirPath($cropSessionKey)
Parameters
  • $cropSessionKey

protected void getCurrentFolder()

protected void getFilter()

protected void getLocalTempFilePath($fileName)
Parameters
  • $fileName

protected void getPlaceholderId($item)
Parameters
  • $item

protected void getSearchTerm()

protected void getSelectionParams()

protected void getSidebarVisible()

protected void getSortBy()

protected void getSortDirection()

protected void getTargetDimensions($width, $height, $originalImagePath)
Parameters
  • $width
  • $height
  • $originalImagePath

protected void getThumbnailDirectory()

protected void getThumbnailImagePath($thumbnailParams, $itemPath, $lastModified)
Parameters
  • $thumbnailParams
  • $itemPath
  • $lastModified

protected void getThumbnailImageUrl($imagePath)
Parameters
  • $imagePath

protected void getThumbnailParams($viewMode=NULL)
Parameters
  • $viewMode

protected void getViewMode()

protected void itemTypeToIconClass($item, $itemType)
Parameters
  • $item
  • $itemType

protected void listFolderItems($folder, $filter, $sortBy)
Parameters
  • $folder
  • $filter
  • $sortBy

protected void loadAssets()

Adds widget specific asset files. Use $this->addJs() and $this->addCss() to register new assets to include on the page.

protected void prepareVars()

protected void removeCropEditDir($cropSessionKey)
Parameters
  • $cropSessionKey

protected void resizeImage($fullThumbnailPath, $thumbnailParams, $tempFilePath)
Parameters
  • $fullThumbnailPath
  • $thumbnailParams
  • $tempFilePath

protected void setCurrentFolder($path)
Parameters
  • $path

protected void setFilter($filter)
Parameters
  • $filter

protected void setSearchTerm($searchTerm)
Parameters
  • $searchTerm

protected void setSelectionParams($selectionMode, $selectionWidth, $selectionHeight)
Parameters
  • $selectionMode
  • $selectionWidth
  • $selectionHeight

protected void setSidebarVisible($visible)
Parameters
  • $visible

protected void setSortBy($sortBy)
Parameters
  • $sortBy

protected void setSortDirection($sortDirection)
Parameters
  • $sortDirection

protected void setViewMode($viewMode)
Parameters
  • $viewMode

protected void splitPathToSegments($path)
Parameters
  • $path

protected void thumbnailExists($thumbnailParams, $itemPath, $lastModified)
Parameters
  • $thumbnailParams
  • $itemPath
  • $lastModified

protected void thumbnailIsError($thumbnailPath)
Parameters
  • $thumbnailPath

protected bool validateFileName(string $name)

Validate a proposed media item file name.

Parameters
  • string $name

protected bool validateFileType(string $name)

Check for blocked / unsafe file extensions

Parameters
  • string $name

Show inherited protected methods

Inherited protected methods

  • protected array emitterEventSortEvents(string $eventName) - defined in Backend\Classes\WidgetBase. Sort the listeners for a given event by priority.
  • protected boolean extendableIsAccessible(mixed $class, string $propertyName) - defined in October\Rain\Extension\Extendable. Checks if a property is accessible, property equivalent of is_callabe().
  • protected void extensionExtractMethods(string $extensionName, object $extensionObject) - defined in October\Rain\Extension\Extendable. Extracts the available methods from a behavior and adds it to the.
  • protected void fillFromConfig(array $properties=NULL) - defined in Backend\Classes\WidgetBase. Transfers config values stored inside the $config property directly.
  • protected string getAssetEntryBuildPath(array $asset) - defined in Backend\Classes\WidgetBase. Internal helper, attaches a build code to an asset path.
  • protected string getAssetScheme(string $asset) - defined in Backend\Classes\WidgetBase. Internal helper, get asset scheme.
  • protected string getSession(string $key=NULL, string $default=NULL) - defined in Backend\Classes\WidgetBase. Retrieves a widget related key/value pair from session data.
  • protected void handleViewException(Exception $e, int $obLevel) - defined in Backend\Classes\WidgetBase. Handle a view exception.
  • protected string makeSessionId() - defined in Backend\Classes\WidgetBase. Returns a unique session identifier for this widget and controller action.
  • protected void putSession(string $key, string $value) - defined in Backend\Classes\WidgetBase. Saves a widget related key/value pair in to session data.
  • protected void removeDuplicates() - defined in Backend\Classes\WidgetBase. Removes duplicate assets from the entire collection.