La classe blog prend en charge toute la gestion du blog. Elle nécessite pour fonctionner qu'un objet de type connection soit existant et que la librairie files soit également disponible.
Avec cette classe, il est possible de réaliser toutes les tâches d'administration (ajouts, modifications, suppressions d'éléments) ainsi que les sélections de billets.
void blog($con, [$prefix=''], [$pub_mode='1'], [$encoding='ISO-8859-1'])
Constructeur. Cette méthode initialise l'objet Blog.
void setPubMode($mode)
Cette méthode définit le niveau de plublication des éléments (billets et commentaires) que l'on va traiter avec l'objet. Il prend les valeurs 0 (éléments non publiés uniquement), 1 (éléments publiés uniquement) ou NULL (tous les éléments)
Le niveau de publication sera pris en compte dans nombre de méthodes de sélection des billets ou des commentaires.
void setLang($lang)
Définit un critère de tri pour la langue des billets. Utilisable sur la partie publique si on souhaite n'afficher que les billets d'une certaine langue.
void setDateFormat([$d='%A %e %B %Y'], [$h='%H:%M'])
Définit le format de la date des éléments qui seront retournés.
void setURL($type, $url)
Définit les différents modèles d'URL du blog.
void resetError()
Remet les erreurs à zéro.
void setError($msg, [$no=0])
Ajoute une erreur dans la pile des erreurs.
string error([$html=false], [$with_nb=true])
Récupère les erreurs et renvoie une chaîne ou false si aucune erreur.
Le paramètre $html indique si l'on souhaite obtenir les erreurs au format HTML et $with_nb si la méthode doit également renvoyer les numéros (uniquement visibles au format HTML)
void setUser($id, [$force=false])
Force un utilisateur, seulement si user_level est inférieur à 5 ou si $force est vrai.
boolean checkUser($id, [$pwd=NULL], [$level=NULL], [$md5=true])
Existence d'un utilisateur. Cette méthode renvoie vrai ou faux selon que l'utilisateur existe ou non. Les mots de passe et niveau sont optionnels. Le paramètre $md5 indique si la chaîne de mot de passe est passé en clair ou comme md5 à la méthode.
recordset getUser([$id=''])
Renvoie les données concernant un ou plusieurs utilisateurs. Si aucun paramètre $id n'est donné, tous les utilisateurs seront renvoyés dans un recordset. La méthode renvoie false si elle échoue.
boolean addUser($id, $level, $pwd, $nom, $prenom, $pseudo, $email, [$post_format='html'], [$edit_size=10], [$pref_cat=1], [$lang=''], [$delta=0], [$post_pub=true])
Ajout d'un utilisateur. Renvoie vrai en cas de succès.
boolean updUser($id, $new_id, $level, $pwd, $nom, $prenom, $pseudo, $email, [$post_format='html'], [$edit_size=10], [$pref_cat=1], [$lang=''], [$delta=0], [$post_pub=true])
Modification d'un utilisateur. Renvoie vrai en cas de succès.
Si le mot de passe est vide, il ne sera pas changé.
boolean delUser($id)
Suppression d'un utilisateur. Renvoie vrai en cas de succès.
boolean checkCat($cat_id)
Vérifie l'existence d'une catégorie. Renvoie vrai ou faux.
recordset getCat([$cat_id=''], [$order_by='cat_ord'])
Sélectionne une ou plusieurs catégories. La paramètre $cat_id peut être un entier, le champ cat_id sera alors pris en compte. S'il s'agit d'une chaine, la comparaison sera faite sur cat_libelle_url.
Si le paramètre $cat_id est une chaine vide, toutes les catégories seront renvoyées dans le recordset (fonctionnement par défaut).
La méthode renvoie false en cas d'erreur.
boolean addCat($libelle, [$desc=''], [$libelle_url=''])
Ajout d'un catégorie. Renvoie vrai en cas de succès.
boolean updCat($cat_id, $libelle, [$desc=''], [$libelle_url=''])
Modification d'un catégorie. Renvoie vrai en cas de succès.
boolean delCat($cat_id)
Suppression d'une catégorie donnée. Renvoie vrai en cas de succès.
void reordCats([$chekc_url=false], [$byname=false])
Réordonner les catégories. Cette méthode va remettre les catégorie dans l'ordre (selon les ID ou selon les noms si $byname est vrai).
Si $check_url est vrai, les titres "URLisés" seront normalisés.
boolean ordCats($ord)
Ordonne les catégories en utilisant les valeurs du tableau $ord. La clé est l'identifiant de la catégorie et la valeur, l'ordre de celle-ci.
La méthode renvoie vrai en cas de succès.
string SQL([$reqPlus=''], [$order='post_dt ASC'], $limit)
Cette méthode renvoie une requête SQL prête à être exploitée pour sélectionner des billets selon divers critères.
La valeur de $reqPlus doit commencer par AND. $limit peut être un nombre ou un critère de limite classique (0,n).
recordset getLastNews([$limit=20], $cat, [$order='post_dt DESC'], [$selected=false], $lang)
post_selectedCette functions renvoie un recordset (ou l'objet défini par la propriété rs_blogpost) contenant les n derniers billets.
$cat peut être une chaîne ou un entier selon que l'on souhaite travailler avec cat_id ou cat_libelle_url.
recordset getPostByID($id)
Sélection d'un billet par son ID. Cette méthode renvoie un recordset étendu (comme la précédente) contenant le billet sélectionné.
recordset getPostByDate($y, $m, [$d=''], $cat, [$order='post_dt DESC'], [$selected=false], $lang)
post_selectedSélection de billet par une date. Les paramètre de mois et d'année sont obligatoire. Les aures optionnels. La catégorie peut être une chaîne ou un entier.
La méthode renvoie un recordset étendu.
recordset searchPost($w)
Recherche d'un billet selon des mots clé et renvoie un recordset étendu. La recherche est faite sur les champs post_content, post_titre et post_chapo.
array getAllDates($type, [$y=''], [$m=''], [$d=''], [$cat=''])
Obtenir les dates (jours ou mois) du blog. Cette méthode renvoie un tableau contenant toutes les dates du blog. On peut restreindre la recherche à une année, un mois (d'une année donnée) ou un jour.
Le critère de catégorie peut être une chaîne ou un entier.
La tableau renvoyé est un tableau de plusieurs lignes dont la clé est un timestamp et la valeur la date au format YYYY-MM-DD.
string getEarlierDate($cat)
Renvoie la date au format standard du billet le plus récent ou false en cas d'erreur. $cat peut être une chaîne ou un entier.
recordset getNextID($ts, $dir)
Renvoie un recordset contenant l'id, le titre et la date du billet suivant le timestamp donné par $ts. $dir prend les valeurs 1 (billet suivant) ou 0 (billet précédent).
recordset getPostLanguages()
Renvoie un recordset contenant toutes les langues du blog, ou false en cas d'erreur.
integer addPost($user_id, $titre, $titre_url, $chapo, $content, $notes, $cat_id, [$format='html'], [$publish=true], [$open_comment=true], [$open_tb=true], [$lang=''], [$selected=false], [$delta=0])
Création d'un billet. Renvoie l'ID du billet en cas de succès et false en cas d'erreur.
boolean updPost($post_id, $titre, $titre_url, $chapo, $content, $notes, $cat_id, [$format='html'], [$publish=true], [$open_comment=true], [$open_tb=true], $date, [$lang=''], [$selected=false], [$delta=0])
Modification d'un billet. Renvoie vrai en cas de succès.
boolean updPostCat($post_id, $cat_id)
Change la catégorie d'un billet donné. Renvoi vrai en cas de succès.
boolean statusPost($id)
Inverse le status de publication d'un billet.
boolean delPost($id)
Supprime un billet et tous les commentaires associés. Renvoie vrai en cas de succès.
void triggerMassUpd()
"Déclencheur" changeant la date d'un fichier pour indiquer la dernière modification. Le fichier est défini par la constante DC_UPDATE_FILE et la constante DC_UPDATE_FILE_W indique si ce dernier est accessible en écriture.
boolean triggerPostNbComment($id)
"Déclencheur" pour mettre à jour le nombre de commentaires publiés d'un billet. Renvoie vrai en cas de succès.
boolean triggerLog($table, $key, $log, $user)
"Déclencheur" remplissant la table de logs. Renvoie vrai en cas de succès.
integer getNbComments($id)
Retourn le nombre de commentaires d'un billet sous forme d'un entier.
integer getNbTrackbacks($id)
Retourn le nombre de trackbacks d'un billet sous forme d'un entier.
recordset getComments([$post_id=''], [$order='ASC'], [$limit=NULL])
Sélection des commentaires et trackbacks d'un billet. Renvoie un recordset étendu du type défini par la propriété rs_blogcomment. Si la valeur de $post_id est vide, tous les commentaires seront renvoyés.
recordset getComment($id)
Récupération d'un commentaire par son ID. Renvoie un recordset étendu.
boolean addComment($post_id, $auteur, $email, $site, $content, [$trackback=false], [$delta=0], [$pub=true])
Création d'un commentaire. Renvoie vrai en cas de succès.
boolean updComment($id, $auteur, $email, $site, $content, [$pub=true])
Modification d'un commentaire. Renvoie vrai en cas de succès.
boolean statusComment($id)
Inversion du status d'un commentaire. Renvoie vrai en cas de succès.
boolean delComment($id)
Suppression d'un commentaire. Renvoie vrai en cas de succès.
boolean postTbPingURL($post_id, $url, $blog_name, [$content=''])
Effectue un ping sur un autre blog. Renvoie vrai en cas de succès.
Si le contenu du ping n'est pas donné, les 255 premier caractères du billet ou du chapo seront utilisés à la place.
boolean postPingNotify($post_id, $url)
Notification du trackback dans la table d'historique des pings. Renvoie vrai en cas de succès.
boolean postPingCheck($post_id, $url)
Vérification si ping pas déjà fait pour un post. Renvoie vrai si il y a déjà un ping dans la table.
recordset postGetPings($post_id)
Sélection des ping réalisés pour un post donnée. Renvoie un recordset.
boolean optimize()
Optimise les tables de la base de données. Les tables concernées sont uniquement celles prises en charge par la classe. Renvoie vrai en cas de succès.
void countAll()
Recompte l'ensemble des commentaires et trackbacks du blog.
string parseContent($string)
Cette méthode remplace les URL et les liens mailto par des liens HTML dans la chaîne $string et renvoie une chaîne transformée.
string parseUri($matches)
Cette fonction est utilisée par parseContent pour créer le lien HTML depuis une URL. L'intitulé est raccourci si l'URL dépasse 25 caractères.
C'est une fonction de callback qui n'est d'aucune utilité sortie de son contexte.
array getPermissions($str)
Méthode statique qui transforme une chaine de permission au format |perm1|perm2| en un tableau PHP.
string secureString($str)
Renvoie une chaîne après en avoir supprimé les tags HTML et passé les caractères spéciaux en entités.
boolean isEmail($str)
Teste si une chaîne est une adresse email valide.
string getPart($string, $l)
Renvoie une partie de la chaîne $string en coupant à la longueur $l désirée. La chaîne est coupée aux espaces.
string toXML($string, [$utf8=false])
Renvoie une chaîne propre à être passée dans un fichier XML (entités numériques, etc.). La paramètre $utf8 n'est plus d'aucune utilité.
string removeEntities($string)
Remplace les entités d'une chaîne par leurs équivalents normaux. Les caractères provenant du jeu de caractère incorect de Windows sont également convertis.
Cette méthode utilise la propriété encoding de la classe et transforme les caractères en UTF-8 si le jeu de caractère est UTF-8.
Cette méthode est utilisée par la méthode toXML.
string str2url($str)
Transforme la chaîne $str en une chaîne propre à être un élément d'une URL.
Ces exemples supposent qu'un objet $blog soit une instance de la classe.
Dans cet exemple, nous sélectionnons les 10 derniers billets du blog dans la catégorie dont l'ID est 1, puis nous en affichons le titre.
<?php $rs = $blog->getLastNews(10,1); while ($rs->fetch()) { echo '<p>'.$rs->f('post_titre').'</p>'; } ?>
Wiki powered by Dokuwiki.