Collator::getErrorMessage

collator_get_error_message

Get text for collator's last error code

Description

Object-oriented style

public stringfalse Collator::getErrorMessage()

Procedural style

stringfalse collator_get_error_message(Collator $object)

Retrieves the message for the last error.

Parameters

object

Collator object.

Return Values

Description of an error occurred in the last Collator API function call, or false on failure.

Examples

Example #1 collator_get_error_message example

<?php
$coll = collator_create( 'lt' );
if( collator_compare( $coll, 'y', 'k' ) === false ) {
    echo collator_get_error_message( $coll );
}
?>

See Also

  • collator_get_error_code