Sandbox Url

: http://drupal.org/sandbox/gokulnk/1270692.

Git Url

: git clone http://git.drupal.org/sandbox/gokulnk/1270692.git developer_quick_links.

Coding standards

: Ran through coder module with no warnings and errors.

Category

: Development add on module

Existing modules

: Searched through the Drupal modules didn't find any similar modules. Module with closest functionality admin menu. But this module makes it easier for the developers who know the actual urls like node/add/page or admin/settings/performance or admin/content/node-type/page/fields. They can just type the part of the url and get all the suggested links and hence reducing the development time.

Module Description

: Quicklinks is a drupal module that helps the developers to quickly find the
right urls(menu paths) that they are looking for. It is available in the form of a block
as well as a page.

For those of you who are used to the linux style auto-suggest this can be
very handy.

So the next time you want to go to the performance page you need
not think whether it is a sub-menu of Site building or Site configurations,
just type the "performace" in the search box and get a list of all the related
links.

Or if you want to manage fields of a content type you need not go to Content
Management menu first, then Content types sub-menu, then particular contenty type
and then click on the manage fields. Just type "page/fields"

Links with the keyword "remove" in them are not populated as a safety measure,
so that nothing is deleted by mistake.

CommentFileSizeAuthor
Selection_046.png25.19 KBgokulnk
Selection_047.png22.62 KBgokulnk

Comments

gokulnk’s picture

Priority: Normal » Major
Everett Zufelt’s picture

Priority: Major » Normal
Status: Needs review » Needs work

Looks useful:

I wonder why you are writing custom code for the ajax callback, when you could be extending the autocomplete functionality already available on textfield in Core?

1. ; $Id:$
is no longer required.

2. Typo in .info description

3. version not required in .info, packager will take care of this.

4. Does the JS need to be added on every page load in hook_init()?

5. $items['quicklinks/get_suggestions'] = array( ... normally paths are hyphenated, not underscores

6. function get_quicklinks_for_input()
Function names should start with module name. Consider changing to function quicklinks_get_links_for_input()

gokulnk’s picture

Status: Needs work » Needs review

Hi Everett Zufelt ,

Thanks for your review and suggestions. I have implemented your suggestions.

Regarding your question, its not just the text value that I want, I want the links here. Since I want the rendered html to populated in the div below the search box, I am not extending the autocomplete functionality already available on textfield in Core.

gokulnk’s picture

Priority: Normal » Major
13rac1’s picture

Status: Needs review » Needs work

datestamp = "1290589869" - Is not required in info, packager does this.

Please use a 6.x-1.x branch rather than the master branch.

gokulnk’s picture

Status: Needs work » Needs review

Hi eosrei,
Thanks for the suggestions. I have implemented them.

klausi’s picture

Status: Needs review » Needs work

It appears you are working in the "master" branch in git. You should really be working in a version specific branch. The most direct documentation on this is Moving from a master branch to a version branch. For additional resources please see the documentation about release naming conventions and creating a branch in git.
Review of the master branch:

  • Run coder to check your style, some issues were found (please check the Drupal coding standards):
    Severity minor, Drupal Commenting Standards, Internationalization, Drupal Security Checks, Drupal SQL Standards, Drupal Coding Standards
    
    sites/all/modules/pareview_temp/test_candidate/quicklinks.module:
     +4: [minor] @file description should be on the following line
     +7: [minor] There should be no trailing spaces
     +12: [minor] Comment should be read "Implements hook_foo()."
     +36: [minor] Comment should be read "Implements hook_foo()."
     +51: [minor] There should be no trailing spaces
     +52: [minor] There should be no trailing spaces
     +53: [minor] There should be no trailing spaces
     +54: [minor] There should be no trailing spaces
     +64: [minor] There should be no trailing spaces
     +85: [minor] Comment should be read "Implements hook_foo()."
     +98: [minor] Potential problem: use the Form API to prevent against CSRF attacks. If you need to use $_POST variables, ensure they are fully sanitized if displayed by using check_plain(), !f
    ilter_xss() or similar.
     +101: [minor] There should be no trailing spaces
     +102: [minor] There should be no trailing spaces
     +104: [minor] There should be no trailing spaces
     +105: [minor] There should be no trailing spaces
    
    Status Messages:
     Coder found 1 projects, 2 files, 15 minor warnings, 0 warnings were flagged to be ignored
    
  • Lines in README.txt should not exceed 80 characters, see the guidelines for in-project documentation.
  • Comments: there should be a space after "//".
    quicklinks.module:66:            //Saving the vid to the db
    
  • ./quicklinks.module: all functions should have doxygen doc blocks, see http://drupal.org/node/1354#functions
    
    function quicklinks_menu() {
    --
    
    function quicklinks_get_links_for_input() {
    --
    
    function quicklinks_content() {
    

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

gokulnk’s picture

Status: Needs work » Needs review

Hi Klausi,

I am using 6.x-1.x branch now and have implemented the suggestions. Thanks for the review.

klausi’s picture

Status: Needs review » Needs work

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

  • Run coder to check your style, some issues were found (please check the Drupal coding standards):
    Severity minor, Drupal Commenting Standards, Internationalization, Drupal Security Checks, Drupal SQL Standards, Drupal Coding Standards
    
    sites/all/modules/pareview_temp/test_candidate/quicklinks.module:
     +98: [minor] Potential problem: use the Form API to prevent against CSRF attacks. If you need to use $_POST variables, ensure they are fully sanitized if displayed by using check_plain(), !f
    ilter_xss() or similar.
     +117: [minor] There should be no trailing spaces
    
    Status Messages:
     Coder found 1 projects, 2 files, 2 minor warnings, 0 warnings were flagged to be ignored
    
  • Lines in README.txt should not exceed 80 characters, see the guidelines for in-project documentation.

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

manual review:

  • quicklinks.js: indentation should be always 2 spaces, also in javascript files.
  • info file: "core = 6.x-1.x" should be "core = 6.x"
  • quicklinks_block(): "case 'save':": indentation errors, always use 2 spaces per level.
  • quicklinks_get_links_for_input(): indentation errors on the while loop.
  • "$items['get-suggestions'] = array(": Better use your module name in the path to avoid collisions with other modules. And why is this a MENU_NORMAL_ITEM? I thought it is only used as ajax callback?
gokulnk’s picture

Hi Klausi,

I have implemented all the changes suggested by you and your module.

However I must appreciate you for the great work you are doing and the way your PAreview has been helping fasten the module review code process. Keep up the good work.

gokulnk’s picture

Status: Needs work » Needs review
13rac1’s picture

Status: Needs review » Needs work

I just found: http://drupal.org/project/teleport ? Seems as though you should apply to become the new maintainer of teleport rather than create a new module.

misc’s picture

@gokulnk 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

misc’s picture

Status: Needs work » Closed (won't fix)

The application has been closed. If you would like to reopen it, you are free to do so.
See http://drupal.org/node/894256#abandonedtwoweekscontact

avpaderno’s picture

Title: Developer Quick Links » [D6] Developer Quick Links
avpaderno’s picture

Priority: Major » Normal
Status: Closed (won't fix) » Closed (duplicate)
Related issues: +#2510992: [D7] Pay With Amazon Integration