contenido\includes\functions.stat.php

Show: PublicProtectedPrivateinherited
    Table of Contents
    Project: Contenido Content Management System

    Description: Define the "stat" related functions

    Requirements:

    Author
    Olaf Niemann  
    Con_php_req
    5.0  
    Copyright
    four for business AG  
    License
    http://www.contenido.org/license/LIZENZ.txt  
    Link
    http://www.4fb.de  
    Link
    http://www.contenido.org  
    Package
    Contenido Backend includes  
    Since
    file available since contenido release <= 4.6 {@internal created 2002-03-02 modified 2008-06-26, Frederic Schneider, add security fix modified 2008-07-22, Ingo van Peeren, fixed SQL syntax error due to security fix modified 2009-10-23, Murat Purc, removed deprecated function (PHP 5.3 ready) and commented code $Id: functions.stat.php 1085 2009-10-24 02:01:34Z xmurrix $: }}  
    Version
    1.0.3  

    Functions

    functionbuildHeapTable(string $sHeapTable, \DB_Contenido $db) : void

    Deletes existing heap table (table in memory) and creates it.

    Parameters
    NameTypeDescription
    $sHeapTablestring

    Table name

    $db\DB_Contenido

    Database object

    functionstatCreateLocationString(int $idcat, string $seperator, string $cat_str) : void

    Generates the location string for passed category id.

    Performs a recursive call, if parent category doesn't matches to 0

    Parameters
    NameTypeDescription
    $idcatint

    The category id

    $seperatorstring

    Separator for location string

    $cat_strstring

    The location string variable (reference)

    functionstatDisplayTopChooser(\none $default) : string

    Returns a drop down to choose the stats to display

    Parameters
    NameTypeDescription
    $default\none
    Returns
    TypeDescription
    stringReturns a drop down string
    Details
    Author
    Timo A. Hummel  
    Copyright
    four for business AG  
    functionstatDisplayYearlyTopChooser(\none $default) : string

    Returns a drop down to choose the stats to display for yearly summary pages

    Parameters
    NameTypeDescription
    $default\none
    Returns
    TypeDescription
    stringReturns a drop down string
    Details
    Author
    Timo A. Hummel  
    Copyright
    four for business AG  
    functionstatGetAvailableMonths(mixed $year,  $client,  $lang) : array

    Return an array with all months for a specific year which are available as stat files

    Parameters
    NameTypeDescription
    $yearmixed

    many

    $client
    $lang
    Returns
    TypeDescription
    arrayArray of strings with months.
    Details
    Author
    Timo A. Hummel  
    Copyright
    four for business AG  
    functionstatGetAvailableYears(mixed $client,  $lang) : array

    Return an array with all years which are available as stat files

    Parameters
    NameTypeDescription
    $clientmixed

    many

    $lang
    Returns
    TypeDescription
    arrayArray of strings with years.
    Details
    Author
    Timo A. Hummel  
    Copyright
    four for business AG  
    functionstatResetStatistic(int $client) : void

    Resets the statistic for passed client

    Parameters
    NameTypeDescription
    $clientint

    Id of client

    functionstatReturnCanonicalMonth(int $month) : string

    Returns the canonical month.

    Wrapper for function getCanonicalMonth()

    Parameters
    NameTypeDescription
    $monthint

    The digit representation of a month

    Returns
    TypeDescription
    stringTextual representation of a month
    functionstatsArchive( $yearmonth) : \none

    Archives the current statistics

    Parameters
    NameTypeDescription
    $yearmonth

    String with the desired archive date (YYYYMM)

    Returns
    TypeDescription
    \none
    functionstatsDisplayInfo(int $id, string $type, int $x, int $y, int $w, int $h) : string

    Displays statistic information layer (a div Tag)

    Parameters
    NameTypeDescription
    $idint

    Either article or directory id

    $typestring

    The type

    $xint

    Style top position

    $yint

    Style left position

    $wint

    Style width

    $hint

    Style height

    Returns
    TypeDescription
    stringComposed info layer
    functionstatsOverviewAll( $yearmonth) : \none

    Generates a statistics page

    Parameters
    NameTypeDescription
    $yearmonth

    Specifies the year and month from which to retrieve the statistics, specify "current" to retrieve the current entries

    Returns
    TypeDescription
    \none
    Details
    Author
    Jan Lengowski @modified Timo A. Hummel  
    Copyright
    four for business AG  
    functionstatsOverviewTop( $yearmonth,  $top) : \none

    Generates a top statistics page

    Parameters
    NameTypeDescription
    $yearmonth

    Specifies the year and month from which to retrieve the statistics, specify "current" to retrieve the current entries

    $top

    Specifies the amount of pages to display

    Returns
    TypeDescription
    \none
    Details
    Author
    Timo A. Hummel  
    Copyright
    four for business AG  
    functionstatsOverviewTopYear( $year,  $top) : \none

    Generates a top statistics page

    Parameters
    NameTypeDescription
    $year

    Specifies the year from which to retrieve the statistics

    $top

    Specifies the amount of pages to display

    Returns
    TypeDescription
    \none
    Details
    Author
    Timo A. Hummel  
    Copyright
    four for business AG  
    functionstatsOverviewYear( $year) : \none

    Generates a statistics page for a given year

    Parameters
    NameTypeDescription
    $year

    Specifies the year to retrieve the statistics for

    Returns
    TypeDescription
    \none
    Details
    Author
    Jan Lengowski @modified Timo A. Hummel  
    Copyright
    four for business AG  
    Documentation was generated by phpDocumentor 2.0.0a12.