php man page for datefmt_format

DATEFMT_FORMAT(3)							 1							 DATEFMT_FORMAT(3)

IntlDateFormatter::format - Format the date/time value as a string

	Object oriented style

SYNOPSIS
       public string IntlDateFormatter::format (mixed  $value)

DESCRIPTION
	Procedural style
       string datefmt_format (IntlDateFormatter  $fmt, mixed  $value)

	Formats the time value as a string.

PARAMETERS
	      o $fmt
		- The date formatter resource.

	      o $value
		- Value to format. This may be a DateTime object, an IntlCalendar object, a numeric type representing a (possibly fractional) num-
		ber of seconds since epoch or an array in the format output by localtime(3).  If a DateTime or an IntlCalendar object  is  passed,
		its  timezone  is  not	considered.  The object will be formatted using the formaters configured timezone. If one wants to use the
		timezone of the object to be formatted, IntlDateFormatter.setTimeZone(3) must be called before with the objects timezone. Alterna-
		tively, the static function datefmt_formatObject(3) may be used instead.

RETURN VALUES
	The formatted string or, if an error occurred, FALSE.

CHANGELOG
       +-----------------+---------------------------------------------------+
       |    Version	 |						     |
       |		 |						     |
       |		 |		      Description		     |
       |		 |						     |
       +-----------------+---------------------------------------------------+
       |5.5.0/PECL 3.0.0 |						     |
       |		 |						     |
       |		 |  Support  for  providing  IntlCalendar objects to |
       |		 | the $value parameter was added.		     |
       |		 |						     |
       |     5.3.4	 |						     |
       |		 |						     |
       |		 |  Support for providing DateTime  objects  to  the |
       |		 | $value parameter was added.			     |
       |		 |						     |
       +-----------------+---------------------------------------------------+
EXAMPLES
       Example #1

	      datefmt_format(3) example

	      <?php
	      $fmt = datefmt_create(
		  'en_US',
		  IntlDateFormatter::FULL,
		  IntlDateFormatter::FULL,
		  'America/Los_Angeles',
		  IntlDateFormatter::GREGORIAN
	      );
	      echo 'First Formatted output is ' . datefmt_format($fmt, 0);

	      $fmt = datefmt_create(
		  'de-DE',
		  IntlDateFormatter::FULL,
		  IntlDateFormatter::FULL,
		  'America/Los_Angeles',
		  IntlDateFormatter::GREGORIAN
	      );
	      echo 'Second Formatted output is ' . datefmt_format($fmt, 0);

	      $fmt = datefmt_create(
		  'en_US',
		  IntlDateFormatter::FULL,
		  IntlDateFormatter::FULL,
		  'America/Los_Angeles',
		  IntlDateFormatter::GREGORIAN,
		  'MM/dd/yyyy'
	      );
	      echo 'First Formatted output with pattern is ' . datefmt_format($fmt, 0);

	      $fmt = datefmt_create(
		  'de-DE',
		  IntlDateFormatter::FULL,
		  IntlDateFormatter::FULL,
		  'America/Los_Angeles',
		  IntlDateFormatter::GREGORIAN,
		  'MM/dd/yyyy'
	      );
	      echo "Second Formatted output with pattern is " . datefmt_format($fmt, 0);
	      ?>

       Example #2

	      OO example

	      <?php
	      $fmt = new IntlDateFormatter(
		  'en_US',
		  IntlDateFormatter::FULL,
		  IntlDateFormatter::FULL,
		  'America/Los_Angeles',
		  IntlDateFormatter::GREGORIAN
	      );
	      echo 'First Formatted output is ' . $fmt->format(0);

	      $fmt = new IntlDateFormatter(
		  'de-DE',
		  IntlDateFormatter::FULL,
		  IntlDateFormatter::FULL,
		  'America/Los_Angeles',
		  IntlDateFormatter::GREGORIAN
	      );
	      echo 'Second Formatted output is ' . $fmt->format(0);

	      $fmt = new IntlDateFormatter(
		  'en_US',
		  IntlDateFormatter::FULL,
		  IntlDateFormatter::FULL,
		  'America/Los_Angeles',
		  IntlDateFormatter::GREGORIAN,
		  'MM/dd/yyyy'
	      );
	      echo 'First Formatted output with pattern is ' . $fmt->format(0);

	      $fmt = new IntlDateFormatter(
		  'de-DE',
		  IntlDateFormatter::FULL,
		  IntlDateFormatter::FULL,
		  'America/Los_Angeles',
		  IntlDateFormatter::GREGORIAN,
		  'MM/dd/yyyy'
	      );
	      echo 'Second Formatted output with pattern is ' . $fmt->format(0);
	      ?>

       The above example will output:

       First Formatted output is Wednesday, December 31, 1969 4:00:00 PM PT
       Second Formatted output is Mittwoch, 31. Dezember 1969 16:00 Uhr GMT-08:00
       First Formatted output with pattern is 12/31/1969
       Second Formatted output with pattern is 12/31/1969

       Example #3

	      With IntlCalendar object

	      <?php
	      $tz = reset(iterator_to_array(IntlTimeZone::createEnumeration('FR')));
	      $formatter = IntlDateFormatter::create(
		  'fr_FR',
		  IntlDateFormatter::FULL,
		  IntlDateFormatter::FULL,
		  $tz,
		  IntlDateFormatter::GREGORIAN
	      );

	      $cal = IntlCalendar::createInstance($tz, '@calendar=islamic-civil');
	      $cal->set(IntlCalendar::FIELD_MONTH, 8); //9th month, Ramadan
	      $cal->set(IntlCalendar::FIELD_DAY_OF_MONTH, 1); //1st day
	      $cal->clear(IntlCalendar::FIELD_HOUR_OF_DAY);
	      $cal->clear(IntlCalendar::FIELD_MINUTE);
	      $cal->clear(IntlCalendar::FIELD_SECOND);
	      $cal->clear(IntlCalendar::FIELD_MILLISECOND);

	      echo "In this islamic year, Ramadan started/will start on:
	",
		      $formatter->format($cal), "
";

	      //Its the formatters timezone that is used:
	      $formatter->setTimeZone('Asia/Tokyo');
	      echo "After changing timezone:
	",
		      $formatter->format($cal), "
";

	      The above example will output:

	      In this islamic year, Ramadan started/will start on:
		  mardi 9 juillet 2013 19:00:00 heure avancee d'Europe centrale
	      After changing timezone:
		  mercredi 10 juillet 2013 02:00:00 heure normale du Japon

SEE ALSO
       datefmt_create(3), datefmt_parse(3), datefmt_get_error_code(3), datefmt_get_error_message(3), datefmt_format_object(3).

PHP Documentation Group 													 DATEFMT_FORMAT(3)