10000 Docblock fixes · symfony/security-acl@1d465f3 · GitHub
[go: up one dir, main page]
Skip to content

Commit 1d465f3

Browse files
GrahamCampbellGrahamCampbell
committed
Docblock fixes
1 parent 885f1a1 commit 1d465f3

18 files changed

+157
-100
lines changed

‎Dbal/AclProvider.php

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,7 @@ public function findAcls(array $oids, array $sids = array())
223223
* ACEs, and security identities.
224224
*
225225
* @param array $ancestorIds
226+
*
226227
* @return string
227228
*/
228229
protected function getLookupSql(array $ancestorIds)
@@ -328,6 +329,7 @@ protected function getAncestorLookupSql(array $batch)
328329
*
329330
* @param ObjectIdentityInterface $oid
330331
* @param bool $directChildrenOnly
332+
*
331333
* @return string
332334
*/
333335
protected function getFindChildrenSql(ObjectIdentityInterface $oid, $directChildrenOnly)
@@ -359,6 +361,7 @@ protected function getFindChildrenSql(ObjectIdentityInterface $oid, $directChild
359361
* identity.
360362
*
361363
* @param ObjectIdentityInterface $oid
364+
*
362365
* @return string
363366
*/
364367
protected function getSelectObjectIdentityIdSql(ObjectIdentityInterface $oid)
@@ -383,6 +386,7 @@ protected function getSelectObjectIdentityIdSql(ObjectIdentityInterface $oid)
383386
* Returns the primary key of the passed object identity.
384387
*
385388
* @param ObjectIdentityInterface $oid
389+
*
386390
* @return int
387391
*/
388392
final protected function retrieveObjectIdentityPrimaryKey(ObjectIdentityInterface $oid)
@@ -491,8 +495,10 @@ private function lookupObjectIdentities(array $batch, array $sids, array $oidLoo
491495
* @param Statement $stmt
492496
* @param array $oidLookup
493497
* @param array $sids
494-
* @throws \RuntimeException
498+
*
495499
* @return \SplObjectStorage
500+
*
501+
* @throws \RuntimeException
496502
*/
497503
private function hydrateObjectIdentities(Statement $stmt, array $oidLookup, array $sids)
498504
{

‎Dbal/MutableAclProvider.php

Lines changed: 50 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -354,7 +354,8 @@ public function updateAcl(MutableAclInterface $acl)
354354
/**
355355
* Constructs the SQL for deleting access control entries.
356356
*
357-
* @param int $oidPK
357+
* @param int $oidPK
358+
*
358359
* @return string
359360
*/
360361
protected function getDeleteAccessControlEntriesSql($oidPK)
@@ -369,7 +370,8 @@ protected function getDeleteAccessControlEntriesSql($oidPK)
369370
/**
370371
* Constructs the SQL for deleting a specific ACE.
371372
*
372-
* @param int $acePK
373+
* @param int $acePK
374+
*
373375
* @return string
374376
*/
375377
protected function getDeleteAccessControlEntrySql($acePK)
@@ -384,7 +386,8 @@ protected function getDeleteAccessControlEntrySql($acePK)
384386
/**
385387
* Constructs the SQL for deleting an object identity.
386388
*
387-
* @param int $pk
389+
* @param int $pk
390+
*
388391
* @return string
389392
*/
390393
protected function getDeleteObjectIdentitySql($pk)
@@ -399,7 +402,8 @@ protected function getDeleteObjectIdentitySql($pk)
399402
/**
400403
* Constructs the SQL for deleting relation entries.
401404
*
402-
* @param int $pk
405+
* @param int $pk
406+
*
403407
* @return string
404408
*/
405409
protected function getDeleteObjectIdentityRelationsSql($pk)
@@ -414,16 +418,17 @@ protected function getDeleteObjectIdentityRelationsSql($pk)
414418
/**
415419
* Constructs the SQL for inserting an ACE.
416420
*
417-
* @param int $classId
418-
* @param int|null $objectIdentityId
419-
* @param string|null $field
420-
* @param int $aceOrder
421-
* @param int $securityIdentityId
422-
* @param string $strategy
423-
* @param int $mask
424-
* @param bool $granting
425-
* @param bool $auditSuccess
426-
* @param bool $auditFailure
421+
* @param int $classId
422+
* @param int|null $objectIdentityId
423+
* @param string|null $field
424+
* @param int $aceOrder
425+
* @param int $securityIdentityId
426+
* @param string $strategy
427+
* @param int $mask
428+
* @param bool $granting
429+
* @param bool $auditSuccess
430+
* @param bool $auditFailure
431+
*
427432
* @return string
428433
*/
429434
protected function getInsertAccessControlEntrySql($classId, $objectIdentityId, $field, $aceOrder, $securityIdentityId, $strategy, $mask, $granting, $auditSuccess, $auditFailure)
@@ -464,6 +469,7 @@ class_id,
464469
* Constructs the SQL for inserting a new class type.
465470
*
466471
* @param string $classType
472+
*
467473
* @return string
468474
*/
469475
protected function getInsertClassSql($classType)
@@ -478,8 +484,9 @@ protected function getInsertClassSql($classType)
478484
/**
479485
* Constructs the SQL for inserting a relation entry.
480486
*
481-
* @param int $objectIdentityId
482-
* @param int $ancestorId
487+
* @param int $objectIdentityId
488+
* @param int $ancestorId
489+
*
483490
* @return string
484491
*/
485492
protected function getInsertObjectIdentityRelationSql($objectIdentityId, $ancestorId)
@@ -495,9 +502,10 @@ protected function getInsertObjectIdentityRelationSql($objectIdentityId, $ancest
495502
/**
496503
* Constructs the SQL for inserting an object identity.
497504
*
498-
* @param string $identifier
499-
* @param int $classId
500-
* @param bool $entriesInheriting
505+
* @param string $identifier
506+
* @param int $classId
507+
* @param bool $entriesInheriting
508+
*
501509
* @return string
502510
*/
503511
protected function getInsertObjectIdentitySql($identifier, $classId, $entriesInheriting)
@@ -520,7 +528,9 @@ protected function getInsertObjectIdentitySql($identifier, $classId, $entriesInh
520528
* Constructs the SQL for inserting a security identity.
521529
*
522530
* @param SecurityIdentityInterface $sid
531+
*
523532
* @throws \InvalidArgumentException
533+
*
524534
* @return string
525535
*/
526536
protected function getInsertSecurityIdentitySql(SecurityIdentityInterface $sid)
@@ -546,10 +556,11 @@ protected function getInsertSecurityIdentitySql(SecurityIdentityInterface $sid)
546556
/**
547557
* Constructs the SQL for selecting an ACE.
548558
*
549-
* @param int $classId
550-
* @param int $oid
551-
* @param string $field
552-
* @param int $order
559+
* @param int $classId
560+
* @param int $oid
561+
* @param string $field
562+
* @param int $order
563+
*
553564
* @return string
554565
*/
555566
protected function getSelectAccessControlEntryIdSql($classId, $oid, $field, $order)
@@ -573,6 +584,7 @@ protected function getSelectAccessControlEntryIdSql($classId, $oid, $field, $ord
573584
* the passed class type.
574585
*
575586
* @param string $classType
587+
*
576588
* @return string
577589
*/
578590
protected function getSelectClassIdSql($classType)
@@ -588,7 +600,9 @@ protected function getSelectClassIdSql($classType)
588600
* Constructs the SQL for selecting the primary key of a security identity.
589601
*
590602
* @param SecurityIdentityInterface $sid
603+
*
591604
* @throws \InvalidArgumentException
605+
*
592606
* @return string
593607
*/
594608
protected function getSelectSecurityIdentityIdSql(SecurityIdentityInterface $sid)
@@ -614,9 +628,11 @@ protected function getSelectSecurityIdentityIdSql(SecurityIdentityInterface $sid
614628
/**
615629
* Constructs the SQL for updating an object identity.
616630
*
617-
* @param int $pk
618-
* @param array $changes
631+
* @param int $pk
632+
* @param array $changes
633+
*
619634
* @throws \InvalidArgumentException
635+
*
620636
* @return string
621637
*/
622638
protected function getUpdateObjectIdentitySql($pk, array $changes)
@@ -636,9 +652,11 @@ protected function getUpdateObjectIdentitySql($pk, array $changes)
636652
/**
637653
* Constructs the SQL for updating an ACE.
638654
*
639-
* @param int $pk
640-
* @param array $sets
655+
* @param int $pk
656+
* @param array $sets
657+
*
641658
* @throws \InvalidArgumentException
659+
*
642660
* @return string
643661
*/
644662
protected function getUpdateAccessControlEntrySql($pk, array $sets)
@@ -673,6 +691,7 @@ private function createObjectIdentity(ObjectIdentityInterface $oid)
673691
* If the type does not yet exist in the database, it will be created.
674692
*
675693
* @param string $classType
694+
*
676695
* @return int
677696
*/
678697
private function createOrRetrieveClassId($classType)
@@ -693,6 +712,7 @@ private function createOrRetrieveClassId($classType)
693712
* created.
694713
*
695714
* @param SecurityIdentityInterface $sid
715+
*
696716
* @return int
697717
*/
698718
private function createOrRetrieveSecurityIdentityId(SecurityIdentityInterface $sid)
@@ -709,7 +729,7 @@ private function createOrRetrieveSecurityIdentityId(SecurityIdentityInterface $s
709729
/**
710730
* Deletes all ACEs for the given object identity primary key.
711731
*
712-
* @param int $oidPK
732+
* @param int $oidPK
713733
*/
714734
private function deleteAccessControlEntries($oidPK)
715735
{
@@ -719,7 +739,7 @@ private function deleteAccessControlEntries($oidPK)
719739
/**
720740
* Deletes the object identity from the database.
721741
*
722-
* @param int $pk
742+
* @param int $pk
723743
*/
724744
private function deleteObjectIdentity($pk)
725745
{
@@ -729,7 +749,7 @@ private function deleteObjectIdentity($pk)
729749
/**
730750
* Deletes all entries from the relations table from the database.
731751
*
732-
* @param int $pk
752+
* @param int $pk
733753
*/
734754
private function deleteObjectIdentityRelations($pk)
735755
{

‎Domain/Acl.php

Lines changed: 25 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -397,8 +397,9 @@ public function updateObjectFieldAuditing($index, $field, $auditSuccess, $auditF
397397
/**
398398
* Deletes an ACE
399399
*
400-
* @param string $property
401-
* @param int $index
400+
* @param string $property
401+
* @param int $index
402+
*
402403
* @throws \OutOfBoundsException
403404
*/
404405
private function deleteAce($property, $index)
@@ -421,9 +422,10 @@ private function deleteAce($property, $index)
421422
/**
422423
* Deletes a field-based ACE
423424
*
424-
* @param string $property
425-
* @param int $index
426-
* @param string $field
425+
* @param string $property
426+
* @param int $index
427+
* @param string $field
428+
*
427429
* @throws \OutOfBoundsException
428430
*/
429431
private function deleteFieldAce($property, $index, $field)
@@ -452,6 +454,7 @@ private function deleteFieldAce($property, $index, $field)
452454
* @param SecurityIdentityInterface $sid
453455
* @param bool $granting
454456
* @param string $strategy
457+
*
455458
* @throws \OutOfBoundsException
456459
* @throws \InvalidArgumentException
457460
*/
@@ -501,6 +504,7 @@ private function insertAce($property, $index, $mask, SecurityIdentityInterface $
501504
* @param SecurityIdentityInterface $sid
502505
* @param bool $granting
503506
* @param string $strategy
507+
*
504508
* @throws \InvalidArgumentException
505509
* @throws \OutOfBoundsException
506510
*/
@@ -551,10 +555,11 @@ private function insertFieldAce($property, $index, $field, $mask, SecurityIdenti
551555
/**
552556
* Updates an ACE
553557
*
554-
* @param string $property
555-
* @param int $index
556-
* @param int $mask
557-
* @param string $strategy
558+
* @param string $property
559+
* @param int $index
560+
* @param int $mask
561+
* @param string $strategy
562+
*
558563
* @throws \OutOfBoundsException
559564
*/
560565
private function updateAce($property, $index, $mask, $strategy = null)
@@ -578,10 +583,11 @@ private function updateAce($property, $index, $mask, $strategy = null)
578583
/**
579584
* Updates auditing for an ACE
580585
*
581-
* @param array &$aces
582-
* @param int $index
583-
* @param bool $auditSuccess
584-
* @param bool $auditFailure
586+
* @param array &$aces
587+
* @param int $index
588+
* @param bool $auditSuccess
589+
* @param bool $auditFailure
590+
*
585591
* @throws \OutOfBoundsException
586592
*/
587593
private function updateAuditing(array &$aces, $index, $auditSuccess, $auditFailure)
@@ -604,11 +610,12 @@ private function updateAuditing(array &$aces, $index, $auditSuccess, $auditFailu
604610
/**
605611
* Updates a field-based ACE
606612
*
607-
* @param string $property
608-
* @param int $index
609-
* @param string $field
610-
* @param int $mask
611-
* @param string $strategy
613+
* @param string $property
614+
* @param int $index
615+
* @param string $field
616+
* @param int $mask
617+
* @param string $strategy
618+
*
612619
* @throws \InvalidArgumentException
613620
* @throws \OutOfBoundsException
614621
*/

‎Domain/DoctrineAclCache.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,7 @@ public function putInCache(AclInterface $acl)
147147
* Unserializes the ACL.
148148
*
149149
* @param string $serialized
150+
*
150151
* @return AclInterface
151152
*/
152153
private function unserializeAcl($serialized)
@@ -205,6 +206,7 @@ private function unserializeAcl($serialized)
205206
* Returns the key for the object identity
206207
*
207208
* @param ObjectIdentityInterface $oid
209+
*
208210
* @return string
209211
*/
210212
private function getDataKeyByIdentity(ObjectIdentityInterface $oid)
@@ -217,6 +219,7 @@ private function getDataKeyByIdentity(ObjectIdentityInterface $oid)
217219
* Returns the alias key for the object identity key
218220
*
219221
* @param string $aclId
222+
*
220223
* @return string
221224
*/
222225
private function getAliasKeyForIdentity($aclId)

0 commit comments

Comments
 (0)
0