Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove forbidden @author tag from Magento_Backend #36976

Open
wants to merge 8 commits into
base: 2.4-develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions app/code/Magento/Backend/Block/Dashboard/AbstractDashboard.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@

/**
* Adminhtml dashboard tab abstract
*
* @author Magento Core Team <[email protected]>
*/
abstract class AbstractDashboard extends \Magento\Backend\Block\Widget
{
Expand Down Expand Up @@ -40,6 +38,8 @@ public function __construct(
}

/**
* Return a collection
*
* @return array|AbstractCollection|\Magento\Eav\Model\Entity\Collection\Abstract
*/
public function getCollection()
Expand All @@ -48,6 +48,8 @@ public function getCollection()
}

/**
* Return items count
*
* @return int
*/
public function getCount()
Expand All @@ -66,6 +68,8 @@ public function getDataHelper()
}

/**
* Prepare any data for display, if required
*
* @return $this
*/
protected function _prepareData()
Expand All @@ -74,6 +78,8 @@ protected function _prepareData()
}

/**
* Ensure data is prepared before layout
*
* @return $this
*/
protected function _prepareLayout()
Expand Down
2 changes: 0 additions & 2 deletions app/code/Magento/Backend/Block/Dashboard/Bar.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@

/**
* Adminhtml dashboard bar block
*
* @author Magento Core Team <[email protected]>
*/
class Bar extends \Magento\Backend\Block\Dashboard\AbstractDashboard
{
Expand Down
2 changes: 0 additions & 2 deletions app/code/Magento/Backend/Block/Dashboard/Diagrams.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@
* Adminhtml dashboard diagram tabs
* @deprecated dashboard graphs were migrated to dynamic chart.js solution
* @see dashboard.diagrams in adminhtml_dashboard_index.xml
*
* @author Magento Core Team <[email protected]>
*/
class Diagrams extends \Magento\Backend\Block\Widget\Tabs
{
Expand Down
13 changes: 2 additions & 11 deletions app/code/Magento/Backend/Block/Dashboard/Graph.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,37 +11,27 @@
* Adminhtml dashboard google chart block
* @deprecated dashboard graphs were migrated to dynamic chart.js solution
* @see dashboard.chart.amounts and dashboard.chart.orders in adminhtml_dashboard_index.xml
*
* @author Magento Core Team <[email protected]>
*/
class Graph extends \Magento\Backend\Block\Dashboard\AbstractDashboard
{
const API_URL = 'https://image-charts.com/chart';
public const API_URL = 'https://image-charts.com/chart';

/**
* All series
*
* @var array
*/
protected $_allSeries = [];

/**
* Axis labels
*
* @var array
*/
protected $_axisLabels = [];

/**
* Axis maps
*
* @var array
*/
protected $_axisMaps = [];

/**
* Data rows
*
* @var array
*/
protected $_dataRows = [];
Expand Down Expand Up @@ -78,6 +68,7 @@ class Graph extends \Magento\Backend\Block\Dashboard\AbstractDashboard
* Google chart api data encoding
*
* @deprecated 101.0.2 since the Google Image Charts API not accessible from March 14, 2019
* @see Nothing
* @var string
*/
protected $_encoding = 'e';
Expand Down
1 change: 0 additions & 1 deletion app/code/Magento/Backend/Block/Dashboard/Grid.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
/**
* Adminhtml dashboard grid
*
* @author Magento Core Team <[email protected]>
* @api
* @since 100.0.2
*/
Expand Down
1 change: 0 additions & 1 deletion app/code/Magento/Backend/Block/Dashboard/Grids.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
* Adminhtml dashboard bottom tabs
*
* @api
* @author Magento Core Team <[email protected]>
* @since 100.0.2
*/
class Grids extends Tabs
Expand Down
1 change: 0 additions & 1 deletion app/code/Magento/Backend/Block/Dashboard/Orders/Grid.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
* Adminhtml dashboard recent orders grid
*
* @api
* @author Magento Core Team <[email protected]>
* @SuppressWarnings(PHPMD.DepthOfInheritance)
* @since 100.0.2
*/
Expand Down
1 change: 0 additions & 1 deletion app/code/Magento/Backend/Block/Dashboard/Sales.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
* Adminhtml dashboard sales statistics bar
*
* @api
* @author Magento Core Team <[email protected]>
* @since 100.0.2
*/
class Sales extends Bar
Expand Down
2 changes: 0 additions & 2 deletions app/code/Magento/Backend/Block/Dashboard/Tab/Amounts.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@
* Adminhtml dashboard order amounts diagram
* @deprecated dashboard graphs were migrated to dynamic chart.js solution
* @see dashboard.chart.amounts in adminhtml_dashboard_index.xml
*
* @author Magento Core Team <[email protected]>
*/
class Amounts extends \Magento\Backend\Block\Dashboard\Graph
{
Expand Down
2 changes: 0 additions & 2 deletions app/code/Magento/Backend/Block/Dashboard/Tab/Orders.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@
* Adminhtml dashboard orders diagram
* @deprecated dashboard graphs were migrated to dynamic chart.js solution
* @see dashboard.chart.orders in adminhtml_dashboard_index.xml
*
* @author Magento Core Team <[email protected]>
*/
class Orders extends \Magento\Backend\Block\Dashboard\Graph
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
/**
* Adminhtml dashboard most ordered products grid
*
* @author Magento Core Team <[email protected]>
* @SuppressWarnings(PHPMD.DepthOfInheritance)
*/
class Ordered extends \Magento\Backend\Block\Dashboard\Grid
Expand Down
4 changes: 2 additions & 2 deletions app/code/Magento/Backend/Block/Page.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@

/**
* Adminhtml page
*
* @author Magento Core Team <[email protected]>
*/
namespace Magento\Backend\Block;

Expand Down Expand Up @@ -62,6 +60,8 @@ public function getLang()
}

/**
* Returns true if we are running in single store mode
*
* @return bool
*/
public function isSingleStoreMode()
Expand Down
1 change: 0 additions & 1 deletion app/code/Magento/Backend/Block/Page/Footer.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
* Adminhtml footer block
*
* @api
* @author Magento Core Team <[email protected]>
* @since 100.0.2
*/
class Footer extends \Magento\Backend\Block\Template
Expand Down
9 changes: 6 additions & 3 deletions app/code/Magento/Backend/Block/Page/Header.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
* Adminhtml header block
*
* @api
* @author Magento Core Team <[email protected]>
* @since 100.0.2
*/
class Header extends \Magento\Backend\Block\Template
Expand All @@ -21,8 +20,6 @@ class Header extends \Magento\Backend\Block\Template
protected $_template = 'Magento_Backend::page/header.phtml';

/**
* Backend data
*
* @var \Magento\Backend\Helper\Data
*/
protected $_backendData = null;
Expand Down Expand Up @@ -50,6 +47,8 @@ public function __construct(
}

/**
* Return URL to homepage
*
* @return string
*/
public function getHomeLink()
Expand All @@ -58,6 +57,8 @@ public function getHomeLink()
}

/**
* Return the current user
*
* @return \Magento\User\Model\User|null
*/
public function getUser()
Expand All @@ -66,6 +67,8 @@ public function getUser()
}

/**
* Return URL to log out from admin
*
* @return string
*/
public function getLogoutLink()
Expand Down
2 changes: 0 additions & 2 deletions app/code/Magento/Backend/Block/Page/Notices.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@

/**
* Adminhtml header notices block
*
* @author Magento Core Team <[email protected]>
*/
namespace Magento\Backend\Block\Page;

Expand Down
18 changes: 4 additions & 14 deletions app/code/Magento/Backend/Block/Page/System/Config/Robots/Reset.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,25 +12,15 @@
* "Reset to Defaults" button renderer
*
* @deprecated 100.1.6
* @author Magento Core Team <[email protected]>
* @see Nothing
*/
class Reset extends \Magento\Config\Block\System\Config\Form\Field
{
/**
* Pasge robots default instructions
* Page robots default instructions
*/
const XML_PATH_ROBOTS_DEFAULT_CUSTOM_INSTRUCTIONS = 'design/search_engine_robots/default_custom_instructions';

/**
* @param \Magento\Backend\Block\Template\Context $context
* @param array $data
*/
public function __construct(
\Magento\Backend\Block\Template\Context $context,
array $data = []
) {
parent::__construct($context, $data);
}
public const XML_PATH_ROBOTS_DEFAULT_CUSTOM_INSTRUCTIONS =
'design/search_engine_robots/default_custom_instructions';

/**
* Set template
Expand Down
5 changes: 4 additions & 1 deletion app/code/Magento/Backend/Block/System/Account/Edit.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,13 @@
* Adminhtml edit admin user account
*
* @api
* @author Magento Core Team <[email protected]>
* @since 100.0.2
*/
class Edit extends \Magento\Backend\Block\Widget\Form\Container
{
/**
* Initialise the page
*
* @return void
*/
protected function _construct()
Expand All @@ -29,6 +30,8 @@ protected function _construct()
}

/**
* Return a Phrase for the header text
*
* @return \Magento\Framework\Phrase
*/
public function getHeaderText()
Expand Down
4 changes: 1 addition & 3 deletions app/code/Magento/Backend/Block/System/Account/Edit/Form.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,10 @@

/**
* Adminhtml edit admin user account form
*
* @author Magento Core Team <[email protected]>
*/
class Form extends \Magento\Backend\Block\Widget\Form\Generic
{
const IDENTITY_VERIFICATION_PASSWORD_FIELD = 'current_password';
public const IDENTITY_VERIFICATION_PASSWORD_FIELD = 'current_password';

/**
* @var \Magento\Backend\Model\Auth\Session
Expand Down
12 changes: 9 additions & 3 deletions app/code/Magento/Backend/Block/System/Cache/Edit.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@

/**
* Cache management edit page
*
* @author Magento Core Team <[email protected]>
*/
class Edit extends \Magento\Backend\Block\Widget
{
Expand All @@ -18,6 +16,8 @@ class Edit extends \Magento\Backend\Block\Widget
protected $_template = 'Magento_Backend::system/cache/edit.phtml';

/**
* Set the page title
*
* @return void
*/
protected function _construct()
Expand All @@ -28,7 +28,7 @@ protected function _construct()
}

/**
* {@inheritdoc}
* @inheritDoc
*/
protected function _prepareLayout()
{
Expand All @@ -47,6 +47,8 @@ protected function _prepareLayout()
}

/**
* Return the HTML for the save button
*
* @return string
*/
public function getSaveButtonHtml()
Expand All @@ -55,6 +57,8 @@ public function getSaveButtonHtml()
}

/**
* Return the URL to save an item
*
* @return string
*/
public function getSaveUrl()
Expand All @@ -63,6 +67,8 @@ public function getSaveUrl()
}

/**
* Initialise the form
*
* @return $this
*/
public function initForm()
Expand Down
2 changes: 0 additions & 2 deletions app/code/Magento/Backend/Block/System/Cache/Form.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@

/**
* Cache management form page
*
* @author Magento Core Team <[email protected]>
*/
class Form extends \Magento\Backend\Block\Widget\Form\Generic
{
Expand Down
2 changes: 0 additions & 2 deletions app/code/Magento/Backend/Block/System/Store/Delete.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@

/**
* Store / store view / website delete form container
*
* @author Magento Core Team <[email protected]>
*/
class Delete extends \Magento\Backend\Block\Widget\Form\Container
{
Expand Down
2 changes: 0 additions & 2 deletions app/code/Magento/Backend/Block/System/Store/Delete/Form.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@

/**
* Adminhtml cms block edit form
*
* @author Magento Core Team <[email protected]>
*/
class Form extends \Magento\Backend\Block\Widget\Form\Generic
{
Expand Down
Loading