Objektorientering med klasser i PHP

By . Latest revision .

Du skall skapa ett antal klasser i PHP. Dessa klasser skall du sedan använda i ett par webbsidor och visa upp att de fungerar.

Du använder namespace i dina klasser.

Dina webbsidor placerar du bakom en frontcontroller och du lägger till en “snygg ram” med header, footer och navigering på sidorna.

Du använder vyer för att rendera webbsidorna och som vyspråk kan du använda ren PHP eller så använder du ett vy-lib.

Eventuella externa moduler installeras med composer och du använder dig av composers autoloader.

Webbplatsen publiceras på studentservern.

Du samlar allt i ett Git-repo som du publicerar på en tjänst likt GitHub/GitLab.

Ditt repo innehåller en Makefile som kan användas för att linta din kod. Linters installeras med composer.

#Förkunskaper

Du kan PHP.

Du vet hur man bygger en webbplats och du har koll på GET, POST och SESSION samt vyer.

Du har PHP i din path i terminalen och du har installerat composer.

Du kan grunderna i Git och webbtjänster likt GitHub/GitLab.

Du kan en del allmänt om problemlösning och programmering och vet grunderna i hur du tar reda på svar. Glöm inte att formulera din fråga, svaret är då lättare att finna. Fråga ankan, det kan hjälpa.

#Introduktion och förberedelse

Gör följande steg för att förbereda dig för uppgiften.

#Spara filerna i me

Alla filerna sparar du i ditt kursrepo under me/game/.

Alla referenser till filer och kataloger du nu skall skapa förutsätter att de ligger under denna katalogen.

#Gör ett Git repo

Gör ett git-repo av katalogen.

git init
touch README.md
git add .
git commit -m "First commit"

Du har nu ett git-repo. Vill du lära dig mer om Git kan du läsa mer i “Work with Git” som ger dig en snabb introduktion till de vanligaste kommandona i Git.

#GitHub/GitLab

Ladda upp ditt repo till en webbtjänst likt GitHub eller GitLab (eller motsvarande).

Det mest lämpliga är att använda SSH-nycklar för att identifiera dig, det blir så mycket enklare än HTTPS där du behöver skriva lösenord varje gång du laddar upp repot.

#Webbapplikation med frontcontroller

Du skall bygga en webbapplikation som fungerar lokalt och på studentservern.

Skapa en underkatalog htdocs/ där du placerar de filerna som är din så kallade webb root.

Det finns ett kodexempel i kursrepot under example/game/frontcontroller/ som du kan/bör utgå ifrån. Det ger din en snabb start in i uppgiften med en enklare bas av en frontcontroller och en .htaccess som fungerar både lokalt och på studentservern samt de kodvalideringsverktyg som är nödvändiga.

Du kan komma igång snabbt så här.

# Stå i roten av kursrepot

# Börja kopiera kodbasen
rsync -av example/game/frontcontroller/ me/game/

# Installera en autoloader via composer
cd me/game
composer install --no-dev

Nu kan du öppna din webbläsare till katalogen me/game/htdocs och du bör se en enklare webbsida.

Det kan vara läge att bekanta sig med kodbasen. Tanken är att du skall stoppa in din egen kod i den.

Här är en kort översikt av katalogstrukturen.

Katalog Beskrivning
config/ Här kan du spara alla dina konfigurationsfiler.
htdocs/ Webbrooten med den publika delen för webbplatsen och frontcontrollern som tar alla requester till webbplatsen.
src/ Källkodsfiler för PHP, organiserade i katalogstruktur enligt namespace.
view/ Template- och layout-filer för vyer och rendering av webbsidor.

#Alternativ för kodbasen

Du kan även skriva din kodbas helt från ett tomt blad, eller gå direkt på att använda ett ramverk. Du behöver inte använda alla delar i den föreslagna kodbasen, men…

Men, den breda och rekommenderade vägen är att utgå från mallen och sedan justera den efter ditt eget tycke när du väl har kommit igång. Vi kommer att blanda in ramverk senare i kursen så det blir tid att skriva om denna inledande kod så att den passar in i ett ramverk.

I denna inledande uppgift handlar det mest om att skriva och använda klasser i PHP. I kommande uppgifter så kikar vi mer på den delen som berör ramverket.

Här är ett längre inlägg om varför man bör utgå från den givna mallen, iallafall inledningsvis i kursen.

#CSS

Du väljer själv hur du vill jobba med stylesheeten och CSS/LESS/SASS och eventuella ramverk eller ej.

#Javascript

Du väljer själv om du vill komplettera med JavaScript eller ej på klientsidan. Det är dock inget som krävs för att lösa uppgifterna i kursen.

#Publicera studentservern

Du kan nu publicera till studentservern.

Innan du gör det så behöver du ändra sökvägarna i htdocs/.htaccess, annars får du 404 på länkar. Läs kommentaren överst i filen och gör som det står där.

Publicera sedan till studentservern för att se att allt fungerar.

Första gången kan du publicera hela me-katalogen.

dbwebb publishpure me

Sedan räcker det att enbart publicera en specifik katalog.

dbwebb publishpure game

#Make

Dubbelkolla att du har Make installerat och att det fungerar.

which make
make --version

Du kan nu köra kommandot överst i din katalog där du har filen Makefile. I filen Makefile finns ett antal targets som kan utföras. När du enbart kör kommandot make så kommer dess första target att exekveras.

make

Ett target är en samling kommandon som exekveras. Man kan kedja så att ett target exekverar ett eller flera targets.

Öppna filen Makefile i en texteditor och studera dess innehåll.

Installera nu en lokal utvecklingsmiljö i repot.

make install

Du kan nu testa vilken version av olika verktyg som är installerade lokalt som en utvecklingmiljö för ditt repo.

make check-version

Du kan testköra testsviten som finns, om det nu finns några tester att köra.

make test

Du kommer använda kommandot make för att jobba med dina enhetstester, längre fram i kursen.

#Linters

När du gör make install så installeras en lokal utvecklingsmiljö i repot. Det är bra så att du slipper “skräpa ned” din lokala dator med installation av dessa verktyg.

I exemplet example/game/frontcontroller/ finns ett antal linters inkluderade och de skall användas igenom hela kursen som ett sätt att kvalitetssäkra din kod.

Här är en kort översikt av några av de viktigaste linters som är inkluderade.

Verktyg Make target Beskrivning
phpcs make phpcs Validera kodstilen enligt en kodstandard.
phpcbf make phpcbf Automaträtta de fel som phpcs anger.
phpcpd make phpcpd Copy and paste detector, hittar kod som är duplicerad.
phpmd make phpmd Mess detector för att finna delar i din kod som kan förbättras.
phpstan make phpstan Ytterligare en mess detector för att finna delar i din kod som kan förbättras.
phploc make phploc Visa mätvärden och statistik för din kod (metrics).

Du skall köra make test och då körs de linters som är aktuella. De felmeddelanden och varningar som du får är rekommendationer till att förbättra din kod.

Det blir inte underkänt om du har ett stort antal varningar, men du bygger bättre och snyggare kod med högra kvalitet ju färre varningar du visar upp. Så är det.

#Namespace och autoloader

Kodbasen använder composers autoloader för att sköta laddning av klassfiler.

Du skall lägga till ditt eget vendornamn i composer.json och sedan använda det som utgångspunkt för din egen kod.

Denna del ser nu ut så här i kodbasen.

"autoload": {
    "psr-4": {
        "Mos\\": "src/"
        "Dbwebb\\": "src/"
    },
    "files": [
        "src/functions.php"
    ]
},

Vendornamnet Mos\ är det som jag använt för exempelkoden. Låt det vara kvar.

Vendornamnet Dbwebb\ är ytterligare ett exempel på vendornamn. Det kan du byta ut till ditt eget. Ett vendornamn är en koppling till dig själv (eller organisationen/företaget) som skapar koden.

Använd gärna ett namn som inte redan finns i paketdatabasen Packagist. Om du är osäker kan du tex använda din studentakronym eller ditt användarid på GitHub/GitLab.

När du placerar ett vendornamn i composer.json så sker en koppling mellan namnet och var dess källkod placeras.

Du måste generera en ny autoloader varje gång du uppdaterar din composer.json, det gör du med följande kommando.

# Uppdatera composers generereade autoloader filer
composer dump

När du anger ett namespace i en fil så måste små och stora bokstäver i dess namespace matcha exakt den sökväg där filen ligger.

Som ett exempel kan du se följande.

# Namespace för en klass
namespace Mos\Router;
class Router {}

Följande stämmer nu.

  • Klassens namepace blir alltså Mos\Router\Router.
  • Vendornamn Mos\ pekar ut katalogen src/.
  • Klassens källkod ligger i filen src/Router/Router.php.

#Docker

Detta stycket är överkurs och utanför kursens omfång. Detta förutsätter att du har kommandon för docker och docker-compose installerade på din dator.

Det finns en fil docker-compose.yaml som underlättar om du vill köra webbplatsen i en docker-container.

# Starta php/apache i en kontainer
docker-compose up apache

# Kör bash i en kontainer
docker-compose run php bash

#Krav

Kraven är uppdelade i sektioner.

#Struktur

  1. Din källkod placerar du i src/.

  2. Dina vyer placerar du i view/.

  3. I den mån du använder konfigurationsfiler så placerar du dem under config/.

  4. Det finns ingen anledning att lägga till “webbsidor” direkt i htdocs/, allt hanteras via din frontcontroller.

  5. Om du lägger till andra paket med composer så måste de finnas med i din composer.json.

  6. Du behöver ha en Makefile som stödjer make install och make test på det viset som den bifogade Makefilen gör.

  7. Lägg till en README.md till ditt repo och skriv något representativt i den. I slutändan bör den innehålla dokumentationen av ditt repo.

  8. Du skall skapa och använda ett eget namespace för din kod samt uppdatera så att ditt namespace fungerar i composers autoloader.

#Klasser

Under ditt eget namespace, skapa följande efter bästa förmåga.

  1. Skapa en klass Dice.

    1. Man skall kunna slå/kasta/rulla tärningen.
    2. Man skall kunna hämta senaste slaget.
    3. Det skall vara konfigurerbart hur många sidor tärningen har.
  2. Skapa en klass GraphicalDice.

    1. Den kan göra allt som Dice kan plus att den även kan ha en grafisk representation som visar upp en tärning.
    2. Denna tärning skall ha 6 sidor.
  3. Skapa en klass DiceHand som kan innehålla ett antal tärningar.

    1. Man kan konfigurera objektet hur många tärningar det skall innehålla.
    2. Man kan rulla alla tärningar på en gång.
    3. Man kan hämta värdena på de rullade tärningarna.

#Spel

  1. Använd ovan klasser för att skapa en webbsida där man kan spela 21 mot datorn.

  2. Man skall kunna välja om man vill spela med en eller två tärningar.

  3. Man kastar tärningarna och får ett resultat. Därefter kan man kasta igen för att få mer poäng. Man skall komma så närma 21 som möjligt.

  4. När spelaren är nöjd så kan den “stanna”.

  5. Om spelaren får 21 skall du notera ett stort “Grattis!”.

  6. Om spelaren får över 21 så har den förlorat.

  7. Därefter är det datorns tur. För att göra det enkelt kan du låta datorn slå tills den vunnit eller tills den får över 21. Datorn vinner vid lika.

  8. När datorn slagit sina slag så visar du vem som vann denna rundan.

  9. Spara undan ställningen i antal rundor, vem som vunnit, spelaren eller datorn. Det skall finnas en möjlighet att nollställa poängställningen.

  10. Se till att man når ditt spel via en länk “Game 21” i navbaren för din webbsida.

  11. Som ren överkurs kan du välja att implementera att du kan satsa “bitcoins” i varje spelrunda. Spelaren kan börja med 10 bitcoins och man kan satsa max 50% av sina bitcoins per spel. Banken (datorn) kan ha 100 bitcoins när du börjar. Klarar du av att vinna alla pengarna från banken?

#Publicera

  1. När du är klar, kör make test för att köra alla testerna mot ditt repo. När man kör make test så bör det passera utan allvarliga felmeddelanden.

  2. Dubbelkolla att webbplatsen fungerar på studentservern genom att göra en dbwebb publishpure me och testköra den.

  3. Committa alla filer till ditt repo och lägg till en ny tagg (1.0.*). Öka versionnumret om du lägger till ändringar (1.0.1, 1.0.2 och så vidare). Rättaren kommer normalt sett att använda din senaste tagg som är >= 1.0.0 och > 2.0.0.

  4. Pusha upp repot till GitHub/GitLab, inklusive taggarna.

#Tips från coachen

Gör små commits och committa ofta, när du väl har din bas. Använd tydliga committ-meddelanden så att historiken ser bra ut.

Lycka till och hojta till i chatt och forum om du behöver hjälp!

#Revision history

  • 2021-03-29: (B, mos) Lade till not om composer dump.
  • 2021-03-22: (A, mos) Första utgåvan.

Document source.

Category: kurs mvc.