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

Inherited public properties

Protected properties

There are no protected properties in the class.

Show inherited protected properties

Inherited protected properties

Public methods

public void __construct()

Constructor.

Show inherited public methods

Inherited public methods

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 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 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 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.