diff --git a/core/core.services.yml b/core/core.services.yml index b48f1a8..a2d373c 100644 --- a/core/core.services.yml +++ b/core/core.services.yml @@ -384,16 +384,16 @@ services: class: Drupal\Core\Routing\Enhancer\AjaxEnhancer arguments: ['@content_negotiation'] tags: - - { name: route_enhancer, priority: 20 } - - { name: legacy_route_enhancer, priority: 20 } + - { name: route_enhancer, priority: 15 } + - { name: legacy_route_enhancer, priority: 15 } route_enhancer.entity: class: Drupal\Core\Entity\Enhancer\EntityRouteEnhancer - arguments: ['@content_negotiation'] + arguments: ['@controller_resolver', '@entity.manager', '@form_builder'] tags: - - { name: route_enhancer, priority: 15 } + - { name: route_enhancer, priority: 20 } route_enhancer.form: class: Drupal\Core\Routing\Enhancer\FormEnhancer - arguments: ['@content_negotiation'] + arguments: ['@service_container', '@controller_resolver', '@form_builder'] tags: - { name: route_enhancer, priority: 10 } route_special_attributes_subscriber: @@ -402,10 +402,16 @@ services: - { name: event_subscriber } controller.page: class: Drupal\Core\Controller\HtmlPageController - arguments: ['@http_kernel', '@controller_resolver', '@string_translation', '@title_resolver'] + arguments: ['@controller_resolver', '@string_translation', '@title_resolver'] + controller.ajax: + class: Drupal\Core\Controller\AjaxController + arguments: ['@controller_resolver'] + controller.entityform: + class: Drupal\Core\Entity\HtmlEntityFormController + arguments: ['@controller_resolver', '@service_container', '@entity.manager'] controller.dialog: class: Drupal\Core\Controller\DialogController - arguments: ['@http_kernel', '@title_resolver'] + arguments: ['@controller_resolver', '@title_resolver'] router_listener: class: Symfony\Component\HttpKernel\EventListener\RouterListener tags: @@ -418,6 +424,14 @@ services: tags: - { name: event_subscriber } arguments: ['@content_negotiation', '@title_resolver'] + html_view_subscriber: + class: Drupal\Core\EventSubscriber\HtmlViewSubscriber + tags: + - { name: event_subscriber } + arguments: ['@html_page_renderer'] + html_page_renderer: + class: Drupal\Core\Page\DefaultHtmlPageRenderer + arguments: ['@language_manager'] private_key: class: Drupal\Core\PrivateKey arguments: ['@state'] @@ -447,29 +461,29 @@ services: access_check.default: class: Drupal\Core\Access\DefaultAccessCheck tags: - - { name: access_check } + - { name: access_check, applies_to: _access } access_check.entity: class: Drupal\Core\Entity\EntityAccessCheck tags: - - { name: access_check } + - { name: access_check, applies_to: _entity_access } access_check.entity_create: class: Drupal\Core\Entity\EntityCreateAccessCheck arguments: ['@entity.manager'] tags: - - { name: access_check } + - { name: access_check, applies_to: _entity_create_access } access_check.theme: class: Drupal\Core\Theme\ThemeAccessCheck tags: - - { name: access_check } + - { name: access_check, applies_to: _access_theme } access_check.custom: class: Drupal\Core\Access\CustomAccessCheck arguments: ['@controller_resolver'] tags: - - { name: access_check } + - { name: access_check, applies_to: _custom_access } access_check.csrf: class: Drupal\Core\Access\CsrfAccessCheck tags: - - { name: access_check } + - { name: access_check, applies_to: _csrf_token } arguments: ['@csrf_token'] maintenance_mode_subscriber: class: Drupal\Core\EventSubscriber\MaintenanceModeSubscriber @@ -521,7 +535,7 @@ services: arguments: ['@language_manager', '@string_translation'] exception_controller: class: Drupal\Core\Controller\ExceptionController - arguments: ['@content_negotiation'] + arguments: ['@content_negotiation', '@string_translation', '@title_resolver', '@html_page_renderer'] calls: - [setContainer, ['@service_container']] exception_listener: diff --git a/core/includes/batch.inc b/core/includes/batch.inc index 049b3fb..597ab43 100644 --- a/core/includes/batch.inc +++ b/core/includes/batch.inc @@ -150,30 +150,46 @@ function _batch_progress_page() { $batch['url_options']['query']['op'] = $new_op; $url = url($batch['url'], $batch['url_options']); - $element = array( - // Redirect through a 'Refresh' meta tag if JavaScript is disabled. - '#prefix' => '', - '#tag' => 'meta', - '#attributes' => array( - 'http-equiv' => 'Refresh', - 'content' => '0; URL=' . $url, - ), - ); - drupal_add_html_head($element, 'batch_progress_meta_refresh'); - - // Adds JavaScript code and settings for clients where JavaScript is enabled. - $js_setting = array( - 'batch' => array( - 'errorMessage' => $current_set['error_message'] . '
' . $batch['error_message'], - 'initMessage' => $current_set['init_message'], - 'uri' => $url, + + $build = array( + '#theme' => 'progress_bar', + '#percent' => $percentage, + '#message' => $message, + '#label' => $label, + '#attached' => array( + 'drupal_add_html_head' => array( + array( + array( + // Redirect through a 'Refresh' meta tag if JavaScript is disabled. + '#tag' => 'meta', + '#noscript' => TRUE, + '#attributes' => array( + 'http-equiv' => 'Refresh', + 'content' => '0; URL=' . $url, + ), + ), + 'batch_progress_meta_refresh', + ), + ), + // Adds JavaScript code and settings for clients where JavaScript is enabled. + 'js' => array( + array( + 'type' => 'setting', + 'data' => array( + 'batch' => array( + 'errorMessage' => $current_set['error_message'] . '
' . $batch['error_message'], + 'initMessage' => $current_set['init_message'], + 'uri' => $url, + ), + ), + ), + ), + 'library' => array( + array('system', 'drupal.batch'), + ), ), ); - drupal_add_js($js_setting, 'setting'); - drupal_add_library('system', 'drupal.batch'); - - return theme('progress_bar', array('percent' => $percentage, 'message' => $message, 'label' => $label)); + return drupal_render($build); } /** diff --git a/core/includes/bootstrap.inc b/core/includes/bootstrap.inc index 6d70110..91d12af 100644 --- a/core/includes/bootstrap.inc +++ b/core/includes/bootstrap.inc @@ -418,18 +418,9 @@ function config_get_config_directory($type = CONFIG_ACTIVE_DIRECTORY) { global $config_directories; if (!empty($config_directories[$type])) { - // Allow a configuration directory path to be outside of webroot. - if (empty($config_directories[$type]['absolute'])) { - $path = conf_path() . '/files/' . $config_directories[$type]['path']; - } - else { - $path = $config_directories[$type]['path']; - } + return $config_directories[$type]; } - else { - throw new Exception(format_string('The configuration directory type %type does not exist.', array('%type' => $type))); - } - return $path; + throw new Exception(format_string('The configuration directory type %type does not exist.', array('%type' => $type))); } /** @@ -2293,7 +2284,7 @@ function _drupal_load_test_overrides($test_prefix) { $path_prefix = 'simpletest/' . substr($test_prefix, 10); $config_directories = array(); foreach (array(CONFIG_ACTIVE_DIRECTORY, CONFIG_STAGING_DIRECTORY) as $type) { - $config_directories[$type] = array('path' => $path_prefix . '/config_' . $type); + $config_directories[$type] = conf_path() . '/files/' . $path_prefix . '/config_' . $type; } // Check for and load a settings.php file in the simpletest files directory. @@ -2439,7 +2430,7 @@ function language_list($flags = Language::STATE_CONFIGURABLE) { $default = language_default(); if (language_multilingual() || \Drupal::moduleHandler()->moduleExists('language')) { // Use language module configuration if available. - $language_entities = config_get_storage_names_with_prefix('language.entity'); + $language_entities = config_get_storage_names_with_prefix('language.entity.'); // Initialize default property so callers have an easy reference and can // save the same object without data loss. diff --git a/core/includes/common.inc b/core/includes/common.inc index e70816b..aff7665 100644 --- a/core/includes/common.inc +++ b/core/includes/common.inc @@ -354,7 +354,7 @@ function _drupal_default_html_head() { /** * Retrieves output to be displayed in the HEAD tag of the HTML page. - */ + */ function drupal_get_html_head() { $elements = drupal_add_html_head(); drupal_alter('html_head', $elements); @@ -3408,7 +3408,12 @@ function drupal_pre_render_html_tag($element) { } $markup .= '\n"; } - $element['#markup'] = $markup; + if (!empty($element['#noscript'])) { + $element['#markup'] = ''; + } + else { + $element['#markup'] = $markup; + } return $element; } @@ -3592,7 +3597,7 @@ function drupal_pre_render_dropbutton($element) { } /** - * Renders the page, including all theming. + * Processes the page render array, enhancing it as necessary. * * @param $page * A string or array representing the content of a page. The array consists of @@ -3602,10 +3607,13 @@ function drupal_pre_render_dropbutton($element) { * - #show_messages: Suppress drupal_get_message() items. Used by Batch * API (optional). * + * @return array + * The processed render array for the page. + * * @see hook_page_alter() * @see element_info() */ -function drupal_render_page($page) { +function drupal_prepare_page($page) { $main_content_display = &drupal_static('system_main_content_added', FALSE); // Pull out the page title to set it back later. @@ -3642,6 +3650,28 @@ function drupal_render_page($page) { $page['#title'] = $title; } + return $page; +} + +/** + * Renders the page, including all theming. + * + * @param string|array $page + * A string or array representing the content of a page. The array consists of + * the following keys: + * - #type: Value is always 'page'. This pushes the theming through + * the page template (required). + * - #show_messages: Suppress drupal_get_message() items. Used by Batch + * API (optional). + * + * @return string + * Returns the rendered string. + * + * @see hook_page_alter() + * @see element_info() + */ +function drupal_render_page($page) { + $page = drupal_prepare_page($page); return drupal_render($page); } diff --git a/core/includes/config.inc b/core/includes/config.inc index af62fda..c7fca03 100644 --- a/core/includes/config.inc +++ b/core/includes/config.inc @@ -7,6 +7,7 @@ use Drupal\Core\Config\Context\FreeConfigContext; use Drupal\Core\Config\FileStorage; use Drupal\Core\Config\StorageInterface; +use Drupal\Core\Entity\EntityTypeInterface; use Symfony\Component\Yaml\Dumper; /** @@ -202,8 +203,8 @@ function config_context_leave() { * Either the entity type name, or NULL if none match. */ function config_get_entity_type_by_name($name) { - $entities = array_filter(entity_get_info(), function($entity_info) use ($name) { - return (isset($entity_info['config_prefix']) && strpos($name, $entity_info['config_prefix'] . '.') === 0); + $entities = array_filter(\Drupal::entityManager()->getDefinitions(), function (EntityTypeInterface $entity_info) use ($name) { + return ($config_prefix = $entity_info->getConfigPrefix()) && strpos($name, $config_prefix . '.') === 0; }); return key($entities); } diff --git a/core/includes/entity.inc b/core/includes/entity.inc index 4dddce1..28d2025 100644 --- a/core/includes/entity.inc +++ b/core/includes/entity.inc @@ -266,11 +266,10 @@ function entity_revision_delete($entity_type, $revision_id) { * @see \Drupal\Core\Entity\EntityManagerInterface */ function entity_load_by_uuid($entity_type, $uuid, $reset = FALSE) { - $entity_info = entity_get_info($entity_type); - if (empty($entity_info['entity_keys']['uuid'])) { + $entity_info = \Drupal::entityManager()->getDefinition($entity_type); + if (!$uuid_key = $entity_info->getKey('uuid')) { throw new EntityStorageException("Entity type $entity_type does not support UUIDs."); } - $uuid_key = $entity_info['entity_keys']['uuid']; $controller = \Drupal::entityManager()->getStorageController($entity_type); if ($reset) { diff --git a/core/includes/errors.inc b/core/includes/errors.inc index b7c15b6..03594fe 100644 --- a/core/includes/errors.inc +++ b/core/includes/errors.inc @@ -373,12 +373,14 @@ function format_backtrace(array $backtrace) { else { $call['function'] = 'main'; } - foreach ($trace['args'] as $arg) { - if (is_scalar($arg)) { - $call['args'][] = is_string($arg) ? '\'' . filter_xss($arg) . '\'' : $arg; - } - else { - $call['args'][] = ucfirst(gettype($arg)); + if (isset($trace['args'])) { + foreach ($trace['args'] as $arg) { + if (is_scalar($arg)) { + $call['args'][] = is_string($arg) ? '\'' . filter_xss($arg) . '\'' : $arg; + } + else { + $call['args'][] = ucfirst(gettype($arg)); + } } } $return .= $call['function'] . '(' . implode(', ', $call['args']) . ")\n"; diff --git a/core/includes/install.core.inc b/core/includes/install.core.inc index 8db114a..b44c59a 100644 --- a/core/includes/install.core.inc +++ b/core/includes/install.core.inc @@ -1901,7 +1901,7 @@ function install_already_done_error() { global $base_url; drupal_set_title(t('Drupal already installed')); - return t('', array('@base-url' => $base_url)); + return t('', array('@base-url' => $base_url)); } /** diff --git a/core/includes/install.inc b/core/includes/install.inc index f6848c9..256c79e 100644 --- a/core/includes/install.inc +++ b/core/includes/install.inc @@ -177,24 +177,20 @@ function drupal_get_database_types() { * and comment properties. * @code * $settings['config_directories'] = array( - * CONFIG_ACTIVE_DIRECTORY => array( - * 'path' => (object) array( - * 'value' => 'config__hash/active' - * 'required' => TRUE, - * ), + * CONFIG_ACTIVE_DIRECTORY => (object) array( + * 'value' => 'config_hash/active' + * 'required' => TRUE, * ), - * CONFIG_STAGING_DIRECTORY => array( - * 'path' => (object) array( - * 'value' => 'config_hash/staging', - * 'required' => TRUE, - * ), + * CONFIG_STAGING_DIRECTORY => (object) array( + * 'value' => 'config_hash/staging', + * 'required' => TRUE, * ), * ); * @endcode * gets dumped as: * @code - * $config_directories['active']['path'] = 'config__hash/active'; - * $config_directories['staging']['path'] = 'config__hash/staging' + * $config_directories['active'] = 'config_hash/active'; + * $config_directories['staging'] = 'config_hash/staging' * @endcode */ function drupal_rewrite_settings($settings = array(), $settings_file = NULL) { @@ -452,17 +448,13 @@ function drupal_install_config_directories($mode = NULL) { if (empty($config_directories)) { $config_directories_hash = Crypt::randomStringHashed(55); $settings['config_directories'] = array( - CONFIG_ACTIVE_DIRECTORY => array( - 'path' => (object) array( - 'value' => 'config_' . $config_directories_hash . '/active', - 'required' => TRUE, - ), + CONFIG_ACTIVE_DIRECTORY => (object) array( + 'value' => conf_path() . '/files/config_' . $config_directories_hash . '/active', + 'required' => TRUE, ), - CONFIG_STAGING_DIRECTORY => array( - 'path' => (object) array( - 'value' => 'config_' . $config_directories_hash . '/staging', - 'required' => TRUE, - ), + CONFIG_STAGING_DIRECTORY => (object) array( + 'value' => conf_path() . '/files/config_' . $config_directories_hash . '/staging', + 'required' => TRUE, ), ); // Rewrite settings.php, which also sets the value as global variable. diff --git a/core/includes/mail.inc b/core/includes/mail.inc index dfa3f1d..61dfb7e 100644 --- a/core/includes/mail.inc +++ b/core/includes/mail.inc @@ -96,8 +96,8 @@ * Language code to use to compose the e-mail. * @param array $params * (optional) Parameters to build the e-mail. - * @param string|null $from - * Sets From to this value, if given. + * @param string|null $reply + * Optional e-mail address to be used to answer. * @param bool $send * If TRUE, drupal_mail() will call drupal_mail_system()->mail() to deliver * the message, and store the result in $message['result']. Modules @@ -111,13 +111,12 @@ * written to the watchdog. (Success means nothing more than the message being * accepted at php-level, which still doesn't guarantee it to be delivered.) */ -function drupal_mail($module, $key, $to, $langcode, $params = array(), $from = NULL, $send = TRUE) { +function drupal_mail($module, $key, $to, $langcode, $params = array(), $reply = NULL, $send = TRUE) { $site_config = \Drupal::config('system.site'); $site_mail = $site_config->get('mail'); if (empty($site_mail)) { $site_mail = ini_get('sendmail_from'); } - $default_from = $site_mail; // Bundle up the variables into a structured array for altering. $message = array( @@ -125,7 +124,8 @@ function drupal_mail($module, $key, $to, $langcode, $params = array(), $from = N 'module' => $module, 'key' => $key, 'to' => $to, - 'from' => isset($from) ? $from : $default_from, + 'from' => $site_mail, + 'reply-to' => $reply, 'langcode' => $langcode, 'params' => $params, 'send' => TRUE, @@ -140,15 +140,13 @@ function drupal_mail($module, $key, $to, $langcode, $params = array(), $from = N 'Content-Transfer-Encoding' => '8Bit', 'X-Mailer' => 'Drupal' ); - if ($default_from) { - // To prevent e-mail from looking like spam, the addresses in the Sender and - // Return-Path headers should have a domain authorized to use the originating - // SMTP server. - $headers['Sender'] = $headers['Return-Path'] = $default_from; - $headers['From'] = $site_config->get('name') . ' <' . $default_from . '>'; - } - if ($from && $from != $default_from) { - $headers['From'] = $from; + // To prevent e-mail from looking like spam, the addresses in the Sender and + // Return-Path headers should have a domain authorized to use the + // originating SMTP server. + $headers['Sender'] = $headers['Return-Path'] = $site_mail; + $headers['From'] = $site_config->get('name') . ' <' . $site_mail . '>'; + if ($reply) { + $headers['Reply-to'] = $reply; } $message['headers'] = $headers; @@ -181,7 +179,7 @@ function drupal_mail($module, $key, $to, $langcode, $params = array(), $from = N $message['result'] = $system->mail($message); // Log errors. if (!$message['result']) { - watchdog('mail', 'Error sending e-mail (from %from to %to).', array('%from' => $message['from'], '%to' => $message['to']), WATCHDOG_ERROR); + watchdog('mail', 'Error sending e-mail (from %from to %to with reply-to %reply).', array('%from' => $message['from'], '%to' => $message['to'], '%reply' => $message['reply-to'] ? $message['reply-to'] : t('not set')), WATCHDOG_ERROR); drupal_set_message(t('Unable to send e-mail. Contact the site administrator if the problem persists.'), 'error'); } } diff --git a/core/includes/theme.inc b/core/includes/theme.inc index 9545be7..3db84a9 100644 --- a/core/includes/theme.inc +++ b/core/includes/theme.inc @@ -2054,15 +2054,22 @@ function _template_preprocess_default_variables() { * @see system_elements() */ function template_preprocess_html(&$variables) { - $language_interface = language(Language::TYPE_INTERFACE); + /** @var $page \Drupal\Core\Page\HtmlPage */ + $page = $variables['page_object']; + + $variables['html_attributes'] = $page->getHtmlAttributes(); + $variables['attributes'] = $page->getBodyAttributes(); + $variables['page'] = $page->getContent(); // Compile a list of classes that are going to be applied to the body element. // This allows advanced theming based on context (home page, node of certain type, etc.). - $variables['attributes']['class'][] = 'html'; + $body_classes = $variables['attributes']['class']; + $body_classes[] = 'html'; // Add a class that tells us whether we're on the front page or not. - $variables['attributes']['class'][] = $variables['is_front'] ? 'front' : 'not-front'; + $body_classes[] = $variables['is_front'] ? 'front' : 'not-front'; // Add a class that tells us whether the page is viewed by an authenticated user or not. - $variables['attributes']['class'][] = $variables['logged_in'] ? 'logged-in' : 'not-logged-in'; + $body_classes[] = $variables['logged_in'] ? 'logged-in' : 'not-logged-in'; + $variables['attributes']['class'] = $body_classes; // Populate the body classes. if ($suggestions = theme_get_suggestions(arg(), 'page', '-')) { @@ -2080,6 +2087,7 @@ function template_preprocess_html(&$variables) { $variables['html_attributes'] = new Attribute; // HTML element attributes. + $language_interface = \Drupal::service('language_manager')->getLanguage(); $variables['html_attributes']['lang'] = $language_interface->id; $variables['html_attributes']['dir'] = $language_interface->direction ? 'rtl' : 'ltr'; @@ -2097,9 +2105,9 @@ function template_preprocess_html(&$variables) { $site_config = \Drupal::config('system.site'); // Construct page title. - if (!empty($variables['page']['#title'])) { + if ($page->hasTitle()) { $head_title = array( - 'title' => strip_tags($variables['page']['#title']), + 'title' => strip_tags($page->getTitle()), 'name' => String::checkPlain($site_config->get('name')), ); } @@ -2149,15 +2157,8 @@ function template_preprocess_html(&$variables) { drupal_add_library('system', 'html5shiv', TRUE); - // Render page_top and page_bottom into top level variables. - $variables['page_top'] = array(); - if (isset($variables['page']['page_top'])) { - $variables['page_top'] = drupal_render($variables['page']['page_top']); - } - $variables['page_bottom'] = array(); - if (isset($variables['page']['page_bottom'])) { - $variables['page_bottom'][]['#markup'] = drupal_render($variables['page']['page_bottom']); - } + $variables['page_top'][] = array('#markup' => $page->getBodyTop()); + $variables['page_bottom'][] = array('#markup' => $page->getBodyBottom()); // Add footer scripts as '#markup' so they can be rendered with other // elements in page_bottom. @@ -2557,7 +2558,7 @@ function drupal_common_theme() { return array( // From theme.inc. 'html' => array( - 'render element' => 'page', + 'variables' => array('page_object' => NULL), 'template' => 'html', ), 'page' => array( @@ -2631,7 +2632,7 @@ function drupal_common_theme() { ), // From theme.maintenance.inc. 'maintenance_page' => array( - 'variables' => array('content' => NULL, 'show_messages' => TRUE), + 'variables' => array('content' => NULL, 'show_messages' => TRUE, 'page' => array()), 'template' => 'maintenance-page', ), 'install_page' => array( diff --git a/core/includes/update.inc b/core/includes/update.inc index b63bf8c..73f9b7f 100644 --- a/core/includes/update.inc +++ b/core/includes/update.inc @@ -1643,7 +1643,7 @@ function update_language_list($flags = Language::STATE_CONFIGURABLE) { if (language_multilingual() || \Drupal::moduleHandler()->moduleExists('language')) { // Use language module configuration if available. We can not use // entity_load_multiple() because this breaks during updates. - $language_entities = config_get_storage_names_with_prefix('language.entity'); + $language_entities = config_get_storage_names_with_prefix('language.entity.'); // Initialize default property so callers have an easy reference and can // save the same object without data loss. diff --git a/core/includes/utility.inc b/core/includes/utility.inc index a900262..023ecb0 100644 --- a/core/includes/utility.inc +++ b/core/includes/utility.inc @@ -34,6 +34,12 @@ function drupal_var_export($var, $prefix = '') { * @see rebuild.php */ function drupal_rebuild() { + // Remove Drupal's error and exception handlers; they rely on a working + // service container and other subsystems and will only cause a fatal error + // that hides the actual error. + restore_error_handler(); + restore_exception_handler(); + // drupal_bootstrap(DRUPAL_BOOTSTRAP_KERNEL) will build a new kernel. This // comes before DRUPAL_BOOTSTRAP_PAGE_CACHE. PhpStorageFactory::get('service_container')->deleteAll(); @@ -50,4 +56,9 @@ function drupal_rebuild() { drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL); drupal_flush_all_caches(); + + // Restore Drupal's error and exception handlers. + // @see _drupal_bootstrap_configuration() + set_error_handler('_drupal_error_handler'); + set_exception_handler('_drupal_exception_handler'); } diff --git a/core/lib/Drupal/Component/Annotation/AnnotationBase.php b/core/lib/Drupal/Component/Annotation/AnnotationBase.php new file mode 100644 index 0000000..f256d42 --- /dev/null +++ b/core/lib/Drupal/Component/Annotation/AnnotationBase.php @@ -0,0 +1,71 @@ +provider; + } + + /** + * {@inheritdoc} + */ + public function setProvider($provider) { + $this->provider = $provider; + } + + /** + * {@inheritdoc} + */ + public function getId() { + return $this->id; + } + + /** + * {@inheritdoc} + */ + public function getClass() { + return $this->class; + } + + /** + * {@inheritdoc} + */ + public function setClass($class) { + $this->class = $class; + } + +} diff --git a/core/lib/Drupal/Component/Annotation/AnnotationInterface.php b/core/lib/Drupal/Component/Annotation/AnnotationInterface.php index e3aacc6..03caad8 100644 --- a/core/lib/Drupal/Component/Annotation/AnnotationInterface.php +++ b/core/lib/Drupal/Component/Annotation/AnnotationInterface.php @@ -17,4 +17,39 @@ */ public function get(); + /** + * Returns the name of the provider of the annotated class. + * + * @return string + */ + public function getProvider(); + + /** + * Sets the name of the provider of the annotated class. + * + * @param string $provider + */ + public function setProvider($provider); + + /** + * Returns the unique ID for this annotated class. + * + * @return string + */ + public function getId(); + + /** + * Returns the class of the annotated class. + * + * @return string + */ + public function getClass(); + + /** + * Sets the class of the annotated class. + * + * @param string $class + */ + public function setClass($class); + } diff --git a/core/lib/Drupal/Component/Annotation/Plugin.php b/core/lib/Drupal/Component/Annotation/Plugin.php index b67092b..115e94b 100644 --- a/core/lib/Drupal/Component/Annotation/Plugin.php +++ b/core/lib/Drupal/Component/Annotation/Plugin.php @@ -71,10 +71,45 @@ protected function parse(array $values) { } /** - * Implements Drupal\Core\Annotation\AnnotationInterface::get(). + * {@inheritdoc} */ public function get() { return $this->definition; } + /** + * {@inheritdoc} + */ + public function getProvider() { + return isset($this->definition['provider']) ? $this->definition['provider'] : FALSE; + } + + /** + * {@inheritdoc} + */ + public function setProvider($provider) { + $this->definition['provider'] = $provider; + } + + /** + * {@inheritdoc} + */ + public function getId() { + return $this->definition['id']; + } + + /** + * {@inheritdoc} + */ + public function getClass() { + return $this->definition['class']; + } + + /** + * {@inheritdoc} + */ + public function setClass($class) { + $this->definition['class'] = $class; + } + } diff --git a/core/lib/Drupal/Component/Annotation/Plugin/Discovery/AnnotatedClassDiscovery.php b/core/lib/Drupal/Component/Annotation/Plugin/Discovery/AnnotatedClassDiscovery.php index b9236be..b04e39d 100644 --- a/core/lib/Drupal/Component/Annotation/Plugin/Discovery/AnnotatedClassDiscovery.php +++ b/core/lib/Drupal/Component/Annotation/Plugin/Discovery/AnnotatedClassDiscovery.php @@ -7,6 +7,7 @@ namespace Drupal\Component\Annotation\Plugin\Discovery; +use Drupal\Component\Annotation\AnnotationInterface; use Drupal\Component\Plugin\Discovery\DiscoveryInterface; use Drupal\Component\Annotation\Reflection\MockFileFinder; use Doctrine\Common\Annotations\SimpleAnnotationReader; @@ -115,12 +116,12 @@ public function getDefinitions() { $finder = MockFileFinder::create($fileinfo->getPathName()); $parser = new StaticReflectionParser($class, $finder, TRUE); + /** @var $annotation \Drupal\Component\Annotation\AnnotationInterface */ if ($annotation = $reader->getClassAnnotation($parser->getReflectionClass(), $this->pluginDefinitionAnnotationName)) { + $this->prepareAnnotationDefinition($annotation, $class); // AnnotationInterface::get() returns the array definition // instead of requiring us to work with the annotation object. - $definition = $annotation->get(); - $definition['class'] = $class; - $definitions[$definition['id']] = $definition; + $definitions[$annotation->getId()] = $annotation->get(); } } } @@ -135,6 +136,18 @@ public function getDefinitions() { } /** + * Prepares the annotation definition. + * + * @param \Drupal\Component\Annotation\AnnotationInterface $annotation + * The annotation derived from the plugin. + * @param string $class + * The class used for the plugin. + */ + protected function prepareAnnotationDefinition(AnnotationInterface $annotation, $class) { + $annotation->setClass($class); + } + + /** * Returns an array of PSR-0 namespaces to search for plugin classes. */ protected function getPluginNamespaces() { diff --git a/core/lib/Drupal/Component/Annotation/PluginID.php b/core/lib/Drupal/Component/Annotation/PluginID.php index dcb27aa..fe8e599 100644 --- a/core/lib/Drupal/Component/Annotation/PluginID.php +++ b/core/lib/Drupal/Component/Annotation/PluginID.php @@ -12,7 +12,7 @@ * * @Annotation */ -class PluginID implements AnnotationInterface { +class PluginID extends AnnotationBase { /** * The plugin ID. @@ -29,7 +29,16 @@ class PluginID implements AnnotationInterface { public function get() { return array( 'id' => $this->value, + 'class' => $this->class, + 'provider' => $this->provider, ); } + /** + * {@inheritdoc} + */ + public function getId() { + return $this->value; + } + } diff --git a/core/lib/Drupal/Core/Access/AccessException.php b/core/lib/Drupal/Core/Access/AccessException.php index a44738e..4f21092 100644 --- a/core/lib/Drupal/Core/Access/AccessException.php +++ b/core/lib/Drupal/Core/Access/AccessException.php @@ -8,7 +8,10 @@ namespace Drupal\Core\Access; /** - * An exception thrown for invalid access callback return values. + * An exception thrown for access errors. + * + * Examples could be invalid access callback return values, or invalid access + * objects being used. */ class AccessException extends \RuntimeException { } diff --git a/core/lib/Drupal/Core/Access/AccessManager.php b/core/lib/Drupal/Core/Access/AccessManager.php index f33d47f..89e9268 100644 --- a/core/lib/Drupal/Core/Access/AccessManager.php +++ b/core/lib/Drupal/Core/Access/AccessManager.php @@ -8,6 +8,7 @@ namespace Drupal\Core\Access; use Drupal\Core\ParamConverter\ParamConverterManager; +use Drupal\Core\Routing\Access\AccessInterface as RoutingAccessInterface; use Drupal\Core\Routing\RequestHelper; use Drupal\Core\Routing\RouteProviderInterface; use Drupal\Core\Session\AccountInterface; @@ -16,7 +17,6 @@ use Symfony\Component\Routing\Route; use Symfony\Component\DependencyInjection\ContainerAware; use Symfony\Component\HttpFoundation\Request; -use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException; use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; use Symfony\Component\Routing\Exception\RouteNotFoundException; use Symfony\Cmf\Component\Routing\RouteObjectInterface; @@ -118,9 +118,15 @@ public function setRequest(Request $request) { * * @param string $service_id * The ID of the service in the Container that provides a check. + * @param array $applies_checks + * (optional) An array of route requirement keys the checker service applies + * to. */ - public function addCheckService($service_id) { + public function addCheckService($service_id, array $applies_checks = array()) { $this->checkIds[] = $service_id; + foreach ($applies_checks as $applies_check) { + $this->staticRequirementMap[$applies_check][] = $service_id; + } } /** @@ -130,7 +136,7 @@ public function addCheckService($service_id) { * A collection of routes to apply checks to. */ public function setChecks(RouteCollection $routes) { - $this->loadAccessRequirementMap(); + $this->loadDynamicRequirementMap(); foreach ($routes as $route) { if ($checks = $this->applies($route)) { $route->setOption('_access_checks', $checks); @@ -329,19 +335,24 @@ protected function loadCheck($service_id) { throw new \InvalidArgumentException(sprintf('No check has been registered for %s', $service_id)); } - $this->checks[$service_id] = $this->container->get($service_id); + $check = $this->container->get($service_id); + + if (!($check instanceof RoutingAccessInterface)) { + throw new AccessException('All access checks must implement AccessInterface.'); + } + + $this->checks[$service_id] = $check; } /** * Compiles a mapping of requirement keys to access checker service IDs. */ - public function loadAccessRequirementMap() { - if (isset($this->staticRequirementMap, $this->dynamicRequirementMap)) { + public function loadDynamicRequirementMap() { + if (isset($this->dynamicRequirementMap)) { return; } // Set them here, so we can use the isset() check above. - $this->staticRequirementMap = array(); $this->dynamicRequirementMap = array(); foreach ($this->checkIds as $service_id) { @@ -349,14 +360,8 @@ public function loadAccessRequirementMap() { $this->loadCheck($service_id); } - // Empty arrays will not register anything. - if (is_subclass_of($this->checks[$service_id], 'Drupal\Core\Access\StaticAccessCheckInterface')) { - foreach ((array) $this->checks[$service_id]->appliesTo() as $key) { - $this->staticRequirementMap[$key][] = $service_id; - } - } - // Add the service ID to a the regular that will be iterated over. - else { + // Add the service ID to an array that will be iterated over. + if ($this->checks[$service_id] instanceof AccessCheckInterface) { $this->dynamicRequirementMap[] = $service_id; } } diff --git a/core/lib/Drupal/Core/Access/CsrfAccessCheck.php b/core/lib/Drupal/Core/Access/CsrfAccessCheck.php index 98be68c..9744d6c 100644 --- a/core/lib/Drupal/Core/Access/CsrfAccessCheck.php +++ b/core/lib/Drupal/Core/Access/CsrfAccessCheck.php @@ -7,8 +7,8 @@ namespace Drupal\Core\Access; -use Drupal\Core\Access\CsrfTokenGenerator; use Drupal\Core\Session\AccountInterface; +use Drupal\Core\Routing\Access\AccessInterface as RoutingAccessInterface; use Symfony\Component\Routing\Route; use Symfony\Component\HttpFoundation\Request; @@ -19,7 +19,7 @@ * a token generated by \Drupal::csrfToken()->get() using the same value as the * "_csrf_token" parameter in the route. */ -class CsrfAccessCheck implements StaticAccessCheckInterface { +class CsrfAccessCheck implements RoutingAccessInterface { /** * The CSRF token generator. @@ -41,13 +41,6 @@ function __construct(CsrfTokenGenerator $csrf_token) { /** * {@inheritdoc} */ - public function appliesTo() { - return array('_csrf_token'); - } - - /** - * {@inheritdoc} - */ public function access(Route $route, Request $request, AccountInterface $account) { // If this is the controller request, check CSRF access as normal. if ($request->attributes->get('_controller_request')) { diff --git a/core/lib/Drupal/Core/Access/CustomAccessCheck.php b/core/lib/Drupal/Core/Access/CustomAccessCheck.php index 20f0ead..c116e66 100644 --- a/core/lib/Drupal/Core/Access/CustomAccessCheck.php +++ b/core/lib/Drupal/Core/Access/CustomAccessCheck.php @@ -8,6 +8,7 @@ namespace Drupal\Core\Access; use Drupal\Core\Controller\ControllerResolverInterface; +use Drupal\Core\Routing\Access\AccessInterface as RoutingAccessInterface; use Drupal\Core\Session\AccountInterface; use Symfony\Component\HttpFoundation\Request; use Symfony\Component\Routing\Route; @@ -22,7 +23,7 @@ * cannot reuse any stored property of your actual controller instance used * to generate the output. */ -class CustomAccessCheck implements StaticAccessCheckInterface { +class CustomAccessCheck implements RoutingAccessInterface { /** * The controller resolver. @@ -44,13 +45,6 @@ public function __construct(ControllerResolverInterface $controller_resolver) { /** * {@inheritdoc} */ - public function appliesTo() { - return array('_custom_access'); - } - - /** - * {@inheritdoc} - */ public function access(Route $route, Request $request, AccountInterface $account) { $access_controller = $route->getRequirement('_custom_access'); diff --git a/core/lib/Drupal/Core/Access/DefaultAccessCheck.php b/core/lib/Drupal/Core/Access/DefaultAccessCheck.php index 123fc5d..dc26067 100644 --- a/core/lib/Drupal/Core/Access/DefaultAccessCheck.php +++ b/core/lib/Drupal/Core/Access/DefaultAccessCheck.php @@ -8,20 +8,14 @@ namespace Drupal\Core\Access; use Drupal\Core\Session\AccountInterface; +use Drupal\Core\Routing\Access\AccessInterface as RoutingAccessInterface; use Symfony\Component\Routing\Route; use Symfony\Component\HttpFoundation\Request; /** * Allows access to routes to be controlled by an '_access' boolean parameter. */ -class DefaultAccessCheck implements StaticAccessCheckInterface { - - /** - * {@inheritdoc} - */ - public function appliesTo() { - return array('_access'); - } +class DefaultAccessCheck implements RoutingAccessInterface { /** * {@inheritdoc} diff --git a/core/lib/Drupal/Core/Access/StaticAccessCheckInterface.php b/core/lib/Drupal/Core/Access/StaticAccessCheckInterface.php deleted file mode 100644 index c01b719..0000000 --- a/core/lib/Drupal/Core/Access/StaticAccessCheckInterface.php +++ /dev/null @@ -1,34 +0,0 @@ -entityInfo['class'], 'sort')); + uasort($entities, array($this->entityInfo->getClass(), 'sort')); return $entities; } @@ -41,7 +41,7 @@ public function getOperations(EntityInterface $entity) { $operations['edit']['href'] = $uri['path']; } - if (isset($this->entityInfo['entity_keys']['status'])) { + if ($this->entityInfo->hasKey('status')) { if (!$entity->status()) { $operations['enable'] = array( 'title' => t('Enable'), diff --git a/core/lib/Drupal/Core/Config/Entity/ConfigStorageController.php b/core/lib/Drupal/Core/Config/Entity/ConfigStorageController.php index 0ee55e2..458d765 100644 --- a/core/lib/Drupal/Core/Config/Entity/ConfigStorageController.php +++ b/core/lib/Drupal/Core/Config/Entity/ConfigStorageController.php @@ -13,6 +13,7 @@ use Drupal\Core\Config\Config; use Drupal\Core\Config\ConfigFactory; use Drupal\Core\Config\StorageInterface; +use Drupal\Core\Entity\EntityTypeInterface; use Drupal\Core\Entity\Query\QueryFactory; use Drupal\Component\Uuid\UuidInterface; use Symfony\Component\DependencyInjection\ContainerInterface; @@ -79,10 +80,8 @@ class ConfigStorageController extends EntityStorageControllerBase { /** * Constructs a ConfigStorageController object. * - * @param string $entity_type - * The entity type for which the instance is created. - * @param array $entity_info - * An array of entity info for the entity type. + * @param \Drupal\Core\Entity\EntityTypeInterface $entity_info + * The entity info for the entity type. * @param \Drupal\Core\Config\ConfigFactory $config_factory * The config factory service. * @param \Drupal\Core\Config\StorageInterface $config_storage @@ -92,17 +91,11 @@ class ConfigStorageController extends EntityStorageControllerBase { * @param \Drupal\Component\Uuid\UuidInterface $uuid_service * The UUID service. */ - public function __construct($entity_type, array $entity_info, ConfigFactory $config_factory, StorageInterface $config_storage, QueryFactory $entity_query_factory, UuidInterface $uuid_service) { - parent::__construct($entity_type, $entity_info); + public function __construct(EntityTypeInterface $entity_info, ConfigFactory $config_factory, StorageInterface $config_storage, QueryFactory $entity_query_factory, UuidInterface $uuid_service) { + parent::__construct($entity_info); - $this->idKey = $this->entityInfo['entity_keys']['id']; - - if (isset($this->entityInfo['entity_keys']['status'])) { - $this->statusKey = $this->entityInfo['entity_keys']['status']; - } - else { - $this->statusKey = FALSE; - } + $this->idKey = $this->entityInfo->getKey('id'); + $this->statusKey = $this->entityInfo->getKey('status'); $this->configFactory = $config_factory; $this->configStorage = $config_storage; @@ -113,9 +106,8 @@ public function __construct($entity_type, array $entity_info, ConfigFactory $con /** * {@inheritdoc} */ - public static function createInstance(ContainerInterface $container, $entity_type, array $entity_info) { + public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_info) { return new static( - $entity_type, $entity_info, $container->get('config.factory'), $container->get('config.storage'), @@ -208,7 +200,7 @@ public function getQuery($conjunction = 'AND') { * The full configuration prefix, for example 'views.view.'. */ public function getConfigPrefix() { - return $this->entityInfo['config_prefix'] . '.'; + return $this->entityInfo->getConfigPrefix() . '.'; } /** @@ -249,7 +241,7 @@ public static function getIDFromConfigName($config_name, $config_prefix) { * A SelectQuery object for loading the entity. */ protected function buildQuery($ids, $revision_id = FALSE) { - $config_class = $this->entityInfo['class']; + $config_class = $this->entityInfo->getClass(); $prefix = $this->getConfigPrefix(); // Get the names of the configuration entities we are going to load. @@ -276,7 +268,7 @@ protected function buildQuery($ids, $revision_id = FALSE) { * Implements Drupal\Core\Entity\EntityStorageControllerInterface::create(). */ public function create(array $values) { - $class = $this->entityInfo['class']; + $class = $this->entityInfo->getClass(); $class::preCreate($this, $values); // Set default language to site default if not provided. @@ -314,7 +306,7 @@ public function delete(array $entities) { return; } - $entity_class = $this->entityInfo['class']; + $entity_class = $this->entityInfo->getClass(); $entity_class::preDelete($this, $entities); foreach ($entities as $entity) { $this->invokeHook('predelete', $entity); @@ -458,7 +450,7 @@ public function importCreate($name, Config $new_config, Config $old_config) { * A configuration object containing the old configuration data. */ public function importUpdate($name, Config $new_config, Config $old_config) { - $id = static::getIDFromConfigName($name, $this->entityInfo['config_prefix']); + $id = static::getIDFromConfigName($name, $this->entityInfo->getConfigPrefix()); $entity = $this->load($id); $entity->setSyncing(TRUE); $entity->original = clone $entity; @@ -489,7 +481,7 @@ public function importUpdate($name, Config $new_config, Config $old_config) { * A configuration object containing the old configuration data. */ public function importDelete($name, Config $new_config, Config $old_config) { - $id = static::getIDFromConfigName($name, $this->entityInfo['config_prefix']); + $id = static::getIDFromConfigName($name, $this->entityInfo->getConfigPrefix()); $entity = $this->load($id); $entity->setSyncing(TRUE); $entity->delete(); diff --git a/core/lib/Drupal/Core/Config/Entity/DraggableListController.php b/core/lib/Drupal/Core/Config/Entity/DraggableListController.php index 2cb3f43..8e61eb4 100644 --- a/core/lib/Drupal/Core/Config/Entity/DraggableListController.php +++ b/core/lib/Drupal/Core/Config/Entity/DraggableListController.php @@ -9,6 +9,7 @@ use Drupal\Core\Entity\EntityInterface; use Drupal\Core\Entity\EntityStorageControllerInterface; +use Drupal\Core\Entity\EntityTypeInterface; use Drupal\Core\Extension\ModuleHandlerInterface; use Drupal\Core\Form\FormInterface; @@ -41,12 +42,12 @@ /** * {@inheritdoc} */ - public function __construct($entity_type, array $entity_info, EntityStorageControllerInterface $storage, ModuleHandlerInterface $module_handler) { - parent::__construct($entity_type, $entity_info, $storage, $module_handler); + public function __construct(EntityTypeInterface $entity_info, EntityStorageControllerInterface $storage, ModuleHandlerInterface $module_handler) { + parent::__construct($entity_info, $storage, $module_handler); // Check if the entity type supports weighting. - if (!empty($this->entityInfo['entity_keys']['weight'])) { - $this->weightKey = $this->entityInfo['entity_keys']['weight']; + if ($this->entityInfo->hasKey('weight')) { + $this->weightKey = $this->entityInfo->getKey('weight'); } } @@ -99,7 +100,7 @@ public function buildForm(array $form, array &$form_state) { $form[$this->entitiesKey] = array( '#type' => 'table', '#header' => $this->buildHeader(), - '#empty' => t('There is no @label yet.', array('@label' => $this->entityInfo['label'])), + '#empty' => t('There is no @label yet.', array('@label' => $this->entityInfo->getLabel())), '#tabledrag' => array( array( 'action' => 'order', diff --git a/core/lib/Drupal/Core/Config/Entity/Query/Query.php b/core/lib/Drupal/Core/Config/Entity/Query/Query.php index b398f83..130f171 100644 --- a/core/lib/Drupal/Core/Config/Entity/Query/Query.php +++ b/core/lib/Drupal/Core/Config/Entity/Query/Query.php @@ -86,7 +86,7 @@ public function condition($property, $value = NULL, $operator = NULL, $langcode public function execute() { // Load all config files. $entity_info = $this->entityManager->getDefinition($this->getEntityType()); - $prefix = $entity_info['config_prefix'] . '.'; + $prefix = $entity_info->getConfigPrefix() . '.'; $prefix_length = strlen($prefix); $names = $this->configStorage->listAll($prefix); $configs = array(); diff --git a/core/lib/Drupal/Core/Controller/AjaxController.php b/core/lib/Drupal/Core/Controller/AjaxController.php index 7b2cece..2f8498e 100644 --- a/core/lib/Drupal/Core/Controller/AjaxController.php +++ b/core/lib/Drupal/Core/Controller/AjaxController.php @@ -10,8 +10,11 @@ use Drupal\Core\Ajax\AjaxResponse; use Drupal\Core\Ajax\InsertCommand; use Drupal\Core\Ajax\PrependCommand; +use Drupal\Core\Page\HtmlFragment; +use Drupal\Core\Page\HtmlPage; use Symfony\Component\DependencyInjection\ContainerAware; use Symfony\Component\HttpFoundation\Request; +use Symfony\Component\HttpFoundation\Response; /** * Default controller for ajax requests. @@ -19,6 +22,23 @@ class AjaxController extends ContainerAware { /** + * The controller resolver. + * + * @var \Drupal\Core\Controller\ControllerResolverInterface + */ + protected $controllerResolver; + + /** + * Constructs a new AjaxController instance. + * + * @param \Drupal\Core\Controller\ControllerResolverInterface $controller_resolver + * The controller resolver. + */ + public function __construct(ControllerResolverInterface $controller_resolver) { + $this->controllerResolver = $controller_resolver; + } + + /** * Controller method for AJAX content. * * @param \Symfony\Component\HttpFoundation\Request $request @@ -30,50 +50,66 @@ class AjaxController extends ContainerAware { * A response object. */ public function content(Request $request, $_content) { + $content = $this->getContentResult($request, $_content); + // If there is already an AjaxResponse, then return it without + // manipulation. + if ($content instanceof AjaxResponse && $content->isOk()) { + return $content; + } - // @todo When we have a Generator, we can replace the forward() call with - // a render() call, which would handle ESI and hInclude as well. That will - // require an _internal route. For examples, see: - // https://github.com/symfony/symfony/blob/master/src/Symfony/Bundle/FrameworkBundle/Resources/config/routing/internal.xml - // https://github.com/symfony/symfony/blob/master/src/Symfony/Bundle/FrameworkBundle/Controller/InternalController.php - $attributes = clone $request->attributes; - $controller = $_content; + // Allow controllers to return a HtmlFragment or a Response object directly. + if ($content instanceof HtmlFragment) { + $content = $content->getContent(); + } + if ($content instanceof Response) { + $content = $content->getContent(); + } - // We need to clean up the derived information and such so that the - // subrequest can be processed properly without leaking data through. - $attributes->remove('_system_path'); - $attributes->remove('_content'); - $attributes->remove('_legacy'); + // Most controllers return a render array, but some return a string. + if (!is_array($content)) { + $content = array( + '#markup' => $content, + ); + } - // Remove the accept header so the subrequest does not end up back in this - // controller. - $request->headers->remove('accept'); - // Remove the header in order to let the subrequest not think that it's an - // ajax request, see \Drupal\Core\ContentNegotiation. - $request->headers->remove('x-requested-with'); + $html = drupal_render($content); - $response = $this->container->get('http_kernel')->forward($controller, $attributes->all(), $request->query->all()); - // For successful (HTTP status 200) responses. - if ($response->isOk()) { - // If there is already an AjaxResponse, then return it without - // manipulation. - if (!($response instanceof AjaxResponse)) { - // Pull the content out of the response. - $content = $response->getContent(); - // A page callback could return a render array or a string. - $html = is_string($content) ? $content : drupal_render($content); - $response = new AjaxResponse(); - // The selector for the insert command is NULL as the new content will - // replace the element making the ajax call. The default 'replaceWith' - // behavior can be changed with #ajax['method']. - $response->addCommand(new InsertCommand(NULL, $html)); - $status_messages = array('#theme' => 'status_messages'); - $output = drupal_render($status_messages); - if (!empty($output)) { - $response->addCommand(new PrependCommand(NULL, $output)); - } - } + $response = new AjaxResponse(); + // The selector for the insert command is NULL as the new content will + // replace the element making the ajax call. The default 'replaceWith' + // behavior can be changed with #ajax['method']. + $response->addCommand(new InsertCommand(NULL, $html)); + $status_messages = array('#theme' => 'status_messages'); + $output = drupal_render($status_messages); + if (!empty($output)) { + $response->addCommand(new PrependCommand(NULL, $output)); } return $response; } + + /** + * Returns the result of invoking the sub-controller. + * + * @param \Symfony\Component\HttpFoundation\Request $request + * The request object. + * @param mixed $controller_definition + * A controller definition string, or a callable object/closure. + * + * @return mixed + * The result of invoking the controller. Render arrays, strings, HtmlPage, + * and HtmlFragment objects are possible. + */ + public function getContentResult(Request $request, $controller_definition) { + if ($controller_definition instanceof \Closure) { + $callable = $controller_definition; + } + else { + $callable = $this->controllerResolver->getControllerFromDefinition($controller_definition); + } + $arguments = $this->controllerResolver->getArguments($request, $callable); + $page_content = call_user_func_array($callable, $arguments); + + return $page_content; + } + } diff --git a/core/lib/Drupal/Core/Controller/DialogController.php b/core/lib/Drupal/Core/Controller/DialogController.php index 7bb34ff..5fda730 100644 --- a/core/lib/Drupal/Core/Controller/DialogController.php +++ b/core/lib/Drupal/Core/Controller/DialogController.php @@ -9,9 +9,10 @@ use Drupal\Core\Ajax\AjaxResponse; use Drupal\Core\Ajax\OpenDialogCommand; +use Drupal\Core\Page\HtmlPage; use Symfony\Cmf\Component\Routing\RouteObjectInterface; use Symfony\Component\HttpFoundation\Request; -use Symfony\Component\HttpKernel\HttpKernelInterface; +use Symfony\Component\HttpFoundation\Response; /** * Defines a default controller for dialog requests. @@ -19,11 +20,11 @@ class DialogController { /** - * The HttpKernel object to use for subrequests. + * The controller resolver service. * - * @var \Symfony\Component\HttpKernel\HttpKernelInterface + * @var \Drupal\Core\Controller\ControllerResolverInterface */ - protected $httpKernel; + protected $controllerResolver; /** * The title resolver. @@ -35,112 +36,126 @@ class DialogController { /** * Constructs a new DialogController. * - * @param \Symfony\Component\HttpKernel\HttpKernelInterface $kernel - * The kernel. + * @param \Drupal\Core\Controller\ControllerResolverInterface $controller_resolver + * The controller resolver service. * @param \Drupal\Core\Controller\TitleResolverInterface $title_resolver * The title resolver. */ - public function __construct(HttpKernelInterface $kernel, TitleResolverInterface $title_resolver) { - $this->httpKernel = $kernel; + public function __construct(ControllerResolverInterface $controller_resolver, TitleResolverInterface $title_resolver) { + $this->controllerResolver = $controller_resolver; $this->titleResolver = $title_resolver; } /** - * Forwards request to a subrequest. - * - * @param \Symfony\Component\HttpFoundation\RequestRequest $request - * The request object. - * - * @return \Symfony\Component\HttpFoundation\Response - * A response object. - */ - protected function forward(Request $request) { - // @todo When we have a Generator, we can replace the forward() call with - // a render() call, which would handle ESI and hInclude as well. That will - // require an _internal route. For examples, see: - // https://github.com/symfony/symfony/blob/master/src/Symfony/Bundle/FrameworkBundle/Resources/config/routing/internal.xml - // https://github.com/symfony/symfony/blob/master/src/Symfony/Bundle/FrameworkBundle/Controller/InternalController.php - $attributes = clone $request->attributes; - // We need to clean up the derived information and such so that the - // subrequest can be processed properly without leaking data through. - $attributes->remove('_system_path'); - $attributes->set('dialog', TRUE); - - // Remove the accept header so the subrequest does not end up back in this - // controller. - $request->headers->remove('accept'); - // Remove the X-Requested-With header so the subrequest is not mistaken for - // an ajax request. - $request->headers->remove('x-requested-with'); - - return $this->httpKernel->forward(NULL, $attributes->all(), $request->query->all()); - } - - /** * Displays content in a modal dialog. * - * @param \Symfony\Component\HttpFoundation\RequestRequest $request + * @param \Symfony\Component\HttpFoundation\Request $request * The request object. + * @param mixed $_content + * A controller definition string, or a callable object/closure. * * @return \Drupal\Core\Ajax\AjaxResponse * AjaxResponse to return the content wrapper in a modal dialog. */ - public function modal(Request $request) { - return $this->dialog($request, TRUE); + public function modal(Request $request, $_content) { + return $this->dialog($request, $_content, TRUE); } /** * Displays content in a dialog. * - * @param \Symfony\Component\HttpFoundation\RequestRequest $request + * @param \Symfony\Component\HttpFoundation\Request $request * The request object. + * @param mixed $_content + * A controller definition string, or a callable object/closure. * @param bool $modal * (optional) TRUE to render a modal dialog. Defaults to FALSE. * * @return \Drupal\Core\Ajax\AjaxResponse * AjaxResponse to return the content wrapper in a dialog. */ - public function dialog(Request $request, $modal = FALSE) { - $subrequest = $this->forward($request); - if ($subrequest->isOk()) { - $content = $subrequest->getContent(); - if (!$title = $this->titleResolver->getTitle($request, $request->attributes->get(RouteObjectInterface::ROUTE_OBJECT))) { - // @todo Remove use of drupal_get_title() when - // http://drupal.org/node/1871596 is in. - $title = drupal_get_title(); - } - $response = new AjaxResponse(); - // Fetch any modal options passed in from data-dialog-options. - if (!($options = $request->request->get('dialogOptions'))) { - $options = array(); - } - // Set modal flag and re-use the modal ID. - if ($modal) { - $options['modal'] = TRUE; - $target = '#drupal-modal'; + public function dialog(Request $request, $_content, $modal = FALSE) { + $page_content = $this->getContentResult($request, $_content); + + // Allow controllers to return a HtmlPage or a Response object directly. + if ($page_content instanceof HtmlPage) { + $page_content = $page_content->getContent(); + } + if ($page_content instanceof Response) { + $page_content = $page_content->getContent(); + } + + // Most controllers return a render array, but some return a string. + if (!is_array($page_content)) { + $page_content = array( + '#markup' => $page_content, + ); + } + + $content = drupal_render($page_content); + + // @todo Remove use of drupal_get_title() when + // http://drupal.org/node/1871596 is in. + if (!$title = $this->titleResolver->getTitle($request, $request->attributes->get(RouteObjectInterface::ROUTE_OBJECT))) { + // @todo Remove use of drupal_get_title() when + // http://drupal.org/node/1871596 is in. + $title = drupal_get_title(); + } + $response = new AjaxResponse(); + // Fetch any modal options passed in from data-dialog-options. + if (!($options = $request->request->get('dialogOptions'))) { + $options = array(); + } + // Set modal flag and re-use the modal ID. + if ($modal) { + $options['modal'] = TRUE; + $target = '#drupal-modal'; + } + else { + // Generate the target wrapper for the dialog. + if (isset($options['target'])) { + // If the target was nominated in the incoming options, use that. + $target = $options['target']; + // Ensure the target includes the #. + if (substr($target, 0, 1) != '#') { + $target = '#' . $target; + } + // This shouldn't be passed on to jQuery.ui.dialog. + unset($options['target']); } else { - // Generate the target wrapper for the dialog. - if (isset($options['target'])) { - // If the target was nominated in the incoming options, use that. - $target = $options['target']; - // Ensure the target includes the #. - if (substr($target, 0, 1) != '#') { - $target = '#' . $target; - } - // This shouldn't be passed on to jQuery.ui.dialog. - unset($options['target']); - } - else { - // Generate a target based on the route id. - $route_name = $request->attributes->get(RouteObjectInterface::ROUTE_NAME); - $target = '#' . drupal_html_id("drupal-dialog-$route_name"); - } + // Generate a target based on the route id. + $route_name = $request->attributes->get(RouteObjectInterface::ROUTE_NAME); + $target = '#' . drupal_html_id("drupal-dialog-$route_name"); } - $response->addCommand(new OpenDialogCommand($target, $title, $content, $options)); - return $response; } - // An error occurred in the subrequest, return that. - return $subrequest; + $response->addCommand(new OpenDialogCommand($target, $title, $content, $options)); + return $response; + } + + /** + * Returns the result of invoking the sub-controller. + * + * @param \Symfony\Component\HttpFoundation\Request $request + * The request object. + * @param mixed $controller_definition + * A controller definition string, or a callable object/closure. + * + * @return mixed + * The result of invoking the controller. Render arrays, strings, HtmlPage, + * and HtmlFragment objects are possible. + */ + public function getContentResult(Request $request, $controller_definition) { + if ($controller_definition instanceof \Closure) { + $callable = $controller_definition; + } + else { + $callable = $this->controllerResolver->getControllerFromDefinition($controller_definition); + } + $arguments = $this->controllerResolver->getArguments($request, $callable); + $page_content = call_user_func_array($callable, $arguments); + + return $page_content; } + } diff --git a/core/lib/Drupal/Core/Controller/ExceptionController.php b/core/lib/Drupal/Core/Controller/ExceptionController.php index 2ba6f2c..af66226 100644 --- a/core/lib/Drupal/Core/Controller/ExceptionController.php +++ b/core/lib/Drupal/Core/Controller/ExceptionController.php @@ -7,7 +7,10 @@ namespace Drupal\Core\Controller; -use Symfony\Component\DependencyInjection\ContainerAware; +use Drupal\Core\Page\HtmlPageRendererInterface; +use Drupal\Core\StringTranslation\TranslationInterface; +use Symfony\Component\DependencyInjection\ContainerAwareInterface; +use Symfony\Component\DependencyInjection\ContainerInterface; use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpFoundation\Response; use Symfony\Component\HttpFoundation\JsonResponse; @@ -19,7 +22,7 @@ /** * This controller handles HTTP errors generated by the routing system. */ -class ExceptionController extends ContainerAware { +class ExceptionController extends HtmlControllerBase implements ContainerAwareInterface { /** * The content negotiation library. @@ -29,14 +32,48 @@ class ExceptionController extends ContainerAware { protected $negotiation; /** + * The service container. + * + * @var \Symfony\Component\DependencyInjection\ContainerInterface + */ + protected $container; + + /** + * The page rendering service. + * + * @var \Drupal\Core\Page\HtmlPageRendererInterface + */ + protected $renderer; + + /** * Constructor. * * @param \Drupal\Core\ContentNegotiation $negotiation * The content negotiation library to use to determine the correct response * format. + * @param \Drupal\Core\StringTranslation\TranslationInterface $translation_manager + * The translation manager. + * @param \Drupal\Core\Controller\TitleResolverInterface $title_resolver + * The title resolver. + * @param \Drupal\Core\Page\HtmlPageRendererInterface $renderer + * The page renderer. */ - public function __construct(ContentNegotiation $negotiation) { + public function __construct(ContentNegotiation $negotiation, TranslationInterface $translation_manager, TitleResolverInterface $title_resolver, HtmlPageRendererInterface $renderer) { + parent::__construct($translation_manager, $title_resolver); $this->negotiation = $negotiation; + $this->renderer = $renderer; + } + + /** + * Sets the Container associated with this Controller. + * + * @param \Symfony\Component\DependencyInjection\ContainerInterface $container + * A ContainerInterface instance. + * + * @api + */ + public function setContainer(ContainerInterface $container = NULL) { + $this->container = $container; } /** @@ -90,14 +127,15 @@ public function on403Html(FlattenException $exception, Request $request) { $system_path = $request->attributes->get('_system_path'); watchdog('access denied', $system_path, NULL, WATCHDOG_WARNING); - $path = $this->container->get('path.alias_manager')->getSystemPath(\Drupal::config('system.site')->get('page.403')); + $system_config = $this->container->get('config.factory')->get('system.site'); + $path = $this->container->get('path.alias_manager')->getSystemPath($system_config->get('page.403')); if ($path && $path != $system_path) { // Keep old path for reference, and to allow forms to redirect to it. if (!$request->query->has('destination')) { $request->query->set('destination', $system_path); } - $subrequest = Request::create($request->getBaseUrl() . '/' . $path, 'get', array('destination' => $system_path), $request->cookies->all(), array(), $request->server->all()); + $subrequest = Request::create($request->getBaseUrl() . '/' . $path, 'get', array('destination' => $system_path, '_exception_statuscode' => 403), $request->cookies->all(), array(), $request->server->all()); // The active trail is being statically cached from the parent request to // the subrequest, like any other static. Unfortunately that means the @@ -119,15 +157,15 @@ public function on403Html(FlattenException $exception, Request $request) { $response->setStatusCode(403, 'Access denied'); } else { + $page_content = array( + '#markup' => t('You are not authorized to access this page.'), + '#title' => t('Access denied'), + ); - // @todo Replace this block with something cleaner. - $return = t('You are not authorized to access this page.'); - drupal_set_title(t('Access denied')); - drupal_set_page_content($return); - $page = element_info('page'); - $content = drupal_render_page($page); - - $response = new Response($content, 403); + $fragment = $this->createHtmlFragment($page_content, $request); + $page = $this->renderer->render($fragment, 403); + $response = new Response($this->renderer->renderPage($page), $page->getStatusCode()); + return $response; } return $response; @@ -173,7 +211,8 @@ public function on404Html(FlattenException $exception, Request $request) { // that and sub-call the kernel rather than using meah(). // @todo The create() method expects a slash-prefixed path, but we store a // normal system path in the site_404 variable. - $subrequest = Request::create($request->getBaseUrl() . '/' . $path, 'get', array('destination' => $system_path), $request->cookies->all(), array(), $request->server->all()); + + $subrequest = Request::create($request->getBaseUrl() . '/' . $path, 'get', array('destination' => $system_path, '_exception_statuscode' => 403), $request->cookies->all(), array(), $request->server->all()); // The active trail is being statically cached from the parent request to // the subrequest, like any other static. Unfortunately that means the @@ -195,14 +234,15 @@ public function on404Html(FlattenException $exception, Request $request) { $response->setStatusCode(404, 'Not Found'); } else { - // @todo Replace this block with something cleaner. - $return = t('The requested page "@path" could not be found.', array('@path' => $request->getPathInfo())); - drupal_set_title(t('Page not found')); - drupal_set_page_content($return); - $page = element_info('page'); - $content = drupal_render_page($page); - - $response = new Response($content, 404); + $page_content = array( + '#markup' => t('The requested page "@path" could not be found.', array('@path' => $request->getPathInfo())), + '#title' => t('Page not found'), + ); + + $fragment = $this->createHtmlFragment($page_content, $request); + $page = $this->renderer->render($fragment, 404); + $response = new Response($this->renderer->renderPage($page), $page->getStatusCode()); + return $response; } return $response; @@ -264,16 +304,16 @@ public function on500Html(FlattenException $exception, Request $request) { drupal_set_message(t('%type: !message in %function (line %line of %file).', $error), $class); } - drupal_set_title(t('Error')); - // We fallback to a maintenance page at this point, because the page - // generation itself can generate errors. - $maintenance_page = array( + $page_content = array( '#theme' => 'maintenance_page', '#content' => t('The website has encountered an error. Please try again later.'), + '#page' => array( + '#title' => t('Error'), + ), ); - $output = drupal_render($maintenance_page); - $response = new Response($output, 500); + $output = drupal_render($page_content); + $response = new Response($output); $response->setStatusCode(500, '500 Service unavailable (with message)'); return $response; diff --git a/core/lib/Drupal/Core/Controller/FormController.php b/core/lib/Drupal/Core/Controller/FormController.php new file mode 100644 index 0000000..271de99 --- /dev/null +++ b/core/lib/Drupal/Core/Controller/FormController.php @@ -0,0 +1,96 @@ +resolver = $resolver; + $this->formBuilder = $form_builder; + } + + /** + * Invokes the form and returns the result. + * + * @param \Symfony\Component\HttpFoundation\Request $request + * The request object. + * + * @return array + * The render array that results from invoking the controller. + */ + public function getContentResult(Request $request) { + $form_object = $this->getFormObject($request, $this->formDefinition); + + // Add the form and form_state to trick the getArguments method of the + // controller resolver. + $form_state = array(); + $request->attributes->set('form', array()); + $request->attributes->set('form_state', $form_state); + $args = $this->resolver->getArguments($request, array($form_object, 'buildForm')); + $request->attributes->remove('form'); + $request->attributes->remove('form_state'); + + // Remove $form and $form_state from the arguments, and re-index them. + unset($args[0], $args[1]); + $form_state['build_info']['args'] = array_values($args); + + $form_id = $this->formBuilder->getFormId($form_object, $form_state); + return $this->formBuilder->buildForm($form_id, $form_state); + } + + /** + * Returns the object used to build the form. + * + * @param \Symfony\Component\HttpFoundation\Request $request + * The request using this form. + * @param string $form_arg + * Either a class name or a service ID. + * + * @return \Drupal\Core\Form\FormInterface + * The form object to use. + */ + abstract protected function getFormObject(Request $request, $form_arg); + +} diff --git a/core/lib/Drupal/Core/Controller/HtmlControllerBase.php b/core/lib/Drupal/Core/Controller/HtmlControllerBase.php new file mode 100644 index 0000000..bf7be8d --- /dev/null +++ b/core/lib/Drupal/Core/Controller/HtmlControllerBase.php @@ -0,0 +1,87 @@ +translationManager = $translation_manager; + $this->titleResolver = $title_resolver; + } + + /** + * Converts a render array into an HtmlFragment object. + * + * @param array|string $page_content + * The page content area to display. + * @param \Symfony\Component\HttpFoundation\Request $request + * The request object. + * + * @return \Drupal\Core\Page\HtmlPage + * A page object. + */ + protected function createHtmlFragment($page_content, Request $request) { + // Allow controllers to return a HtmlFragment or a Response object directly. + if ($page_content instanceof HtmlFragment || $page_content instanceof Response) { + return $page_content; + } + + if (!is_array($page_content)) { + $page_content = array( + 'main' => array( + '#markup' => $page_content, + ), + ); + } + + $fragment = new HtmlFragment(drupal_render($page_content)); + + // A title defined in the return always wins. + if (isset($page_content['#title'])) { + $fragment->setTitle($page_content['#title'], Title::FILTER_XSS_ADMIN); + } + else if ($route = $request->attributes->get(RouteObjectInterface::ROUTE_OBJECT)) { + $fragment->setTitle($this->titleResolver->getTitle($request, $route), PASS_THROUGH); + } + + return $fragment; + } + +} diff --git a/core/lib/Drupal/Core/Controller/HtmlFormController.php b/core/lib/Drupal/Core/Controller/HtmlFormController.php index db78383..2e92c80 100644 --- a/core/lib/Drupal/Core/Controller/HtmlFormController.php +++ b/core/lib/Drupal/Core/Controller/HtmlFormController.php @@ -2,20 +2,19 @@ /** * @file - * Contains \Drupal\Core\Controller\HtmlFormController. + * Contains \Drupal\Core\Controler\HtmlFormController. */ namespace Drupal\Core\Controller; +use Drupal\Core\Form\FormBuilderInterface; use Symfony\Component\HttpFoundation\Request; -use Symfony\Component\HttpFoundation\Response; -use Symfony\Component\DependencyInjection\ContainerAwareInterface; use Symfony\Component\DependencyInjection\ContainerInterface; /** * Wrapping controller for forms that serve as the main page body. */ -class HtmlFormController implements ContainerAwareInterface { +class HtmlFormController extends FormController { /** * The injection container for this object. @@ -25,48 +24,19 @@ class HtmlFormController implements ContainerAwareInterface { protected $container; /** - * Injects the service container used by this object. + * The name of a class implementing FormInterface that defines a form. * - * @param \Symfony\Component\DependencyInjection\ContainerInterface $container - * The service container this object should use. + * @var string */ - public function setContainer(ContainerInterface $container = NULL) { - $this->container = $container; - } + protected $formClass; /** - * Controller method for generic HTML form pages. - * - * @param \Symfony\Component\HttpFoundation\Request $request - * The request object. - * @param callable $_form - * The name of the form class for this request. - * - * @return \Symfony\Component\HttpFoundation\Response - * A response object. + * Constructs a new \Drupal\Core\Routing\Enhancer\FormEnhancer object. */ - public function content(Request $request, $_form) { - $form_object = $this->getFormObject($request, $_form); - - // Using reflection, find all of the parameters needed by the form in the - // request attributes, skipping $form and $form_state. - - // At the form and form_state to trick the getArguments method of the - // controller resolver. - $form_state = array(); - $request->attributes->set('form', array()); - $request->attributes->set('form_state', $form_state); - $args = $this->container->get('controller_resolver')->getArguments($request, array($form_object, 'buildForm')); - $request->attributes->remove('form'); - $request->attributes->remove('form_state'); - - // Remove $form and $form_state from the arguments, and re-index them. - unset($args[0], $args[1]); - $form_state['build_info']['args'] = array_values($args); - - $form_builder = $this->container->get('form_builder'); - $form_id = $form_builder->getFormId($form_object, $form_state); - return $form_builder->buildForm($form_id, $form_state); + public function __construct(ControllerResolverInterface $resolver, ContainerInterface $container, $class, FormBuilderInterface $form_builder) { + parent::__construct($resolver, $form_builder); + $this->container = $container; + $this->formDefinition = $class; } /** diff --git a/core/lib/Drupal/Core/Controller/HtmlPageController.php b/core/lib/Drupal/Core/Controller/HtmlPageController.php index f3358ad..1672939 100644 --- a/core/lib/Drupal/Core/Controller/HtmlPageController.php +++ b/core/lib/Drupal/Core/Controller/HtmlPageController.php @@ -8,22 +8,12 @@ namespace Drupal\Core\Controller; use Drupal\Core\StringTranslation\TranslationInterface; -use Symfony\Cmf\Component\Routing\RouteObjectInterface; use Symfony\Component\HttpFoundation\Request; -use Symfony\Component\HttpFoundation\Response; -use Symfony\Component\HttpKernel\HttpKernelInterface; /** * Default controller for most HTML pages. */ -class HtmlPageController { - - /** - * The HttpKernel object to use for subrequests. - * - * @var \Symfony\Component\HttpKernel\HttpKernelInterface - */ - protected $httpKernel; +class HtmlPageController extends HtmlControllerBase { /** * The controller resolver. @@ -33,35 +23,19 @@ class HtmlPageController { protected $controllerResolver; /** - * The translation manager service. - * - * @var \Drupal\Core\StringTranslation\TranslationInterface - */ - protected $translationManager; - - /** - * The title resolver. - * - * @var \Drupal\Core\Controller\TitleResolver - */ - protected $titleResolver; - - /** * Constructs a new HtmlPageController. * - * @param \Symfony\Component\HttpKernel\HttpKernelInterface $kernel * @param \Drupal\Core\Controller\ControllerResolverInterface $controller_resolver * The controller resolver. * @param \Drupal\Core\StringTranslation\TranslationInterface $translation_manager * The translation manager. - * @param \Drupal\Core\Controller\TitleResolver $title_resolver + * @param \Drupal\Core\Controller\TitleResolverInterface $title_resolver * The title resolver. */ - public function __construct(HttpKernelInterface $kernel, ControllerResolverInterface $controller_resolver, TranslationInterface $translation_manager, TitleResolver $title_resolver) { - $this->httpKernel = $kernel; + public function __construct(ControllerResolverInterface $controller_resolver, TranslationInterface $translation_manager, TitleResolverInterface $title_resolver) { + parent::__construct($translation_manager, $title_resolver); + $this->controllerResolver = $controller_resolver; - $this->translationManager = $translation_manager; - $this->titleResolver = $title_resolver; } /** @@ -76,38 +50,32 @@ public function __construct(HttpKernelInterface $kernel, ControllerResolverInter * A response object. */ public function content(Request $request, $_content) { - $callable = $this->controllerResolver->getControllerFromDefinition($_content); - $arguments = $this->controllerResolver->getArguments($request, $callable); - $page_content = call_user_func_array($callable, $arguments); - if ($page_content instanceof Response) { - return $page_content; - } - if (!is_array($page_content)) { - $page_content = array( - 'main' => array( - '#markup' => $page_content, - ), - ); - } - if (!isset($page_content['#title'])) { - $title = $this->titleResolver->getTitle($request, $request->attributes->get(RouteObjectInterface::ROUTE_OBJECT)); - // Ensure that #title will not be set if no title was returned. - if (isset($title)) { - $page_content['#title'] = $title; - } - } - - $response = new Response(drupal_render_page($page_content)); - return $response; + $page_content = $this->getContentResult($request, $_content); + return $this->createHtmlFragment($page_content, $request); } /** - * Translates a string to the current language or to a given language. + * Returns the result of invoking the sub-controller. * - * See the t() documentation for details. + * @param \Symfony\Component\HttpFoundation\Request $request + * The request object. + * @param mixed $controller_definition + * A controller definition string, or a callable object/closure. + * + * @return array + * The render array that results from invoking the controller. */ - protected function t($string, array $args = array(), array $options = array()) { - return $this->translationManager->translate($string, $args, $options); + public function getContentResult(Request $request, $controller_definition) { + if ($controller_definition instanceof \Closure) { + $callable = $controller_definition; + } + else { + $callable = $this->controllerResolver->getControllerFromDefinition($controller_definition); + } + $arguments = $this->controllerResolver->getArguments($request, $callable); + $page_content = call_user_func_array($callable, $arguments); + + return $page_content; } } diff --git a/core/lib/Drupal/Core/DependencyInjection/Compiler/RegisterAccessChecksPass.php b/core/lib/Drupal/Core/DependencyInjection/Compiler/RegisterAccessChecksPass.php index 9e6506d..ae66851 100644 --- a/core/lib/Drupal/Core/DependencyInjection/Compiler/RegisterAccessChecksPass.php +++ b/core/lib/Drupal/Core/DependencyInjection/Compiler/RegisterAccessChecksPass.php @@ -26,7 +26,13 @@ public function process(ContainerBuilder $container) { } $access_manager = $container->getDefinition('access_manager'); foreach ($container->findTaggedServiceIds('access_check') as $id => $attributes) { - $access_manager->addMethodCall('addCheckService', array($id)); + $applies = array(); + foreach ($attributes as $attribute) { + if (isset($attribute['applies_to'])) { + $applies[] = $attribute['applies_to']; + } + } + $access_manager->addMethodCall('addCheckService', array($id, $applies)); } } } diff --git a/core/lib/Drupal/Core/Entity/Annotation/EntityType.php b/core/lib/Drupal/Core/Entity/Annotation/EntityType.php index 3dbbb39..4e875df 100644 --- a/core/lib/Drupal/Core/Entity/Annotation/EntityType.php +++ b/core/lib/Drupal/Core/Entity/Annotation/EntityType.php @@ -17,261 +17,33 @@ class EntityType extends Plugin { /** - * The name of the entity type class. + * The class used to represent the entity type. * - * This is not provided manually, it will be added by the discovery mechanism. + * It must implement \Drupal\Core\Entity\EntityTypeInterface. * * @var string */ - public $class; + public $entity_type_class = 'Drupal\Core\Entity\EntityType'; /** - * The name of the entity type's base table. - * - * @todo This is only used by \Drupal\Core\Entity\DatabaseStorageController. - * - * @var string - */ - public $base_table; - - /** - * An associative array where the keys are the names of different controller - * types (listed below) and the values are the names of the classes that - * implement that controller: - * - storage: The name of the class that is used to load the objects. The - * class must implement \Drupal\Core\Entity\EntityStorageControllerInterface. - * - form: An associative array where the keys are the names of the different - * form operations (such as 'create', 'edit', or 'delete') and the values - * are the names of the controller classes for those operations. The name of - * the operation is passed also to the form controller's constructor, so - * that one class can be used for multiple entity forms when the forms are - * similar. The classes must implement - * \Drupal\Core\Entity\EntityFormControllerInterface - * - list: The name of the class that provides listings of the entities. The - * class must implement \Drupal\Core\Entity\EntityListControllerInterface. - * - render: The name of the class that is used to render the entities. The - * class must implement \Drupal\Core\Entity\EntityViewBuilderInterface. - * - access: The name of the class that is used for access checks. The class - * must implement \Drupal\Core\Entity\EntityAccessControllerInterface. - * Defaults to \Drupal\Core\Entity\EntityAccessController. - * - translation: The name of the controller class that should be used to - * handle the translation process. The class must implement - * \Drupal\content_translation\ContentTranslationControllerInterface. - * - * @todo Interfaces from outside \Drupal\Core or \Drupal\Component should not - * be used here. - * - * @var array - */ - public $controllers = array( - 'access' => 'Drupal\Core\Entity\EntityAccessController', - ); - - /** - * The name of the default administrative permission. - * - * The default \Drupal\Core\Entity\EntityAccessController class checks this - * permission for all operations in its checkAccess() method. Entities with - * more complex permissions can extend this class to do their own access - * checks. - * - * @var string (optional) - */ - public $admin_permission; - - /** - * Boolean indicating whether fields can be attached to entities of this type. - * - * @var bool (optional) - */ - public $fieldable = FALSE; - - /** - * Boolean indicating if the persistent cache of field data should be used. - * - * The persistent cache should usually only be disabled if a higher level - * persistent cache is available for the entity type. Defaults to TRUE. - * - * @var bool (optional) - */ - public $field_cache = TRUE; - - /** - * The human-readable name of the type. - * - * @ingroup plugin_translatable - * - * @var \Drupal\Core\Annotation\Translation - */ - public $label; - - /** - * The human-readable name of the entity bundles, e.g. Vocabulary. - * - * @ingroup plugin_translatable - * - * @var \Drupal\Core\Annotation\Translation - */ - public $bundle_label; - - /** - * The name of a function that returns the label of the entity. - * - * The function takes an entity and optional langcode argument, and returns - * the label of the entity. If langcode is omitted, the entity's default - * language is used. The entity label is the main string associated with an - * entity; for example, the title of a node or the subject of a comment. If - * there is an entity object property that defines the label, use the 'label' - * element of the 'entity_keys' return value component to provide this - * information (see below). If more complex logic is needed to determine the - * label of an entity, you can instead specify a callback function here, which - * will be called to determine the entity label. See also the - * \Drupal\Core\Entity\EntityInterface::label() method, which implements this - * logic. - * - * @var string (optional) - */ - public $label_callback; - - /** - * Boolean indicating whether entities should be statically cached during a page request. - * - * @todo This is only used by \Drupal\Core\Entity\DatabaseStorageController. - * - * @var bool (optional) - */ - public $static_cache = TRUE; - - /** - * Boolean indicating whether the rendered output of entities should be - * cached. - * - * @var bool (optional) - */ - public $render_cache = TRUE; - - /** - * Boolean indicating whether entities of this type have multilingual support. - * - * At an entity level, this indicates language support and at a bundle level - * this indicates translation support. - * - * @var bool (optional) - */ - public $translatable = FALSE; - - /** - * @todo content_translation_entity_info_alter() uses this but it is undocumented. + * @todo content_translation_entity_info_alter() uses this but it is + * undocumented. Fix in https://drupal.org/node/1968970. * * @var array */ public $translation = array(); /** - * The name of the entity type for which bundles are provided. - * - * It can be used by other modules to act accordingly; for example, - * the Field UI module uses it to add operation links to manage fields and - * displays. - * - * @var string - */ - public $bundle_of; - - /** - * An array describing how the Field API can extract certain information from - * objects of this entity type: - * - id: The name of the property that contains the primary ID of the entity. - * Every entity object passed to the Field API must have this property and - * its value must be numeric. - * - revision: (optional) The name of the property that contains the revision - * ID of the entity. The Field API assumes that all revision IDs are unique - * across all entities of a type. This entry can be omitted if the entities - * of this type are not versionable. - * - bundle: (optional) The name of the property that contains the bundle name - * for the entity. The bundle name defines which set of fields are attached - * to the entity (e.g. what nodes call "content type"). This entry can be - * omitted if this entity type exposes a single bundle (such that all - * entities have the same collection of fields). The name of this single - * bundle will be the same as the entity type. - * - label: The name of the property that contains the entity label. For - * example, if the entity's label is located in $entity->subject, then - * 'subject' should be specified here. If complex logic is required to build - * the label, a 'label_callback' should be defined instead (see the - * $label_callback block above for details). - * - uuid (optional): The name of the property that contains the universally - * unique identifier of the entity, which is used to distinctly identify an - * entity across different systems. - * - * @var array - */ - public $entity_keys = array( - 'revision' => '', - 'bundle' => '', - ); - - /** - * An array describing how the Field API can extract the information it needs - * from the bundle objects for this type (e.g Vocabulary objects for terms; - * not applicable for nodes): - * - bundle: The name of the property that contains the name of the bundle - * object. - * - * This entry can be omitted if this type's bundles do not exist as standalone - * objects. - * - * @var array + * {@inheritdoc} */ - public $bundle_keys; + public function get() { + $values = $this->definition; - /** - * The name of the entity type which provides bundles. - * - * @var string (optional) - */ - public $bundle_entity_type = 'bundle'; + // Use the specified entity type class, and remove it before instantiating. + $class = $values['entity_type_class']; + unset($values['entity_type_class']); - /** - * Link templates using the URI template syntax. - * - * Links are an array of standard link relations to the URI template that - * should be used for them. Where possible, link relationships should use - * established IANA relationships rather than custom relationships. - * - * Every entity type should, at minimum, define "canonical", which is the - * pattern for URIs to that entity. Even if the entity will have no HTML page - * exposed to users it should still have a canonical URI in order to be - * compatible with web services. Entities that will be user-editable via an - * HTML page must also define an "edit-form" relationship. - * - * By default, the following placeholders are supported: - * - entityType: The machine name of the entity type. - * - bundle: The bundle machine name of the entity. - * - id: The unique ID of the entity. - * - uuid: The UUID of the entity. - * - [entityType]: The entity type itself will also be a valid token for the - * ID of the entity. For instance, a placeholder of {node} used on the Node - * class would have the same value as {id}. This is generally preferred - * over "id" for better self-documentation. - * - * Specific entity types may also expand upon this list by overriding the - * uriPlaceholderReplacements() method. - * - * @link http://www.iana.org/assignments/link-relations/link-relations.xml @endlink - * @link http://tools.ietf.org/html/rfc6570 @endlink - * - * @var array - */ - public $links = array(); - - /** - * Specifies whether a module exposing permissions for the current entity type - * should use entity-type level granularity, bundle level granularity or just - * skip this entity. The allowed values are respectively "entity_type", - * "bundle" or FALSE. - * - * @var string|bool (optional) - */ - public $permission_granularity = 'entity_type'; + return new $class($values); + } } diff --git a/core/lib/Drupal/Core/Entity/ContentEntityBase.php b/core/lib/Drupal/Core/Entity/ContentEntityBase.php index 8bdaed8..7c68f0a 100644 --- a/core/lib/Drupal/Core/Entity/ContentEntityBase.php +++ b/core/lib/Drupal/Core/Entity/ContentEntityBase.php @@ -179,8 +179,7 @@ public function setNewRevision($value = TRUE) { * {@inheritdoc} */ public function isNewRevision() { - $info = $this->entityInfo(); - return $this->newRevision || (!empty($info['entity_keys']['revision']) && !$this->getRevisionId()); + return $this->newRevision || ($this->entityInfo()->hasKey('revision') && !$this->getRevisionId()); } /** @@ -712,7 +711,7 @@ public function addTranslation($langcode, array $values = array()) { // Instantiate a new empty entity so default values will be populated in the // specified language. $info = $this->entityInfo(); - $default_values = array($info['entity_keys']['bundle'] => $this->bundle, 'langcode' => $langcode); + $default_values = array($info->getKey('bundle') => $this->bundle, 'langcode' => $langcode); $entity = \Drupal::entityManager() ->getStorageController($this->entityType()) ->create($default_values); @@ -898,17 +897,17 @@ public function createDuplicate() { $duplicate = clone $this; $entity_info = $this->entityInfo(); - $duplicate->{$entity_info['entity_keys']['id']}->value = NULL; + $duplicate->{$entity_info->getKey('id')}->value = NULL; // Check if the entity type supports UUIDs and generate a new one if so. - if (!empty($entity_info['entity_keys']['uuid'])) { + if ($entity_info->hasKey('uuid')) { // @todo Inject the UUID service into the Entity class once possible. - $duplicate->{$entity_info['entity_keys']['uuid']}->value = \Drupal::service('uuid')->generate(); + $duplicate->{$entity_info->getKey('uuid')}->value = \Drupal::service('uuid')->generate(); } // Check whether the entity type supports revisions and initialize it if so. - if (!empty($entity_info['entity_keys']['revision'])) { - $duplicate->{$entity_info['entity_keys']['revision']}->value = NULL; + if ($entity_info->hasKey('revision')) { + $duplicate->{$entity_info->getKey('revision')}->value = NULL; } return $duplicate; @@ -954,11 +953,12 @@ public function label($langcode = NULL) { if (!isset($langcode)) { $langcode = $this->activeLangcode; } - if (isset($entity_info['label_callback']) && function_exists($entity_info['label_callback'])) { - $label = $entity_info['label_callback']($this, $langcode); + // @todo Convert to is_callable() and call_user_func(). + if (($label_callback = $entity_info->getLabelCallback()) && function_exists($label_callback)) { + $label = $label_callback($this, $langcode); } - elseif (!empty($entity_info['entity_keys']['label']) && isset($this->{$entity_info['entity_keys']['label']})) { - $label = $this->{$entity_info['entity_keys']['label']}->value; + elseif (($label_key = $entity_info->getKey('label')) && isset($this->{$label_key})) { + $label = $this->{$label_key}->value; } return $label; } diff --git a/core/lib/Drupal/Core/Entity/ContentEntityFormController.php b/core/lib/Drupal/Core/Entity/ContentEntityFormController.php index 7f613bc..de83f56 100644 --- a/core/lib/Drupal/Core/Entity/ContentEntityFormController.php +++ b/core/lib/Drupal/Core/Entity/ContentEntityFormController.php @@ -50,8 +50,7 @@ public function form(array $form, array &$form_state) { $entity = $this->entity; // @todo Exploit the Field API to generate the default widgets for the // entity fields. - $info = $entity->entityInfo(); - if (!empty($info['fieldable'])) { + if ($entity->entityInfo()->isFieldable()) { field_attach_form($entity, $form, $form_state, $this->getFormLangcode($form_state)); } @@ -132,14 +131,14 @@ public function isDefaultFormLangcode(array $form_state) { public function buildEntity(array $form, array &$form_state) { $entity = clone $this->entity; $entity_type = $entity->entityType(); - $info = entity_get_info($entity_type); + $info = \Drupal::entityManager()->getDefinition($entity_type); // @todo Exploit the Entity Field API to process the submitted field values. // Copy top-level form values that are entity fields but not handled by // field API without changing existing entity fields that are not being // edited by this form. Values of fields handled by field API are copied // by field_attach_extract_form_values() below. - $values_excluding_fields = $info['fieldable'] ? array_diff_key($form_state['values'], field_info_instances($entity_type, $entity->bundle())) : $form_state['values']; + $values_excluding_fields = $info->isFieldable() ? array_diff_key($form_state['values'], field_info_instances($entity_type, $entity->bundle())) : $form_state['values']; $definitions = $entity->getPropertyDefinitions(); foreach ($values_excluding_fields as $key => $value) { if (isset($definitions[$key])) { @@ -155,7 +154,7 @@ public function buildEntity(array $form, array &$form_state) { } // Invoke field API for copying field values. - if ($info['fieldable']) { + if ($info->isFieldable()) { field_attach_extract_form_values($entity, $form, $form_state, array('langcode' => $this->getFormLangcode($form_state))); } return $entity; diff --git a/core/lib/Drupal/Core/Entity/DatabaseStorageController.php b/core/lib/Drupal/Core/Entity/DatabaseStorageController.php index f258353..bfbdfb4 100644 --- a/core/lib/Drupal/Core/Entity/DatabaseStorageController.php +++ b/core/lib/Drupal/Core/Entity/DatabaseStorageController.php @@ -9,6 +9,7 @@ use Drupal\Component\Uuid\UuidInterface; use Drupal\Core\Database\Connection; +use Drupal\Core\Entity\EntityTypeInterface; use Drupal\Core\Entity\Query\QueryInterface; use Drupal\Core\Language\Language; use Drupal\Component\Utility\NestedArray; @@ -60,9 +61,8 @@ class DatabaseStorageController extends EntityStorageControllerBase { /** * {@inheritdoc} */ - public static function createInstance(ContainerInterface $container, $entity_type, array $entity_info) { + public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_info) { return new static( - $entity_type, $entity_info, $container->get('database'), $container->get('uuid') @@ -72,36 +72,24 @@ public static function createInstance(ContainerInterface $container, $entity_typ /** * Constructs a DatabaseStorageController object. * - * @param string $entity_type - * The entity type for which the instance is created. - * @param array $entity_info - * An array of entity info for the entity type. + * @param \Drupal\Core\Entity\EntityTypeInterface $entity_info + * The entity info for the entity type. * @param \Drupal\Core\Database\Connection $database * The database connection to be used. * @param \Drupal\Component\Uuid\UuidInterface $uuid_service * The UUID service. */ - public function __construct($entity_type, array $entity_info, Connection $database, UuidInterface $uuid_service) { - parent::__construct($entity_type, $entity_info); + public function __construct(EntityTypeInterface $entity_info, Connection $database, UuidInterface $uuid_service) { + parent::__construct($entity_info); $this->database = $database; $this->uuidService = $uuid_service; // Check if the entity type supports IDs. - if (isset($this->entityInfo['entity_keys']['id'])) { - $this->idKey = $this->entityInfo['entity_keys']['id']; - } - else { - $this->idKey = FALSE; - } + $this->idKey = $this->entityInfo->getKey('id'); // Check if the entity type supports UUIDs. - if (!empty($this->entityInfo['entity_keys']['uuid'])) { - $this->uuidKey = $this->entityInfo['entity_keys']['uuid']; - } - else { - $this->uuidKey = FALSE; - } + $this->uuidKey = $this->entityInfo->getKey('uuid'); } /** @@ -133,11 +121,11 @@ public function loadMultiple(array $ids = NULL) { // Build and execute the query. $query_result = $this->buildQuery($ids)->execute(); - if (!empty($this->entityInfo['class'])) { + if ($class = $this->entityInfo->getClass()) { // We provide the necessary arguments for PDO to create objects of the // specified entity class. // @see \Drupal\Core\Entity\EntityInterface::__construct() - $query_result->setFetchMode(\PDO::FETCH_CLASS, $this->entityInfo['class'], array(array(), $this->entityType)); + $query_result->setFetchMode(\PDO::FETCH_CLASS, $class, array(array(), $this->entityType)); } $queried_entities = $query_result->fetchAllAssoc($this->idKey); } @@ -229,12 +217,12 @@ protected function buildPropertyQuery(QueryInterface $entity_query, array $value * A SelectQuery object for loading the entity. */ protected function buildQuery($ids, $revision_id = FALSE) { - $query = $this->database->select($this->entityInfo['base_table'], 'base'); + $query = $this->database->select($this->entityInfo->getBaseTable(), 'base'); $query->addTag($this->entityType . '_load_multiple'); // Add fields from the {entity} table. - $entity_fields = drupal_schema_fields_sql($this->entityInfo['base_table']); + $entity_fields = drupal_schema_fields_sql($this->entityInfo->getBaseTable()); $query->fields('base', $entity_fields); if ($ids) { @@ -248,7 +236,7 @@ protected function buildQuery($ids, $revision_id = FALSE) { * {@inheritdoc} */ public function create(array $values) { - $entity_class = $this->entityInfo['class']; + $entity_class = $this->entityInfo->getClass(); $entity_class::preCreate($this, $values); $entity = new $entity_class($values, $this->entityType); @@ -277,14 +265,14 @@ public function delete(array $entities) { $transaction = $this->database->startTransaction(); try { - $entity_class = $this->entityInfo['class']; + $entity_class = $this->entityInfo->getClass(); $entity_class::preDelete($this, $entities); foreach ($entities as $entity) { $this->invokeHook('predelete', $entity); } $ids = array_keys($entities); - $this->database->delete($this->entityInfo['base_table']) + $this->database->delete($this->entityInfo->getBaseTable()) ->condition($this->idKey, $ids, 'IN') ->execute(); @@ -320,13 +308,13 @@ public function save(EntityInterface $entity) { $this->invokeHook('presave', $entity); if (!$entity->isNew()) { - $return = drupal_write_record($this->entityInfo['base_table'], $entity, $this->idKey); + $return = drupal_write_record($this->entityInfo->getBaseTable(), $entity, $this->idKey); $this->resetCache(array($entity->id())); $entity->postSave($this, TRUE); $this->invokeHook('update', $entity); } else { - $return = drupal_write_record($this->entityInfo['base_table'], $entity); + $return = drupal_write_record($this->entityInfo->getBaseTable(), $entity); // Reset general caches, but keep caches specific to certain entities. $this->resetCache(array()); diff --git a/core/lib/Drupal/Core/Entity/Enhancer/EntityRouteEnhancer.php b/core/lib/Drupal/Core/Entity/Enhancer/EntityRouteEnhancer.php index 2cf8d47..0bbbef8 100644 --- a/core/lib/Drupal/Core/Entity/Enhancer/EntityRouteEnhancer.php +++ b/core/lib/Drupal/Core/Entity/Enhancer/EntityRouteEnhancer.php @@ -7,10 +7,13 @@ namespace Drupal\Core\Entity\Enhancer; +use Drupal\Core\Controller\ControllerResolverInterface; +use Drupal\Core\Entity\EntityManagerInterface; +use Drupal\Core\Entity\HtmlEntityFormController; +use Drupal\Core\Form\FormBuilderInterface; use Symfony\Component\HttpFoundation\Request; use Symfony\Cmf\Component\Routing\Enhancer\RouteEnhancerInterface; use Symfony\Cmf\Component\Routing\RouteObjectInterface; -use Drupal\Core\ContentNegotiation; /** * Enhances an entity form route with the appropriate controller. @@ -18,38 +21,57 @@ class EntityRouteEnhancer implements RouteEnhancerInterface { /** - * Content negotiation library. + * The controller resolver. * - * @var \Drupal\Core\ContentNegotiation + * @var \Drupal\Core\Controller\ControllerResolverInterface */ - protected $negotiation; + protected $resolver; /** - * Constructs a new \Drupal\Core\Entity\Enhancer\EntityRouteEnhancer. + * The entity manager service. * - * @param \Drupal\Core\ContentNegotiation $negotiation - * The content negotiation library. + * @var \Drupal\Core\Entity\EntityManagerInterface */ - public function __construct(ContentNegotiation $negotiation) { - $this->negotiation = $negotiation; + protected $manager; + + /** + * The form builder. + * + * @var \Drupal\Core\Form\FormBuilderInterface + */ + protected $formBuilder; + + /** + * Constructs a new EntityRouteEnhancer object. + * + * @param \Drupal\Core\Controller\ControllerResolverInterface $resolver + * The controller resolver. + * @param \Drupal\Core\Entity\EntityManagerInterface $manager + * The entity manager. + * @param \Drupal\Core\Form\FormBuilderInterface $form_builder + * The form builder. + */ + public function __construct(ControllerResolverInterface $resolver, EntityManagerInterface $manager, FormBuilderInterface $form_builder) { + $this->resolver = $resolver; + $this->manager = $manager; + $this->formBuilder = $form_builder; } /** * {@inheritdoc} */ public function enhance(array $defaults, Request $request) { - if (empty($defaults['_controller']) && $this->negotiation->getContentType($request) === 'html') { + if (empty($defaults['_content'])) { if (!empty($defaults['_entity_form'])) { - $defaults['_controller'] = '\Drupal\Core\Entity\HtmlEntityFormController::content'; + $wrapper = new HtmlEntityFormController($this->resolver, $this->manager, $this->formBuilder, $defaults['_entity_form']); + $defaults['_content'] = array($wrapper, 'getContentResult'); } elseif (!empty($defaults['_entity_list'])) { - $defaults['_controller'] = 'controller.page:content'; $defaults['_content'] = '\Drupal\Core\Entity\Controller\EntityListController::listing'; $defaults['entity_type'] = $defaults['_entity_list']; unset($defaults['_entity_list']); } elseif (!empty($defaults['_entity_view'])) { - $defaults['_controller'] = 'controller.page:content'; $defaults['_content'] = '\Drupal\Core\Entity\Controller\EntityViewController::view'; if (strpos($defaults['_entity_view'], '.') !== FALSE) { // The _entity_view entry is of the form entity_type.view_mode. diff --git a/core/lib/Drupal/Core/Entity/Entity.php b/core/lib/Drupal/Core/Entity/Entity.php index b0b905d..178fe51 100644 --- a/core/lib/Drupal/Core/Entity/Entity.php +++ b/core/lib/Drupal/Core/Entity/Entity.php @@ -109,11 +109,12 @@ public function bundle() { public function label($langcode = NULL) { $label = NULL; $entity_info = $this->entityInfo(); - if (isset($entity_info['label_callback']) && function_exists($entity_info['label_callback'])) { - $label = $entity_info['label_callback']($this, $langcode); + // @todo Convert to is_callable() and call_user_func(). + if (($label_callback = $entity_info->getLabelCallback()) && function_exists($label_callback)) { + $label = $label_callback($this, $langcode); } - elseif (!empty($entity_info['entity_keys']['label']) && isset($this->{$entity_info['entity_keys']['label']})) { - $label = $this->{$entity_info['entity_keys']['label']}; + elseif (($label_key = $entity_info->getKey('label')) && isset($this->{$label_key})) { + $label = $this->{$label_key}; } return $label; } @@ -150,7 +151,7 @@ public function uri($rel = 'canonical') { $entity_info = $this->entityInfo(); // The links array might contain URI templates set in annotations. - $link_templates = isset($entity_info['links']) ? $entity_info['links'] : array(); + $link_templates = $entity_info->getLinkTemplates(); $template = NULL; if (isset($link_templates[$rel])) { @@ -185,12 +186,13 @@ public function uri($rel = 'canonical') { if (isset($bundles[$bundle]['uri_callback'])) { $uri_callback = $bundles[$bundle]['uri_callback']; } - elseif (isset($entity_info['uri_callback'])) { - $uri_callback = $entity_info['uri_callback']; + elseif ($entity_uri_callback = $entity_info->getUriCallback()) { + $uri_callback = $entity_uri_callback; } // Invoke the callback to get the URI. If there is no callback, use the // default URI format. + // @todo Convert to is_callable() and call_user_func(). if (isset($uri_callback) && function_exists($uri_callback)) { $uri = $uri_callback($this); } @@ -243,8 +245,7 @@ protected function uriPlaceholderReplacements() { * An array of link relationships supported by this entity. */ public function uriRelationships() { - $entity_info = $this->entityInfo(); - return isset($entity_info['links']) ? array_keys($entity_info['links']) : array(); + return array_keys($this->entityInfo()->getLinkTemplates()); } @@ -296,12 +297,12 @@ public function delete() { public function createDuplicate() { $duplicate = clone $this; $entity_info = $this->entityInfo(); - $duplicate->{$entity_info['entity_keys']['id']} = NULL; + $duplicate->{$entity_info->getKey('id')} = NULL; // Check if the entity type supports UUIDs and generate a new one if so. - if (!empty($entity_info['entity_keys']['uuid'])) { + if ($entity_info->hasKey('uuid')) { // @todo Inject the UUID service into the Entity class once possible. - $duplicate->{$entity_info['entity_keys']['uuid']} = \Drupal::service('uuid')->generate(); + $duplicate->{$entity_info->getKey('uuid')} = \Drupal::service('uuid')->generate(); } return $duplicate; } diff --git a/core/lib/Drupal/Core/Entity/EntityAccessCheck.php b/core/lib/Drupal/Core/Entity/EntityAccessCheck.php index 06ad0b7..1e3b0ae 100644 --- a/core/lib/Drupal/Core/Entity/EntityAccessCheck.php +++ b/core/lib/Drupal/Core/Entity/EntityAccessCheck.php @@ -7,23 +7,15 @@ namespace Drupal\Core\Entity; -use Drupal\Core\Entity\EntityInterface; +use Drupal\Core\Routing\Access\AccessInterface; use Drupal\Core\Session\AccountInterface; use Symfony\Component\Routing\Route; use Symfony\Component\HttpFoundation\Request; -use Drupal\Core\Access\StaticAccessCheckInterface; /** * Provides a generic access checker for entities. */ -class EntityAccessCheck implements StaticAccessCheckInterface { - - /** - * {@inheritdoc} - */ - public function appliesTo() { - return array('_entity_access'); - } +class EntityAccessCheck implements AccessInterface { /** * Implements \Drupal\Core\Access\AccessCheckInterface::access(). diff --git a/core/lib/Drupal/Core/Entity/EntityAccessController.php b/core/lib/Drupal/Core/Entity/EntityAccessController.php index c747cca..f18cd2c 100644 --- a/core/lib/Drupal/Core/Entity/EntityAccessController.php +++ b/core/lib/Drupal/Core/Entity/EntityAccessController.php @@ -7,6 +7,7 @@ namespace Drupal\Core\Entity; +use Drupal\Core\Entity\EntityTypeInterface; use Drupal\Core\Field\FieldItemListInterface; use Drupal\Core\Extension\ModuleHandlerInterface; use Drupal\Core\Field\FieldDefinitionInterface; @@ -35,7 +36,7 @@ class EntityAccessController implements EntityAccessControllerInterface { /** * The entity info array. * - * @var array + * @var \Drupal\Core\Entity\EntityTypeInterface */ protected $entityInfo; @@ -49,13 +50,11 @@ class EntityAccessController implements EntityAccessControllerInterface { /** * Constructs an access controller instance. * - * @param string $entity_type - * The entity type of the access controller instance. - * @param array $entity_info - * An array of entity info for the entity type. + * @param \Drupal\Core\Entity\EntityTypeInterface $entity_info + * The entity info for the entity type. */ - public function __construct($entity_type, array $entity_info) { - $this->entityType = $entity_type; + public function __construct(EntityTypeInterface $entity_info) { + $this->entityType = $entity_info->id(); $this->entityInfo = $entity_info; } @@ -137,8 +136,8 @@ protected function processAccessHookResults(array $access) { * could not be determined. */ protected function checkAccess(EntityInterface $entity, $operation, $langcode, AccountInterface $account) { - if (!empty($this->entityInfo['admin_permission'])) { - return $account->hasPermission($this->entityInfo['admin_permission']); + if ($admin_permission = $this->entityInfo->getAdminPermission()) { + return $account->hasPermission($admin_permission); } else { return NULL; @@ -258,8 +257,8 @@ public function createAccess($entity_bundle = NULL, AccountInterface $account = * could not be determined. */ protected function checkCreateAccess(AccountInterface $account, array $context, $entity_bundle = NULL) { - if (!empty($this->entityInfo['admin_permission'])) { - return $account->hasPermission($this->entityInfo['admin_permission']); + if ($admin_permission = $this->entityInfo->getAdminPermission()) { + return $account->hasPermission($admin_permission); } else { return NULL; diff --git a/core/lib/Drupal/Core/Entity/EntityControllerInterface.php b/core/lib/Drupal/Core/Entity/EntityControllerInterface.php index 79232c1..cdcffd3 100644 --- a/core/lib/Drupal/Core/Entity/EntityControllerInterface.php +++ b/core/lib/Drupal/Core/Entity/EntityControllerInterface.php @@ -8,6 +8,7 @@ namespace Drupal\Core\Entity; use Drupal\Core\Entity\EntityStorageControllerInterface; +use Drupal\Core\Entity\EntityTypeInterface; use Symfony\Component\DependencyInjection\ContainerInterface; /** @@ -30,14 +31,12 @@ * * @param \Symfony\Component\DependencyInjection\ContainerInterface $container * The service container this object should use. - * @param string $entity_type - * The entity type which the controller handles. - * @param array $entity_info - * An array of entity info for the entity type. + * @param \Drupal\Core\Entity\EntityTypeInterface $entity_info + * The entity info for the entity type. * * @return static * A new instance of the entity controller. */ - public static function createInstance(ContainerInterface $container, $entity_type, array $entity_info); + public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_info); } diff --git a/core/lib/Drupal/Core/Entity/EntityCreateAccessCheck.php b/core/lib/Drupal/Core/Entity/EntityCreateAccessCheck.php index e3268bf..1cf7d87 100644 --- a/core/lib/Drupal/Core/Entity/EntityCreateAccessCheck.php +++ b/core/lib/Drupal/Core/Entity/EntityCreateAccessCheck.php @@ -7,7 +7,7 @@ namespace Drupal\Core\Entity; -use Drupal\Core\Access\StaticAccessCheckInterface; +use Drupal\Core\Routing\Access\AccessInterface; use Drupal\Core\Session\AccountInterface; use Symfony\Component\HttpFoundation\Request; use Symfony\Component\Routing\Route; @@ -15,7 +15,7 @@ /** * Defines an access checker for entity creation. */ -class EntityCreateAccessCheck implements StaticAccessCheckInterface { +class EntityCreateAccessCheck implements AccessInterface { /** * The entity manager. @@ -44,13 +44,6 @@ public function __construct(EntityManagerInterface $entity_manager) { /** * {@inheritdoc} */ - public function appliesTo() { - return array($this->requirementsKey); - } - - /** - * {@inheritdoc} - */ public function access(Route $route, Request $request, AccountInterface $account) { list($entity_type, $bundle) = explode(':', $route->getRequirement($this->requirementsKey) . ':'); diff --git a/core/lib/Drupal/Core/Entity/EntityFormController.php b/core/lib/Drupal/Core/Entity/EntityFormController.php index 8057ca7..2ea0fbe 100644 --- a/core/lib/Drupal/Core/Entity/EntityFormController.php +++ b/core/lib/Drupal/Core/Entity/EntityFormController.php @@ -138,8 +138,7 @@ public function form(array $form, array &$form_state) { $entity = $this->entity; // @todo Exploit the Field API to generate the default widgets for the // entity properties. - $info = $entity->entityInfo(); - if (!empty($info['fieldable'])) { + if ($entity->entityInfo()->isFieldable()) { field_attach_form($entity, $form, $form_state, $this->getFormLangcode($form_state)); } diff --git a/core/lib/Drupal/Core/Entity/EntityInterface.php b/core/lib/Drupal/Core/Entity/EntityInterface.php index bf01326..66ed701 100644 --- a/core/lib/Drupal/Core/Entity/EntityInterface.php +++ b/core/lib/Drupal/Core/Entity/EntityInterface.php @@ -228,7 +228,7 @@ public function createDuplicate(); /** * Returns the info of the type of the entity. * - * @see entity_get_info() + * @return \Drupal\Core\Entity\EntityTypeInterface */ public function entityInfo(); diff --git a/core/lib/Drupal/Core/Entity/EntityListController.php b/core/lib/Drupal/Core/Entity/EntityListController.php index 64c1c43..fdbc6a9 100644 --- a/core/lib/Drupal/Core/Entity/EntityListController.php +++ b/core/lib/Drupal/Core/Entity/EntityListController.php @@ -7,6 +7,7 @@ namespace Drupal\Core\Entity; +use Drupal\Core\Entity\EntityTypeInterface; use Drupal\Core\Extension\ModuleHandlerInterface; use Drupal\Core\StringTranslation\TranslationInterface; use Symfony\Component\DependencyInjection\ContainerInterface; @@ -41,9 +42,7 @@ class EntityListController implements EntityListControllerInterface, EntityContr /** * The entity info array. * - * @var array - * - * @see entity_get_info() + * @var \Drupal\Core\Entity\EntityTypeInterface */ protected $entityInfo; @@ -57,11 +56,10 @@ class EntityListController implements EntityListControllerInterface, EntityContr /** * {@inheritdoc} */ - public static function createInstance(ContainerInterface $container, $entity_type, array $entity_info) { + public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_info) { return new static( - $entity_type, $entity_info, - $container->get('entity.manager')->getStorageController($entity_type), + $container->get('entity.manager')->getStorageController($entity_info->id()), $container->get('module_handler') ); } @@ -69,17 +67,15 @@ public static function createInstance(ContainerInterface $container, $entity_typ /** * Constructs a new EntityListController object. * - * @param string $entity_type - * The type of entity to be listed. - * @param array $entity_info - * An array of entity info for the entity type. + * @param \Drupal\Core\Entity\EntityTypeInterface $entity_info + * The entity info for the entity type. * @param \Drupal\Core\Entity\EntityStorageControllerInterface $storage * The entity storage controller class. * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler * The module handler to invoke hooks on. */ - public function __construct($entity_type, array $entity_info, EntityStorageControllerInterface $storage, ModuleHandlerInterface $module_handler) { - $this->entityType = $entity_type; + public function __construct(EntityTypeInterface $entity_info, EntityStorageControllerInterface $storage, ModuleHandlerInterface $module_handler) { + $this->entityType = $entity_info->id(); $this->storage = $storage; $this->entityInfo = $entity_info; $this->moduleHandler = $module_handler; @@ -204,7 +200,7 @@ public function render() { '#header' => $this->buildHeader(), '#title' => $this->getTitle(), '#rows' => array(), - '#empty' => $this->t('There is no @label yet.', array('@label' => $this->entityInfo['label'])), + '#empty' => $this->t('There is no @label yet.', array('@label' => $this->entityInfo->getLabel())), ); foreach ($this->load() as $entity) { if ($row = $this->buildRow($entity)) { diff --git a/core/lib/Drupal/Core/Entity/EntityManager.php b/core/lib/Drupal/Core/Entity/EntityManager.php index 83a671c..bffc91b 100644 --- a/core/lib/Drupal/Core/Entity/EntityManager.php +++ b/core/lib/Drupal/Core/Entity/EntityManager.php @@ -34,7 +34,7 @@ * * @see \Drupal\Core\Entity\Annotation\EntityType * @see \Drupal\Core\Entity\EntityInterface - * @see entity_get_info() + * @see \Drupal\Core\Entity\EntityTypeInterface * @see hook_entity_info_alter() */ class EntityManager extends PluginManagerBase implements EntityManagerInterface { @@ -160,28 +160,26 @@ public function clearCachedDefinitions() { * {@inheritdoc} */ public function hasController($entity_type, $controller_type) { - $definition = $this->getDefinition($entity_type); - return !empty($definition['controllers'][$controller_type]); + if ($definition = $this->getDefinition($entity_type)) { + return $definition->hasController($controller_type); + } + return FALSE; } /** * {@inheritdoc} */ public function getControllerClass($entity_type, $controller_type, $nested = NULL) { - $definition = $this->getDefinition($entity_type); - if (!$definition) { + $info = $this->getDefinition($entity_type); + if (!$info) { throw new \InvalidArgumentException(sprintf('The %s entity type does not exist.', $entity_type)); } - $definition = $definition['controllers']; - if (!$definition) { - throw new \InvalidArgumentException(sprintf('The entity type (%s) does not exist.', $entity_type)); - } - if (empty($definition[$controller_type])) { + if (!$info->hasController($controller_type)) { throw new \InvalidArgumentException(sprintf('The entity type (%s) did not specify a %s controller.', $entity_type, $controller_type)); } - $class = $definition[$controller_type]; + $class = $info->getController($controller_type); // Some class definitions can be nested. if (isset($nested)) { @@ -213,7 +211,7 @@ public function getListController($entity_type) { if (!isset($this->controllers['listing'][$entity_type])) { $class = $this->getControllerClass($entity_type, 'list'); if (in_array('Drupal\Core\Entity\EntityControllerInterface', class_implements($class))) { - $this->controllers['listing'][$entity_type] = $class::createInstance($this->container, $entity_type, $this->getDefinition($entity_type)); + $this->controllers['listing'][$entity_type] = $class::createInstance($this->container, $this->getDefinition($entity_type)); } else { $this->controllers['listing'][$entity_type] = new $class($entity_type, $this->getStorageController($entity_type)); @@ -277,10 +275,10 @@ protected function getController($entity_type, $controller_type) { if (!isset($this->controllers[$controller_type][$entity_type])) { $class = $this->getControllerClass($entity_type, $controller_type); if (in_array('Drupal\Core\Entity\EntityControllerInterface', class_implements($class))) { - $this->controllers[$controller_type][$entity_type] = $class::createInstance($this->container, $entity_type, $this->getDefinition($entity_type)); + $this->controllers[$controller_type][$entity_type] = $class::createInstance($this->container, $this->getDefinition($entity_type)); } else { - $this->controllers[$controller_type][$entity_type] = new $class($entity_type, $this->getDefinition($entity_type)); + $this->controllers[$controller_type][$entity_type] = new $class($this->getDefinition($entity_type)); } } return $this->controllers[$controller_type][$entity_type]; @@ -302,9 +300,9 @@ public function getAdminPath($entity_type, $bundle) { $admin_path = ''; $entity_info = $this->getDefinition($entity_type); // Check for an entity type's admin base path. - if (isset($entity_info['links']['admin-form'])) { - $route_parameters[$entity_info['bundle_entity_type']] = $bundle; - $admin_path = \Drupal::urlGenerator()->getPathFromRoute($entity_info['links']['admin-form'], $route_parameters); + if ($admin_form = $entity_info->getLinkTemplate('admin-form')) { + $route_parameters[$entity_info->getBundleEntityType()] = $bundle; + $admin_path = \Drupal::urlGenerator()->getPathFromRoute($admin_form, $route_parameters); } return $admin_path; @@ -318,7 +316,7 @@ public function getAdminRouteInfo($entity_type, $bundle) { return array( 'route_name' => "field_ui.overview_$entity_type", 'route_parameters' => array( - $entity_info['bundle_entity_type'] => $bundle, + $entity_info->getBundleEntityType() => $bundle, ) ); } @@ -336,7 +334,9 @@ public function getFieldDefinitions($entity_type, $bundle = NULL) { else { // @todo: Refactor to allow for per-bundle overrides. // See https://drupal.org/node/2114707. - $class = $this->factory->getPluginClass($entity_type, $this->getDefinition($entity_type)); + $entity_info = $this->getDefinition($entity_type); + $definition = array('class' => $entity_info->getClass()); + $class = $this->factory->getPluginClass($entity_type, $definition); $this->entityFieldInfo[$entity_type] = array( 'definitions' => $class::baseFieldDefinitions($entity_type), @@ -367,8 +367,7 @@ public function getFieldDefinitions($entity_type, $bundle = NULL) { $this->moduleHandler->alter($hooks, $this->entityFieldInfo[$entity_type], $entity_type); // Ensure all basic fields are not defined as translatable. - $entity_info = $this->getDefinition($entity_type); - $keys = array_intersect_key(array_filter($entity_info['entity_keys']), array_flip(array('id', 'revision', 'uuid', 'bundle'))); + $keys = array_intersect_key(array_filter($entity_info->getKeys()), array_flip(array('id', 'revision', 'uuid', 'bundle'))); $untranslatable_fields = array_flip(array('langcode') + $keys); foreach (array('definitions', 'optional') as $key) { foreach ($this->entityFieldInfo[$entity_type][$key] as $field_name => &$definition) { @@ -436,7 +435,7 @@ public function getAllBundleInfo() { // If no bundles are provided, use the entity type name and label. foreach ($this->getDefinitions() as $type => $entity_info) { if (!isset($this->bundleInfo[$type])) { - $this->bundleInfo[$type][$type]['label'] = $entity_info['label']; + $this->bundleInfo[$type][$type]['label'] = $entity_info->getLabel(); } } $this->moduleHandler->alter('entity_bundle_info', $this->bundleInfo); @@ -453,7 +452,7 @@ public function getAllBundleInfo() { public function getEntityTypeLabels() { $options = array(); foreach ($this->getDefinitions() as $entity_type => $definition) { - $options[$entity_type] = $definition['label']; + $options[$entity_type] = $definition->getLabel(); } return $options; diff --git a/core/lib/Drupal/Core/Entity/EntityManagerInterface.php b/core/lib/Drupal/Core/Entity/EntityManagerInterface.php index fdc9666..cb962e0 100644 --- a/core/lib/Drupal/Core/Entity/EntityManagerInterface.php +++ b/core/lib/Drupal/Core/Entity/EntityManagerInterface.php @@ -262,4 +262,23 @@ public function getBundleInfo($entity_type); */ public function getTranslationFromContext(EntityInterface $entity, $langcode = NULL, $context = array()); + /** + * Returns the entity type info for a specific entity type. + * + * @param string $entity_type_name + * The name of the entity type. + * + * @return \Drupal\Core\Entity\EntityTypeInterface|null + * Either the entity type object, or NULL if the name does not exist. + */ + public function getDefinition($entity_type_name); + + /** + * Returns an array of entity type info, keyed by entity type name. + * + * @return \Drupal\Core\Entity\EntityTypeInterface[] + * An array of entity type objects. + */ + public function getDefinitions(); + } diff --git a/core/lib/Drupal/Core/Entity/EntityStorageControllerBase.php b/core/lib/Drupal/Core/Entity/EntityStorageControllerBase.php index e9d7fcb..8774ac2 100644 --- a/core/lib/Drupal/Core/Entity/EntityStorageControllerBase.php +++ b/core/lib/Drupal/Core/Entity/EntityStorageControllerBase.php @@ -39,9 +39,7 @@ /** * Array of information about the entity. * - * @var array - * - * @see entity_get_info() + * @var \Drupal\Core\Entity\EntityTypeInterface */ protected $entityInfo; @@ -64,16 +62,14 @@ /** * Constructs an EntityStorageControllerBase instance. * - * @param string $entity_type - * The entity type for which the instance is created. - * @param array $entity_info - * An array of entity info for the entity type. + * @param \Drupal\Core\Entity\EntityTypeInterface $entity_info + * The entity info for the entity type. */ - public function __construct($entity_type, $entity_info) { - $this->entityType = $entity_type; + public function __construct(EntityTypeInterface $entity_info) { + $this->entityType = $entity_info->id(); $this->entityInfo = $entity_info; // Check if the entity type supports static caching of loaded entities. - $this->cache = !empty($this->entityInfo['static_cache']); + $this->cache = $this->entityInfo->isStaticallyCacheable(); } /** @@ -165,7 +161,7 @@ protected function invokeHook($hook, EntityInterface $entity) { * Associative array of query results, keyed on the entity ID. */ protected function postLoad(array &$queried_entities) { - $entity_class = $this->entityInfo['class']; + $entity_class = $this->entityInfo->getClass(); $entity_class::postLoad($this, $queried_entities); // Call hook_entity_load(). foreach (\Drupal::moduleHandler()->getImplementations('entity_load') as $module) { diff --git a/core/lib/Drupal/Core/Entity/EntityType.php b/core/lib/Drupal/Core/Entity/EntityType.php new file mode 100644 index 0000000..1d86e02 --- /dev/null +++ b/core/lib/Drupal/Core/Entity/EntityType.php @@ -0,0 +1,537 @@ + $value) { + $this->{$property} = $value; + } + } + + /** + * {@inheritdoc} + */ + public function get($property) { + return isset($this->{$property}) ? $this->{$property} : NULL; + } + + /** + * {@inheritdoc} + */ + public function set($property, $value) { + $this->{$property} = $value; + return $this; + } + + /** + * {@inheritdoc} + */ + public function isStaticallyCacheable() { + return isset($this->static_cache) ? $this->static_cache: TRUE; + } + + /** + * {@inheritdoc} + */ + public function isRenderCacheable() { + return isset($this->render_cache) ? $this->render_cache: TRUE; + } + + /** + * {@inheritdoc} + */ + public function isFieldDataCacheable() { + return isset($this->field_cache) ? $this->field_cache: TRUE; + } + + /** + * {@inheritdoc} + */ + public function getKeys() { + return $this->entity_keys + array('revision' => '', 'bundle' => ''); + } + + /** + * {@inheritdoc} + */ + public function getKey($key) { + $keys = $this->getKeys(); + return isset($keys[$key]) ? $keys[$key] : FALSE; + } + + /** + * {@inheritdoc} + */ + public function hasKey($key) { + $keys = $this->getKeys(); + return !empty($keys[$key]); + } + + /** + * {@inheritdoc} + */ + public function id() { + return $this->id; + } + + /** + * {@inheritdoc} + */ + public function getProvider() { + return $this->provider; + } + + /** + * {@inheritdoc} + */ + public function getClass() { + return $this->class; + } + + /** + * {@inheritdoc} + */ + public function setClass($class) { + $this->class = $class; + return $this; + } + + /** + * {@inheritdoc} + */ + public function isSubclassOf($class) { + return is_subclass_of($this->getClass(), $class); + } + + /** + * {@inheritdoc} + */ + public function getControllers() { + return $this->controllers + array( + 'access' => 'Drupal\Core\Entity\EntityAccessController', + ); + } + + /** + * {@inheritdoc} + */ + public function getController($controller_type) { + $controllers = $this->getControllers(); + return $controllers[$controller_type]; + } + + /** + * {@inheritdoc} + */ + public function setController($controller_type, $value) { + $this->controllers[$controller_type] = $value; + return $this; + } + + /** + * {@inheritdoc} + */ + public function hasController($controller_type) { + $controllers = $this->getControllers(); + return isset($controllers[$controller_type]); + } + + /** + * {@inheritdoc} + */ + public function setForm($operation, $class) { + $this->controllers['form'][$operation] = $class; + return $this; + } + + /** + * {@inheritdoc} + */ + public function setList($class) { + $this->controllers['list'] = $class; + return $this; + } + + /** + * {@inheritdoc} + */ + public function getAdminPermission() { + return $this->admin_permission ?: FALSE; + } + + /** + * {@inheritdoc} + */ + public function getPermissionGranularity() { + return isset($this->permission_granularity) ? $this->permission_granularity : 'entity_type'; + } + + /** + * {@inheritdoc} + */ + public function getBundleKeys() { + return isset($this->bundle_keys) ? $this->bundle_keys : array(); + } + + /** + * {@inheritdoc} + */ + public function getBundleKey($name) { + return isset($this->bundle_keys[$name]) ? $this->bundle_keys[$name] : FALSE; + } + + /** + * {@inheritdoc} + */ + public function isFieldable() { + return isset($this->fieldable) ? $this->fieldable : FALSE; + } + + /** + * {@inheritdoc} + */ + public function getLinkTemplates() { + return isset($this->links) ? $this->links : array(); + } + + /** + * {@inheritdoc} + */ + public function getLinkTemplate($key) { + $links = $this->getLinkTemplates(); + return isset($links[$key]) ? $links[$key] : FALSE; + } + + /** + * {@inheritdoc} + */ + public function hasLinkTemplate($key) { + $links = $this->getLinkTemplates(); + return isset($links[$key]); + } + + /** + * {@inheritdoc} + */ + public function setLinkTemplate($key, $route_name) { + $this->links[$key] = $route_name; + return $this; + } + + /** + * {@inheritdoc} + */ + public function getLabelCallback() { + return isset($this->label_callback) ? $this->label_callback : FALSE; + } + + /** + * {@inheritdoc} + */ + public function setLabelCallback($callback) { + $this->label_callback = $callback; + return $this; + } + + /** + * {@inheritdoc} + */ + public function hasLabelCallback() { + return isset($this->label_callback); + } + + /** + * {@inheritdoc} + */ + public function getBundleEntityType() { + return isset($this->bundle_entity_type) ? $this->bundle_entity_type : 'bundle'; + } + + /** + * {@inheritdoc} + */ + public function getBundleOf() { + return isset($this->bundle_of) ? $this->bundle_of : FALSE; + } + + /** + * {@inheritdoc} + */ + public function getBundleLabel() { + return isset($this->bundle_label) ? $this->bundle_label : FALSE; + } + + /** + * {@inheritdoc} + */ + public function getBaseTable() { + return isset($this->base_table) ? $this->base_table : FALSE; + } + + /** + * {@inheritdoc} + */ + public function isTranslatable() { + return !empty($this->translatable); + } + + /** + * {@inheritdoc} + */ + public function getConfigPrefix() { + return isset($this->config_prefix) ? $this->config_prefix : FALSE; + } + + /** + * {@inheritdoc} + */ + public function getRevisionDataTable() { + return isset($this->revision_data_table) ? $this->revision_data_table : FALSE; + } + + /** + * {@inheritdoc} + */ + public function getRevisionTable() { + return isset($this->revision_table) ? $this->revision_table : FALSE; + } + + /** + * {@inheritdoc} + */ + public function getDataTable() { + return isset($this->data_table) ? $this->data_table : FALSE; + } + + /** + * {@inheritdoc} + */ + public function getLabel() { + return isset($this->label) ? $this->label : ''; + } + + /** + * {@inheritdoc} + */ + public function getLowercaseLabel() { + return Unicode::strtolower($this->getLabel()); + } + + /** + * {@inheritdoc} + */ + public function getUriCallback() { + return isset($this->uri_callback) ? $this->uri_callback : FALSE; + } + + /** + * {@inheritdoc} + */ + public function setUriCallback($callback) { + $this->uri_callback = $callback; + return $this; + } + +} diff --git a/core/lib/Drupal/Core/Entity/EntityTypeInterface.php b/core/lib/Drupal/Core/Entity/EntityTypeInterface.php new file mode 100644 index 0000000..9a121d3 --- /dev/null +++ b/core/lib/Drupal/Core/Entity/EntityTypeInterface.php @@ -0,0 +1,531 @@ +subject, then + * 'subject' should be specified here. If complex logic is required to + * build the label, a 'label_callback' should be defined instead (see the + * $label_callback block above for details). + * - uuid (optional): The name of the property that contains the universally + * unique identifier of the entity, which is used to distinctly identify + * an entity across different systems. + */ + public function getKeys(); + + /** + * Returns a specific entity key. + * + * @param string $key + * The name of the entity key to return. + * + * @return string|bool + * The entity key, or FALSE if it does not exist. + * + * @see self::getKeys() + */ + public function getKey($key); + + /** + * Indicates if a given entity key exists. + * + * @param string $key + * The name of the entity key to check. + * + * @return bool + * TRUE if a given entity key exists, FALSE otherwise. + */ + public function hasKey($key); + + /** + * Indicates whether entities should be statically cached. + * + * @return bool + * TRUE if static caching should be used; FALSE otherwise. + */ + public function isStaticallyCacheable(); + + /** + * Indicates whether the rendered output of entities should be cached. + * + * @return bool + */ + public function isRenderCacheable(); + + /** + * Indicates if the persistent cache of field data should be used. + * + * @todo Used by FieldableEntityStorageControllerBase only. + * + * The persistent cache should usually only be disabled if a higher level + * persistent cache is available for the entity type. + * + * @return bool + */ + public function isFieldDataCacheable(); + + /** + * Sets the name of the entity type class. + * + * @param string $class + * The name of the entity type class. + * + * @return static + */ + public function setClass($class); + + /** + * Determines if there is a controller for a given type. + * + * @param string $controller_type + * The type of controller to check. + * + * @return bool + * TRUE if a controller of this type exists, FALSE otherwise. + */ + public function hasController($controller_type); + + /** + * @param string $controller_type + * The controller type to get. + * + * @return array|string + * The controllers for a given type. + */ + public function getController($controller_type); + + /** + * Returns an array of controllers. + * + * @return array + * An associative array where the keys are the names of different controller + * types (listed below) and the values are the names of the classes that + * implement that controller: + * - storage: The name of the class used to load the objects. The class must + * implement \Drupal\Core\Entity\EntityStorageControllerInterface. + * - form: An associative array where the keys are the names of the + * different form operations (such as 'create', 'edit', or 'delete') and + * the values are the names of the controller classes for those + * operations. The name of the operation is passed also to the form + * controller's constructor, so that one class can be used for multiple + * entity forms when the forms are similar. The classes must implement + * \Drupal\Core\Entity\EntityFormControllerInterface. + * - list: The name of the class that provides listings of the entities. The + * class must implement \Drupal\Core\Entity\EntityListControllerInterface. + * - render: The name of the class that is used to render the entities. The + * class must implement \Drupal\Core\Entity\EntityViewBuilderInterface. + * - access: The name of the class that is used for access checks. The class + * must implement \Drupal\Core\Entity\EntityAccessControllerInterface. + * Defaults to \Drupal\Core\Entity\EntityAccessController. + * - translation: The name of the controller class that should be used to + * handle the translation process. The class must implement + * \Drupal\content_translation\ContentTranslationControllerInterface. + */ + public function getControllers(); + + /** + * Sets a form class for a specific operation. + * + * @param string $operation + * The operation to use this form class for. + * @param string $class + * The form class to use for the operation. + * + * @return static + */ + public function setForm($operation, $class); + + /** + * Sets the listing class. + * + * @param string $class + * The list class to use for the operation. + * + * @return static + */ + public function setList($class); + + /** + * Indicates if the entity type is a subclass of the given class or interface. + * + * @param string $class + * The class or interface to check. + * + * @return bool + * TRUE if the entity type is a subclass of the class or interface. + */ + public function isSubclassOf($class); + + /** + * Sets the controllers for a given type. + * + * @param string $controller_type + * The type of controller to set. + * @param array|string $value + * The value for a controller type. + * + * @return static + */ + public function setController($controller_type, $value); + + /** + * Returns the name of the default administrative permission. + * + * The default \Drupal\Core\Entity\EntityAccessController class checks this + * permission for all operations in its checkAccess() method. Entities with + * more complex permissions can extend this class to do their own access + * checks. + * + * @return string|bool + */ + public function getAdminPermission(); + + /** + * Returns the permission granularity level. + * + * The allowed values are respectively "entity_type", "bundle" or FALSE. + * + * @return string|bool + * Whether a module exposing permissions for the current entity type + * should use entity-type level granularity, bundle level granularity or + * just skip this entity. + */ + public function getPermissionGranularity(); + + /** + * Get all bundle keys defined on the annotation. + * + * @return array + * An array describing how the Field API can extract the information it + * needs from the bundle objects for this type (e.g Vocabulary objects for + * terms; not applicable for nodes): + * - bundle: The name of the property that contains the name of the bundle + * object. + */ + public function getBundleKeys(); + + /** + * Returns a single bundle key. + * + * @param string $name + * The name of the bundle key. + * + * @return string|bool + * The value of the bundle key. + */ + public function getBundleKey($name); + + /** + * Indicates whether fields can be attached to entities of this type. + * + * @return bool + * Returns TRUE if the entity type can has fields, otherwise FALSE. + */ + public function isFieldable(); + + /** + * Returns link templates using the URI template syntax. + * + * Links are an array of standard link relations to the URI template that + * should be used for them. Where possible, link relationships should use + * established IANA relationships rather than custom relationships. + * + * Every entity type should, at minimum, define "canonical", which is the + * pattern for URIs to that entity. Even if the entity will have no HTML page + * exposed to users it should still have a canonical URI in order to be + * compatible with web services. Entities that will be user-editable via an + * HTML page must also define an "edit-form" relationship. + * + * By default, the following placeholders are supported: + * - entityType: The machine name of the entity type. + * - bundle: The bundle machine name of the entity. + * - id: The unique ID of the entity. + * - uuid: The UUID of the entity. + * - [entityType]: The entity type itself will also be a valid token for the + * ID of the entity. For instance, a placeholder of {node} used on the Node + * class would have the same value as {id}. This is generally preferred + * over "id" for better self-documentation. + * + * Specific entity types may also expand upon this list by overriding the + * Entity::uriPlaceholderReplacements() method. + * + * @link http://www.iana.org/assignments/link-relations/link-relations.xml @endlink + * @link http://tools.ietf.org/html/rfc6570 @endlink + * + * @return array + */ + public function getLinkTemplates(); + + /** + * Returns the link template for a given key. + * + * @param string $key + * The link type. + * + * @return string|bool + * The route name for this link, or FALSE if it doesn't exist. + */ + public function getLinkTemplate($key); + + /** + * Indicates if a link template exists for a given key. + * + * @param string $key + * The link type. + * + * @return bool + * TRUE if the link template exists, FALSE otherwise. + */ + public function hasLinkTemplate($key); + + /** + * Sets a single link template. + * + * @param string $key + * The name of a link. + * @param string $route_name + * The route name to use for the link. + * + * @return static + */ + public function setLinkTemplate($key, $route_name); + + /** + * Gets the callback for the label of the entity. + * + * The function takes an entity and optional langcode argument, and returns + * the label of the entity. If langcode is omitted, the entity's default + * language is used. The entity label is the main string associated with an + * entity; for example, the title of a node or the subject of a comment. If + * there is an entity object property that defines the label, use the 'label' + * element of the 'entity_keys' return value component to provide this + * information (see below). If more complex logic is needed to determine the + * label of an entity, you can instead specify a callback function here, which + * will be called to determine the entity label. See also the + * \Drupal\Core\Entity\EntityInterface::label() method, which implements this + * logic. + * + * @return callable|bool + * The callback, or FALSE if none exists. + */ + public function getLabelCallback(); + + /** + * Sets the label callback. + * + * @param callable $callback + * A callable that returns the label of the entity. + * + * @return static + */ + public function setLabelCallback($callback); + + /** + * Indicates if a label callback exists. + * + * @return bool + */ + public function hasLabelCallback(); + + /** + * Returns the name of the entity type which provides bundles. + * + * @return string + */ + public function getBundleEntityType(); + + /** + * Returns the entity type for which this entity provides bundles. + * + * It can be used by other modules to act accordingly; for example, + * the Field UI module uses it to add operation links to manage fields and + * displays. + * + * @return string|bool + * The entity type for which this entity provides bundles, or FALSE if does + * not provide bundles for another entity type. + */ + public function getBundleOf(); + + /** + * Returns the label for the bundle. + * + * @return string|bool + * The bundle label, or FALSE if none exists. + */ + public function getBundleLabel(); + + /** + * Returns the name of the entity's base table. + * + * @todo Used by DatabaseStorageController only. + * + * @return string|bool + * The name of the entity's base table, or FALSE if none exists. + */ + public function getBaseTable(); + + /** + * Indicates whether entities of this type have multilingual support. + * + * At an entity level, this indicates language support and at a bundle level + * this indicates translation support. + * + * @return bool + */ + public function isTranslatable(); + + /** + * Returns the config prefix used by the configuration entity type. + * + * @todo Used for configuration entities only. + * + * @return string|bool + * The config prefix, or FALSE if not a configuration entity type. + */ + public function getConfigPrefix(); + + /** + * Returns the name of the entity's revision data table. + * + * @todo Used by FieldableDatabaseStorageController only. + * + * @return string|bool + * The name of the entity type's revision data table. + */ + public function getRevisionDataTable(); + + /** + * Returns the name of the entity's revision table. + * + * @todo Used by FieldableDatabaseStorageController only. + * + * @return string|bool + * The name of the entity type's revision table. + */ + public function getRevisionTable(); + + /** + * Returns the name of the entity's data table. + * + * @todo Used by FieldableDatabaseStorageController only. + * + * @return string|bool + * The name of the entity type's data table. + */ + public function getDataTable(); + + /** + * Returns the human-readable name of the entity type. + * + * @return string + * The human-readable name of the entity type. + */ + public function getLabel(); + + /** + * Returns the lowercase form of the human-readable entity type name. + * + * @return string + * The lowercase form of the human-readable entity type name. + */ + public function getLowercaseLabel(); + + /** + * Returns a callable that can be used to provide the entity URI. + * + * This is only called if there is no matching link template for the link + * relationship type, and there is no bundle-specific callback provided. + * + * @return callable|bool + * A valid callback that is passed the entity or FALSE if none is specified. + */ + public function getUriCallback(); + + /** + * Sets a callable to use to provide the entity URI. + * + * @param callable $callback + * A callback to use to provide a URI for the entity. + * + * @return static + */ + public function setUriCallback($callback); + +} diff --git a/core/lib/Drupal/Core/Entity/EntityViewBuilder.php b/core/lib/Drupal/Core/Entity/EntityViewBuilder.php index c2db6b0..d886224 100644 --- a/core/lib/Drupal/Core/Entity/EntityViewBuilder.php +++ b/core/lib/Drupal/Core/Entity/EntityViewBuilder.php @@ -26,9 +26,7 @@ class EntityViewBuilder implements EntityControllerInterface, EntityViewBuilderI /** * The entity info array. * - * @var array - * - * @see entity_get_info() + * @var \Drupal\Core\Entity\EntityTypeInterface */ protected $entityInfo; @@ -60,25 +58,26 @@ class EntityViewBuilder implements EntityControllerInterface, EntityViewBuilderI /** * Constructs a new EntityViewBuilder. * - * @param string $entity_type - * The entity type. - * @param array $entity_info + * @param \Drupal\Core\Entity\EntityTypeInterface $entity_info * The entity information array. - * @param \Drupal\Core\Entity\EntityManager $entity_manager + * @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager * The entity manager service. */ - public function __construct($entity_type, array $entity_info, EntityManager $entity_manager) { - $this->entityType = $entity_type; + public function __construct(EntityTypeInterface $entity_info, EntityManagerInterface $entity_manager) { + $this->entityType = $entity_info->id(); $this->entityInfo = $entity_info; $this->entityManager = $entity_manager; - $this->viewModesInfo = entity_get_view_modes($entity_type); + $this->viewModesInfo = entity_get_view_modes($this->entityType); } /** * {@inheritdoc} */ - public static function createInstance(ContainerInterface $container, $entity_type, array $entity_info) { - return new static($entity_type, $entity_info, $container->get('entity.manager')); + public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_info) { + return new static( + $entity_info, + $container->get('entity.manager') + ); } /** @@ -140,7 +139,7 @@ protected function getBuildDefaults(EntityInterface $entity, $view_mode, $langco // type configuration. The isset() checks below are necessary because // 'default' is not an actual view mode. $view_mode_is_cacheable = !isset($this->viewModesInfo[$view_mode]) || (isset($this->viewModesInfo[$view_mode]) && $this->viewModesInfo[$view_mode]['cache']); - if ($view_mode_is_cacheable && !$entity->isNew() && !isset($entity->in_preview) && $this->entityInfo['render_cache']) { + if ($view_mode_is_cacheable && !$entity->isNew() && !isset($entity->in_preview) && $this->entityInfo->isRenderCacheable()) { $return['#cache'] = array( 'keys' => array('entity_view', $this->entityType, $entity->id(), $view_mode), 'granularity' => DRUPAL_CACHE_PER_ROLE, diff --git a/core/lib/Drupal/Core/Entity/FieldableDatabaseStorageController.php b/core/lib/Drupal/Core/Entity/FieldableDatabaseStorageController.php index c78453c..cb8b4cb 100644 --- a/core/lib/Drupal/Core/Entity/FieldableDatabaseStorageController.php +++ b/core/lib/Drupal/Core/Entity/FieldableDatabaseStorageController.php @@ -8,6 +8,7 @@ namespace Drupal\Core\Entity; use Drupal\Core\Database\Connection; +use Drupal\Core\Entity\EntityTypeInterface; use Drupal\Core\Entity\Query\QueryInterface; use Drupal\Core\Language\Language; use Drupal\Component\Utility\NestedArray; @@ -99,9 +100,8 @@ class FieldableDatabaseStorageController extends FieldableEntityStorageControlle /** * {@inheritdoc} */ - public static function createInstance(ContainerInterface $container, $entity_type, array $entity_info) { + public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_info) { return new static( - $entity_type, $entity_info, $container->get('database'), $container->get('field.info') @@ -111,49 +111,42 @@ public static function createInstance(ContainerInterface $container, $entity_typ /** * Constructs a DatabaseStorageController object. * - * @param string $entity_type - * The entity type for which the instance is created. - * @param array $entity_info - * An array of entity info for the entity type. + * @param \Drupal\Core\Entity\EntityTypeInterface $entity_info + * The entity info for the entity type. * @param \Drupal\Core\Database\Connection $database * The database connection to be used. * @param \Drupal\field\FieldInfo $field_info * The field info service. */ - public function __construct($entity_type, array $entity_info, Connection $database, FieldInfo $field_info) { - parent::__construct($entity_type, $entity_info); + public function __construct(EntityTypeInterface $entity_info, Connection $database, FieldInfo $field_info) { + parent::__construct($entity_info); $this->database = $database; $this->fieldInfo = $field_info; - $this->bundleKey = !empty($this->entityInfo['entity_keys']['bundle']) ? $this->entityInfo['entity_keys']['bundle'] : FALSE; - $this->entityClass = $this->entityInfo['class']; + $this->bundleKey = $this->entityInfo->getKey('bundle'); + $this->entityClass = $this->entityInfo->getClass(); // Check if the entity type supports IDs. - if (isset($this->entityInfo['entity_keys']['id'])) { - $this->idKey = $this->entityInfo['entity_keys']['id']; + if ($this->entityInfo->hasKey('id')) { + $this->idKey = $this->entityInfo->getKey('id'); } // Check if the entity type supports UUIDs. - if (!empty($this->entityInfo['entity_keys']['uuid'])) { - $this->uuidKey = $this->entityInfo['entity_keys']['uuid']; - } - else { - $this->uuidKey = FALSE; - } + $this->uuidKey = $this->entityInfo->getKey('uuid'); // Check if the entity type supports revisions. - if (!empty($this->entityInfo['entity_keys']['revision'])) { - $this->revisionKey = $this->entityInfo['entity_keys']['revision']; - $this->revisionTable = $this->entityInfo['revision_table']; + if ($this->entityInfo->hasKey('revision')) { + $this->revisionKey = $this->entityInfo->getKey('revision'); + $this->revisionTable = $this->entityInfo->getRevisionTable(); } // Check if the entity type has a dedicated table for fields. - if (!empty($this->entityInfo['data_table'])) { - $this->dataTable = $this->entityInfo['data_table']; + if ($data_table = $this->entityInfo->getDataTable()) { + $this->dataTable = $data_table; // Entity types having both revision and translation support should always // define a revision data table. - if ($this->revisionTable && !empty($this->entityInfo['revision_data_table'])) { - $this->revisionDataTable = $this->entityInfo['revision_data_table']; + if ($this->revisionTable && $revision_data_table = $this->entityInfo->getRevisionDataTable()) { + $this->revisionDataTable = $revision_data_table; } } } @@ -336,10 +329,10 @@ protected function attachPropertyData(array &$entities) { $field_definitions = \Drupal::entityManager()->getFieldDefinitions($this->entityType); $translations = array(); if ($this->revisionDataTable) { - $data_column_names = array_flip(array_diff(drupal_schema_fields_sql($this->entityInfo['revision_data_table']), drupal_schema_fields_sql($this->entityInfo['base_table']))); + $data_column_names = array_flip(array_diff(drupal_schema_fields_sql($this->entityInfo->getRevisionDataTable()), drupal_schema_fields_sql($this->entityInfo->getBaseTable()))); } else { - $data_column_names = array_flip(drupal_schema_fields_sql($this->entityInfo['data_table'])); + $data_column_names = array_flip(drupal_schema_fields_sql($this->entityInfo->getDataTable())); } foreach ($data as $values) { @@ -459,7 +452,7 @@ protected function buildPropertyQuery(QueryInterface $entity_query, array $value * A SelectQuery object for loading the entity. */ protected function buildQuery($ids, $revision_id = FALSE) { - $query = $this->database->select($this->entityInfo['base_table'], 'base'); + $query = $this->database->select($this->entityInfo->getBaseTable(), 'base'); $query->addTag($this->entityType . '_load_multiple'); @@ -471,11 +464,11 @@ protected function buildQuery($ids, $revision_id = FALSE) { } // Add fields from the {entity} table. - $entity_fields = drupal_schema_fields_sql($this->entityInfo['base_table']); + $entity_fields = drupal_schema_fields_sql($this->entityInfo->getBaseTable()); if ($this->revisionTable) { // Add all fields from the {entity_revision} table. - $entity_revision_fields = drupal_map_assoc(drupal_schema_fields_sql($this->entityInfo['revision_table'])); + $entity_revision_fields = drupal_map_assoc(drupal_schema_fields_sql($this->entityInfo->getRevisionTable())); // The ID field is provided by entity, so remove it. unset($entity_revision_fields[$this->idKey]); @@ -522,7 +515,7 @@ protected function postLoad(array &$queried_entities) { $queried_entities = $this->mapFromStorageRecords($queried_entities); // Attach field values. - if ($this->entityInfo['fieldable']) { + if ($this->entityInfo->isFieldable()) { $this->loadFieldItems($queried_entities); } @@ -548,7 +541,7 @@ public function delete(array $entities) { } $ids = array_keys($entities); - $this->database->delete($this->entityInfo['base_table']) + $this->database->delete($this->entityInfo->getBaseTable()) ->condition($this->idKey, $ids) ->execute(); @@ -615,7 +608,7 @@ public function save(EntityInterface $entity) { if (!$entity->isNew()) { if ($entity->isDefaultRevision()) { - $return = drupal_write_record($this->entityInfo['base_table'], $record, $this->idKey); + $return = drupal_write_record($this->entityInfo->getBaseTable(), $record, $this->idKey); } else { // @todo, should a different value be returned when saving an entity @@ -645,7 +638,7 @@ public function save(EntityInterface $entity) { // Ensure the entity is still seen as new after assigning it an id, // while storing its data. $entity->enforceIsNew(); - $return = drupal_write_record($this->entityInfo['base_table'], $record); + $return = drupal_write_record($this->entityInfo->getBaseTable(), $record); $entity->{$this->idKey}->value = (string) $record->{$this->idKey}; if ($this->revisionTable) { $entity->setNewRevision(); @@ -691,7 +684,7 @@ public function save(EntityInterface $entity) { * 'data_table'. */ protected function savePropertyData(EntityInterface $entity, $table_key = 'data_table') { - $table_name = $this->entityInfo[$table_key]; + $table_name = $this->entityInfo->get($table_key); $revision = $table_key != 'data_table'; if (!$revision || !$entity->isNewRevision()) { @@ -733,11 +726,11 @@ protected function mapToStorageRecord(EntityInterface $entity, $table_key = 'bas $record = new \stdClass(); $values = array(); $definitions = $entity->getPropertyDefinitions(); - $schema = drupal_get_schema($this->entityInfo[$table_key]); + $schema = drupal_get_schema($this->entityInfo->get($table_key)); $is_new = $entity->isNew(); $multi_column_fields = array(); - foreach (drupal_schema_fields_sql($this->entityInfo[$table_key]) as $name) { + foreach (drupal_schema_fields_sql($this->entityInfo->get($table_key)) as $name) { // Check for fields which store data in multiple columns and process them // separately. if ($field = strstr($name, '__', TRUE)) { @@ -814,7 +807,7 @@ protected function saveRevision(EntityInterface $entity) { if ($entity->isNewRevision()) { drupal_write_record($this->revisionTable, $record); if ($entity->isDefaultRevision()) { - $this->database->update($this->entityInfo['base_table']) + $this->database->update($this->entityInfo->getBaseTable()) ->fields(array($this->revisionKey => $record->{$this->revisionKey})) ->condition($this->idKey, $record->{$this->idKey}) ->execute(); diff --git a/core/lib/Drupal/Core/Entity/FieldableEntityStorageControllerBase.php b/core/lib/Drupal/Core/Entity/FieldableEntityStorageControllerBase.php index d30c972..9aa3a63 100644 --- a/core/lib/Drupal/Core/Entity/FieldableEntityStorageControllerBase.php +++ b/core/lib/Drupal/Core/Entity/FieldableEntityStorageControllerBase.php @@ -44,8 +44,7 @@ protected function loadFieldItems(array $entities) { // Only the most current revision of non-deleted fields for cacheable entity // types can be cached. $load_current = $age == static::FIELD_LOAD_CURRENT; - $info = entity_get_info($this->entityType); - $use_cache = $load_current && $info['field_cache']; + $use_cache = $load_current && $this->entityInfo->isFieldDataCacheable(); // Assume all entities will need to be queried. Entities found in the cache // will be removed from the list. @@ -130,7 +129,7 @@ protected function saveFieldItems(EntityInterface $entity, $update = TRUE) { if ($update) { $entity_info = $entity->entityInfo(); - if ($entity_info['field_cache']) { + if ($entity_info->isFieldDataCacheable()) { cache('field')->delete('field:' . $entity->entityType() . ':' . $entity->id()); } } @@ -150,7 +149,7 @@ protected function deleteFieldItems(EntityInterface $entity) { $this->doDeleteFieldItems($entity); $entity_info = $entity->entityInfo(); - if ($entity_info['field_cache']) { + if ($entity_info->isFieldDataCacheable()) { cache('field')->delete('field:' . $entity->entityType() . ':' . $entity->id()); } } diff --git a/core/lib/Drupal/Core/Entity/HtmlEntityFormController.php b/core/lib/Drupal/Core/Entity/HtmlEntityFormController.php index 4aa7925..44a0bf3 100644 --- a/core/lib/Drupal/Core/Entity/HtmlEntityFormController.php +++ b/core/lib/Drupal/Core/Entity/HtmlEntityFormController.php @@ -7,22 +7,39 @@ namespace Drupal\Core\Entity; -use Drupal\Core\Controller\HtmlFormController; +use Drupal\Core\Controller\ControllerResolverInterface; +use Drupal\Core\Controller\FormController; +use Drupal\Core\Form\FormBuilderInterface; use Symfony\Component\HttpFoundation\Request; /** * Wrapping controller for entity forms that serve as the main page body. */ -class HtmlEntityFormController extends HtmlFormController { +class HtmlEntityFormController extends FormController { /** - * {@inheritdoc} + * The entity manager service. + * + * @var \Drupal\Core\Entity\EntityManagerInterface + */ + protected $manager; + + /** + * Constructs a new \Drupal\Core\Routing\Enhancer\FormEnhancer object. * - * Due to reflection, the argument must be named $_entity_form. The parent - * method has $request and $_form, but the parameter must match the route. + * @param \Drupal\Core\Controller\ControllerResolverInterface $resolver + * The controller resolver. + * @param \Drupal\Core\Entity\EntityManagerInterface $manager + * The entity manager. + * @param \Drupal\Core\Form\FormBuilderInterface $form_builder + * The form builder. + * @param string $form_definition + * The definition of this form, usually found in $defaults['_entity_form']. */ - public function content(Request $request, $_entity_form) { - return parent::content($request, $_entity_form); + public function __construct(ControllerResolverInterface $resolver, EntityManagerInterface $manager, FormBuilderInterface $form_builder, $form_definition) { + parent::__construct($resolver, $form_builder); + $this->manager = $manager; + $this->formDefinition = $form_definition; } /** @@ -46,8 +63,6 @@ public function content(Request $request, $_entity_form) { * @endcode */ protected function getFormObject(Request $request, $form_arg) { - $manager = $this->container->get('entity.manager'); - // If no operation is provided, use 'default'. $form_arg .= '.default'; list ($entity_type, $operation) = explode('.', $form_arg); @@ -56,10 +71,10 @@ protected function getFormObject(Request $request, $form_arg) { $entity = $request->attributes->get($entity_type); } else { - $entity = $manager->getStorageController($entity_type)->create(array()); + $entity = $this->manager->getStorageController($entity_type)->create(array()); } - return $manager->getFormController($entity_type, $operation)->setEntity($entity); + return $this->manager->getFormController($entity_type, $operation)->setEntity($entity); } } diff --git a/core/lib/Drupal/Core/Entity/Plugin/DataType/Deriver/EntityDeriver.php b/core/lib/Drupal/Core/Entity/Plugin/DataType/Deriver/EntityDeriver.php index 7828a99..508959c 100644 --- a/core/lib/Drupal/Core/Entity/Plugin/DataType/Deriver/EntityDeriver.php +++ b/core/lib/Drupal/Core/Entity/Plugin/DataType/Deriver/EntityDeriver.php @@ -82,8 +82,8 @@ public function getDerivativeDefinitions(array $base_plugin_definition) { // Add definitions for each entity type and bundle. foreach ($this->entityManager->getDefinitions() as $entity_type => $info) { $this->derivatives[$entity_type] = array( - 'label' => $info['label'], - 'class' => $info['class'], + 'label' => $info->getLabel(), + 'class' => $info->getClass(), 'constraints' => array('EntityType' => $entity_type), ) + $base_plugin_definition; @@ -92,7 +92,7 @@ public function getDerivativeDefinitions(array $base_plugin_definition) { if ($bundle !== $entity_type) { $this->derivatives[$entity_type . ':' . $bundle] = array( 'label' => $bundle_info['label'], - 'class' => $info['class'], + 'class' => $info->getClass(), 'constraints' => array( 'EntityType' => $entity_type, 'Bundle' => $bundle, diff --git a/core/lib/Drupal/Core/Entity/Query/Sql/Query.php b/core/lib/Drupal/Core/Entity/Query/Sql/Query.php index 987a322..f5c84b4 100644 --- a/core/lib/Drupal/Core/Entity/Query/Sql/Query.php +++ b/core/lib/Drupal/Core/Entity/Query/Sql/Query.php @@ -22,9 +22,7 @@ class Query extends QueryBase implements QueryInterface { /** * Contains the entity info for the entity type of that query. * - * @var array - * - * @see \Drupal\Core\Entity\EntityManagerInterface + * @var \Drupal\Core\Entity\EntityTypeInterface */ protected $entityInfo; @@ -111,19 +109,18 @@ public function execute() { protected function prepare() { $entity_type = $this->entityType; $this->entityInfo = $this->entityManager->getDefinition($entity_type); - if (!isset($this->entityInfo['base_table'])) { + if (!$base_table = $this->entityInfo->getBaseTable()) { throw new QueryException("No base table, invalid query."); } - $base_table = $this->entityInfo['base_table']; $simple_query = TRUE; - if (isset($this->entityInfo['data_table'])) { + if ($this->entityInfo->getDataTable()) { $simple_query = FALSE; } $this->sqlQuery = $this->connection->select($base_table, 'base_table', array('conjunction' => $this->conjunction)); $this->sqlQuery->addMetaData('entity_type', $entity_type); - $id_field = $this->entityInfo['entity_keys']['id']; + $id_field = $this->entityInfo->getKey('id'); // Add the key field for fetchAllKeyed(). - if (empty($this->entityInfo['entity_keys']['revision'])) { + if (!$revision_field = $this->entityInfo->getKey('revision')) { // When there is no revision support, the key field is the entity key. $this->sqlFields["base_table.$id_field"] = array('base_table', $id_field); // Now add the value column for fetchAllKeyed(). This is always the @@ -132,7 +129,6 @@ protected function prepare() { } else { // When there is revision support, the key field is the revision key. - $revision_field = $this->entityInfo['entity_keys']['revision']; $this->sqlFields["base_table.$revision_field"] = array('base_table', $revision_field); // Now add the value column for fetchAllKeyed(). This is always the // entity id. diff --git a/core/lib/Drupal/Core/Entity/Query/Sql/Tables.php b/core/lib/Drupal/Core/Entity/Query/Sql/Tables.php index 8098849..8ec71e1 100644 --- a/core/lib/Drupal/Core/Entity/Query/Sql/Tables.php +++ b/core/lib/Drupal/Core/Entity/Query/Sql/Tables.php @@ -83,16 +83,16 @@ public function addField($field, $type, $langcode) { for ($key = 0; $key <= $count; $key ++) { // If there is revision support and only the current revision is being // queried then use the revision id. Otherwise, the entity id will do. - if (!empty($entity_info['entity_keys']['revision']) && $age == EntityStorageControllerInterface::FIELD_LOAD_CURRENT) { + if (($revision_key = $entity_info->getKey('revision')) && $age == EntityStorageControllerInterface::FIELD_LOAD_CURRENT) { // This contains the relevant SQL field to be used when joining entity // tables. - $entity_id_field = $entity_info['entity_keys']['revision']; + $entity_id_field = $revision_key; // This contains the relevant SQL field to be used when joining field // tables. $field_id_field = 'revision_id'; } else { - $entity_id_field = $entity_info['entity_keys']['id']; + $entity_id_field = $entity_info->getKey('id'); $field_id_field = 'entity_id'; } // This can either be the name of an entity property (non-configurable @@ -138,8 +138,8 @@ public function addField($field, $type, $langcode) { $values = array(); $field_name = $field->getName(); // If there are bundles, pick one. - if (!empty($entity_info['entity_keys']['bundle'])) { - $values[$entity_info['entity_keys']['bundle']] = reset($field_map[$entity_type][$field_name]['bundles']); + if ($bundle_key = $entity_info->getKey('bundle')) { + $values[$bundle_key] = reset($field_map[$entity_type][$field_name]['bundles']); } $entity = $entity_manager ->getStorageController($entity_type) @@ -172,11 +172,12 @@ public function addField($field, $type, $langcode) { // finds the property first. The data table is preferred, which is why // it gets added before the base table. $entity_tables = array(); - if (isset($entity_info['data_table'])) { + if ($data_table = $entity_info->getDataTable()) { $this->sqlQuery->addMetaData('simple_query', FALSE); - $entity_tables[$entity_info['data_table']] = drupal_get_schema($entity_info['data_table']); + $entity_tables[$data_table] = drupal_get_schema($data_table); } - $entity_tables[$entity_info['base_table']] = drupal_get_schema($entity_info['base_table']); + $entity_base_table = $entity_info->getBaseTable(); + $entity_tables[$entity_base_table] = drupal_get_schema($entity_base_table); $sql_column = $specifier; $table = $this->ensureEntityTable($index_prefix, $specifier, $type, $langcode, $base_table, $entity_id_field, $entity_tables); } @@ -190,9 +191,9 @@ public function addField($field, $type, $langcode) { $values = array(); // If there are bundles, pick one. It does not matter which, // properties exist on all bundles. - if (!empty($entity_info['entity_keys']['bundle'])) { + if ($bundle_key = $entity_info->getKey('bundle')) { $bundles = entity_get_bundles($entity_type); - $values[$entity_info['entity_keys']['bundle']] = key($bundles); + $values[$bundle_key] = key($bundles); } $entity = $entity_manager ->getStorageController($entity_type) @@ -207,8 +208,8 @@ public function addField($field, $type, $langcode) { $entity_type = $propertyDefinitions[$relationship_specifier]->getConstraint('EntityType'); $entity_info = $entity_manager->getDefinition($entity_type); // Add the new entity base table using the table and sql column. - $join_condition= '%alias.' . $entity_info['entity_keys']['id'] . " = $table.$sql_column"; - $base_table = $this->sqlQuery->leftJoin($entity_info['base_table'], NULL, $join_condition); + $join_condition= '%alias.' . $entity_info->getKey('id') . " = $table.$sql_column"; + $base_table = $this->sqlQuery->leftJoin($entity_info->getBaseTable(), NULL, $join_condition); $propertyDefinitions = array(); $key++; $index_prefix .= "$next_index_prefix."; diff --git a/core/lib/Drupal/Core/EventSubscriber/HtmlViewSubscriber.php b/core/lib/Drupal/Core/EventSubscriber/HtmlViewSubscriber.php new file mode 100644 index 0000000..f66b604 --- /dev/null +++ b/core/lib/Drupal/Core/EventSubscriber/HtmlViewSubscriber.php @@ -0,0 +1,85 @@ +renderer = $renderer; + } + + /** + * Converts an HtmlFragment into an HtmlPage. + * + * @param \Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent $event + * The Event to process. + */ + public function onHtmlFragment(GetResponseForControllerResultEvent $event) { + $fragment = $event->getControllerResult(); + if ($fragment instanceof HtmlFragment && !$fragment instanceof HtmlPage) { + $page = $this->renderer->render($fragment); + $event->setControllerResult($page); + } + } + + /** + * Renders an HtmlPage object to a Response. + * + * @param \Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent $event + * The Event to process. + */ + public function onHtmlPage(GetResponseForControllerResultEvent $event) { + $page = $event->getControllerResult(); + if ($page instanceof HtmlPage) { + // In case renderPage() returns NULL due to an error cast it to a string + // so as to not cause issues with Response. This also allows renderPage + // to return an object implementing __toString(), but that is not + // recommended. + $response = new Response((string) $this->renderer->renderPage($page), $page->getStatusCode()); + $event->setResponse($response); + } + } + + /** + * Registers the methods in this class that should be listeners. + * + * @return array + * An array of event listener definitions. + */ + static function getSubscribedEvents() { + $events[KernelEvents::VIEW][] = array('onHtmlFragment', 100); + $events[KernelEvents::VIEW][] = array('onHtmlPage', 50); + + return $events; + } + +} diff --git a/core/lib/Drupal/Core/EventSubscriber/ViewSubscriber.php b/core/lib/Drupal/Core/EventSubscriber/ViewSubscriber.php index e986700..6fb011d 100644 --- a/core/lib/Drupal/Core/EventSubscriber/ViewSubscriber.php +++ b/core/lib/Drupal/Core/EventSubscriber/ViewSubscriber.php @@ -8,6 +8,7 @@ namespace Drupal\Core\EventSubscriber; use Drupal\Core\Controller\TitleResolverInterface; +use Drupal\Core\Page\HtmlPage; use Symfony\Cmf\Component\Routing\RouteObjectInterface; use Symfony\Component\HttpFoundation\Response; use Symfony\Component\HttpFoundation\JsonResponse; @@ -85,28 +86,14 @@ public function onView(GetResponseForControllerResultEvent $event) { $event->setResponse(new Response('Not Acceptable', 406)); } } - elseif ($request->attributes->get('_legacy')) { - // This is an old hook_menu-based subrequest, which means we assume - // the body is supposed to be the complete page. - $page_result = $event->getControllerResult(); - if (!is_array($page_result)) { - $page_result = array( - '#markup' => $page_result, - ); - } - - // If no title was returned fall back to one defined in the route. - if (!isset($page_result['#title'])) { - $page_result['#title'] = $this->titleResolver->getTitle($request, $request->attributes->get(RouteObjectInterface::ROUTE_OBJECT)); - } - - $event->setResponse(new Response(drupal_render_page($page_result))); - } else { // This is a new-style Symfony-esque subrequest, which means we assume // the body is not supposed to be a complete page but just a page // fragment. $page_result = $event->getControllerResult(); + if ($page_result instanceof HtmlPage || $page_result instanceof Response) { + return $page_result; + } if (!is_array($page_result)) { $page_result = array( '#markup' => $page_result, diff --git a/core/lib/Drupal/Core/Field/Plugin/Field/FieldType/EntityReferenceItem.php b/core/lib/Drupal/Core/Field/Plugin/Field/FieldType/EntityReferenceItem.php index 655f4fd..40f7a3a 100644 --- a/core/lib/Drupal/Core/Field/Plugin/Field/FieldType/EntityReferenceItem.php +++ b/core/lib/Drupal/Core/Field/Plugin/Field/FieldType/EntityReferenceItem.php @@ -51,7 +51,7 @@ public function getPropertyDefinitions() { if (!isset(static::$propertyDefinitions[$key])) { $target_type_info = \Drupal::entityManager()->getDefinition($target_type); - if (is_subclass_of($target_type_info['class'], '\Drupal\Core\Entity\ContentEntityInterface')) { + if ($target_type_info->isSubclassOf('\Drupal\Core\Entity\ContentEntityInterface')) { // @todo: Lookup the entity type's ID data type and use it here. // https://drupal.org/node/2107249 static::$propertyDefinitions[$key]['target_id'] = DataDefinition::create('integer') diff --git a/core/lib/Drupal/Core/Form/FormBuilder.php b/core/lib/Drupal/Core/Form/FormBuilder.php index 99a2d73..355e560 100644 --- a/core/lib/Drupal/Core/Form/FormBuilder.php +++ b/core/lib/Drupal/Core/Form/FormBuilder.php @@ -192,10 +192,13 @@ public function getForm($form_arg) { /** * {@inheritdoc} */ - public function buildForm($form_id, &$form_state) { + public function buildForm($form_id, array &$form_state) { // Ensure some defaults; if already set they will not be overridden. $form_state += $this->getFormStateDefaults(); + // Ensure the form ID is prepared. + $form_id = $this->getFormId($form_id, $form_state); + if (!isset($form_state['input'])) { $form_state['input'] = $form_state['method'] == 'get' ? $_GET : $_POST; } diff --git a/core/lib/Drupal/Core/Form/FormBuilderInterface.php b/core/lib/Drupal/Core/Form/FormBuilderInterface.php index 1ccb527..a7205d1 100644 --- a/core/lib/Drupal/Core/Form/FormBuilderInterface.php +++ b/core/lib/Drupal/Core/Form/FormBuilderInterface.php @@ -73,7 +73,7 @@ public function getForm($form_arg); * can implement hook_forms(), which maps different $form_id values to the * proper form constructor function. Examples may be found in node_forms(), * and search_forms(). - * @param $form_state + * @param array $form_state * An array which stores information about the form. This is passed as a * reference so that the caller can use it to examine what in the form * changed when the form submission process is complete. Furthermore, it may @@ -230,7 +230,7 @@ public function getForm($form_arg); * * @see self::redirectForm() */ - public function buildForm($form_id, &$form_state); + public function buildForm($form_id, array &$form_state); /** * Retrieves default values for the $form_state array. diff --git a/core/lib/Drupal/Core/Menu/LocalTaskDefault.php b/core/lib/Drupal/Core/Menu/LocalTaskDefault.php index ef8d023..1f5180a 100644 --- a/core/lib/Drupal/Core/Menu/LocalTaskDefault.php +++ b/core/lib/Drupal/Core/Menu/LocalTaskDefault.php @@ -92,7 +92,7 @@ public function getTitle() { public function getWeight() { // By default the weight is 0, or -10 for the root tab. if (!isset($this->pluginDefinition['weight'])) { - if ($this->pluginDefinition['tab_root_id'] == $this->pluginId) { + if ($this->pluginDefinition['base_route'] == $this->pluginDefinition['route_name']) { $this->pluginDefinition['weight'] = -10; } else { diff --git a/core/lib/Drupal/Core/Menu/LocalTaskDerivativeBase.php b/core/lib/Drupal/Core/Menu/LocalTaskDerivativeBase.php deleted file mode 100644 index 5e3cacb..0000000 --- a/core/lib/Drupal/Core/Menu/LocalTaskDerivativeBase.php +++ /dev/null @@ -1,37 +0,0 @@ - $local_task) { - if ($local_task['route_name'] == $route_name) { - return $plugin_id; - break; - } - } - } - -} diff --git a/core/lib/Drupal/Core/Menu/LocalTaskManager.php b/core/lib/Drupal/Core/Menu/LocalTaskManager.php index e2a2499..2649aa7 100644 --- a/core/lib/Drupal/Core/Menu/LocalTaskManager.php +++ b/core/lib/Drupal/Core/Menu/LocalTaskManager.php @@ -40,10 +40,10 @@ class LocalTaskManager extends DefaultPluginManager { 'route_parameters' => array(), // The static title for the local task. 'title' => '', - // The plugin ID of the root tab. - 'tab_root_id' => '', + // The route name where the root tab appears. + 'base_route' => '', // The plugin ID of the parent tab (or NULL for the top-level tab). - 'tab_parent_id' => NULL, + 'parent_id' => NULL, // The weight of the tab. 'weight' => NULL, // The default link options. @@ -171,7 +171,7 @@ public function getLocalTasksForRoute($route_name) { if (!isset($this->instances[$route_name])) { $this->instances[$route_name] = array(); if ($cache = $this->cacheBackend->get($this->cacheKey . ':' . $route_name)) { - $tab_root_ids = $cache->data['tab_root_ids']; + $base_routes = $cache->data['base_routes']; $parents = $cache->data['parents']; $children = $cache->data['children']; } @@ -179,47 +179,56 @@ public function getLocalTasksForRoute($route_name) { $definitions = $this->getDefinitions(); // We build the hierarchy by finding all tabs that should // appear on the current route. - $tab_root_ids = array(); + $base_routes = array(); $parents = array(); $children = array(); foreach ($definitions as $plugin_id => $task_info) { + // Fill in the base_route from the parent to insure consistency. + if (!empty($task_info['parent_id']) && !empty($definitions[$task_info['parent_id']])) { + $task_info['base_route'] = $definitions[$task_info['parent_id']]['base_route']; + // Populate the definitions we use in the next loop. Using a + // reference like &$task_info causes bugs. + $definitions[$plugin_id]['base_route'] = $definitions[$task_info['parent_id']]['base_route']; + } if ($route_name == $task_info['route_name']) { - $tab_root_ids[$task_info['tab_root_id']] = $task_info['tab_root_id']; + if(!empty($task_info['base_route'])) { + $base_routes[$task_info['base_route']] = $task_info['base_route']; + } // Tabs that link to the current route are viable parents // and their parent and children should be visible also. // @todo - this only works for 2 levels of tabs. // instead need to iterate up. $parents[$plugin_id] = TRUE; - if (!empty($task_info['tab_parent_id'])) { - $parents[$task_info['tab_parent_id']] = TRUE; + if (!empty($task_info['parent_id'])) { + $parents[$task_info['parent_id']] = TRUE; } } } - if ($tab_root_ids) { + if ($base_routes) { // Find all the plugins with the same root and that are at the top // level or that have a visible parent. foreach ($definitions as $plugin_id => $task_info) { - if (!empty($tab_root_ids[$task_info['tab_root_id']]) && (empty($task_info['tab_parent_id']) || !empty($parents[$task_info['tab_parent_id']]))) { + if (!empty($base_routes[$task_info['base_route']]) && (empty($task_info['parent_id']) || !empty($parents[$task_info['parent_id']]))) { // Concat '> ' with root ID for the parent of top-level tabs. - $parent = empty($task_info['tab_parent_id']) ? '> ' . $task_info['tab_root_id'] : $task_info['tab_parent_id']; + $parent = empty($task_info['parent_id']) ? '> ' . $task_info['base_route'] : $task_info['parent_id']; $children[$parent][$plugin_id] = $task_info; } } } $data = array( - 'tab_root_ids' => $tab_root_ids, + 'base_routes' => $base_routes, 'parents' => $parents, 'children' => $children, ); $this->cacheBackend->set($this->cacheKey . ':' . $route_name, $data, CacheBackendInterface::CACHE_PERMANENT, $this->cacheTags); } // Create a plugin instance for each element of the hierarchy. - foreach ($tab_root_ids as $root_id) { + foreach ($base_routes as $base_route) { // Convert the tree keyed by plugin IDs into a simple one with // integer depth. Create instances for each plugin along the way. $level = 0; // We used this above as the top-level parent array key. - $next_parent = '> ' . $root_id; + $next_parent = '> ' . $base_route; do { $parent = $next_parent; $next_parent = FALSE; @@ -283,8 +292,7 @@ public function getTasksBuild($current_route_name) { // The plugin may have been set active in getLocalTasksForRoute() if // one of its child tabs is the active tab. $active = $active || $child->getActive(); - // @todo It might make sense to use menu link entities instead of - // arrays. + // @todo It might make sense to use link render elements instead. $link = array( 'title' => $this->getTitle($child), diff --git a/core/lib/Drupal/Core/Page/DefaultHtmlPageRenderer.php b/core/lib/Drupal/Core/Page/DefaultHtmlPageRenderer.php new file mode 100644 index 0000000..6543fbc --- /dev/null +++ b/core/lib/Drupal/Core/Page/DefaultHtmlPageRenderer.php @@ -0,0 +1,101 @@ +languageManager = $language_manager; + } + + /** + * {@inheritdoc} + */ + public function render(HtmlFragment $fragment, $status_code = 200) { + $page = new HtmlPage('', $fragment->getTitle()); + + $page_content['main'] = array( + '#markup' => $fragment->getContent(), + ); + $page_content['#title'] = $page->getTitle(); + + $page_array = drupal_prepare_page($page_content); + + $page = $this->preparePage($page, $page_array); + + $page->setBodyTop(drupal_render($page_array['page_top'])); + $page->setBodyBottom(drupal_render($page_array['page_bottom'])); + $page->setContent(drupal_render($page_array)); + + $page->setStatusCode($status_code); + + return $page; + } + + /** + * {@inheritdoc} + */ + public function renderPage(HtmlPage $page) { + $render = array( + '#theme' => 'html', + '#page_object' => $page, + ); + return drupal_render($render); + } + + /** + * Enhances a page object based on a render array. + * + * @param \Drupal\Core\Page\HtmlPage $page + * The page object to enhance. + * @param array $page_array + * The page array to extract onto the page object. + * + * @return \Drupal\Core\Page\HtmlPage + * The modified page object. + */ + public function preparePage(HtmlPage $page, &$page_array) { + // @todo Remove this one drupal_get_title() has been eliminated. + if (!$page->hasTitle()) { + $title = drupal_get_title(); + // drupal_set_title() already ensured security, so not letting the + // title pass through would cause double escaping. + $page->setTitle($title, PASS_THROUGH); + } + + $page_array['#page'] = $page; + + // HTML element attributes. + $language_interface = $this->languageManager->getLanguage(Language::TYPE_INTERFACE); + $html_attributes = $page->getHtmlAttributes(); + $html_attributes['lang'] = $language_interface->id; + $html_attributes['dir'] = $language_interface->direction ? 'rtl' : 'ltr'; + + return $page; + } + +} diff --git a/core/lib/Drupal/Core/Page/HeadElement.php b/core/lib/Drupal/Core/Page/HeadElement.php new file mode 100644 index 0000000..2c92965 --- /dev/null +++ b/core/lib/Drupal/Core/Page/HeadElement.php @@ -0,0 +1,89 @@ +. + * + * @var bool + */ + protected $noScript = FALSE; + + /** + * Renders this object to an HTML element string. + * + * @return string + */ + public function __toString() { + // Render the attributes via the attribute template class. + // @todo Should HeadElement just extend the Attribute classes? + $attributes = new Attribute($this->attributes); + $rendered = (string) $attributes; + + $string = "<{$this->element}{$rendered} />"; + if ($this->noScript) { + $string = ""; + } + return $string; + } + + /** + * Sets an attribute on this element. + * + * @param mixed $key + * The attribute to set. + * @param mixed $value + * The value to which to set it. + * + * @return self + * The invoked object. + */ + public function setAttribute($key, $value) { + $this->attributes[$key] = $value; + return $this; + } + + /** + * Sets if this element should be wrapped in