File dorm-bundle/src/Traits/ControllerItemable.php

1:

<?php

2:

namespace TIC\DormBundle\Traits;

3:

4:

use Doctrine\ORM\EntityRepository;

5:

use Doctrine\ORM\EntityManagerInterface;

6:

use Symfony\Component\HttpFoundation\Request;

7:

use Symfony\Component\HttpFoundation\RedirectResponse;

8:

9:

use TIC\CoreBundle\Util\ConvertHelper;

10:

use TIC\CoreBundle\Util\ObjectHelper;

11:

12:

/**

13:

* Méthodes utiles pour gérer l'entité associée (EntityManager et raccourcis en surcouche).

14:

*/

15:

trait ControllerItemable

16:

{

17:

use \TIC\DormBundle\Traits\ManagerTrait; // EntityManager avec méthodes saveEntity & deleteEntity

18:

use \TIC\CoreBundle\Traits\ControllerRouting; // Méthodes pour les réponses redirectItem & redirectList

19:

# use \TIC\CoreBundle\Traits\ContextProperties; // ctxMesg (déjà inclu par ManagerTrait & ControllerRouting)

20:

21:

/**

22:

* Exécution de l'enregistrement d'une entité en BdD.

23:

*

24:

* @param object $item Entité à enregistrer

25:

* @param bool $redirect Rediriger vers la page d'origine (défaut) ou la fiche de l'entité (true)

26:

* @param string $alert Message de succès personnalisé (au lieu des tokens générés par défaut)

27:

* (si spécifié, le message de l'exception sera utilisé en cas d'échec)

28:

* @return RedirectResponse Réponse HTTP optionnelle vers la page précédente ou la fiche de l'entité

29:

*/

30:

protected function saveItem(object $item, ?bool $redirect = null, ?string $alert = null): ?RedirectResponse

31:

{

32:

$error = $this->saveEntity($item);

33:

34:

// génération du message de retour (alert)

35:

if (null === $error) {

36:

$message = ($alert === null) ? \sprintf('alert.%s.save.success', $this->ctxMesg) : $alert;

37:

$this->addFlash('success', $message);

38:

} else {

39:

$message = ($alert === null) ? \sprintf('alert.%s.save.failed', $this->ctxMesg) : $error;

40:

$this->addFlash('danger', $message);

41:

}

42:

43:

// génération d'une redirection HTTP en retour ?

44:

if ($redirect === false) return null;

45:

return ($redirect) ? $this->redirectItem($item) : $this->redirectReferer();

}

/**

* Exécution de la suppression d'une entité en BdD.

50:

*

51:

* @param object $item Entité à supprimer

52:

* @param bool $redirect Rediriger vers la page d'origine (défaut) ou la fiche de l'entité (true) sur erreur

53:

* ou sur la liste des entités en cas de succès (car la fiche devient indisponible)

54:

* @param string $alert Message de succès personnalisé (au lieu des tokens générés par défaut)

55:

* (si spécifié, le message de l'exception sera utilisé en cas d'échec)

56:

* @return RedirectResponse Réponse HTTP optionnelle vers la liste (si erreur page précédente ou fiche)

57:

*/

58:

protected function deleteItem(object $item, ?bool $redirect = null, ?string $alert = null): ?RedirectResponse

59:

{

60:

$error = $this->deleteEntity($item);

61:

62:

// génération du message de retour (alert)

63:

if (null === $error) {

64:

$message = ($alert === null) ? \sprintf('alert.%s.delete.success', $this->ctxMesg) : $alert;

65:

$this->addFlash('success', $message);

66:

} else {

67:

$message = ($alert === null) ? \sprintf('alert.%s.delete.failed', $this->ctxMesg) : $error;

68:

$this->addFlash('danger', $message);

69:

}

70:

71:

// génération d'une redirection HTTP en retour ?

72:

if ($redirect === false) return null;

73:

if (null === $error) return $this->redirectList();

74:

return ($redirect) ? $this->redirectItem($item) : $this->redirectReferer();

}

/**

* Exécution de la suppression d'une entité en BdD en coupant si possible le softdelete.

79:

*

80:

* @param object $item Entité à supprimer

81:

* @param bool $redirect Rediriger vers la page d'origine (défaut) ou la fiche de l'entité (true) sur erreur

82:

* ou sur la liste des entités en cas de succès (car la fiche devient indisponible)

83:

* @param string $alert Message de succès personnalisé (au lieu des tokens générés par défaut)

84:

* (si spécifié, le message de l'exception sera utilisé en cas d'échec)

85:

* @return RedirectResponse Réponse HTTP optionnelle vers la liste (si erreur page précédente ou fiche)

86:

*/

87:

protected function harddeleteItem(object $item, ?bool $redirect = null, ?string $alert = null): ?RedirectResponse

88:

{

89:

$error = $this->harddeleteEntity($item);

90:

91:

// génération du message de retour (alert)

92:

if (null === $error) {

93:

$message = ($alert === null) ? \sprintf('alert.%s.delete.success', $this->ctxMesg) : $alert;

94:

$this->addFlash('success', $message);

95:

} else {

96:

$message = ($alert === null) ? \sprintf('alert.%s.delete.failed', $this->ctxMesg) : $error;

97:

$this->addFlash('danger', $message);

98:

}

99:

100:

// génération d'une redirection HTTP en retour ?

101:

if ($redirect === false) return null;

102:

if (null === $error) return $this->redirectList();

103:

return ($redirect) ? $this->redirectItem($item) : $this->redirectReferer();

}

/**

* Exécution d'un changement de valeur sur une entité en BdD.

108:

*

109:

* @param object $item Entité à modifier et enregistrer

110:

* @param string $field Nom de la propriété à modifier

111:

* @param mixed $value Valeur à affecter à la propriété

112:

* @param bool $redirect Rediriger vers la page d'origine (défaut) ou la fiche de l'entité (true)

113:

* @param bool $no_alert Ne pas générer le message de retour selon résultat (token avec ctxMesg)

114:

* @return RedirectResponse Réponse HTTP optionnelle vers la page précédente ou la fiche de l'entité

115:

*/

116:

protected function changeItem(object $item, string $field, mixed $value, ?bool $redirect = null, ?bool $no_alert = false): ?RedirectResponse

117:

{

118:

// méthodes utilitaires pour changer la valeur du champs

119:

try {

120:

$change = ObjectHelper::changeField($item, $field, $value);

121:

} catch (\Exception $e) {

122:

return $this->alert('danger', ['title'=>"error.item.no_property", 'text'=>$e->getMessage()], false);

123:

}

124:

125:

// si valeur modifiée : enregistrement en BdD

126:

if ($change) $error = $this->saveEntity($item);

127:

128:

// message de retour selon l'état et le résultat

129:

if (! $no_alert) {

130:

if (! $change)

131:

$this->addFlash('warning', \sprintf('alert.%s.change.already', $this->ctxMesg));

132:

elseif ($error === null)

133:

$this->addFlash('success', \sprintf('alert.%s.change.success', $this->ctxMesg));

134:

else

135:

$this->addFlash('danger', ['title'=>\sprintf('alert.%s.change.failed', $this->ctxMesg), 'text'=>$error]);

136:

}

137:

138:

// génération d'une redirection HTTP en retour ?

139:

if ($redirect === false) return null;

140:

return ($redirect) ? $this->redirectItem($item) : $this->redirectReferer();

}

/**

* Exécution d'une inversion de valeur (booléenne) sur une entité en BdD.

145:

*

146:

* @param object $item Entité à modifier et enregistrer

147:

* @param string $field Nom de la propriété à modifier

148:

* @param mixed $value Valeur à affecter à la propriété (convertie en booléen via ConvertHelper)

149:

* @param bool $redirect Rediriger vers la page d'origine (défaut) ou la fiche de l'entité (true)

150:

* @param bool $no_alert Ne pas générer le message de retour selon résultat (token avec ctxMesg)

151:

* @return RedirectResponse Réponse HTTP optionnelle vers la page précédente ou la fiche de l'entité

152:

*/

153:

protected function toggleItem(object $item, string $field, mixed $value, ?bool $redirect = null, ?bool $no_alert = false): ?RedirectResponse

154:

{

155:

// méthodes utilitaires pour changer la valeur du champs

156:

try {

157:

$value = ConvertHelper::boolean($value);

158:

$state = ObjectHelper::toggleField($item, $field, $value);

159:

} catch (\Exception $e) {

160:

return $this->alert('danger', ['title'=>"error.item.no_property", 'text'=>$e->getMessage()], false);

161:

}

162:

163:

// si valeur modifiée : enregistrement en BdD

164:

if ($value === null) $value = $state;

165:

if ($state !== null) $error = $this->saveEntity($item);

166:

167:

// message de retour selon l'état et le résultat

168:

if (! $no_alert) {

169:

$action = ($value) ? "enable" : "disable";

170:

if ($state === null)

171:

$this->addFlash('warning', \sprintf('alert.%s.%s.already', $this->ctxMesg, $action));

172:

elseif ($error === null)

173:

$this->addFlash('success', \sprintf('alert.%s.%s.success', $this->ctxMesg, $action));

174:

else

175:

$this->addFlash('danger', ['title'=>\sprintf('alert.%s.%s.failed', $this->ctxMesg, $action), 'text'=>$error]);

176:

}

177:

178:

// génération d'une redirection HTTP en retour ?

179:

if ($redirect === false) return null;

180:

return ($redirect) ? $this->redirectItem($item) : $this->redirectReferer();

}

}

Namespaces

Traits