/sources/banners.php

Description
Functions
banners_script (line 33)

Show a banner according to GET parameter specification.

  • return: Result (NULL: we weren't asked to return the result)
?tempcode banners_script ([boolean $ret = false], [?string $type = NULL], [?string $dest = NULL], [?string $b_type = NULL], [?integer $internal_only = NULL], [?string $source = NULL])
  • boolean $ret: Whether to return a result rather than outputting
  • ?string $type: Whether we are displaying or click-processing (NULL: get from URL param)
  • ?string $dest: Specific banner to display (NULL: get from URL param) (blank: randomise)
  • ?string $b_type: Banner type to display (NULL: get from URL param)
  • ?integer $internal_only: Whether we are only showing our own banners, rather than allowing external rotation ones (NULL: get from URL param)
  • ?string $source: The banner advertisor who is actively displaying the banner (calling up this function) and hence is rewarded (NULL: get from URL param) (blank: our own site)
nice_get_banners (line 330)

Get a list of banners.

  • return: The list
tempcode nice_get_banners ([?AUTO_LINK $it = NULL], [?MEMBER $only_owned = NULL])
  • ?AUTO_LINK $it: The ID of the banner selected by default (NULL: no specific default)
  • ?MEMBER $only_owned: Only show banners owned by the member (NULL: no such restriction)
nice_get_banner_types (line 230)

Get a nice, formatted XHTML list to select a banner type

  • return: The list of categories
tempcode nice_get_banner_types ([?ID_TEXT $it = NULL])
  • ?ID_TEXT $it: The currently selected licence (NULL: none selected)
show_banner (line 263)

Get the tempcode for the display of the defined banner.

tempcode show_banner (ID_TEXT $name, SHORT_TEXT $title_text, tempcode $caption, URLPATH $img_url, ID_TEXT $source, URLPATH $url, ID_TEXT $b_type)
  • ID_TEXT $name: The name of the banner
  • SHORT_TEXT $title_text: The title text of the banner (displayed for a text banner only)
  • tempcode $caption: The caption of the banner
  • URLPATH $img_url: The URL to the banner image
  • ID_TEXT $source: The name of the banner for the site that will get the return-hit
  • URLPATH $url: The URL to the banner's target
  • ID_TEXT $b_type: The banner type

Documentation generated on Sun, 02 Jan 2011 23:08:58 +0000 by phpDocumentor 1.4.3