Object-Oriented PHP For Beginners - Nettuts+

02/02/12
Object-Oriented PHP for Beginners Nettuts+
AdvertiseHere
ObjectOrientedPHPforBeginners
JasonLengstorfonDec23rd2011with202comments
TutorialDetails
Program:PHP
Version(ifapplicable):PHP5+
Difficulty:Intermediate
EstimatedCompletionTime:2Hours
Twiceamonth,werevisitsomeofourreaders favoritepostsfromthroughoutthehistoryofNettuts+.ThistutorialwasfirstpublishedinJuly,2010.
FormanyPHPprogrammers,objectorientedprogrammingisafrighteningconcept,fullofcomplicatedsyntaxandotherroadblocks.Asdetailedinmybook,Pro
PHPandjQuery,you lllearntheconceptsbehindobjectorientedprogramming(OOP),astyleofcodinginwhichrelatedactionsaregroupedintoclassestoaid
increatingmorecompact,effectivecode.
UnderstandingObjectOrientedProgramming
Objectorientedprogrammingisastyleofcodingthatallowsdeveloperstogroupsimilartasksintoclasses.Thishelpskeepcodefollowingthetenetdon trepeat
yourself(DRY)andeasytomaintain.
Objectorientedprogrammingisastyleofcodingthatallowsdeveloperstogroupsimilartasksintoclasses.
OneofthemajorbenefitsofDRYprogrammingisthat,ifapieceofinformationchangesinyourprogram,usuallyonlyonechangeisrequiredtoupdatethe
code.Oneofthebiggestnightmaresfordevelopersismaintainingcodewheredataisdeclaredoverandoveragain,meaninganychangestotheprogrambecomean
infinitelymorefrustratinggameofWhere sWaldo?astheyhuntforduplicateddataandfunctionality.
OOPisintimidatingtoalotofdevelopersbecauseitintroducesnewsyntaxand,ataglance,appearstobefarmorecomplexthansimpleprocedural,orinline,code.
However,uponcloserinspection,OOPisactuallyaverystraightforwardandultimatelysimplerapproachtoprogramming.
UnderstandingObjectsandClasses
BeforeyoucangettoodeepintothefinerpointsofOOP,abasicunderstandingofthedifferencesbetweenobjectsandclassesisnecessary.Thissectionwillgo
overthebuildingblocksofclasses,theirdifferentcapabilities,andsomeoftheiruses.
Recogni ingtheDifferencesBetweenObjectsandClasses
net.tutsplus.com/tutorials/php/object-oriented-php-for-beginners/
1/24
02/02/12
PhotosbyInstantJeffersonandJohnWardell
Developersstarttalkingaboutobjectsandclasses,andtheyappeartobeinterchangeableterms.Thisisnotthecase,however.
Rightoffthebat,there sconfusioninOOP:seasoneddevelopersstarttalkingaboutobjectsandclasses,andtheyappeartobeinterchangeableterms.Thisisnotthe
case,however,thoughthedifferencecanbetoughtowrapyourheadaroundatfirst.
Aclass,forexample,islikeabl ep in fo aho e.Itdefinestheshapeofthehouseonpaper,withrelationshipsbetweenthedifferentpartsofthehouseclearly
definedandplannedout,eventhoughthehousedoesn texist.
Anobject,then,islike heac alho ebuiltaccordingtothatblueprint.Thedatastoredintheobjectislikethewood,wires,andconcretethatcomposethehouse:
withoutbeingassembledaccordingtotheblueprint,it sjustapileofstuff.However,whenitallcomestogether,itbecomesanorganized,usefulhouse.
Cla e fo m he
c eofda aandac ion and e ha info ma ion ob ildobjec .Morethanoneobjectcanbebuiltfromthesameclassatthesame
time,eachoneindependentoftheothers.Continuingwithourconstructionanalogy,it ssimilartothewayanentiresubdivisioncanbebuiltfromthesameblueprint:
150differenthousesthatalllookthesamebuthavedifferent
familiesanddecorationsinside.
ingCla
Thesyntaxtocreateaclassisprettystraightforward:declareaclassusingtheclasskeyword,followedbythenameoftheclassandasetofcurlybraces({ ):
viewplaincopytoclipboardprint?
1.
2.
3.
4.
5.
6.
7.
8.
<?php
classMyClass
{
//Classpropertiesandmethodsgohere
}
?>
Aftercreatingtheclass,anewclasscanbeinstantiatedandstoredinavariableusingthenewkeyword:
1. $obj=newMyClass
Toseethecontentsoftheclass,usevar_dump():
1. var_dump($obj)
Tryoutthisprocessbyputtingalltheprecedingcodeinanewfilecalledtest.phpin[yourlocal]testingfolder:
1.
2.
3.
4.
5.
6.
<?php
classMyClass
{
//Classpropertiesandmethodsgohere
}
2/24
02/02/12
6.
7.
8.
9.
10.
11.
12.
$obj=newMyClass
var_dump($obj)
?>
Loadthepageinyourbrowserathttp://localhost/test.phpandthefollowingshoulddisplay:
1. object(MyClass)#1(0){}
Initssimplestform,you vejustcompletedyourfirstOOPscript.
DefiningCla
P ope ie
Toadddatatoaclass,properties,orclassspecificvariables,areused.Theseworkexactlylikeregularvariables,exceptthey reboundtotheobjectandtherefore
canonlybeaccessedusingtheobject.
ToaddapropertytoM Class,addthefollowingcodetoyourscript:
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
<?php
classMyClass
{
public$prop1="I'maclassproperty!"
}
$obj=newMyClass
var_dump($obj)
?>
Thekeywordpublicdeterminesthevisibilityoftheproperty,whichyou lllearnaboutalittlelaterinthischapter.Next,thepropertyisnamedusingstandard
variablesyntax,andavalueisassigned(thoughclasspropertiesdonotneedaninitialvalue).
Toreadthispropertyandoutputittothebrowser,referencetheobjectfromwhichtoreadandthepropertytoberead:
1. echo$obj>prop1
Becausemultipleinstancesofaclasscanexist,iftheindividualobjectisnotreferenced,thescriptwouldbeunabletodeterminewhichobjecttoreadfrom.Theuse
ofthearrow(>)isanOOPconstructthataccessesthecontainedpropertiesandmethodsofagivenobject.
Modifythescriptintest.phptoreadoutthepropertyratherthandumpingthewholeclassbymodifyingthecodeasshown:
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
<?php
classMyClass
{
}
$obj=newMyClass
echo$obj>prop1//Outputtheproperty
?>
Reloadingyourbrowsernowoutputsthefollowing:
1. I'maclassproperty!
3/24
02/02/12
DefiningCla
Me hod
Me hod areclassspecificfunctions.Individualactionsthatanobjectwillbeabletoperformaredefinedwithintheclassasmethods.
Forinstance,tocreatemethodsthatwouldsetandgetthevalueoftheclassproperty$prop1,addthefollowingtoyourcode:
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
<?php
classMyClass
{
publicfunctionsetProperty($newval)
{
$this>prop1=$newval
}
publicfunctiongetProperty()
{
return$this>prop1." "
}
}
$obj=newMyClass
echo$obj>prop1
?>
No e OOPallowsobjectstoreferencethemselvesusing$this.Whenworkingwithinamethod,use$thisinthesamewayyouwouldusetheobjectname
outsidetheclass.
Tousethesemethods,callthemjustlikeregularfunctions,butfirst,referencetheobjecttheybelongto.ReadthepropertyfromM Class,changeitsvalue,andread
itoutagainbymakingthemodificationsbelow:
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
<?php
classMyClass
{
{
$this>prop1=$newval
}
{
}
}
$obj=newMyClass
echo$obj>getProperty()//Getthepropertyvalue
$obj>setProperty("I'manewpropertyvalue!")//Setanewone
echo$obj>getProperty()//Readitoutagaintoshowthechange
26. ?>
4/24
02/02/12
26. ?>
Reloadyourbrowser,andyou llseethefollowing:
2. I'manewpropertyvalue!
ThepowerofOOPbecomesapparentwhenusingmultipleinstancesofthe
sameclass.
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
<?php
classMyClass
{
{
$this>prop1=$newval
}
{
}
}
//Createtwoobjects
$obj=newMyClass
$obj2=newMyClass
//Getthevalueof$prop1frombothobjects
echo$obj>getProperty()
echo$obj2>getProperty()
//Setnewvaluesforbothobjects
$obj>setProperty("I'manewpropertyvalue!")
$obj2>setProperty("Ibelongtothesecondinstance!")
//Outputbothobjects'$prop1value
echo$obj2>getProperty()
?>
Whenyouloadtheresultsinyourbrowser,theyreadasfollows:
1.
2.
3.
4.
I'maclassproperty!
I'maclassproperty!
I'manewpropertyvalue!
Ibelongtothesecondinstance!
Asyoucansee,OOPkeep objec a epa a een i ie ,whichmakesforeasyseparationofdifferentpiecesofcodeintosmall,relatedbundles.
MagicMe hod inOOP

Tomaketheuseofobjectseasier,PHPalsoprovidesanumberofmagicme hod ,orspecialmethodsthatarecalledwhencertaincommonactionsoccurwithin
objects.Thisallowsdeveloperstoperformanumberofusefultaskswithrelativeease.
5/24
02/02/12
U ingCon
c o andDe
co
Whenanobjectisinstantiated,it softendesirabletosetafewthingsrightoffthebat.Tohandlethis,PHPprovidesthemagicmethod__construct(),whichis
calledautomaticallywheneveranewobjectis
created.
Forthepurposeofillustratingtheconceptofconstructors,addaconstructortoM Classthatwilloutputamessagewheneveranewinstanceoftheclassiscreated:
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
<?php
classMyClass
{
publicfunction__construct()
{
echo'Theclass"',__CLASS__,'"wasinitiated! '
}
{
$this>prop1=$newval
}
{
}
}
//Createanewobject
$obj=newMyClass
//Getthevalueof$prop1
//Outputamessageattheendofthefile
echo"Endoffile. "
?>
No e__CLASS__returnsthenameoftheclassinwhichitiscalledthisiswhatisknownasamagicconstant.Thereareseveralavailablemagicconstants,which
youcanreadmoreaboutinthePHPmanual.
Reloadingthefileinyourbrowserwillproducethefollowingresult:
1. Theclass"MyClass"wasinitiated!
3. Endoffile.
Tocallafunctionwhentheobjectisdestroyed,the__destruct()magicmethodisavailable.Thisisusefulforclasscleanup(closingadatabaseconnection,for
instance).
Outputamessagewhentheobjectisdestroyedbydefiningthemagicmethod
__destruct()inM Class:
1.
2.
3.
4.
5.
<?php
classMyClass
{
6.
6/24
02/02/12
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
{
}
publicfunction__destruct()
{
echo'Theclass"',__CLASS__,'"wasdestroyed. '
}
{
$this>prop1=$newval
}
{
}
}
//Createanewobject
$obj=newMyClass
?>
Withadestructordefined,reloadingthetestfileresultsinthefollowingoutput:
1.
2.
3.
4.
Theclass"MyClass"wasinitiated!
I'maclassproperty!
Endoffile.
Theclass"MyClass"wasdestroyed.
Whentheendofafileisreached,PHPautomaticallyreleasesallresources.
Toexplicitlytriggerthedestructor,youcandestroytheobjectusingthe
function n e ():
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
<?php
classMyClass
{
{
}
{
}
{
$this>prop1=$newval
20. }
7/24
02/02/12
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
{

//Createanewobject
$obj=newMyClass
//Destroytheobject
unset($obj)
?>
Nowtheresultchangestothefollowingwhenloadedinyourbrowser:
1.
2.
3.
4.
I'maclassproperty!
Endoffile.
Con ertingtoaString
ToavoidanerrorifascriptattemptstooutputM Classasastring,anothermagicmethodisusedcalled__toString().
Without__toString(),a emp ing oo p heobjec a a
ing e l inafa ale o .Attempttouseechotooutputtheobjectwithoutamagicmethodinplace:
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
<?php
classMyClass
{
{

{

{
$this>prop1=$newval

{

28. //Createanewobject
8/24
02/02/12
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
//Createanewobject
$obj=newMyClass
//Outputtheobjectasastring
echo$obj
//Destroytheobject
unset($obj)
?>
Thisresultsinthefollowing:
2.
3. Catchablefatalerror:ObjectofclassMyClasscouldnotbeconvertedtostringin/Applications/XAMPP/xamppfiles/htdocs/testing/test.phponline40
Toavoidthiserror,adda__ oS ring()method:
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
41.
42.
43.
<?php
classMyClass
{
{

{

publicfunction__toString()
{
echo"UsingthetoStringmethod:"
return$this>getProperty()

{
$this>prop1=$newval

{

//Createanewobject
$obj=newMyClass
echo$obj
//Destroytheobject
unset($obj)
9/24
02/02/12
43.
44.
45.
46.
?>
Inthiscase,attemptingtoconverttheobjecttoastringresultsinacalltothegetPropert ()method.Loadthetestscriptinyourbrowsertoseetheresult:
1.
2.
3.
4.
Tip
UsingthetoStringmethod:I'maclassproperty!
Endoffile.
Inadditiontothemagicmethodsdiscussedinthissection,severalothersareavailable.Foracompletelistofmagicmethods,seethePHPmanualpage.
U ingCla
Inhe i ance
Cla e caninhe i heme hod andp ope ie ofano he cla usingthee tendskeyword.Forinstance,tocreateasecondclassthatextendsM Classand
addsamethod,youwouldaddthefollowingtoyourtestfile:
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
41.
42.
43.
44.
<?php
classMyClass
{
{
}
{
}
{
}
{
$this>prop1=$newval
}
{
}
}
classMyOtherClassextendsMyClass
{
publicfunctionnewMethod()
{
echo"Fromanewmethodin".__CLASS__.". "
}
}
//Createanewobject
$newobj=newMyOtherClass
10/24
02/02/12
44.
45.
46.
47.
48.
49.
50.
51.
echo$newobj>newMethod()
//Useamethodfromtheparentclass
echo$newobj>getProperty()
?>
Uponreloadingthetestfileinyourbrowser,thefollowingisoutput:
1.
2.
3.
4.
FromanewmethodinMyOtherClass.
I'maclassproperty!
O er ritingInheritedPropertiesandMethods
Tochangethebehaviorofanexistingpropertyormethodinthenewclass,youcansimplyoverwriteitbydeclaringitagaininthenewclass:
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
41.
42.
<?php
classMyClass
{
{

{

{

{
$this>prop1=$newval

{

{
{
echo"Anewconstructorin".__CLASS__.". "

{
43. echo"Fromanewmethodin".__CLASS__.". "
11/24
02/02/12
43.
44.
45.
46.
47.
48.
49.
50.
51.
52.
53.
54.
55.
56.

//Createanewobject
?>
Thischangestheoutputinthebrowserto:
1.
2.
3.
4.
AnewconstructorinMyOtherClass.
I'maclassproperty!
PreservingOriginalMethodFunctionalit WhileOverwritingMethods
Toaddnewfunctionalitytoaninheritedmethodwhilekeepingtheoriginalmethodintact,usetheparen keywordwiththe cope e ol ionope a o (::):
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
<?php
classMyClass
{
{

{

{

{
$this>prop1=$newval

{

{
37. {
12/24
02/02/12
37.
38.
39.
40.
41.
42.
43.
44.
45.
46.
47.
48.
49.
50.
51.
52.
53.
54.
55.
56.
57.
{
parent::__construct()//Calltheparentclass'sconstructor
}
{
}
}
//Createanewobject
?>
Thisoutputstheresultofboththeparentconstructorandthenewclass sconstructor:
1.
2.
3.
4.
5.
I'maclassproperty!
AssigningtheVisibilit ofPropertiesandMethods
Foraddedcontroloverobjects,methodsandpropertiesareassignedvisibility.Thiscontrolshowandfromwherepropertiesandmethodscanbeaccessed.Thereare
threevisibilitykeywords:public,protected,andprivate.Inadditiontoitsvisibility,amethodorpropertycanbedeclaredasstatic,whichallowsthemtobe
accessedwithoutaninstantiationoftheclass.
Foraddedcontroloverobjects,methodsandpropertiesareassignedvisibility.
NoteVisibilityisanewfeatureasofPHP5.ForinformationonOOPcompatibilitywithPHP4,seethePHPmanualpage.
PublicPropertiesandMethods
Allthemethodsandpropertiesyou veusedsofarhavebeenpublic.Thismeansthattheycanbeaccessedanywhere,bothwithintheclassandexternally.
ProtectedPropertiesandMethods
Whenapropertyormethodisdeclaredprotected,itcanonl beaccessedwithintheclassitselforindescendantclasses(classesthatextendtheclass
containingtheprotectedmethod).
DeclarethegetPropert ()methodasprotectedinM Classandtrytoaccessitdirectlyfromoutsidetheclass:
13/24
02/02/12
DeclarethegetPropert ()methodasprotectedinM Classandtrytoaccessitdirectlyfromoutsidetheclass:

1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
41.
42.
43.
44.
45.
46.
47.
48.
49.
50.
51.
52.
53.
54.
<?php
classMyClass
{
{

{

{

{
$this>prop1=$newval

protectedfunctiongetProperty()
{

{
{
parent::__construct()

{

//Createanewobject
//Attempttocallaprotectedmethod
?>
Uponattemptingtorunthisscript,thefollowingerrorshowsup:
1.
2.
3.
4.
Fatalerror:CalltoprotectedmethodMyClass::getProperty()fromcontext''in/Applications/XAMPP/xamppfiles/htdocs/testing/test.phponline55
Now,createanewmethodinM OtherClasstocallthegetPropert ()method:
14/24
02/02/12
Now,createanewmethodinM OtherClasstocallthegetPropert ()method:

1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
41.
42.
43.
44.
45.
46.
47.
48.
49.
50.
51.
52.
53.
54.
55.
56.
57.
58.
59.
<?php
classMyClass
{
{

{

{

{
$this>prop1=$newval

protectedfunctiongetProperty()
{

{
{

{

publicfunctioncallProtected()
{

//Createanewobject
//Calltheprotectedmethodfromwithinapublicmethod
echo$newobj>callProtected()
?>
Thisgeneratesthedesiredresult:
15/24
02/02/12
1.
2.
3.
4.
I'maclassproperty!
Pri atePropertiesandMethods
Apropertyormethoddeclaredprivateisaccessibleonl fromwithintheclassthatdefinesit.Thismeansthate enifane classe tendstheclassthatdefinesa
pri atepropert ,thatpropertyormethodwillnotbeavailableatallwithinthechildclass.
Todemonstratethis,declaregetPropert ()asprivateinM Class,andattempttocallcallProtected()from
M OtherClass:
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
41.
42.
43.
44.
45.
46.
47.
48.
49.
50.
51.
52.
<?php
classMyClass
{
{

{

{

{
$this>prop1=$newval

privatefunctiongetProperty()
{

{
{

{

{

16/24
02/02/12
52.
53.
54.
55.
56.
57.
58.
59.
//Createanewobject
echo$newobj>callProtected()
?>
Reloadyourbrowser,andthefollowingerrorappears:
1.
2.
3.
4.
Fatalerror:CalltoprivatemethodMyClass::getProperty()fromcontext'MyOtherClass'in/Applications/XAMPP/xamppfiles/htdocs/testing/test.phponline49
S a icP ope ie andMe hod

Amethodorpropertydeclaredstaticcanbeaccessedwithoutfirstinstantiatingtheclassyousimplysupplytheclassname,scoperesolutionoperator,andthe
propertyormethodname.
Oneofthemajorbenefitstousingstaticpropertiesisthattheykeeptheirstoredvaluesforthedurationofthescript.
Todemonstratethis,addastaticpropertycalled$countandastaticmethodcalledplusOne()toM Class.Thensetupado...whilelooptooutputthe
incrementedvalueof$countaslongasthevalueislessthan10:
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
<?php
classMyClass
{
publicstatic$count=0
{
}
{
}
{
}
{
$this>prop1=$newval
}
privatefunctiongetProperty()
{
}
publicstaticfunctionplusOne()
{
37. return"Thecountis".++self::$count.". "
17/24
02/02/12
37.
38.
39.
40.
41.
42.
43.
44.
45.
46.
47.
48.
49.
50.
51.
52.
53.
54.
55.
56.
57.
58.
59.
60.
61.
62.
63.
64.
65.
66.
return"Thecountis".++self::$count.". "
}
}
{
{
}
{
}
{
}
}
do
{
//CallplusOnewithoutinstantiatingMyClass
echoMyClass::plusOne()
}while(MyClass::$count<10)
?>
No eWhenaccessingstaticproperties,thedollarsign
($)comesaf e he cope e ol ionope a o .
Whenyouloadthisscriptinyourbrowser,thefollowingisoutput:
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
Thecountis1.
Thecountis2.
Thecountis3.
Thecountis4.
Thecountis5.
Thecountis6.
Thecountis7.
Thecountis8.
Thecountis9.
Thecountis10.
Commenting ithDocBlocks
TheDocBlockcommentingstyleisawidely
acceptedmethodofdocumentingclasses.
WhilenotanofficialpartofOOP,theDocBlockcommentingstyleisawidelyacceptedmethodofdocumentingclasses.Asidefromprovidingastandardfor
developerstousewhenwritingcode,ithasalsobeenadoptedbymanyofthemostpopularsoftwaredevelopmentkits(SDKs),suchasEclipseandNetBeans,and
willbeusedtogeneratecodehints.
ADocBlockisdefinedbyusingablockcommentthatstartswithanadditionalasterisk:
1. /**
2. *ThisisaverybasicDocBlock
3. */
TherealpowerofDocBlockscomeswiththeabilitytouse ag ,whichstartwithanatsymbol( )immediatelyfollowedbythetagnameandthevalueofthetag.
18/24
02/02/12
TherealpowerofDocBlockscomeswiththeabilitytousetags,whichstartwithanatsymbol(@)immediatelyfollowedbythetagnameandthevalueofthetag.
DocBlocktagsallowdeveloperstodefineauthorsofafile,thelicenseforaclass,thepropert ormethodinformation,andotherusefulinformation.
Themostcommontagsusedfollow:
@author:Theauthorofthecurrentelement(whichmightbeaclass,file,method,oranybitofcode)arelistedusingthistag.Multipleauthortagscanbeused
inthesameDocBlockifmorethanoneauthoriscredited.TheformatfortheauthornameisJohnDoe<john.doe@email.com>.
@cop right:Thissignifiesthecopyrightyearandnameofthecopyrightholderforthecurrentelement.Theformatis2010Cop rightHolder.
@license:Thislinkstothelicenseforthecurrentelement.Theformatforthelicenseinformationis
http:// .e ample.com/path/to/license.t tLicenseName.
@var:Thisholdsthetypeanddescriptionofavariableorclassproperty.Theformatist peelementdescription.
@param:Thistagshowsthetypeanddescriptionofafunctionormethodparameter.Theformatist pe$element_nameelementdescription.
@return:Thetypeanddescriptionofthereturnvalueofafunctionormethodareprovidedinthistag.Theformatist pereturnelementdescription.
AsampleclasscommentedwithDocBlocksmightlooklikethis:
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
41.
42.
43.
44.
45.
46.
47.
48.
49.
<?php
/**
*Asimpleclass
*
*Thisisthelongdescriptionforthisclass,
*whichcanspanasmanylinesasneeded.Itis
*notrequired,whereastheshortdescriptionis
*necessary.
*
*Itcanalsospanmultipleparagraphsifthe
*descriptionmeritsthatmuchverbiage.
*
*@authorJasonLengstorf<jason.lengstorf@ennuidesign.com>
*@copyright2010EnnuiDesign
*@licensehttp://www.php.net/license/3_01.txtPHPLicense3.01
*/
classSimpleClass
{
/**
*Apublicvariable
*
*@varstringstoresdatafortheclass
*/
public$foo
/**
*Sets$footoanewvalueuponclassinstantiation
*
*@paramstring$valavaluerequiredfortheclass
*@returnvoid
*/
publicfunction__construct($val)
{
$this>foo=$val

/**
*Multipliestwointegers
*
*Acceptsapairofintegersandreturnsthe
*productofthetwo.
*
*@paramint$batanumbertobemultiplied
*@paramint$bazanumbertobemultiplied
*@returninttheproductofthetwoparameters
*/
publicfunctionbar($bat,$baz)
{
50. return$bat*$baz
19/24
02/02/12
51.
52.
53.
54.
}
}
?>
Onceyouscantheprecedingclass,thebenefitsofDocBlockareapparent:everythingisclearlydefinedsothatthenextdevelopercanpickupthecodeandne e
ha e o onde ha a nippe ofcodedoe o ha i ho ldcon ain.
Compa ingObjec O ien edandP oced alCode

There snotreallyarightandwrongwaytowritecode.Thatbeingsaid,thissectionoutlinesastrongargumentforadoptinganobjectorientedapproachin
softwaredevelopment,especiall inlargeapplications.
Rea on1:Ea eofImplemen a ion

Whileitmaybedauntingatfirst,OOPactuallyprovidesaneasierapproachtodealingwithdata.
Whileitmaybedauntingatfirst,OOPactuallyprovidesaneasierapproachtodealingwithdata.Becauseanobjectcanstoredatainternally,variablesdon tneedto
bepassedfromfunctiontofunctiontoworkproperly.
Also,becausem l iplein ance of he amecla cane i im l aneo l ,dealingwithlargedatasetsisinfinitelyeasier.Forinstance,imagineyouhavetwo
people sinformationbeingprocessedinafile.Theyneednames,occupations,andages.
TheP oced alApp oach

Here stheproceduralapproachtoourexample:
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
<?php
functionchangeJob($person,$newjob)
{
$person['job']=$newjob//Changetheperson'sjob
return$person
}
functionhappyBirthday($person)
{
++$person['age']//Add1totheperson'sage
return$person
}
$person1=array(
'name'=>'Tom',
'job'=>'ButtonPusher',
'age'=>34
)
$person2=array(
'name'=>'John',
'job'=>'LeverPuller',
'age'=>41
)
//Outputthestartingvaluesforthepeople
echo"<pre>Person1:",print_r($person1,TRUE),"</pre>"
//Tomgotapromotionandhadabirthday
$person1=changeJob($person1,'BoxMover')
33. $person1=happyBirthday($person1)
20/24
02/02/12
34.
35.
36.
37.
38.
39.
40.
41.
42.
//Johnjusthadabirthday
$person2=happyBirthday($person2)
//Outputthenewvaluesforthepeople
?>
Whenexecuted,thecodeoutputsthefollowing:
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
Person1:Array
(
[name]=>Tom
[job]=>ButtonPusher
[age]=>34
)
Person2:Array
(
[name]=>John
[job]=>LeverPuller
[age]=>41
)
Person1:Array
(
[name]=>Tom
[job]=>BoxMover
[age]=>35
)
Person2:Array
(
[name]=>John
[job]=>LeverPuller
[age]=>42
)
Whilethiscodeisn tnecessarilybad,there salottokeepinmindwhilecoding.Thearrayoftheaffectedperson sattributesmustbepassedandreturned

fromeachfunctioncall,whichleavesmarginforerror.
Tocleanupthisexample,itwouldbedesirabletoleaveasfewthingsuptothedeveloperaspossible.Onlyabsolutelyessentialinformationforthecurrent
operationshouldneedtobepassedtothefunctions.
ThisiswhereOOPstepsinandhelpsyoucleanthingsup.
TheOOPApp oach
Here stheOOPapproachtoourexample:
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
<?php
classPerson
{
private$_name
private$_job
private$_age
publicfunction__construct($name,$job,$age)
{
$this>_name=$name
$this>_job=$job
$this>_age=$age
}
15.
16. publicfunctionchangeJob($newjob)
21/24
02/02/12
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
41.
42.
43.
44.
45.
46.
publicfunctionchangeJob($newjob)
{
$this>_job=$newjob
}
publicfunctionhappyBirthday()
{
++$this>_age
}
}
//Createtwonewpeople
$person1=newPerson("Tom","ButtonPusher",34)
$person2=newPerson("John","LeverPuller",41)
//Outputtheirstartingpoint
//GiveTomapromotionandabirthday
$person1>changeJob("BoxMover")
$person1>happyBirthday()
//Johnjustgetsayearolder
$person2>happyBirthday()
//Outputtheendingvalues
?>
Thisoutputsthefollowinginthebrowser:
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
Person1:PersonObject
(
[_name:private]=>Tom
[_job:private]=>ButtonPusher
[_age:private]=>34
)
(
[_name:private]=>John
[_job:private]=>LeverPuller
[_age:private]=>41
)
(
[_name:private]=>Tom
[_job:private]=>BoxMover
[_age:private]=>35
)
(
[_name:private]=>John
[_job:private]=>LeverPuller
[_age:private]=>42
)
There salittlebitmoresetupinvolvedtomaketheapproachobjectoriented,butaftertheclassisdefined,creatingandmodifyingpeopleisabreezeaperson s
informationdoesnotneedtobepassedorreturnedfrommethods,andonlyabsolutelyessentialinformationispassedtoeachmethod.
OOPwillsignificantlyreduceyourworkloadifimplementedproperly.
22/24
02/02/12
Onthesmallscale,thisdifferencemaynotseemlikemuch,butasyourapplicationsgrowinsize,OOPwillsignificantlyreduceyourworkloadifimplemented
properly.
TipNoteverythingneedstobeobjectoriented.Aquickfunctionthathandlessomethingsmallinoneplaceinsidetheapplicationdoesnotnecessarilyneedtobe
wrappedinaclass.Useyourbestjudgmentwhendecidingbetweenobjectorientedandproceduralapproaches.
Reason2:BetterOrgani ation
AnotherbenefitofOOPishowwellitlendsitselftobeingeasil packagedandcataloged.Eachclasscangenerallybekeptinitsownseparatefile,andifa
uniformnamingconventionisused,accessingtheclassesisextremelysimple.
Assumeyou vegotanapplicationwith150classesthatarecalleddynamicallythroughacontrollerfileattherootofyourapplicationfilesystem.All150classes
followthenamingconventioncla .cla name.inc.phpandresideintheincfolderofyourapplication.
ThecontrollercanimplementPHP s__a oload()functiontodynamicallypullinonlytheclassesitneedsastheyarecalled,ratherthanincludingall150inthe
controllerfilejustincaseorcomingupwithsomecleverwayofincludingthefilesinyourowncode:
1.
2.
3.
4.
5.
6.
<?php
function__autoload($class_name)
{
include_once'inc/class.'.$class_name.'.inc.php'
}
?>
Havingeachclassinaseparatefilealsomakescodemoreportableandeasiertoreuseinnewapplicationswithoutabunchofcopyingandpasting.
Reason3:EasierMaintenance
DuetothemorecompactnatureofOOPwhendonecorrectly,changesinthecodeareusuall mucheasiertospotandmakethaninalongspaghetticode
proceduralimplementation.
Ifaparticulararrayofinformationgainsanewattribute,aproceduralpieceofsoftwaremayrequire(inaworstcasescenario)thatthenewattributebeaddedtoeach
functionthatusesthearray.
AnOOPapplicationcouldpotentiallybeupdatedaseasilyaddingthenewpropertyandthenaddingthemethodsthatdealwithsaidproperty.
AlotofthebenefitscoveredinthissectionaretheproductofOOPincombinationwithDRYprogrammingpractices.Itisdefinitelypossibletocreateeasyto
maintainproceduralcodethatdoesn tcausenightmares,anditisequallypossibletocreateawfulobjectorientedcode.[ProPHPandjQuery]willattemptto
demonstrateacombinationofgoodcodinghabitsinconjunctionwithOOPtogeneratecleancodethat seasytoreadandmaintain.
Summar
Atthispoint,youshouldfeelcomfortablewiththeobjectorientedprogrammingstyle.LearningOOPisagreatwaytotakeyourprogrammingtothatnextlevel.
Whenimplementedproperly,OOPwillhelpyouproduceeasytoread,easytomaintain,portablecodethatwillsaveyou(andthedeveloperswhoworkwithyou)
hoursofextrawork.Areyoustuckonsomethingthatwasn tcoveredinthisarticle?AreyoualreadyusingOOPandhavesometipsforbeginners?Sharethemin
thecomments!
Author sNote ThistutorialwasanexcerptfromProPHPandjQuery(Apress,2010).
Like
397 people like hi .
Tags:objectorientedprogrammingoopphpPHP
23/24
02/02/12
Tags:objectorientedprogrammingoopphpPHP
B JasonLengstorf
JasonLengstorfisa25 earoldturbogeekhailingfromPortland,Oregon,whodesignsanddevelopswebsitesfor
CopterLabs.He'stheauthorofPHPforAbsoluteBeginners[2009Apress]andProPHPandjQuer [2010Apress],
aswellasarticlesforvariousonlinepublications.
24/24

Object-Oriented PHP For Beginners - Nettuts+

Încărcat de

Informații document

Descriere originală:

Titlu original

Drepturi de autor

Formate disponibile

Partajați acest document

Partajați sau inserați document

Opțiuni de partajare

Vi se pare util acest document?

Este necorespunzător acest conținut?

Drepturi de autor:

Formate disponibile

Object-Oriented PHP For Beginners - Nettuts+

Încărcat de

Drepturi de autor:

Formate disponibile

02/02/12

Object-Oriented PHP for Beginners Nettuts+

Object-Oriented PHP for Beginners Nettuts+

Object-Oriented PHP for Beginners Nettuts+

Object-Oriented PHP for Beginners Nettuts+

Object-Oriented PHP for Beginners Nettuts+

Asyoucansee,OOPkeep objec a epa a een i ie ,whichmakesforeasyseparationofdifferentpiecesofcodeintosmall,relatedbundles.

MagicMe hod inOOP

Object-Oriented PHP for Beginners Nettuts+

Object-Oriented PHP for Beginners Nettuts+

Object-Oriented PHP for Beginners Nettuts+

ing e l inafa ale o .Attempttouseechotooutputtheobjectwithoutamagicmethodinplace:

Object-Oriented PHP for Beginners Nettuts+

Object-Oriented PHP for Beginners Nettuts+

Object-Oriented PHP for Beginners Nettuts+

Object-Oriented PHP for Beginners Nettuts+

Object-Oriented PHP for Beginners Nettuts+

Object-Oriented PHP for Beginners Nettuts+

DeclarethegetPropert ()methodasprotectedinM Classandtrytoaccessitdirectlyfromoutsidetheclass:

Now,createanewmethodinM OtherClasstocallthegetPropert ()method:

Object-Oriented PHP for Beginners Nettuts+

Now,createanewmethodinM OtherClasstocallthegetPropert ()method:

Object-Oriented PHP for Beginners Nettuts+

Object-Oriented PHP for Beginners Nettuts+

S a icP ope ie andMe hod

Object-Oriented PHP for Beginners Nettuts+

Object-Oriented PHP for Beginners Nettuts+

Object-Oriented PHP for Beginners Nettuts+

Compa ingObjec O ien edandP oced alCode

Rea on1:Ea eofImplemen a ion

TheP oced alApp oach

Object-Oriented PHP for Beginners Nettuts+

Whilethiscodeisn tnecessarilybad,there salottokeepinmindwhilecoding.Thearrayoftheaffectedperson sattributesmustbepassedandreturned

Object-Oriented PHP for Beginners Nettuts+

Object-Oriented PHP for Beginners Nettuts+

397 people like hi .

Object-Oriented PHP for Beginners Nettuts+

S-ar putea să vă placă și