Auto docblock fixes.

This commit is contained in:
Dennis Eichhorn 2023-05-25 07:48:47 +00:00
parent 833cc7abe6
commit 819734daca
11 changed files with 78 additions and 79 deletions

2
Controller/FileUploaderTrait.php Executable file → Normal file
View File

@ -19,7 +19,7 @@ use phpOMS\Message\RequestAbstract;
use phpOMS\Message\ResponseAbstract; use phpOMS\Message\ResponseAbstract;
/** /**
* Options trait. * Trait for setting up file upload functionality.
* *
* @package Modules\Media\Controller * @package Modules\Media\Controller
* @license OMS License 2.0 * @license OMS License 2.0

2
Models/MediaClass.php Executable file → Normal file
View File

@ -15,7 +15,7 @@ declare(strict_types=1);
namespace Modules\Media\Models; namespace Modules\Media\Models;
/** /**
* Media class. * Represents the type/class of media in the application.
* *
* @package Modules\Media\Models * @package Modules\Media\Models
* @license OMS License 2.0 * @license OMS License 2.0

12
Models/MediaContent.php Executable file → Normal file
View File

@ -15,7 +15,7 @@ declare(strict_types=1);
namespace Modules\Media\Models; namespace Modules\Media\Models;
/** /**
* Media class. * Media content class.
* *
* @package Modules\Media\Models * @package Modules\Media\Models
* @license OMS License 2.0 * @license OMS License 2.0
@ -32,17 +32,13 @@ class MediaContent implements \JsonSerializable
*/ */
public int $id = 0; public int $id = 0;
public string $content = '';
/** /**
* @return int * Content of the media.
* *
* @var string
* @since 1.0.0 * @since 1.0.0
*/ */
public function getId() : int public string $content = '';
{
return $this->id;
}
/** /**
* {@inheritdoc} * {@inheritdoc}

2
Models/MediaStatus.php Executable file → Normal file
View File

@ -15,7 +15,7 @@ declare(strict_types=1);
namespace Modules\Media\Models; namespace Modules\Media\Models;
/** /**
* Media class. * Media status enum.
* *
* @package Modules\Media\Models * @package Modules\Media\Models
* @license OMS License 2.0 * @license OMS License 2.0

2
Models/NullCollection.php Executable file → Normal file
View File

@ -15,7 +15,7 @@ declare(strict_types=1);
namespace Modules\Media\Models; namespace Modules\Media\Models;
/** /**
* Media class. * NullCollection class.
* *
* @package Modules\Media\Models * @package Modules\Media\Models
* @license OMS License 2.0 * @license OMS License 2.0

4
Models/NullMedia.php Executable file → Normal file
View File

@ -15,7 +15,7 @@ declare(strict_types=1);
namespace Modules\Media\Models; namespace Modules\Media\Models;
/** /**
* Media class. * NullMedia class represents a null object of the Media class.
* *
* @package Modules\Media\Models * @package Modules\Media\Models
* @license OMS License 2.0 * @license OMS License 2.0
@ -25,7 +25,7 @@ namespace Modules\Media\Models;
final class NullMedia extends Media final class NullMedia extends Media
{ {
/** /**
* Constructor * Constructor.
* *
* @param int $id Model id * @param int $id Model id
* *

3
Models/NullMediaContent.php Executable file → Normal file
View File

@ -15,7 +15,8 @@ declare(strict_types=1);
namespace Modules\Media\Models; namespace Modules\Media\Models;
/** /**
* Media class. * Class NullMediaContent
* Represents null media content.
* *
* @package Modules\Media\Models * @package Modules\Media\Models
* @license OMS License 2.0 * @license OMS License 2.0

2
Models/NullMediaType.php Executable file → Normal file
View File

@ -15,7 +15,7 @@ declare(strict_types=1);
namespace Modules\Media\Models; namespace Modules\Media\Models;
/** /**
* Media type class. * Null media type class.
* *
* @package Modules\Media\Models * @package Modules\Media\Models
* @license OMS License 2.0 * @license OMS License 2.0

6
Models/Reference.php Executable file → Normal file
View File

@ -17,6 +17,8 @@ namespace Modules\Media\Models;
/** /**
* Reference class. * Reference class.
* *
* This class represents a reference to a media file. It extends the Media class.
*
* @package Modules\Media\Models * @package Modules\Media\Models
* @license OMS License 2.0 * @license OMS License 2.0
* @link https://jingga.app * @link https://jingga.app
@ -25,7 +27,7 @@ namespace Modules\Media\Models;
class Reference extends Media class Reference extends Media
{ {
/** /**
* Extension name. * The file extension of the reference file.
* *
* @var string * @var string
* @since 1.0.0 * @since 1.0.0
@ -33,7 +35,7 @@ class Reference extends Media
public string $extension = 'reference'; public string $extension = 'reference';
/** /**
* Is reference. * The media class of the reference.
* *
* @var int * @var int
* @since 1.0.0 * @since 1.0.0

0
Models/ReferenceMapper.php Executable file → Normal file
View File

0
Models/UploadStatus.php Executable file → Normal file
View File