als / path
Path Component.
Installs: 118
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 1
Open Issues: 0
Language:OpenEdge ABL
Requires (Dev)
- parser/composer: ^1.0
This package is auto-updated.
Last update: 2024-10-24 18:23:28 UTC
README
Path Component.
Documentations
Properties
Methods
$PROPERTY: delimiter
Provides the path delimiter.
Example
${Als/Path:delimiter} #--> ':' $env:PATH #--> '/usr/local/bin:/usr/bin:/bin' $paths[^env:PATH.split[${Als/Path:delimiter};h]] #--> |/usr/local/bin|/usr/bin|/bin|
$PROPERTY: separator
Provides the path segment separator.
Example
${Als/Path:separator} #--> '/' $path[/assets/images/icons.png] $parts[^path.split[${Als/Path:separator};h]] #--> |assets|images|icons.png|
$PROPERTY: cwd
Contains the absolute path of the 'DOCUMENT_ROOT'.
Example
${Als/Path:cwd} #--> '/home/username/host/www'
@METHOD: basename
The ^Als/Path:basename[]
methods returns the last portion of a path
, similar to the Unix basename
command.
Syntax
^Als/Path:basename[path[;ext]]
Params
- $path
<string>
- $ext
<string>
An optional file extension.
Example
^Als/Path:basename[/foo/bar/baz/asdf/quux.html] #--> 'quux.html' ^Als/Path:basename[/foo/bar/baz/asdf/quux.html;.html] #--> 'quux'
@METHOD: dirname
The ^Als/Path:dirname[]
method returns the directory name of a path
, similar to the Unix dirname
command.
Syntax
^Als/Path:dirname[path]
Params
- $path
<string>
Example
^Als/Path:dirname[/foo/bar/baz/asdf/quux] #--> '/foo/bar/baz/asdf'
@METHOD: extname
The ^Als/Path:extname[]
method returns the extension of the path
, from the last occurance of the .
(period) character to end of string in the last portion of the path
. If there is no .
in the last portion of the path
, or if the first character of the basename of path
(see ^Als/Path:basename[]
) is .
, then an empty string is returned.
Syntax
^Als/Path:extname[path]
Params
- $path
<string>
Example
^Als/Path:extname[index.html] #--> '.html' ^Als/Path:extname[index.coffee.md] #--> '.md' ^Als/Path:extname[index.] #--> '.' ^Als/Path:extname[index] #--> '' ^Als/Path:extname[.index] #--> ''
@METHOD: format
The ^Als/Path:format[]
method returns a path string from an <hash>
. This is the opposite of ^Als/Path:parse[]
.
Syntax
^Als/Path:format[hPath]
Params
- $hPath
<hash>
- $.dir
<string>
- $.root
<string>
- $.base
<string>
- $.name
<string>
- $.ext
<string>
- $.dir
The following process is used when constructing the path string:
$result
is set to an empty string.- If
$.dir[]
is specified,$.dir[]
is appended to$result
followed by the value of$Als/Path:separator
; - Otherwise, if
$.root[]
is specified,$.root[]
is appended to$result
. - If
$.base[]
is specified,$.base[]
is appended to$result
; - Otherwise:
- If
$.name[]
is specified,$.name[]
is appended to$result
- If
$.ext[]
is specified,$.ext[]
is appended to$result
.
- If
- Return
$result
Example
# If 'dir' and 'base' are provided: # ${dir}${separator}${base} # will be returned. ^Als/Path:format[ $.dir[/home/user/dir] $.base[file.txt] ] //--> '/home/user/dir/file.txt' # 'root will be used if 'dir' is not specified. # If only 'root' is provided or 'dir' is equal to 'root' # then the separator will not be included. ^Als/Path:format[ $.root[/] $.base[file.txt] ] #--> '/file.txt' # `name` + `ext` will be used if `base` is not specified. ^Als/Path:format[ $.root[/] $.name[file] $.ext[.txt] ] #--> '/file.txt' # `base` will be returned if `dir` or `root` are not provided. ^Als/Path:format[ $.base[file.txt] ] #--> 'file.txt'
@METHOD: isAbsolute
The ^Als/Path:isAbsolute[]
method determines if path
is an absolute path.
If the given path
is a zero-length string, false
will be returned.
Syntax
^Als/Path:isAbsolute[path]
Params
- path
<string>
Example
^Als/Path:isAbsolute[/foo/bar] #--> true ^Als/Path:isAbsolute[/baz/..] #--> true ^Als/Path:isAbsolute[qux/] #--> false ^Als/Path:isAbsolute[.] #--> false
@METHOD: join
The ^Als/Path:join[]
method join all given path
segments together using the $Als/Path:separator
as a delimiter, then @normalizes the resulting path.
Zero-length path
segments are ignored. If the joined path string is a zero-length string then '.'
will be returned, representing the current working directory.
Syntax
^Als/Path:join[path1;path2[;...]]
Params
- path[, ...]
<string>
A sequence of path segments.
Example
^Als/Path:join[/foo;bar;baz/asdf;quux;..] #--> '/foo/bar/baz/asdf' ^Als/Path:join[foo; $.path[123] ;bar] #--> throws 'invalid.argument' error.
@METHOD: normalize
The ^Als/Path:normalize[]
method normalizes the given path
, resolving '..'
and '.'
segments.
When multiple, sequential path segment separation characters are found, they are replaced by a single instance of the path segment separator. Trailing separators are preserved.
If the path is a zero-length string, '.'
is returned, representing the current working directory.
Syntax
^Als/Path:normalize[path]
Params
- path
<string>
Example
^Als/Path:normalize[/foo/bar//baz/asdf/quux/..] #--> '/foo/bar/baz/asdf'
@METHOD: parse
The ^Als/Path:parse[]
method returns an <hash>
whose properties represent significant elements of the path.
The returned <hash>
will have the following properties:
- $.root
<string>
- $.dir
<string>
- $.base
<string>
- $.ext
<string>
- $.name
<string>
Syntax
^Als/Path:parse[path]
Params
- path
<string>
Example
^Als/Path:parse[/home/user/dir/file.txt] #--> # $.root[/] # $.dir[/home/user/dir] # $.base[file.txt] # $.ext[.txt] # $.name[file]
@METHOD: relative
The ^Als/Path:relative[]
method returns the relative path from from
to to
. If from
and to
each resolve to the same path (after calling ^Als/Path:resolve[]
on each), a zero-length string is returned.
If a zero-length string is passed as from
or to
, the current working directory will be used instead of the zero-length strings.
Syntax
^Als/Path:relative[from;to]
Params
- from
<string>
- to
<string>
Example
^Als/Path:relative[/home/user/test/aaa;/home/user/impl/bbb] #--> '../../impl/bbb'
@METHOD: resolve
The ^Als/Path:resolve[]
method resolves a sequence of paths or path segments into an absolute path.
The given sequence of paths is processed from right to left, with each subsequent path
prepended until an absolute path is constructed. For instance, given the sequence of path segments: /foo
, /bar
, baz
, calling ^Als/Path:resolve[/foo;/bar;baz]
would return /bar/baz
.
If after processing all given path
segments an absolute path has not yet been generated, the current working directory is used.
The resulting path is normalized and trailing slashes are removed unless the path is resolved to the root directory.
Zero-length path
segments are ignored.
If no path
segments are passed, ^Als/Path:resolve[]
will return the absolute path of the current working directory.
Syntax
^Als/Path:resolve[[path[; ...]]
Params
- path[, ...]
<string>
A sequence of paths or path segments
Example
^Als/Path:resolve[/foo/bar;./baz] #--> '/foo/bar/baz' ^Als/Path:resolve[/foo/bar;/tmp/file/] #--> '/tmp/file' # if the current working directory is '/home/myself/node' ^Als/Path:resolve[wwwroot;static_files/png/;../gif/image.gif] #--> '/home/myself/node/wwwroot/static_files/gif/image.gif'
References
- Questions to Leonid Knyazev leonid@knyazev.me | n3o@design.ru
- Bug reports and Feature requests to Issues.