class
Ik ben benieuwd... benieuwd naar hoe jullie je classes inrichten. Ik heb regelmatig dat ik bij mezelf denk "Waar zal ik deze functie zetten? Hier op deze plek, of toch maar onder die andere functie?"
Mijn vraag is dus eigenlijk... wat is een goede manier om je class in te richten zodat deze prettig leesbaar is?
Wat ik momenteel in ieder geval doe, is altijd de __construct functie bovenaan zetten. Daaronder de public functies (ofwel de functies die je van buitenaf kunt aanroepen) en daaronder de private functies. Echter... van de public en private functies weet ik nooit zo goed welke ik bovenaan moet zetten. Ik zet nu maar de "voor mijn gevoel" belangrijkste functie bovenaan, maar ja... wat is belangrijk? Zijn dat je get en set functies? Of juist de exist functie of een clear functie of een convert functie? Dat is lastig te bepalen. Sterker nog... eigenlijk wil ik daar helemaal niet over na hoeven te denken!!
Nu zat ik dus bij mezelf te denken dat het misschien wel een goed idee is om de functies op alfabetische volgorde te zetten. Dan krijg je helemaal bovenin de __construct functie, gevolgd door de public functies op alfabetische volgorde en daar weer onder de private functies op alfabetische volgorde.
Zijn er meer mensen die het op deze manier doen?
Waarschijnlijk zijn er een hoop mensen die hier nooit over na hebben gedacht en gewoon alle functies door elkaar heen plaatsen. Maar ik zou graag een soort van structuur willen aanbrengen. Ervaringen en tips zijn bijzonder welkom!!
Een hele leuk vraag. Ik heb er zelf ook wel eens over nagedacht, en probeer de methodes zoveel mogelijk te groeperen op basis van wat de methodes doen.
Dus:
- getUser
- getUsers
en
- setUser
- setUsers
zet ik gewoon bij elkaar.
Daarnaast, zet ik wel altijd mijn constructor / init method bovenaan de class.
Niels
- getName
- setName
- getAge
- setAge
- getAddress
- setAddress
- addRight
- clearRight
en ook nog de volgende private functies
- getAgeFromDayOfBirth
- getExistingRights
- saveRights
Het gaat even helemaal niet erom of dit een reële/goede invulling van een class is. Het gaat mij er alleen om... hoe zou jij deze functies in je class zetten?? En waarom op die manier? Van een paar functies kun je het belang nog wel inschatten, maar van sommige functies ook echt niet. Wat is bijvoorbeeld belangrijker (en zou dus hoger moeten staan) de functie getAddress of getAge? Ik heb daadwerkelijk geen idee. En vandaar dus ook mijn gedachte om zowel de public als private functies op alfabetische volgorde te zetten.
Laat maar komen die reacties! :)
- variabele en constants
- constructor
- public methods, eerst 'aparte' methods, dan setters en dan getters
- protected methods, idem
- private methods
Belangrijkheid doe ik niet, want dat kun je -zoals je al aangeeft- bijna nooit goed bepalen.
Ook groepeer ik de methods wel, zoals Niels. Dus eerst setName gevolgt door getName enz. Nog een voorbeeldje van groeperen: http://www.phphulp.nl/php/script/classes/oo-registery/1940/registeryphp/1721/
Wat vind je van het idee om het op alfabetische volgorde te doen voor de public functies en de private functies?
Met dat voorbeeldje van hierboven zou je dan dit krijgen:
__construct
// public
addRight
clearRight
getAddress
getAge
getName
setAddress
setName
// private
getAgeFromDayOfBirth
getExistingRights
saveRights
Misschien toch helemaal zo gek nog niet. Je kunt dan wel alles heel snel vinden.
Gewijzigd op 12/03/2012 21:14:44 door Ozzie PHP
Alfabetisch vind ik zelf niet heel geweldig, logisch groeperen zou ik beter vinden. Je zou dan zoiets krijgen:
Code (php)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
class My_Class
{
+ __construct
+ addRight
+ clearRight
- saveRights
- getExistingRights
+ getAddress
+ setAddress
+ getName
+ setName
+ getAge
- getAgeFromDayOfBirth
}
{
+ __construct
+ addRight
+ clearRight
- saveRights
- getExistingRights
+ getAddress
+ setAddress
+ getName
+ setName
+ getAge
- getAgeFromDayOfBirth
}
Code (php)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
class My_Class
{
+ __construct
+ getAge
- getAgeFromDayOfBirth
+ getAddress
+ setAddress
+ getName
+ setName
+ addRight
+ clearRight
- saveRights
- getExistingRights
}
{
+ __construct
+ getAge
- getAgeFromDayOfBirth
+ getAddress
+ setAddress
+ getName
+ setName
+ addRight
+ clearRight
- saveRights
- getExistingRights
}
Wouter J op 12/03/2012 22:03:34:
Je zou ook de groepen alfabetisch kunnen groeperen. Dan zou ik niet de woordjes als add, clear, save en get meerekenen en dan krijg je zoiets:
Code (php)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
class My_Class
{
+ __construct
+ getAge
- getAgeFromDayOfBirth
+ getAddress
+ setAddress
+ getName
+ setName
+ addRight
+ clearRight
- saveRights
- getExistingRights
}
{
+ __construct
+ getAge
- getAgeFromDayOfBirth
+ getAddress
+ setAddress
+ getName
+ setName
+ addRight
+ clearRight
- saveRights
- getExistingRights
}
Hmmm... dat zou inderdaad ook nog kunnen. Ik ga er eens wat mee spelen ;)