Main

Output FunctionsView SourceTalkHistoryDiff?

Output Functions

There are a variety of output functions available to theme builders. Some you'll need to include for proper site functioning, while others can be mixed.

Note: The function information on this page relates to version of gpEasy greater than or equal to version 1.6RC1.

Necessary Functions

$page->GetContent();
This function outputs the primary content of each page.
gpOutput::GetHead();
This function will output the necessary meta, style and link information found in the <head> tag of the html document.
gpOutput::GetAdminLink();
This function will output the Login link so users can log in as administrators.

Menu Output

gpOutput::Get('Menu');
Outputs only the top level links.
gpOutput::Get('FullMenu');
Outputs all links within the user's menu.
gpOutput::Get('SubMenu');
Outputs all 2nd and 3rd level links within the selected group.
gpOutput::Get('ExpandMenu');
Outpus all 1st level links and the 2nd and 3rd level links within the selected group.
gpOutput::Get('ExpandLastMenu');
Outputs all 1st and 2nd level links and the 3rd level links within the selected group.
gpOutput::Get('TopTwoMenu');
Outputs all the 1st and 2nd level links.
gpOutput::Get('BottomTwoMenu');
Outputs all the 2nd and 3rd level links.
gpOutput::Get('MiddleSubMenu');
Outputs only the 2nd level links when the 1st level parent is selected.
gpOutput::Get('BottomSubMenu');
Outputs only the 3rd level links when the 2nd level parent is selected.


HTML Content Areas

gpOutput::Get('Extra',[area]); where area is the name of a content area. 'Header', 'Footer', 'Side_Menu' are all standard areas. Additional areas can be added just by changing the value of area.

You can find a brief tutorial on how to add unique header and/or side menu on a per page basis in gpEasy 1.6.3 in the forum here: [1].


Text Areas

gpOutput::Area([area_name],[area_html]) and gpOutput::GetArea([area_name],[area_text]) can be used used in combination to define and output a draggable area with custom html and editable text.

This line of code defines an area named My_Html_Area that contains the html <div class="my_html_area">%s</div> 

gpOutput::Area('My_Html_Area','<div class="my_html_area">%s</div>');

Then using this line of code, we can retrieve that html, in a user draggable wrapper with editable text. 

gpOutput::GetArea('My_Html_Area','This Text');

The result will be an area in your template that a user can do two things with:

  • Edit the text "This Text"
  • Drag 'n drop the whole area to their desired location within their theme.

Note: gpOutput::Area() should be called before any other output functions are used in your template. Before <head>label and enclosed on php calls

Designing for Arrangeable Content

By default, most of the areas outlined above can be rearranged by the user within gpEasy's administration scripts. To prevent users from being able to move an area in your theme, you can precede the function call with $GP_ARRANGE = false;. Example: 

$GP_ARRANGE = false;
gpOutput::Get('Menu');


Last modified 07:45 Wed, 23 Jun 2010 by Strodtbeck. Accessed 1,995 times Children What Links Here share Share
 
Main
Search