Docs For Class Calendar

Class Overview

Calendar

Located in /blogs/plugins/_calendar.plugin.php [line 291]

Property Summary

boolean	$browseyears	Do we want to browse years in the caption? True by default for mode == year, false for mode == month (gets set in constructor).
mixed	$cellend
mixed	$cellstart
mixed	$context_isolation
mixed	$displaycaption
mixed	$emptycellcontent
mixed	$emptycellend
mixed	$emptycellstart
mixed	$headercellend
mixed	$headercellstart
mixed	$headerdisplay
mixed	$headerrowend
mixed	$headerrowstart
mixed	$linktomontharchive
mixed	$link_type
string	$mode	'month' or 'year'
string	$month	The month to display or empty in mode 'year' with no selected month.
mixed	$monthend
mixed	$monthformat
mixed	$monthstart
string	$navigation	Where to do the navigation
mixed	$params
string	$request	SQL query string
mixed	$result	Result set
integer	$result_num_rows	Number of rows in result set
mixed	$rowend
mixed	$rowstart
mixed	$tableend
mixed	$tablestart
boolean	$today_is_visible	Is today in the displayed frame?
mixed	$where
mixed	$year

[ Top ]

Method Summary

Calendar	Calendar()	Calendar::Calendar(-)
void	archive_link()	Create a link to archive, using either URL params or extra path info.
void	display()	Display the calendar.
array	getNavLinks()	Get links to navigate between month / year.
void	set()

[ Top ]

Properties

boolean $browseyears [line 362]

Do we want to browse years in the caption? True by default for mode == year, false for mode == month (gets set in constructor).

[ Top ]

mixed $cellend [line 350]

[ Top ]

mixed $cellstart [line 349]

[ Top ]

mixed $context_isolation [line 373]

[ Top ]

mixed $displaycaption [line 323]

[ Top ]

mixed $emptycellcontent [line 355]

[ Top ]

mixed $emptycellend [line 353]

[ Top ]

mixed $emptycellstart [line 352]

[ Top ]

mixed $headercellend [line 347]

[ Top ]

mixed $headercellstart [line 346]

[ Top ]

mixed $headerdisplay [line 343]

[ Top ]

mixed $headerrowend [line 345]

[ Top ]

mixed $headerrowstart [line 344]

[ Top ]

mixed $linktomontharchive [line 327]

[ Top ]

mixed $link_type [line 372]

[ Top ]

string $mode [line 305]

'month' or 'year'

[ Top ]

string $month [line 299]

The month to display or empty in mode 'year' with no selected month.

[ Top ]

mixed $monthend [line 326]

[ Top ]

mixed $monthformat [line 324]

[ Top ]

mixed $monthstart [line 325]

[ Top ]

string $navigation = 'tfoot' [line 335]

Where to do the navigation

'caption' or 'tfoot';

[ Top ]

mixed $params = array( ) [line 375]

[ Top ]

string $request [line 312]

SQL query string

[ Top ]

mixed $result [line 316]

Result set

[ Top ]

integer $result_num_rows [line 321]

Number of rows in result set

[ Top ]

mixed $rowend [line 341]

[ Top ]

mixed $rowstart [line 340]

[ Top ]

mixed $tableend [line 338]

[ Top ]

mixed $tablestart [line 337]

[ Top ]

boolean $today_is_visible [line 369]

Is today in the displayed frame?

API Tags:

Access:

protected

[ Top ]

mixed $where [line 307]

[ Top ]

mixed $year [line 293]

[ Top ]

Methods

Constructor Calendar [line 387]

Calendar Calendar(
[string
$m = ''], [array
$params = array()] 
)

Calendar::Calendar(-)

Constructor

Parameters:

string	$m:	Month ('YYYYMM'), year ('YYYY'), current ('')
array	$params:	Associative array of parameters. Valid keys are: 'min_timestamp' : Minimum unix timestamp the user can browse too or 'query' (Default: 2000-01-01) 'max_timestamp' : Maximum unix timestamp the user can browse too or 'query' (Default: now + 1 year )

[ Top ]

archive_link [line 863]

void archive_link(
string
$text, string
$title, string
$year, [string
$month = NULL], [string
$day = NULL] 
)

Create a link to archive, using either URL params or extra path info.

Can make contextual links.

Parameters:

string	$text:
string	$title:
string	$year:	year
string	$month:	month
string	$day:	day

[ Top ]

display [line 526]

void display(
)

Display the calendar.

Information Tags:

Todo:

If a specific day (mode == month) or month (mode == year) is selected, apply another class (default to some border)

[ Top ]

getNavLinks [line 898]

array getNavLinks(
string
$direction 
)

Get links to navigate between month / year.

Unless min/max_timestamp='query' has been specified, this will not do any (time consuming!) queries to check where the posts are.

Parameters:

string

$direction:

'prev' / 'next'

[ Top ]

set [line 515]

void set(

$var, 
$value 
)

Parameters:

	$var:
	$value:

[ Top ]

Multilingual multiuser multiblog engine

Class: Calendar

Class Calendar

Packages

Classes

Files