PHPdoc, typage

blocks_fonctions.php

@@ -36,6 +36,7 @@ function blocks_deserialize($data) {
 /**
  * Compile la balise `#GENERER_BLOCK` qui génère l'affiche d'un block'
  *
+ * @uses _block_charger_block()
  * @balise
  * @param Champ $p Pile au niveau de la balise
  * @return Champ   Pile complétée par le code à générer
@@ -65,6 +66,12 @@ function balise_GENERER_BLOCK_dist($p) {
 	return $p;
 }
 
+/**
+ * Fonction interne à la balise GENERER_BLOCK
+ *
+ * @param $id_block
+ * @return array|string
+ */
 function _block_charger_block($id_block) {
 	$retour = '';
 	$where = ['b.id_block = ' . (int)$id_block];
@@ -98,6 +105,7 @@ function _block_charger_block($id_block) {
 /**
  * Compile la balise `#GENERER_BLOCKS` qui génère l'affiche des blocks liés à un objet
  *
+ * @uses _block_charger_blocks()
  * @balise
  * @param Champ $p Pile au niveau de la balise
  * @return Champ   Pile complétée par le code à générer
@@ -131,7 +139,14 @@ function balise_GENERER_BLOCKS_dist($p) {
 	return $p;
 }
 
-function _block_charger_blocks($objet, $id_objet) {
+/**
+ * Fonction interne à la balise GENERER_BLOCKS
+ *
+ * @param $objet
+ * @param $id_objet
+ * @return string
+ */
+function _block_charger_blocks($objet, $id_objet): string {
 	$retour = '';
 	$where = [
 		'bl.objet = ' . sql_quote($objet),
@@ -159,9 +174,9 @@ function _block_charger_blocks($objet, $id_objet) {
  * composé de son type et du titre de l'objet auquel il est lié
  *
  * @param $id_block
- * @return mixed|string
+ * @return string
  */
-function generer_TITRE_BLOCK($id_block) {
+function generer_TITRE_BLOCK($id_block): string {
 	if ($infos = sql_fetsel(
 		'bt.titre, bl.objet, bl.rang_lien, bl.id_objet',
 		'spip_blocks b join spip_blocktypes bt using(id_blocktype) left join spip_blocks_liens bl using(id_block)',
@@ -186,7 +201,7 @@ function generer_TITRE_BLOCK($id_block) {
  * @param bool   $chemin_complet Retourne le chemin complet du squelette
  * @return string Chemin du squelette trouvé
  */
-function blocks_trouver_squelette($identifiant, $force_public = false, $chemin_complet = false, $dist = true) {
+function blocks_trouver_squelette($identifiant, $force_public = false, $chemin_complet = false, $dist = true): string {
 	static $cache;
 	$cle = $identifiant . (int)$force_public . (int)$chemin_complet . (int)$dist;
 
@@ -219,15 +234,31 @@ function blocks_trouver_squelette($identifiant, $force_public = false, $chemin_c
 	return $squelette;
 }
 
-function bloctypes_trouver_enfants($id_blocktype) {
+/**
+ * Calculer la liste des types de blocks pouvant être créés sous un type de block
+ * @param $id_blocktype
+ * @return array
+ */
+function bloctypes_trouver_enfants($id_blocktype): array {
 	return bloctypes_trouver_role($id_blocktype, 'enfant');
 }
 
-function bloctypes_trouver_parents($id_blocktype) {
+/**
+ * Calculer la liste des types de blocks dans lesquels un type de block peut être créé
+ * @param $id_blocktype
+ * @return array
+ */
+function bloctypes_trouver_parents($id_blocktype): array {
 	return bloctypes_trouver_role($id_blocktype, 'parent');
 }
 
-function bloctypes_trouver_role($id_blocktype, $role) {
+/**
+ * Calculer une liste de types de blocks enfants ou parents en fonction du rôle
+ * @param $id_blocktype
+ * @param $role
+ * @return array
+ */
+function bloctypes_trouver_role($id_blocktype, $role): array {
 	if (
 		$id_blocktype
 		&& $role