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


Classes:
Calendar
   DiaryEvent
   MonthDecorator
   MonthPayload_Decorator
   MyBoldDecorator
Calendar
Calendar_Day
Calendar_Decorator
Calendar_Decorator_Textual
Calendar_Decorator_Uri
Calendar_Decorator_Weekday
Calendar_Decorator_Wrapper
Calendar_Engine_Factory
Calendar_Engine_Interface
Calendar_Engine_PearDate
Calendar_Engine_UnixTS
Calendar_Factory
Calendar_Hour
Calendar_Minute
Calendar_Month
Calendar_Month_Weekdays
Calendar_Month_Weeks
Calendar_Second
Calendar_Table_Helper
Calendar_Util_Textual
Calendar_Util_Uri
Calendar_Validation_Error
Calendar_Validator
Calendar_Week
Calendar_Year
Files:
1.php
2.php
3.php
4.php
5.php
6.php
7.php
8.php
9.php
10.php
11.php
12.php
13.php
14.php
15.php
16.php
17.php
18.php
19.php
20.php
21.php
22.php
23.php
Calendar.php
Day.php
Decorator.php
Factory.php
Helper.php
Hour.php
Interface.php
Minute.php
Month.php
PearDate.php
Second.php
Textual.php
Textual.php
UnixTS.php
Uri.php
Uri.php
Validator.php
Week.php
Weekday.php
Weekdays.php
Weeks.php
Wrapper.php
Year.php

Class: Calendar_Util_Textual

Source Location: /Calendar-0.5.4/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 Fri, 12 Dec 2008 14:30:24 -0500 by phpDocumentor 1.4.0. PEAR Logo Copyright ©  PHP Group 2004.