diff --git a/README.txt b/README.txt index 38effd8..b6d0810 100644 --- a/README.txt +++ b/README.txt @@ -6,17 +6,28 @@ The Entity Construction Kit creates entities for you! -- Entity Type Administration -The main administration page is located at /admin/structure/eck -Here you will be able to see all of the entities you have created, under the "Overview" tab. -There is, also, an "Add Entity Type" Link. This is were you go to create your entities, simply give a name for your entity, and that is it. ECK creates entities for the purpose of adding fields to them, so it will create a bundle for you automatically. The name of this bundle is the same that the name that you gave your entity type. If you want your first bundle to be called something different just add the bundle name when creating the entity type. -After adding an entity type, you can go back to the overview tab and see a link to you Bundle administration section. +The main administration page is located at /admin/structure/eck Here you will be +able to see all of the entities you have created, under the "Overview" tab. +There is, also, an "Add Entity Type" Link. This is were you go to create your +entities, simply give a name for your entity, and that is it. ECK creates +entities for the purpose of adding fields to them, so it will create a bundle +for you automatically. The name of this bundle is the same that the name that +you gave your entity type. If you want your first bundle to be called something +different just add the bundle name when creating the entity type. After adding +an entity type, you can go back to the overview tab and see a link to you Bundle +administration section. -- Bundle Administration -If you click on an Entity Type's name, you will be taken the the Bundle administration page. Here you will see the bundle that was created automatically for you, and will be able to add more bundles for your entity type. -Entity Administration +If you click on an Entity Type's name, you will be taken the the Bundle +administration page. Here you will see the bundle that was created automatically +for you, and will be able to add more bundles for your entity type. Entity +Administration -If you click on a bundle of your entity type, you will be taken to the entity administration table. There you can add fields to your bundle manage the display for the different view modes, and create new entities. -Once an entity is created it will be shown in the overview tab, and you can further view or edit your entity from there. +If you click on a bundle of your entity type, you will be taken to the entity +administration table. There you can add fields to your bundle manage the display +for the different view modes, and create new entities. Once an entity is created +it will be shown in the overview tab, and you can further view or edit your +entity from there. That is all. diff --git a/eck.api.php b/eck.api.php index 4d27d2b..14f1674 100644 --- a/eck.api.php +++ b/eck.api.php @@ -4,7 +4,6 @@ * ECK's API documentation. */ - /** * Respond to the creation of a new ECK entity type. * @@ -64,7 +63,7 @@ function hook_eck_default_properties() { * * More constrained versions of this hook also exist: * hook_eck_entity__label - * hook_eck_entity___label + * hook_eck_entity___label. * * This hook is mainly useful for dynamic labels, or for using values * in a field as labels. @@ -105,7 +104,7 @@ function hook_eck_property_types() { * @param string $type * The property type. */ -function hook_eck_property_type_schema_alter(&$schema, $type) { +function hook_eck_property_type_schema_alter(array &$schema, $type) { if ($type == 'email') { $schema = array( 'description' => 'An email', diff --git a/eck.bundle.inc b/eck.bundle.inc index 3c8c327..31a62cf 100644 --- a/eck.bundle.inc +++ b/eck.bundle.inc @@ -12,6 +12,9 @@ module_load_include('inc', 'eck', 'eck.classes'); * @param /EntityType $entity_type * As returned by eck__entity_type__load(). * + * @return array + * A menu item array. + * * @see eck_menu() */ function eck__bundle__menu($entity_type) { @@ -137,7 +140,7 @@ function eck__bundle__menu($entity_type) { /** * Page call back for the bundle overview table. * - * to see and manipulate all created label of a given type. + * To see and manipulate all created label of a given type. * * @param string $entity_type * The name of the entity type. @@ -159,7 +162,9 @@ function eck__bundle__list($entity_type) { $header = array(t('Type'), array( 'data' => t('Operations'), - 'colspan' => '1')); + 'colspan' => '1', + ), + ); $rows = array(); @@ -258,7 +263,6 @@ function eck__bundle__add_validate($form, &$form_state) { // The type does not have to be unique in the table, but it should be unique // to its entity so we will check that here. foreach (Bundle::loadByEntityType($entity_type) as $bundle) { - if ($bundle->name == $form_state['values']['bundle_name']) { form_set_error('bundle', t("bundle @bundle_name already exists for this entity type", array("@bundle_name" => $bundle->name))); @@ -348,6 +352,7 @@ function eck__bundle__edit_form($form, &$form_state, $entity_type_name, $bundle_ '#value' => t('Save bundle'), '#weight' => 40, ); + return $form; } @@ -473,9 +478,7 @@ function eck__bundle__field_autocomplete($entity_type, $bundle, $string = "") { * Helper function to determine if an entity wants to define a field as lable. */ function get_bundle_field_label_info($entity_type, $bundle) { - $info = entity_get_info(); - if (array_key_exists('field label', $info[$entity_type->name]['bundles'][$bundle->name])) { return $info[$entity_type->name]['bundles'][$bundle->name]['field label']; } diff --git a/eck.classes.inc b/eck.classes.inc index be76f98..9db25dc 100644 --- a/eck.classes.inc +++ b/eck.classes.inc @@ -4,6 +4,9 @@ * Classes for all the different objects used in ECK. */ +/** + * A database object. + */ class DBObject implements Iterator { // Wheteher this object was loaded or just created. public $isNew; @@ -30,8 +33,6 @@ class DBObject implements Iterator { // Iterator variable. $this->position = 0; - $data = array(); - // Is this a real table? If it is, check it. if ($schema = drupal_get_schema($table)) { $this->table = $table; @@ -126,7 +127,7 @@ class DBObject implements Iterator { * @param string $property * The property we will use to search for the record. * @param mixed $value - * the value the property should match. + * The value the property should match. */ protected function load($property, $value) { $result = db_select($this->table, 't')->fields('t')->condition($property, $value, '=') @@ -200,8 +201,12 @@ class DBObject implements Iterator { return FALSE; } } + } +/** + * An entity type database object. + */ class EntityType extends DBObject { // If an entity type is new, we can create its table from the current data of @@ -252,7 +257,6 @@ class EntityType extends DBObject { eck_property_behavior_invoke_plugin($this, 'property_add', array('name' => $name, 'property' => $p[$name], 'entity_type' => $this)); } - } /** @@ -282,9 +286,8 @@ class EntityType extends DBObject { * * @param string $name * The name of the property. - * * @param string $behavior - * the name of the behavior. + * The name of the behavior. */ public function changeBehavior($name, $behavior) { $p = $this->properties; @@ -398,6 +401,7 @@ class EntityType extends DBObject { variable_set('eck_clear_caches', TRUE); } + /** * Delete. */ @@ -485,8 +489,12 @@ class EntityType extends DBObject { } return $entity_types; } + } +/** + * A bundle database object. + */ class Bundle extends DBObject { /** @@ -601,8 +609,8 @@ class Bundle extends DBObject { * This method returns a bundle object. * * @param string $machine_name - * A string composed of the entity type name and the bundle name. - * "{$entity_type_name}_{$bundle_name}" + * A string composed of the entity type name and the bundle name, + * e.g., "{$entity_type_name}_{$bundle_name}". * * @return mixed * A Bundle object or Null. @@ -667,7 +675,7 @@ class Bundle extends DBObject { * Load the bundles of an entity type. * * @param EntityType $entity_type - * entity type object. + * An entity type object. * * @return array * An array with the bundles associated with the given entity type. @@ -694,10 +702,11 @@ class Bundle extends DBObject { /** * Adds a field to this bundle. * + * See: @link field Field API data structures @endlink. + * * @param string $field_type * The type of field to add. One of the keys as defined by any field module * using hook_field_info. - * * @param array $options * This is an optional array. Its properties can include: * _use existing_: If TRUE and if a 'field_name' property is specified in @@ -714,7 +723,7 @@ class Bundle extends DBObject { * The $instance array with the id property filled in as returned by * field_create_instance(). * - * See: @link field Field API data structures @endlink. + * @throws \FieldException */ public function addField($field_type, $options = array()) { // Check that the field type is known. @@ -738,7 +747,8 @@ class Bundle extends DBObject { if (empty($field['field_name']) || (isset($field_type_fields[$field['field_name']]) && !$options['use existing'])) { $iter = count($field_type_fields) + 1; $field += array( - 'field_name' => substr('field_' . $field_type, 0, 28) . '_' . $iter); + 'field_name' => substr('field_' . $field_type, 0, 28) . '_' . $iter, + ); } // Create a new field if the field name is unique over active and @@ -759,6 +769,7 @@ class Bundle extends DBObject { } return field_create_instance($instance); } + } /** @@ -813,4 +824,5 @@ class ECKCache { $this->data = NULL; cache_clear_all($this->id, 'cache_eck'); } + } diff --git a/eck.default_properties.inc b/eck.default_properties.inc index d2b13b0..09a2e5c 100644 --- a/eck.default_properties.inc +++ b/eck.default_properties.inc @@ -30,7 +30,6 @@ function eck__default_properties__form($form, &$state, $entity_type) { $form['default_properties']['#default_value'] = $defaults; // :S - return $form; } @@ -56,8 +55,9 @@ function eck__default_properties__form_submit($form, &$state, $entity_type) { /** * All default properties information. + * * @todo combine this and get_default_property(). - * + * * @return array * All of the default properties info. */ @@ -70,10 +70,10 @@ function eck_get_default_properties() { /** * Get a default property by name. - * + * * @param string $name * Default property's name. - * + * * @return array * The default property info. */ diff --git a/eck.entity.inc b/eck.entity.inc index 54e935e..c2a8138 100755 --- a/eck.entity.inc +++ b/eck.entity.inc @@ -168,9 +168,9 @@ function eck__entity__list($entity_type_name, $bundle_name) { // Get all entity instances of this type. $query = new EntityFieldQuery(); $query - ->entityCondition('entity_type', $entity_type->name, '=') - ->entityCondition('bundle', $bundle->name, '=') - ->pager(20); + ->entityCondition('entity_type', $entity_type->name, '=') + ->entityCondition('bundle', $bundle->name, '=') + ->pager(20); drupal_alter('entity_overview_query', $query, $info); unset($info['entity_type']); @@ -238,6 +238,7 @@ function eck__entity__add($entity_type_name, $bundle_name) { $bundle = bundle_load($entity_type_name, $bundle_name); $entity = entity_create($entity_type->name, array('type' => $bundle->name)); + return drupal_get_form("eck__entity__form_add_{$entity_type_name}_{$bundle_name}", $entity); } @@ -245,7 +246,7 @@ function eck__entity__add($entity_type_name, $bundle_name) { * Get the entities view. * * @param string $entity_type - * entity type + * An entity type. * @param mixed $id * The entity id or the entity object itself * Normally you wouldn't need to call this function if you already have the @@ -293,6 +294,7 @@ function eck__entity__edit($entity_type_name, $bundle_name, $id) { function eck__entity__delete($entity_type_name, $bundle_name, $entity) { $entity_type = entity_type_load($entity_type_name); $bundle = bundle_load($entity_type_name, $bundle_name); + return drupal_get_form('eck__entity__delete_form', $entity_type, $bundle, $entity); } @@ -328,7 +330,6 @@ function eck__entity__delete_form($form, &$form_state, $entity_type, $bundle, $e $caption = t("This action cannot be undone."); return confirm_form($form, $message, "{$path}/{$entity_type->name}", $caption, t('Delete')); - } /** @@ -445,7 +446,6 @@ function eck__entity__form_submit($form, &$state) { // @TODO: maybe we should do this in the form validation step. That way we can // catch entity wrapper validation exceptions and set a form error message // appropriately. - // Lets give the behavior a chance to manipulate the data before it is set. $data = eck_property_behavior_invoke_plugin($entity_type, 'pre_set', array('entity' => $entity), $values); @@ -557,5 +557,4 @@ function _eck_form_property_value($state, $property) { if (array_key_exists($property, $state['values'])) { return $state['values'][$property]; } - return NULL; } diff --git a/eck.entity_type.inc b/eck.entity_type.inc index fca2495..1e82aaf 100755 --- a/eck.entity_type.inc +++ b/eck.entity_type.inc @@ -1,7 +1,7 @@ "The base table for entities types information", 'fields' => array( @@ -184,17 +182,16 @@ function eck_update_7000() { db_create_table('eck_types', $schema); // Now we add a type (bundle) to the table for each entity in the eck table. - $results = db_select('eck', 't')->fields('t')->execute(); foreach ($results as $record) { $nid = db_insert('eck_types') - ->fields(array( + ->fields(array( 'entity' => $record->name, 'type' => $record->name, 'label' => $record->label, )) - ->execute(); + ->execute(); // Also we want to add a field to all the enity tables for the type, and // populated with the current type. @@ -216,7 +213,6 @@ function eck_update_7000() { function eck_update_7001() { // For importing and exporting things it is always good to have a uuid, so we // will add that colunm to the current entity types. - // Now we add a type (bundle) to the table for each entity in the eck table. $results = db_select('eck', 't')->fields('t')->execute(); @@ -246,7 +242,6 @@ function eck_update_7002() { // campture those different states: 0- don't show 1 - show 3 - needs review 4 // - revised by editor, etc. Also instead of status, I think that "state" is a // more appropiate name. - $results = db_select('eck', 't')->fields('t')->execute(); foreach ($results as $record) { @@ -388,22 +383,33 @@ function eck_update_7006() { case 'uid': $new_properties['uid'] = array( - 'label' => 'Author', 'type' => 'integer', 'behavior' => 'author'); + 'label' => 'Author', + 'type' => 'integer', + 'behavior' => 'author', + ); break; case 'created': $new_properties['created'] = array( - 'label' => 'Created', 'type' => 'integer', 'behavior' => 'created'); + 'label' => 'Created', + 'type' => 'integer', + 'behavior' => 'created', + ); break; case 'changed': $new_properties['changed'] = array( - 'label' => 'Changed', 'type' => 'integer', 'behavior' => 'changed'); + 'label' => 'Changed', + 'type' => 'integer', + 'behavior' => 'changed', + ); break; case 'state': $new_properties['state'] = array( - 'label' => 'State', 'type' => 'positive_integer'); + 'label' => 'State', + 'type' => 'positive_integer', + ); break; } @@ -434,11 +440,11 @@ function eck_update_7006() { $encode_new = drupal_json_encode($new_properties); db_update('eck_entity_type') - ->fields(array( + ->fields(array( 'properties' => $encode_new, )) - ->condition('name', $record->name, '=') - ->execute(); + ->condition('name', $record->name, '=') + ->execute(); } // Now we can drop the custom_properties field now that everything has @@ -472,11 +478,11 @@ function eck_update_7007() { $entity_type = $record->entity_type; $record->machine_name = "{$entity_type}_{$name}"; db_update('eck_bundle') - ->fields(array( + ->fields(array( 'machine_name' => $record->machine_name, )) - ->condition('id', $record->id, '=') - ->execute(); + ->condition('id', $record->id, '=') + ->execute(); } } diff --git a/eck.module b/eck.module index 2481fd6..1ff7a74 100644 --- a/eck.module +++ b/eck.module @@ -21,7 +21,7 @@ module_load_include('inc', 'eck', 'includes/eck.references_dialog'); * Load callback for %eckentity. */ function eckentity_load($id, $type) { - try{ + try { $entity = entity_load_single($type, $id); } catch (Exception $ex) { @@ -120,10 +120,10 @@ function eck_ctools_plugin_type() { * * This is the callback function for an entities label * By default the label is the id of the entity, but a number of - * hooks are defined to customize the label if needed + * hooks are defined to customize the label if needed. * * @param object $entity - * an object as returned by entity_load(). + * An object as returned by entity_load(). */ function eck__entity__label($entity) { $hook_names = array( @@ -152,7 +152,7 @@ function eck__entity__label($entity) { * Entity URI callback. * * @param object $entity - * an object as returned by entity_load(). + * An object as returned by entity_load(). */ function eck__entity__uri($entity) { @@ -175,7 +175,6 @@ function eck_schema_alter(&$schema) { // When something requests an entity's info, the hook_schema is called to // get the information about the entity's table, so we need to provide that // information in the hook. - // Get all the entity types that have been create // (all the rows in eck_entity_type table). foreach (EntityType::loadAll() as $entity_type) { @@ -202,12 +201,15 @@ function eck_schema_alter(&$schema) { * Creates a table showing a group of entities. * * @param array $entities - * the entities to create the table from + * The entities to create the table from. * @param bool $select - * a boolean value that will determine whether the - * table is a select table or a regular table + * A boolean value that will determine whether the + * table is a select table or a regular table. + * + * @return array + * A theme table render array. */ -function entity_table($entities, $select = FALSE) { +function entity_table(array $entities, $select = FALSE) { module_load_include('inc', 'eck', 'eck.entity'); // This is information set up for each bundle in the hook_entity_info // look there for more details. @@ -481,7 +483,7 @@ function eck_menu() { * * A pretty through set of permission * you can set permissiona at each level: entity_type, bundle, entity - * and for each action of the CRUD + * and for each action of the CRUD. */ function eck_permission() { @@ -608,7 +610,7 @@ function eck_permission() { * (optional) The account to check permissions against. Defaults to the * current user. */ -function eck__multiple_access_check($perms, $b_own = FALSE, $account = NULL) { +function eck__multiple_access_check(array $perms, $b_own = FALSE, $account = NULL) { if (!isset($account)) { $account = $GLOBALS['user']; } @@ -659,7 +661,7 @@ function eck_forms($form_id, $args) { * @param array $state * The form state, this is also provided by the Form API. * @param string $entity_type - * the type of the entities that will be in the table. + * The type of the entities that will be in the table. * @param string $bundle * The bundle of the entity that will be in the table. * @param array $header @@ -668,7 +670,7 @@ function eck_forms($form_id, $args) { * The rows of the table for more info on what this should look like look * at theme_table. */ -function entity_table_select($form, &$state, $entity_type, $bundle, $header, $rows) { +function entity_table_select(array $form, array &$state, $entity_type, $bundle, array $header, array $rows) { $form['entity_type'] = array('#type' => 'value', '#value' => $entity_type); $form['bundle'] = array('#type' => 'value', '#value' => $bundle); @@ -824,7 +826,7 @@ function eck__entity_menu_access($action, $entity_type_name, $bundle_name, $enti * and bundle. * @param object $account * The user to check access for. If this is NULL, access will be checked for - * the current user. + * The current user. * @param string $entity_type_name * A string representing the type of entity to check access for. * @@ -863,7 +865,6 @@ function eck__entity_access($op, $entity_or_bundle, $account, $entity_type_name) } // @todo should auto-load entity author here. - return eck__multiple_access_check($permissions, FALSE, $account); } @@ -883,9 +884,8 @@ function eck_entity_view_alter(&$build, $entity_type) { // the paths of any of the possible operations, since contextual links // are dependent on the hierarchy of those paths, changing the paths // could cause of contextual links not to work correctly. - $build['#contextual_links']['eck'] - = array("{$this_entity_type}/{$this_bundle}",array($entity->id)); + = array("{$this_entity_type}/{$this_bundle}", array($entity->id)); } } } diff --git a/eck.properties.inc b/eck.properties.inc index 7ab2625..a1b1c0f 100644 --- a/eck.properties.inc +++ b/eck.properties.inc @@ -11,7 +11,7 @@ * @param array $schema * A schema array. */ -function eck_set_properties_schema(&$schema, $entity_type) { +function eck_set_properties_schema(array &$schema, $entity_type) { $properties = $entity_type->properties; foreach ($properties as $name => $info) { @@ -140,7 +140,8 @@ function eck__properties__form($form, &$state, $entity_type_name) { '#markup' => "

HELP: " . "The add property button will temporarily add a property to the entity " . "type, to finalize adding the property, click the checkbox on the left and " - . "click save

"); + . "click save

", + ); // When the add button is clicked, the submit callback directs the form to // be rebuilt. Here we check to see if a new property was added, and keep it @@ -164,7 +165,6 @@ function eck__properties__form($form, &$state, $entity_type_name) { // @todo need to get a better interface. // But until then, we need to keep the form from changing the // property_type or property_name of the already existing properties. - if (!array_key_exists($property_name, $new_properties) || $new_properties[$property_name]['type'] == $property_type) { @@ -198,7 +198,6 @@ function eck__properties__form($form, &$state, $entity_type_name) { // load all defaults, and then load all the properties in the entity type, // while modifying the before added default properties given the entity // type settings. - $property_arrays = array('new_properties'); foreach ($property_arrays as $array_name) { diff --git a/eck.property_behavior.inc b/eck.property_behavior.inc index d3a7f61..fa3d61a 100644 --- a/eck.property_behavior.inc +++ b/eck.property_behavior.inc @@ -38,7 +38,6 @@ function eck_property_behavior_implements($entity_type, $property, $function_nam * A general function to call specific functions in a property behavior plugin. */ function eck_property_behavior_invoke_plugin($entity_type, $function_name, $all = array(), $specific = array()) { - $properties = $entity_type->properties; $returns = array(); @@ -76,15 +75,14 @@ function eck_property_behavior_invoke_plugin($entity_type, $function_name, $all * @param EntityType $entity_type * The entity type object. * @param string $function_name - * the name of the sub_hook. + * The name of the sub_hook. * @param array $var * Variable to be altered. * * @return array * most likely, an array returned by a plugin. */ -function eck_property_behavior_invoke_plugin_alter($entity_type, $function_name, $var) { - +function eck_property_behavior_invoke_plugin_alter($entity_type, $function_name, array $var) { $properties = $entity_type->properties; $return = $var; diff --git a/includes/eck.inline_entity_form.inc b/includes/eck.inline_entity_form.inc index f50c74c..6db9d6a 100644 --- a/includes/eck.inline_entity_form.inc +++ b/includes/eck.inline_entity_form.inc @@ -5,6 +5,9 @@ * Defines the inline entity form controller for ECK Entities. */ +/** + * An ECK inline entity form controller. + */ class EckInlineEntityFormController extends EntityInlineEntityFormController { /** @@ -34,4 +37,5 @@ class EckInlineEntityFormController extends EntityInlineEntityFormController { unset($entity_form['submit']); return $entity_form; } + } diff --git a/includes/translation.handler.eck.inc b/includes/translation.handler.eck.inc index b6b3448..1cd6cae 100644 --- a/includes/translation.handler.eck.inc +++ b/includes/translation.handler.eck.inc @@ -20,4 +20,5 @@ class EntityTranslationECKHandler extends EntityTranslationDefaultHandler { // Since we are using per-bundle paths then use the bundle's path scheme. $this->setPathScheme($entity->type); } + } diff --git a/plugins/property_behavior/author.inc b/plugins/property_behavior/author.inc index c6eb781..82bf1e8 100644 --- a/plugins/property_behavior/author.inc +++ b/plugins/property_behavior/author.inc @@ -2,8 +2,8 @@ /** * @file * Author Behavior. - * - * Save the user id of the user when the entity is created. + * + * Save the user id of the user when the entity is created. */ $plugin = array( diff --git a/plugins/property_behavior/changed.inc b/plugins/property_behavior/changed.inc index 7802783..64a72ae 100644 --- a/plugins/property_behavior/changed.inc +++ b/plugins/property_behavior/changed.inc @@ -2,7 +2,7 @@ /** * @file * Changed behavior. - * + * * Store the current time in the property every time it is updated. */ diff --git a/plugins/property_behavior/created.inc b/plugins/property_behavior/created.inc index 2727f3c..2f4f8ac 100644 --- a/plugins/property_behavior/created.inc +++ b/plugins/property_behavior/created.inc @@ -1,8 +1,8 @@ -