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

Update PHPdocs for classes #1

Merged
merged 1 commit into from
Apr 4, 2024
Merged
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
5 changes: 1 addition & 4 deletions src/Mods/Element/AbstractElement.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,7 @@
use Slub\Mods\Element\Common\BaseElement;

/**
* Abstract MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* Abstract MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand Down
5 changes: 1 addition & 4 deletions src/Mods/Element/AccessCondition.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,7 @@
use Slub\Mods\Element\Common\BaseElement;

/**
* AccessCondition MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* AccessCondition MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand Down
5 changes: 1 addition & 4 deletions src/Mods/Element/Classification.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,7 @@
use Slub\Mods\Element\Common\BaseElement;

/**
* Classification MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* Classification MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand Down
5 changes: 1 addition & 4 deletions src/Mods/Element/Common/AuthorityDateLanguageElement.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,7 @@
use Slub\Mods\Attribute\Common\LanguageAttribute;

/**
* AuthorityDateLanguageElement MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* AuthorityDateLanguageElement MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand Down
5 changes: 1 addition & 4 deletions src/Mods/Element/Common/AuthorityLanguageElement.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,7 @@
use Slub\Mods\Attribute\Common\LanguageAttribute;

/**
* AuthorityLanguageElement MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* AuthorityLanguageElement MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand Down
5 changes: 1 addition & 4 deletions src/Mods/Element/Common/BaseElement.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,7 @@
namespace Slub\Mods\Element\Common;

/**
* MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand Down
5 changes: 1 addition & 4 deletions src/Mods/Element/Common/DateElement.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,7 @@
use Slub\Mods\Attribute\Common\LanguageAttribute;

/**
* General date MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* General date MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand Down
5 changes: 1 addition & 4 deletions src/Mods/Element/Common/LanguageElement.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,7 @@
use Slub\Mods\Element\Common\Element;

/**
* LanguageElement MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* LanguageElement MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand Down
5 changes: 1 addition & 4 deletions src/Mods/Element/Extension.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,7 @@
use Slub\Mods\Element\Common\BaseElement;

/**
* Extension MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* Extension MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand Down
5 changes: 1 addition & 4 deletions src/Mods/Element/Genre.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,7 @@
use Slub\Mods\Element\Common\BaseElement;

/**
* Genre MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* Genre MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand Down
5 changes: 1 addition & 4 deletions src/Mods/Element/Identifier.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,7 @@
use Slub\Mods\Element\Common\BaseElement;

/**
* Identifier MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* Identifier MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand Down
5 changes: 1 addition & 4 deletions src/Mods/Element/Language.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,7 @@
use Slub\Mods\Element\Specific\Language\ScriptTerm;

/**
* Language MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* Language MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand All @@ -37,13 +34,13 @@
* @access private
* @var LanguageTerm
*/
private LanguageTerm $languageTerm;

Check failure on line 37 in src/Mods/Element/Language.php

View workflow job for this annotation

GitHub Actions / phpstan

Property Slub\Mods\Element\Language::$languageTerm is never written, only read.

/**
* @access private
* @var ScriptTerm
*/
private ScriptTerm $scriptTerm;

Check failure on line 43 in src/Mods/Element/Language.php

View workflow job for this annotation

GitHub Actions / phpstan

Property Slub\Mods\Element\Language::$scriptTerm is never written, only read.

/**
* This extracts the essential MODS metadata from XML
Expand Down
5 changes: 1 addition & 4 deletions src/Mods/Element/Location.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,7 @@
use Slub\Mods\Element\Specific\Location\Url;

/**
* Location MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* Location MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand All @@ -38,31 +35,31 @@
* @access private
* @var PhysicalLocation
*/
private PhysicalLocation $physicalLocation;

Check failure on line 38 in src/Mods/Element/Location.php

View workflow job for this annotation

GitHub Actions / phpstan

Property Slub\Mods\Element\Location::$physicalLocation is never written, only read.

/**
* @access private
* @var LanguageElement
*/
private LanguageElement $shelfLocator;

Check failure on line 44 in src/Mods/Element/Location.php

View workflow job for this annotation

GitHub Actions / phpstan

Property Slub\Mods\Element\Location::$shelfLocator is never written, only read.

/**
* @access private
* @var Url
*/
private Url $url;

Check failure on line 50 in src/Mods/Element/Location.php

View workflow job for this annotation

GitHub Actions / phpstan

Property Slub\Mods\Element\Location::$url is never written, only read.

/**
* @access private
* @var HoldingSimple
*/
private HoldingSimple $holdingSimple;

Check failure on line 56 in src/Mods/Element/Location.php

View workflow job for this annotation

GitHub Actions / phpstan

Property Slub\Mods\Element\Location::$holdingSimple is never written, only read.

/**
* @access private
* @var string
*/
private string $holdingExternal;

Check failure on line 62 in src/Mods/Element/Location.php

View workflow job for this annotation

GitHub Actions / phpstan

Property Slub\Mods\Element\Location::$holdingExternal is never written, only read.

/**
* This extracts the essential MODS metadata from XML
Expand Down
5 changes: 1 addition & 4 deletions src/Mods/Element/Name.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,7 @@
use Slub\Mods\Element\Xml\Element;

/**
* Name MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* Name MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand All @@ -45,7 +42,7 @@
* @access private
* @var array
*/
private array $allowedTypes = [

Check failure on line 45 in src/Mods/Element/Name.php

View workflow job for this annotation

GitHub Actions / phpstan

Property Slub\Mods\Element\Name::$allowedTypes is never read, only written.
'personal',
'corporate',
'conference',
Expand Down Expand Up @@ -98,7 +95,7 @@
* @access private
* @var LanguageElement
*/
private LanguageElement $etal;

Check failure on line 98 in src/Mods/Element/Name.php

View workflow job for this annotation

GitHub Actions / phpstan

Property Slub\Mods\Element\Name::$etal is never written, only read.

/**
* This extracts the essential MODS metadata from XML
Expand Down Expand Up @@ -185,7 +182,7 @@
*
* @return NameIdentifier
*/
public function getNameIdentifier(string $query): array

Check failure on line 185 in src/Mods/Element/Name.php

View workflow job for this annotation

GitHub Actions / phpstan

PHPDoc tag @return with type Slub\Mods\Element\Specific\Name\NameIdentifier is incompatible with native type array.
{
if (empty($this->nameIdentifiers)) {
$xpath = './mods:nameIdentifier' . $query;
Expand Down
5 changes: 1 addition & 4 deletions src/Mods/Element/Note.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,7 @@
use Slub\Mods\Element\Common\BaseElement;

/**
* Note MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* Note MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand Down
5 changes: 1 addition & 4 deletions src/Mods/Element/OriginInfo.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,7 @@
use Slub\Mods\Element\Specific\OriginInfo\Issuance;

/**
* OriginInfo MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* OriginInfo MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand Down
5 changes: 1 addition & 4 deletions src/Mods/Element/Part.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,7 @@
use Slub\Mods\Element\Specific\Part\Text;

/**
* Part MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* Part MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand Down
5 changes: 1 addition & 4 deletions src/Mods/Element/PhysicalDescription.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,7 @@
use Slub\Mods\Element\Specific\PhysicalDescription\Form;

/**
* PhysicalDescription MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* PhysicalDescription MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand Down
5 changes: 1 addition & 4 deletions src/Mods/Element/RecordInfo.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,7 @@
use Slub\Mods\Element\Specific\RecordInfo\RecordInfoNote;

/**
* RecordInfo MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* RecordInfo MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand Down
5 changes: 1 addition & 4 deletions src/Mods/Element/RelatedItem.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,7 @@
use Slub\Mods\Element\Common\BaseElement;

/**
* RelatedItem MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* RelatedItem MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand Down
5 changes: 1 addition & 4 deletions src/Mods/Element/Specific/Language/LanguageTerm.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,7 @@
use Slub\Mods\Element\Common\BaseElement;

/**
* LanguageTerm MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* LanguageTerm MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand Down
5 changes: 1 addition & 4 deletions src/Mods/Element/Specific/Language/ScriptTerm.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,7 @@
use Slub\Mods\Element\Common\BaseElement;

/**
* ScriptTerm MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* ScriptTerm MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand Down
5 changes: 1 addition & 4 deletions src/Mods/Element/Specific/Location/HoldingSimple.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,7 @@
use Slub\Mods\Element\Specific\Location\HoldingSimple\CopyInformation;

/**
* HoldingSimple MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* HoldingSimple MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,7 @@
use Slub\Mods\Element\Specific\PhysicalDescription\Form;

/**
* HoldingSimple MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* HoldingSimple MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,7 @@
use Slub\Mods\Element\Common\BaseElement;

/**
* EnumerationAndChronology MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* EnumerationAndChronology MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,7 @@
use Slub\Mods\Element\Common\BaseElement;

/**
* ItemIdentifier MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* ItemIdentifier MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand Down
5 changes: 1 addition & 4 deletions src/Mods/Element/Specific/Location/PhysicalLocation.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,7 @@
use Slub\Mods\Element\Common\BaseElement;

/**
* PhysicalLocation MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* PhysicalLocation MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand Down
5 changes: 1 addition & 4 deletions src/Mods/Element/Specific/Location/Url.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,7 @@
use Slub\Mods\Element\Common\BaseElement;

/**
* Url MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* Url MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand Down
5 changes: 1 addition & 4 deletions src/Mods/Element/Specific/Name/AlternativeName.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,7 @@
use Slub\Mods\Element\Specific\Name\NameIdentifier;

/**
* AlternativeName MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* AlternativeName MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand Down
5 changes: 1 addition & 4 deletions src/Mods/Element/Specific/Name/NameIdentifier.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,7 @@
use Slub\Mods\Element\Common\BaseElement;

/**
* NameIdentifier MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* NameIdentifier MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand Down
5 changes: 1 addition & 4 deletions src/Mods/Element/Specific/Name/NamePart.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,7 @@
use Slub\Mods\Element\Common\BaseElement;

/**
* NamePart MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* NamePart MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand Down
5 changes: 1 addition & 4 deletions src/Mods/Element/Specific/Name/Role.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,7 @@
use Slub\Mods\Element\Xml\Element;

/**
* Role MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* Role MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand Down
5 changes: 1 addition & 4 deletions src/Mods/Element/Specific/Name/RoleTerm.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,7 @@
use Slub\Mods\Element\Common\BaseElement;

/**
* RoleTerm MODS metadata element class for the 'dlf' extension
*
* @package TYPO3
* @subpackage dlf
* RoleTerm MODS metadata element class for the 'php-mods-reader' library.
*
* @access public
*/
Expand Down
Loading