mbk-lab
/
nextcloud
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

types shall always be plural

This commit is contained in:
Arthur Schiwon 2016-02-03 19:28:15 +01:00
parent c0322b3f98
commit 9370491822
7 changed files with 45 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
lib/private/comments/comment.php
View File

@ -242,7 +242,7 @@ class Comment implements IComment {
/** /**
* sets (overwrites) the actor type and id * sets (overwrites) the actor type and id
* *
* @param string $actorType e.g. 'user' * @param string $actorType e.g. 'users'
* @param string $actorId e.g. 'zombie234' * @param string $actorId e.g. 'zombie234'
* @return IComment * @return IComment
* @since 9.0.0 * @since 9.0.0
@ -328,7 +328,7 @@ class Comment implements IComment {
/** /**
* sets (overwrites) the object of the comment * sets (overwrites) the object of the comment
* *
* @param string $objectType e.g. 'file' * @param string $objectType e.g. 'files'
* @param string $objectId e.g. '16435' * @param string $objectId e.g. '16435'
* @return IComment * @return IComment
* @since 9.0.0 * @since 9.0.0

6
lib/private/comments/manager.php
View File

@ -384,7 +384,7 @@ class Manager implements ICommentsManager {
* saved in the used data storage. Use save() after setting other fields * saved in the used data storage. Use save() after setting other fields
* of the comment (e.g. message or verb). * of the comment (e.g. message or verb).
* *
* @param string $actorType the actor type (e.g. 'user') * @param string $actorType the actor type (e.g. 'users')
* @param string $actorId a user id * @param string $actorId a user id
* @param string $objectType the object type the comment is attached to * @param string $objectType the object type the comment is attached to
* @param string $objectId the object id the comment is attached to * @param string $objectId the object id the comment is attached to
@ -533,7 +533,7 @@ class Manager implements ICommentsManager {
* removes references to specific actor (e.g. on user delete) of a comment. * removes references to specific actor (e.g. on user delete) of a comment.
* The comment itself must not get lost/deleted. * The comment itself must not get lost/deleted.
* *
* @param string $actorType the actor type (e.g. 'user') * @param string $actorType the actor type (e.g. 'users')
* @param string $actorId a user id * @param string $actorId a user id
* @return boolean * @return boolean
* @since 9.0.0 * @since 9.0.0
@ -560,7 +560,7 @@ class Manager implements ICommentsManager {
/** /**
* deletes all comments made of a specific object (e.g. on file delete) * deletes all comments made of a specific object (e.g. on file delete)
* *
* @param string $objectType the object type (e.g. 'file') * @param string $objectType the object type (e.g. 'files')
* @param string $objectId e.g. the file id * @param string $objectId e.g. the file id
* @return boolean * @return boolean
* @since 9.0.0 * @since 9.0.0

2
lib/private/user/user.php
View File

@ -210,7 +210,7 @@ class User implements IUser {
// Delete the users entry in the storage table // Delete the users entry in the storage table
\OC\Files\Cache\Storage::remove('home::' . $this->uid); \OC\Files\Cache\Storage::remove('home::' . $this->uid);
\OC::$server->getCommentsManager()->deleteReferencesOfActor('user', $this->uid); \OC::$server->getCommentsManager()->deleteReferencesOfActor('users', $this->uid);
\OC::$server->getCommentsManager()->deleteReadMarksFromUser($this); \OC::$server->getCommentsManager()->deleteReadMarksFromUser($this);
} }

4
lib/public/comments/icomment.php
View File

@ -161,7 +161,7 @@ interface IComment {
/** /**
* sets (overwrites) the actor type and id * sets (overwrites) the actor type and id
* *
* @param string $actorType e.g. 'user' * @param string $actorType e.g. 'users'
* @param string $actorId e.g. 'zombie234' * @param string $actorId e.g. 'zombie234'
* @return IComment * @return IComment
* @since 9.0.0 * @since 9.0.0
@ -223,7 +223,7 @@ interface IComment {
/** /**
* sets (overwrites) the object of the comment * sets (overwrites) the object of the comment
* *
* @param string $objectType e.g. 'file' * @param string $objectType e.g. 'files'
* @param string $objectId e.g. '16435' * @param string $objectId e.g. '16435'
* @return IComment * @return IComment
* @since 9.0.0 * @since 9.0.0

10
lib/public/comments/icommentsmanager.php
View File

@ -39,7 +39,7 @@ interface ICommentsManager {
* *
* User interfaces shall show "Deleted user" as display name, if needed. * User interfaces shall show "Deleted user" as display name, if needed.
*/ */
const DELETED_USER = 'deleted_user'; const DELETED_USER = 'deleted_users';
/** /**
* returns a comment instance * returns a comment instance
@ -127,7 +127,7 @@ interface ICommentsManager {
* saved in the used data storage. Use save() after setting other fields * saved in the used data storage. Use save() after setting other fields
* of the comment (e.g. message or verb). * of the comment (e.g. message or verb).
* *
* @param string $actorType the actor type (e.g. 'user') * @param string $actorType the actor type (e.g. 'users')
* @param string $actorId a user id * @param string $actorId a user id
* @param string $objectType the object type the comment is attached to * @param string $objectType the object type the comment is attached to
* @param string $objectId the object id the comment is attached to * @param string $objectId the object id the comment is attached to
@ -170,10 +170,10 @@ interface ICommentsManager {
* removes references to specific actor (e.g. on user delete) of a comment. * removes references to specific actor (e.g. on user delete) of a comment.
* The comment itself must not get lost/deleted. * The comment itself must not get lost/deleted.
* *
* A 'user' type actor (type and id) should get replaced by the * A 'users' type actor (type and id) should get replaced by the
* value of the DELETED_USER constant of this interface. * value of the DELETED_USER constant of this interface.
* *
* @param string $actorType the actor type (e.g. 'user') * @param string $actorType the actor type (e.g. 'users')
* @param string $actorId a user id * @param string $actorId a user id
* @return boolean * @return boolean
* @since 9.0.0 * @since 9.0.0
@ -183,7 +183,7 @@ interface ICommentsManager {
/** /**
* deletes all comments made of a specific object (e.g. on file delete) * deletes all comments made of a specific object (e.g. on file delete)
* *
* @param string $objectType the object type (e.g. 'file') * @param string $objectType the object type (e.g. 'files')
* @param string $objectId e.g. the file id * @param string $objectId e.g. the file id
* @return boolean * @return boolean
* @since 9.0.0 * @since 9.0.0

8
tests/lib/comments/comment.php
View File

@ -15,10 +15,10 @@ class Test_Comments_Comment extends TestCase
$childrenCount = 6; $childrenCount = 6;
$message = 'I like to comment comment'; $message = 'I like to comment comment';
$verb = 'comment'; $verb = 'comment';
$actor = ['type' => 'user', 'id' => 'alice']; $actor = ['type' => 'users', 'id' => 'alice'];
$creationDT = new \DateTime(); $creationDT = new \DateTime();
$latestChildDT = new \DateTime('yesterday'); $latestChildDT = new \DateTime('yesterday');
$object = ['type' => 'file', 'id' => 'file64']; $object = ['type' => 'files', 'id' => 'file64'];
$comment $comment
->setId($id) ->setId($id)
@ -87,11 +87,11 @@ class Test_Comments_Comment extends TestCase
public function roleSetterProvider() { public function roleSetterProvider() {
return [ return [
['Actor', true, true], ['Actor', true, true],
['Actor', 'user', true], ['Actor', 'users', true],
['Actor', true, 'alice'], ['Actor', true, 'alice'],
['Actor', ' ', ' '], ['Actor', ' ', ' '],
['Object', true, true], ['Object', true, true],
['Object', 'file', true], ['Object', 'files', true],
['Object', true, 'file64'], ['Object', true, 'file64'],
['Object', ' ', ' '], ['Object', ' ', ' '],
]; ];

56
tests/lib/comments/manager.php
View File

@ -35,13 +35,13 @@ class Test_Comments_Manager extends TestCase
'parent_id' => $qb->createNamedParameter($parentId), 'parent_id' => $qb->createNamedParameter($parentId),
'topmost_parent_id' => $qb->createNamedParameter($topmostParentId), 'topmost_parent_id' => $qb->createNamedParameter($topmostParentId),
'children_count' => $qb->createNamedParameter(2), 'children_count' => $qb->createNamedParameter(2),
'actor_type' => $qb->createNamedParameter('user'), 'actor_type' => $qb->createNamedParameter('users'),
'actor_id' => $qb->createNamedParameter('alice'), 'actor_id' => $qb->createNamedParameter('alice'),
'message' => $qb->createNamedParameter('nice one'), 'message' => $qb->createNamedParameter('nice one'),
'verb' => $qb->createNamedParameter('comment'), 'verb' => $qb->createNamedParameter('comment'),
'creation_timestamp' => $qb->createNamedParameter($creationDT, 'datetime'), 'creation_timestamp' => $qb->createNamedParameter($creationDT, 'datetime'),
'latest_child_timestamp' => $qb->createNamedParameter($latestChildDT, 'datetime'), 'latest_child_timestamp' => $qb->createNamedParameter($latestChildDT, 'datetime'),
'object_type' => $qb->createNamedParameter('file'), 'object_type' => $qb->createNamedParameter('files'),
'object_id' => $qb->createNamedParameter('file64'), 'object_id' => $qb->createNamedParameter('file64'),
]) ])
->execute(); ->execute();
@ -83,13 +83,13 @@ class Test_Comments_Manager extends TestCase
'parent_id' => $qb->createNamedParameter('2'), 'parent_id' => $qb->createNamedParameter('2'),
'topmost_parent_id' => $qb->createNamedParameter('1'), 'topmost_parent_id' => $qb->createNamedParameter('1'),
'children_count' => $qb->createNamedParameter(2), 'children_count' => $qb->createNamedParameter(2),
'actor_type' => $qb->createNamedParameter('user'), 'actor_type' => $qb->createNamedParameter('users'),
'actor_id' => $qb->createNamedParameter('alice'), 'actor_id' => $qb->createNamedParameter('alice'),
'message' => $qb->createNamedParameter('nice one'), 'message' => $qb->createNamedParameter('nice one'),
'verb' => $qb->createNamedParameter('comment'), 'verb' => $qb->createNamedParameter('comment'),
'creation_timestamp' => $qb->createNamedParameter($creationDT, 'datetime'), 'creation_timestamp' => $qb->createNamedParameter($creationDT, 'datetime'),
'latest_child_timestamp' => $qb->createNamedParameter($latestChildDT, 'datetime'), 'latest_child_timestamp' => $qb->createNamedParameter($latestChildDT, 'datetime'),
'object_type' => $qb->createNamedParameter('file'), 'object_type' => $qb->createNamedParameter('files'),
'object_id' => $qb->createNamedParameter('file64'), 'object_id' => $qb->createNamedParameter('file64'),
]) ])
->execute(); ->execute();
@ -102,11 +102,11 @@ class Test_Comments_Manager extends TestCase
$this->assertSame($comment->getParentId(), '2'); $this->assertSame($comment->getParentId(), '2');
$this->assertSame($comment->getTopmostParentId(), '1'); $this->assertSame($comment->getTopmostParentId(), '1');
$this->assertSame($comment->getChildrenCount(), 2); $this->assertSame($comment->getChildrenCount(), 2);
$this->assertSame($comment->getActorType(), 'user'); $this->assertSame($comment->getActorType(), 'users');
$this->assertSame($comment->getActorId(), 'alice'); $this->assertSame($comment->getActorId(), 'alice');
$this->assertSame($comment->getMessage(), 'nice one'); $this->assertSame($comment->getMessage(), 'nice one');
$this->assertSame($comment->getVerb(), 'comment'); $this->assertSame($comment->getVerb(), 'comment');
$this->assertSame($comment->getObjectType(), 'file'); $this->assertSame($comment->getObjectType(), 'files');
$this->assertSame($comment->getObjectId(), 'file64'); $this->assertSame($comment->getObjectId(), 'file64');
$this->assertEquals($comment->getCreationDateTime(), $creationDT); $this->assertEquals($comment->getCreationDateTime(), $creationDT);
$this->assertEquals($comment->getLatestChildDateTime(), $latestChildDT); $this->assertEquals($comment->getLatestChildDateTime(), $latestChildDT);
@ -207,7 +207,7 @@ class Test_Comments_Manager extends TestCase
$this->addDatabaseEntry(0, 0); $this->addDatabaseEntry(0, 0);
$manager = $this->getManager(); $manager = $this->getManager();
$comments = $manager->getForObject('file', 'file64'); $comments = $manager->getForObject('files', 'file64');
$this->assertTrue(is_array($comments)); $this->assertTrue(is_array($comments));
$this->assertSame(count($comments), 1); $this->assertSame(count($comments), 1);
@ -227,7 +227,7 @@ class Test_Comments_Manager extends TestCase
$manager = $this->getManager(); $manager = $this->getManager();
$offset = 0; $offset = 0;
do { do {
$comments = $manager->getForObject('file', 'file64', 3, $offset); $comments = $manager->getForObject('files', 'file64', 3, $offset);
$this->assertTrue(is_array($comments)); $this->assertTrue(is_array($comments));
foreach($comments as $comment) { foreach($comments as $comment) {
@ -247,7 +247,7 @@ class Test_Comments_Manager extends TestCase
$id2 = $this->addDatabaseEntry(2, 2, new \DateTime('-2 hours')); $id2 = $this->addDatabaseEntry(2, 2, new \DateTime('-2 hours'));
$manager = $this->getManager(); $manager = $this->getManager();
$comments = $manager->getForObject('file', 'file64', 0, 0, new \DateTime('-4 hours')); $comments = $manager->getForObject('files', 'file64', 0, 0, new \DateTime('-4 hours'));
$this->assertSame(count($comments), 2); $this->assertSame(count($comments), 2);
$this->assertSame($comments[0]->getId(), strval($id2)); $this->assertSame($comments[0]->getId(), strval($id2));
@ -266,7 +266,7 @@ class Test_Comments_Manager extends TestCase
$manager = $this->getManager(); $manager = $this->getManager();
$offset = 0; $offset = 0;
do { do {
$comments = $manager->getForObject('file', 'file64', 3, $offset, new \DateTime('-4 hours')); $comments = $manager->getForObject('files', 'file64', 3, $offset, new \DateTime('-4 hours'));
$this->assertTrue(is_array($comments)); $this->assertTrue(is_array($comments));
foreach($comments as $comment) { foreach($comments as $comment) {
@ -290,7 +290,7 @@ class Test_Comments_Manager extends TestCase
$amount = $manager->getNumberOfCommentsForObject('untype', '00'); $amount = $manager->getNumberOfCommentsForObject('untype', '00');
$this->assertSame($amount, 0); $this->assertSame($amount, 0);
$amount = $manager->getNumberOfCommentsForObject('file', 'file64'); $amount = $manager->getNumberOfCommentsForObject('files', 'file64');
$this->assertSame($amount, 4); $this->assertSame($amount, 4);
} }
@ -357,8 +357,8 @@ class Test_Comments_Manager extends TestCase
$manager = $this->getManager(); $manager = $this->getManager();
$comment = new \OC\Comments\Comment(); $comment = new \OC\Comments\Comment();
$comment $comment
->setActor('user', 'alice') ->setActor('users', 'alice')
->setObject('file', 'file64') ->setObject('files', 'file64')
->setMessage('very beautiful, I am impressed!') ->setMessage('very beautiful, I am impressed!')
->setVerb('comment'); ->setVerb('comment');
@ -377,8 +377,8 @@ class Test_Comments_Manager extends TestCase
$manager = $this->getManager(); $manager = $this->getManager();
$comment = new \OC\Comments\Comment(); $comment = new \OC\Comments\Comment();
$comment $comment
->setActor('user', 'alice') ->setActor('users', 'alice')
->setObject('file', 'file64') ->setObject('files', 'file64')
->setMessage('very beautiful, I am impressed!') ->setMessage('very beautiful, I am impressed!')
->setVerb('comment'); ->setVerb('comment');
@ -398,8 +398,8 @@ class Test_Comments_Manager extends TestCase
$manager = $this->getManager(); $manager = $this->getManager();
$comment = new \OC\Comments\Comment(); $comment = new \OC\Comments\Comment();
$comment $comment
->setActor('user', 'alice') ->setActor('users', 'alice')
->setObject('file', 'file64') ->setObject('files', 'file64')
->setMessage('very beautiful, I am impressed!') ->setMessage('very beautiful, I am impressed!')
->setVerb('comment'); ->setVerb('comment');
@ -428,8 +428,8 @@ class Test_Comments_Manager extends TestCase
for($i = 0; $i < 3; $i++) { for($i = 0; $i < 3; $i++) {
$comment = new \OC\Comments\Comment(); $comment = new \OC\Comments\Comment();
$comment $comment
->setActor('user', 'alice') ->setActor('users', 'alice')
->setObject('file', 'file64') ->setObject('files', 'file64')
->setParentId(strval($id)) ->setParentId(strval($id))
->setMessage('full ack') ->setMessage('full ack')
->setVerb('comment') ->setVerb('comment')
@ -450,7 +450,7 @@ class Test_Comments_Manager extends TestCase
[ [
['', ''], ['', ''],
[1, 'alice'], [1, 'alice'],
['user', 1], ['users', 1],
]; ];
} }
@ -473,10 +473,10 @@ class Test_Comments_Manager extends TestCase
// just to make sure they are really set, with correct actor data // just to make sure they are really set, with correct actor data
$comment = $manager->get(strval($ids[1])); $comment = $manager->get(strval($ids[1]));
$this->assertSame($comment->getActorType(), 'user'); $this->assertSame($comment->getActorType(), 'users');
$this->assertSame($comment->getActorId(), 'alice'); $this->assertSame($comment->getActorId(), 'alice');
$wasSuccessful = $manager->deleteReferencesOfActor('user', 'alice'); $wasSuccessful = $manager->deleteReferencesOfActor('users', 'alice');
$this->assertTrue($wasSuccessful); $this->assertTrue($wasSuccessful);
foreach($ids as $id) { foreach($ids as $id) {
@ -487,7 +487,7 @@ class Test_Comments_Manager extends TestCase
// actor info is gone from DB, but when database interaction is alright, // actor info is gone from DB, but when database interaction is alright,
// we still expect to get true back // we still expect to get true back
$wasSuccessful = $manager->deleteReferencesOfActor('user', 'alice'); $wasSuccessful = $manager->deleteReferencesOfActor('users', 'alice');
$this->assertTrue($wasSuccessful); $this->assertTrue($wasSuccessful);
} }
@ -496,7 +496,7 @@ class Test_Comments_Manager extends TestCase
$this->assertTrue($user instanceof \OCP\IUser); $this->assertTrue($user instanceof \OCP\IUser);
$manager = \OC::$server->getCommentsManager(); $manager = \OC::$server->getCommentsManager();
$comment = $manager->create('user', $user->getUID(), 'file', 'file64'); $comment = $manager->create('users', $user->getUID(), 'files', 'file64');
$comment $comment
->setMessage('Most important comment I ever left on the Internet.') ->setMessage('Most important comment I ever left on the Internet.')
->setVerb('comment'); ->setVerb('comment');
@ -516,7 +516,7 @@ class Test_Comments_Manager extends TestCase
[ [
['', ''], ['', ''],
[1, 'file64'], [1, 'file64'],
['file', 1], ['files', 1],
]; ];
} }
@ -539,10 +539,10 @@ class Test_Comments_Manager extends TestCase
// just to make sure they are really set, with correct actor data // just to make sure they are really set, with correct actor data
$comment = $manager->get(strval($ids[1])); $comment = $manager->get(strval($ids[1]));
$this->assertSame($comment->getObjectType(), 'file'); $this->assertSame($comment->getObjectType(), 'files');
$this->assertSame($comment->getObjectId(), 'file64'); $this->assertSame($comment->getObjectId(), 'file64');
$wasSuccessful = $manager->deleteCommentsAtObject('file', 'file64'); $wasSuccessful = $manager->deleteCommentsAtObject('files', 'file64');
$this->assertTrue($wasSuccessful); $this->assertTrue($wasSuccessful);
$verified = 0; $verified = 0;
@ -557,7 +557,7 @@ class Test_Comments_Manager extends TestCase
// actor info is gone from DB, but when database interaction is alright, // actor info is gone from DB, but when database interaction is alright,
// we still expect to get true back // we still expect to get true back
$wasSuccessful = $manager->deleteCommentsAtObject('file', 'file64'); $wasSuccessful = $manager->deleteCommentsAtObject('files', 'file64');
$this->assertTrue($wasSuccessful); $this->assertTrue($wasSuccessful);
} }