/doc/core/z_module_indexer.html

https://code.google.com/p/zotonic/ · HTML · 108 lines · 91 code · 17 blank · 0 comment · 0 complexity · 78a59ba6652a22d00aae97a4f101f3ac MD5 · raw file 

    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4. <title>Module z_module_indexer</title>
    5. 

  5. <link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
    6. 

  6. </head>
    7. 

  7. <body bgcolor="white">
    8. 

  8. <div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
    9. 

  9. <hr>
    10. 

  10. 

  11. <h1>Module z_module_indexer</h1>
    12. 

  12. <ul class="index"><li><a href="#description">Description</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>Implements the module extension mechanisms for scomps, templates, actions etc.
    13. 

  13. <p>Copyright Š 2009 Marc Worrell
    14. 

  14.   Date: 2009-06-06
    15. 

  15.  </p>
    16. 

  16. 

  17. <p><b>Behaviours:</b> <a href="gen_server.html"><tt>gen_server</tt></a>.</p>
    18. 

  18. <p><b>Authors:</b> Marc Worrell (<a href="mailto:marc@worrell.nl"><tt>marc@worrell.nl</tt></a>).</p>
    19. 

  19. 

  20. <h2><a name="description">Description</a></h2>Implements the module extension mechanisms for scomps, templates, actions etc.  Scans all active modules
    21. 

  21.   for scomps (etc) and maintains lookup lists for when the system tries to find a scomp (etc).
    22. 

  22. <h2><a name="index">Function Index</a></h2>
    23. 

  23. <table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#all-2">all/2</a></td><td>Return a list of all templates, scomps etc per module.</td></tr>
    24. 

  24. <tr><td valign="top"><a href="#code_change-3">code_change/3</a></td><td>Convert process state when code is changed.</td></tr>
    25. 

  25. <tr><td valign="top"><a href="#find-3">find/3</a></td><td>Find a scomp, validator etc.</td></tr>
    26. 

  26. <tr><td valign="top"><a href="#find_all-3">find_all/3</a></td><td>Find a scomp, validator etc.</td></tr>
    27. 

  27. <tr><td valign="top"><a href="#handle_call-3">handle_call/3</a></td><td>Find a template definition.</td></tr>
    28. 

  28. <tr><td valign="top"><a href="#handle_cast-2">handle_cast/2</a></td><td>Scan for all scomps etc.</td></tr>
    29. 

  29. <tr><td valign="top"><a href="#handle_info-2">handle_info/2</a></td><td>Handling all non call/cast messages.</td></tr>
    30. 

  30. <tr><td valign="top"><a href="#init-1">init/1</a></td><td>Initiates the server.</td></tr>
    31. 

  31. <tr><td valign="top"><a href="#reindex-1">reindex/1</a></td><td>Reindex the list of all scomps, etc for the site in the context.</td></tr>
    32. 

  32. <tr><td valign="top"><a href="#start_link-1">start_link/1</a></td><td>Starts the server.</td></tr>
    33. 

  33. <tr><td valign="top"><a href="#terminate-2">terminate/2</a></td><td>This function is called by a gen_server when it is about to
    34. 

  34.   terminate.</td></tr>
    35. 

  35. <tr><td valign="top"><a href="#translations-1">translations/1</a></td><td>Find all .po files in all modules and the active site.</td></tr>
    36. 

  36. </table>
    37. 

  37. 

  38. <h2><a name="functions">Function Details</a></h2>
    39. 

  39. 

  40. <h3 class="function"><a name="all-2">all/2</a></h3>
    41. 

  41. <div class="spec">
    42. 

  42. <p><tt>all(What, Context) -&gt; any()</tt></p>
    43. 

  43. </div><p>Return a list of all templates, scomps etc per module</p>
    44. 

  44. 

  45. <h3 class="function"><a name="code_change-3">code_change/3</a></h3>
    46. 

  46. <div class="spec">
    47. 

  47. <p><tt>code_change(OldVsn, State, Extra) -&gt; {ok, NewState}</tt></p>
    48. 

  48. </div><p>Convert process state when code is changed</p>
    49. 

  49. 

  50. <h3 class="function"><a name="find-3">find/3</a></h3>
    51. 

  51. <div class="spec">
    52. 

  52. <p><tt>find(What, Name, Context) -&gt; {ok, term()} | {error, Reason}</tt></p>
    53. 

  53. </div><p>Find a scomp, validator etc.</p>
    54. 

  54. 

  55. <h3 class="function"><a name="find_all-3">find_all/3</a></h3>
    56. 

  56. <div class="spec">
    57. 

  57. <p><tt>find_all(What, Name, Context) -&gt; list()</tt></p>
    58. 

  58. </div><p>Find a scomp, validator etc.</p>
    59. 

  59. 

  60. <h3 class="function"><a name="handle_call-3">handle_call/3</a></h3>
    61. 

  61. <div class="spec">
    62. 

  62. <p><tt>handle_call(Message::Request, From, State) -&gt; {reply, Reply, State} | {reply, Reply, State, Timeout} | {noreply, State} | {noreply, State, Timeout} | {stop, Reason, Reply, State} | {stop, Reason, State}</tt></p>
    63. 

  63. </div><p>Find a template definition</p>
    64. 

  64. 

  65. <h3 class="function"><a name="handle_cast-2">handle_cast/2</a></h3>
    66. 

  66. <div class="spec">
    67. 

  67. <p><tt>handle_cast(Message::Msg, State) -&gt; {noreply, State} | {noreply, State, Timeout} | {stop, Reason, State}</tt></p>
    68. 

  68. </div><p>Scan for all scomps etc. for the context given.</p>
    69. 

  69. 

  70. <h3 class="function"><a name="handle_info-2">handle_info/2</a></h3>
    71. 

  71. <div class="spec">
    72. 

  72. <p><tt>handle_info(Info, State) -&gt; {noreply, State} | {noreply, State, Timeout} | {stop, Reason, State}</tt></p>
    73. 

  73. </div><p>Handling all non call/cast messages</p>
    74. 

  74. 

  75. <h3 class="function"><a name="init-1">init/1</a></h3>
    76. 

  76. <div class="spec">
    77. 

  77. <p><tt>init(SiteProps) -&gt; {ok, State} | {ok, State, Timeout} | ignore | {stop, Reason}</tt></p>
    78. 

  78. </div><p>Initiates the server.</p>
    79. 

  79. 

  80. <h3 class="function"><a name="reindex-1">reindex/1</a></h3>
    81. 

  81. <div class="spec">
    82. 

  82. <p><tt>reindex(Context) -&gt; any()</tt></p>
    83. 

  83. </div><p>Reindex the list of all scomps, etc for the site in the context.</p>
    84. 

  84. 

  85. <h3 class="function"><a name="start_link-1">start_link/1</a></h3>
    86. 

  86. <div class="spec">
    87. 

  87. <p><tt>start_link(SiteProps::Props) -&gt; {ok, Pid} | ignore | {error, Error}</tt></p>
    88. 

  88. </div><p>Starts the server</p>
    89. 

  89. 

  90. <h3 class="function"><a name="terminate-2">terminate/2</a></h3>
    91. 

  91. <div class="spec">
    92. 

  92. <p><tt>terminate(Reason, State) -&gt; <a href="#type-void">void()</a></tt></p>
    93. 

  93. </div><p>This function is called by a gen_server when it is about to
    94. 

  94.   terminate. It should be the opposite of Module:init/1 and do any necessary
    95. 

  95.   cleaning up. When it returns, the gen_server terminates with Reason.
    96. 

  96.   The return value is ignored.</p>
    97. 

  97. 

  98. <h3 class="function"><a name="translations-1">translations/1</a></h3>
    99. 

  99. <div class="spec">
    100. 

  100. <p><tt>translations(Context::#context{}) -&gt; [{module, {ModuleDirectory, [{Language, File}]}}]</tt></p>
    101. 

  101. </div><p>Find all .po files in all modules and the active site.
    102. 

  102.   This is an active scan, not designed to be fast.</p>
    103. 

  103. <hr>
    104. 

  104. 

  105. <div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
    106. 

  106. <p><i>Generated by EDoc, Aug 12 2011, 20:01:39.</i></p>
    107. 

  107. </body>
    108. 

  108. </html>
    109.