repo_zf1/documentation/manual/en/module_specs/Zend_Validate-Messages.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- Reviewed: no -->
<sect1 id="zend.validate.messages">

    <title>Validation Messages</title>

    <para>
        Each validator which is based on <classname>Zend_Validate</classname> provides
        one or multiple messages in the case of a failed validation. You can use
        this information for setting own messages or when you have to translate
        the messages a validator can return. The following table lists all
        available messages which are returned by each validator.
    </para>

    <table id="zend.validate.messages.table">
        <title>Available Validation Messages</title>
        <tgroup cols="4">
            <thead>
                <row>
                    <entry>Validator</entry>
                    <entry>Constant</entry>
                    <entry>Message</entry>
                </row>
            </thead>
            <tbody>
                <row>
                    <entry morerows="1" valign="middle">Alnum</entry>
                    <entry>NOT_ALNUM</entry>
                    <entry>'%value%' has not only alphabetic and digit characters</entry>
                </row>
                <row>
                    <entry>STRING_EMPTY</entry>
                    <entry>'%value%' is an empty string</entry>
                </row>
                <row>
                    <entry morerows="1" valign="middle">Alpha</entry>
                    <entry>NOT_ALPHA</entry>
                    <entry>'%value%' has not only alphabetic characters</entry>
                </row>
                <row>
                    <entry>STRING_EMPTY</entry>
                    <entry>'%value%' is an empty string</entry>
                </row>
                <row>
                    <entry>Barcode</entry>
                    <entry>---</entry>
                    <entry>messages are thrown by a subclass</entry>
                </row>
                <row>
                    <entry morerows="2" valign="middle">Barcode_Ean13</entry>
                    <entry>INVALID</entry>
                    <entry>'%value%' is an invalid EAN-13 barcode</entry>
                </row>
                <row>
                    <entry>INVALID_LENGTH</entry>
                    <entry>'%value%' should be 13 characters</entry>
                </row>
                <row>
                    <entry>NOT_NUMERIC</entry>
                    <entry>'%value%' should contain only numeric characters</entry>
                </row>
                <row>
                    <entry morerows="1" valign="middle">Barcode_UpcA</entry>
                    <entry>INVALID</entry>
                    <entry>'%value%' is an invalid UPC-A barcode</entry>
                </row>
                <row>
                    <entry>INVALID_LENGTH</entry>
                    <entry>'%value%' should be 12 characters</entry>
                </row>
                <row>
                    <entry morerows="1" valign="middle">Between</entry>
                    <entry>NOT_BETWEEN</entry>
                    <entry>'%value%' is not between '%min%' and '%max%', inclusively</entry>
                </row>
                <row>
                    <entry>NOT_BETWEEN_STRICT</entry>
                    <entry>'%value%' is not strictly between '%min%' and '%max%'</entry>
                </row>
                <row>
                    <entry morerows="1" valign="middle">Ccnum</entry>
                    <entry>LENGTH</entry>
                    <entry>'%value%' must contain between 13 and 19 digits</entry>
                </row>
                <row>
                    <entry>CHECKSUM</entry>
                    <entry>Luhn algorithm (mod-10 checksum) failed on '%value%'</entry>
                </row>
                <row>
                    <entry morerows="2" valign="middle">Date</entry>
                    <entry>FALSEFORMAT</entry>
                    <entry>'%value%' does not fit given date format</entry>
                </row>
                <row>
                    <entry>INVALID</entry>
                    <entry>'%value%' does not appear to be a valid date</entry>
                </row>
                <row>
                    <entry>NOT_YYYY_MM_DD</entry>
                    <entry>'%value%' is not of the format YYYY-MM-DD</entry>
                </row>
                <row>
                    <entry morerows="1" valign="middle">Db_Abstract</entry>
                    <entry>ERROR_NO_RECORD_FOUND</entry>
                    <entry>No record matching %value% was found</entry>
                </row>
                <row>
                    <entry>ERROR_RECORD_FOUND</entry>
                    <entry>A record matching %value% was found</entry>
                </row>
                <row>
                    <entry morerows="1" valign="middle">Digits</entry>
                    <entry>NOT_DIGITS</entry>
                    <entry>'%value%' contains not only digit characters</entry>
                </row>
                <row>
                    <entry>STRING_EMPTY</entry>
                    <entry>'%value%' is an empty string</entry>
                </row>
                <row>
                    <entry morerows="7" valign="middle">EmailAddress</entry>
                    <entry>INVALID</entry>
                    <entry>
                        '%value%' is not a valid email address in the basic format
                        local-part@hostname
                    </entry>
                </row>
                <row>
                    <entry>INVALID_FORMAT</entry>
                    <entry>'%value%' is not a valid email address in the basic format local-part@hostname</entry>
                </row>
                <row>
                    <entry>INVALID_HOSTNAME</entry>
                    <entry>'%hostname%' is not a valid hostname for email address '%value%'</entry>
                </row>
                <row>
                    <entry>INVALID_MX_RECORD</entry>
                    <entry>
                        '%hostname%' does not appear to have a valid MX record for the email address
                        '%value%'
                    </entry>
                </row>
                <row>
                    <entry>DOT_ATOM</entry>
                    <entry>'%localPart%' not matched against dot-atom format</entry>
                </row>
                <row>
                    <entry>QUOTED_STRING</entry>
                    <entry>'%localPart%' not matched against quoted-string format</entry>
                </row>
                <row>
                    <entry>INVALID_LOCAL_PART</entry>
                    <entry>
                        '%localPart%' is not a valid local part for email address '%value%'
                    </entry>
                </row>
                <row>
                    <entry>LENGTH_EXCEEDED</entry>
                    <entry>'%value%' exceeds the allowed length</entry>
                </row>
                <row>
                    <entry morerows="1" valign="middle">File_Count</entry>
                    <entry>TOO_MUCH</entry>
                    <entry>
                        Too much files, maximum '%max%' are allowed but '%count%' are given
                    </entry>
                </row>
                <row>
                    <entry>TOO_LESS</entry>
                    <entry>
                        Too less files, minimum '%min%' are expected but '%count%' are given
                    </entry>
                </row>
                <row>
                    <entry morerows="2" valign="middle">File_Crc32</entry>
                    <entry>DOES_NOT_MATCH</entry>
                    <entry>The file '%value%' does not match the given crc32 hashes</entry>
                </row>
                <row>
                    <entry>NOT_DETECTED</entry>
                    <entry>There was no crc32 hash detected for the given file</entry>
                </row>
                <row>
                    <entry>NOT_FOUND</entry>
                    <entry>The file '%value%' could not be found</entry>
                </row>
                <row>
                    <entry morerows="1" valign="middle">File_ExcludeExtension</entry>
                    <entry>FALSE_EXTENSION</entry>
                    <entry>The file '%value%' has a false extension</entry>
                </row>
                <row>
                    <entry>NOT_FOUND</entry>
                    <entry>The file '%value%' was not found</entry>
                </row>
                <row>
                    <entry morerows="2" valign="middle">File_ExcludeMimeType</entry>
                    <entry>FALSE_TYPE</entry>
                    <entry>The file '%value%' has a false mimetype of '%type%'</entry>
                </row>
                <row>
                    <entry>NOT_DETECTED</entry>
                    <entry>The mimetype of file '%value%' could not been detected</entry>
                </row>
                <row>
                    <entry>NOT_READABLE</entry>
                    <entry>The file '%value%' can not be read</entry>
                </row>
                <row>
                    <entry morerows="2" valign="middle">File_Exists</entry>
                    <entry>DOES_NOT_EXIST</entry>
                    <entry>The file '%value%' does not exist</entry>
                </row>
                <row>
                    <entry morerows="1" valign="middle">File_Extension</entry>
                    <entry>FALSE_EXTENSION</entry>
                    <entry>The file '%value%' has a false extension</entry>
                </row>
                <row>
                    <entry>NOT_FOUND</entry>
                    <entry>The file '%value%' was not found</entry>
                </row>
                <row>
                    <entry morerows="2" valign="middle">File_FilesSize</entry>
                    <entry>TOO_BIG</entry>
                    <entry>
                        All files in sum should have a maximum size of '%max%' but '%size%' were
                        detected
                    </entry>
                </row>
                <row>
                    <entry>TOO_SMALL</entry>
                    <entry>
                        All files in sum should have a minimum size of '%min%' but '%size%' were
                        detected
                    </entry>
                </row>
                <row>
                    <entry>NOT_READABLE</entry>
                    <entry>One or more files can not be read</entry>
                </row>
                <row>
                    <entry morerows="2" valign="middle">File_Hash</entry>
                    <entry>DOES_NOT_MATCH</entry>
                    <entry>The file '%value%' does not match the given hashes</entry>
                </row>
                <row>
                    <entry>NOT_DETECTED</entry>
                    <entry>There was no hash detected for the given file</entry>
                </row>
                <row>
                    <entry>NOT_FOUND</entry>
                    <entry>The file '%value%' could not be found</entry>
                </row>
                <row>
                    <entry morerows="5" valign="middle">File_ImageSize</entry>
                    <entry>WIDTH_TOO_BIG</entry>
                    <entry>
                        Maximum allowed width for image '%value%' should be '%maxwidth%' but
                        '%width%' detected
                    </entry>
                </row>
                <row>
                    <entry>WIDTH_TOO_SMALL</entry>
                    <entry>
                        Minimum expected width for image '%value%' should be '%minwidth%' but
                        '%width%' detected
                    </entry>
                </row>
                <row>
                    <entry>HEIGHT_TOO_BIG</entry>
                    <entry>
                        Maximum allowed height for image '%value%' should be '%maxheight%' but
                        '%height%' detected
                    </entry>
                </row>
                <row>
                    <entry>HEIGHT_TOO_SMALL</entry>
                    <entry>
                        Minimum expected height for image '%value%' should be '%minheight%' but
                        '%height%' detected
                    </entry>
                </row>
                <row>
                    <entry>NOT_DETECTED</entry>
                    <entry>The size of image '%value%' could not be detected</entry>
                </row>
                <row>
                    <entry>NOT_READABLE</entry>
                    <entry>The image '%value%' can not be read</entry>
                </row>
                <row>
                    <entry morerows="2" valign="middle">File_IsCompressed</entry>
                    <entry>FALSE_TYPE</entry>
                    <entry>The file '%value%' is not compressed, '%type%' detected</entry>
                </row>
                <row>
                    <entry>NOT_DETECTED</entry>
                    <entry>The mimetype of file '%value%' could not been detected</entry>
                </row>
                <row>
                    <entry>NOT_READABLE</entry>
                    <entry>The file '%value%' can not be read</entry>
                </row>
                <row>
                    <entry morerows="2" valign="middle">File_IsImage</entry>
                    <entry>FALSE_TYPE</entry>
                    <entry>The file '%value%' is no image, '%type%' detected</entry>
                </row>
                <row>
                    <entry>NOT_DETECTED</entry>
                    <entry>The mimetype of file '%value%' could not been detected</entry>
                </row>
                <row>
                    <entry>NOT_READABLE</entry>
                    <entry>The file '%value%' can not be read</entry>
                </row>
                <row>
                    <entry morerows="2" valign="middle">File_Md5</entry>
                    <entry>DOES_NOT_MATCH</entry>
                    <entry>The file '%value%' does not match the given md5 hashes</entry>
                </row>
                <row>
                    <entry>NOT_DETECTED</entry>
                    <entry>There was no md5 hash detected for the given file</entry>
                </row>
                <row>
                    <entry>NOT_FOUND</entry>
                    <entry>The file '%value%' could not be found</entry>
                </row>
                <row>
                    <entry morerows="2" valign="middle">File_MimeType</entry>
                    <entry>FALSE_TYPE</entry>
                    <entry>The file '%value%' has a false mimetype of '%type%'</entry>
                </row>
                <row>
                    <entry>NOT_DETECTED</entry>
                    <entry>The mimetype of file '%value%' could not been detected</entry>
                </row>
                <row>
                    <entry>NOT_READABLE</entry>
                    <entry>The file '%value%' can not be read</entry>
                </row>
                <row>
                    <entry>File_NotExists</entry>
                    <entry>DOES_EXIST</entry>
                    <entry>The file '%value%' does exist</entry>
                </row>
                <row>
                    <entry morerows="2" valign="middle">File_Sha1</entry>
                    <entry>DOES_NOT_MATCH</entry>
                    <entry>The file '%value%' does not match the given sha1 hashes</entry>
                </row>
                <row>
                    <entry>NOT_DETECTED</entry>
                    <entry>There was no sha1 hash detected for the given file</entry>
                </row>
                <row>
                    <entry>NOT_FOUND</entry>
                    <entry>The file '%value%' could not be found</entry>
                </row>
                <row>
                    <entry morerows="2" valign="middle">File_Size</entry>
                    <entry>TOO_BIG</entry>
                    <entry>
                        Maximum allowed size for file '%value%' is '%max%' but '%size%' detected
                    </entry>
                </row>
                <row>
                    <entry>TOO_SMALL</entry>
                    <entry>
                        Minimum expected size for file '%value%' is '%min%' but '%size%' detected
                    </entry>
                </row>
                <row>
                    <entry>NOT_FOUND</entry>
                    <entry>The file '%value%' could not be found</entry>
                </row>
                <row>
                    <entry morerows="9" valign="middle">File_Upload</entry>
                    <entry>INI_SIZE</entry>
                    <entry>The file '%value%' exceeds the defined ini size</entry>
                </row>
                <row>
                    <entry>FORM_SIZE</entry>
                    <entry>The file '%value%' exceeds the defined form size</entry>
                </row>
                <row>
                    <entry>PARTIAL</entry>
                    <entry>The file '%value%' was only partially uploaded</entry>
                </row>
                <row>
                    <entry>NO_FILE</entry>
                    <entry>The file '%value%' was not uploaded</entry>
                </row>
                <row>
                    <entry>NO_TMP_DIR</entry>
                    <entry>No temporary directory was found for the file '%value%'</entry>
                </row>
                <row>
                    <entry>CANT_WRITE</entry>
                    <entry>The file '%value%' can't be written</entry>
                </row>
                <row>
                    <entry>EXTENSION</entry>
                    <entry>
                        The extension returned an error while uploading the file '%value%'
                    </entry>
                </row>
                <row>
                    <entry>ATTACK</entry>
                    <entry>The file '%value%' was illegal uploaded, possible attack</entry>
                </row>
                <row>
                    <entry>FILE_NOT_FOUND</entry>
                    <entry>The file '%value%' was not found</entry>
                </row>
                <row>
                    <entry>UNKNOWN</entry>
                    <entry>Unknown error while uploading the file '%value%'</entry>
                </row>
                <row>
                    <entry morerows="2" valign="middle">File_WordCount</entry>
                    <entry>TOO_MUCH</entry>
                    <entry>
                        Too much words, maximum '%max%' are allowed but '%count%' were counted
                    </entry>
                </row>
                <row>
                    <entry>TOO_LESS</entry>
                    <entry>
                        Too less words, minimum '%min%' are expected but '%count%' were counted
                    </entry>
                </row>
                <row>
                    <entry>NOT_FOUND</entry>
                    <entry>The file '%value%' could not be found</entry>
                </row>
                <row>
                    <entry>Float</entry>
                    <entry>NOT_FLOAT</entry>
                    <entry>'%value%' does not appear to be a float</entry>
                </row>
                <row>
                    <entry>GreaterThan</entry>
                    <entry>NOT_GREATER</entry>
                    <entry>'%value%' is not greater than '%min%'</entry>
                </row>
                <row>
                    <entry>Hex</entry>
                    <entry>NOT_HEX</entry>
                    <entry>'%value%' has not only hexadecimal digit characters</entry>
                </row>
                <row>
                    <entry morerows="7" valign="middle">Hostname</entry>
                    <entry>IP_ADDRESS_NOT_ALLOWED</entry>
                    <entry>
                        '%value%' appears to be an IP address, but IP addresses are not allowed
                    </entry>
                </row>
                <row>
                    <entry>UNKNOWN_TLD</entry>
                    <entry>
                        '%value%' appears to be a DNS hostname but cannot match TLD against known
                        list
                    </entry>
                </row>
                <row>
                    <entry>INVALID_DASH</entry>
                    <entry>
                        '%value%' appears to be a DNS hostname but contains a dash (-) in an invalid
                        position
                    </entry>
                </row>
                <row>
                    <entry>INVALID_HOSTNAME_SCHEMA</entry>
                    <entry>
                        '%value%' appears to be a DNS hostname but cannot match against hostname
                        schema for TLD '%tld%'
                    </entry>
                </row>
                <row>
                    <entry>UNDECIPHERABLE_TLD</entry>
                    <entry>
                        '%value%' appears to be a DNS hostname but cannot extract TLD part
                    </entry>
                </row>
                <row>
                    <entry>INVALID_HOSTNAME</entry>
                    <entry>
                        '%value%' does not match the expected structure for a DNS hostname
                    </entry>
                </row>
                <row>
                    <entry>INVALID_LOCAL_NAME</entry>
                    <entry>'%value%' does not appear to be a valid local network name</entry>
                </row>
                <row>
                    <entry>LOCAL_NAME_NOT_ALLOWED</entry>
                    <entry>
                        '%value%' appears to be a local network name but local network names are not
                        allowed
                    </entry>
                </row>
                <row>
                    <entry morerows="2" valign="middle">Iban</entry>
                    <entry>NOTSUPPORTED</entry>
                    <entry>'%value%' does not have IBAN</entry>
                </row>
                <row>
                    <entry>FALSEFORMAT</entry>
                    <entry>'%value%' has a false format</entry>
                </row>
                <row>
                    <entry>CHECKFAILED</entry>
                    <entry>'%value%' has failed the IBAN check</entry>
                </row>
                <row>
                    <entry morerows="1" valign="middle">Identical</entry>
                    <entry>NOT_SAME</entry>
                    <entry>The token '%token%' does not match the given token '%value%'</entry>
                </row>
                <row>
                    <entry>MISSING_TOKEN</entry>
                    <entry>No token was provided to match against</entry>
                </row>
                <row>
                    <entry>InArray</entry>
                    <entry>NOT_IN_ARRAY</entry>
                    <entry>'%value%' was not found in the haystack</entry>
                </row>
                <row>
                    <entry>Int</entry>
                    <entry>NOT_INT</entry>
                    <entry>'%value%' does not appear to be an integer</entry>
                </row>
                <row>
                    <entry>Ip</entry>
                    <entry>NOT_IP_ADDRESS</entry>
                    <entry>'%value%' does not appear to be a valid IP address</entry>
                </row>
                <row>
                    <entry>LessThan</entry>
                    <entry>NOT_LESS</entry>
                    <entry>'%value%' is not less than '%max%'</entry>
                </row>
                <row>
                    <entry>NotEmpty</entry>
                    <entry>IS_EMPTY</entry>
                    <entry>Value is required and can't be empty</entry>
                </row>
                <row>
                    <entry>Regex</entry>
                    <entry>NOT_MATCH</entry>
                    <entry>'%value%' does not match against pattern '%pattern%'</entry>
                </row>
                <row>
                    <entry morerows="1" valign="middle">StringLength</entry>
                    <entry>TOO_SHORT</entry>
                    <entry>'%value%' is less than %min% characters long</entry>
                </row>
                <row>
                    <entry>TOO_LONG</entry>
                    <entry>'%value%' is greater than %max% characters long</entry>
                </row>
            </tbody>
        </tgroup>
    </table>

    <para>
        Additionally you can retrieve all message templates of a validator with
        the method <code>getMessageTemplates()</code>. It returns you an array
        with the messages a validator could return in the case of a failed validation.
    </para>

    <programlisting language="php"><![CDATA[
$validator = new Zend_Validate_Alnum();
$messages  = $validator->getMessageTemplates();
]]></programlisting>

    <sect2 id="zend.validate.messages.limitation">
        <title>Limit the size of a validation message</title>

        <para>
            Sometimes it is necessary to limit the maximum size a validation message can have.
            For example when your view allows a maximum size of 100 chars to be rendered on one
            line. To simplify the usage, <classname>Zend_Validate</classname> is able to
            automatically limit the maximum returned size of a validation message.
        </para>

        <para>
            To get the actual set size use
            <methodname>Zend_Validate::getMessageLength()</methodname>. If it is -1, then the
            returned message will not be truncated. This is default behaviour.
        </para>

        <para>
            To limit the returned message size use
            <methodname>Zend_Validate::setMessageLength()</methodname>. Set it to any integer size
            you need. When the returned message exceeds the set size, then the message
            will be truncated and the string '<emphasis>...</emphasis>' will be added instead of
            the rest of the message.
        </para>

        <programlisting language="php"><![CDATA[
Zend_Validate::setMessageLength(100);
]]></programlisting>

        <note>
            <para>
                Note that the set message length is used for all validators, even for self defined ones
                as long as they extend <classname>Zend_Validate_Abstract</classname>.
            </para>
        </note>
    </sect2>

</sect1>
<!--
vim:se ts=4 sw=4 et:
-->