terah / fluent-assert

     * @return Assert

     * @throws AssertionFailedException

     */

    public function directory(string $message='', string $fieldName='') : Assert

    {

        if ( $this->doAllOrNullOr(__FUNCTION__, func_get_args()) )

        {

            return $this;

        }

        $this->string($message, $fieldName);

        if ( !is_dir($this->value) )

        {

            $message = $message ?: $this->overrideError;

            $message = sprintf(

                $message ?: 'Path "%s" was expected to be a directory.',

                $this->stringify($this->value)

            );

            throw $this->createException($message, $this->overrideCode ?: self::INVALID_DIRECTORY, $fieldName);

        }

        return $this;

    }

    /**

     * Assert that value is something readable.

     * @return Assert

     * @throws AssertionFailedException

     */

    public function readable(string $message='', string $fieldName='') : Assert

    {

        if ( $this->doAllOrNullOr(__FUNCTION__, func_get_args()) )

        {

            return $this;

        }

        $this->string($message, $fieldName);

        if ( !is_readable($this->value) )

        {

            $message = $message ?: $this->overrideError;

            $message = sprintf(

                $message ?: 'Path "%s" was expected to be readable.',

                $this->stringify($this->value)

            );

            throw $this->createException($message, $this->overrideCode ?: self::INVALID_READABLE, $fieldName);

        }

        return $this;

    }

    /**

     * Assert that value is something writeable.

     * @return Assert

     * @throws AssertionFailedException

     */

    public function writeable(string $message='', string $fieldName='') : Assert

    {

        if ( $this->doAllOrNullOr(__FUNCTION__, func_get_args()) )

        {

            return $this;

        }

        $this->string($message, $fieldName);

        if ( !is_writeable($this->value) )

        {

            $message = $message ?: $this->overrideError;

            $message = sprintf(

                $message ?: 'Path "%s" was expected to be writeable.',

                $this->stringify($this->value)

            );

            throw $this->createException($message, $this->overrideCode ?: self::INVALID_WRITEABLE, $fieldName);

        }

        return $this;

    }

    /**

     * Assert that value is a valid email address (using input_filter/FILTER_VALIDATE_EMAIL).

     * @return $this

     * @throws AssertionFailedException

     */

    public function ausMobile(string $message='', string $fieldName='') : Assert

    {

        if ( $this->doAllOrNullOr(__FUNCTION__, func_get_args()) )

        {

            return $this;

        }

        $this->string($message, $fieldName);

        if ( ! static::isAusMobile($this->value) )

        {

            $message = $message ?: $this->overrideError;

            $message = sprintf(

                $message

                    ?: 'Value "%s" is not an australian mobile number.',

                $this->stringify($this->value)

            );

            throw $this->createException($message, $this->overrideCode ?: self::INVALID_AUS_MOBILE, $fieldName);

        }

        return $this;

    }

    /**

     * @param string $value

     * @return Assert

     * @throws AssertionFailedException

     */

    public function alnum(string $message='', string $fieldName='') : Assert

    {

        if ( $this->doAllOrNullOr(__FUNCTION__, func_get_args()) )

        {

            return $this;

        }

        try

        {

            $this->regex('(^([a-zA-Z]{1}[a-zA-Z0-9]*)$)', $message, $fieldName);

        }

        catch (AssertionFailedException $e)

        {

            $message = $message ?: $this->overrideError;

            $message = sprintf(

                $message

                    ?: 'Value "%s" is not alphanumeric, starting with letters and containing only letters and numbers.',

                $this->stringify($this->value)

            );

            throw $this->createException($message, $this->overrideCode ?: self::INVALID_ALNUM, $fieldName);

        }

        return $this;

    }

    /**

     * Assert that value is boolean True.

     * @return Assert

     * @throws AssertionFailedException

     */

    public function userPrincipalName(string $message='', string $fieldName='') : Assert

    {

        if ( $this->doAllOrNullOr(__FUNCTION__, func_get_args()) )

        {

            return $this;

        }

        try

        {

            $this->email($message, $fieldName);

        }

        catch (AssertionFailedException $e)

        {

            $message = $message ?: $this->overrideError;

            $message = sprintf(

                $message

                    ?: 'Value "%s" is not a valid userPrincipalName.',

                $this->stringify($this->value)

            );

            throw $this->createException($message, $this->overrideCode ?: self::INVALID_USERPRINCIPALNAME, $fieldName);

        }

        return $this;

    }

    /**

     * Assert that the given string is a valid UUID