Entity Notes allows you to add a note to any Entities in your site. This allows you to add notes to users, comments, nodes, etc. You can set different permissions to allow different access to each notes.

The code has run through coder review module.

Sandbox Page:
http://drupal.org/sandbox/webadpro/1307956

Drupal Core:
Drupal 7

CommentFileSizeAuthor
#20 coder-result.txt4.79 KBklausi
#5 Screenshot109.16 KBwebadpro

Comments

joachim’s picture

In what way are notes different from comments?

There's certainly a need for a generalized comment-for-entities module. It sounds like this isn't far off from that, but I'd rather see the Drupal terminology kept.

webadpro’s picture

Entity Notes is more than just comments. This creates an extra tab "Note" where you could use for admin if you wish. The project was initially used to add admin notes to users account for support. I don't think comments are the same as entity notes. You could add a note to a comment if you'd like to.

As for comments in Drupal, comments are added after the content where this module isn't made to do that.

joachim’s picture

Thanks for the explanation. It might be a good idea to post a screenshot to explain this difference.

webadpro’s picture

Please view post under.

webadpro’s picture

StatusFileSize
new109.16 KB

As requested.

joachim’s picture

> * Provides a Mail In Payment method for Drupal Commerce

ORLY? ;)

> * an object as returned by entity_load()

Should be written as a sentence: capital letter and full stop.

> 'title' => t("View any Notes")

Compare the capitalization with core permissions, perhaps.

> if (empty($entity)) return FALSE;

if statements always need {}, and on separate lines.

- you need a newline at the end of files.

> function entity_notes_views_query_alter(&$view, &$query) {

Missing a function docblock.

Generally the code looks pretty good -- all my comments are minor detail.

I'm still unsure about the way this is largely doing what comments do...

webadpro’s picture

Thanks for reviewing. I will fix the errors mentioned. As for the first bug, yeah, I must've started the project with a default template I always use, and I forgot to remove the comment.

webadpro’s picture

I have fixed all the bugs that has been mentioned. As for what is the difference between comments & entity notes, well I did explain it earlier and provided the requested screenshot. I've used the code in a live environment and i feel like it is not really the same as comments but that is my opinion.

sreynen’s picture

Status: Needs review » Needs work

Hi webadpro,

Please set this back to "needs review" after fixing these issues:

  • Project description needs more info. See: http://drupal.org/node/997024
  • It wasn't clear to me how to use this module. You should add a README.txt with instructions.
  • I eventually found the configuration at admin/config/content/entity_notes/settings by looking in the code. You should point to that in the .info file. See: http://drupal.org/node/542202 After enabling notes on a content type, I don't see any way to add notes to nodes of that type.
  • You should create a 7.x-1.x branch in Git, which you'll need to do your first release once this is a full project.

I don't see any problems just looking at the code, but since I couldn't figure out how to actually create notes, I wasn't able to do much testing.

joachim’s picture

> As for what is the difference between comments & entity notes, well I did explain it earlier and provided the requested screenshot.

Yup, I had a look.
It looks like comments, but presented in a slightly different way. Would you ever use both comments *and* notes on a single entity?

webadpro’s picture

-> It looks like comments, but presented in a slightly different way. Would you ever use both comments *and* notes on a single entity?

You sure could use both. As an example lets say you have a content type Invoice, where some discussions could be be made using comments but the admins could add in some notes for the invoice where you wouldn't want the user to view.

webadpro’s picture

sreynen, i will add the missing files and instructions how to use the module.

Thanks a lot for reviewing.

webadpro’s picture

@sreynen, I made all the changes that you did mention.

Would it be possible to review once again?

joachim’s picture

I understand that they're presented differently, and have different purposes.

But surely under the hood they're the same kind of thing -- an entity that's completely attached to another one, with a UI for posting and updating them and outputting then.
Hence I can't help but feel that this is the sort of thing a decoupled comment module should be able to support: multiple types of comment on one entity type, with different output.

I'm not going to let this stand in the way of this application, as that work on comment is a huge task and will take a long time. But perhaps you'd like to take a look at #731724: Convert comment settings into a field to make them work with CMI and non-node entities, perhaps lend the experience you'd built up working on this module, and consider a dependency on comment module in the long term?

webadpro’s picture

Joachim, I would agree with you that comment would probably be something similar in the way its binded to entities. I will have a look at the post you mentioned, and ill see how can I help.

Thanks.

webadpro’s picture

Status: Needs work » Needs review

Changing the status of this application.

webadpro’s picture

What are the next step I must take, or do I still have to wait to get it reviewed once again?

sreynen’s picture

webadpro, this just needs someone to review it again. There are many projects awaiting review, so it's sometimes slow. If you'd like to speed things up, I recommend reviewing someone else's project following the guidelines.

webadpro’s picture

Okay I see. Well, lets see what I can do.

Thanks.

klausi’s picture

Status: Needs review » Needs work
StatusFileSize
new4.79 KB

Review of the 7.x-1.x branch:

  • Run coder to check your style, some issues were found (please check the Drupal coding standards). See attachment.
  • Lines in README.txt should not exceed 80 characters, see the guidelines for in-project documentation.
  • Comments: there should be a space after "//".
    entity_notes.admin.inc:9:  //Include the css file
    entity_notes.admin.inc:12:  //Get default values
    entity_notes.admin.inc:115:      //Delete an exsisting entity
    entity_notes.admin.inc:131:        //Update entity
    entity_notes.admin.inc:136:        //Add new entity
    entity_notes.admin.inc:144:  //Rebuild the menu to activate the new changes.
    entity_notes.module:230:  //Bypass all the permissions
    entity_notes.module:241:      //Add hooks to allow users to add their custom access hooks to certain entities.
    entity_notes.module:451:  //Update note
    entity_notes.module:459:  //Save new note  
    views/handlers/entity_notes_handler_field_note_operations.inc:39:    //Check if user has access to delete this note
    views/handlers/entity_notes_handler_field_note_operations.inc:43:    //Check if user has access to modify this note
    views/entity_notes.views.inc:223:      //If the user doesn't have any permissions then set uid to -1 to return no results.
    
  • ./entity_notes.module: comment lines should break at 80 characters, see http://drupal.org/node/1354#general
          //Add hooks to allow users to add their custom access hooks to certain entities.
    
  • ./views/entity_notes.views.inc: comment lines should break at 80 characters, see http://drupal.org/node/1354#general
          //If the user doesn't have any permissions then set uid to -1 to return no results.
    
  • views/entity_notes.views.views.inc in entity_notes.info: It's only necessary to declare files[] if they declare a class or interface.
  • ./entity_notes.admin.inc: all functions should have doxygen doc blocks, see http://drupal.org/node/1354#functions
    
    function entity_notes_manage_note() {
    
  • ./entity_notes.module: all functions should be prefixed with your module/theme name to avoid name clashes. See http://drupal.org/node/318#naming
    function entity_note_get_entities($options = array()) {
    
  • ./entity_notes.module: The description for the @param/@return documentation is either missing or not formatted correctly. See http://drupal.org/node/1354#functions
    63- *  An object as returned by entity_load().
    

This automated report was generated with PAReview.sh, your friendly project application review script. Please report any bugs to klausi.

webadpro’s picture

Strange that coder returns warnings because when I did run it, it wasnt returning anything. Thanks klausi for reviewing, ill fix that.

misc’s picture

Applicant has been contacted to ask if the application is abandoned.

After ten weeks with a status of needs work: the applicant may be contacted by a reviewer to determine whether the application was indeed abandoned. The action taken by the reviewer should be documented in the project application issue.

http://drupal.org/node/894256

webadpro’s picture

Hi,

Sorry for the delay, but no this project is still active. I've simply run out of time lately to fix the issues. I will try get them fix asap.

Thanks

misc’s picture

No problem. Could we mark this as postponed until you got the time to work on it?

webadpro’s picture

Status: Needs work » Postponed

Sure, I just did.

I will change its status back to needs review once i'm done.

klausi’s picture

Status: Postponed » Closed (won't fix)

Closing due to lack of activity. Feel free to reopen if you are still working on this application.