[ Index ]

PHP Cross Reference of PivotX 2.3 branch SVN

title

Body

[close]

/pivotx/modules/ -> module_db.php (summary)

(no description)

File Size: 571 lines (15 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

db:: (29 methods):
  __construct()
  getlist()
  getArchiveArray()
  get_entries_count()
  get_next_code()
  get_previous_code()
  generate_index()
  entry_exists()
  read_entry()
  read_entries()
  guess_entry()
  get_entry_by_uri()
  read_latestcomments()
  read_lasttrackbacks()
  set_entry()
  delete_entry()
  delete_entries()
  delete_comment()
  get_comment()
  delete_trackback()
  get_trackback()
  save_entry()
  get_date()
  disallow_write()
  allow_write()
  publish_entries()
  depublish_entries()
  checkTimedPublish()
  clearIndex()


Class: db  - X-Ref

class db
The API for accessing the database.

__construct($loadindex=TRUE)   X-Ref
Initialises the db.

param: boolean $loadindex Whether the index should be loaded.

getlist($amount, $offset=0, $filteronuser="", $filteroncat="", $order=TRUE, $field="", $status="")   X-Ref
Gets a list of entries by date.  This function is really deprecated and
acts like a wrapper around read_entries.

param: int $amount
param: int $offset
param: mixed $filteronuser
param: mixed $filteroncat
param: boolean $order Defines whether the results are in chronological
param: string $field The field to order by.
param: string $status Return only entries with this status.
return: array

getArchiveArray($force=FALSE, $unit)   X-Ref
Gets an array of archives.

param: boolean $force tells if the cache (if any) should be updated.
param: string $unit the unit of the archives.
return: array

get_entries_count($params=false)   X-Ref
Gets the number of entries.

The $params array can take the same keys as in the read_entries
function, but only the following keys give meaning when counting:

- 'offset': The offset from the beginning of the filtered and sorted/ordered array.
- 'cats': Filter entries by category/ies.
- 'extrafields': Filter entries by extrafields.
- 'user': Filter entries by user(s).
- 'status': Filter entries by status.
- 'date': A date range - day, month or year.
- 'start'/'end': A start/end date.

'cats', 'extrafields' and 'user' can either be (comma separated) strings or arrays.

param: array $params
return: int

get_next_code($num=1, $category="")   X-Ref
Gets the code of the next entry.

param: int $num
return: int

get_previous_code($num=1, $category="")   X-Ref
Gets the code of the previous entry.

param: int $num
return: int

generate_index()   X-Ref
Rebuilds the index, if necessary.


entry_exists($code)   X-Ref
Tells if the entry exists.

param: int $code The code/id of the entry.
return: boolean

read_entry($code, $date="")   X-Ref
Retrieves a full entry as an associative array, and returns it. The $code
parameter can be a code/uid or an URI. The optional $date parameter helps
to narrow it down, if there's more than one option.

param: mixed $code
param: string $date
return: array

read_entries($params)   X-Ref
Read a bunch of entries.

The $params array can have the following keys:

- 'full': Determines if the returned entries should be full (contain all fields), the default, or be reduced. (true/false)
- 'show': Amount of entries to read.
- 'offset': The offset from the beginning of the filtered and sorted/ordered array.
- 'cats': Filter entries by category/ies.
- 'extrafields': Filter entries by extrafields.
- 'user': Filter entries by user(s).
- 'status': Filter entries by status.
- 'order': Select random, asc(ending) or des(cending).
- 'orderby': Default is date, but any entry field (e.g. code/uid) can be used.
- 'date': A date range - day, month or year.
- 'start'/'end': A start/end date.

'cats', 'extrafields' and 'user' can either be (comma separated) strings or arrays.

param: array $params
return: array

guess_entry($uri, $date = '')   X-Ref
Tries to guess an entry by it's (incomplete) URI and date (if
available). The entry is returned as an associative array.

param: string $uri
param: string $date
return: array

get_entry_by_uri($uri)   X-Ref
Get an entry by its specific URI.

param: string $uri
param: string $date
return: array

read_latestcomments($params)   X-Ref
Read the latest comments

param: array $params
return: array

read_lasttrackbacks($params)   X-Ref
Read the last trackbacks

param: array $params
return: array

set_entry($entry)   X-Ref
Sets the current entry to the contents of $entry.

Returns the inserted entry as it got stored in the database with
correct code/id and Word HTML stripped off.

param: array $entry The entry to be inserted
return: array

delete_entry()   X-Ref
Deletes the current entry


delete_entries($ids)   X-Ref
Delete one or more entries.

param: array $ids

delete_comment($uid)   X-Ref
Deletes a comment from the current entry.

param: integer uid

get_comment($uid)   X-Ref
Returns a comment from the current entry.

param: integer uid

delete_trackback($uid)   X-Ref
Deletes a trackback from the current entry.

param: integer uid

get_trackback($uid)   X-Ref
Returns a trackback from the current entry.

param: integer uid

save_entry($update_index=TRUE)   X-Ref
Saves the current entry.

Returns true if successfully saved. Current implementation
(in module_db_xml.php) seems to return true no matter what.

param: boolean $update_index Whether to update the date index.
return: boolean

get_date($code)   X-Ref
Gets the date for an entry

param: int $code
return: string

disallow_write()   X-Ref
Switches to writing-disallowed mode.


allow_write()   X-Ref
Switches to writing-allowed mode.


publish_entries($ids)   X-Ref
Set one or more entries to 'publish'

param: array $ids

depublish_entries($ids)   X-Ref
Set one or more entries to 'hold'

param: array $ids

checkTimedPublish()   X-Ref
Checks if any entries set to 'timed publish' should be published.


clearIndex($type)   X-Ref
Clears the index for searching or tags.

param: string $type
return: void



Generated: Tue Jun 27 01:07:56 2017 Cross-referenced by PHPXref 0.6