Skip to content

Commit b1e0dd3

Browse files
committed
Add code documentation
1 parent 55ca66f commit b1e0dd3

30 files changed

+514
-28
lines changed

wcfsetup/install/files/lib/action/GridViewFilterAction.class.php

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,17 @@
1111
use wcf\system\exception\PermissionDeniedException;
1212
use wcf\system\exception\UserInputException;
1313
use wcf\system\form\builder\Psr15DialogForm;
14-
use wcf\system\view\grid\AbstractGridView;
14+
use wcf\system\gridView\AbstractGridView;
1515
use wcf\system\WCF;
1616

17+
/**
18+
* Handles the filter dialog of grid views.
19+
*
20+
* @author Marcel Werk
21+
* @copyright 2001-2024 WoltLab GmbH
22+
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
23+
* @since 6.2
24+
*/
1725
final class GridViewFilterAction implements RequestHandlerInterface
1826
{
1927
#[\Override]

wcfsetup/install/files/lib/page/AbstractGridViewPage.class.php

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,14 @@
66
use wcf\system\gridView\AbstractGridView;
77
use wcf\system\WCF;
88

9+
/**
10+
* Abstract implementation of a page that is rendering a grid view.
11+
*
12+
* @author Marcel Werk
13+
* @copyright 2001-2024 WoltLab GmbH
14+
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
15+
* @since 6.2
16+
*/
917
abstract class AbstractGridViewPage extends AbstractPage
1018
{
1119
protected AbstractGridView $gridView;
@@ -70,5 +78,8 @@ protected function initGridView(): void
7078
$this->gridView->setBaseUrl(LinkHandler::getInstance()->getControllerLink(static::class));
7179
}
7280

81+
/**
82+
* Returns the grid view instance for the rendering of this page.
83+
*/
7384
protected abstract function createGridViewController(): AbstractGridView;
7485
}

wcfsetup/install/files/lib/system/endpoint/controller/core/gridViews/GetRows.class.php

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@
1212
use wcf\system\exception\UserInputException;
1313
use wcf\system\gridView\AbstractGridView;
1414

15+
/**
16+
* Retrieves the rows for a grid view.
17+
*
18+
* @author Marcel Werk
19+
* @copyright 2001-2024 WoltLab GmbH
20+
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
21+
* @since 6.2
22+
*/
1523
#[GetRequest('/core/gridViews/rows')]
1624
final class GetRows implements IController
1725
{

0 commit comments

Comments
 (0)