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

Procedural File: lib-syndication.php

Source Location: /system/lib-syndication.php



Page Details:



Includes:

require_once($_CONF['path_system'].'lib-story.php') [line 41]
require_once($_CONF['path_system'].'lib-trackback.php') [line 38]






SYND_feedUpdateCheck [line 184]

boolean SYND_feedUpdateCheck( string $topic, string $update_data, string $limit, [string $updated_topic = ''], [string $updated_id = ''])

Check if the contents of Geeklog's built-in feeds need to be updated.



Tags:

return:  false = feed has to be updated, true = ok


Parameters

string   $topic   indicator of the feed's "topic"
string   $update_data   comma-sep. list of updated ids
string   $limit   number of entries or number of hours
string   $updated_topic   (optional) specific topic to update
string   $updated_id   (optional) specific id to update
[ Top ]



SYND_feedUpdateCheckAll [line 56]

boolean SYND_feedUpdateCheckAll( boolean $frontpage_only, string $update_info, string $limit, [string $updated_topic = ''], [string $updated_id = ''])

Check if a feed for all stories needs to be updated.



Tags:

return:  false = feed needs to be updated


Parameters

boolean   $frontpage_only   true: only articles shown on the frontpage
string   $update_info   list of story ids
string   $limit   number of entries or number of hours
string   $updated_topic   (optional) topic to be updated
string   $updated_id   (optional) entry id to be updated
[ Top ]



SYND_feedUpdateCheckTopic [line 125]

boolean SYND_feedUpdateCheckTopic( string $tid, string $update_info, string $limit, [string $updated_topic = ''], [string $updated_id = ''])

Check if a feed for stories from a topic needs to be updated.



Tags:

return:  false = feed needs to be updated


Parameters

string   $tid   topic id
string   $update_info   list of story ids
string   $limit   number of entries or number of hours
string   $updated_topic   (optional) topic to be updated
string   $updated_id   (optional) entry id to be updated
[ Top ]



SYND_fixCharset [line 694]

void SYND_fixCharset( int $fid)

Fix the character set of a default feed file which is hard-coded as 'iso-8859-1'.



Parameters

int   $fid   feed id
[ Top ]



SYND_getDefaultFeedUrl [line 675]

string SYND_getDefaultFeedUrl( )

Helper function: Get default feed URL This is mostly for backward compatibility: Back in the dark ages, Geeklog only had one RSS feed and its URL was available as a template variable.

Moved that code here from COM_siteHeader/Footer for better encapsulation.




Tags:

return:  URL of the feed


[ Top ]



SYND_getFeedContentAll [line 323]

array SYND_getFeedContentAll( boolean $frontpage_only, string $limit, &$link, &$update, int $contentLength, $feedType, $feedVersion, int $fid, string $link, string $update)

Get content for a feed that holds all stories.



Tags:

return:  content of the feed


Parameters

boolean   $frontpage_only   true: only articles shown on the frontpage
string   $limit   number of entries or number of stories
string   $link   link to homepage
string   $update   list of story ids
int   $contentLength   Length of summary to allow.
int   $fid   the id of the feed being fetched
   &$link  
   &$update  
   $feedType  
   $feedVersion  
[ Top ]



SYND_getFeedContentPerTopic [line 217]

array SYND_getFeedContentPerTopic( string $tid, string $limit, &$link, &$update, $contentLength, $feedType, $feedVersion, $fid, string $link, string $update)

Get content for a feed that holds stories from one topic.



Tags:

return:  content of the feed


Parameters

string   $tid   topic id
string   $limit   number of entries or number of stories
string   $link   link to topic
string   $update   list of story ids
   &$link  
   &$update  
   $contentLength  
   $feedType  
   $feedVersion  
   $fid  
[ Top ]



SYND_getFeedPath [line 611]

string SYND_getFeedPath( [string $feedfile = ''])

Get the path of the feed directory or a specific feed file



Tags:

return:  path of feed directory or file


Parameters

string   $feedfile   (option) feed file name
[ Top ]



SYND_getFeedType [line 660]

string SYND_getFeedType( string $format)

Helper function: Derive printable feed format name



Tags:

return:  MIME type, e.g. application/atom+xml


Parameters

string   $format   internal name of the feed format, e.g. Atom-1.0
[ Top ]



SYND_getFeedUrl [line 628]

string SYND_getFeedUrl( [string $feedfile = ''])

Get the URL of the feed directory or a specific feed file



Tags:

return:  URL of feed directory or file


Parameters

string   $feedfile   (option) feed file name
[ Top ]



SYND_getMimeType [line 646]

string SYND_getMimeType( string $format)

Helper function: Return MIME type for a feed format



Tags:

return:  MIME type, e.g. application/atom+xml


Parameters

string   $format   internal name of the feed format, e.g. Atom-1.0
[ Top ]



SYND_truncateSummary [line 598]

string SYND_truncateSummary( string $text, int $length)

Truncate a feed item's text to a given max. length of characters



Tags:

return:  truncated text Note: Use COM_truncateHTML from now on.


Parameters

string   $text   the item's text
int   $length   max. length
[ Top ]



SYND_updateFeed [line 448]

void SYND_updateFeed( int $fid)

Update a feed.

Re-written by Michael Jervis (mike AT fuckingbrit DOT com) to use the new architecture




Parameters

int   $fid   feed id
[ Top ]



Documentation generated on Sun, 02 Oct 2016 07:51:40 +0000 by phpDocumentor 1.4.3