Studenten Net Twente making the net wiki work

This is an old revision of the document!


PlayGround

    Tag Plugin

    tag wiki pages

    $tag = plugin_load('helper', 'tag');

    $tag->th()

    Descriptionreturns the header for the tags column for pagelist
    Return valueheaderstring

    $tag->td()

    Descriptionreturns the tag links of a given page
    Parametersidstring
    Return valuelinksstring

    $tag->tagLinks()

    Descriptiongenerates tag links for given words
    Parameterstagsarray
    Return valuelinksstring

    $tag->getTopic()

    Descriptionreturns a list of pages tagged with the given keyword
    Parametersnamespace (optional)string
    number (not used)integer
    tag (required)string
    Return valuepagesarray

    $tag->tagRefine()

    Descriptionrefines an array of pages with tags
    Parameterspages to refinearray
    refinement tagsstring
    Return valuepagesarray

    $tag->tagOccurrences()

    Descriptionreturns a list of tags with their number of occurrences
    Parameterslist of tags to get the occurrences forarray
    namespaces to which the search shall be restrictedarray
    if all tags shall be returned (then the first parameter is ignored)boolean
    if the namespaces shall be searched recursivelyboolean
    Return valuetagsarray

    Pagelist Plugin

    Lists pages in a nice formatted way

    $pagelist = plugin_load('helper', 'pagelist');

    $pagelist->addColumn()

    Descriptionadds an extra column for plugin data
    Parametersplugin namestring
    column keystring

    $pagelist->setFlags()

    Descriptionoverrides standard values for showfooter and firstseconly settings
    Parametersflagsarray
    Return valuesuccessboolean

    $pagelist->startList()

    Descriptionprepares the table header for the page list

    $pagelist->addPage()

    Descriptionadds a page to the list
    Parameterspage attributes, 'id' required, others optionalarray

    $pagelist->finishList()

    Descriptionreturns the XHTML output
    Return valuexhtmlstring
    playground/playground.1246054007.txt.gz · Last modified: 2009/06/26 22:06 by jeroen