composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-04-22 10:08:45 +02:00
Code Issues Packages Projects Releases Wiki Activity

PHPDoc & code cleanup

Browse Source
This commit is contained in:
Molkobain
2020-08-21 11:51:24 +02:00
parent eb1322dc3e
commit 5320f69c44
2 changed files with 10 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
sources/application/UI/UIBlock.php
View File

@@ -31,7 +31,10 @@ use utils;
*/
abstract class UIBlock implements iUIBlock
{
/** @var string BLOCK_CODE The block code to use to generate the identifier, the CSS/JS prefixes, ... */
/** @var string BLOCK_CODE The block code to use to generate the identifier, the CSS/JS prefixes, ...
*
* Should start "ibo-" for the iTop backoffice blocks, followed by the name of the block in lower case (eg. for a MyCustomBlock class, should be "ibo-my-custom-clock")
*/
const BLOCK_CODE = 'ibo-block';
/** @var string|null GLOBAL_TEMPLATE_REL_PATH Relative path (from <ITOP>/templates/) to the "global" TWIG template which contains HTML, JS inline, JS files, CSS inline, CSS files. Should not be used to often as JS/CSS files would be duplicated making browser parsing time way longer. */

12
sources/application/UI/iUIBlock.php
View File

@@ -51,7 +51,7 @@ interface iUIBlock
public static function GetJsTemplateRelPath();
/**
* Return an array of the relative paths (from <ITOP>/) of the JS files to use
* Return an array of the relative paths (from <ITOP>/) of the JS files to use for the block itself
*
* @return array
*/
@@ -65,7 +65,7 @@ interface iUIBlock
public static function GetCssTemplateRelPath();
/**
* Return an array of the relative paths (from <ITOP>/) of the CSS files to use
* Return an array of the relative paths (from <ITOP>/) of the CSS files to use for the block itself
*
* @return array
*/
@@ -86,8 +86,8 @@ interface iUIBlock
public function GetSubBlocks();
/**
* Return an array of the JS files URL of the block and its sub blocks.
* URL is relative unless the $bAbsolutePath is set to true.
* Return an array of the JS files URL necessary for the block and all its sub blocks.
* URLs are relative unless the $bAbsolutePath is set to true.
*
* @param bool $bAbsoluteUrl
*
@@ -96,8 +96,8 @@ interface iUIBlock
public function GetJsFilesUrlRecursively($bAbsoluteUrl = false);
/**
* Return an array of the CSS files URL of the block and its sub blocks.
* URL is relative unless the $bAbsolutePath is set to true.
* Return an array of the CSS files URL necessary for the block and all its sub blocks.
* URLs are relative unless the $bAbsolutePath is set to true.
*
* @param bool $bAbsoluteUrl
*