BadPHP. Fiche explicative des Classes et des Fonctions de BadPHP. Equipe : Savelli Adrien Hugo Morales

Transcription

1 BadPHP Fiche explicative des Classes et des Fonctions de BadPHP Equipe : Savelli Adrien Hugo Morales

2 SOMMAIRE 1 Classe $sql connect(string (1), string (2), string (3), string (4)); request(variable, string); column(variable, string); Classe $session start(); destroy(); all(); Classe $cookie start(string (1), string (2), int); destroy(string); all(); Classe $php display_errors(bool); badhash(string); getip(); Classe $file name(string); extension(string); editword(string (1), string (2), string (3)); editline(string (1), int, string (2)); upload($_files, string); Classe $ajax refresh(string (1), string (2), int); refreshonclick(string (1), string (2), string (3)); Classe $human imc(int (1), int (2); Classe $web getsignal(string); Classe $server memory(); cpu(); Autres debug(variable) debugall()... 25

3 Classe $sql Cette classe va vous permettre de faciliter votre connexion à une base de données MySQL et également lancer une requête SQL en quelques lignes! Le taux de lignes en moins est de 50% grâce à BadPHP. De plus vous n avez pas à vous préoccuper de la sécurité des requêtes grâce à l utilisation des dernières normes PDO. connect(string (1), string (2), string (3), string (4)); Cette fonction de la classe $sql permet de se connecter à une base de données MySQL. - string (1): Adresse de l'hôte. ( , localhost...) - string (2): Nom d'utilisateur. (root, admin...) - string (3): Mot de passe. (badphp, killmvc...) - string (4): Nom de la base de données. (badphp_bdd, bdd1...) Comment appeler la fonction : Il n y a pas besoin de l appeler, elle est directement disponible dans le fichier config.php se situant le dossier config de BadPHP! Il y a juste à enlever le # et configurer les arguments de la fonction. Hop l ensemble de votre site est connecté à votre base de données! Elle retourne une connexion valide et sécurisée, à défaut une erreur s affichera. Astuce : Vous pouvez configurer plusieurs bases de données depuis votre fichier config.php! ADRIEN SAVELLI 1

4 request(variable, string); Cette fonction de la classe $sql permet d'effectuer une requête pour récupérer, ajouter, modifier ou supprimer des données d'une base de données MySQL. - variable: Celle qui récupère le résultat de la fonction connect. (Défaut : $pdo) - string: Votre requête MySQL Pré-requis : Vous devez d abord configurer une connexion MySQL, pour cela vous merci de vous référencer à la fonction connect de la classe sql ci-dessus. Elle retourne le résultat au format tableau pour une requête SELECT et un bool pour les requêtes UPDATE, DELETE, MERGE, INSERT Astuce : Pour bien exploiter le résultat format tableau d une requête SELECT, il est fortement conseillé de lire la variable contenant le résultat dans un debug(variable); ADRIEN SAVELLI 2

5 column(variable, string); Cette fonction de la classe $sql permet de recupérer les noms des colonnes d'une table MySQL. - variable: Celle qui récupère le résultat de la fonction connect. (Défaut : $pdo) - string: Le nom de votre table MySQL. Pré-requis : Vous devez d abord configurer une connexion MySQL, pour cela vous merci de vous référencer à la fonction connect de la classe sql ci-dessus. Elle retourne le résultat au format tableau, à défaut une erreur s affichera. Astuce : Pour bien exploiter le résultat format tableau de cette fonction, il est fortement conseillé de lire la variable contenant le résultat dans un debug(variable); ADRIEN SAVELLI 3

6 Classe $session Cette classe va vous permettre de faciliter la gestion de vos sessions. start(); Cette fonction de la classe $session permet d activer les sessions sur l ensemble de votre site. Aucun paramètre n est nécessaire. Comment appeler la fonction : Il n y a pas besoin de l appeler, elle est directement disponible dans le fichier config.php se situant le dossier config de BadPHP! Il y a juste à enlever le #. Hop l ensemble de votre site est opérationnel avec les sessions! $session->start(); Elle retourne un accès session valide et sécurisé, à défaut une erreur s affichera. ADRIEN SAVELLI 4

7 destroy(); Cette fonction de la classe $session permet de supprimer les données sessions de l utilisateur. Aucun paramètre n est nécessaire. Pré-requis : Vous devez d abord activer les sessions, pour cela vous merci de vous référencer à la fonction start de la classe session ci-dessus. $session->destroy(); Astuce : Très utile si vous avez un espace membre et qu un utilisateur souhaite se déconnecter. ADRIEN SAVELLI 5

8 all(); Cette fonction de la classe $session permet d'afficher toutes les sessions enregistrées. Aucun paramètre n est nécessaire. Pré-requis : Vous devez d abord activer les sessions, pour cela vous merci de vous référencer à la fonction start de la classe session ci-dessus. $session->all(); Elle retourne un tableau contenant l ensemble des données. ADRIEN SAVELLI 6

9 Classe $cookie Cette classe va vous permettre de faciliter votre gestion des cookies. start(string (1), string (2), int); Cette fonction de $cookie permet d'activer et de stocker des cookies. - string (1): Identifiant du cookie. (nom, prenom ) - string (2): Valeur du cookie. (Spears, britney) - int: définir la durée du cookie en nombre de jours. Comment appeler la fonction : Il n y a pas besoin de l appeler, elle est directement disponible dans le fichier config.php se situant le dossier config de BadPHP! Il y a juste à enlever le # et configurer les arguments de la fonction. Hop l ensemble de votre site peut profiter des cookies et peut stocker des informations. $cookie->start("nom", "Travolta", 2); ADRIEN SAVELLI 7

10 destroy(string); Cette fonction de la classe $cookie permet de supprimer un cookie. - string : Identifiant du cookie. Pré-requis : Vous devez d abord activer les cookies, pour cela vous merci de vous référencer à la fonction start de la classe cookie ci-dessus. $cookie->destroy("nom"); Astuce : Très utile si vous avez un espace membre et qu un utilisateur souhaite se déconnecter. ADRIEN SAVELLI 8

11 all(); Cette fonction de la classe $cookie permet d'afficher tous les cookies enregistrés. Aucun paramètre n est nécessaire. Pré-requis : Vous devez d abord activer les cookies, pour cela vous merci de vous référencer à la fonction start de la classe cookie ci-dessus. $cookie->all(); Elle retourne un tableau contenant l ensemble des données. ADRIEN SAVELLI 9

12 Classe $php Cette classe va vous permettre de faciliter votre gestion des cookies. display_errors(bool); Cette fonction de $php permet d'activer ou de désactiver les erreurs PHP. - bool: True active la fonction, False désactive la fonction. Comment appeler la fonction : Il n y a pas besoin de l appeler, elle est directement disponible dans le fichier config.php se situant le dossier config de BadPHP! Il y a juste à enlever le # et configurer l argument de la fonction. Hop l ensemble de votre site peut afficher ou non les erreurs PHP. $php->display_errors(false); ADRIEN SAVELLI 10

13 badhash(string); Cette fonction de $php permet de Hash une string. - string: Texte qui va se faire Hash. (boeuf, motdepasse) $php->badhash("mot_de_passe"); Elle retourne un string qui a été Hash. Astuce : Très utile si vous avez un espace membre et qu il faut sécuriser un mot de passe sur votre base de données. Vous pouvez directement modifier la fonction dans le fichier php.php se situant dans le dossier libs de BadPHP afin de modifier l ordre de Hash, cela permettra d augmenter la sécurité de vos données en évitant d utiliser la configuration par défaut. ADRIEN SAVELLI 11

14 getip(); Cette fonction de $php permet de retourner l'ip du visiteur. Aucun paramètre n est nécessaire. $php->getip(); Elle retourne un string contenant l IP du visiteur. Astuce : Utile si vous devez fourni des logs de l activité de votre site web. ADRIEN SAVELLI 12

15 Classe $file Cette classe va vous permettre de faciliter votre gestion des fichiers. name(string); Cette fonction de $file permet de récupérer le nom d'un fichier. - string: chemin ou lien vers le fichier. Fonctionne avec les fichiers internes et externes. $file->name(" Elle retourne un string contenant le nom du fichier, avec l exemple ci-dessus la fonction retournera "test". ADRIEN SAVELLI 13

16 extension(string); Cette fonction de $file permet de récupérer l'extension d'un fichier. - string: chemin ou lien vers le fichier. Fonctionne avec les fichiers internes et externes. $file->extension(" Elle retourne un string contenant l extension du fichier, avec l exemple ci-dessus la fonction retournera "php". ADRIEN SAVELLI 14

17 editword(string (1), string (2), string (3)); Cette fonction de la classe $file permet de modifier tous les mots d'un fichier par un nouveau. - string (1): Chemin vers le fichier. - string (2): Mot à remplacer. - string (3): Nouveau mot. $file->editword("fichier.txt", "ancien_mot", "nouveau_mot"); ADRIEN SAVELLI 15

18 editline(string (1), int, string (2)); Cette fonction de la classe $file permet de modifier une ligne et d ajouter un nouveau texte à celle-ci. - string (1): Chemin vers le fichier. - int: Numéro de la ligne. - string (2): Nouveau contenu de la ligne. $file->editline("fichier.txt", 666, "La ligne de vador"); ADRIEN SAVELLI 16

19 upload($_files, string); Cette fonction de la classe $file permet de modifier une ligne et d ajouter un nouveau texte à celle-ci. - $_FILES: Superglobal $_FILES ayant pour nom le name de votre input contenant le fichier. - string: Chemin vers le dossier où le fichier sera upload. $file->upload($_files["inputupload"],"./upload/"); Astuce : Utile si vous devez upload l avatar d un utilisateur ou simplement des fichiers. Attention à bien limiter la taille de certains fichiers. Attention, il faut également penser à bloquer certaines extensions pour éviter une «File Upload Vulnerabilities». ADRIEN SAVELLI 17

20 Classe $ajax Cette classe va vous permettre d afficher vos pages en temps réel et d afficher les éventuels changements sans avoir besoin de recharger celle-ci. refresh(string (1), string (2), int); Cette fonction de la classe $ajax permet de rafraîchir PHP sans recharger la page au bout d'un temps donné. - string (1): Chemin ou lien vers le fichier. Fonctionne avec les fichiers internes et externes. - string (2): id de la balise qui affichera le résultat. - int: Temps en milliseconde avant rafraîchissement du contenu de la balise. $ajax->refresh("page.php", "id_div", 2000); Elle retourne le contenu du fichier dans la balise. Astuce : Il est conseillé de faire en sorte que le design du fichier soit le plus proche du design de la page. Cela permettra à l utilisateur de se rendre compte de rien. ADRIEN SAVELLI 18

21 refreshonclick(string (1), string (2), string (3)); Cette fonction de la classe $ajax permet de rafraîchir PHP sans recharger la page en cliquant sur un bouton. - string (1): Chemin ou lien vers le fichier. Fonctionne avec les fichiers internes et externes. - string (2): id de la balise qui affichera le résultat. - string (3): id du bouton où il faudra cliquer pour rafraîchir le résultat. $ajax->refreshonclick("page.php", "id_div", "id_bouton"); Elle retourne le contenu du fichier dans la balise après un clique sur le bouton. Astuce : Il est conseillé de faire en sorte que le design du fichier soit le plus proche du design de la page. Cela permettra à l utilisateur de se rendre compte de rien. ADRIEN SAVELLI 19

22 Classe $human Cette classe va vous permettre de mieux connaitre votre corps. 7.1 imc(int (1), int (2);... 4 imc(int (1), int (2)); Cette fonction de la classe $human permet d avoir certaines informations sur votre corps. - int (1): La taille en centimètre. (cm) - int (2): Le poids en kilogramme. (kg) $human->imc(180, 65); Elle retourne un entier (int) contenant votre indice d IMC permettant de déterminer la corpulence d une personne. ADRIEN SAVELLI 20

23 Classe $web Cette classe va vous permettre de communiquer sur internet grâce à certaines fonctions. getsignal(string); Cette fonction de $web permet de déterminer si une page est accessible ou non. - string: Le lien où vous souhaitez avoir un signal. $web->getsignal(" Elle retourne un string contenant la réponse du site web en question. "HTTP/ OK" pour l exemple ci-dessus. ADRIEN SAVELLI 21

24 Classe $server Cette classe va vous permettre de connaitre la consommation de la machine qui héberge votre site web. memory(); Cette fonction de $server permet de déterminer la mémoire RAM utilisée par votre serveur. Aucun paramètre n est nécessaire. $server->memory(); Elle retourne un tableau contenant la mémoire disponible en Go et en pourcentage. Elle retourne également le nombre de Go sur votre hébergement. ADRIEN SAVELLI 22

25 cpu(); Cette fonction de $server permet de déterminer la puissance du processeur utilisée par votre serveur. Aucun paramètre n est nécessaire. $server->cpu(); Elle retourne un tableau contenant le nom de votre processeur mais également l utilisation en pourcentage de celui-ci par le serveur. ADRIEN SAVELLI 23

26 Autres Les fonctions ci-dessous sont inclassables. debug(variable) debugall()... 4 debug(variable); Cette fonction sans classe permet d afficher de façon lisible une variable afin de jongler plus facilement avec son contenu. - variable: La variable de votre choix. (String, Tableau, Int ) debug($array); Affichage directement le contenu de la variable. Astuce : Cette fonctionnalité prend tout son sens lorsqu il faut afficher les résultats d une requête SQL ou alors un tableau ayant un certain nombre de données. ADRIEN SAVELLI 24

27 debugall(); Cette fonction sans classe permet d afficher de façon lisible l ensemble des informations disponibles sur une page. (POST, GET, SESSION, FILES & COOKIE) Aucun paramètre n est nécessaire. debugall(); Affichage directement un tableau avec l ensemble des informations. Astuce : Cette fonctionnalité est très importante si vous souhaitez afficher facilement vos superglobals. ADRIEN SAVELLI 25