CoreAPI
[ class tree: CoreAPI ] [ index: CoreAPI ] [ all elements ]

Procedural File: collapse_api.php

Source Location: /core/collapse_api.php



Page Details:

Collapse API

collapse_open( 'xyz' ); # marks the start of the expanded section : ... collapse_icon( 'xyz' ); # this will add the '+' icon : collapse_closed( 'xyz' ); # marks the start of the collapsed section : ... collapse_icon( 'xyz' ); # this will add the '-' icon : collapse_end( 'xyz' ); # marks the end of the whole section




Tags:

copyright:  Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
copyright:  Copyright (C) 2002 - 2010 MantisBT Team - mantisbt-dev@lists.sourceforge.net
link:  http://www.mantisbt.org
uses:  tokens_api.php
uses:  gpc_api.php
uses:  utility_api.php
uses:  config_api.php
uses:  authentiction_api.php
uses:  current_user_api.php


Includes:

require_once('tokens_api.php') [line 47]
requires tokens_api




string $g_collapse_cache_token [line 65]

Default value:   null


[ Top ]



string $g_current_collapse_section [line 53]

Default value:   null


[ Top ]



bool $g_open_collapse_section [line 59]

Default value:   false


[ Top ]






collapse_cache_token [line 199]

void collapse_cache_token( )

Cache collapse API data from the database for the current user.

If the collapse cookie has been set, grab the changes and resave the token, or touch it otherwise.




[ Top ]



collapse_closed [line 99]

void collapse_closed( string $p_name, [string $p_section = ''])

Marks the end of a collapse block's open phase and the beginning of the block's closed phase. Thi will only be visible if the block have been collapsed and javascript is enabled.



Parameters

string   $p_name   Collapse block name
string   $p_section   Collapse block section
[ Top ]



collapse_display [line 184]

bool collapse_display( string $p_block)

Determine if a block should be displayed open by default.



Parameters

string   $p_block   Collapse block
[ Top ]



collapse_end [line 154]

void collapse_end( string $p_name, [string $p_section = ''])

Marks the end of a collaps block's closed phase.

Closed phase output is discarded if javascript is disabled.




Parameters

string   $p_name   Collapse block name
string   $p_section   Collapse block section
[ Top ]



collapse_icon [line 127]

void collapse_icon( string $p_name, [string $p_section = ''])

Marks the location where a +/- icon is placed in output for the user to toggle the collapse block status.

This should appear in both the open and closed phase of a block.




Parameters

string   $p_name   Collapse block name
string   $p_section   Collapse block section
[ Top ]



collapse_open [line 74]

void collapse_open( string $p_name, [string $p_section = ''])

Marks the beginning of a collapse block's open phase.

This will be visible if the block is expanded, or if javascript is disabled.




Parameters

string   $p_name   Collapse block name
string   $p_section   Collapse block section
[ Top ]



Documentation generated on Sun, 12 Dec 2010 23:50:14 +0900 by phpDocumentor 1.4.3
inserted by FC2 system