N°3477 - Rename methods of the new iPageUIBlockExtension API

This commit is contained in:
Molkobain
2020-12-23 16:25:36 +01:00
parent 1d02ada8dc
commit 4ddfbf6559
2 changed files with 28 additions and 29 deletions

View File

@@ -1096,26 +1096,26 @@ interface iPageUIExtension
*/
interface iPageUIBlockExtension
{
/**
* Add content to the "admin banner"
*
* @return iUIBlock|null The Block to add into the page
*/
public function GetBannerBlock();
/**
* Add content to the header of the page
*
* @return iUIBlock The Block to add into the page
* @return iUIBlock|null The Block to add into the page
*/
public function GetNorthPaneBlock();
public function GetHeaderBlock();
/**
* Add content to the footer of the page
*
* @return iUIBlock The Block to add into the page
* @return iUIBlock|null The Block to add into the page
*/
public function GetSouthPaneBlock();
/**
* Add content to the "admin banner"
*
* @return iUIBlock The Block to add into the page
*/
public function GetBannerBlock();
public function GetFooterBlock();
}
/**
@@ -1163,22 +1163,6 @@ abstract class AbstractPageUIExtension implements iPageUIExtension
*/
abstract class AbstractPageUIBlockExtension implements iPageUIBlockExtension
{
/**
* @inheritDoc
*/
public function GetNorthPaneBlock()
{
return null;
}
/**
* @inheritDoc
*/
public function GetSouthPaneBlock()
{
return null;
}
/**
* @inheritDoc
*/
@@ -1187,6 +1171,21 @@ abstract class AbstractPageUIBlockExtension implements iPageUIBlockExtension
return null;
}
/**
* @inheritDoc
*/
public function GetHeaderBlock()
{
return null;
}
/**
* @inheritDoc
*/
public function GetFooterBlock()
{
return null;
}
}
/**

View File

@@ -797,7 +797,7 @@ HTML;
/** @var \iPageUIBlockExtension $oExtensionInstance */
foreach (MetaModel::EnumPlugins('iPageUIBlockExtension') as $oExtensionInstance)
{
$oBlock = $oExtensionInstance->GetNorthPaneBlock();
$oBlock = $oExtensionInstance->GetHeaderBlock();
if ($oBlock) {
$oHeader->AddSubBlock($oBlock);
}
@@ -844,7 +844,7 @@ HTML;
// Call the extensions to add content to the page, warning they can also add styles or scripts through as they have access to the \iTopWebPage
/** @var \iPageUIBlockExtension $oExtensionInstance */
foreach (MetaModel::EnumPlugins('iPageUIBlockExtension') as $oExtensionInstance) {
$oBlock = $oExtensionInstance->GetSouthPaneBlock();
$oBlock = $oExtensionInstance->GetFooterBlock();
if ($oBlock) {
$oFooter->AddSubBlock($oBlock);
}