Arabic
[ class tree: Arabic ] [ index: Arabic ] [ all elements ]

Class: ArDate

Source Location: /sub/ArDate.class.php

Class Overview


This PHP class is an Arabic customization for PHP date function


Author(s):

Copyright:

  • 2009 Khaled Al-Shamaa

Methods



Class Details

[line 167]
This PHP class is an Arabic customization for PHP date function



Tags:

author:  Khaled Al-Shamaa <khaled.alshamaa@gmail.com>
copyright:  2009 Khaled Al-Shamaa
link:  http://www.ar-php.org
license:  LGPL


[ Top ]


Class Methods


method date [line 232]

string date( string $format, integer $timestamp, [string $outputCharset = null], [integer $correction = 0], [object $main = null])

Format a local time/date in Arabic string



Tags:

return:  Format Arabic date string according to given format string using the given integer timestamp or the current local time if no timestamp is given.
author:  Khaled Al-Shamaa <khaled.alshamaa@gmail.com>
access:  public


Parameters:

string   $format   Format string (same as PHP date function)
integer   $timestamp   Unix timestamp
string   $outputCharset   (optional) Output charset [utf-8|windows-1256|iso-8859-6] default value is NULL (use set output charset)
integer   $correction   To apply correction factor (+/- 1-2) to standard hijri calendar
object   $main   Main Ar-PHP object to access charset converter options

[ Top ]

method getMode [line 212]

Integer getMode( )

Getting $mode value that refer to output mode format

1) Hegri format (Islamic calendar) 2) Arabic month names used in Middle East countries 3) Arabic Transliteration of Gregorian month names 4) Both of 2 and 3 formats together 5) Libyan way




Tags:

return:  Value of $mode properity
author:  Khaled Al-Shamaa <khaled.alshamaa@gmail.com>
access:  public


[ Top ]

method setMode [line 185]

boolean setMode( [integer $mode = 1])

Setting value for $mode scalar



Tags:

return:  TRUE if success, or FALSE if fail
author:  Khaled Al-Shamaa <khaled.alshamaa@gmail.com>
access:  public


Parameters:

integer   $mode   Output mode of date function where: 1) Hegri format (Islamic calendar) 2) Arabic month names used in Middle East countries 3) Arabic Transliteration of Gregorian month names 4) Both of 2 and 3 formats together 5) Libyan way

[ Top ]


Documentation generated on Tue, 18 Aug 2009 00:12:49 +0300 by phpDocumentor 1.4.0