Phar::isValidPharFilename

    (PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL phar >= 1.2.0)

    Phar::isValidPharFilename — Returns whether the given filename is a valid phar filename

    Description

    final public static Phar::isValidPharFilename(string $filename, bool $executable = true): bool

    Returns whether the given filename is a valid phar filename that will be recognized as a phar archive by the phar extension. This can be used to test a name without having to instantiate a phar archive and catch the inevitable Exception that will be thrown if an invalid name is specified.

    Parameters

    filename

    The name or full path to a phar archive not yet created

    executable

    This parameter determines whether the filename should be treated as a phar executable archive, or a data non-executable archive

    Return Values

    Returns true if the filename is valid, false if not.

    Improve This Page

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 2 notes

    up
    0
    kevin dot sours at internetbrands dot com
    4 months ago
    This appears to return true for the running phar file regardless of the file extension. This is undocumented (as is the fact that PHP will run phar files perfectly fine with a php extension). This allows, for instance, reading the metadata for the running phar.
    up
    0
    sebastian dot krebs dot berlin at googlemail dot com
    13 years ago
    Note, that this method accepts _everything_ (=> returns 'true'), when $executable is 'false' as long as the filename contains at least a dot

    var_dump(\PharData::isValidPharFilename('randomstring.y', false));
    bool(true)

    This is not wrong at all, because I can name an archive like I want, but it makes the method completely useless (when $executable == false).
    ＋add a note
    To Top