[ Index ]

PHP Cross Reference of Nucleus CMS v3.51 code documentation

title

Body

[close]

/nucleus/libs/ -> BLOG.php (summary)

A class representing a blog and containing functions to get that blog shown on the screen

Copyright: Copyright (C) 2002-2009 The Nucleus Group
License: http://nucleuscms.org/license.txt GNU General Public License
Version: $Id: BLOG.php 1398 2009-08-05 22:14:07Z ftruscot $
File Size: 1297 lines (38 kb)
Included or required: 1 time
Referenced: 1 time
Includes or requires: 0 files

Defines 1 class

BLOG:: (75 methods):
  BLOG()
  readLog()
  showArchive()
  setSelectedCategory()
  setSelectedCategoryByName()
  getSelectedCategory()
  readLogAmount()
  showUsingQuery()
  showOneitem()
  additem()
  sendNewItemNotification()
  createNewCategory()
  search()
  getSqlSearch()
  getSqlBlog()
  showArchiveList()
  showCategoryList()
  showBlogList()
  readSettings()
  writeSettings()
  updateUpdatefile()
  isValidCategory()
  getCategoryName()
  getCategoryDesc()
  getCategoryIdFromName()
  convertBreaks()
  insertJavaScriptInfo()
  setConvertBreaks()
  setAllowPastPosting()
  allowPastPosting()
  getCorrectTime()
  getName()
  getShortName()
  getMaxComments()
  getNotifyAddress()
  getNotifyType()
  notifyOnComment()
  notifyOnVote()
  notifyOnNewItem()
  setNotifyType()
  getTimeOffset()
  commentsEnabled()
  getURL()
  getDefaultSkin()
  getUpdateFile()
  getDescription()
  isPublic()
  emailRequired()
  getSearchable()
  getDefaultCategory()
  setPublic()
  setSearchable()
  setDescription()
  setUpdateFile()
  setDefaultSkin()
  setURL()
  setName()
  setShortName()
  setCommentsEnabled()
  setMaxComments()
  setNotifyAddress()
  setEmailRequired()
  setTimeOffset()
  setDefaultCategory()
  getSetting()
  setSetting()
  addTeamMember()
  getID()
  exists()
  existsID()
  setFuturePost()
  clearFuturePost()
  checkJustPosted()
  readLogFromList()
  getSqlItemList()


Class: BLOG  - X-Ref

BLOG($id)   X-Ref
Creates a new BLOG object for the given blog

param: $id blogid

readLog($template, $amountEntries, $offset = 0, $startpos = 0)   X-Ref
Shows the given amount of items for this blog

returns: int
param: $template
param: $amountEntries
param: $startpos

showArchive($templatename, $year, $month=0, $day=0)   X-Ref
Shows an archive for a given month

param: $year
param: $month
param: $template

setSelectedCategory($catid)   X-Ref
No description

setSelectedCategoryByName($catname)   X-Ref
No description

getSelectedCategory()   X-Ref
No description

readLogAmount($template, $amountEntries, $extraQuery, $highlight, $comments, $dateheads, $offset = 0, $startpos = 0)   X-Ref
Shows the given amount of items for this blog

returns: int
param: $template
param: $amountEntries
param: $extraQuery
param: $highlight
param: $comments
param: $dateheads
param: $offset

showUsingQuery($templateName, $query, $highlight = '', $comments = 0, $dateheads = 1)   X-Ref
No description

showOneitem($itemid, $template, $highlight)   X-Ref
No description

additem($catid, $title, $body, $more, $blogid, $authorid, $timestamp, $closed, $draft, $posted='1')   X-Ref
Adds an item to this blog


sendNewItemNotification($itemid, $title, $body)   X-Ref
No description

createNewCategory($catName = '', $catDescription = _CREATED_NEW_CATEGORY_DESC)   X-Ref
Creates a new category for this blog

returns:
param: $catName
param: $catDescription

search($query, $template, $amountMonths, $maxresults, $startpos)   X-Ref
Searches all months of this blog for the given query

returns:
param: $query
param: $template
param: $amountMonths
param: $maxresults
param: $startpos

getSqlSearch($query, $amountMonths = 0, &$highlight, $mode = '')   X-Ref
Returns an SQL query to use for a search query

returns: $highlight
returns:
param: $query
param: $amountMonths
param: $mode

getSqlBlog($extraQuery, $mode = '')   X-Ref
Returns the SQL query that's normally used to display the blog items on the index type skins

returns:
param: $mode

showArchiveList($template, $mode = 'month', $limit = 0)   X-Ref
Shows the archivelist using the given template


showCategoryList($template)   X-Ref
Shows the list of categories using a given template


showBlogList($template, $bnametype, $orderby, $direction)   X-Ref
Shows a list of all blogs in the system using a given template
ordered by     number, name, shortname or description
in ascending or descending order


readSettings()   X-Ref
Blogsettings functions


writeSettings()   X-Ref
No description

updateUpdatefile()   X-Ref
No description

isValidCategory($catid)   X-Ref
No description

getCategoryName($catid)   X-Ref
No description

getCategoryDesc($catid)   X-Ref
No description

getCategoryIdFromName($name)   X-Ref
No description

convertBreaks()   X-Ref
No description

insertJavaScriptInfo($authorid = '')   X-Ref
No description

setConvertBreaks($val)   X-Ref
No description

setAllowPastPosting($val)   X-Ref
No description

allowPastPosting()   X-Ref
No description

getCorrectTime($t=0)   X-Ref
No description

getName()   X-Ref
No description

getShortName()   X-Ref
No description

getMaxComments()   X-Ref
No description

getNotifyAddress()   X-Ref
No description

getNotifyType()   X-Ref
No description

notifyOnComment()   X-Ref
No description

notifyOnVote()   X-Ref
No description

notifyOnNewItem()   X-Ref
No description

setNotifyType($val)   X-Ref
No description

getTimeOffset()   X-Ref
No description

commentsEnabled()   X-Ref
No description

getURL()   X-Ref
No description

getDefaultSkin()   X-Ref
No description

getUpdateFile()   X-Ref
No description

getDescription()   X-Ref
No description

isPublic()   X-Ref
No description

emailRequired()   X-Ref
No description

getSearchable()   X-Ref
No description

getDefaultCategory()   X-Ref
No description

setPublic($val)   X-Ref
No description

setSearchable($val)   X-Ref
No description

setDescription($val)   X-Ref
No description

setUpdateFile($val)   X-Ref
No description

setDefaultSkin($val)   X-Ref
No description

setURL($val)   X-Ref
No description

setName($val)   X-Ref
No description

setShortName($val)   X-Ref
No description

setCommentsEnabled($val)   X-Ref
No description

setMaxComments($val)   X-Ref
No description

setNotifyAddress($val)   X-Ref
No description

setEmailRequired($val)   X-Ref
No description

setTimeOffset($val)   X-Ref
No description

setDefaultCategory($val)   X-Ref
No description

getSetting($key)   X-Ref
No description

setSetting($key,$value)   X-Ref
No description

addTeamMember($memberid, $admin)   X-Ref
No description

getID()   X-Ref
No description

exists($name)   X-Ref
No description

existsID($id)   X-Ref
No description

setFuturePost()   X-Ref
No description

clearFuturePost()   X-Ref
No description

checkJustPosted()   X-Ref
No description

readLogFromList($itemarray, $template, $highlight = '', $comments = 1, $dateheads = 1)   X-Ref
Shows the given list of items for this blog

returns: int
param: $itemarray
param: $template
param: $highlight
param: $comments
param: $dateheads

getSqlItemList($itemarray)   X-Ref
Returns the SQL query used to fill out templates for a list of items

returns:
param: $itemarray



Generated: Sun Aug 1 03:56:06 2010
Open Source related documentation for developers.