Class: CalendarMonthComponent

Source Location: /framework/template/components/calendar/calendar_month.inc.php

http://wact.sourceforge.net/index.php/CalendarMonthComponent

Class Overview

Component
   |
   --BlockComponent
      |
      --HtmlBaseComponent
         |
         --CalendarMonthComponent

Runtime calendar API

Variables

Methods

Inherited Variables

Class: BlockComponent

BlockComponent::$visible

Class: Component

Component::$children
Component::$id
Component::$IsDynamicallyRendered
Component::$parent

Inherited Methods

Class: BlockComponent

BlockComponent::hide(): Changes the block state to invisible
BlockComponent::IsVisible(): Called within the compiled template render function to determine whether block should be displayed.
BlockComponent::show(): Changes the block state to visible

Class: Component

Component::addChild(): Adds a reference to a child component to this component, using it's ID attribute as the child array key
Component::findChild(): Returns a child component given it's ID.
Component::findChildByClass(): Returns the first child component matching the supplied WACT_TEMPLATE Component PHP class name
Component::findParentByClass(): Recursively searches through parents of this component searching for a given WACT_TEMPLATE component PHP class name
Component::getChild(): Same as find child, except raises error if child is not found
Component::getServerId(): Returns the ID of the component, as defined in the template tags ID attribute
Component::render(): Outputs the component, rendering any child components as well This method will only ever be called on components that support Dynamic rendering.
Component::setChildDataSource(): set the data source of a child component, or raise an error if the child is not found.

Class Details

Runtime calendar API

access:	public
see:	http://wact.sourceforge.net/index.php/CalendarMonthComponent
todo:	EXPERIMENTAL

Class Variables

$baseUrl =

Type:

mixed

$Calendar =

Instance of PEAR::Calendar_Month_Weekdays

access:

private

Type:

Calendar_Month_Weekdays

$dayUri = d

String for day GET variable

access:

private

Type:

string

$monthUri = m

String for month GET variable

access:

private

Type:

string

$selection = array()

Array of PEAR::Calendar_Day objects to be used in selection

access:

private

Type:

array

$Textual =

Instance of PEAR::Calendar_Decorator_Textual

access:

private

Type:

Calendar_Decorator_Textual

$Uri =

Instance of PEAR::Calendar_Decorator_Uri

access:

private

Type:

Calendar_Decorator_Uri

$Wrapper =

Instance of PEAR::Calendar_Decorator_Wrapper

access:

private

Type:

Calendar_Decorator_Wrapper

$yearUri = y

String for year GET variable

access:

private

Type:

string

Class Methods

constructor CalendarMonthComponent

CalendarMonthComponent CalendarMonthComponent(
)

method dayHeaders

Returns the headers for the days of the week

string dayHeaders(
string
$format)

API Tags:

access:

protected

Parameters:

string

$format

how to format: 'long', 'short','two','one'

method dayLink

void dayLink(
mixed
$day)

method getBaseUri

Return the URI to a specific page in the list.

string getBaseUri(
)

API Tags:

access:

public

method getCalendar

Returns the PEAR::Calendar_Month_Weekdays object wrapped in a Calendar_Decorator_Wrapper instance

Calendar_Decorator_Wrapper &getCalendar(
)

API Tags:

access:

protected

method monthName

Returns the month name formated

string monthName(
string
$format)

API Tags:

access:

protected

Parameters:

string

$format

how to format: 'long', 'short','two','one'

method nextLink

Returns the URI string for the next month

string nextLink(
)

API Tags:

access:

protected

method prepare

void prepare(
)

API Tags:

access:

protected

method prevLink

Returns the URI string for the previous month

string prevLink(
)

API Tags:

access:

protected

method setSelection

Sets a selection of PEAR::Calendar_Day objects

void setSelection(
array
$selection)

API Tags:

access:

public

Parameters:

array

$selection

method yearFormatted

Returns the year

string yearFormatted(
string
$format)

API Tags:

access:

protected

Parameters:

string

$format

how to format: 'full', 'two' (digits) or 'hide'

Documentation generated on Sun, 28 Nov 2004 19:44:23 -0800 by phpDocumentor 1.2.3