php man page for datefmt_format_object

DATEFMT_FORMAT_OBJECT(3)						 1						  DATEFMT_FORMAT_OBJECT(3)

IntlDateFormatter::formatObject - Formats an object

	Object oriented style

SYNOPSIS
       publicstatic string IntlDateFormatter::formatObject (object  $object, [mixed  $format = NULL], [string  $locale = NULL])

DESCRIPTION
	Procedural style string datefmt_format_object (object  $object, [mixed	$format = NULL], [string  $locale = NULL])

	This function allows formatting an IntlCalendar or DateTime object without first explicitly creating a IntlDateFormatter object.

	The  temporary IntlDateFormatter that will be created will take the timezone from the passed in object. The timezone database bundled with
       PHP will not be used - ICU's will be used instead. The timezone identifier used in DateTime objects must  therefore  also  exist  in  ICU's
       database.

PARAMETERS
	      o $object
		- An object of type IntlCalendar or DateTime. The timezone information in the object will be used.

	      o $format
		-  How	to  format  the date/time. This can either be an array with two elements (first the date style, then the time style, these
		being one of the constants IntlDateFormatter::NONE, IntlDateFormatter::SHORT, IntlDateFormatter::MEDIUM,  IntlDateFormatter::LONG,
		IntlDateFormatter::FULL), a long with the value of one of these constants (in which case it will be used both for the time and the
		date) or a string with the format described in the ICU documentation. If NULL, the default style will be used.

	      o $locale
		- The locale to use, or NULL to use the default one.

RETURN VALUES
	A string with result or FALSE on failure.

EXAMPLES
       Example #1

	      datefmt_format_object(3) examples

	      <?php
	      /* default timezone is irrelevant; timezone taken from the object */
	      ini_set('date.timezone', 'UTC');
	      /* default locale is taken from this ini setting */
	      ini_set('intl.default_locale', 'fr_FR');

	      $cal = IntlCalendar::fromDateTime("2013-06-06 17:05:06 Europe/Dublin");
	      echo "default:
	",
		      IntlDateFormatter::formatObject($cal),
		      "
";

	      echo "long $format (full):
	",
		      IntlDateFormatter::formatObject($cal, IntlDateFormatter::FULL),
		      "
";

	      echo "array $format (none, full):
	",
		      IntlDateFormatter::formatObject($cal, array(
			      IntlDateFormatter::NONE,
			      IntlDateFormatter::FULL)),
		      "
";

	      echo "string $format (d 'of' MMMM y):
	",
		      IntlDateFormatter::formatObject($cal, "d 'of' MMMM y", 'en_US'),
		      "
";

	      echo "with DateTime:
	",
		      IntlDateFormatter::formatObject(
			      new DateTime("2013-09-09 09:09:09 Europe/Madrid"),
			      IntlDateFormatter::FULL,
			      'es_ES'),
		      "
";

	      The above example will output:

	      default:
		  6 juin 2013 17:05:06
	      long $format (full):
		  jeudi 6 juin 2013 17:05:06 heure d'ete irlandaise
	      array $format (none, full):
		  17:05:06 heure d'ete irlandaise
	      string $format (d 'of' MMMM y):
		  6 of June 2013
	      with DateTime:
		  lunes, 9 de septiembre de 2013 09:09:09 Hora de verano de Europa central

PHP Documentation Group 												  DATEFMT_FORMAT_OBJECT(3)