Grâce aux avancées de Dotclear 2.27, cette nouvelle version 2.28 peut désormais proposer l'accès à la quasi totalité de l'application à partir d'un seul point App::. Le core, aka dcCore, passe en déprécié et ses méthodes et propriétés sont regroupées dans des classes dédiées à un ensemble de tâches de même style. Une nouvelle gestion par conteneur et services accompagnée d'un nouvelle gestion d'exception permet de proposer ces classes à tout moment sans avoir besoin de les instancier. Autre nouveauté de taille qui pourra être exploitée par la suite, ces classes deviennent remplaçables ! Ce qui devra être utilisé pour des classes d'authentification ou de connexion tiers par exemple.
Pour résumer, voici deux exemples simples de la nouvelle façon d'appeler les classes de l'ancien dcCore :
// Avant 2.28 :
dcCore::app()->auth->use_prefs;
// A partir 2.28, dcAuth fait partie du conteneur et ses propriétés deviennent des méthodes :
App::auth()->prefs();
// Avant 2.28 :
dcCore::app()->getAllBlogStatus();
// A partir de 2.28 les méthodes de l'ancien dcCore sont regroupées dans des classes à thème :
App::blogs()->getAllBlogStatus();
Voici la liste complète des classes composants ce nouveau Core de Dotclear :
Configuration
App::config(): ConfigInterface
Cette classe est une nouveauté de dotclear 2.28, elle regroupe toutes les informations de configuration de l'application.
Authentification
App::auth(): AuthInterface
dcCore::app()->auth
Anciennement dcAuth, c'est la classe de gestion de l'utilisateur.
Deux nouvelles méthodes sont disponibles :
openUserCursor(): Cursor
: renvoie un Cursor sur la table des utilisateursopenPermCursor(): Cursor
: renvoie un Cursor sur la table des permissions
L'utilisation d'une classe tiers d'authentification est encore permise en 2.28, mais il faudra utiliser le nouveau système de remplacement de classe par la suite.
Comportement
App::behavior(): BehaviorInterface
dcCore::app()->xxxBehaviorxxx(xxx)
Nouvelle classe de la version 2.28, elle regroupe toutes les méthodes dépréciées de dcCore en rapport aux behaviors.
L'ancienne méthode getBehaviors() est dédoublée :
getBehavior(string $behavior): array
: renvoie un groupe de behaviors,getBehaviors(): array
: renvoie tous les behaviors
Blog
App::blog(): BlogInterface
dcCore::app()->blog, new dcBLog()
Anciennement dcBlog, c'est la classe de gestion du blog courant. Cette classe subit des changements majeures dans son utilisation.
Désormais cette classe existe toujours dans l'application. Il ne faut plus tester le chargement du blog avec !is_null(dcCore::app()->blog) mais App::blog()->isDefined()
.
Il ne faut plus créer une nouvelle instance de dcBlog lorsqu'on veut naviguer entre deux blogs en cours de script, Il faut partir de l'instance existante et charger un autre blog dedans, puis recharger le premier si besoin. On peut mettre en id vide pour décharger un blog.
Une nouvelle méthode est donc disponible :
App::blog()->loadFromBlog(string $blog_id): BlogInterface
: renvoie l'instance de Blog chargé d'un autre blog
Exemple de chargement :
// On récupère l'ID de blog courant
$old_id = App::blog()->id();
// On charge le blog qu'on souhaite modifier
App::blog()->loadFromBlog('SecondBlog');
// On le modifie
App::blog()->triggerBlog();
// On recharge le blog courant
App::blog()->loadFromBlog($old_id);
De nouvelles méthodes sont disponibles :
openBlogCursor(): Cursor
: Ouvre un Cursor sur la table blogopenPostCursor(): Cursor
: Ouvre un Cursor sur la table postopenCommentCursor(): Cursor
: Ouvre un Cursor sur la table commentisDefined(): bool
: Vérifie si un blog est chargé dans la classe ou non
Les propriétés publiques de la classe passent en déprécié, il faut désormais utiliser les méthodes idoines :
- dcCore::app()->blog->id :
App::blog()->id(): string
- dcCore::app()->blog->uid :
App::blog()->uid(): string
- dcCore::app()->blog->name :
App::blog()->name(): string
- dcCore::app()->blog->desc :
App::blog()->desc(): string
- dcCore::app()->blog->url :
App::blog()->url(): string
- dcCore::app()->blog->host :
App::blog()->host(): string
- dcCore::app()->blog->creadt :
App::blog()->creadt(): int
- dcCore::app()->blog->upddt :
App::blog()->upddt(): int
- dcCore::app()->blog->status :
App::blog()->status(): int
- dcCore::app()->blog->settings :
App::blog()->settings(): BlogSettingsInterface
- dcCore::app()->blog->themes_path :
App::blog()->themesPath(): string
- dcCore::app()->blog->pblic_path :
App::blog()->publicPath(): string
Paramètres de blog
App::blogSettings(): BlogSettingsInterface
dcCore::app()->blog->settings, new dcSettings();
Anciennement dcSettings, c'est la classe de gestion des paramètres de blog. Cette classe subit également un changement majeur dans son utilisation. Pour créer une nouvelle instance de BlogSettings, il faut utiliser une nouvelle méthode de la classe qui renverra une instance prête à l'emploie :
App::blogSettings()->createFromBlog(?string $blog_id): BlogSettingsInterface
: renvoie une nouvelle instance de BlogSettings.
On peut également utiliser App::blog()->settings()->createFromBlog(?string $blog_id)
.
Ses méthodes en xxxNamespace() passent en déprécié, il faut utiliser leurs méthodes associées xxxWorkspace().
Espace de paramètres de blog
App::blogWorspace(), App::blog()->settings()->get(xxx), App::blog()->settings()->addWorspace(xxx)
Comme la classe précédente une nouvelle méthode fait son apparition pour créer une nouvelle instance de BlogWorkspace :
App::blogWorkspace()->createFromBlog(?string $blog_id, string $workspace, ?MetaRecord $rs = null): BlogWorkspaceInterface
: renvoie une nouvelle instance de BlogWorkspace.
Une nouvelle méthode est disponible :
openBlogWorkspaceCursor(): Cursor
: renvoie un Cursor sur la table des espaces de paramètres de blog
La méthode dumpNamespace() passe en déprécié, il faut utiliser dumpWorkspace().
Blogs
App:blogs()
dcCore::app()->xxxBlogsxxx()
Nouvelle classe de la version 2.28, elle regroupe toutes les tâches en rapport à la gestion des blogs.
Changement par rapport à la version 2.27, la méthode getBlog() renverra toujours une instance de Blog. Ceci est dû au changement de comportement de la classe Blog.
Cache
App:cache()
dcCore::app()->emptyTemplatesCache(), dcCore::app()->cache
Nouvelle classe de la version 2.28, Elle inclue une méthode de l'ancien core :
emptyTemplatesCache(): void
: vide le cache des templates
Et une nouvelle méthode pour le cache des dépôts de modules :
emptyModulesStoreCache(): void
: vide le cache des dépôts tiers
Elle remplace également la gestion des fichiers et timestamps utilisés pour le cache coté public et qui était dans un simple tableau dcCore::app()->cache :
resetFiles(): void
: Raz de la litses des fichiersaddFile(string $file): void
: Ajoute un fichieraddFiles(array $files): void
: Ajoute plusieurs fichiersgetFiles(): array
: Renvoie la liste des fichiersfunction resetTimes(): void
: Raz des timestampsaddTime(int $time): void
: Ajoute un timestampaddTimes(array $times): void
: Ajoute plusieurs timestampsgetTimes(): array
: Renvoie la listes des timestamps
Catégories
App::categories(), App::blog()->categories()
dcCore::app()->blog->categories, new dcCategories()
Anciennement dcCategories, c'est la classe de gestion des catégories d'un blog. Elle inclut désormais la classe NestedTree.
Comme vu sur de précédentes classes une nouvelle méthode fait son apparition pour créer une nouvelle instance de Categories :
App::blog()->categories()->createFromBlog(string $blog_id): CategoriesInterface
: renvoie une nouvelle instance de Categories.
Une nouvelle méthode est disponible :
openCategoryCursor(): Cursor
: renvoie un Cursor sur la table des catégories
Toutes les propriétés de la classe passent en protected.
Connexion
App::con()
dcCore::app()->con
Nouvelle classe de la version 2.28, elle permet le lien entre l'ancien chargement de gestionnaire de base de donnée et le nouveau système de chargement des classes du Core.
L'utilisation d'une classe tiers de connexion est encore permise en 2.28, mais il faudra utiliser le nouveau système remplacement de classe par la suite.
Elle inclut désormais le préfixe des tables disponibles en faisant App::con()->prefix()
.
Déprécié
App:deprecated()
Cette classe est disponible dans le Core ou en version statique. Elle permet de loguer en mode DEV d'éventuelles méthodes dépréciées.
Erreur
App::error()
dcCore::app()->error
C'est la classe de gestion d'erreur non bloquante du Core.
Sa méthode toHTML() passe en dépréciée, il faut utiliser votre propre parser à la place.
Filtre
App::filter()
dcCore::app()->wiki, dcCore::app()->xxxWikiXxx(), dcCore::app()->HTMLfilter()
Nouvelle classe de la version 2.28, elle regroupe toutes les méthodes et propriétés dédiées à la syntaxe wiki et HTML de texte.
Formateur
App:formater()
dcCore::app()->xxxFormaterXxx()-
Nouvelle classe de la version 2.28 elle regroupe toutes les méthodes de gestion des formateurs de texte.
Langue
App::lang()
dcCore::app()->lang
Nouvelle classe de la version 2.28, elle s'occupe de la langue courante.
Deux méthodes sont disponibles :
getLang(): string
: renvoie le code de la langue courantesetLang(string $lang): void
: enregistre le code de la langue courante.
Lexique
App::lexical()
dcUtils::xxxlexicalxxx()
Nouvelle classe de la version 2.28, elle regroupe toutes les méthodes en rapport au champs lexical d'une langue.
Log
App::log()
dcCore::app()->log
Anciennement dcLog, cette classe s'occupe de la gestion de log.
Une nouvelle méthode est disponible :
openLogCursor(): Cursor
: Ouvre un Cursor sur la table de log
L'ancienne méthode getTable() passe en dépréciée, il faut utiliser la constante de classe disponible sur App::log()::LOG_TABLE_NAME
.
Média
App::media()
dcCore::app()->media
Anciennement dcMedia, cette classe s'occupe de la gestion des média et comme vu précédemment, il ne faut plus créer une instance de dcMedia mais toujours utiliser celle du Core.
Pour définir le type de media, auparavant dans son constructeur, il faut utiliser la nouvelle méthode :
setFilterMimeType(string $type): void
: définit le type de media
Ses propriétés publiques deviennent dépréciées, il faut par exemple utiliser la méthode :
getThumbnailFilePattern(string $type = ''): string
: renvoie la définition d'un pattern.
D'autres nouvelles méthodes sont disponibles :
openMediaCursor(): Cursor
: ouvre un Cursor sur la table des médiapostMedia(): PostMediaInterface
: retourne l'instance de PostMedia
Métadonnée
App::meta()
dcCore::app()->meta
Anciennement dcMeta, cette classe gère les métadonnées de dotclear.
Une nouvelle méthode est disponible :
openMetaCursor(): Cursor
: ouvre un Cursor sur la table des métadonnées
Nonce
App::nonce()
Nouvelle classe de la version 2.28, elle regroupe les méthodes en rapport à la validation de formulaires.
L'ancienne méthode formNonce() est dédoublée :
getFormNonce(): string
: renvoie le contenu HTMLformNonce(): Hidden
: renvoie l'élément de Form de type Hidden
Notification
App::notice()
dcCore::app()->notices
Anciennement dcNotices, cette classe gère en base les notices.
Une nouvelle méthode est disponible :
openNoticeCursor(): Cursor
: ouvre un Cursor sur la table des notifications
Media de billets
App:postMedia(), App::media()->postMedia()
dcCore::app()->postmedia
Anciennement dcPostMedia, cette classe gère les media de billets.
Une nouvelle méthode est disponible :
openPostMediaCursor(): Cursor
: ouvre un Cursor sur la table des media de billets
Les constantes des noms des tables de media et post media sont disponibles dans cette classe :
App::postMedia()::MEDIA_TABLE_NAME
App::postMedia()::POST_MEDIA_TABLE_NAME
A noter que lorsqu'un blog est chargé dans la classe Blog via App::blog()->loadFromBlog()
, il est également chargé dans l'instance de la classe PostMedia.
Type de billets
App::postTypes()
dcCore::app()->getPostxxxURL(), dcCore::app()->xxxPostType()
Nouvelle classe de la version 2.28, elle regroupe les méthodes en relation aux types de billets.
Les anciennes méthodes sont toujours utilisables mais il est recommandé d'utiliser l'autre nouvelle classe de définition d'un type de billet PostType. (cf billet sur dcCore déprécié)
Service REST
App::rest()
dcCore::app()->xxxRestXxx()
Nouvelle classe de la version 2.28, elle regroupe les méthodes relatives au service REST.
Session
App::session()
Nouvelle classe de la version 2.28, elle adapte l'ancienne classe de gestion de session à la nouvelle gestion de classe de Core.
Une nouvelle méthode est disponible pour créer simplement une nouvelle session à partir d'un nom de cookie (pratique pour les plugins et thèmes) :
App::session()->createFromCookieName(string $cookie_name): SessionInterface
Rétroliens
App::trackback()
Anciennement dcTrackback, cette classe gère les rétroliens et pingback.
Une nouvelle méthode est disponible :
openTrackbackCursor(): Cursor
: ouvre un Cursor sur la table des rétroliens
Préférences utilisateur
App::userPrerefences()
Anciennement dcPrefs, cette classe gère les préférences utilisateur. Elle est disponible pour l'utilisateur en cours dans App::auth()->prefs()
.
Comme nombre de classes de Core, cette classe est toujours disponible et instanciée dans App::userPreferences(), pour avoir une nouvelle instance il faut donc utiliser sa méthode :
createFromUser(string $user_id, ?string $user_workspace = null): UserPreferencesInterface
: Créé une nouvelle instance des préférences utilisateur
Espace de préférences utilisateur
App::userWorkspace(), App::auth()->perfs()->get(xxx), App::auth()->prefs()->addWorspace(xxx)
Comme la classe précédente une nouvelle méthode fait son apparition pour créer une nouvelle instance de UserWorkspace :
createFromUser(?string $user_id, string $workspace, ?MetaRecord $rs = null): UserWorkspaceInterface
: renvoie une nouvelle instance de UserWorkspace.
Une nouvelle méthode est disponible :
openUserWorkspaceCursor(): Cursor
: renvoie un Cursor sur la table des espaces de préférences utilisateur
Utilisateurs
App::users()
Nouvelle classe de la version 2.28, elle regroupe toutes les méthodes relatives aux utilisateurs.
Versions
App::version()
dcCore::app()->xxxVersionXxx()
Nouvelle classe de la version 2.28, elle gère les version de module (et core) en base.
Une nouvelle méthode est disponible :
openVersionCursor(): Cursor
: ouvre un Cursor sur la table des versions
Autres
De plugs certaines classes plus spéciales sont accessibles depuis App::xxx() :
App::backend()
: Gestion de l'interface d'administrationApp::frontend()
: Gestion de l'interface publiqueApp::url()
: Anciennement dcUrlHandler de dcCore::app()->urlApp::task()
: Uniquement utilisé par les plugins et thèmes pour tester le contexte avecApp::task()->checkContext(...)
En savoir plus
Le contenu de ce document a été écrit suivant le code de la version 2.28 de Dotclear.
La discussion continue ailleurs
URL de rétrolien : https://dotclear.watch/trackback/34