Add inline docs

neos · Nov 6, 2024 · 187b80e · 187b80e
1 parent da297ec
commit 187b80e
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 16 deletions.
diff --git a/Neos.Neos/Classes/Security/Authorization/Privilege/AbstractSubtreeTagBasedPrivilege.php b/Neos.Neos/Classes/Security/Authorization/Privilege/AbstractSubtreeTagBasedPrivilege.php
@@ -14,15 +14,15 @@
 
 namespace Neos\Neos\Security\Authorization\Privilege;
 
-use Neos\ContentRepository\Core\Feature\SubtreeTagging\Dto\SubtreeTag;
 use Neos\ContentRepository\Core\Feature\SubtreeTagging\Dto\SubtreeTags;
 use Neos\ContentRepository\Core\SharedModel\ContentRepository\ContentRepositoryId;
 use Neos\Flow\Security\Authorization\Privilege\AbstractPrivilege;
 use Neos\Flow\Security\Authorization\Privilege\PrivilegeSubjectInterface;
 use Neos\Flow\Security\Exception\InvalidPrivilegeTypeException;
 
 /**
- * TODO docs
+ * Common base class for privileges that evaluate {@see SubtreeTagPrivilegeSubject}s
+ * @see ReadNodePrivilege, EditNodePrivilege
  */
 abstract class AbstractSubtreeTagBasedPrivilege extends AbstractPrivilege
 {

diff --git a/Neos.Neos/Classes/Security/Authorization/Privilege/EditNodePrivilege.php b/Neos.Neos/Classes/Security/Authorization/Privilege/EditNodePrivilege.php
@@ -14,14 +14,9 @@
 
 namespace Neos\Neos\Security\Authorization\Privilege;
 
-use Neos\ContentRepository\Core\Feature\SubtreeTagging\Dto\SubtreeTag;
-use Neos\ContentRepository\Core\SharedModel\ContentRepository\ContentRepositoryId;
-use Neos\Flow\Security\Authorization\Privilege\AbstractPrivilege;
-use Neos\Flow\Security\Authorization\Privilege\PrivilegeSubjectInterface;
-use Neos\Flow\Security\Exception\InvalidPrivilegeTypeException;
-
 /**
- * TODO docs
+ * The privilege to edit any matching node in the Content Repository.
+ * This includes creation, setting properties or references, disabling/enabling, tagging and moving corresponding nodes
  */
 class EditNodePrivilege extends AbstractSubtreeTagBasedPrivilege
 {

diff --git a/Neos.Neos/Classes/Security/Authorization/Privilege/ReadNodePrivilege.php b/Neos.Neos/Classes/Security/Authorization/Privilege/ReadNodePrivilege.php
@@ -14,14 +14,9 @@
 
 namespace Neos\Neos\Security\Authorization\Privilege;
 
-use Neos\ContentRepository\Core\Feature\SubtreeTagging\Dto\SubtreeTag;
-use Neos\ContentRepository\Core\SharedModel\ContentRepository\ContentRepositoryId;
-use Neos\Flow\Security\Authorization\Privilege\AbstractPrivilege;
-use Neos\Flow\Security\Authorization\Privilege\PrivilegeSubjectInterface;
-use Neos\Flow\Security\Exception\InvalidPrivilegeTypeException;
-
 /**
- * TODO docs
+ * The privilege to read any matching node from the Content Repository.
+ * This includes all properties, references and metadata
  */
 class ReadNodePrivilege extends AbstractSubtreeTagBasedPrivilege
 {