Skip to content

Latest commit

 

History

History
103 lines (81 loc) · 4.06 KB

fValidationException.wiki

File metadata and controls

103 lines (81 loc) · 4.06 KB

Table of Contents

fValidationException

<<css mode="next" class="sidebar"></css>> (((

Class Resources <<toc></toc>>

 - '''<a href="/docs/fValidationException">Class Documentation</a>'''
 - <a href="/api/fValidationException">API Reference</a>
 - <a href="https://github.com/flourishlib/flourish-classes/blob/master/fValidationException.php" target="_blank">Source Code</a>

<<toc></toc>>

Exception Classes <<toc></toc>>

 - fException
  - fExpectedException
   - fAuthorizationException
   - fEmptySetException
   - fNoRemainingException
   - fNoRowsException
   - fNotFoundException
   - '''fValidationException'''
  - fUnexpectedException
   - fConnectivityException
   - fEnvironmentException
   - fProgrammerException
   - fSQLException

)))

fValidationException is a sub-class of fExpectedException that indicates that some sort of input did not meet the requirements of the code. This class is used by Flourish code quite a bit and would be suitable to toss on almost any web site or application at some point.

Message with a List

This functionality is specific to fValidationException, where it is most common and useful. In addition to being able to pass a `$message` to ::__construct() (and possibly some values to interpolate), it is possible to pass a string `$message` followed by an array of `$sub_messages`. The `$message` will be placed in a `

` tag and the `$sub_messages` will each be placed in an `
  • ` tag inside of a `
      ` tag.

      Thus, the following example code:

      will create the message:

      Field Name Formatting

      Both fValidation and fORMValidation throw fValidationException objects when data has been detected that does not validate according to the established rules. In the message for these exceptions there are unordered lists of each field/column name followed by the error message for that field/column. By default the field/column name is printed followed by `: `.

      Sometimes it may be desirable to change the formatting of the field name, to include HTML tags such as `` or ``. The static method ::setFieldFormat() accepts a single parameter that is the format for field/column names. The token `%s` is replaced with the field/column name. Any literal `%` symbols should be changed to `%%` to prevent formatting issues.

      Here is an example of adding `` tags around field/column names:

      Removing Field Names

      When fActiveRecord::validate() or fValidation::validate() is called with the `$return_messages` parameter set to `TRUE`, an array of error messages will be returned, with the column or field names included in the error messages. For situations where the messages are going to be displayed next to the field in question, having the field name in the actual error message is not desirable. The static method ::removeFieldNames() will accept an array of error messages and will return an array with the same error messages, sans field names.

      The code below will produce a full exception including the field names, but will also provide an associative array of the key being the field/column and the value being the error message without the field name.

      The exception message would be:

      And the `$field_errors` array would contain: