Docs For Class calendar

Description

Class calendrier, permetant de générer un calendrier sous différent format.

license: lLGPL (GNU Lesser General Public License)
version: 0.9.0
link: Grummfy
copyright: Grummfy 12/09/2005
author: Grummfy <grummfy@yahoo.fr>

Variable Summary

array $evenement

const $fday

timestamp $ftime

const $html_v

array $lng_day

array $lng_month

int $nbr_periode

const $periode

const $short_day

const $short_month

Method Summary

calendar calendar ()

string get_calendar ([timestamp $timestamp = ''])

boolean is_bisextille (year $time, [boolean $timestamp_or_year = true])

void make_day (timestamp $day, [boolean $select = false], [boolean $blank = false])

array make_head_day (timestamp $day, [boolean $a_week = true])

string make_month (timestamp $month, [boolean $day_selet = true])

string parse_calendar ([timestamp $timestamp = ''])

void print_calendar ([timestamp $timestamp = ''])

void reset ()

void set_debut (int $day, int $month, int $year)

void set_evenement (timestamp $timestamp, string $nom, [string $description = ''], [string $description_long = ''], [string $lien = ''], [string $nom_lien = ''], [boolean $lien_out = true])

void set_first_day ([const $day = CALENDAR_DAY_MON])

void set_format ([const $format = CALENDAR_TYPE_HTML])

void set_lang ([array $day = array()], [array $month = array()], [const $day_short = CALENDAR_SHORT_DAY], [const $month_short = CALENDAR_LONG_DAY])

void set_periode ([int $nbr_periode = 1], [const $periode = CALENDAR_PERIODE_MONTH])

Variables

array $evenement = array()

Contient les événements

access: private

const $fday

premier jour de calendrier

access: private

timestamp $ftime

début du calendrier

access: private

const $html_v

type de sortie

access: private

array $lng_day = array()

Traduction des jours

access: private

array $lng_month = array()

Traduction des mois

access: private

int $nbr_periode = 0

nombre de période

access: private

const $periode

période de calendrier

access: private

const $short_day

Longeur des jours

access: private

const $short_month

Longeur des mois

access: private

Methods

Constructor calendar

Créer une instance de la class calendar et initialise les variables par défaut

calendar calendar ()

get_calendar

retourne le calendrier analysé

return: calendrier à affficher

string get_calendar ([timestamp $timestamp = ''])

timestamp $timestamp: date ( optionel si set_debut à été utilisé )

is_bisextille

Renvoi true si c'est une année bisextille, sinon renvoi false

Renvoi true si c'est une année bisextille, sinon renvoi false. $time peux soit être une année soit être un timestamp. Si c'est uen année il faut mettre le paramètre $timestamp_or_year = false.

return: vrai si c'est bisextille

boolean is_bisextille (year $time, [boolean $timestamp_or_year = true])

year $time
boolean $timestamp_or_year: si true -> un timestamp, false -> une année à 4 chiffres

make_day

fabrique le code pour un jour

void make_day (timestamp $day, [boolean $select = false], [boolean $blank = false])

timestamp $day: timestamp du jour
boolean $select: true -> est mis en évidence
boolean $blank: true -> c'est un jour blanc

make_head_day

fabrique le code pour l'entête du/des jour

array make_head_day (timestamp $day, [boolean $a_week = true])

timestamp $day: timestamp du jour
boolean $a_week: true -> créer une semaine

make_month

fabrique le code pour un mois

return: le code d'un mois

string make_month (timestamp $month, [boolean $day_selet = true])

timestamp $month: timestamp du mois, avec le jour sélectionner.
boolean $day_selet: true -> met en évidence le jour sélectionner.

parse_calendar

analyse le calendrier

return: calendrier à afficher
access: private

string parse_calendar ([timestamp $timestamp = ''])

timestamp $timestamp: date ( optionel si set_debut à été utilisé )

print_calendar

affiche le calendrier après analyse

void print_calendar ([timestamp $timestamp = ''])

timestamp $timestamp: date ( optionel si set_debut à été utilisé )

reset

Remet toutes les variables sur leur valeurs par défaut.

void reset ()

set_debut

Permet de définir la date du début du calendrier

Permet de définir la date du début du calendrier On définit la date du début du calendrier, est optionel.

void set_debut (int $day, int $month, int $year)

int $day: jour du début
int $month: mois du début
int $year: année du début

set_evenement

Permet d'ajouter un événement au calendrier avec un lien

void set_evenement (timestamp $timestamp, string $nom, [string $description = ''], [string $description_long = ''], [string $lien = ''], [string $nom_lien = ''], [boolean $lien_out = true])

string $description: description courte de l'événement
string $description_long: description longue ( optionnel )
string $lien: lien vers l'événement ( optionnel )
string $nom_lien: texte qui sera affiché sur le lien ( optionnel )
string $nom: nom de l'événement
boolean $lien_out: true si on met target="_blank" ( optionnel )
timestamp $timestamp: date de l'évenement

set_first_day

Permet de définir le premier jour de la semaine

void set_first_day ([const $day = CALENDAR_DAY_MON])

const $day: jour de la semaine

set_format

Définit le format de sortie

void set_format ([const $format = CALENDAR_TYPE_HTML])

const $format: Cosntante de type

set_lang

Permet de définir une traduction de nom de jour ou de mois

void set_lang ([array $day = array()], [array $month = array()], [const $day_short = CALENDAR_SHORT_DAY], [const $month_short = CALENDAR_LONG_DAY])

array $day: Tableau conteant une traduction des jours de type array('dim', 'lun', 'mar',... )
array $month: Tableau conteant une traduction des mois de type array('janv', 'fev', ...)
const $day_short: taille des jours
const $month_short: taille des mois

set_periode

Permet de définir la période de temps qui sera affichée

void set_periode ([int $nbr_periode = 1], [const $periode = CALENDAR_PERIODE_MONTH])

int $nbr_periode: nombre de période à afficher
const $periode: type de période