Docs For Class naked

Description

A utility class for timing the Naked Day event

author: Jim Auldridge
version: 1.1
copyright: 2008 Jim Auldridge
link: http://naked.dustindiaz.com/
link: http://www.jaaulde.com/naked_day/
name: naked_day
license: http://www.opensource.org/licenses/bsd-license.php

Located in /naked_day.php (line 13)

Variable Summary

static mixed $config_cache_expire

static mixed $css_replacement

static mixed $day

static mixed $end

static mixed $initialized

static mixed $international_day

static mixed $is_naked_day

static mixed $is_naked_day_over

static mixed $live_config_file

static mixed $live_config_url

static mixed $message

static mixed $month

static mixed $now

static mixed $start

static mixed $year

Method Summary

static BOOLEAN coming_soon ()

static void css_replacement ()

static INTEGER day ()

static INTEGER how_long_til ()

static void init ([BOOLEAN $live_config = true], [INTEGER $d = null], [INTEGER $m = null], [INTEGER $y = null], [BOOLEAN $international_day = true], [STRING $message = ''], [STRING $css_replacement = ''])

static BOOLEAN live_config ()

static void message ()

static INTEGER month ()

static BOOLEAN over ()

static BOOLEAN today ()

static void verify_init ()

static INTEGER year ()

Variables

static mixed $config_cache_expire = 43200 (line 36)

access: protected

static mixed $css_replacement = '' (line 23)

access: protected

static mixed $day = null (line 16)

access: protected

static mixed $end = 0 (line 28)

access: protected

static mixed $initialized = false (line 32)

access: protected

static mixed $international_day = true (line 20)

access: protected

static mixed $is_naked_day = false (line 30)

access: protected

static mixed $is_naked_day_over = false (line 31)

access: protected

static mixed $live_config_file = 'live_config_cache.json' (line 35)

access: protected

static mixed $live_config_url = 'http://php-naked-day-api.googlecode.com/files/config.json' (line 34)

access: protected

static mixed $message = '' (line 22)

access: protected

static mixed $month = null (line 17)

access: protected

static mixed $now = 0 (line 25)

access: protected

static mixed $start = 0 (line 27)

access: protected

static mixed $year = null (line 18)

access: protected

Methods

static method coming_soon (line 216)

Is Naked Day coming soon?

access: public

static BOOLEAN coming_soon ()

static method css_replacement (line 260)

Output a HTML comment where CSS would normally have been

access: public

static void css_replacement ()

static method day (line 172)

Get the day of month in which naked day will occur

access: public

static INTEGER day ()

static method how_long_til (line 238)

How long until naked day (in seconds)?

access: public

static INTEGER how_long_til ()

static method init (line 51)

Initialize the timer and trigger its calculations

access: public

static void init ([BOOLEAN $live_config = true], [INTEGER $d = null], [INTEGER $m = null], [INTEGER $y = null], [BOOLEAN $international_day = true], [STRING $message = ''], [STRING $css_replacement = ''])

BOOLEAN $live_config: (optional) flag whether or not to connect to naked.dustindiaz.com for live configuration data
INTEGER $d: (optional) day of month on which Naked Day will occur
INTEGER $m: (optional) number of month in which Naked Day will occur
INTEGER $y: (optional) year in which Naked Day will occur
BOOLEAN $international_day: (optional) full 48 hour period or local 24?
STRING $message: (optional) text/html to output on call to message()
STRING $css_replacement: (optional) text/html to output on call to css_replacement()

static method live_config (line 98)

Retrieve and process live configuration data

access: protected

static BOOLEAN live_config ()

static method message (line 249)

Output a message about naked day

access: public

static void message ()

static method month (line 183)

Get the number of month in which naked day will occur

access: public

static INTEGER month ()

static method over (line 227)

Enter description here...

access: public

static BOOLEAN over ()

static method today (line 205)

Is Naked Day today?

access: public

static BOOLEAN today ()

static method verify_init (line 151)

Verify the data after initialization to ensure it is valid

throws: Exception
access: protected

static void verify_init ()

static method year (line 194)

Get the year in which naked day will occur

access: public

static INTEGER year ()

Class naked_day