1. Einleitung2. ÜberblickVisitors3. InstallationvonVisitors4. ÜbersichtFrontend/Backend

i. Backendii. Frontend

5. ErsteSchrittei. AnlegeneinerKategorieii. AnlegendesBesucherzählersiii. AnlegendesFrontend-Modulsiv. DemoCSSDateiaktivieren

6. Feinheiteni. FeinheitenBesucherzähler-Definitionii. FeinheitenFrontend-Modul-Definition

7. Insert-Tagsi. Anzeigeii. Zählungiii. WeitereInsert-Tags

8. Besonderheiteni. KeineZählungii. BesucherproTag:Ø=0iii. BotDetectionabschalten

9. Datenschutzi. Datenerfassungii. Datenspeicherungiii. Datenhaltung

Inhaltsverzeichnis

HandbuchfürdieContao4ErweiterungVisitorsBundle-

-2-

DiesistdasHandbuchfürAnwendervonVisitorsBundle.DieneusteVersionistunterdocs.contao.ninjazufinden.

ÜberblickVisitorsInstallationvonVisitorsÜbersichtFrontend/Backend

BackendFrontend

ErsteSchritteAnlegeneinerKategorieAnlegendesBesucherzählersAnlegendesFrontend-ModulsDemoCSSDateiaktivieren

FeinheitenFeinheitenBesucherzähler-DefinitionFeinheitenFrontend-Modul-Definition

Insert-TagsAnzeigeZählungWeitereInsert-Tags

BesonderheitenKeineZählungBesucherproTag:Ø=0BotDetectionabschalten

DatenschutzDatenerfassungDatenspeicherungDatenhaltung

AlldocumentationsofBugBuster1701@GitHublicensedunderaCreativeCommonsAttribution3.0License(CCBY-NC-SA3.0).Ifyouwanttoredistributeamodifiedorunmodifiedversionofthedocumentation,youcandosounderthelicenseterms.

Ifyoucontributetothedocumentation,e.g.bycreatingpullrequests,yougrantusfullusagerightsofanycontentyoucreateorupload.Youalsoensurethatyourcontentdoesnotviolateanythird-partyrights.

Wearenotclaimingexclusiveusagerights,thereforeyouarefreetouseyourcontributedcontent(e.g.textsorimages)inanyotherprojectaswell.

HandbuchfürdieContao4ErweiterungVisitorsBundle

Inhaltsverzeichnis

Licence

HandbuchfürdieContao4ErweiterungVisitorsBundle-Einleitung

-3-

HandbuchfürdieContao4ErweiterungVisitorsBundle-Einleitung

-4-

VisitorsBundle,imweiteremkurzVisitors,isteineErweiterungwelchedieZugriffe(Hits)undBesucher(Visits)zähltundzurAnzeigebringenkann.ImBackendgibteseineStatistikübersicht.

DabeiwirdinderAnzeigegetrenntangezeigtdieZugriffe/BesuchervomaktuellemTagsowiediejeweiligeGesamtzahl.

DerZugriffszählerwird,wiederNameschonsagt,beijedemZugrifferhöht.DerBesucherzählerzeigtdieZahlderunterschiedlichenIP-Adressen,dieinnerhalbvon30MinuteneineodermehrereSeitenangeforderthabenaufdemsichdieErweiterungbefindet.(siehedazuauchBlockzeit)

VisitorsbenutztinAbhängigkeitdieErweiterung"BotDetectionBundle".Damitwirdverhindert,dassZugriffevonBots/Suchmaschinengezähltwerden.Eine100%igeSicherheitgibtesdabeinatürlichnicht.

Information Link

EntwicklerWebseite http://contao.ninja

LinkzumExtensionRepository(Packagist) Packagist.org

DenEntwicklerunterstützen AmazonWunschliste

Fehler/Wünschemelden GitHub

ContaoForumfürFragen community.contao.org

DieÜbersetzungenderTextevonVisitorsimBackendundFrontendwerdenmitTransifexverwaltet.UmeineneueÜbersetzungerstellenoderumeinevorhandenezukorrigieren,müssenSiesichbeitransifex.comregistrieren.BasisspracheistEnglisch.

ProjektLink:https://www.transifex.com/projects/p/contao-visitors-bundle/

Howto(english):http://docs.transifex.com/faq/#translating

Überblick

HilfreicheLinks

Übersetzungen

HandbuchfürdieContao4ErweiterungVisitorsBundle-ÜberblickVisitors

-5-

EsgibtzweiArtenderInstallation.

mitdemContao-Manager,nurfürdieContaoManaged-EditonüberdieKommandozeile,fürContaoStandard-EditionundManaged-Editon

Hinweis:VisitorsBundleistabhängigvondenErweiterungen"BotDetectionBundle"und"phpoffice/phpexcel",diesewerdenautomatischmitinstalliert.

LinkzuPackagist:VisitorsBundleaufPackagist.org

SuchedasPaket:bugbuster/contao-visitors-bundleInstallationderErweiterungKlickauf"InstallTool"AnmeldenundDatenbankUpdatedurchführen

InstallationineinerComposer-basierendenContao4.3+Managed-Edition:

composerrequire"bugbuster/contao-visitors-bundle"

Aufrufhttp://deinedomain/contao/installDatenbankUpdatedurchführen

InstallationineinerComposer-basierendenContao4.3+Standard-Edition:

composerrequire"bugbuster/contao-visitors-bundle"

Einfügeninapp/AppKernel.phpfolgendeZeileamEndedesArray$bundles:

newBugBuster\VisitorsBundle\BugBusterVisitorsBundle(),

Cacheleerenundneuanlegenlassen:

vendor/bin/contao-consolecache:clear--env=prod

vendor/bin/contao-consolecache:warmup-eprod

Aufrufhttp://deinedomain/contao/installDatenbankUpdatedurchführen

InstallationvonVisitorsBundle

InstallationüberContao-Manager

InstallationüberdieKommandozeile

InstallationineinerContaoManaged-Edition

InstallationineinerContaoStandard-Edition

HandbuchfürdieContao4ErweiterungVisitorsBundle-InstallationvonVisitors

-6-

DieVisitorsErweiterungbringtzweiBackend-undeinFrontend-Modulmit.ImBackendgibtesdasModul"Besucher",hierwerdendieBesucherzählerdefiniertundersteEinstellungendurchgeführt,sowiedasModul"Besucherstatistik",hiersinddieStatistikdateneinsehbar.

FürdasFrontendgibtesdasModul"Besucher".DurchAuswahleinesdermitgeliefertenTemplateskannesentwedernurzählenoderauchdieSummenderBesucherundZugriffeanzeigen.

DetailsdazufolgenindennächstenKapiteln.

ÜbersichtFrontend/Backend

HandbuchfürdieContao4ErweiterungVisitorsBundle-ÜbersichtFrontend/Backend

-7-

DasBesucherModulistunterInhalte->Besucherzufinden.

DasBesucherstatistikModulistunterSystem->Besucherstatistikzufinden.

EszeigtdanndieStatistikenfürdenangelegtenBesucherzähler.Hatmanmehrereangelegt,z.B.füreineMultidomainInstallation,kannderBesucherzählerausgewähltwerden.

EineAuswahlderStatistiken:

Backend

Besucher

Besucherstatistik

HandbuchfürdieContao4ErweiterungVisitorsBundle-Backend

-8-

HandbuchfürdieContao4ErweiterungVisitorsBundle-Backend

-9-

(TOP20Listensindgekürzt.)

HandbuchfürdieContao4ErweiterungVisitorsBundle-Backend

-10-

FürdasFrontendwerdenzweiCSS-DateienalsBeispielfüreineAnzeigeformatierungmitgeliefert:

mod_visitors_fe.cssfürdienormale,zeilenweiseAusgabemod_visitors_fe_horizontal.cssfürdiehorizontaleAusgabe

DieseDateienliegenimUnterverzeichniscss_demo.ZurVerwendungsieheCSS-Datei

AnsichtbeiVerwendungdesTemplatesmod_visitors_fe_all:

AnsichtbeiVerwendungdesTemplatesmod_visitors_fe_all:

Frontend

Besucherstatistikzeilenweise

Besucherstatistikhorizontal

HandbuchfürdieContao4ErweiterungVisitorsBundle-Frontend

-11-

AlsersteswirdüberdenMenüpunktBesuchereineneueBesucher-Kategorieangelegt.IndieserdanndenBesucherzähler.

DanachwirdeinFrontend-ModulangelegtundbautesindasLayoutderSeiteein.(z.B.in'left')

HiernundieeinzelnenSchritte,jeweilsmitdenDefault-Angaben.Feinheitenwerdenspätererklärt.

ErsteSchritte

HandbuchfürdieContao4ErweiterungVisitorsBundle-ErsteSchritte

-12-

UmeineneueBesucher-Kategoriezuerstellen,wirdimBackendunterInhalte->BesucherimHauptbereichderLink'NeueKategorie'ausgewählt.

AmAnfangreichteseinenKategorie-Namenanzugeben,anschließendeinKlickauf"SpeichernundSchließen".NunwirddieKategorieÜbersichtangezeigt.DurchKlickaufdenBleistiftinderZeilederKategorieundnochmaligemKlickaufdenBleistiftimKopfderKategoriegelangtmanwiederzudenEinstellungenderKategorie.

AnlegeneinerKategorie

HandbuchfürdieContao4ErweiterungVisitorsBundle-AnlegeneinerKategorie

-13-

InderKategorieÜbersichtkanndurcheinKlickaufEdit(Bleistift)derKategorieeinneuerBesucherzählerangelegtwerden.Dortentwederauf'NeuerBesucherzähler'unddanndasPfeil-SymboloderaufdasPlusimKopfderKategorie:

NunsindeinigeAngabennötig:

Namenangeben(wirdüberdenZahlenalsÜberschriftangezeigt).Start-Datum,istoptional,dientnurzurAnzeigeimFrontendOptional:'StartwertefürZähler'eingebenOptional:'BesucherproTag'Anzeigeaktivieren"Veröffentlicht"aktivieren

anschließendeinKlickauf"SpeichernundSchließen".

AnlegendesBesucherzählers

HandbuchfürdieContao4ErweiterungVisitorsBundle-AnlegendesBesucherzählers

-14-

EinneuesFrontend-Modulwirdangelegtüber:

Layout->Themes->FrontendModule->NeuesModul

AlserstesdenTiteleingeben,dannbeiModultyp:'Verschiedenes'-'Besucher'auswählen.EsändernsichnundieFormularfelder.Bei'Besucherkategorie'nundievorherangelegteKategorieauswählen,anschließend'SpeichernundSchließen'.

NunmussdasangelegteFrontend-ModulnochimLayouteingebundenwerden:

Layout->Themes->Seitenlayout->EditdesgenutzteLayouts

Bei'EingebundeneModule'dasgeradeerstellteFrontend-Moduleinbinden(z.B.inleft)

AnlegendesFrontend-Moduls

HandbuchfürdieContao4ErweiterungVisitorsBundle-AnlegendesFrontend-Moduls

-15-

WieerwähntsindzweiCSS-DateienmitgeliefertfürdieDarstellung.FürdieerstenTestssolltedieDateimod_visitors_fe.cssausdemVerzeichnis/web/bundles/bugbustervisitors/css_demoaufdenlokalemPCkopiertwerdenunddannüberdasBackendimportiert(Themes->CSS->Import)undimLayoutaktiviertwerden.

DemoCSSDateiaktivieren

HandbuchfürdieContao4ErweiterungVisitorsBundle-DemoCSSDateiaktivieren

-16-

FeinheitensindeinstellbarinderKategorie,imBesucherzählerselbstsowieimselbstangelegtemFrontend-Modul.DasbetrifftdiebishernichterwähntenFormularfeldersowiedieunterschiedlichenFrontendTemplatesdiemitgeliefertwerden.

Feinheiten

HandbuchfürdieContao4ErweiterungVisitorsBundle-Feinheiten

-17-

DieBlockzeitwirdinSekundenangegeben.NachZugriffspausedieserZeitwirdeinZugriffvonderselbenIPalsweitererBesuchergezählt.

Voreingetragensind1800Sekunden,d.h.30Minuten.

FeinheitenBesucherzähler-Definition

Blockzeit

HandbuchfürdieContao4ErweiterungVisitorsBundle-FeinheitenBesucherzähler-Definition

-18-

JedemFrontendModulkannperAuswahleinTemplatezugeordnetwerden.ZurAuswahlstehen4Templates:

mod_visitors_fe_all

LiefertalleFelderdiemöglichsind(sieheBeispielbildoben)mod_visitors_fe_hits

HierwurdendiebeidenBesucherzeilenentferntmod_visitors_fe_visits

HierwurdendiebeidenZugriffszeilenentferntmod_visitors_fe_invisible

Hierwirdnichtsangezeigt.DiesesTemplatedientdadurchzurreinenZählung.

EskönneneigeneTemplateserstelltwerden.DiesemüssenalsDateinameanfangenmitmod_visitors_fe_unddieEndung.html5haben.

NachdemAktivierendieserFunktionwirddasFrontendModulversteckt,sobaldeinMitglied(Frontend-Nutzer)angemeldetist.

Hierkannnundefiniertwerden,dassdieAnzeigedesModulsnurdannerfolgt,wennMitgliederbestimmterGruppenonlinesind.

EsgabeinigeIdeen,wiemannochverhindernkann,eigeneZugriffenichtzuzählen.Besonders,wennmanmitdynamischenIPsankommt.HieristnuneineMöglichkeitumgesetzt,diesesübereinenangepasstenUserAgentStringdesBrowserszutun.

Über:

Layout->Themes->Frontend-Module->Modul-Name

vomangelegtemBesucher-ModulkannimFeld"KeineZählungbeiHTTP_USER_AGENTTeilkennung:"einenStringeingegebenwerden,diesersollteeindeutigsein.Beispiel:CTISOK

Essind,wozuauchimmer,auchmehrereStringsdortmöglich,diesedanndurchKommagetrennteingeben.

InälterenBrowsernkonntedurchAnpassungderKonfigurationdesBrowsersderAgentStringangepasstwerden.AktuellsollteeinAdd-Ondazugenutztwerden.FürFirefoxwäredaszumBeispielderUser-Agent-Switcher

FeinheitenFrontend-Modul-Definition

Templates

NurGästenanzeigen

Modulschützen

Selbstzählungverhindern

HandbuchfürdieContao4ErweiterungVisitorsBundle-FeinheitenFrontend-Modul-Definition

-19-

HandbuchfürdieContao4ErweiterungVisitorsBundle-FeinheitenFrontend-Modul-Definition

-20-

DieInsert-TagswerdenvomFrontendModulselbstbenutzt.EinNutzerbenötigtdiesenur,wenndasFrontendModulnichteingesetztwird.DerEinsatzistdahernuretwasfürfortgeschritteneNutzer.

Insert-Tags

HandbuchfürdieContao4ErweiterungVisitorsBundle-Insert-Tags

-21-

EsgibtfolgendeInsert-TagszumAnzeigenderWerte:

{{visitors::katid::name}}

{{visitors::katid::online}}

{{visitors::katid::start}}

{{visitors::katid::totalvisit}}

{{visitors::katid::totalhit}}

{{visitors::katid::todayvisit}}

{{visitors::katid::todayhit}}

{{visitors::katid::yesterdayvisit}}

{{visitors::katid::yesterdayhit}}

{{visitors::katid::averagevisits}}

{{visitors::katid::pagehits}}

DieInsert-TagskönnenumdenPräfix'cache_'erweitertwerden,damitsinddiesedannauchsichervordemCache.Dasbedeutet,dassselbstwenndieSeiteausdemContaoCachekommt,werdenvordemSendenzumBrowserdieWertenochaktualisiert.

{{cache_visitors::katid::name}}

...

DasModulzähltundzeigtnormalerweisedieWertean.WerfürdieAnzeigedieInsert-Tagsnutzenwill,brauchtdasModulweiterhin,abernurzumZählen.MittelsdesTemplatesmod_visitors_fe_invisiblekannesdazuunsichtbargeschaltetwerden.

Die"katid"istdieKategorie-ID,indemderZählerangelegtwurde.ZurErmittlungindieKategorieübersichtgehen,dortstehtdieIDdirekthinterdemKategorie-Namen.

BeiKategorie-ID=1wäredasdannalsobeispielsweise:

{{cache_visitors::1::online}}

Anzeige

HandbuchfürdieContao4ErweiterungVisitorsBundle-Anzeige

-22-

EineAlternativefür"nurzählen"wäre,denInsert-Tagzunutzen,dasModulselbstverwendetdiesenebenfalls:

{{cache_visitors::katid::count}}

BeispielfürEinbauineinenArtikel(fürKategorie-ID=1):

<spanstyle="width:0px;height:0px;">{{cache_visitors::1::count}}</span>

Achtung:Dabeimussdraufgeachtetwerden,dassderInsert-TagfürdieZählungalserstesaufderSeiteeingebautwird,damitdieZählungvorderErmittlungderAnzeigewerteerfolgt.

Zählung

HandbuchfürdieContao4ErweiterungVisitorsBundle-Zählung

-23-

EsgibtInsert-TagszumAnzeigenderWertevomTag,andemdiemeistenBesuchergezähltwurden.

{{visitors::katid::bestday::date}}-Tag(Datum)mitdenmeistenBesuchern

{{visitors::katid::bestday::visits}}-AnzahlBesuchervomTagmitdenmeistenBesuchern

{{visitors::katid::bestday::hits}}-AnzahlZugriffevomTagmitdenmeistenBesuchern

bzw.

{{cache_visitors::katid::bestday::date}}

{{cache_visitors::katid::bestday::visits}}

{{cache_visitors::katid::bestday::hits}}

Beim"date"Insert-TagistnocheinoptionalerParametermöglich,umdieDatumsausgabezuformatieren.(m.d.Y,Y-m-d,etc.)

AlsdefaultwirddieSystemeinstellungverwendet.AlsTrennzeichenmussein"::"verwendetwerden.EinkomplettesBeispiel(hiermitKategorie1):

BestDay:{{visitors::1::bestday::date::j.FY}}mit{{visitors::1::bestday::visits}}Besuchern

(bei{{visitors::1::bestday::hits}}Hits)

ergibtzumBeispiel:

BestDay:31.August2010mit25Besuchern(bei123Hits)

WeitereInsert-Tags

HandbuchfürdieContao4ErweiterungVisitorsBundle-WeitereInsert-Tags

-24-

HierfolgeneinigeBesonderheitendiezubeachtensind.

Besonderheiten

HandbuchfürdieContao4ErweiterungVisitorsBundle-Besonderheiten

-25-

EswirdkeinFrontend-Aufrufgezählt,wennderselbeNutzerdabeigleichzeitigimBackendangemeldetist.EsmusseinFrontendModulangelegtundeingebundenwerden,bzw.alsAlternativederInsert-TagfürdieZählung(nurfürProfis),sonstkannnatürlichnichtgezähltwerden.

KeineZählung

HandbuchfürdieContao4ErweiterungVisitorsBundle-KeineZählung

-26-

DerDurschnittswertproTagwirdprovollständigemKalendertagberechnet.GibtesnurvoneinemTagvorherodergarnurvomaktuellemTageineZählung,kannkeinsinnvollerWertberechnetwerden.(Durschnitt=AnzahlBesucher)

IndiesenFällenwird"0"angezeigt.

BesucherproTag:Ø=0

HandbuchfürdieContao4ErweiterungVisitorsBundle-BesucherproTag:Ø=0

-27-

WerdieZugriffevonBotsundSuchmaschinenmitzählenmöchte,kanndieBotDetectionabschalten.DasgehtallerdingsnichtüberdasBackend,sondernmussüberdielocalconfig.phppassieren.

Achtung:DasgiltdannfüralleBesucher-Module,fallsmehrereFrontendModuleangelegtwurden!

FolgenderEintragansEndederlocalconfig.php(nach:###INSTALLSCRIPTSTOP###)bewirktdasAusschalten:

$GLOBALS['TL_CONFIG']['mod_visitors_bot_check']=false;

BotDetectionabschalten

HandbuchfürdieContao4ErweiterungVisitorsBundle-BotDetectionabschalten

-28-

EinigeWortezumThemaDatenschutz.ImGegensatzzudenmeistenanderenBesucherstatistik-Tools,speichertVisitorsnichtdieRohdatenundwertetdiesespäteraus.DienotwendigenAuswertungenwerdensofortausgeführt.GespeichertwerdenalsodiefertigenStatistikDaten,mitAusnahmederIP-Adresse,siehedazudieHinweiseindenweiterenKapiteln.SomitistdasZielderDatenvermeidungundDatenminimierungbestmöglicherreicht.

Datenschutz

HandbuchfürdieContao4ErweiterungVisitorsBundle-Datenschutz

-29-

ZurErkennungvonunterschiedlichenBesuchernwirdausschließlichdieIP-Adressegenommen,keinJavaScript,keineCookies.

FürzusätzlicheStatistikenwirdderBrowser-AgentausgelesenundderReferrersofernvorhanden.BeideswirdunabhängigvonderIP-AdressegetrenntgespeichertundkannsomitauchnichtinVerbindunggebrachtwerden.(reineZählung)

Datenerfassung

IP-Adresse

Browser-AgentundReferrer

HandbuchfürdieContao4ErweiterungVisitorsBundle-Datenerfassung

-30-

GespeichertwirdnichtdieIP-AdressedesBesuchers.MitAusnahmezurErkennungvonBots/Crawler/SpidernwirddieIP-AdresseauchnichtzuweiterenAnalysezweckenverwendet.

AusderIP-AdresseundweitereninternenDatenwirdeinPseudonymgeneriertinFormeinesHashwertes.EinRückrechnenistdenkbar,abernurmiterheblichemAufwand.DerHashwertwirdmitkeineranderenstatistischenAuswertunginVerbindunggebracht.

FürdenBrowser-AgentwerdendieKombinationenausBrowser,Sprache,OSmiteinemZählstandgespeichert,nichtderkompletteAgentString.

BeimReferrerwirddieURLgespeichertmitZählstandundZeitstempeldesletztenAuftretens,ohneVerbindungzurIP-AdresseoderBrowser-Agent.

Datenspeicherung

IP-Adresse

Browser-AgentundReferrer

HandbuchfürdieContao4ErweiterungVisitorsBundle-Datenspeicherung

-31-

DieHashwertezurErkennungvonunterschiedlichenBesuchernwerdenbeijedemAufrufgeprüft,zeitlichabgelaufendewerdendabeigelöscht.HaltezeitentsprichtdabeiderBlockzeit,Default-Wertist1800Sekunden,d.h.30Minuten.

ReferrerWertewerdenjenachArtderzeitnach90bzw.120Tagengelöscht.

DieAnzahlderBesucher/ZugriffejeTagwirddauerhaftgespeichert,darauswerdendieweiterenAnzeigengeneriert.DieseSpeicherungkannüberdasBackendgelöschtwerden,derZählerfängtdannwiederbei0an.

Datenhaltung

HandbuchfürdieContao4ErweiterungVisitorsBundle-Datenhaltung

-32-