• Inicio
• MetaModels
• Helper
• ToolboxFile

PHP Class MetaModels\Helper\ToolboxFile

Mostrar archivo Open project: metamodels/core Class Usage Examples

Protected Properties

Property	Type	Description
$acceptedExtensions	array	Allowed file extensions.
$baseLanguage	string	Base language, used for retrieving meta.txt information.
$blnShowImages	boolean	Determines if we want to generate images or not.
$fallbackLanguage	string	The fallback language, used for retrieving meta.txt information.
$foundFiles	array	The files to process in this instance.
$metaInformation	array	Meta information for files.
$modifiedTime	array	Buffered modification timestamps.
$outputBuffer	array	Buffered file information.
$pendingIds	array	The pending uuids to collect from DB.
$pendingPaths	string[]	The pending paths to collect from DB.
$resizeImages	array	Image resize information.
$strLightboxId	string	The id to use in lightboxes.
$uuidMap	string[]	File id mapping for files.

Public Methods

Method	Description
__construct ( )	Create a new instance.
addPath ( string $strPath ) : ToolboxFile	Add path to file or folder list.
addPathById ( string $strId ) : ToolboxFile	Contao 3 DBAFS Support.
convertUuidsOrPathsToMetaModels ( array $values ) : array	Convert an uuid or path to a value to be handled by MetaModels.
convertValueToPath ( string $varValue ) : string	Translate the file ID to file path.
convertValuesToDatabase ( array $values ) : array	Convert an array of values handled by MetaModels to a value to be stored in the database (array of bin uuid).
convertValuesToMetaModels ( array $values ) : array	Convert an array of values stored in the database (array of bin uuid) to a value to be handled by MetaModels.
getAcceptedExtensions ( ) : array	Retrieve the allowed file extensions.
getBaseLanguage ( ) : string	Retrieve the base language.
getFallbackLanguage ( ) : string	Retrieve the fallback language.
getFiles ( ) : array	Returns the file list.
getLightboxId ( ) : string	Retrieve the lightbox id to use.
getResizeImages ( ) : array	Retrieve the resize information.
getShowImages ( ) : boolean	Retrieve the flag if images shall be rendered as images.
resolveFiles ( ) : ToolboxFile	Process all folders and resolve to a valid file list.
setAcceptedExtensions ( string | array $acceptedExtensions ) : void	Set the allowed file extensions.
setBaseLanguage ( string $baseLanguage ) : ToolboxFile	Set the base language.
setFallbackLanguage ( string $fallbackLanguage ) : ToolboxFile	Set the fallback language.
setLightboxId ( string $strLightboxId ) : ToolboxFile	Sets the Id to use for the lightbox.
setResizeImages ( array $resizeImages ) : ToolboxFile	Set the resize information.
setShowImages ( boolean $blnShowImages ) : ToolboxFile	Set to show/prepare images or not.
sortFiles ( string $sortType, array $sortIds = [] ) : array	Sorts the internal file list by a given condition.

Protected Methods

Method	Description
addClasses ( array &$arrSource ) : void	Attach first, last and even/odd classes to the given array.
collectFiles ( ) : void	Walks the list of pending folders via ToolboxFile::addPath().
fetchAdditionalData ( ) : void	Walk all files and fetch desired additional information like image sizes etc.
getDownloadLink ( string $strFile ) : string	Generate an URL for downloading the given file.
remapSorting ( array $arrFiles, array $arrSource ) : array	Maps the sorting from the files to the source.
sortByDate ( boolean $blnAscending = true ) : array	Sort by modification time.
sortByIdList ( array $sortIds ) : array	Sort by passed id list.
sortByName ( boolean $blnAscending = true ) : array	Sort by filename.
sortByRandom ( ) : array	Shuffle the file list.

Private Methods

Method	Description
addFileModels ( FilesModel[] $files, array $skipPaths = [] ) : void	Add the passed file model collection to the current buffer if the extension is allowed.
stringToUuid ( string $uuid ) : string	Map a string to it's binary uuid representation.
uuidToString ( string $uuid ) : string	Map a binary uuid to it's string representation.

Method Details

Property Details