MediaManager - October CMS

Contents

Cms\Widgets\MediaManager

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

Extends:

Media Manager widget.

Public properties

There are no public properties in the class.

Show inherited public properties

Protected properties

There are no protected properties in the class.

Show inherited protected properties

Public methods

public void __construct()

Constructor.

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. Programmatically adds a method to the extendable class.
public void addDynamicProperty(string $dynamicName, string $value=NULL) - defined in October\Rain\Extension\Extendable. Programmatically 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 array getClassMethods() - defined in October\Rain\Extension\Extendable. Get a list of class methods, extension equivalent of get_class_methods().
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 array getDynamicProperties() - defined in October\Rain\Extension\Extendable. Returns all dynamic properties and their values.
public string getEventHandler(string $name) - defined in Backend\Classes\WidgetBase. Returns a fully qualified event handler name for this widget.
public string getFatalError() - defined in Backend\Classes\WidgetBase. Returns the fatal error message
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 boolean hasFatalError() - defined in Backend\Classes\WidgetBase. Determines whether a fatal error has been set or not.
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 of 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 array onApplyName() - defined in Backend\Widgets\MediaManager. Reanem library item AJAX handler.
public array onChangeView() - defined in Backend\Widgets\MediaManager. Set view preference AJAX handler.
public array onCreateFolder() - defined in Backend\Widgets\MediaManager. Create library folder AJAX handler.
public array onCropImage() - defined in Backend\Widgets\MediaManager. Crop image AJAX handler.
public array onDeleteItem() - defined in Backend\Widgets\MediaManager. Delete library item AJAX handler.
public array onEndCroppingSession() - defined in Backend\Widgets\MediaManager. End crop session AJAX handler.
public array onGenerateThumbnails() - defined in Backend\Widgets\MediaManager. Generate thumbnail AJAX handler.
public array onGetSidebarThumbnail() - defined in Backend\Widgets\MediaManager. Get thumbnail AJAX handler.
public array onGoToFolder() - defined in Backend\Widgets\MediaManager. Change view AJAX handler.
public array onLoadImageCropPopup() - defined in Backend\Widgets\MediaManager. Load image for cropping AJAX handler.
public array onLoadMovePopup() - defined in Backend\Widgets\MediaManager. Show move item popup AJAX handler.
public array onLoadPopup() - defined in Backend\Widgets\MediaManager. Start image cropping session AJAX handler.
public array onLoadRenamePopup() - defined in Backend\Widgets\MediaManager. Show rename item popup AJAX handler.
public array onMoveItems() - defined in Backend\Widgets\MediaManager. Move library item AJAX handler.
public array onResizeImage() - defined in Backend\Widgets\MediaManager. Resize image AJAX handler.
public array onSearch() - defined in Backend\Widgets\MediaManager. Perform search AJAX handler.
public array onSetFilter() - defined in Backend\Widgets\MediaManager. Set filter preference AJAX handler.
public array onSetSidebarVisible() - defined in Backend\Widgets\MediaManager. Sidebar visibility AJAX handler.
public array onSetSorting() - defined in Backend\Widgets\MediaManager. Set sorting preference AJAX handler.
public boolean propertyExists(string $name) - defined in October\Rain\Extension\Extendable. Checks if a property exists, extension equivalent of property_exists().
public string render() - defined in Backend\Widgets\MediaManager. Renders the widget.
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

Show inherited protected methods

Inherited protected methods

protected void abortIfReadOnly() - defined in Backend\Widgets\MediaManager. Abort the request with an access-denied code if readOnly mode is active.
protected void addAsset(string $type, string $path, array $attributes) - defined in Backend\Classes\WidgetBase. Adds the provided asset to the internal asset collections.
protected void checkUploadPostback() - defined in Backend\Widgets\MediaManager. Detect the upload post flag.
protected string cleanFileName(string $name) - defined in Backend\Widgets\MediaManager. Creates a slug form the string. A modified version of Str::slug.
protected void copyBrokenImage(string $path) - defined in Backend\Widgets\MediaManager. Copy broken image to destination.
protected array cropImage(string $imageSrcPath, string $selectionData, string $cropSessionKey, string $path) - defined in Backend\Widgets\MediaManager. Business logic to crop a media library image.
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_callable().
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 void findFiles(string $searchTerm, string $filter, string $sortBy) - defined in Backend\Widgets\MediaManager. Finds files from within the media library based on supplied criteria,
protected array generateThumbnail(array $thumbnailInfo, array|null $thumbnailParams=NULL) - defined in Backend\Widgets\MediaManager. Generate thumbnail.
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 getBrokenImageHash() - defined in Backend\Widgets\MediaManager. Returns a CRC32 hash for a broken image.
protected string getBrokenImagePath() - defined in Backend\Widgets\MediaManager. Returns the path for the broken image graphic.
protected array getCropEditImageUrlAndSize(string $path, string $cropSessionKey, array $params=NULL) - defined in Backend\Widgets\MediaManager. Prepares an image for cropping and returns payload containing a URL.
protected string getCropSessionDirPath(string $cropSessionKey) - defined in Backend\Widgets\MediaManager. Returns the crop session working directory path.
protected string getCurrentFolder() - defined in Backend\Widgets\MediaManager. Gets the user current folder from the session state.
protected string getFilter() - defined in Backend\Widgets\MediaManager. Gets the user filter from the session state.
protected void getLocalPath($relativePath) - defined in Backend\Classes\WidgetBase.
protected string getLocalTempFilePath(string $fileName) - defined in Backend\Widgets\MediaManager. Get temporary local file path.
protected string getPlaceholderId(System\Classes\MediaLibraryItem $item) - defined in Backend\Widgets\MediaManager. Get placeholder identifier.
protected string getSearchTerm() - defined in Backend\Widgets\MediaManager. Gets the user search term from the session state.
protected array getSelectionParams() - defined in Backend\Widgets\MediaManager. Gets the user selection parameters from the session state.
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 bool getSidebarVisible() - defined in Backend\Widgets\MediaManager. Checks if the sidebar is visible.
protected string getSortBy() - defined in Backend\Widgets\MediaManager. Gets the user sort column from the session state.
protected string getSortDirection() - defined in Backend\Widgets\MediaManager. Gets the user sort direction from the session state.
protected void getTargetDimensions(int $width, int $height, string $originalImagePath) - defined in Backend\Widgets\MediaManager. Get target dimensions.
protected string getThumbnailDirectory() - defined in Backend\Widgets\MediaManager. Get thumbnail directory.
protected string getThumbnailImageExtension(string $itemPath) - defined in Backend\Widgets\MediaManager. Preferred thumbnail image extension.
protected string getThumbnailImagePath(array|null $thumbnailParams, string $itemPath, int $lastModified) - defined in Backend\Widgets\MediaManager. Generates a thumbnail image path.
protected string getThumbnailImageUrl(string $imagePath) - defined in Backend\Widgets\MediaManager. Returns the URL to a thumbnail.
protected array getThumbnailParams(string $viewMode=NULL) - defined in Backend\Widgets\MediaManager. Returns thumbnail parameters.
protected string getViewMode() - defined in Backend\Widgets\MediaManager. Returns the current view mode stored in the session.
protected void handleViewException(Exception $e, int $obLevel) - defined in Backend\Classes\WidgetBase. Handle a view exception.
protected boolean isVector(string $path) - defined in Backend\Widgets\MediaManager. Detect if image is vector graphic (SVG).
protected string itemTypeToIconClass(System\Classes\MediaLibraryItem $item, string $itemType) - defined in Backend\Widgets\MediaManager. Returns an icon for the item type.
protected void listFolderItems(string $searchTerm, string $filter, string $sortBy) - defined in Backend\Widgets\MediaManager. Returns a list of folders and files in a Library folder.
protected void loadAssets() - defined in Backend\Widgets\MediaManager. Adds widget specific asset files. Use $this->addJs() and $this->addCss().
protected string makeSessionId() - defined in Backend\Classes\WidgetBase. Returns a unique session identifier for this widget and controller action.
protected array prepareVars() - defined in Backend\Widgets\MediaManager. Internal method to prepare view variables.
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 removeCropEditDir(string $cropSessionKey) - defined in Backend\Widgets\MediaManager. Cleans up the directory used for cropping based on the session key.
protected void removeDuplicates() - defined in Backend\Classes\WidgetBase. Removes duplicate assets from the entire collection.
protected void resizeImage(string $fullThumbnailPath, array $thumbnailParams, string $tempFilePath) - defined in Backend\Widgets\MediaManager. Resize an image.
protected void setCurrentFolder(string $path) - defined in Backend\Widgets\MediaManager. Sets the user current folder from the session state.
protected void setFilter(string $filter) - defined in Backend\Widgets\MediaManager. Sets the user filter from the session state.
protected void setSearchTerm(string $searchTerm) - defined in Backend\Widgets\MediaManager. Sets the user search term from the session state.
protected void setSelectionParams(string $selectionMode, int $selectionWidth, int $selectionHeight) - defined in Backend\Widgets\MediaManager. Stores the user selection parameters in the session state.
protected void setSidebarVisible(bool $visible) - defined in Backend\Widgets\MediaManager. Sets the sidebar visible state.
protected void setSortBy(string $sortBy) - defined in Backend\Widgets\MediaManager. Sets the user sort column from the session state.
protected void setSortDirection(string $sortDirection) - defined in Backend\Widgets\MediaManager. Sets the user sort direction from the session state.
protected void setViewMode(string $viewMode) - defined in Backend\Widgets\MediaManager. Stores a view mode in the session.
protected array splitPathToSegments(string $path) - defined in Backend\Widgets\MediaManager. Splits a path in to segments.
protected bool thumbnailExists(array|null $thumbnailParams, string $itemPath, int $lastModified) - defined in Backend\Widgets\MediaManager. Check if a thumbnail exists.
protected bool thumbnailIsError(string $thumbnailPath) - defined in Backend\Widgets\MediaManager. Check if a thumbnail has caused an error.
protected bool validateFileName(string $name) - defined in Backend\Widgets\MediaManager. Validate a proposed media item file name.
protected bool validateFileType(string $name) - defined in Backend\Widgets\MediaManager. Check for blocked / unsafe file extensions.

Backend

Behaviors

ImportExportController

Classes

Controllers

Database

Seeds

Facades

FormWidgets

Helpers

Exception

Models

ReportWidgets

Skins

Traits

Widgets

Table

Cms

Classes

Components

Contracts

Controllers

Facades

FormWidgets

Helpers

Models

ReportWidgets

Traits

Twig

Widgets

System

Behaviors

Classes

Console

Controllers

Database

Seeds

Helpers

Models

ReportWidgets

Traits

Twig

Events

backend

ajax

filter

form

list

menu

page

user

cms

ajax

block

combiner

component

object

page

router

template

theme

halcyon

datasource

db

mailer

media

file

folder

model

auth

form

relation

system

assets

console

mirror

theme

sync

reportwidgets

settings