/sources/authors.php

Description
Description | Functions
Functions
Description | Functions
add_author (line 107)

Adds an author (re-creating them if they already exist - thus it also serves to edit; the reason for this is the fluidity of authors - members are automatically authors even before an author profile is made)

void add_author (ID_TEXT $author, URLPATH $url, ?MEMBER $forum_handle, LONG_TEXT $description, LONG_TEXT $skills, [?SHORT_TEXT $meta_keywords = ''], [?LONG_TEXT $meta_description = ''])
  • ID_TEXT $author: The name of an author
  • URLPATH $url: The URL to the authors home page
  • ?MEMBER $forum_handle: The member ID of the author (NULL: no forum profile)
  • LONG_TEXT $description: A description of the author
  • LONG_TEXT $skills: A terse string showing author skills
  • ?SHORT_TEXT $meta_keywords: Meta keywords for this resource (NULL: do not edit) (blank: implicit)
  • ?LONG_TEXT $meta_description: Meta description for this resource (NULL: do not edit) (blank: implicit)
authors_script (line 24)

Shows an HTML page of all authors clickably.

void authors_script ()
delete_author (line 136)

Delete an author

void delete_author (ID_TEXT $author)
  • ID_TEXT $author: The name of an author
get_author_id_from_name (line 86)

Get a member ID from an author name. First by trying authors table, second by trying forum membernames.

  • return: The member ID (NULL: none found)
?MEMBER get_author_id_from_name (ID_TEXT $author)
  • ID_TEXT $author: The name of an author
has_delete_author_permission (line 171)

Find if a member's usergroup has permission to delete an author

  • return: Whether the member can edit this author
boolean has_delete_author_permission (MEMBER $member, ID_TEXT $author)
  • MEMBER $member: The member being checked whether to have the access
  • ID_TEXT $author: An author
has_edit_author_permission (line 156)

Find if a member's usergroup has permission to edit an author

  • return: Whether the member can edit this author
boolean has_edit_author_permission (MEMBER $member, ID_TEXT $author)
  • MEMBER $member: The member being checked whether to have the access
  • ID_TEXT $author: An author
merge_authors (line 185)

Merge two authors.

void merge_authors (ID_TEXT $from, ID_TEXT $to)
  • ID_TEXT $from: The first author (being removed effectively)
  • ID_TEXT $to: The second author (subsuming the first)

Documentation generated on Sun, 02 Jan 2011 23:08:44 +0000 by phpDocumentor 1.4.3