id = $id; // Per default we assume that a Feeds object is not saved to // database nor is it exported to code. $this->export_type = FEEDS_EXPORT_NONE; // Make sure configuration is populated. $this->config = $this->configDefaults(); $this->disabled = FALSE; } /** * Determine whether this object is persistent and enabled. I. e. it is * defined either in code or in the database and it is enabled. */ public function existing() { if ($this->export_type == FEEDS_EXPORT_NONE) { throw new FeedsNotExistingException(t('Object is not persistent.')); } if ($this->disabled) { throw new FeedsNotExistingException(t('Object is disabled.')); } return $this; } /** * Save a configuration. Concrete extending classes must implement a save * operation. */ public abstract function save(); /** * Copy a configuration. */ public function copy(FeedsConfigurable $configurable) { $this->setConfig($configurable->config); } /** * Set configuration. * * @param $config * Array containing configuration information. Config array will be filtered * by the keys returned by configDefaults() and populated with default * values that are not included in $config. */ public function setConfig($config) { $defaults = $this->configDefaults(); $this->config = array_intersect_key($config, $defaults) + $defaults; } /** * Similar to setConfig but adds to existing configuration. * * @param $config * Array containing configuration information. Will be filtered by the keys * returned by configDefaults(). */ public function addConfig($config) { $this->config = array_merge($this->config, $config); $default_keys = $this->configDefaults(); $this->config = array_intersect_key($this->config, $default_keys); } /** * Override magic method __get(). Make sure that $this->config goes * through getConfig() */ public function __get($name) { if ($name == 'config') { return $this->getConfig(); } return $this->$name; } /** * Implementation of getConfig(). */ public function getConfig() { return $this->config; } /** * Return default configuration. * * @todo rename to getConfigDefaults(). * * @return * Array where keys are the variable names of the configuration elements and * values are their default values. */ public function configDefaults() { return array(); } /** * Return configuration form for this object. The keys of the configuration * form must match the keys of the array returned by configDefaults(). * * @return * FormAPI style form definition. */ public function configForm(&$form_state) { return array(); } /** * Validation handler for configForm(). * * Set errors with form_set_error(). * * @param $values * An array that contains the values entered by the user through configForm. */ public function configFormValidate(&$values) { } /** * Submission handler for configForm(). * * @param $values */ public function configFormSubmit(&$values) { $this->addConfig($values); $this->save(); drupal_set_message(t('Your changes have been saved.')); feeds_cache_clear(FALSE); } } /** * Config form wrapper. Use to render the configuration form of * a FeedsConfigurable object. * * @param $configurable * FeedsConfigurable object. * @param $form_method * The form method that should be rendered. * * @return * Rendered config form, if available. Empty string otherwise. */ function feeds_get_form($configurable, $form_method) { $form_state = array(); if (method_exists($configurable, $form_method)) { return drupal_get_form(get_class($configurable) .'_feeds_form', $configurable, $form_method); } return ''; } /** * Config form callback. Don't call directly, but use * feeds_get_form($configurable, 'method') instead. * * @param * FormAPI $form_state. * @param * FeedsConfigurable object. * @param * The object to perform the save() operation on. * @param $form_method * The $form_method that should be rendered. */ function feeds_form(&$form_state, $configurable, $form_method) { $form = $configurable->$form_method($form_state); $form['#configurable'] = $configurable; $form['#feeds_form_method'] = $form_method; $form['#validate'] = array('feeds_form_validate'); $form['#submit'] = array('feeds_form_submit'); $form['submit'] = array( '#type' => 'submit', '#value' => t('Save'), '#weight' => 100, ); return $form; } /** * Validation handler for feeds_form(). */ function feeds_form_validate($form, &$form_state) { $validate_method = $form['#feeds_form_method'] .'Validate'; if (method_exists($form['#configurable'], $validate_method)) { $form['#configurable']->$validate_method($form_state['values']); } } /** * Submit handler for feeds_config_form(). */ function feeds_form_submit($form, &$form_state) { $submit_method = $form['#feeds_form_method'] .'Submit'; if (method_exists($form['#configurable'], $submit_method)) { $form['#configurable']->$submit_method($form_state['values']); } }