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.2/Util/Textual.php

Class Overview




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




Author(s):


    
        





    







Methods
















Inherited Variables





Inherited Methods














Class Details



[line 47]

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


    

  • Access: public
    • 









[ Top ]








Method Detail



	
	
monthNames   [line 57]

	

    

    

		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 or long)
      

        

    


        
[ Top ]

  

  
  
	
	
nextDayName   [line 197]

	

    

    

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

    


	
		Returns textual representation of the next day of week of the decorated calendar object


    

  • Access: public
    • 








        
Parameters:

    

    

          

        object subclass  
        $Calendar  
        — 
        of Calendar e.g. Calendar_Month
      

          

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

        

    


        
[ Top ]

  

  
  
	
	
nextMonthName   [line 146]

	

    

    

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

    


	
		Returns textual representation of the next month of the decorated calendar object


    

  • Access: public
    • 








        
Parameters:

    

    

          

        object subclass  
        $Calendar  
        — 
        of Calendar e.g. Calendar_Month
      

          

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

        

    


        
[ Top ]

  

  
  
	
	
orderedWeekdays   [line 218]

	

    

    

		array orderedWeekdays(
object subclass
$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 subclass  
        $Calendar  
        — 
        of Calendar e.g. Calendar_Month
      

          

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

        

    


        
[ Top ]

  

  
  
	
	
prevDayName   [line 161]

	

    

    

		string prevDayName(
object subclass
$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 subclass  
        $Calendar  
        — 
        of Calendar e.g. Calendar_Month
      

          

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

        

    


        
[ Top ]

  

  
  
	
	
prevMonthName   [line 118]

	

    

    

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

    


	
		Returns textual representation of the previous month of the decorated calendar object


    

  • Access: public
    • 








        
Parameters:

    

    

          

        object subclass  
        $Calendar  
        — 
        of Calendar e.g. Calendar_Month
      

          

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

        

    


        
[ Top ]

  

  
  
	
	
thisDayName   [line 181]

	

    

    

		string thisDayName(
object subclass
$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 subclass  
        $Calendar  
        — 
        of Calendar e.g. Calendar_Month
      

          

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

        

    


        
[ Top ]

  

  
  
	
	
thisMonthName   [line 132]

	

    

    

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

    


	
		Returns textual representation of the month of the decorated calendar object


    

  • Access: public
    • 








        
Parameters:

    

    

          

        object subclass  
        $Calendar  
        — 
        of Calendar e.g. Calendar_Month
      

          

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

        

    


        
[ Top ]

  

  
  
	
	
weekdayNames   [line 87]

	

    

    

		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 Mon, 11 Mar 2019 13:54:44 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright ©  PHP Group 2004.