Class HtmlPage
Copyright:
2004-2016 The Admidio Team
License:
GNU General Public License v2.0 only
**********************************************************************************************
Brief:
Creates an Admidio specific complete html page
This class creates a html page with head and body and integrates some Admidio
specific elements like css files, javascript files and javascript code. It
also provides some methods to easily add new html data to the page. The generated
page will automatically integrate the choosen theme. You can optional disable the
integration of the theme files.
Class:
HtmlPage
Code:
// create a simple html page with some text
$page = new HtmlPage();
$page->addJavascriptFile('adm_program/libs/jquery/jquery.min.js');
$page->setHeadline('A simple Html page');
$page->addHtml('This is a simple Html page!');
$page->show(); @endcode
Par:
Examples
Located at htmlpage.php
Methods summary
public
|
#
__construct( string $headline = '' )
Constructor creates the page object and initialized all parameters
Constructor creates the page object and initialized all parameters
Parameters
- $headline
A string that contains the headline for the page that will be shown in the
<
h1> tag.
|
public
|
#
addCssFile( string $file )
Adds a cascading style sheets file to the html page.
Adds a cascading style sheets file to the html page.
Parameters
- $file
- The url with filename or the relative path starting with @i adm_program of the css file.
|
public
|
#
addHtml( string $html )
Adds any html content to the page. The content will be added in the order
you call this method. The first call will place the content at the top of
the page. The second call below the first etc.
Adds any html content to the page. The content will be added in the order
you call this method. The first call will place the content at the top of
the page. The second call below the first etc.
Parameters
- $html
- A valid html code that will be added to the page.
|
public
|
#
addJavascript( string $javascriptCode, boolean $executeAfterPageLoad = false )
Adds any javascript content to the page. The javascript will be added in the order you call this method.
Adds any javascript content to the page. The javascript will be added in the order you call this method.
Parameters
- $javascriptCode
- A valid javascript code that will be added to the header of the page.
- $executeAfterPageLoad
(optional) If set to @b true the javascript code will be executed after
the page is fully loaded.
|
public
|
#
addJavascriptFile( string $file )
Adds a javascript file to the html page.
Adds a javascript file to the html page.
Parameters
- $file
- The url with filename or the relative path starting with @i adm_program of the javascript file.
|
public
|
|
private
string
|
#
getDebugOrMinFilepath( string $filepath )
The method will return the filename. If you are in debug mode than it will return the
not minified version of the filename otherwise it will return the minified version.
Therefore you must provide 2 versions of the file. One with a @b min before the file extension
and one version without the @b min.
The method will return the filename. If you are in debug mode than it will return the
not minified version of the filename otherwise it will return the minified version.
Therefore you must provide 2 versions of the file. One with a @b min before the file extension
and one version without the @b min.
Parameters
- $filepath
- Filename of the NOT minified file.
Returns
string
Returns the filename in dependence of the debug mode.
|
public
string
|
#
getHeadline( )
Returns the headline of the current Admidio page. This is the text of the
<
h1> tag of the page.
Returns the headline of the current Admidio page. This is the text of the
<
h1> tag of the page.
Returns
string
Returns the headline of the current Admidio page.
|
public
string
|
#
getTitle( )
Returns the title of the html page.
Returns the title of the html page.
Returns
string
Returns the title of the html page.
|
public
|
#
hideThemeHtml( )
Every html page of Admidio contains three files of the custom theme.
my_header.php, my_body_top.php and my_body_bottom.php
With these files the administrator can contain custom layout to Admidio.
If these files should not be included in the current page, than this method must be called.
Every html page of Admidio contains three files of the custom theme.
my_header.php, my_body_top.php and my_body_bottom.php
With these files the administrator can contain custom layout to Admidio.
If these files should not be included in the current page, than this method must be called.
|
public
|
#
hasNavbar( )
Flag if the current page has a navbar.
Flag if the current page has a navbar.
|
public
|
#
setHeadline( string $headline )
Set the h1 headline of the current html page. If the title of the page
was not set until now than this will also be the title.
Set the h1 headline of the current html page. If the title of the page
was not set until now than this will also be the title.
Parameters
- $headline
- A string that contains the headline for the page.
|
public
|
#
setPrintMode( )
If print mode is set then a print specific css file will be loaded.
All styles will be more print compatible and are only black, grey and white.
If print mode is set then a print specific css file will be loaded.
All styles will be more print compatible and are only black, grey and white.
|
public
|
#
setTitle( string $title )
Set the title of the html page that will be shown in the tag.</p>
</div>
<div class="description detailed hidden">
<p>Set the title of the html page that will be shown in the <title> tag.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$title</var></dt>
<dd>A string that contains the title for the page.</dd>
</dl></div>
</div>
</div></td>
</tr>
<tr data-order="show" id="_show">
<td class="attributes"><code>
public
string|
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_show">#</a>
<code><a href="source-class-HtmlPage.html#435-611" title="Go to source code">show</a>( <span>boolean <var>$directOutput</var> = <span class="php-keyword1">true</span></span> )</code>
<div class="description short">
<p>This method send the whole html code of the page to the browser. Call this method
if you have finished your page layout.</p>
</div>
<div class="description detailed hidden">
<p>This method send the whole html code of the page to the browser. Call this method
if you have finished your page layout.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$directOutput</var></dt>
<dd><p>If set to @b true (default) the html page will be directly send
to the browser. If set to @b false the html will be returned.</p></dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
string|<br>If $directOutput is set to @b false this method will return the html code of the page.
</div>
</div>
</div></td>
</tr>
</table>
</div>
<div class="panel panel-default">
<div class="panel-heading"><h2>Properties summary</h2></div>
<table class="summary table table-bordered table-striped properties" id="properties">
<tr data-order="title" id="$title">
<td class="attributes"><code>
protected
</code></td>
<td class="name">
<a href="source-class-HtmlPage.html#29" title="Go to source code"><var>$title</var></a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</td>
<td class="value">
<div>
<a href="#$title" class="anchor">#</a>
<code></code>
</div>
</td>
</tr>
<tr data-order="header" id="$header">
<td class="attributes"><code>
protected
</code></td>
<td class="name">
<a href="source-class-HtmlPage.html#30" title="Go to source code"><var>$header</var></a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</td>
<td class="value">
<div>
<a href="#$header" class="anchor">#</a>
<code></code>
</div>
</td>
</tr>
<tr data-order="headline" id="$headline">
<td class="attributes"><code>
protected
</code></td>
<td class="name">
<a href="source-class-HtmlPage.html#31" title="Go to source code"><var>$headline</var></a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</td>
<td class="value">
<div>
<a href="#$headline" class="anchor">#</a>
<code></code>
</div>
</td>
</tr>
<tr data-order="pageContent" id="$pageContent">
<td class="attributes"><code>
protected
</code></td>
<td class="name">
<a href="source-class-HtmlPage.html#32" title="Go to source code"><var>$pageContent</var></a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</td>
<td class="value">
<div>
<a href="#$pageContent" class="anchor">#</a>
<code></code>
</div>
</td>
</tr>
<tr data-order="menu" id="$menu">
<td class="attributes"><code>
protected
</code></td>
<td class="name">
<a href="source-class-HtmlPage.html#33" title="Go to source code"><var>$menu</var></a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</td>
<td class="value">
<div>
<a href="#$menu" class="anchor">#</a>
<code></code>
</div>
</td>
</tr>
<tr data-order="showThemeHtml" id="$showThemeHtml">
<td class="attributes"><code>
protected
</code></td>
<td class="name">
<a href="source-class-HtmlPage.html#34" title="Go to source code"><var>$showThemeHtml</var></a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</td>
<td class="value">
<div>
<a href="#$showThemeHtml" class="anchor">#</a>
<code></code>
</div>
</td>
</tr>
<tr data-order="showMenu" id="$showMenu">
<td class="attributes"><code>
protected
</code></td>
<td class="name">
<a href="source-class-HtmlPage.html#35" title="Go to source code"><var>$showMenu</var></a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</td>
<td class="value">
<div>
<a href="#$showMenu" class="anchor">#</a>
<code></code>
</div>
</td>
</tr>
<tr data-order="hasNavbar" id="$hasNavbar">
<td class="attributes"><code>
protected
</code></td>
<td class="name">
<a href="source-class-HtmlPage.html#36" title="Go to source code"><var>$hasNavbar</var></a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</td>
<td class="value">
<div>
<a href="#$hasNavbar" class="anchor">#</a>
<code></code>
</div>
</td>
</tr>
<tr data-order="showModal" id="$showModal">
<td class="attributes"><code>
protected
</code></td>
<td class="name">
<a href="source-class-HtmlPage.html#37" title="Go to source code"><var>$showModal</var></a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</td>
<td class="value">
<div>
<a href="#$showModal" class="anchor">#</a>
<code></code>
</div>
</td>
</tr>
<tr data-order="cssFiles" id="$cssFiles">
<td class="attributes"><code>
protected
</code></td>
<td class="name">
<a href="source-class-HtmlPage.html#38" title="Go to source code"><var>$cssFiles</var></a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</td>
<td class="value">
<div>
<a href="#$cssFiles" class="anchor">#</a>
<code></code>
</div>
</td>
</tr>
<tr data-order="jsFiles" id="$jsFiles">
<td class="attributes"><code>
protected
</code></td>
<td class="name">
<a href="source-class-HtmlPage.html#39" title="Go to source code"><var>$jsFiles</var></a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</td>
<td class="value">
<div>
<a href="#$jsFiles" class="anchor">#</a>
<code></code>
</div>
</td>
</tr>
<tr data-order="rssFiles" id="$rssFiles">
<td class="attributes"><code>
protected
</code></td>
<td class="name">
<a href="source-class-HtmlPage.html#40" title="Go to source code"><var>$rssFiles</var></a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</td>
<td class="value">
<div>
<a href="#$rssFiles" class="anchor">#</a>
<code></code>
</div>
</td>
</tr>
<tr data-order="printMode" id="$printMode">
<td class="attributes"><code>
protected
</code></td>
<td class="name">
<a href="source-class-HtmlPage.html#41" title="Go to source code"><var>$printMode</var></a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</td>
<td class="value">
<div>
<a href="#$printMode" class="anchor">#</a>
<code></code>
</div>
</td>
</tr>
<tr data-order="javascriptContent" id="$javascriptContent">
<td class="attributes"><code>
protected
</code></td>
<td class="name">
<a href="source-class-HtmlPage.html#42" title="Go to source code"><var>$javascriptContent</var></a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</td>
<td class="value">
<div>
<a href="#$javascriptContent" class="anchor">#</a>
<code></code>
</div>
</td>
</tr>
<tr data-order="javascriptContentExecute" id="$javascriptContentExecute">
<td class="attributes"><code>
protected
</code></td>
<td class="name">
<a href="source-class-HtmlPage.html#43" title="Go to source code"><var>$javascriptContentExecute</var></a>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</td>
<td class="value">
<div>
<a href="#$javascriptContentExecute" class="anchor">#</a>
<code></code>
</div>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Admidio API API documentation generated by <a href="http://apigen.org">ApiGen</a>
</div>
</div>
<script src="resources/combined.js"></script>
<script src="elementlist.js"></script>
</body>
</html>
|