/[drupal]/drupal/modules/system/system.api.php
ViewVC logotype

Diff of /drupal/modules/system/system.api.php

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.100, Wed Nov 4 05:39:14 2009 UTC revision 1.101, Thu Nov 5 03:04:24 2009 UTC
# Line 1  Line 1 
1  <?php  <?php
2  // $Id: system.api.php,v 1.99 2009/11/03 06:47:23 webchick Exp $  // $Id: system.api.php,v 1.100 2009/11/04 05:39:14 webchick Exp $
3    
4  /**  /**
5   * @file   * @file
# Line 56  function hook_hook_info() { Line 56  function hook_hook_info() {
56   * @return   * @return
57   *   An array whose keys are entity type names and whose values identify   *   An array whose keys are entity type names and whose values identify
58   *   properties of those types that the  system needs to know about:   *   properties of those types that the  system needs to know about:
59   *   *   - name: The human-readable name of the type.
60   *   name: The human-readable name of the type.   *   - controller class: The name of the class that is used to load the objects.
  *   controller class: The name of the class that is used to load the objects.  
61   *     The class has to implement the DrupalEntityController interface. Leave   *     The class has to implement the DrupalEntityController interface. Leave
62   *     blank to use the DefaultDrupalEntityController implementation.   *     blank to use the DefaultDrupalEntityController implementation.
63   *   base table: (used by DefaultDrupalEntityController) The name of the entity   *   - base table: (used by DefaultDrupalEntityController) The name of the
64   *     type's base table.   *     entity type's base table.
65   *   static cache: (used by DefaultDrupalEntityController) FALSE to disable   *   - static cache: (used by DefaultDrupalEntityController) FALSE to disable
66   *     static caching of entities during a page request. Defaults to TRUE.   *     static caching of entities during a page request. Defaults to TRUE.
67   *   load hook: The name of the hook which should be invoked by   *   - load hook: The name of the hook which should be invoked by
68   *   DrupalDefaultEntityController:attachLoad(), for example 'node_load'.   *     DrupalDefaultEntityController:attachLoad(), for example 'node_load'.
69   *   fieldable: Set to TRUE if you want your entity type to be fieldable.   *   - fieldable: Set to TRUE if you want your entity type to be fieldable.
70   *   - object keys: An array describing how the Field API can extract the   *   - object keys: An array describing how the Field API can extract the
71   *     information it needs from the objects of the type.   *     information it needs from the objects of the type. Elements:
72   *     - id: The name of the property that contains the primary id of the   *     - id: The name of the property that contains the primary id of the
73   *       object. Every object passed to the Field API must have this property   *       object. Every object passed to the Field API must have this property
74   *       and its value must be numeric.   *       and its value must be numeric.
# Line 87  function hook_hook_info() { Line 86  function hook_hook_info() {
86   *     information it needs from the bundle objects for this type (e.g   *     information it needs from the bundle objects for this type (e.g
87   *     $vocabulary objects for terms; not applicable for nodes).   *     $vocabulary objects for terms; not applicable for nodes).
88   *     This element can be omitted if this type's bundles do not exist as   *     This element can be omitted if this type's bundles do not exist as
89   *     standalone objects.   *     standalone objects. Elements:
90   *     - bundle: The name of the property that contains the name of the bundle   *     - bundle: The name of the property that contains the name of the bundle
91   *       object.   *       object.
92   *   - cacheable: A boolean indicating whether Field API should cache   *   - cacheable: A boolean indicating whether Field API should cache
# Line 95  function hook_hook_info() { Line 94  function hook_hook_info() {
94   *     field_attach_load().   *     field_attach_load().
95   *   - bundles: An array describing all bundles for this object type.   *   - bundles: An array describing all bundles for this object type.
96   *     Keys are bundles machine names, as found in the objects' 'bundle'   *     Keys are bundles machine names, as found in the objects' 'bundle'
97   *     property (defined in the 'object keys' entry above).   *     property (defined in the 'object keys' entry above). Elements:
98   *     - label: The human-readable name of the bundle.   *     - label: The human-readable name of the bundle.
99   *     - admin: An array of information that allow Field UI pages (currently   *     - admin: An array of information that allow Field UI pages (currently
100   *       implemented in a contributed module) to attach themselves to the   *       implemented in a contributed module) to attach themselves to the
101   *       existing administration pages for the bundle.   *       existing administration pages for the bundle. Elements:
102   *       - path: the path of the bundle's main administration page, as defined   *       - path: the path of the bundle's main administration page, as defined
103   *         in hook_menu(). If the path includes a placeholder for the bundle,   *         in hook_menu(). If the path includes a placeholder for the bundle,
104   *         the 'bundle argument', 'bundle helper' and 'real path' keys below   *         the 'bundle argument', 'bundle helper' and 'real path' keys below
Legend:
Removed from v.1.100  
changed lines
  Added in v.1.101
  ViewVC Help
Powered by ViewVC 1.1.2