bas

version du village concernée: vbeta

L'ensembles de ces classes et fonctions sont experimentales. Il faut donc les utiliser avec prudence, et avant de propser un code verifiez bien ce que vous faites.
____________________________________________________________


Statistiques par R Daneel

avancement de la partie objet (finie hors evolutions futures)
avancement de la partie fonctions
avancement de la partie base de donnee (finie hors evolutions futures)

____________________________________________________________


1 bibliotheque des objets

1.1 action (entre personnages)
1.1.1 appel classe
1.1.2 Fonctions de cette classe

1.2 création/ manipulation d'objet
1.2.1 appel classe
1.2.2 Fonctions de cette classe

1.3 action du lieux (action_db)
1.3.1 appel classe
1.3.2 Fonctions de cette classe

1.4 emplacement (deplacement et contenu de la page action)
1.4.1 appel classe
1.4.2 Fonctions de cette classe

1.5 maj (mise à jour)
1.5.1 appel classe
1.5.2 Fonctions de cette classe

1.6 objet (privé)
1.6.1 appel classe
1.6.2 Fonctions de cette classe

1.7 objet_lieu (public)
1.7.1 appel classe
1.7.2 Fonctions de cette classe

1.8 rapport
1.8.1 appel classe
1.8.2 Fonctions de cette classe

1.9 evenement
1.9.1 appel classe
1.9.2 Fonctions de cette classe


2 bibliotheque des fonctions

3 bibliotheque des tables de la base de donnée

3.1 action
3.2 connecte
3.3 credit_temps
3.4 evenement
3.5 maj
3.6 objet_index
3.7 objet_lieu
3.8 objet_perso
3.9 rapport
3.10 zone

____________________________________________________________


1 bibliotheque des objets

1.1 action

nom du fichier: action.php

description: cette classe sert à gèrer les actions entre les personnages.
exemple: parler à quelqu'un

1.1.1 appel classe

appel: action(int source, int but, int zone)

paramètres:
int
source: identifiant de personnage source de l'action (souvent celui qui effectue l'action)
int
but: identifiant de personnage but de l'action (souvent celui qui subit l'action)
int
zone: identifiant de la zone d'action (souvent la zone ou est celui qui effectue l'action)

Valeurs retournées:
retourne TRUE si les deux personnages sont dans la même zone et que cette zone existe, ou FALSE sinon.

1.1.2 Fonctions de cette classe

1.1.2.1 get_action_list

description:
cette fonction sert a obtenir la liste des actions possibles entre les
deux personnages considérés.

appel: get_action_list()

paramètres: aucun

Valeurs retournées:
retourne la liste des actions possibles entre les deux personnages sous forme d'une chaine contenant du texte html et les formulaires, une chaine vide si il n'y a pas d'action possible entre les personnages.


1.2 creation

nom du fichier: action.php

description: cette classe sert à gèrer les creations d'objets.
exemple: creer du bois

1.2.1 appel

appel: creation(int lieu, array ligne)

paramètres:
int
lieu: identifiant de la zone d'action (souvent la zone ou est celui qui effectue l'action)
array
ligne: ressource ligne du tableau des membres, contenant les données sur le membre accomplissant l'action

Valeurs retournées:
retourne TRUE si le membre est bien dans une zone du village, FALSE sinon.

1.2.2 Fonctions de cette classe

1.2.2.1 get_list

description:
cette fonction sert a obtenir la liste des creations/manipulation d'objet possibles dans la zone considérée.

appel: get_list()

paramètres: aucun

Valeurs retournées:
retourne la liste des creations/manipulation d'objet sous forme d'une chaine contenant du texte html et les formulaires, une chaine vide si il n'y a pas de création/manipulation d'objet possible.

1.2.2.2 action

description:
réalise l'action de création/manipulation de l'objet courant, et renseigne dans le rapport personnel l'action accomplie.

appel: action()

paramètres: aucun

Valeurs retournées:
retourne une chaine de la forme:
a.'Vous avez cree/manipule l'objet: nom de l'objet' si tout c'est passé corectement
b.'action de creation/manipulation d'objet non effectuee' si l'action de création n'a pu être réalisée
c.'prerequis non respecte.' si le prerequis pour realiser cette creation/manipulation d'objet n'est pas respecté.
d.'table non trouvee.' si la table d'objet n'a pas été trouvée
e. unechaine vide sinon





1.3 action_db

nom du fichier: action.php

description: cette classe sert à gèrer actions de lieu.
exemple: prendre du bois.

1.3.1 appel

appel: action_db(int lieu, array ligne)

paramètres:
int
lieu: identifiant de la zone d'action (souvent la zone ou est celui qui effectue l'action)
array
ligne: ressource ligne du tableau des membres, contenant les données sur le membre accomplissant l'action

Valeurs retournées:
retourne TRUE si le membre est bien dans une zone du village, FALSE sinon.

1.3.2 Fonctions de cette classe

1.3.2.1 get_list

description:
cette fonction sert a obtenir la liste des actions du lieu possibles dans la zone considérée.

appel: get_list()

paramètres: aucun

Valeurs retournées:
retourne la liste des action possibles dans le lieu sous forme d'une chaine contenant du texte html et les formulaires, une chaine vide si il n'y a pas d'action possible.

1.3.2.2 action

description:
réalise l'action du lieu courant, et renseigne dans le rapport personnel l'action accomplie.

appel: action()

paramètres: aucun

Valeurs retournées:
retourne une chaine de la forme:
a.'Vous avez realise l'action: nom de l'action' si tout c'est passé corectement
b.'action non effectuee' si l'action n'a pu être réalisée
c.'prerequis non respecte.' si le prerequis pour realiser cette action n'est pas respecté.
d.'table non trouvee.' si la table d'action n'a pas été trouvée
e. une chaine vide sinon




1.4 emplacement

nom du fichier: deplacement.php

description: cette classe sert à gèrer les deplacements et à presenter l'interface generale de la partie action.
exemple: parler à quelqu'un

1.4.1 appel classe

appel: emplacement(array ligne)

paramètres:
array
ligne: ligne du tableau des membre conceranant un membre en particulier

Valeurs retournées:
retourne TRUE si le personnage est bien dans le village, ou FALSE sinon.
A noter que si le personnage n'a jamais mis les pieds dans le village, il est placé dans celui-ci, dans la rue, et si l'opération réussit l'objet retournera naturellement TRUE.

1.4.2 Fonctions de cette classe

1.4.2.1 get_content

description:
cette fonction accomplit les actions suivantes:
-?? (fonction realiser())
-concatène des personnages et des actions possibles sur ceux-ci.
-concatène les manipulation-creation d'objet
-concatène les actions spécifiques au lieu
-concatène l'inventaire des objets présents

appel: get_action_list()

paramètres: aucun

Valeurs retournées:
retourne le contenu de l'emplacement sous forme d'une chaine contenant du texte html et les formulaires, une chaine vide si aucune des choses citées précédemment n'est possible.


1.5 maj (mise à jour)

nom du fichier: maj.php

description: cette classe sert à gèrer les mise à jour que ce soit pour le jeu ou pour le site. Le principe veut que ce soit un membre qui la fasse se déclencher en passant sur le site.
exemples: un calcul a effectuer pour une population, l'effacement du rapport tous les trois jours...

1.5.1 appel classe

appel: maj(array ligne)

paramètres:
array
ligne: ligne du tableau des membre conceranant un membre en particulier

Valeurs retournées:
Retourne TRUE si le server est capable d'afffeceter une variable, FALSE sinon (auquel cas il faut s'inquieter)

1.5.2 Fonctions de cette classe

1.5.2.1 do_action

description:
cette fonction accomplit les actions suivantes:
pour chaque mise a jour de la base de donnee,
-interprete la commande de mise a jour
-ajoute dans les evenements un message de mise a jour

appel: do_action()

paramètres: aucun

Valeurs retournées:
retourne FALSE si la requette mysql sur la table de mise a jour s'est bien passée.
ne retourne rien sinon.


1.6 objet (personnel)

nom du fichier: objet.php

description: cette classe sert à afficher les objets personnels (page objets) ainsi que des informations sur ceux-ci)

1.6.1 appel classe

appel: objet(array ligne)

paramètres:
array
ligne: ligne du tableau des membre conceranant un membre en particulier

Valeurs retournées:
toujours TRUE

1.6.2 Fonctions de cette classe

1.6.2.1 get_list

description:
cette fonction permet l'affichage des informations sur les objets possédés.

appel: get_list()

paramètres: aucun

Valeurs retournées:
Retourne une chaine sous forme html contenant les objets et les informations qui s'y rapportent mis en forme.
Retourne une chaine vide si le personnage ne possède aucun objet.



1.7 objet_lieu (public)

nom du fichier: objet.php

description: cette classe sert à afficher les objets du lieu (page action) ainsi que des informations sur ceux-ci.

1.7.1 appel classe

appel: objet(array ligne)

paramètres:
array
ligne: ligne du tableau des membre conceranant un membre en particulier

Valeurs retournées:
toujours TRUE

1.7.2 Fonctions de cette classe

1.7.2.1 get_list

description:
cette fonction permet l'affichage des informations sur les objets présents dans un lieu.

appel: get_list()

paramètres: aucun

Valeurs retournées:
Retourne une chaine sous forme html contenant les objets et les informations qui s'y rapportent mis en forme.
Retourne une chaine vide si le le lieu ne contient aucun objet.


1.8 rapport (public)

nom du fichier: rapport.php

description: cette classe sert à gerer les evenements privés.

1.8.1 appel classe

appel: rapport(int membre)

paramètres:
int
membre: identifiant de membre

Valeurs retournées:
retourne TRUE si le membre est dans le village, retourne FALSE sinon

1.8.2 Fonctions de cette classe

1.8.2.1 add_event

description:
cette fonction permet l'ajout d'un evenement dans le rapport personnel du personnage courant.

appel: add_event(str titre,str img,str contenu,bool viewed <, bool html_secured> )

paramètres:
str
titre: titre du message à ajouter dans le rapport privé
str
img: url de l'image a ajouter dans le rapport privé
str
str: message a ajouter dans le rapport privé
bool
viewed: booleen censé attester du fait que le message a été vu (fonctionnalité non developpée actuellement)
bool
html_secured: option qui spécifie si le message accepte le html (FALSE) ou pas (TRUE). Vaut par défaut TRUE

Valeurs retournées:
Retourne TRUE si le message a bien été enregistré dans la table, false sinon

1.8.2.2 get_event_box

description:
cette fonction permet l'affichage du rapport privé.

appel: get_event_box

paramètres:aucun

Valeurs retournées:
Retourne une chaine sous forme html du rapport privé (visualisable dans la page rapport)

1.9 evenement (public)

nom du fichier: rapport.php

description: cette classe sert à gerer les evenements publics.

1.9.1 appel classe

appel: evenement(int membre)

paramètres:
int
membre: identifiant de membre

Valeurs retournées:
retourne TRUE si le membre est dans le village, retourne FALSE sinon

1.9.2 Fonctions de cette classe

1.9.2.1 add_event

description:
cette fonction permet l'ajout d'un evenement dans le rapport des evenements.

appel: add_event(str titre,str img,str contenu,bool viewed <, bool html_secured> )

paramètres:
str
titre: titre du message à ajouter dans le rapport des evenements
str
img: url de l'image a ajouter dans le rapport des evenements
str
str: message a ajouter dans le rapport des evenements
bool
viewed: booleen censé attester du fait que le message a été vu (fonctionnalité non developpée actuellement)
bool
html_secured: option qui spécifie si le message accepte le html (FALSE) ou pas (TRUE). Vaut par défaut TRUE

Valeurs retournées:
Retourne TRUE si le message a bien été enregistré dans la table, false sinon

1.9.2.2 get_event_box

description:
cette fonction permet l'affichage du rapport des evenements.

appel: get_event_box

paramètres:aucun

Valeurs retournées:
Retourne une chaine sous forme html du rapport des evenemlents (visualisable dans la page evenements)




2 bibliotheque des fonctions

Une reference des fonctions au format xml est consultable.
____________________________

/!\

Votre navigateur doit tolerer en particulier les pseudos classes before et after de CSS pour pouvoir la consulter dans de bonnes conditions (comme firefox).
Si le mot qui suit s'encadre de paranthèses au passage de votre souris sur celui-ci sous le skin default, c'est le cas:
texte de test
____________________________

aller à la reference des fonctions


3 bibliotheque des tables de la base de donnée

3.1 action

nom de la table: m_a_action

commentaire:
table contenant les actions liées à un lieu.

requette de creation:

CREATE TABLE m_a_action
(id INT not null AUTO_INCREMENT, name VARCHAR (255) not null, description BLOB not null, img VARCHAR (255) not null,id_lieu INT not null, prerequis BLOB not null,form BLOB not null,action BLOB not null, PRIMARY KEY (id))

liste des colonnes:

int
id : identifiant d'action

varchar
name : nom de l'action

BLOB
description : texte de description de l'action

varchar
img : url de l'image de l'action

int
id_lieu : identifiant du lieu ou on accomplit l'action (a l'avenir une table spéciale action/lieu sera creer pour permettre de faire une même action dans des lieux différents)

BLOB
prerequis : code php prerequis pour effectuer l'action

BLOB
form : formulaire donné pour effectuer l'action

BLOB
action : code php de l'action

3.2 connecte

nom de la table: m_a_connecte

commentaire:
cette table permet de savoir la derniere fois ou un membre s'est connecté sur le site. (elle est ici car peut-être pourrait-elle etre utilisée en jeu)

requette de creation:

CREATE TABLE m_a_connecte
(id INT not null AUTO_INCREMENT,idperso INT not null, date INT, PRIMARY KEY (id))

liste des colonnes:

int
id : identifiant de ligne

int
idperso : identifiant de personnage

int
date : derniere date de passage

3.3 credit_temps

nom de la table: m_a_credit_temps

commentaire:
cette table stocke le credit-temps alloué a un personnage.

requette de creation:

CREATE TABLE m_a_credit_temps
(id INT not null AUTO_INCREMENT,id_perso INT not null,credit_temps FLOAT,date INT, PRIMARY KEY (id))

liste des colonnes:

int
id : identifiant de ligne

int
idperso : identifiant de personnage

FLOAT
credit_temps : temps en heure en base 10 (1.5 h dans la base correspond à 1 h 30 min )

int
date : date de creation de la ligne (en secondes du temps unix)

3.4 evenement

nom de la table: m_a_evenement

commentaire:
cette table stocke les evenements ayant eu lieu dans le village.

requette de creation:

CREATE TABLE m_a_evenement
(id_evenement INT not null AUTO_INCREMENT, id_perso INT, name VARCHAR (255) not null, img VARCHAR (255) not null, event BLOB not null,viewed INT, date INT, PRIMARY KEY (id_evenement))

liste des colonnes:

int
id_evenement : identifiant de ligne

int
id_perso : identifiant de personnage

varchar
name : titre de l'evenement

varchar
img : image liée a l'evenement

blob
event : texte de l'evenement.

int
viewed : booleen en pratique (vu ou pas) mais pas utilisé dans la version courante

int
date : date de creation de la ligne (en secondes du temps unix)



3.5 maj

nom de la table: m_a_maj

commentaire:
cette table stocke les différentes actions de mise a jour et les données les concernant.

requette de creation:

CREATE TABLE m_a_maj
(id INT not null AUTO_INCREMENT, name VARCHAR (255) not null, action BLOB not null, img VARCHAR (255) not null,pas INT not null, last_date INT, PRIMARY KEY (id))

liste des colonnes:

int
id : identifiant de ligne

varchar
name : titre de l'action de mise a jour

blob
action : script a executer a la mise a jours de cette action.

varchar
img : image liée a l'evenement

int
pas : temps en secondes entre deux mises à jour

int
last_date : date en temps unix en secondes de la dernieres mise ajours



3.6 objet_index

nom de la table: m_a_objet_index

commentaire:
Index contenant les objets, les informations s'y rapportant et le code php de leur création.

requette de creation:

CREATE TABLE m_a_objet_index
(id INT not null AUTO_INCREMENT, name VARCHAR (255) not null, description BLOB not null, img VARCHAR (255) not null,id_lieu INT not null, prerequis BLOB not null,form BLOB not null,action BLOB not null, PRIMARY KEY (id))

liste des colonnes:

int
id : identifiant de ligne

varchar
name : nom de l'objet

blob
description : description de l'objet.

varchar
img : url de l'image de l'objet

int
id_lieu : identifiant du lieu ou l'on peut creer cet objet (pour l'instant un seul possible mais dans la prochaine version une table objet/lieu sera crée)

blob
prerequis : code php du prerequis a la creation de l'objet.

blob
form : formulaire de creation de l'objet.

blob
action : code php de création de l'objet.



3.7 objet_lieu

nom de la table: m_a_objet_lieu

commentaire:
Table contenant l'inventaire de chaque lieu (a un lieu associe les objets presents dans celui-ci).

requette de creation:

CREATE TABLE m_a_objet_lieu
(id INT not null AUTO_INCREMENT,id_lieu INT not null,id_objet INT not null,num INT not null ,date INT, PRIMARY KEY (id))

liste des colonnes:

int
id : identifiant de ligne

int
id_lieu : identifiant du lieu ou est l'objet de cette ligne

int
id_objet : identifiant de l'objet qui est dans le lieu de cette ligne

int
num : nombre d'objets ayant l'id_objet de cete ligne dans le lieu id_lieu de cette ligne

int
date : date de creation? de la ligne en temps unix, en secondes




3.8 objet_perso

nom de la table: m_a_objet_perso


commentaire:
Table contenant l'inventaire privé (a chaque personnage, il associe un objet).

requette de creation:

CREATE TABLE m_a_objet_perso
(id INT not null AUTO_INCREMENT,id_perso INT not null,id_objet INT not null,num INT not null ,date INT, PRIMARY KEY (id))

liste des colonnes:

int
id : identifiant de ligne

int
id_perso : identifiant du personnage possedant l'objet de cette ligne

int
id_objet : identifiant de l'objet qui est possédé par le personnage id_perso

int
num : nombre d'objets ayant l'id_objet de cete ligne possédé par le personnage de cette ligne

int
date : date de creation? de la ligne en temps unix, en secondes





3.9 rapport

nom de la table: m_a_rapport

commentaire:
cette table stocke les evenements subis par chaque personnage.

requette de creation:

CREATE TABLE m_a_rapport
(id_event INT not null AUTO_INCREMENT, id_perso INT, name VARCHAR (255) not null, img VARCHAR (255) not null, event BLOB not null,viewed INT, date INT, PRIMARY KEY (id_event))

liste des colonnes:

int
id_event : identifiant de ligne

int
id_perso : identifiant de personnage

varchar
name : titre de l'evenement

varchar
img : image liée a l'evenement

blob
event : texte de l'evenement.

int
viewed : booleen en pratique (vu ou pas) mais pas utilisé dans la version courante

int
date : date de creation de la ligne (en secondes du temps unix)


3.10 zone

nom de la table: m_a_zone

commentaire:
cette table stocke la zone ou est chaque personnage.

requette de creation:

CREATE TABLE m_a_zone
(id_perso INT, id_zone INT, date INT )

liste des colonnes:

int
id_perso : identifiant de personnage

int
id_perso : identifiant de zone

int
date : date de creation de la ligne (en secondes du temps unix)





haut