jakob/friendica
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add Doxygen headers for multiple function in App

Browse source
This commit is contained in:
Benjamin Lorteau 2018-09-21 09:54:40 -04:00
parent f0cdd25e34
commit 489d5f41d2
1 changed files with 37 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
src/App.php
View file

@ -99,6 +99,15 @@ class App
public $stylesheets = []; public $stylesheets = [];
public $footerScripts = []; public $footerScripts = [];
/**
* Register a stylesheet file path to be included in the <head> tag of every page.
* Inclusion is done in App->initHead().
* The path can be absolute or relative to the Friendica installation base folder.
*
* @see App->initHead()
*
* @param string $path
*/
public function registerStylesheet($path) public function registerStylesheet($path)
{ {
$url = str_replace($this->get_basepath() . DIRECTORY_SEPARATOR, '', $path); $url = str_replace($this->get_basepath() . DIRECTORY_SEPARATOR, '', $path);
@ -106,6 +115,15 @@ class App
$this->stylesheets[] = trim($url, '/'); $this->stylesheets[] = trim($url, '/');
} }
/**
* Register a javascript file path to be included in the <footer> tag of every page.
* Inclusion is done in App->initFooter().
* The path can be absolute or relative to the Friendica installation base folder.
*
* @see App->initFooter()
*
* @param string $path
*/
public function registerFooterScript($path) public function registerFooterScript($path)
{ {
$url = str_replace($this->get_basepath() . DIRECTORY_SEPARATOR, '', $path); $url = str_replace($this->get_basepath() . DIRECTORY_SEPARATOR, '', $path);
@ -749,6 +767,16 @@ class App
$this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage']; $this->pager['start'] = ($this->pager['page'] * $this->pager['itemspage']) - $this->pager['itemspage'];
} }
/**
* Initializes App->page['htmlhead'].
*
* Includes:
* - Page title
* - Favicons
* - Registered stylesheets (through App->registerStylesheet())
* - Infinite scroll data
* - head.tpl template
*/
public function initHead() public function initHead()
{ {
$interval = ((local_user()) ? PConfig::get(local_user(), 'system', 'update_interval') : 40000); $interval = ((local_user()) ? PConfig::get(local_user(), 'system', 'update_interval') : 40000);
@ -814,6 +842,15 @@ class App
]) . $this->page['htmlhead']; ]) . $this->page['htmlhead'];
} }
/**
* Initializes App->page['footer'].
*
* Includes:
* - Javascript homebase
* - Mobile toggle link
* - Registered footer scripts (through App->registerFooterScript())
* - footer.tpl template
*/
public function initFooter() public function initFooter()
{ {
// If you're just visiting, let javascript take you home // If you're just visiting, let javascript take you home