Myaa - Use Cases

Een aantal UML use case diagrammen verduidelijken wat het programma moet doen. Deze tonen door middel van lijnen welke actoren (gebruikersrollen, aangeduid met een draadpoppetje) welke use cases (scenario’s, aangeduid met een ellips) kunnen uitvoeren.

Een use case diagram beschrijft alleen de interactie, niet de interne werking van het systeem. Use cases kunnen goed met eindgebruikers besproken worden, omdat ze aansluiten bij hun belevingswereld.

De naam van een use case is samengesteld uit een zelfstandig naamwoord en een werkwoord.

Use Case diagram

Use Case beschrijving

Start de Myaa applicatie

naam use case	OpenMyaa
samenvatting	Icoont op bureaublad
actoren	Myaa auteur
aannamen	computer is opgestart
beschrijving	git pull PHP build-in webserver opstarten pauseer browser starten
alternatief	feedback geven
resultaat	De IndexView pagina is geladen in de browser

index

naam use case	index
samenvatting	startpagina myaa
url	Myaa/index/[folder-name-to-open/open-folder-name]
actoren	Myaa auteur
aannamen	url: Myaa/index optioneel POST: open-folder-name
beschrijving	haal de inhoud van de myap map op of van de opgegeven map open-folder-name stop de inhoud in een associatieve array en geef die mee aan het model, met key `open-folder-content` folder navigation array genereren en meegeven aan het model met key `folder-navigation`
alternatief	feedback geven
resultaat	Index view

change directory

naam use case	chdir
samenvatting	naar een opgegeven map gaan en de inhoud in een array stoppen
actoren	Myaa auteur
aannamen	een knop naast een map waarop je kan klikken om naar de map te gaan
	url: Myaa/chdir
	POST: folder-name-to-open
beschrijving	als er een pagina open is: savePage haal de inhoud van de opgegeven map folder-name-to-open stop de inhoud in een associatieve array en geef die mee aan het model, met key `open-folder-content` folder navigation array genereren en meegeven aan het model met key `folder-navigation` geopende bestand terugsturen met key `article`
alternatief	feedback geven
resultaat	indien er een pagina geopend is page view anders index view

new page

naam use case	newPage
samenvatting	een nieuwe pagina met template laden in de editor in de folder die geopend is
actoren	Myaa auteur
aannamen	een + knop
	url: Myaa/newPage
	POST: open-folder-name, open-file-name, article, editor-state
beschrijving	als er een pagina open is, indien gewijzigd backup maken en opslaan haal de inhoud op van de opgegeven map open-folder-name stop de inhoud in een associatieve array en geef die mee aan het model, met key `open-folder-content` het pad van de geopende folder meegeven aan het model met key `open-folder-name` de waarde van `folder-name-open-file` is nu `open-folder-name` want het nieuwe bestand moet in de folder staat die in de verkenner geopend is template bestand terugsturen met key `article`
alternatief	feedback geven
resultaat	Page view

save page

naam use case	savePage
samenvatting	de tekst in de editor opslaan
actoren	Myaa auteur
aannamen	een save knop
	url: Myaa/savePage
	POST: open-folder-name, open-file-name, article, editor-state
beschrijving	indien article gewijzigd is: als de titel gewijzigd is, article onder nieuwe bestandsnaam opslaan anders: als bestand al bestaat, een backup maken opslaan haal de inhoud op van de opgegeven map open-folder-name stop de inhoud in een associatieve array en geef die mee aan het model, met key `open-folder-content` het pad van de geopende folder meegeven aan het model met key `open-folder-name` opgeslagen bestand terugsturen met key `article`
alternatief	feedback geven
resultaat	Page view

open page

naam use case	openPage
samenvatting	een opgeslagen HTML bestand openen door op het potlood icoon te klikken in de verkenner links
actoren	Myaa auteur
aannamen	een potlood knop
	url: Myaa/openPage
	POST: open-folder-name, open-file-name, article, editor-state, file-name-to-open
beschrijving	indien article gewijzigd is: als de titel gewijzigd is, article onder nieuwe bestandsnaam opslaan anders: als bestand al bestaat, een backup maken opslaan haal de inhoud op van de opgegeven map open-folder-name stop de inhoud in een associatieve array en geef die mee aan het model, met key `open-folder-content` het pad van de geopende folder meegeven aan het model met key `open-folder-name` open bestand die in de key file-name-to-open staat opgeslagen bestand terugsturen met key `article`
alternatief	feedback geven
resultaat	Page view

move page

naam use case	movePage
samenvatting	het geopende HTML bestand verplaatsen naar de open folder in de verkenner links
actoren	Myaa auteur
aannamen	een move-to-folder knop
	url: Myaa/movePage
	POST: open-folder-name, open-file-name, article, editor-state,
beschrijving	indien article gewijzigd is: als de titel gewijzigd is, article onder nieuwe bestandsnaam opslaan anders: als bestand al bestaat, een backup maken opslaan verplaats bestand van folder-name-open-file naar open-folder-name haal de inhoud op van de opgegeven map open-folder-name folder-name-open-file is nu gelijk aan open-folder-name verplaatst bestand terugsturen met key `article`
alternatief	feedback geven
resultaat	Page view

Nieuwe folder maken

naam use case	mkdir
samenvatting	Een nieuwe folder maken in de geselecteerde (open) folder
actoren	Myaa auteur
aannamen	FileManager is geladen url: Myaa/mkdir
beschrijving	verifiëren dat de te maken map nog niet bestaat foldernaam valideren folder Id van de myap map ophalen nieuwe folder maken vernieuwde lijst van folders tonen
alternatief	feedback geven
resultaat	indien er een pagina open is page view anders index view

folder deleten

naam use case	rmdir
samenvatting	Een geselecteerd folder deleten
actoren	Myaa auteur
aannamen	FileManager is geladen url: Myaa/rmdir
beschrijving	verifiëren dat de te deleten folder leeg is folder deleten vernieuwde lijst van folders inladen indien pagina open is, naam van de pagina en de folder in het model stoppen
alternatief	feedback geven
resultaat	indien er een pagina open is page view anders index view

bestand uploaden naar myap

naam use case	uploadFile
samenvatting	Een lokaal bestand in de myap folder plaatsen
actoren	Myaa auteur
aannamen	Fille upload is beschikbaar url: Myaa/upLoadFile
beschrijving	verifiëren dat de te uploaden file een image bestand of pdf is bestand uploaden vernieuwde lijst van folders inladen indien pagina open is, naam van de pagina en de folder in het model stoppen
alternatief	feedback geven
resultaat	indien er een pagina open is page view anders index view

bestand unloaden van myap

naam use case	uploadFile
samenvatting	Een bestand uit de myap folder verwijseren
actoren	Myaa auteur
aannamen	Fille unload is beschikbaar url: Myaa/unloadFile
beschrijving	als het het te unloaden bestand bestaat, verwijderen vernieuwde lijst van folders inladen indien pagina open is, naam van de pagina en de folder in het model stoppen
alternatief	feedback geven
resultaat	indien er een pagina open is page view anders index view

pagina publiceren

naam use case	publish page
samenvatting	een pagina publiceren op de website
actoren	Myaa auteur
aannamen	Er staat een pagina open url: Myaa/publishPage
beschrijving	open pagina versturen met sftp indien nodig submappen maken open folder opnieuw inladen indien pagina open is, naam van de pagina en de folder in het model stoppen
alternatief	feedback geven
resultaat	page view

2020-06-11 16:59:33