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

Class: Calendar_Util_Textual

Source Location: /Calendar-0.5.5/Util/Textual.php

Class Overview


Static utlities to help with fetching textual representations of months and days of the week.


Author(s):

Copyright:

  • 2003-2007 Harry Fuecks, Lorenzo Alberton

Methods


Inherited Variables

Inherited Methods


Class Details

[line 71]
Static utlities to help with fetching textual representations of months and days of the week.


[ Top ]


Method Detail

monthNames   [line 83]

array monthNames( [string $format = 'long'])

Returns an array of 12 month names (first index = 1)
  • Access: public

Parameters:

string   $format     (optional) format of returned months (one|two|short|long)

[ Top ]

nextDayName   [line 247]

string nextDayName( object $Calendar, [string $format = 'long'])

Returns textual representation of the next day of week of the decorated calendar object
  • Access: public

Parameters:

object   $Calendar     subclass of Calendar e.g. Calendar_Month
string   $format     (optional) format of returned months (one,two,short or long)

[ Top ]

nextMonthName   [line 190]

string nextMonthName( object $Calendar, [string $format = 'long'])

Returns textual representation of the next month of the decorated calendar object
  • Access: public

Parameters:

object   $Calendar     subclass of Calendar e.g. Calendar_Month
string   $format     (optional) format of returned months (one,two,short or long)

[ Top ]

orderedWeekdays   [line 270]

array orderedWeekdays( object $Calendar, [string $format = 'long'])

Returns the days of the week using the order defined in the decorated calendar object. Only useful for Calendar_Month_Weekdays, Calendar_Month_Weeks and Calendar_Week. Otherwise the returned array will begin on Sunday
  • Return: ordered array of week day names
  • Access: public

Parameters:

object   $Calendar     subclass of Calendar e.g. Calendar_Month
string   $format     (optional) format of returned months (one,two,short or long)

[ Top ]

prevDayName   [line 207]

string prevDayName( object $Calendar, [string $format = 'long'])

Returns textual representation of the previous day of week of the decorated calendar object Note: Requires PEAR::Date
  • Access: public

Parameters:

object   $Calendar     subclass of Calendar e.g. Calendar_Month
string   $format     (optional) format of returned months (one,two,short or long)

[ Top ]

prevMonthName   [line 158]

string prevMonthName( object $Calendar, [string $format = 'long'])

Returns textual representation of the previous month of the decorated calendar object
  • Access: public

Parameters:

object   $Calendar     subclass of Calendar e.g. Calendar_Month
string   $format     (optional) format of returned months (one,two,short or long)

[ Top ]

thisDayName   [line 229]

string thisDayName( object $Calendar, [string $format = 'long'])

Returns textual representation of the day of week of the decorated calendar object Note: Requires PEAR::Date
  • Access: public

Parameters:

object   $Calendar     subclass of Calendar e.g. Calendar_Month
string   $format     (optional) format of returned months (one,two,short or long)

[ Top ]

thisMonthName   [line 174]

string thisMonthName( object $Calendar, [string $format = 'long'])

Returns textual representation of the month of the decorated calendar object
  • Access: public

Parameters:

object   $Calendar     subclass of Calendar e.g. Calendar_Month
string   $format     (optional) format of returned months (one,two,short or long)

[ Top ]

weekdayNames   [line 120]

array weekdayNames( [string $format = 'long'])

Returns an array of 7 week day names (first index = 0)
  • Access: public

Parameters:

string   $format     (optional) format of returned days (one,two,short or long)

[ Top ]


Documentation generated on Thu, 24 Jun 2010 14:00:12 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.