* - package (optional) creates a page to 'Package'.ucfirst( $package ) and takes precedence over $page, should both be set. * only dispalyed if help is enabled * - install (optional) used for packages that require a separate installation * passed in as an array: * package => name of package to be installed * file => path to installation file e.g.: admin/install.php * - page (optional) page name on bitweaver * only dispalyed if help is enabled * - force (optional) if set, it will always dipslay this entry regardless of the feature settings */ function smarty_function_formhelp( $pParams, &$pSmarty=NULL ) { $atts = $ret_note = $ret_page = $ret_link = $ret_install = ''; if( !empty( $pParams['hash'] ) ) { $hash = &$pParams['hash']; } else { // maybe params were passed in separately $hash = &$pParams; } $force = 'n'; // we need to do some hash modification if we're in the installer if( !empty( $hash['is_installer'] )) { if( !empty( $hash['note']['upgrade'] )) { $hash['note']['version'] = $hash['note']['upgrade']; unset( $hash['note']['upgrade'] ); } } foreach( $hash as $key => $val ) { switch( $key ) { case 'note': case 'warning': case 'link': case 'page': $rawHash[$key] = $val; break; case 'label': case 'package': case 'install': case 'force': $$key = $val; break; default: if( $val ) { $atts .= $key.'="'.$val.'" '; } break; } } if( !empty( $package ) ) { $rawHash['page'] = ucfirst( $package ).'Package'; } // if link was passed in as a string, convert it into an array if( !empty( $rawHash['link'] ) && is_string( $rawHash['link'] ) ) { $l = explode( '/', $rawHash['link'] ); unset( $rawHash['link'] ); // package is first, title last, and all remaining elements file (can be 'foo/bar.php' as well) $rawHash['link']['package'] = array_shift( $l ); $rawHash['link']['title'] = array_pop( $l ); $rawHash['link']['file'] = implode( '/', $l ); } global $gBitSystem; if( $gBitSystem->isFeatureActive( 'site_online_help' ) || $gBitSystem->isFeatureActive( 'site_form_help' ) || $force == 'y' ) { if( !empty( $rawHash ) ) { if( !empty( $rawHash['page'] ) && ( $gBitSystem->isFeatureActive('site_online_help') || $force == 'y' ) ) { $ret_page = ''.KernelTools::tra( 'Online help' ).': <a class=\'external\' href=\'https://bitweaver.org/wiki/index.php?page='.$rawHash['page'].'\'>'.$rawHash['page'].'</a> '; } if( !empty( $rawHash['link'] ) && ( $gBitSystem->isFeatureActive('site_online_help') || $force == 'y' ) ) { if( is_array( $rawHash['link'] ) ) { $ret_link = ''.KernelTools::tra( 'IntraLink' ).': '; $ret_link .= '<a href=\''; $ret_link .= constant( strtoupper( $rawHash['link']['package'] ).'_PKG_URL' ).$rawHash['link']['file']; $ret_link .= '\'>'.KernelTools::tra( $rawHash['link']['title'] ).'</a>'; } } if( ( !empty( $rawHash['note'] ) && $gBitSystem->isFeatureActive('site_form_help') ) || ( !empty( $force ) && !empty( $rawHash['note'] ) ) ) { if( is_array( $rawHash['note'] ) ) { foreach( $rawHash['note'] as $name => $value ) { if( $name == 'install' ) { $ret_install = ''.KernelTools::tra( 'Install' ).': '.KernelTools::tra( 'To use this package, you will first have to run the package specific installer' ).': '; $ret_install .= '<a href=\''; $ret_install .= constant( strtoupper( $value['package'] ).'_PKG_URL' ).$value['file']; $ret_install .= '\'>'.ucfirst( $value['package'] ).'</a>'; } else { $ret_note .= ''.ucfirst( KernelTools::tra( $name ) ).': '.KernelTools::tra( $value ).' '; } } } else { $ret_note .= KernelTools::tra( $rawHash['note'] ).' '; } } if( !empty( $rawHash['warning'] ) ) { $ret_note .= ''.KernelTools::tra( $rawHash['warning'] ).' '; } // join all the output content into one string $content = $ret_note.$ret_page.$ret_link.$ret_install; $html = ''; // using the overlib popup system if( !empty( $content ) ) { if( $gBitSystem->isFeatureActive('site_help_popup') ) { global $gBitSmarty; // $gBitSmarty->loadPlugin( 'smarty_modifier_popup' ); // $gBitSmarty->loadPlugin( 'smarty_function_biticon' ); $gBitSmarty->assign( 'title',KernelTools::tra('Extended Help') ); $gBitSmarty->assign( 'content', $content ); $gBitSmarty->assign( 'closebutton', TRUE ); $text = $gBitSmarty->fetch('bitpackage:kernel/popup_box.tpl'); $text = preg_replace( '/"/',"'",$text ); $popup = [ 'trigger' => 'onclick', 'text' => $text, 'fullhtml' => '1', 'sticky' => '1', 'timeout' => '8000', ]; $biticon = [ 'ipackage' => 'icons', 'iname' => 'dialog-information', 'iforce' => 'icon', 'iexplain' => 'Extended Help', ]; $html .= ' '; $html .= '<a '.smarty_function_popup( $popup, $pSmarty ).'>'; $html .= smarty_function_biticon( $biticon ); $html .= '</a>'; $html .= ''; } else { $html .= ''.$content.''; } } return $html; } } }

is printed * only displayed if site_form_help is enabled * - link (optional) provide a link to an internal page (avoids the problem with links being inerpreted * prematurely by the KernelTools::tra() function * // * - package (optional) creates a page to 'Package'.ucfirst( $package ) and takes precedence over $page, should both be set. * only dispalyed if help is enabled * - install (optional) used for packages that require a separate installation * passed in as an array: * package => name of package to be installed * file => path to installation file e.g.: admin/install.php * - page (optional) page name on bitweaver * only dispalyed if help is enabled * - force (optional) if set, it will always dipslay this entry regardless of the feature settings */ function smarty_function_formhelp( $pParams, &$pSmarty=NULL ) { $atts = $ret_note = $ret_page = $ret_link = $ret_install = ''; if( !empty( $pParams['hash'] ) ) { $hash = &$pParams['hash']; } else { // maybe params were passed in separately $hash = &$pParams; } $force = 'n'; // we need to do some hash modification if we're in the installer if( !empty( $hash['is_installer'] )) { if( !empty( $hash['note']['upgrade'] )) { $hash['note']['version'] = $hash['note']['upgrade']; unset( $hash['note']['upgrade'] ); } } foreach( $hash as $key => $val ) { switch( $key ) { case 'note': case 'warning': case 'link': case 'page': $rawHash[$key] = $val; break; case 'label': case 'package': case 'install': case 'force': $$key = $val; break; default: if( $val ) { $atts .= $key.'="'.$val.'" '; } break; } } if( !empty( $package ) ) { $rawHash['page'] = ucfirst( $package ).'Package'; } // if link was passed in as a string, convert it into an array if( !empty( $rawHash['link'] ) && is_string( $rawHash['link'] ) ) { $l = explode( '/', $rawHash['link'] ); unset( $rawHash['link'] ); // package is first, title last, and all remaining elements file (can be 'foo/bar.php' as well) $rawHash['link']['package'] = array_shift( $l ); $rawHash['link']['title'] = array_pop( $l ); $rawHash['link']['file'] = implode( '/', $l ); } global $gBitSystem; if( $gBitSystem->isFeatureActive( 'site_online_help' ) || $gBitSystem->isFeatureActive( 'site_form_help' ) || $force == 'y' ) { if( !empty( $rawHash ) ) { if( !empty( $rawHash['page'] ) && ( $gBitSystem->isFeatureActive('site_online_help') || $force == 'y' ) ) { $ret_page = ''.KernelTools::tra( 'Online help' ).': <a class=\'external\' href=\'https://bitweaver.org/wiki/index.php?page='.$rawHash['page'].'\'>'.$rawHash['page'].'</a> '; } if( !empty( $rawHash['link'] ) && ( $gBitSystem->isFeatureActive('site_online_help') || $force == 'y' ) ) { if( is_array( $rawHash['link'] ) ) { $ret_link = ''.KernelTools::tra( 'IntraLink' ).': '; $ret_link .= '<a href=\''; $ret_link .= constant( strtoupper( $rawHash['link']['package'] ).'_PKG_URL' ).$rawHash['link']['file']; $ret_link .= '\'>'.KernelTools::tra( $rawHash['link']['title'] ).'</a>'; } } if( ( !empty( $rawHash['note'] ) && $gBitSystem->isFeatureActive('site_form_help') ) || ( !empty( $force ) && !empty( $rawHash['note'] ) ) ) { if( is_array( $rawHash['note'] ) ) { foreach( $rawHash['note'] as $name => $value ) { if( $name == 'install' ) { $ret_install = ''.KernelTools::tra( 'Install' ).': '.KernelTools::tra( 'To use this package, you will first have to run the package specific installer' ).': '; $ret_install .= '<a href=\''; $ret_install .= constant( strtoupper( $value['package'] ).'_PKG_URL' ).$value['file']; $ret_install .= '\'>'.ucfirst( $value['package'] ).'</a>'; } else { $ret_note .= ''.ucfirst( KernelTools::tra( $name ) ).': '.KernelTools::tra( $value ).' '; } } } else { $ret_note .= KernelTools::tra( $rawHash['note'] ).' '; } } if( !empty( $rawHash['warning'] ) ) { $ret_note .= ''.KernelTools::tra( $rawHash['warning'] ).' '; } // join all the output content into one string $content = $ret_note.$ret_page.$ret_link.$ret_install; $html = ''; // using the overlib popup system if( !empty( $content ) ) { if( $gBitSystem->isFeatureActive('site_help_popup') ) { global $gBitSmarty; // $gBitSmarty->loadPlugin( 'smarty_modifier_popup' ); // $gBitSmarty->loadPlugin( 'smarty_function_biticon' ); $gBitSmarty->assign( 'title',KernelTools::tra('Extended Help') ); $gBitSmarty->assign( 'content', $content ); $gBitSmarty->assign( 'closebutton', TRUE ); $text = $gBitSmarty->fetch('bitpackage:kernel/popup_box.tpl'); $text = preg_replace( '/"/',"'",$text ); $popup = [ 'trigger' => 'onclick', 'text' => $text, 'fullhtml' => '1', 'sticky' => '1', 'timeout' => '8000', ]; $biticon = [ 'ipackage' => 'icons', 'iname' => 'dialog-information', 'iforce' => 'icon', 'iexplain' => 'Extended Help', ]; $html .= ' '; $html .= '<a '.smarty_function_popup( $popup, $pSmarty ).'>'; $html .= smarty_function_biticon( $biticon ); $html .= '</a>'; $html .= ''; } else { $html .= ''.$content.''; } } return $html; } } }