root / drupal7 / sites / all / modules / uuid / uuid.api.php @ f8e16685
1 |
<?php
|
---|---|
2 |
|
3 |
/**
|
4 |
* @file
|
5 |
* Hooks provided by the UUID module.
|
6 |
*/
|
7 |
|
8 |
/**
|
9 |
* Ensures all records have a UUID assigned to them.
|
10 |
*
|
11 |
* When called this hook should ensure all records it is responsible for
|
12 |
* have a UUID and if not create one.
|
13 |
*
|
14 |
* @see entity_uuid_sync()
|
15 |
*/
|
16 |
function hook_uuid_sync() { |
17 |
// Do what you need to do to generate missing UUIDs for you implementation.
|
18 |
} |
19 |
|
20 |
/**
|
21 |
* Transform entity properties from local IDs to UUIDs when they are loaded.
|
22 |
*/
|
23 |
function hook_entity_uuid_load(&$entities, $entity_type) { |
24 |
|
25 |
} |
26 |
|
27 |
/**
|
28 |
* Transform field values from local IDs to UUIDs when an entity is loaded.
|
29 |
*/
|
30 |
function hook_field_uuid_load($entity_type, $entity, $field, $instance, $langcode, &$items) { |
31 |
|
32 |
} |
33 |
|
34 |
/**
|
35 |
* Transform entity properties from UUIDs to local IDs before entity is saved.
|
36 |
*/
|
37 |
function hook_entity_uuid_presave(&$entity, $entity_type) { |
38 |
|
39 |
} |
40 |
|
41 |
/**
|
42 |
* Transform field values from UUIDs to local IDs before an entity is saved.
|
43 |
*/
|
44 |
function hook_field_uuid_presave($entity_type, $entity, $field, $instance, $langcode, &$items) { |
45 |
|
46 |
} |
47 |
|
48 |
/**
|
49 |
* Transform entity properties after an entity is saved.
|
50 |
*/
|
51 |
function hook_entity_uuid_save($entity, $entity_type) { |
52 |
|
53 |
} |
54 |
|
55 |
/**
|
56 |
* Let modules act when an entity is deleted.
|
57 |
*
|
58 |
* Generally hook_entity_delete() should be used instead of this hook.
|
59 |
*
|
60 |
* @see hook_entity_delete()
|
61 |
*/
|
62 |
function hook_entity_uuid_delete($entity, $entity_type) { |
63 |
|
64 |
} |
65 |
|
66 |
/**
|
67 |
* Modifies paths when they are being converted to UUID ones.
|
68 |
*/
|
69 |
function hook_uuid_menu_path_to_uri_alter($path, &$uri) { |
70 |
|
71 |
} |
72 |
|
73 |
/**
|
74 |
* Modifies paths when they are being converted from UUID ones.
|
75 |
*/
|
76 |
function hook_uuid_menu_uri_to_path(&$path, $uri) { |
77 |
|
78 |
} |
79 |
|
80 |
/**
|
81 |
* Allow modules to provide a list of default entities that will be imported.
|
82 |
*/
|
83 |
function hook_uuid_default_entities() { |
84 |
|
85 |
} |
86 |
|
87 |
/**
|
88 |
* Let other modules do things before default entities are created on rebuild.
|
89 |
*/
|
90 |
function hook_uuid_entities_pre_rebuild($plan_name) { |
91 |
|
92 |
} |
93 |
|
94 |
/**
|
95 |
* Let other modules do things after default entities are created on rebuild.
|
96 |
*/
|
97 |
function hook_uuid_entities_post_rebuild($plan_name) { |
98 |
|
99 |
} |
100 |
|
101 |
/**
|
102 |
* Let other modules do things before default entities are created on revert.
|
103 |
*/
|
104 |
function hook_uuid_entities_pre_revert($plan_name) { |
105 |
|
106 |
} |
107 |
|
108 |
/**
|
109 |
* Let other modules do things after default entities are created on revert.
|
110 |
*/
|
111 |
function hook_uuid_entities_post_revert($plan_name) { |
112 |
|
113 |
} |
114 |
|
115 |
/**
|
116 |
* Let other modules alter entities that are about to be exported.
|
117 |
*/
|
118 |
function hook_uuid_entities_features_export_entity_alter(&$entity, $entity_type) { |
119 |
|
120 |
} |
121 |
|
122 |
/**
|
123 |
* Let other modules alter fields on entities that are about to be exported.
|
124 |
*/
|
125 |
function hook_uuid_entities_features_export_field_alter($entity_type, &$entity, $field, $instance, $langcode, &$items) { |
126 |
|
127 |
} |
128 |
|
129 |
/**
|
130 |
* Alter UUID URI data after processing.
|
131 |
*/
|
132 |
function hook_uuid_uri_data($data) { |
133 |
} |
134 |
|
135 |
/**
|
136 |
* Alter entity URI before creating UUID URI.
|
137 |
*/
|
138 |
function hook_uuid_id_uri_data($data) { |
139 |
} |