Skip to content

Commit

Permalink
Doc block fixes (#41973)
Browse files Browse the repository at this point in the history
  • Loading branch information
Denitz authored Jan 11, 2024
1 parent f85b8d7 commit ec8b05e
Show file tree
Hide file tree
Showing 23 changed files with 54 additions and 49 deletions.
20 changes: 10 additions & 10 deletions administrator/components/com_admin/script.php
Original file line number Diff line number Diff line change
Expand Up @@ -387,10 +387,10 @@ private function migrateLogRotationPlugin($data)
return;
}

/** @var SchedulerComponent $component */
/** @var \Joomla\Component\Scheduler\Administrator\Extension\SchedulerComponent $component */
$component = Factory::getApplication()->bootComponent('com_scheduler');

/** @var TaskModel $model */
/** @var \Joomla\Component\Scheduler\Administrator\Model\TaskModel $model */
$model = $component->getMVCFactory()->createModel('Task', 'Administrator', ['ignore_request' => true]);

// Get the timeout, as configured in plg_system_logrotation
Expand Down Expand Up @@ -433,10 +433,10 @@ private function migrateSessionGCPlugin($data)
// Get the plugin parameters
$params = new Registry($data->params);

/** @var SchedulerComponent $component */
/** @var \Joomla\Component\Scheduler\Administrator\Extension\SchedulerComponent $component */
$component = Factory::getApplication()->bootComponent('com_scheduler');

/** @var TaskModel $model */
/** @var \Joomla\Component\Scheduler\Administrator\Model\TaskModel $model */
$model = $component->getMVCFactory()->createModel('Task', 'Administrator', ['ignore_request' => true]);
$task = [
'title' => 'Session GC',
Expand Down Expand Up @@ -478,10 +478,10 @@ private function migrateUpdatenotificationPlugin($data)
$params = new Registry($data->params);
$lastrun = (int) $params->get('lastrun', time());

/** @var SchedulerComponent $component */
/** @var \Joomla\Component\Scheduler\Administrator\Extension\SchedulerComponent $component */
$component = Factory::getApplication()->bootComponent('com_scheduler');

/** @var TaskModel $model */
/** @var \Joomla\Component\Scheduler\Administrator\Model\TaskModel $model */
$model = $component->getMVCFactory()->createModel('Task', 'Administrator', ['ignore_request' => true]);
$task = [
'title' => 'Update Notification',
Expand Down Expand Up @@ -2632,10 +2632,10 @@ private function migrateDeleteActionlogsConfiguration(): bool
return true;
}

/** @var SchedulerComponent $component */
/** @var \Joomla\Component\Scheduler\Administrator\Extension\SchedulerComponent $component */
$component = Factory::getApplication()->bootComponent('com_scheduler');

/** @var TaskModel $model */
/** @var \Joomla\Component\Scheduler\Administrator\Model\TaskModel $model */
$model = $component->getMVCFactory()->createModel('Task', 'Administrator', ['ignore_request' => true]);
$task = [
'title' => 'Delete Action Logs',
Expand Down Expand Up @@ -2701,10 +2701,10 @@ private function migratePrivacyconsentConfiguration(): bool
return true;
}

/** @var SchedulerComponent $component */
/** @var \Joomla\Component\Scheduler\Administrator\Extension\SchedulerComponent $component */
$component = Factory::getApplication()->bootComponent('com_scheduler');

/** @var TaskModel $model */
/** @var \Joomla\Component\Scheduler\Administrator\Model\TaskModel $model */
$model = $component->getMVCFactory()->createModel('Task', 'Administrator', ['ignore_request' => true]);
$task = [
'title' => 'Privacy Consent',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,9 @@ protected function getFile($path, $name)
/**
* Method to store file information.
*
* @param string $path The base path.
* @param string $name The file name.
* @param stdClass $template The std class object of template.
* @param string $path The base path.
* @param string $name The file name.
* @param \stdClass $template The std class object of template.
*
* @return object stdClass object.
*
Expand Down
1 change: 1 addition & 0 deletions libraries/src/Installer/LegacyInstallerScript.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
use Joomla\CMS\Factory;
use Joomla\Database\DatabaseAwareInterface;
use Joomla\Database\DatabaseAwareTrait;
use Joomla\Database\DatabaseInterface;
use Joomla\Database\Exception\DatabaseNotFoundException;

// phpcs:disable PSR1.Files.SideEffects
Expand Down
2 changes: 1 addition & 1 deletion plugins/content/contact/src/Extension/Contact.php
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ public function onContentPrepare($context, &$row, $params, $page = 0)
*
* @param int $userId Id of the user who created the article
*
* @return stdClass|null Object containing contact details or null if not found
* @return \stdClass|null Object containing contact details or null if not found
*/
private function getContactData($userId)
{
Expand Down
4 changes: 2 additions & 2 deletions plugins/fields/calendar/src/Extension/Calendar.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ final class Calendar extends FieldsPlugin implements SubscriberInterface
/**
* Transforms the field into a DOM XML element and appends it as a child on the given parent.
*
* @param stdClass $field The field.
* @param \stdClass $field The field.
* @param \DOMElement $parent The field node parent.
* @param Form $form The form.
* @param Form $form The form.
*
* @return \DOMElement
*
Expand Down
4 changes: 2 additions & 2 deletions plugins/fields/color/src/Extension/Color.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ final class Color extends FieldsPlugin implements SubscriberInterface
/**
* Transforms the field into a DOM XML element and appends it as a child on the given parent.
*
* @param stdClass $field The field.
* @param \stdClass $field The field.
* @param \DOMElement $parent The field node parent.
* @param Form $form The form.
* @param Form $form The form.
*
* @return \DOMElement
*
Expand Down
4 changes: 2 additions & 2 deletions plugins/fields/editor/src/Extension/Editor.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ final class Editor extends FieldsPlugin implements SubscriberInterface
/**
* Transforms the field into a DOM XML element and appends it as a child on the given parent.
*
* @param stdClass $field The field.
* @param \stdClass $field The field.
* @param \DOMElement $parent The field node parent.
* @param Form $form The form.
* @param Form $form The form.
*
* @return \DOMElement
*
Expand Down
4 changes: 2 additions & 2 deletions plugins/fields/imagelist/src/Extension/Imagelist.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ final class Imagelist extends FieldsPlugin implements SubscriberInterface
/**
* Transforms the field into a DOM XML element and appends it as a child on the given parent.
*
* @param stdClass $field The field.
* @param \stdClass $field The field.
* @param \DOMElement $parent The field node parent.
* @param Form $form The form.
* @param Form $form The form.
*
* @return \DOMElement
*
Expand Down
6 changes: 3 additions & 3 deletions plugins/fields/list/src/Extension/ListPlugin.php
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,9 @@ public function onCustomFieldsBeforePrepareField($context, $item, $field)
/**
* Prepares the field
*
* @param string $context The context.
* @param stdclass $item The item.
* @param stdclass $field The field.
* @param string $context The context.
* @param \stdclass $item The item.
* @param \stdclass $field The field.
*
* @return object
*
Expand Down
4 changes: 2 additions & 2 deletions plugins/fields/media/src/Extension/Media.php
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ final class Media extends FieldsPlugin
/**
* Transforms the field into a DOM XML element and appends it as a child on the given parent.
*
* @param stdClass $field The field.
* @param \stdClass $field The field.
* @param \DOMElement $parent The field node parent.
* @param Form $form The form.
* @param Form $form The form.
*
* @return \DOMElement
*
Expand Down
4 changes: 2 additions & 2 deletions plugins/fields/sql/src/Extension/SQL.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ final class SQL extends FieldsListPlugin
/**
* Transforms the field into a DOM XML element and appends it as a child on the given parent.
*
* @param stdClass $field The field.
* @param \stdClass $field The field.
* @param \DOMElement $parent The field node parent.
* @param Form $form The form.
* @param Form $form The form.
*
* @return \DOMElement
*
Expand Down
4 changes: 2 additions & 2 deletions plugins/fields/url/src/Extension/Url.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ final class Url extends FieldsPlugin implements SubscriberInterface
/**
* Transforms the field into a DOM XML element and appends it as a child on the given parent.
*
* @param stdClass $field The field.
* @param \stdClass $field The field.
* @param \DOMElement $parent The field node parent.
* @param Form $form The form.
* @param Form $form The form.
*
* @return \DOMElement
*
Expand Down
4 changes: 2 additions & 2 deletions plugins/fields/user/src/Extension/User.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ final class User extends FieldsPlugin implements SubscriberInterface
/**
* Transforms the field into a DOM XML element and appends it as a child on the given parent.
*
* @param stdClass $field The field.
* @param \stdClass $field The field.
* @param \DOMElement $parent The field node parent.
* @param Form $form The form.
* @param Form $form The form.
*
* @return \DOMElement
*
Expand Down
2 changes: 1 addition & 1 deletion plugins/installer/folderinstaller/tmpl/default.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

use Joomla\CMS\Language\Text;

/** @var PlgInstallerFolderInstaller $this */
/** @var \Joomla\Plugin\Installer\Folder\Extension\FolderInstaller $this */

Text::script('PLG_INSTALLER_FOLDERINSTALLER_NO_INSTALL_PATH');

Expand Down
2 changes: 1 addition & 1 deletion plugins/installer/webinstaller/tmpl/default.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

use Joomla\CMS\Language\Text;

/** @var PlgInstallerWebinstaller $this */
/** @var \Joomla\Plugin\Installer\Web\Extension\WebInstaller $this */

$dir = $this->isRTL() ? ' dir="ltr"' : '';

Expand Down
4 changes: 2 additions & 2 deletions plugins/sampledata/testing/src/Extension/Testing.php
Original file line number Diff line number Diff line change
Expand Up @@ -198,10 +198,10 @@ public function onAjaxSampledataApplyStep2()

$factory = $this->getApplication()->bootComponent('com_banners')->getMVCFactory();

/** @var Joomla\Component\Banners\Administrator\Model\ClientModel $clientModel */
/** @var \Joomla\Component\Banners\Administrator\Model\ClientModel $clientModel */
$clientModel = $factory->createModel('Client', 'Administrator', ['ignore_request' => true]);

/** @var Joomla\Component\Banners\Administrator\Model\BannerModel $bannerModel */
/** @var \Joomla\Component\Banners\Administrator\Model\BannerModel $bannerModel */
$bannerModel = $factory->createModel('Banner', 'Administrator', ['ignore_request' => true]);

$user = $this->getApplication()->getIdentity();
Expand Down
5 changes: 4 additions & 1 deletion plugins/system/guidedtours/src/Extension/GuidedTours.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,11 @@
namespace Joomla\Plugin\System\GuidedTours\Extension;

use Joomla\CMS\Language\Text;
use Joomla\CMS\Object\CMSObject;
use Joomla\CMS\Plugin\CMSPlugin;
use Joomla\CMS\Session\Session;
use Joomla\Component\Guidedtours\Administrator\Extension\GuidedtoursComponent;
use Joomla\Component\Guidedtours\Administrator\Model\TourModel;
use Joomla\Event\DispatcherInterface;
use Joomla\Event\Event;
use Joomla\Event\SubscriberInterface;
Expand Down Expand Up @@ -172,6 +174,7 @@ private function getTour($tourId)

$factory = $app->bootComponent('com_guidedtours')->getMVCFactory();

/** @var TourModel $tourModel */
$tourModel = $factory->createModel(
'Tour',
'Administrator',
Expand All @@ -186,7 +189,7 @@ private function getTour($tourId)
/**
* Return a tour and its steps or null if not found
*
* @param TourTable $item The tour to load
* @param CMSObject $item The tour to load
*
* @return null|object
*
Expand Down
4 changes: 2 additions & 2 deletions plugins/system/jooa11y/src/Extension/Jooa11y.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ final class Jooa11y extends CMSPlugin implements SubscriberInterface
*
* @since 4.1.0
*
* @throws Exception
* @throws \Exception
*/
public static function getSubscribedEvents(): array
{
Expand Down Expand Up @@ -246,7 +246,7 @@ public function initJooa11y()
Text::script($constant);
}

/** @var Joomla\CMS\WebAsset\WebAssetManager $wa*/
/** @var \Joomla\CMS\WebAsset\WebAssetManager $wa*/
$wa = $document->getWebAssetManager();

$wa->getRegistry()->addRegistryFile('media/plg_system_jooa11y/joomla.asset.json');
Expand Down
2 changes: 1 addition & 1 deletion plugins/system/remember/src/Extension/Remember.php
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ final class Remember extends CMSPlugin
*
* @since 1.5
*
* @throws InvalidArgumentException
* @throws \InvalidArgumentException
*/
public function onAfterInitialise()
{
Expand Down
6 changes: 3 additions & 3 deletions plugins/system/stats/layouts/message.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@
/**
* Layout variables
* -----------------
* @var PlgSystemStats $plugin Plugin rendering this layout
* @var Registry $pluginParams Plugin parameters
* @var array $statsData Array containing the data that will be sent to the stats server
* @var \Joomla\Plugin\System\Stats\Extension\Stats $plugin Plugin rendering this layout
* @var Registry $pluginParams Plugin parameters
* @var array $statsData Array containing the data that will be sent to the stats server
*/
?>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
use Joomla\CMS\Uri\Uri;
use Joomla\CMS\User\UserFactoryAwareTrait;
use Joomla\CMS\User\UserHelper;
use Joomla\Component\Messages\Administrator\Model\MessageModel;
use Joomla\Component\Scheduler\Administrator\Event\ExecuteTaskEvent;
use Joomla\Component\Scheduler\Administrator\Task\Status;
use Joomla\Component\Scheduler\Administrator\Task\Task;
Expand Down
2 changes: 1 addition & 1 deletion plugins/workflow/featuring/src/Extension/Featuring.php
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,7 @@ public function onWorkflowAfterTransition(WorkflowTransitionEvent $event): void
*
* @return boolean
*
* @throws Exception
* @throws \Exception
* @since 4.0.0
*/
public function onContentBeforeChangeFeatured(FeatureEvent $event)
Expand Down
8 changes: 4 additions & 4 deletions plugins/workflow/publishing/src/Extension/Publishing.php
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,8 @@ public function onContentPrepareForm(Model\PrepareFormEvent $event)
/**
* Add different parameter options to the transition view, we need when executing the transition
*
* @param Form $form The form
* @param stdClass $data The data
* @param Form $form The form
* @param \stdClass $data The data
*
* @return boolean
*
Expand All @@ -129,8 +129,8 @@ protected function enhanceTransitionForm(Form $form, $data)
* Disable certain fields in the item form view, when we want to take over this function in the transition
* Check also for the workflow implementation and if the field exists
*
* @param Form $form The form
* @param stdClass $data The data
* @param Form $form The form
* @param \stdClass $data The data
*
* @return boolean
*
Expand Down

0 comments on commit ec8b05e

Please sign in to comment.