Documentation

Dialog
in package

Launches a CLI file manager to select a file to open, save or open a folder

Table of Contents

$ExcludeWindowsSystemObjects  : bool
$HideDotFiles  : bool
$LangBack  : string
$LangClose  : string
$LangDirectoryNotFound  : string
$LangError  : string
$LangFileNotFound  : string
$LangHelp  : string
$LangHideHelp  : string
$LangInputOnlyFileName  : string
$LangInputPath  : string
$LangInputPathToObject  : string
$LangIsDirectoryError  : string
$LangIsFileError  : string
$LangLoadingDirectoryFailed  : string
$LangNo  : string
$LangObjectNotFound  : string
$LangOk  : string
$LangOpenFile  : string
$LangOpenFolder  : string
$LangOverwriteConfirmation  : string
$LangSaveAs  : string
$LangSaveAsLabel  : string
$LangSaveFile  : string
$LangSelectDirectory  : string
$LangSelectDirectoryNote  : string
$LangToParentDirectory  : string
$LangYes  : string
$TableColumnsPadding  : int
GetMenuBox()  : MenuBox|null
Returns a MenuBox's object of current running Dialog. If Dialog is not running, this method will return NULL
OpenFile()  : string|null
Launches CLI file manager to select file to open
OpenFolder()  : string|null
Launches CLI file manager to select a directory
SaveFile()  : string|null
Launches CLI file manager to select file to overwrite or create a new file
SetLocale()  : void
Changes pseudo-GUI locale

Properties

$ExcludeWindowsSystemObjects

public static bool $ExcludeWindowsSystemObjects = true

$HideDotFiles

public static bool $HideDotFiles = true

$LangBack

public static string $LangBack = "Save as..."

$LangClose

public static string $LangClose = "Save as..."

$LangDirectoryNotFound

public static string $LangDirectoryNotFound = "Save as..."

$LangError

public static string $LangError = "Save as..."

$LangFileNotFound

public static string $LangFileNotFound = "Save as..."

$LangHelp

public static string $LangHelp = "Save as..."

$LangHideHelp

public static string $LangHideHelp = "Save as..."

$LangInputOnlyFileName

public static string $LangInputOnlyFileName = "Save as..."

$LangInputPath

public static string $LangInputPath = "Save as..."

$LangInputPathToObject

public static string $LangInputPathToObject = "Save as..."

$LangIsDirectoryError

public static string $LangIsDirectoryError = "Save as..."

$LangIsFileError

public static string $LangIsFileError = "Save as..."

$LangLoadingDirectoryFailed

public static string $LangLoadingDirectoryFailed = "Save as..."

$LangNo

public static string $LangNo = "Save as..."

$LangObjectNotFound

public static string $LangObjectNotFound = "Save as..."

$LangOk

public static string $LangOk = "Save as..."

$LangOpenFile

public static string $LangOpenFile = "Save as..."

$LangOpenFolder

public static string $LangOpenFolder = "Save as..."

$LangOverwriteConfirmation

public static string $LangOverwriteConfirmation = "Save as..."

$LangSaveAs

public static string $LangSaveAs = "Save as..."

$LangSaveAsLabel

public static string $LangSaveAsLabel = "Save as..."

$LangSaveFile

public static string $LangSaveFile = "Save as..."

$LangSelectDirectory

public static string $LangSelectDirectory = "Save as..."

$LangSelectDirectoryNote

public static string $LangSelectDirectoryNote = "Save as..."

$LangToParentDirectory

public static string $LangToParentDirectory = "Save as..."

$LangYes

public static string $LangYes = "Save as..."

$TableColumnsPadding

public static int $TableColumnsPadding = 32

Methods

GetMenuBox()

Returns a MenuBox's object of current running Dialog. If Dialog is not running, this method will return NULL

public static GetMenuBox() : MenuBox|null
Return values
MenuBox|null —

OpenFile()

Launches CLI file manager to select file to open

public static OpenFile([string|null $defaultPath = null ][, string $defaultFileName = "" ]) : string|null
Parameters
$defaultPath : string|null = null

File manager will start from this directory or from user's home path

$defaultFileName : string = ""

File manager will start from this file if file exists

Tags
throws
DialogAlreadyRunningException
Return values
string|null —

Full path to selected file or NULL if no file selected

OpenFolder()

Launches CLI file manager to select a directory

public static OpenFolder([string|null $defaultPath = null ]) : string|null
Parameters
$defaultPath : string|null = null

File manager will start from this directory or from user's home path

Return values
string|null —

Full path to selected directory or NULL if no directory selected

SaveFile()

Launches CLI file manager to select file to overwrite or create a new file

public static SaveFile([string|null $defaultPath = null ][, string $defaultFileName = "" ]) : string|null
Parameters
$defaultPath : string|null = null

File manager will start from this directory or from user's home path

$defaultFileName : string = ""

File manager will start from this file if file exists

Tags
throws
DialogAlreadyRunningException
Return values
string|null —

Full path to saving file or NULL if no file selected

SetLocale()

Changes pseudo-GUI locale

public static SetLocale(array<string|int, mixed> $locale) : void
Parameters
$locale : array<string|int, mixed>

Use one of constants of the class CliForms\FileSystemDialog\DialogLocales

Return values
void —

Search results