Documentation
Documentation de DWF

admin_controle

admin_controle est une classe permettant de créer une interface d'administration "user-friendly",
Cette classe est destinée à être utilisée dans une partie "administration" du site.
Cette classe affiche l'administration d'une table de la base de données,
elle a besoin de l'entité de cette table pour fonctionner et sait gérer les relations entre les tables.

Si l'entité contient un champ "array", ce champ n’apparaitra pas dans les datatables.
Dans les formulaires, les données de ce champ seront accessible en JSON dans un input de type hidden.
Vous devrez créer une interface en JavaScript pour administrer ce champ à votre convenance (en manipulant la chaine JSON).

Cette classe fait office de contrôleur et layout pour l'application,
elle fait la liaison entre les routes et les pages (cf configuration et pages)
et met à disposition quelques outils :

• Instancie la connexion à la base de données par un objet bdd accessible via application::$_bdd (cf bdd)
• Permet d'utiliser des méthodes évènementielles à partir de application::event() (cf : méthodes évènementielles)

Cette classe permet de générer un lecteur audio.

Crédits : InYourDreams (Newgrounds)

Auth est la classe qui gère l'authentification des utilisateurs,
il prend en paramètres : le nom de la table/entité utilisateur ( dans cette documentation : 'user'), le nom du champ de login ('login'), le nom du champ de mot de passe ('psw').
auth utilise deux variables de sessions accessibles via la classe "session"
(session::set_auth(),session::get_auth(),session::set_user() et session::get_user())
lorsque l'utilisateur est authentifié, session::get_auth() retourne true et session::get_user() contient l'identifiant de l'utilisateur (id de la base de données)
sinon session::get_auth() et session::get_user() retourne false et auth affiche un formulaire d'authentification.

Cette classe permet de gèrer les thèmes de bootswatch,
le thème par défaut peut être défini dans config.class.php

Cette classe permet de gérer une mise en cache ( côté serveur )
utilise session::set_val("cache",[ ]) et session::get_val("cache")

Cette classe génére un captcha,
Utilise la classe espeak pour l'accessibilité,
requiert donc espeak installé sur le serveur.
cette classe peut être appellée depuis form->captcha()

Lire le captcha 

Captcha

Cette classe permet de gérer un paquet de 32, 52, 54 ou 78 cartes

Contenu d'un paquet de 52 cartes :

10♣ 10♦ 10♥ 10♠ 2♣ 2♦ 2♥ 2♠ 3♣ 3♦ 3♥ 3♠ 4♣ 4♦ 4♥ 4♠ 5♣ 5♦ 5♥ 5♠ 6♣ 6♦ 6♥ 6♠ 7♣ 7♦ 7♥ 7♠ 8♣ 8♦ 8♥ 8♠ 9♣ 9♦ 9♥ 9♠ A♣ A♦ A♥ A♠ J♣ J♦ J♥ J♠ K♣ K♦ K♥ K♠ Q♣ Q♦ Q♥ Q♠

Contenu d'un paquet de 78 cartes :

1☆ 10♣ 10♦ 10♥ 10♠ 10☆ 11☆ 12☆ 13☆ 14☆ 15☆ 16☆ 17☆ 18☆ 19☆ 2♣ 2♦ 2♥ 2♠ 2☆ 20☆ 21☆ 3♣ 3♦ 3♥ 3♠ 3☆ 4♣ 4♦ 4♥ 4♠ 4☆ 5♣ 5♦ 5♥ 5♠ 5☆ 6♣ 6♦ 6♥ 6♠ 6☆ 7♣ 7♦ 7♥ 7♠ 7☆ 8♣ 8♦ 8♥ 8♠ 8☆ 9♣ 9♦ 9♥ 9♠ 9☆ A♣ A♦ A♥ A♠ C♣ C♦ C♥ C♠ Excuse J♣ J♦ J♥ J♠ K♣ K♦ K♥ K♠ Q♣ Q♦ Q♥ Q♠

Cette classe permet de recharger automatiquement la page courante lorsqu'une classe metier est modifiée dans le dossier /class/ de votre projet
(Cette classe est déconsillée en production)

Cette classe permet d'appliquer une politique de mot de passe

Démonstration du message d'erreur (avec au moins un caractère special obligatoire)

Il est possible de modifier les messages avant d'appeler print_errormsg() :

Cette classe affiche une citation célèbre à chaque chargement de page.
Les citations se trouvent dans dwf/class/citations/citations.json
Vos contributions sont les bienvenues.

Cette classe est exploitée par la classe form (cf. form)

Deprecié depuis la verssion 21.24.10, usilisez plutot TinyMCE

Cette classe est utile pour les CLI (cf. CLI)

Compresse des scripts CSS en deux fichiers minifié

La méthode "render()" est utilisée automatiquement dans html5.class.php, il n'est pas utile de l'appeler

Cette classe permet d'afficher un message d'informations sur l'utilisation de cookies ou autre technologies similaires.
Cette ligne est à placer dans pages->header()

Cette classe permet de génerer des feuilles de style personalisées.
A utiliser avec "compact_src::get_instance()->add_style()"

La feuille de style retournée sera optimisée et minifiée,
dans l'exemple nous voyons que "p" et "div" ont la même règle de padding, elles seront donc fusionnées.
Voici le resultat :

div{margin:0 auto}#mon_id{background-color:#add8e6}p,div{padding:5px}

Il est préférable d'appeler cette classe via (new graphique())->cytoscape() (cf. graphique) Cette classe affiche un graphe d'analyse et de visualisation (utilise la librairie jquery cytoscape)
(Requiert une règle CSS sur l'ID CSS)

Cette classe permet de convertir un tableau HTML en datatable (jquery)
il est préférable de l'appeler via js::datatable() (cf js)

La classe ddg permet d'exploiter le moteur de recherche DuckDuckGO

Résultat :

ddg_api Object
(
    [_Abstract:ddg_api:private] => 
    [_AbstractText:ddg_api:private] => 
    [_AbstractSource:ddg_api:private] => 
    [_AbstractURL:ddg_api:private] => 
    [_Image:ddg_api:private] => 
    [_ImageWidth:ddg_api:private] => 
    [_Entity:ddg_api:private] => 
    [_meta:ddg_api:private] => 
    [_Heading:ddg_api:private] => 
    [_Answer:ddg_api:private] => 
    [_Redirect:ddg_api:private] => 
    [_AnswerType:ddg_api:private] => 
    [_Definition:ddg_api:private] => 
    [_DefinitionSource:ddg_api:private] => 
    [_DefinitionURL:ddg_api:private] => 
    [_RelatedTopics:ddg_api:private] => 
    [_Results:ddg_api:private] => 
    [_Type:ddg_api:private] => 
    [_Infobox:ddg_api:private] => 
    [_ImageIsLogo:ddg_api:private] => 
    [_ImageHeight:ddg_api:private] => 
)

Cette classe est une boîte à outils de débogage

Cette classe permet de convertir et gérer une liste lourde comme étant un dictionnaire

Cette classe permet de générer des fichiers :

• DLC (Download Link Container, recommandé)
• CCF (CryptLoad Container File)
• RSDF (RapidShare Download File)

Servant de librairie de téléchargement pour des logiciels comme JDownloader

Cette classe permet à l'utilisateur de télécharger un fichier spécifique sur le serveur

Cette classe gère les exceptions du framework
les codes d'erreurs des exceptions natives du framework sont compris entre 600 et 699 :

• les codes d'erreurs 60X concernent la base de données
• les codes d'erreurs 61X concernent les routes et méthodes
• les codes d'erreurs 62X concernent les services
• les codes d'erreurs 63X concernent le système

Il est cependant possible pour vous de créer des exceptions personnalisées avec dwf_exeption :

Les exceptions sont toujours retranscrites dans un log : dwf/log/log_[votre_projet]_[date_format_us].txt

Exemple de dwf_exception::warning_exception() :

#0 /var/www/html/doc/class/docPHP_natives.class.php(294): dwf_exception::warning_exception('700', Array)
#1 /var/www/html/doc/class/docPHP_natives.class.php(21): docPHP_natives->dwf_exception()
#2 /var/www/html/doc/class/docPHP.class.php(427): docPHP_natives->__construct()
#3 /var/www/html/doc/class/docPHP.class.php(38): docPHP->classes_natives()
#4 /var/www/html/doc/class/pages.class.php(91): docPHP->__construct()
#5 /var/www/dwf/class/application.class.php(126): pages->web()
#6 /var/www/dwf/class/application.class.php(44): application->contenu()
#7 /var/www/dwf/index.php(20): application->__construct()
#8 /var/www/html/doc/index.php(18): index->__construct()
#9 /var/www/html/doc/index.php(40): website->__construct()
#10 {main}

Cette classe permet d'afficher des "oeufs de Pâques" qui s'affichent à certaines dates de l'année.
Liste des dates :

• 31/12 et 01/01 : Jour de l'an, affiche une guirlande interactive (les ampoules éclatent au survol de la souris)
• 06/01 : Epiphanie, affiche une couronne des rois en pied de page
• 14/02 : Saint Valentin, une pluie de coeurs sur le site
• 21/03 : Printemps, des pétales de cerisiers tombent sur le site
• 01/04 : Poisson d'Avril ! un poisson animé traverse l'écran
• 01/05 : Fête du travail, une couronne de muguet en pied de page
• Entre le 25/05 et 31/05 : Fête des mères (dernier dimanche de mai), un collier de nouilles "bonne fête maman" en pied de page
• 21/06 : Été, la lueur chaude du soleil apparait en pied de page
• Entre le 16/05 et 22/06 : Fête des pères (troisième dimanche de mai) un modal avec le diplôme du père de l'année apparait (qu'une fois par session)
• 14/07 : Fête Nationale française, des feux d'artifices sont tirés sur le site
• 23/09 : Automne, des feuilles mortes tombent sur le site
• 25/11 : Sainte-Catherine, un chapeau de Sainte-Catherine en pied de page
• Du 22/12 aux 25/15 : Hiver et Noël, des flocons de neiges tombent sur le site

Astuce : une interface pour activer les eastereggs peut être affichée en tapant le "Konami code" : ↑ ↑ ↓ ↓ ← → ← → B A

Pour activer les eastereggs sur toutes les pages, placez cette ligne dans pages->header()

(cf Entity)

Cette classe permet d'afficher des pseudos MCD à partir de vos entités

Résultats :

Cette classe convertit un texte en flux audio.
/!\ Nécessite que espeak soit installé sur le serveur.
http://espeak.sourceforge.net/

Résultats :

Cette classe permet de créer des événements (listener et emiter)
l'utilisation de cette classe différe des "méthodes événementielles" dans la mesure où ces dernières font appel à des methodes "statiques" d'autres classes.

Cette classe permet de générer une archive ZIP contenant les fichiers nécessaires à un projet DWF,
en fonction des dépendances enregistrées dans un fichier JSON spécifique à chaque projet.
Ce fichier JSON est consultable dans dwf/class/export_dwf/.
export_dwf est normalement autonome et ajoute vos dépendances tout au long de votre développement.
L'export inclura tous les fichiers contenus dans votre dossier projet (à l'exception des CSS dans src/compact).
Cependant, si vous désirez inclure un fichier ou un dossier spécifique à votre projet lors de l'export :

Il est déconseillé d'instancier export_dwf car son instanciation est réservée à l'export depuis html/index.php.
De même, les autres fonctions statiques sont utilisées en interne de la classe.

(cf js)

Cette classe permet de gérer une authentification via FaceBook.
Requiert la création d'une application sur https://developers.facebook.com/
Exemple d'usage :

Cette classe permet d'afficher et explorer une arborescence

Résultat :

Cette classe permet de rendre une autre classe pseudo-fluent.

La classe form permet de créer des formulaires en php stylisés par bootstrap, accessibles et respectant les normes W3C

Première méthode : création et rendu

Seconde méthode : affichage direct

Résultat (visuel uniquement, exécution désactivée):

Organise dynamiquement les sous éléments d'un conteneur avec la librairie jquery "freetile".
Il est préferable d'appeler cette librairie via js::freetile()
Les sous éléments peuvent être des images ou des DIV de différentes tailles.

Cette classe permet d'afficher et explorer une arborescence FTP PUBLIQUE
le compte FTP renseigné dans cette classe ne doit avoir que des droits de consultation ( aucun droit d'ajout/modification/suppression)
le rendu est le même que file_explorer()

Cette classe permet d'afficher un Fullcalendar
https://fullcalendar.io/

Exemple

Cette classe permet de gérer un agenda d'évènements minimalistes,
souvent utilisé pour avertir des visiteurs des prochains évenements
(salons, conventions, spectacles, ...)

Cette classe affiche le gestionnaire de fichiers elFinder
Il n'est pas recommandé de mettre deux instances de cette classe dans une même page
Pour autoriser un utilisateur à utiliser elFinder, vous devrez utiliser session::set_val("elFinder", true);
Cf : le fichier connector.php (généré par cette classe) pour plus de détails et options)

Cette classe permet de gérer et afficher des articles

Cette classe permet de retourner des Gifs de l'API GIPHY

Afin d'etre utilisatble, la clé api doit etre renseigné dans config.class.php ainsi :

Usage :

Utilisez GIT depuis PHP (requiert GIT sur le serveur) https://github.com/kbjr/Git.php

Cette classe permet de gérer une authentification via Google
Requiert la création d'une application sur https://console.cloud.google.com/apis/credentials

Cette classe permet de créér des graphiques.

Résultats :

Cette classe gère l'en-tête HTML5 et son pied de page.
Cette classe est utilisée automatiquement par le framework dans application.class.php
Les balises : title, meta description et meta keywords peuvent être modifiées grâce aux fonctions suivantes :

html_structures est une classe qui permet de créer des structures HTML en PHP,
Ces structures respectent les normes W3C et répondent à quelques normes d'accessibilité
Exemple :

Résultat :

•   Retour à l'accueil
•   Rechercher sur le web

Méthodes (toutes static) :

Cette classe permet de gérer le header LINK de http/2.0
elle n'est active que si le protocole http/2 est actif
si c'est le cas sont renseignés d'office :

• Les liens du menu (prérender)
• Les fichiers css et js appelés depuis html_structure (preload)

Cette classe sert à blacklister une liste de plages d'adresses IP en les redirigeant vers un autre site

Cette classe permet de récupérer des informations sur une adresse IP (géolocalisation, opérateur...).
Attention, json() est limité à 45 requêtes par minute,
batch() est limité à 15 requêtes par minute et 100 IP max par requête. (Cf https://ip-api.com)

Attention pour json_browser() et batch_browser() : les informations transiteront par le navigateur du client !
Les informations peuvent être altérées !

La classe js permet d'exploiter un grand nombre de librairies javascript intégrées à DWF notamment pour les appliquer à des éléments html de la page.

js::before_title

Ajoute un préfixe au titre (balise title) de la page en cours.

js::alert

Affiche un message à l'écran de l'utilisateur

js::alertify_alert

Affiche un message à l'écran de l'utilisateur (utilise la librairie alertyfy)

js::alertify_alert_redir

Affiche un message à l'écran de l'utilisateur avant redirection (utilise la librairie alertyfy)

js::log_std

Affiche un message de log (standard) à l'écran de l'utilisateur (utilise la librairie alertyfy)

js::log_success

Affiche un message de log (de succès) à l'écran de l'utilisateur (utilise la librairie alertyfy)

js::log_error

Affiche un message de log (erreur) à l'écran de l'utilisateur (utilise la librairie alertyfy)

js::redir

Redirige l'utilisateur vers l'url renseignée en paramètre (peut être un chemin relatif)

js::timer

Affiche un timer avant redirection

Résultat :

js::ckeditor

(cf form)

js::jsqr

Cette classe permet de lire un QRCode depuis une caméra et afficher le résultat dans un élément HTML.
Si l'élément HTML est un input alors le résultat deviendra la valeur de l'input.
Il est déconseillé d'utiliser cette classe plusieurs fois dans la même page

js::vTicker

Créé un vTicker (suite de phrases qui défilent)

js::datatable

Transforme un tableau HTML en Datatable

Résultat :

#	Film	Année	Genre	Entrées (France)
1	La Ligne Verte	1999	Fantastique, Drame	1 714 080
2	Le Cinquième Élément	1997	Science-Fiction	7 727 697
3	Matrix	1999	Action, Science-Fiction	2 426 543

js::monaco_highlighter

Afficher du code formaté et stylisé par la librairie SyntaxHightlighter
code :

<?php
js::monaco_highlighter('<?php\n'
    .'//mon code php\n'
    .'$"."a='Hello World';\n'
    .'echo $"."a;\n'
    .'?>', "php"); 
?>

Résultat :

(Vous l'aurez compris, cette documentation utilise beaucoup de monaco_highlighter)

js::fancybox

Cette classe permet l'affichage de galeries photos et vidéos via la librairie Fancybox
la clé "caption" dans le tableau $data est facultative.

js::freetile

(cf freetile)

js::stalactite

Organise dynamiquement les sous éléments d'un conteneur avec la librairie jquery "stalactite"

js::shuffle_letters

Applique l'effet "shuffleLetters" à un élément au chargement de la page

js::dialog

Affiche la boite de dialogue de jquery-ui

js::accordion

Applique un effet accordéon à une structure

Résultat :

accordéon1

contenu accordéon 1

sous accordéon 1

contenu sous accordéon 1

sous accordéon 2

contenu sous accordéon 2

accordéon 2

contenu accordéon 2

(Vous l'aurez compris, cette documentation utilise beaucoup d'accordéons)

js::menu

Transforme une liste ul>li en menu

Résultat :

• Item 1
• Item 2
• Item 3

js::slider

Affiche le carousel/slide de bootstrap

Résultat :

   

Logo PHP

Logo Cordova

Previous pause  Next

js::wled

Cette classe permet d'exploiter l'API HTTP de WLED

Cette classe permet d'afficher une carte exploitant OSM (OpenStreetMap)

Cette classe permet de créer un log sous forme de fichiers.
Elle vous permet d'enregistrer les comportements anormaux de votre application
Selon vos paramètres, le log est écrit dans dwf/log/log_[votre_projet]_[date_format_us].txt ou dwf/log/log_[votre_projet].txt

Cette classe permet de vous envoyer automatiquement un mail en cas de comportement anormal de votre application

Cette classe permet de générer un faux texte (Lorem ipsum)
Le texte est généré depuis le vocabulaire du texte de Cicero : De finibus.
Sources :
Liber Primus
Oeuvre complète

Resultat (lorem_ipsum::generate(100, true)) :

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Angusti referatur vituperandae disserendum splendore officia iucunditas vi voluerint aetatis disciplina deleniti interpretum petentium interpretaris amorem patientia exquirere inprobitatem cadere ei eo dialectica tite scribentur nostras terminari optimum captet repellere, dicam orestem invidi parum illi bonae necesse obiecta debeo atomis fingitur delicata eam traditur omni defatigatio ii doceat sinat, splendido iudicandum, equos constringendos satisfacit audivi oculis fugiat disputandum novum patriam dum statuam maximisque beatae genus formidines patriam arbitratu pauca istam mediocriterne causae frui politus arbitrarer disputari censes erant reprimique grate tractat. Tenetur stultorum quoque consilia agatur quosvis vitiis priventur consedit leviora brevi.

Cette classe permet de générer des liens LURL ou un bouton LURL sponsorisé qui redirige vers la page courante LURL

Cette classe vous permet d'envoyer un mail depuis votre application en une ligne de code (utilise les paramètres SMTP de config.class.php)

Cette classe permet de formater l'affichage d'un nombre dans un INPUT de type text

Attention ! maskNumber::set() doit être executé avant l'exécution du formulaire !
Résultat :

Cette classe contient quelques méthodes statiques mathématiques de base ainsi que des fonctions pour vérifier le type de variables

Cette classe gère la messagerie, elle permet d'envoyer, de réceptionner ou de supprimer un message entre les utilisateurs de l'application.

"Modal" est une classe permettant d'afficher des modals (appelées aussi layout ou pop-in). Une "modal" s'ouvre lors d'un clic sur un lien lui correspondant

Résultat :

Cette classe génère un monaco_editor afin d'editer le code du projet courant

/!\ cette classe est à placer précautionneusement dans une partie administration restreinte !

(cf js)

Cette classe permet d'afficher la météo d'une ville en temps réel (utilise openweather et nécessite une clé API)

Le résultat est le suivant (exemple fictif) :

Cette classe gère la pagination dans une page

Cette classe permet de créer, vérifier et exécuter des paiements via l'API REST de PayPal

Exemple d'utilisation :

Plus de renseignements dans la documentation technique et sur PayPal Developer

Permet d\'afficher les différences entre deux chaines de caractères

Texte de départfinal

Cette classe permet de modifier le header HTTP

Cette classe permet de formater (réindenter) du code php/html/js

Cette classe permet de gérer des profils de configuration PHP (comme avoir plusieurs fichiers php.ini interchangeable à volonté)

Cette classe permet l'export de données aux formats PDF, CSV ou QRCode,
le script d'export est html/commun/printer.php

Cette classe permet de lancer des "pseudo cron",
contairement à des vrais cron qui s'executent à des heures fixes planifiées par le système,
ici les pseudos cron s'exécutent : lors d'une activité utilisateur et s'il n'a pas été exécuté depuis un certain temps défini.

L'intéret des cron étant de pouvoir lancer des opérations lourdes à un rythme régulier sans ralentir l'utilisateur
il est possible de lancer un pseudo cron de façon "asynchrone" en utilisant un service et la methode service::HTTP_POST().

Les pseudos cron sont renseignés dans un registe ( soit un fichier json soit une table en base de données )
une entrée est supprimée si elle n'est pas mise à jour (exécutée) pendant 1 an, cette durée peut être modifiée via la méthode

Cette classe permet d'afficher un bloc css avec les proportions passées en paramètres.

Cette classe permet de créer un diaporama avec la librairie reveal
Il n'est pas recommandé d'avoir plusieurs diaporamas sur la même page.

Cette classe utilise l'API de Reverso pour corriger un texte et vous affiche les corrections à appliquer au texte grâce à la librairie finediff.

Un texte avec une grosse fotefaute

Cette classe génére le robot.txt
elle est appelé par html5.class.php
inutile de l'instancier d'avantage.

Affiche un tableau des vacances scolaires

Cette classe permet de faire appel à ScraperAPI
https://scraperapi.com

Attention, le scraping est une pratique faisant l'objet de nombreux flous juridiques.
L'utilisation de méthodes de scraping à des fins malveillantes peuvent constituer une infraction pénale.
Les développeurs de DWF se dégagent de toutes responsabilités en cas d'utilisation frauduleuse de cette classe.

Source https://github.com/tj/php-selector
"selectorDOM" permet de manipuler le DOM d'un document en PHP.

Résultat :

Array
(
    [0] => stdClass Object
        (
            [name] => header
            [attributes] => stdClass Object
                (
                    [class] => page-header bg-info
                )

            [text] => 
        DocumentationDocumentation de DWF
      
    
            [children] => Array
                (
                    [0] => stdClass Object
                        (
                            [name] => h1
                            [attributes] => Array
                                (
                                )

                            [text] => 
        DocumentationDocumentation de DWF
      
                            [children] => Array
                                (
                                    [0] => stdClass Object
                                        (
                                            [name] => br
                                            [attributes] => Array
                                                (
                                                )

                                            [text] => 
                                            [children] => Array
                                                (
                                                )

                                        )

                                    [1] => stdClass Object
                                        (
                                            [name] => small
                                            [attributes] => Array
                                                (
                                                )

                                            [text] => Documentation de DWF
                                            [children] => Array
                                                (
                                                )

                                        )

                                )

                        )

                )

        )

)

La classe service est une classe qui permet de communiquer avec des services web d'un tiers ou que vous aurez vous même créé.

La classe session permet de gérer les variables de sessions liées au projet courant,
cette classe créée vos variables en exploitant config::$_prefix

(cf js)

Cette classe sert de base pour créer des singleton.
la méthode "get_instance" retournera toujours la même instance.

Cette classe (singleton) gère les sitemaps de vos projets.
Elle permet d'ajouter, de supprimer et de générer des sitemaps au format XML.
Elle offre également des fonctionnalités pour afficher les URLs dans une liste HTML.
Les URLs peuvent étre supprimé via une interface d'administration.

sitemap::get_instance()->add_url() est automatiquement appelé dans html5.class.php, inutile de l'utiliser.
Seules les URL "publiques" de votre projet sont référencées dans le sitemap, les pages nécessitant une authentification ne le seront pas.
config::$_sitemap doit être défini à true pour que la classe référence les liens publics.

Cette classe permet de faciliter l'utilisation d'un gateway SMS afin de pouvoir envoyer des SMS depuis une application Web.
Cette classe a été conçue pour fonctionner par défaut avec le logiciel SMS Gateway installé sur un appareil Android.
SMS Gateway
Si vous utilisez un autre programme, veuillez à adapter les paramètres en conséquence.

La classe sql_backup permet de créer des backup quotidiens de la base de données
les backup peuvent être stockés sur un disque dur (différent du disque de l'application) ou sur un (s)ftp distant
il est recommandé de placer la ligne de sql_backup dans le constructeur de pages.class.php

Cette classe permet l'envoi de SSE (Server-Sent Events)
Optimisé pour http/2 et supérieur

Côté client, JS

(cf js)

Cette classe permet de recueillir et d'afficher des statistiques liées à l'activité des utilisateurs.
Les statistiques sont stoqué pour 5 ans maximum
la classe utilise ip_api pour déterminer le pays et l'operateur de l'utilisateur config::$_statistiques doit être définis a true pour que les statistiques soit enregistré

La classe sub_menu vous permet de créer un sous-menu en utilisant un système de "sous-routes"

Cette classe permet de créer et manipuler des balises HTML avant de les afficher.

Note 21.18.08 : dès sa création, cette classe est devenue centrale dans la génération de HTML dans les classes natives du framework.
Utiliser cette classe permet d'obtenir un code 100% PHP plus lisible et plus facile à maintenir qu'un code PHP "entrecoupé" de codes HTML.
Les impacts négatifs de cette classe sur l'utilisation de la mémoire et le temps d'exécution de PHP sont très faibles.
Bien entendu l'utilisation de cette classe dans vos projets et classes métiers reste facultative

Usage :

Exemple :

Cette classe permet de gérer les tâches planifiées.
Contrairement à un pseudo cron qui dépend de l'activité des utilisateurs,
les tâches planifiées sont lancées à une heure précise, mais cela nécessite l'exécution permanente d'un script en CLI.

Initialisation

La méthode statique suivante doit être appelée dans votre projet,
cela initialisera une table et une entité "task" ainsi qu'un dossier "task_worker" dans votre projet.

Workers

Un worker est une classe qui sera utilisée pour effectuer une tâche précise,
Exemple :

• Envoyer des mails
• Nettoyer/sauvegarder la base de données
• Lancer des audits et créer des rapports

Il doit être placé dans le dossier "task_worker" et se nommer "[nom_du_worker].worker.php"

Exemple de worker (affiche un hello world dans la console)

A noter que les classes du framework sont accessibles depuis les workers, un worker peut donc faire appel au task_manager pour programmer une nouvelle tâche (en cas d'erreur par exemple).
Exemple : votre worker doit envoyer un mail, l'envoi échoue car le SMTP est indisponible, vous pouvez capturer l'erreur pour programmer une nouvelle tentative d'envoi dans 1 heure.

Utilisation (dans le projet)

Execution

Pour lancer le script d'exécution des tâches, il faut ouvrir un terminal et exécuter la commande suivante :

Cette classe permet d'utiliser des templates en utilisant la librairie Smarty

Les templates doivent étre créés dans le dossier html/[votre-projet]/class/tpl
ce dossier peut être créé par la classe template si vous ne le créez pas au préalable
le ficher de template doit être un fichier .tpl ( exemple mon_template.tpl)
les droits en écriture sur le dossier html/[votre-projet]/class/tpl.compile doivent être donnés au service web

exemple, ficher mon_template.tpl

Appel du template dans le code php (pages.class.php par exemple)

Cette classe permet de retourner des Gifs de l'API TENOR

Afin d'etre utilisable, la clé api doit etre renseignée dans config.class.php ainsi :

Usage :

La classe "time" permet d'effectuer des calculs sur les dates et des conversions de format de dates US <=> FR

Cette classe est exploitée par la classe form (cf. form)

Cette classe permet de recupérer une ressource en passant par tor

Cette classe permet de créer des traductions à partir de clés,
l'administration de clés=>traductions se fait par une interface à placer dans la partie administration de l'application.
le langage de l'utilisateur est défini dans session::get_lang() (peut être modifié par session::set_lang())
Les traductions peuvent être gérées en base de données (par défaut) ou par des fichier JSON (CF : paramètres du constructeur)

Cette classe permet de gérer les mises à jour de DWF (à placer dans une interface d'administration)
ATTENTION ! GIT doit être installé sur la machine hôte !

Cette classe permet d'afficher une vidéo avec un player accessible

Credit :
Vidéo : Nuages - Libre de Droits https://www.youtube.com/watch?v=NqIw5wHvGYQ
Musique : Dread (v2) - musicman921 https://musicman921.newgrounds.com/

(cf js)

Inscrit les erreurs HTML du site dans le log.
requiert que le sitemap soit actif, et que le site soit en ligne

(cf. WebSocket)

Cette classe permet d'exploiter l'API HTTP de WLED

Cette classe permet de gérer un buffer à l'écriture de fichiers