Class Zend_Feed_Builder

Description
Description | Methods (details)

Implements interfaces:

A simple implementation of Zend_Feed_Builder_Interface.

Users are encouraged to make their own classes to implement Zend_Feed_Builder_Interface

  • copyright: Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)
  • license: New BSD License

Located in /Feed/Builder.php (line 58) 


	
			







	
	

		
Method Summary

		

			Description |
												Methods (details)
		

		
			
			

																																							
				

					 
											void
										__construct
											( $data)
									

															
				

					 
											array
										getEntries
										()
									

															
				

					 
											Zend_Feed_Builder_Header
										getHeader
										()
									

											

		

	
		

	
	
	

		
Methods

		

			Description |
																Methods (details)
						
		

		

			



	
	

		
		Constructor __construct (line 185)
	
 
	
	

Constructor. The $data array must conform to the following format:


  1.   array(
    2. 

  2.   'title'       => 'title of the feed', //required
    3. 

  3.   'link'        => 'canonical url to the feed', //required
    4. 

  4.   'lastUpdate'  => 'timestamp of the update date', // optional
    5. 

  5.   'published'   => 'timestamp of the publication date', //optional
    6. 

  6.   'charset'     => 'charset', // required
    7. 

  7.   'description' => 'short description of the feed', //optional
    8. 

  8.   'author'      => 'author/publisher of the feed', //optional
    9. 

  9.   'email'       => 'email of the author', //optional
    10. 

  10.   'webmaster'   => 'email address for person responsible for technical issues' // optional, ignored if atom is used
    11. 

  11.   'copyright'   => 'copyright notice', //optional
    12. 

  12.   'image'       => 'url to image', //optional
    13. 

  13.   'generator'   => 'generator', // optional
    14. 

  14.   'language'    => 'language the feed is written in', // optional
    15. 

  15.   'ttl'         => 'how long in minutes a feed can be cached before refreshing', // optional, ignored if atom is used
    16. 

  16.   'rating'      => 'The PICS rating for the channel.', // optional, ignored if atom is used
    17. 

  17.   'cloud'       => array(
    18. 

  18.                     'domain'            => 'domain of the cloud, e.g. rpc.sys.com' // required
    19. 

  19.                     'port'              => 'port to connect to' // optional, default to 80
    20. 

  20.                     'path'              => 'path of the cloud, e.g. /RPC2 //required
    21. 

  21.                     'registerProcedure' => 'procedure to call, e.g. myCloud.rssPleaseNotify' // required
    22. 

  22.                     'protocol'          => 'protocol to use, e.g. soap or xml-rpc' // required
    23. 

  23.                     ), a cloud to be notified of updates // optional, ignored if atom is used
    24. 

  24.   'textInput'   => array(
    25. 

  25.                     'title'       => 'the label of the Submit button in the text input area' // required,
    26. 

  26.                     'description' => 'explains the text input area' // required
    27. 

  27.                     'name'        => 'the name of the text object in the text input area' // required
    28. 

  28.                     'link'        => 'the URL of the CGI script that processes text input requests' // required
    29. 

  29.                     ) // a text input box that can be displayed with the feed // optional, ignored if atom is used
    30. 

  30.   'skipHours'   => array(
    31. 

  31.                     'hour in 24 format', // e.g 13 (1pm)
    32. 

  32.                     // up to 24 rows whose value is a number between 0 and 23
    33. 

  33.                     ) // Hint telling aggregators which hours they can skip // optional, ignored if atom is used
    34. 

  34.   'skipDays '   => array(
    35. 

  35.                     'a day to skip', // e.g Monday
    36. 

  36.                     // up to 7 rows whose value is a Monday, Tuesday, Wednesday, Thursday, Friday, Saturday or Sunday
    37. 

  37.                     ) // Hint telling aggregators which days they can skip // optional, ignored if atom is used
    38. 

  38.   'itunes'      => array(
    39. 

  39.                     'author'       => 'Artist column' // optional, default to the main author value
    40. 

  40.                     'owner'        => array(
    41. 

  41.                                         'name' => 'name of the owner' // optional, default to main author value
    42. 

  42.                                         'email' => 'email of the owner' // optional, default to main email value
    43. 

  43.                                         ) // Owner of the podcast // optional
    44. 

  44.                     'image'        => 'album/podcast art' // optional, default to the main image value
    45. 

  45.                     'subtitle'     => 'short description' // optional, default to the main description value
    46. 

  46.                     'summary'      => 'longer description' // optional, default to the main description value
    47. 

  47.                     'block'        => 'Prevent an episode from appearing (yes|no)' // optional
    48. 

  48.                     'category'     => array(
    49. 

  49.                                       array('main' => 'main category', // required
    50. 

  50.                                             'sub'  => 'sub category' // optional
    51. 

  51.                                         ),
    52. 

  52.                                         // up to 3 rows
    53. 

  53.                                         ) // 'Category column and in iTunes Music Store Browse' // required
    54. 

  54.                     'explicit'     => 'parental advisory graphic (yes|no|clean)' // optional
    55. 

  55.                     'keywords'     => 'a comma separated list of 12 keywords maximum' // optional
    56. 

  56.                     'new-feed-url' => 'used to inform iTunes of new feed URL location' // optional
    57. 

  57.                     ) // Itunes extension data // optional, ignored if atom is used
    58. 

  58.   'entries'     => array(
    59. 

  59.                    array(
    60. 

  60.                     'title'        => 'title of the feed entry', //required
    61. 

  61.                     'link'         => 'url to a feed entry', //required
    62. 

  62.                     'description'  => 'short version of a feed entry', // only text, no html, required
    63. 

  63.                     'guid'         => 'id of the article, if not given link value will used', //optional
    64. 

  64.                     'content'      => 'long version', // can contain html, optional
    65. 

  65.                     'lastUpdate'   => 'timestamp of the publication date', // optional
    66. 

  66.                     'comments'     => 'comments page of the feed entry', // optional
    67. 

  67.                     'commentRss'   => 'the feed url of the associated comments', // optional
    68. 

  68.                     'source'       => array(
    69. 

  69.                                         'title' => 'title of the original source' // required,
    70. 

  70.                                         'url' => 'url of the original source' // required
    71. 

  71.                                            ) // original source of the feed entry // optional
    72. 

  72.                     'category'     => array(
    73. 

  73.                                       array(
    74. 

  74.                                         'term' => 'first category label' // required,
    75. 

  75.                                         'scheme' => 'url that identifies a categorization scheme' // optional
    76. 

  76.                                             ),
    77. 

  77.                                       array(
    78. 

  78.                                          //data for the second category and so on
    79. 

  79.                                            )
    80. 

  80.                                         ) // list of the attached categories // optional
    81. 

  81.                     'enclosure'    => array(
    82. 

  82.                                       array(
    83. 

  83.                                         'url' => 'url of the linked enclosure' // required
    84. 

  84.                                         'type' => 'mime type of the enclosure' // optional
    85. 

  85.                                         'length' => 'length of the linked content in octets' // optional
    86. 

  86.                                            ),
    87. 

  87.                                       array(
    88. 

  88.                                          //data for the second enclosure and so on
    89. 

  89.                                            )
    90. 

  90.                                         ) // list of the enclosures of the feed entry // optional
    91. 

  91.                    ),
    92. 

  92.                    array(
    93. 

  93.                    //data for the second entry and so on
    94. 

  94.                    )
    95. 

  95.                  )
    96. 

  96.  );
    97. 


	
    
				
  • access: public
    • 
			

	
	

		void
		
			__construct
		
					( $data)
			

	
			
    
					
  • 
				array
				$data			
    • 
				

		
			
	




	
	

		
		getEntries (line 211)
	
 
	
	

Returns an array of Zend_Feed_Builder_Entry instances  describing the entries of the feed

	
    
				
  • return: of Zend_Feed_Builder_Entry
    • 
				
  • access: public
    • 
			

	
	

		array
		
			getEntries
		
				()
			

	
		
				

		
Implementation of:

			

			
Zend_Feed_Builder_Interface::getEntries()

						
Returns an array of Zend_Feed_Builder_Entry instances  describing the entries of the feed

					

			
	




	
	

		
		getHeader (line 200)
	
 
	
	

Returns an instance of Zend_Feed_Builder_Header  describing the header of the feed

	
    
				
  • access: public
    • 
			

	
	

		Zend_Feed_Builder_Header
		
			getHeader
		
				()
			

	
		
				

		
Implementation of:

			

			
Zend_Feed_Builder_Interface::getHeader()

						
Returns an instance of Zend_Feed_Builder_Header  describing the header of the feed

					

			
	

						
		

	


	
	

		Documentation generated on Sun, 27 May 2007 23:21:08 -0700 by phpDocumentor 1.3.2