[ Index ]
 

Code source de GeekLog 1.4.1

Accédez au Source d'autres logiciels libres

title

Body

[fermer]

/plugins/links/ -> functions.inc (sommaire)

This file does two things: 1) it implements the necessary Geeklog Plugin API method and 2) implements all the common code needed by the links Plugins' PHP files.

Author: Trinity Bays
Author: Tony Bibbs
Author: Tom Willett
Author: Blaine Lang
Author: Dirk Haun
Copyright: Copyright © 2005-2006
License: http://opensource.org/licenses/gpl-license.php GNU Public License
Version: 1.0.1
Poids: 1272 lignes (42 kb)
Inclus ou requis:0 fois
Référencé: 0 fois
Nécessite: 0 fichiers

Définit 34 fonctions

  plugin_getmenuitems_links()
  plugin_whatsnewsupported_links()
  plugin_getwhatsnew_links()
  plugin_autotags_links()
  plugin_chkVersion_links()
  LINKS_countLinksAndClicks()
  plugin_showstats_links()
  plugin_statssummary_links()
  plugin_searchtypes_links()
  plugin_dopluginsearch_links()
  plugin_cclabel_links()
  plugin_getadminoption_links()
  plugin_user_delete_links()
  plugin_getfeednames_links()
  plugin_getfeedcontent_links()
  links_buildSql()
  plugin_feedupdatecheck_links()
  plugin_upgrade_links()
  plugin_enablestatechange_links()
  plugin_uninstall_links()
  plugin_submissioncount_links()
  plugin_ismoderator_links()
  plugin_itemlist_links()
  plugin_moderationvalues_links()
  plugin_moderationapprove_links()
  plugin_moderationdelete_links()
  plugin_savesubmission_links()
  plugin_submit_links()
  plugin_save_submit_links()
  LINKS_sendNotification()
  plugin_geticon_links()
  plugin_getListField_links()
  links_getCategoryList()
  plugin_templatesetvars_links()

Fonctions
Fonctions qui ne font pas partie d'une Classe:

plugin_getmenuitems_links()   X-Ref
Returns the items for this plugin that should appear on the main menu

NOTE: this MUST return the url/value pairs in the following format
$<arrayname>[<label>] = <url>

return: mixed   menu entry, or boolean false if disabled / hidden

plugin_whatsnewsupported_links()   X-Ref
Return headlines for New Links section in the What's New block, if enabled

return: mixed       array(headline, byline), or boolean false is disabled

plugin_getwhatsnew_links()   X-Ref
Return new links for the What's New block

return: string  HTML list of new links

plugin_autotags_links($op, $content = '', $autotag = '')   X-Ref
Implements the [link:] autotag.

param: string  $op         operation to perform
param: string  $content    item (e.g. story text), including the autotag
param: array   $autotag    parameters used in the autotag
param: mixed               tag names (for $op='tagname') or formatted content

plugin_chkVersion_links()   X-Ref
Called by the plugin Editor to display the current plugin code version
This may be different than the version installed and registered currently.
If newer then you may want to run the update

return: string  version number

LINKS_countLinksAndClicks()   X-Ref
Helper function: count number of links and total number of clicks

return: array(number of links, number of clicks);

plugin_showstats_links($showsitestats)   X-Ref
Shows the statistics for the links plugin on stats.php.
If $showsitestats is 1 then we are to only print the overall stats in the
'site statistics box' otherwise we show the detailed stats

param: int     $showsitestate  Flag to let us know which stats to get
param: string                  HTML for the stats section

plugin_statssummary_links()   X-Ref
New stats plugin API function for proper integration with the site stats

return: array(item text, item count);

plugin_searchtypes_links()   X-Ref
Geeklog is asking us to provide any items that show up in the type
drop-down on search.php.  Let's users search for links.

return: array   (plugin name/entry title) pair for the dropdown

plugin_dopluginsearch_links($query, $datestart, $dateend, $topic, $type, $author, $keyType, $page, $perpage)   X-Ref
This searches for links matching the user query and returns an array for the
header and table rows back to search.php where it will be formated and printed

param: string  $query      Keywords user is looking for
param: date    $datestart  Start date to get results for
param: date    $dateend    End date to get results for
param: string  $topic      The topic they were searching in
param: string  $type       Type of items they are searching, or 'all'
param: int     $author     Get all results by this author
param: string  $keyType    search key type: 'all', 'phrase', 'any'
param: int     $page       page number of current search
param: int     $perpage    number of results per page
return: object              search result object

plugin_cclabel_links()   X-Ref
This will put an option for links in the command and control block on
moderation.php

return: mixed   array(title, url, icon), or boolean false when not allowed

plugin_getadminoption_links()   X-Ref
returns the administrative option for this plugin

return: mixed   array(title, url, num. links), or void when not allowed

plugin_user_delete_links($uid)   X-Ref
A user is about to be deleted. Update ownership of any links owned
by that user or delete them.

param: int     $uid    User id of deleted user
return: void

plugin_getfeednames_links()   X-Ref
Do we support feeds?

return: array   id/name pairs of all supported feeds

plugin_getfeedcontent_links($feed, &$link, &$update)   X-Ref
Provide feed data

param: int     $feed       feed ID
param: ref     $link
param: ref     $update
return: array               feed entries

links_buildSql($category, $limits)   X-Ref
Helper function: Build part of an SQL request

param: string  $category   category name
param: string  $limits     limit (number of entries or number of hours)
return: string              part of an SQL request

plugin_feedupdatecheck_links($feed, $topic, $update_data, $limit, $updated_type = '', $updated_topic = '', $updated_id = '')   X-Ref
Checking if links feeds are up to date

param: int     $feed           id of feed to be checked
param: string  $topic          topic (actually: category)
param: string  $update_data    data describing current feed contents
param: string  $limit          number of entries or number of hours
param: string  $updated_type   (optional) type of feed to be updated
param: string  $updated_topic  (optional) feed's "topic" to be updated
param: string  $updated_id     (optional) id of entry that has changed
return: boolean                 true: feed data is up to date; false: isn't

plugin_upgrade_links()   X-Ref
Update the Links plugin

return: int     Number of message to display (true = generic success msg)

plugin_enablestatechange_links($enable)   X-Ref
Geeklog informs us that we're about to be enabled or disabled

param: boolean     $enable     true = we're being enabled, false = disabled
return: void

plugin_uninstall_links()   X-Ref
Removes the datastructures for this plugin from the Geeklog database

This may get called by the install routine to undo anything done to this
point.

return: boolean     true: uninstalled successfully

plugin_submissioncount_links()   X-Ref
Counts the items that are submitted

return: int     number of items in submission queue

plugin_ismoderator_links()   X-Ref
Checks that the current user has the rights to moderate the
plugin, returns true if this is the case, false otherwise

return: boolean       Returns true if moderator

plugin_itemlist_links()   X-Ref
Returns SQL & Language texts to moderation.php

return: mixed   plugin object or void if not allowed

plugin_moderationvalues_links()   X-Ref
returns list of moderation values

The array returned contains (in order): the row 'id' label, main plugin
table, moderation fields (comma seperated), and plugin submission table

return: array        Returns array of useful moderation values

plugin_moderationapprove_links($id)   X-Ref
Performs plugin exclusive work for items approved by moderation

While moderation.php handles the actual move from linkssubmission
to links tables, within the function we handle all other approval
relate tasks

param: string  $id     Identifying string
return: string          Any wanted HTML output

plugin_moderationdelete_links($id)   X-Ref
Performs plugin exclusive work for items deleted by moderation

While moderation.php handles the actual removal from <plugin>submission
table, within this function we handle all other deletion
related tasks

param: string  $id     Identifying string
return: string          Any wanted HTML output

plugin_savesubmission_links($A)   X-Ref
Check submission form values and save if OK. Else show form again

param: array   $A  The link record
return: string      Any wanted HTML output

plugin_submit_links()   X-Ref
Shows link submission form

return: string  HTML for the link submission form

plugin_save_submit_links($A)   X-Ref
Saves a link submission

param: array   $A  Data for that submission
return: string      HTML redirect

LINKS_sendNotification($table, $A)   X-Ref
Send an email notification for a new submission.

param: string  $table  Table where the new submission can be found
param: array   $A      submission data

plugin_geticon_links()   X-Ref
Returns the URL of the plugin's icon

return: string      URL of the icon

plugin_getListField_links($fieldname, $fieldvalue, $A, $icon_arr)   X-Ref
Pas de description

links_getCategoryList(&$current_category)   X-Ref
Return a list of all link categories

param: ref     $current_category   currently selected category
return: string                      <option> list containing all categories

plugin_templatesetvars_links($templatename, &$template)   X-Ref
Set template variables

param: string  $templatename   name of template, e.g. 'header'
param: ref     $template       reference of actual template
return: void



Généré le : Wed Nov 21 12:27:40 2007 par Balluche grâce à PHPXref 0.7
  Clicky Web Analytics