/boxes/fortune/index.php

Description

Fortune page element.

$Id: index.php 594 2006-03-20 11:12:42Z stijn $

Functions
boxFortune (line 36)

Display a fortune box.

Displays a box with a random quote. As with all boxes, call addBox() from within the theme before using a box.

void boxFortune ()
readFortune (line 69)

Read a fortune from a file.

Returns a verbatim fortune string, or false if the file is unreadable. Fortunes are formatted according to standard Unix fortune file conventions, with messages separated by <literal>%</literal> starting in column one on a single line (without whitespace at the end of the line). Running strfile(8) on a Unix system is not necessary.

  • return: the fortune selected or false if an error occurred.
string readFortune (string $file, [int $short = false])
  • string $file: the filename to read fortunes from
  • int $short: the maximum number of characters that the returned fortune may have

Documentation generated on Fri, 30 Jun 2006 10:31:37 +0200 by phpDocumentor 1.3.0RC3