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


Files:
examples.php
ical.php

Classes:
Daylight
ical_ComponentManager
ical_File
ical_Property
Standard
Tzprop
vAlarm
vCalendar
vEvent
vEventInstance
vFreebusy
vJournal
vTimezone
vTodo

Class: ical_ComponentManager

Source Location: /ical.php

Class Overview




RFC Sections 4.4 - 4.6









        




Variables







Methods















Child classes:






ical_File

	
This is the class that everyone should start with to open an existing file or create a new one.






vCalendar

	
Calendar object class






vEvent

	
Event object class






vTodo

	
Todo object class






vJournal

	
Journal object class






vFreebusy

	
Freebusy object class






vTimezone

	
Timezone object class






Tzprop

	
Tzprop object class






vAlarm

	
Alarm object class

















Class Details



[line 235]

RFC Sections 4.4 - 4.6

This is a base class for just about everything and shouldn't be  created directly





[ Top ]







Class Variables



	
	

	
$components = array()

	
[line 240]

  This is where we store subelements


  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]










Class Methods




  

	
	
method add [line 292]

	

    

    

		integer add(
string
$component, ical_Property
$value)
    

    


	
		Add this value if it can have multiple entries, otherwise overwrite the old one.





	
        
Parameters:

    

    

          

        string  
        $component  
        
      

          

        ical_Property  
        $value  
        
      

        

    


        
[ Top ]

  

  

	
	
method add_new [line 322]

	

    

    

		void add_new(
string
$component, ical_Property
$value)
    

    


	
		This is only used for adding additional items.





	
        
Parameters:

    

    

          

        string  
        $component  
        
      

          

        ical_Property  
        $value  
        
      

        

    


        
[ Top ]

  

  

	
	
method cleanup_array [line 394]

	

    

    

		array cleanup_array(
string
$plaintext)
    

    


	
		Prepare iCal array of lines for further processing.





Tags:





  

    return:  Array of strings
  









	
        
Parameters:

    

    

          

        string  
        $plaintext  
        
      

        

    


        
[ Top ]

  

  

	
	
method components_dump [line 492]

	

    

    

		string components_dump(
[string
$text = ""])
    

    


	
		Dump component values to text format.





	
        
Parameters:

    

    

          

        string  
        $text  
        
      

        

    


        
[ Top ]

  

  

	
	
method format_line [line 519]

	

    

    

		string format_line(
string
$line)
    

    


	
		Do line folding as defined in the RFC.





Tags:





  

    global:  integer $LINE_FOLD_LENGTH: 
  









	
        
Parameters:

    

    

          

        string  
        $line  
        
      

        

    


        
[ Top ]

  

  

	
	
method get [line 375]

	

    

    

		array get(
string
$component)
    

    


	
		Return an array of ical_Property objects for the component.





Tags:





  

    return:  Array of ical_Property objects
  









	
        
Parameters:

    

    

          

        string  
        $component  
        
      

        

    


        
[ Top ]

  

  

	
	
method get_all [line 385]

	

    

    

		array get_all(
)
    

    


	
		Return all component values in native array form.





	
        
[ Top ]

  

  

	
	
method ical_dump [line 470]

	

    

    

		string ical_dump(
[string
$text = ""])
    

    


	
		Dump ical data to text.





	
Overridden in child classes as:

		

	
ical_File::ical_dump()

		
Dump ical data to text string

	

	

	
        
Parameters:

    

    

          

        string  
        $text  
        
      

        

    


        
[ Top ]

  

  

	
	
method load_ical [line 418]

	

    

    

		void load_ical(
string
$plaintext)
    

    


	
		Recursive method to add ical objects from their text.





	
        
Parameters:

    

    

          

        string  
        $plaintext  
        Text in iCal format
      

        

    


        
[ Top ]

  

  

	
	
method remove [line 357]

	

    

    

		integer remove(
string
$component)
    

    


	
		Remove all of a given component.

Return 0 on success, -1 otherwise (required element).





	
        
Parameters:

    

    

          

        string  
        $component  
        
      

        

    


        
[ Top ]

  

  

	
	
method rfc_verify [line 529]

	

    

    

		integer rfc_verify(
[boolean
$recursive = FALSE])
    

    


	
		Return 0 when everything checks out, negative code otherwise.





	
        
Parameters:

    

    

          

        boolean  
        $recursive  
        
      

        

    


        
[ Top ]

  

  

	
	
method set [line 337]

	

    

    

		integer set(
string
$component, array
$arrayofvalues)
    

    


	
		Set all values for this component type in this array return 0 on success, 1 otherwise.

This is really silly to use for single entries only, it is the same as using add, but probably more cumbersome.





	
        
Parameters:

    

    

          

        string  
        $component  
        
      

          

        array  
        $arrayofvalues  
        Array of ical_Property objects
      

        

    


        
[ Top ]

  






        

		    

		    Documentation generated on Tue, 14 Aug 2007 19:37:26 -0700 by phpDocumentor 1.4.0