add_banner
add_banner_type
banners_script
check_banner
create_selection_list_banner_types
create_selection_list_banners
delete_banner
delete_banner_type
edit_banner
edit_banner_type
get_banner_form_fields
render_banner_box
render_banner_type_box
show_banner
BANNER_CAMPAIGN
BANNER_DEFAULT
BANNER_PERMANENT
add_banner(\ID_TEXT $name, \URLPATH $imgurl, \SHORT_TEXT $title_text, \SHORT_TEXT $caption, \LONG_TEXT $direct_code, \?integer $campaignremaining, \URLPATH $site_url, integer $importancemodulus, \LONG_TEXT $notes, \SHORT_INTEGER $the_type, \?TIME $expiry_date, \?MEMBER $submitter, \BINARY $validated= 0
, \ID_TEXT $b_type= ''
, \?TIME $time= null
, integer $hits_from= 0
, integer $hits_to= 0
, integer $views_from= 0
, integer $views_to= 0
, \?TIME $edit_date= null
, boolean $uniqify= false
) : \ID_TEXT
package | banners |
---|---|
range | 0 max |
range | 1 max |
set | 0 1 2 |
\ID_TEXT
The name of the banner
\URLPATH
The URL to the banner image
\SHORT_TEXT
The title text for the banner (only used for text banners, and functions as the 'trigger text' if the banner type is shown inline)
\SHORT_TEXT
The caption of the banner
\LONG_TEXT
Complete HTML/PHP for the banner
\?integer
The number of hits the banner may have (null: not applicable for this banner type)
\URLPATH
The URL to the site the banner leads to
integer
The banners "importance modulus"
\LONG_TEXT
Any notes associated with the banner
\SHORT_INTEGER
The type of banner (0=permanent, 1=campaign, 2=default)
\?TIME
The banner expiry date (null: never)
\?MEMBER
The banners submitter (null: current member)
\BINARY
Whether the banner has been validated
\ID_TEXT
The banner type (can be anything, where blank means 'normal')
\?TIME
The time the banner was added (null: now)
integer
The number of return hits from this banners site
integer
The number of banner hits to this banners site
integer
The number of return views from this banners site
integer
The number of banner views to this banners site
\?TIME
The banner edit date (null: never)
boolean
Whether to force the name as unique, if there's a conflict
\ID_TEXT
The nameadd_banner_type(\ID_TEXT $id, \BINARY $is_textual, integer $image_width, integer $image_height, integer $max_file_size, \BINARY $comcode_inline, boolean $uniqify = false
) : \ID_TEXT
package | banners |
---|
\ID_TEXT
The ID of the banner type
\BINARY
Whether this is a textual banner
integer
The image width (ignored for textual banners)
integer
The image height (ignored for textual banners)
integer
The maximum file size for the banners in Kilobytes (this is a string length for textual banners)
\BINARY
Whether the banner will be automatically shown via Comcode hot-text (this can only happen if banners of the title are given title-text)
boolean
Whether to force the name as unique, if there's a conflict
\ID_TEXT
The namebanners_script(boolean $ret= false
, \?string $type= null
, \?string $dest= null
, \?string $b_type= null
, \?string $source= null
, \?integer $width= null
, \?integer $height= null
) : \?Tempcode
package | banners |
---|---|
set | "click" "" |
boolean
Whether to return a result rather than outputting
\?string
Whether we are displaying or click-processing (null: get from URL param)
\?string
Specific banner to display (null: get from URL param) (blank: randomise)
\?string
Banner type to display (null: get from URL param)
\?string
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)
\?integer
The width (null: standard for banner type)
\?integer
The height (null: standard for banner type)
\?Tempcode
Result (null: we weren't asked to return the result)check_banner(\SHORT_TEXT $title_text= ''
, \LONG_TEXT $direct_code= ''
, \ID_TEXT $b_type= ''
, string $url_param_name= 'image_url'
, string $file_param_name= 'file'
) : array
package | banners |
---|
\SHORT_TEXT
The title text for the banner (only used for text banners, and functions as the 'trigger text' if the banner type is shown inline)
\LONG_TEXT
Complete HTML/PHP for the banner
\ID_TEXT
The banner type (can be anything, where blank means 'normal')
string
Param name for possible URL field
string
Param name for possible upload field
array
A pair: The URL, and the title textcreate_selection_list_banner_types(\?ID_TEXT $it = null
) : \Tempcode
package | banners |
---|
\?ID_TEXT
The currently selected licence (null: none selected)
\Tempcode
The list of categoriescreate_selection_list_banners(\?AUTO_LINK $it= null
, \?MEMBER $only_owned= null
) : \Tempcode
package | banners |
---|
\?AUTO_LINK
The ID of the banner selected by default (null: no specific default)
\?MEMBER
Only show banners owned by the member (null: no such restriction)
\Tempcode
The listdelete_banner(\ID_TEXT $name)
delete_banner_type(\ID_TEXT $id)
edit_banner(\ID_TEXT $old_name, \ID_TEXT $name, \URLPATH $imgurl, \SHORT_TEXT $title_text, \SHORT_TEXT $caption, \LONG_TEXT $direct_code, \?integer $campaignremaining, \URLPATH $site_url, integer $importancemodulus, \LONG_TEXT $notes, \SHORT_INTEGER $the_type, \?TIME $expiry_date, \?MEMBER $submitter, \BINARY $validated, \ID_TEXT $b_type, \?TIME $edit_time= null
, \?TIME $add_time= null
, boolean $null_is_literal= false
, boolean $uniqify= false
) : \ID_TEXT
package | banners |
---|---|
range | 0 max |
range | 1 max |
set | 0 1 2 |
\ID_TEXT
The current name of the banner
\ID_TEXT
The new name of the banner
\URLPATH
The URL to the banner image
\SHORT_TEXT
The title text for the banner (only used for text banners, and functions as the 'trigger text' if the banner type is shown inline)
\SHORT_TEXT
The caption of the banner
\LONG_TEXT
Complete HTML/PHP for the banner
\?integer
The number of hits the banner may have (null: not applicable for this banner type)
\URLPATH
The URL to the site the banner leads to
integer
The banners "importance modulus"
\LONG_TEXT
Any notes associated with the banner
\SHORT_INTEGER
The type of banner (0=permanent, 1=campaign, 2=default)
\?TIME
The banner expiry date (null: never)
\?MEMBER
The banners submitter (null: leave unchanged)
\BINARY
Whether the banner has been validated
\ID_TEXT
The banner type (can be anything, where blank means 'normal')
\?TIME
Edit time (null: either means current time, or if $null_is_literal, means reset to to NULL)
\?TIME
Add time (null: do not change)
boolean
Determines whether some NULLs passed mean 'use a default' or literally mean 'set to NULL'
boolean
Whether to force the name as unique, if there's a conflict
\ID_TEXT
The nameedit_banner_type(\ID_TEXT $old_id, \ID_TEXT $id, \BINARY $is_textual, integer $image_width, integer $image_height, integer $max_file_size, \BINARY $comcode_inline, boolean $uniqify = false
) : \ID_TEXT
package | banners |
---|
\ID_TEXT
The original ID of the banner type
\ID_TEXT
The ID of the banner type
\BINARY
Whether this is a textual banner
integer
The image width (ignored for textual banners)
integer
The image height (ignored for textual banners)
integer
The maximum file size for the banners in Kilobytes (this is a string length for textual banners)
\BINARY
Whether the banner will be automatically shown via Comcode hot-text (this can only happen if banners of the title are given title-text)
boolean
Whether to force the name as unique, if there's a conflict
\ID_TEXT
The nameget_banner_form_fields(boolean $simplified= false
, \ID_TEXT $name= ''
, \URLPATH $image_url= ''
, \URLPATH $site_url= ''
, \SHORT_TEXT $caption= ''
, \LONG_TEXT $direct_code= ''
, \LONG_TEXT $notes= ''
, integer $importancemodulus= 3
, \?integer $campaignremaining= 50
, \SHORT_INTEGER $the_type= 1
, \?TIME $expiry_date= null
, \?MEMBER $submitter= null
, \BINARY $validated= 1
, \ID_TEXT $b_type= ''
, \SHORT_TEXT $title_text= ''
) : array
package | banners |
---|---|
range | 1 max |
range | 0 max |
set | 0 1 2 |
boolean
Whether to simplify the banner interface (for the Point Store buy process)
\ID_TEXT
The name of the banner
\URLPATH
The URL to the banner image
\URLPATH
The URL to the site the banner leads to
\SHORT_TEXT
The caption of the banner
\LONG_TEXT
Complete HTML/PHP for the banner
\LONG_TEXT
Any notes associated with the banner
integer
The banners "importance modulus"
\?integer
The number of hits the banner may have (null: not applicable for this banner type)
\SHORT_INTEGER
The type of banner (0=permanent, 1=campaign, 2=default)
\?TIME
The banner expiry date (null: never expires)
\?MEMBER
The banners submitter (null: current member)
\BINARY
Whether the banner has been validated
\ID_TEXT
The banner type (can be anything, where blank means 'normal')
\SHORT_TEXT
The title text for the banner (only used for text banners, and functions as the 'trigger text' if the banner type is shown inline)
array
A pair: The input field Tempcode, JavaScript coderender_banner_box(array $row, \ID_TEXT $zone= '_SEARCH'
, boolean $give_context= true
, \ID_TEXT $guid= ''
) : \Tempcode
package | banners |
---|
array
The database field row of it
\ID_TEXT
The zone to use
boolean
Whether to include context (i.e. say WHAT this is, not just show the actual content)
\ID_TEXT
Overridden GUID to send to templates (blank: none)
\Tempcode
A box for it, linking to the full pagerender_banner_type_box(array $row, \ID_TEXT $zone= '_SEARCH'
, boolean $give_context= true
, \ID_TEXT $guid= ''
) : \Tempcode
package | banners |
---|
array
The database field row of it
\ID_TEXT
The zone to use
boolean
Whether to include context (i.e. say WHAT this is, not just show the actual content)
\ID_TEXT
Overridden GUID to send to templates (blank: none)
\Tempcode
A box for it, linking to the full pageshow_banner(\ID_TEXT $name, \SHORT_TEXT $title_text, \Tempcode $caption, \LONG_TEXT $direct_code, \URLPATH $img_url, \ID_TEXT $source, \URLPATH $url, \ID_TEXT $b_type, \MEMBER $submitter, \?integer $width= null
, \?integer $height= null
) : \Tempcode
package | banners |
---|
\ID_TEXT
The name of the banner
\SHORT_TEXT
The title text of the banner (displayed for a text banner only)
\Tempcode
The caption of the banner
\LONG_TEXT
The full HTML/PHP for the banner
\URLPATH
The URL to the banner image
\ID_TEXT
The name of the banner for the site that will get the return-hit (blank: none)
\URLPATH
The URL to the banner's target
\ID_TEXT
The banner type
\MEMBER
The submitting user
\?integer
The width (null: standard for banner type)
\?integer
The height (null: standard for banner type)
\Tempcode
The rendered banner