core/modules/node/node.api.php | 26 +++++++-------- core/modules/node/node.module | 31 ++++++++++-------- .../src/Cache/NodeAccessGrantsCacheContext.php | 2 +- core/modules/node/src/Tests/NodeTestBase.php | 6 ++-- core/modules/options/options.api.php | 8 ++--- .../page_cache/src/StackMiddleware/PageCache.php | 6 ++-- core/modules/quickedit/js/models/FieldModel.js | 6 ++-- core/modules/quickedit/js/quickedit.js | 14 ++++---- core/modules/quickedit/js/views/EditorView.js | 10 +++--- core/modules/rdf/rdf.info.yml | 2 +- core/modules/rdf/rdf.module | 16 ++++----- core/modules/rdf/src/SchemaOrgDataConverter.php | 4 ++- .../rdf/src/Tests/Field/FieldRdfaTestBase.php | 10 +++--- .../responsive_image/responsive_image.module | 2 +- .../rest/src/LinkManager/RelationLinkManager.php | 21 +++++++----- .../rest/src/LinkManager/TypeLinkManager.php | 14 ++++---- core/modules/rest/src/RequestHandler.php | 10 +++--- core/modules/rest/src/Tests/RESTTestBase.php | 38 ++++++++++++---------- 18 files changed, 120 insertions(+), 106 deletions(-) diff --git a/core/modules/node/node.api.php b/core/modules/node/node.api.php index 2479a29..38f563b 100644 --- a/core/modules/node/node.api.php +++ b/core/modules/node/node.api.php @@ -1,18 +1,18 @@ $node->id()))->fetchField(); return array('rating' => \Drupal::translation()->formatPlural($rating, '1 point', '@count points')); } /** - * Act on a node being indexed for searching. + * Acts on a node being indexed for searching. * * This hook is invoked during search indexing, after loading, and after the * result of rendering is added as $node->rendered to the node object. * * @param \Drupal\node\NodeInterface $node * The node being indexed. diff --git a/core/modules/node/node.module b/core/modules/node/node.module index a54fc0a..44df9c4 100644 --- a/core/modules/node/node.module +++ b/core/modules/node/node.module @@ -566,13 +566,13 @@ function node_theme_suggestions_node(array $variables) { * full list of variables. * * @param array $variables * An associative array containing: * - elements: An array of elements to display in view mode. * - node: The node object. - * - view_mode: View mode; e.g., 'full', 'teaser', etc. + * - view_mode: The view mode; for example, 'full' or 'teaser'. */ function template_preprocess_node(&$variables) { $variables['view_mode'] = $variables['elements']['#view_mode']; // Provide a distinct $teaser boolean. $variables['teaser'] = $variables['view_mode'] == 'teaser'; $variables['node'] = $variables['elements']['#node']; @@ -603,15 +603,16 @@ function template_preprocess_node(&$variables) { $node_type = $node->type->entity; // Used by RDF to add attributes around the author and date submitted. $variables['author_attributes'] = new Attribute(); $variables['display_submitted'] = $node_type->displaySubmitted(); if ($variables['display_submitted']) { if (theme_get_setting('features.node_user_picture')) { - // To change user picture settings (e.g. image style), edit the 'compact' - // view mode on the User entity. Note that the 'compact' view mode might - // not be configured, so remember to always check the theme setting first. + // To change user picture settings (for instance, image style), edit the + // 'compact' view mode on the User entity. Note that the 'compact' view + // mode might not be configured, so remember to always check the theme + // setting first. $variables['author_picture'] = user_view($node->getOwner(), 'compact'); } } // Add article ARIA role. $variables['attributes']['role'] = 'article'; @@ -768,35 +769,37 @@ function node_get_recent($number = 10) { /** * Generates an array for rendering the given node. * * @param \Drupal\node\NodeInterface $node * A node entity. - * @param $view_mode - * (optional) View mode, e.g., 'full', 'teaser', etc. Defaults to 'full.' - * @param $langcode - * (optional) A language code to use for rendering. Defaults to NULL which is + * @param string $view_mode + * (optional) The view mode; for example, 'full' or 'teaser'. Defaults to + * 'full'. + * @param string|null $langcode + * (optional) A language code to use for rendering. Defaults to NULL, which is * the global content language of the current request. * * @return array * An array as expected by drupal_render(). */ function node_view(NodeInterface $node, $view_mode = 'full', $langcode = NULL) { return entity_view($node, $view_mode, $langcode); } /** * Constructs a drupal_render() style array from an array of loaded nodes. * - * @param $nodes + * @param array $nodes * An array of nodes as returned by Node::loadMultiple(). - * @param $view_mode - * (optional) View mode, e.g., 'full', 'teaser', etc. Defaults to 'teaser.' - * @param $langcode - * (optional) A language code to use for rendering. Defaults to the global - * content language of the current request. + * @param string $view_mode + * (optional) The view mode; for example, 'full' or 'teaser'. Defaults to + * 'teaser.' + * @param string|null $langcode + * (optional) A language code to use for rendering. Defaults to NULL, the + * global content language of the current request. * * @return array * An array in the format expected by drupal_render(). */ function node_view_multiple($nodes, $view_mode = 'teaser', $langcode = NULL) { return entity_view_multiple($nodes, $view_mode, $langcode); diff --git a/core/modules/node/src/Cache/NodeAccessGrantsCacheContext.php b/core/modules/node/src/Cache/NodeAccessGrantsCacheContext.php index 767d286..d613229 100644 --- a/core/modules/node/src/Cache/NodeAccessGrantsCacheContext.php +++ b/core/modules/node/src/Cache/NodeAccessGrantsCacheContext.php @@ -12,13 +12,13 @@ use Drupal\Core\Cache\Context\UserCacheContextBase; /** * Defines the node access view cache context service. * * Cache context ID: 'user.node_grants' (to vary by all operations' grants). - * Calculated cache context ID: 'user.node_grants:%operation', e.g. + * Calculated cache context ID: 'user.node_grants:%operation', for example, * 'user.node_grants:view' (to vary by the view operation's grants). * * This allows for node access grants-sensitive caching when listing nodes. * * @see node_query_node_access_alter() * @ingroup node_access diff --git a/core/modules/node/src/Tests/NodeTestBase.php b/core/modules/node/src/Tests/NodeTestBase.php index 1640a79..8fe3d74 100644 --- a/core/modules/node/src/Tests/NodeTestBase.php +++ b/core/modules/node/src/Tests/NodeTestBase.php @@ -50,15 +50,15 @@ protected function setUp() { /** * Asserts that node access correctly grants or denies access. * * @param array $ops * An associative array of the expected node access grants for the node - * and account, with each key as the name of an operation (e.g. 'view', - * 'delete') and each value a Boolean indicating whether access to that - * operation should be granted. + * and account, with each key as the name of an operation (for example, + * 'view' or 'delete') and each value a Boolean indicating whether access to + * that operation should be granted. * @param \Drupal\node\NodeInterface $node * The node object to check. * @param \Drupal\Core\Session\AccountInterface $account * The user account for which to check access. */ function assertNodeAccess(array $ops, NodeInterface $node, AccountInterface $account) { diff --git a/core/modules/options/options.api.php b/core/modules/options/options.api.php index f17f102..8ad2d9b 100644 --- a/core/modules/options/options.api.php +++ b/core/modules/options/options.api.php @@ -58,25 +58,25 @@ function hook_options_list_alter(array &$options, array $context) { * should be a subset of the values returned when no $entity is provided. * * @param \Drupal\Core\Field\FieldStorageDefinitionInterface $definition * The field storage definition. * @param \Drupal\Core\Entity\FieldableEntityInterface|null $entity * (optional) The entity context if known, or NULL if the allowed values are - * being collected without the context of a specific entity. + * being collected without the context of a specific entity. Defaults to NULL. * @param bool &$cacheable * (optional) If an $entity is provided, the $cacheable parameter should be * modified by reference and set to FALSE if the set of allowed values * returned was specifically adjusted for that entity and cannot not be reused * for other entities. Defaults to TRUE. * * @return array * The array of allowed values. Keys of the array are the raw stored values * (number or text), values of the array are the display labels. If $entity - * is NULL, you should return the list of all the possible allowed values in - * any context so that other code (e.g. Views filters) can support the allowed - * values for all possible entities and bundles. + * is NULL, one should return the list of all the possible allowed values in + * any context so that other code (for example, Views filters) can support the + * allowed values for all possible entities and bundles. * * @ingroup callbacks * @see options_allowed_values() * @see options_test_allowed_values_callback() * @see options_test_dynamic_values_callback() */ diff --git a/core/modules/page_cache/src/StackMiddleware/PageCache.php b/core/modules/page_cache/src/StackMiddleware/PageCache.php index f25c685..0b6bd6b 100644 --- a/core/modules/page_cache/src/StackMiddleware/PageCache.php +++ b/core/modules/page_cache/src/StackMiddleware/PageCache.php @@ -212,15 +212,15 @@ protected function fetch(Request $request, $type = self::MASTER_REQUEST, $catch // Drupal's primary cache invalidation architecture is cache tags: any // response that varies by a configuration value or data in a content // entity should have cache tags, to allow for instant cache invalidation // when that data is updated. However, HTTP does not standardize how to // encode cache tags in a response. Different CDNs implement their own - // approaches, and configurable reverse proxies (e.g., Varnish) allow for - // custom implementations. To keep Drupal's internal page cache simple, we - // only cache CacheableResponseInterface responses, since those provide a + // approaches, and configurable reverse proxies (for example, Varnish) allow + // for custom implementations. To keep Drupal's internal page cache simple, + // we only cache CacheableResponseInterface responses, since those provide a // defined API for retrieving cache tags. For responses that do not // implement CacheableResponseInterface, there's no easy way to distinguish // responses that truly don't depend on any site data from responses that // contain invalidation information customized to a particular proxy or // CDN. // - Drupal modules are encouraged to use CacheableResponseInterface diff --git a/core/modules/quickedit/js/models/FieldModel.js b/core/modules/quickedit/js/models/FieldModel.js index 8aeff10..55900cc 100644 --- a/core/modules/quickedit/js/models/FieldModel.js +++ b/core/modules/quickedit/js/models/FieldModel.js @@ -269,15 +269,15 @@ 'highlighted', // User has activated the in-place editing of this field; in-place editor // is activating. // - Trigger: user. // - Guarantees: see 'candidate'. // - Expected behavior: loading indicator, in-place editor is loading - // remote data (e.g. retrieve form from back-end). Upon retrieval of - // remote data, the in-place editor transitions the field's state to - // 'active'. + // remote data (for example, retrieve form from back-end). Upon + // retrieval of remote data, the in-place editor transitions the field's + // state to 'active'. 'activating', // In-place editor has finished loading remote data; ready for use. // - Trigger: in-place editor. // - Guarantees: see 'candidate'. // - Expected behavior: in-place editor for the field is ready for use. 'active', diff --git a/core/modules/quickedit/js/quickedit.js b/core/modules/quickedit/js/quickedit.js index 40bdd3e..c14786d 100644 --- a/core/modules/quickedit/js/quickedit.js +++ b/core/modules/quickedit/js/quickedit.js @@ -529,17 +529,17 @@ /** * Attempts to set up a "Quick edit" link and corresponding EntityModel. * * @param {object} contextualLink * An object with the following properties: - * - String entityID: a Quick Edit entity identifier, e.g. "node/1" or - * "block_content/5". - * - String entityInstanceID: a Quick Edit entity instance identifier, - * e.g. 0, 1 or n (depending on whether it's the first, second, or n+1st - * instance of this entity). + * - String entityID: a Quick Edit entity identifier; for example, + * "node/1" or "block_content/5". + * - String entityInstanceID: a Quick Edit entity instance identifier + * (for example, 0, 1 or n, depending on whether it is the first, + * second, or n+1st instance of this entity). * - DOM el: element pointing to the contextual links placeholder for this * entity. * - DOM region: element pointing to the contextual region of this entity. * * @return {bool} * Returns true when a contextual the given contextual link metadata can be @@ -633,14 +633,14 @@ * * Deletes any contained EntityModels (plus their associated FieldModels and * ContextualLinkView) and FieldModels, as well as the corresponding queues. * * After EntityModels, FieldModels must also be deleted, because it is * possible in Drupal for a field DOM element to exist outside of the entity - * DOM element, e.g. when viewing the full node, the title of the node is not - * rendered within the node (the entity) but as the page title. + * DOM element; for example, when viewing the full node, the title of the node + * is not rendered within the node (the entity), but as the page title. * * Note: this will not delete an entity that is actively being in-place * edited. * * @param {jQuery} $context * The context within which to delete. diff --git a/core/modules/quickedit/js/views/EditorView.js b/core/modules/quickedit/js/views/EditorView.js index 5e041db..c8d05eb 100644 --- a/core/modules/quickedit/js/views/EditorView.js +++ b/core/modules/quickedit/js/views/EditorView.js @@ -53,18 +53,18 @@ Backbone.View.prototype.remove.call(this); }, /** * Returns the edited element. * - * For some single cardinality fields, it may be necessary or useful to - * not in-place edit (and hence decorate) the DOM element with the + * For some single cardinality fields, it may be necessary or useful to not + * in-place edit (and hence decorate) the DOM element with the * data-quickedit-field-id attribute (which is the field's wrapper), but a - * specific element within the field's wrapper. - * e.g. using a WYSIWYG editor on a body field should happen on the DOM - * element containing the text itself, not on the field wrapper. + * specific element within the field's wrapper. For instance, using a + * WYSIWYG editor on a body field should happen on the DOM element + * containing the text itself, not on the field wrapper. * * @return {jQuery} * A jQuery-wrapped DOM element. * * @see Drupal.quickedit.editors.plain_text */ diff --git a/core/modules/rdf/rdf.info.yml b/core/modules/rdf/rdf.info.yml index ec1b509..06ff8d9 100644 --- a/core/modules/rdf/rdf.info.yml +++ b/core/modules/rdf/rdf.info.yml @@ -1,6 +1,6 @@ name: RDF type: module -description: 'Enriches your content with metadata to let other applications (e.g. search engines, aggregators) better understand its relationships and attributes.' +description: 'Enriches your content with metadata to let other applications (for example, search engines or aggregators) better understand its relationships and attributes.' package: Core version: VERSION core: 8.x diff --git a/core/modules/rdf/rdf.module b/core/modules/rdf/rdf.module index 33a3e92..828e98e 100644 --- a/core/modules/rdf/rdf.module +++ b/core/modules/rdf/rdf.module @@ -13,13 +13,13 @@ */ function rdf_help($route_name, RouteMatchInterface $route_match) { switch ($route_name) { case 'help.page.rdf': $output = ''; $output .= '

' . t('About') . '

'; - $output .= '

' . t('The RDF module enriches your content with metadata to let other applications (e.g., search engines, aggregators, and so on) better understand its relationships and attributes. This semantically enriched, machine-readable output for your website uses the RDFa specification, which allows RDF data to be embedded in HTML markup. Other modules can define mappings of their data to RDF terms, and the RDF module makes this RDF data available to the theme. The core modules define RDF mappings for their data model, and the core themes output this RDF metadata information along with the human-readable visual information. For more information, see the online documentation for the RDF module.', array(':rdfa' => 'http://www.w3.org/TR/xhtml-rdfa-primer/', ':rdf' => 'https://www.drupal.org/documentation/modules/rdf')) . '

'; + $output .= '

' . t('The RDF module enriches your content with metadata to let other applications (for example, search engines or aggregators) better understand its relationships and attributes. This semantically enriched, machine-readable output for your website uses the RDFa specification, which allows RDF data to be embedded in HTML markup. Other modules can define mappings of their data to RDF terms, and the RDF module makes this RDF data available to the theme. The core modules define RDF mappings for their data model, and the core themes output this RDF metadata information along with the human-readable visual information. For more information, see the online documentation for the RDF module.', array(':rdfa' => 'http://www.w3.org/TR/xhtml-rdfa-primer/', ':rdf' => 'https://www.drupal.org/documentation/modules/rdf')) . '

'; return $output; } } /** * @defgroup rdf RDF Mapping API @@ -293,23 +293,23 @@ function _rdf_set_field_rel_attribute(&$variables) { /** * Implements hook_preprocess_HOOK() for node templates. */ function rdf_preprocess_node(&$variables) { // Adds RDFa markup to the node container. The about attribute specifies the // URI of the resource described within the HTML element, while the @typeof - // attribute indicates its RDF type (e.g., foaf:Document, sioc:Person, and so - // on.) + // attribute indicates its RDF type (for example, foaf:Document, sioc:Person, + // and so on.) $bundle = $variables['node']->bundle(); $mapping = rdf_get_mapping('node', $bundle); $bundle_mapping = $mapping->getPreparedBundleMapping('node', $bundle); $variables['attributes']['about'] = empty($variables['url']) ? NULL: $variables['url']; $variables['attributes']['typeof'] = empty($bundle_mapping['types']) ? NULL : $bundle_mapping['types']; // Adds RDFa markup for the node title as metadata because wrapping the title // with markup is not reliable and the title output is different depending on - // the view mode (e.g. full vs. teaser). + // the view mode (for example, full vis-a-vis teaser). $title_mapping = $mapping->getPreparedFieldMapping('title'); if ($title_mapping) { $title_attributes['property'] = empty($title_mapping['properties']) ? NULL : $title_mapping['properties']; $title_attributes['content'] = $variables['node']->label(); $variables['title_suffix']['rdf_meta_title'] = array( '#theme' => 'rdf_metadata', @@ -445,14 +445,14 @@ function rdf_preprocess_comment(&$variables) { $mapping = rdf_get_mapping('comment', $comment->bundle()); $bundle_mapping = $mapping->getPreparedBundleMapping(); if (!empty($bundle_mapping['types']) && !isset($comment->in_preview)) { // Adds RDFa markup to the comment container. The about attribute specifies // the URI of the resource described within the HTML element, while the - // typeof attribute indicates its RDF type (e.g., sioc:Post, foaf:Document, - // and so on.) + // typeof attribute indicates its RDF type (for example, sioc:Post, + // foaf:Document, and so on.) $variables['attributes']['about'] = $comment->url(); $variables['attributes']['typeof'] = $bundle_mapping['types']; } // Adds RDFa markup for the relation between the comment and its author. $author_mapping = $mapping->getPreparedFieldMapping('uid'); @@ -537,14 +537,14 @@ function rdf_preprocess_comment(&$variables) { /** * Implements hook_preprocess_HOOK() for taxonomy term templates. */ function rdf_preprocess_taxonomy_term(&$variables) { // Adds RDFa markup to the taxonomy term container. // The @about attribute specifies the URI of the resource described within - // the HTML element, while the @typeof attribute indicates its RDF type - // (e.g., schema:Thing, skos:Concept, and so on). + // the HTML element, while the @typeof attribute indicates its RDF type (for + // example, schema:Thing, skos:Concept, and so on). $term = $variables['term']; $mapping = rdf_get_mapping('taxonomy_term', $term->bundle()); $bundle_mapping = $mapping->getPreparedBundleMapping(); $variables['attributes']['about'] = $term->url(); $variables['attributes']['typeof'] = empty($bundle_mapping['types']) ? NULL : $bundle_mapping['types']; diff --git a/core/modules/rdf/src/SchemaOrgDataConverter.php b/core/modules/rdf/src/SchemaOrgDataConverter.php index 99fe670..b5ce802 100644 --- a/core/modules/rdf/src/SchemaOrgDataConverter.php +++ b/core/modules/rdf/src/SchemaOrgDataConverter.php @@ -1,7 +1,8 @@ 'literal'); // The field formatter will be rendered inside the entity. Set the field // formatter in the entity display options before rendering the entity. @@ -164,13 +166,13 @@ protected function parseContent($content) { * * @param string $content * The html to parse. * @param string $xpath * The xpath string to use in the search. * @param array $arguments - * Some arguments for the xpath. + * (optional) Some arguments for the xpath. Defaults to an empty array. * * @return array|FALSE * The return value of the xpath search. For details on the xpath string * format and return values see the SimpleXML documentation, * http://php.net/manual/function.simplexml-element-xpath.php. */ diff --git a/core/modules/responsive_image/responsive_image.module b/core/modules/responsive_image/responsive_image.module index af87c5b..610ffbd 100644 --- a/core/modules/responsive_image/responsive_image.module +++ b/core/modules/responsive_image/responsive_image.module @@ -36,13 +36,13 @@ function responsive_image_help($route_name, RouteMatchInterface $route_match) { $output .= '
' . t('The fallback image style is typically the smallest size image you expect to appear in this space. Because the responsive images module uses the Picturefill library so that responsive images can work in older browsers, the fallback image should only appear on a site if an error occurs.)
'); $output .= '
' . t('Breakpoint groups: viewport sizing vs art direction') . '
'; $output .= '
' . t('The breakpoint group typically only needs a single breakpoint with an empty media query in order to do viewport sizing. Multiple breakpoints are used for changing the crop or aspect ratio of images at different viewport sizes, which is often referred to as art direction. Once you select a breakpoint group, you can choose which breakpoints to use for the responsive image style. By default, the option do not use this breakpoint is selected for each breakpoint. See the help page of the Breakpoint module for more information.', array(':breakpoint_help' => \Drupal::url('help.page', array('name' => 'breakpoint')))) . '
'; $output .= '
' . t('Breakpoint settings: sizes vs image styles') . '
'; $output .= '
' . t('While you have the option to provide only image style per breakpoint, the sizes option allows you to provide more options to browsers as to which image file it can display, even when using multiple breakpoints for art direction. Breakpoints are defined in the configuration files of the theme.
'); $output .= '
' . t('Sizes field') . '
'; - $output .= '
' . t('Once the sizes option is selected, you can let the browser know the size of this image in relation to the site layout, using the Sizes field. For a hero image that always fills the entire screen, you could simply enter 100vw, which means 100% of the viewport width. For an image that fills 90% of the screen for small viewports, but only fills 40% of the screen when the viewport is larger than 40em (typically 640px), you could enter "(min-width: 40em) 40vw, 90vw" in the Sizes field. The last item in the comma-separated list is the smallest viewport size: other items in the comma-separated list should have a media condition paired with an image width. Media conditions are similar to a media query, often a min-width paired with a viewport width using em or px units: e.g. (min-width: 640px) or (min-width: 40em). This is paired with the image width at that viewport size using px, em or vw units. The vw unit is viewport width and is used instead of a percentage because the percentage always refers to the width of the entire viewport.
'); + $output .= '
' . t('Once the sizes option is selected, you can let the browser know the size of this image in relation to the site layout, using the Sizes field. For a hero image that always fills the entire screen, you could simply enter 100vw, which means 100% of the viewport width. For an image that fills 90% of the screen for small viewports, but only fills 40% of the screen when the viewport is larger than 40em (typically 640px), you could enter "(min-width: 40em) 40vw, 90vw" in the Sizes field. The last item in the comma-separated list is the smallest viewport size: other items in the comma-separated list should have a media condition paired with an image width. Media conditions are similar to a media query, often a min-width paired with a viewport width using em or px units: for example, (min-width: 640px) or (min-width: 40em). This is paired with the image width at that viewport size using px, em or vw units. The vw unit is viewport width and is used instead of a percentage because the percentage always refers to the width of the entire viewport.
'); $output .= '
' . t('Image styles for sizes') . '
'; $output .= '
' . t('Below the Sizes field you can choose multiple image styles so the browser can choose the best image file size to fill the space defined in the Sizes field. Typically you will want to use image styles that resize your image to have options that range from the smallest px width possible for the space the image will appear in to the largest px width possible, with a variety of widths in between. You may want to provide image styles with widths that are 1.5x to 2x the space available in the layout to account for high resolution screens. Image styles can be defined on the Image styles page that is provided by the Image module.', array(':image_styles' => \Drupal::url('entity.image_style.collection'), ':image_help' => \Drupal::url('help.page', array('name' => 'image')))) . '
'; $output .= ''; $output .= '
' . t('Using responsive image styles in Image fields') . '
'; $output .= '
' . t('After defining responsive image styles, you can use them in the display settings for your Image fields, so that the site displays responsive images using the HTML5 picture tag. Open the Manage display page for the entity type (content type, taxonomy vocabulary, etc.) that the Image field is attached to. Choose the format Responsive image, click the Edit icon, and select one of the responsive image styles that you have created. For general information on how to manage fields and their display see the Field UI module help page. For background information about entities and fields see the Field module help page.', array(':field_ui' => (\Drupal::moduleHandler()->moduleExists('field_ui')) ? \Drupal::url('help.page', array('name' => 'field_ui')) : '#', ':field_help' => \Drupal::url('help.page', array('name' => 'field')))) . '
'; $output .= ''; diff --git a/core/modules/rest/src/LinkManager/RelationLinkManager.php b/core/modules/rest/src/LinkManager/RelationLinkManager.php index 89e2488..698e1d8 100644 --- a/core/modules/rest/src/LinkManager/RelationLinkManager.php +++ b/core/modules/rest/src/LinkManager/RelationLinkManager.php @@ -15,12 +15,14 @@ use Drupal\Core\Extension\ModuleHandlerInterface; use Symfony\Component\HttpFoundation\RequestStack; class RelationLinkManager extends LinkManagerBase implements RelationLinkManagerInterface { /** + * The cache of relation URIs and their associated Typed Data IDs. + * * @var \Drupal\Core\Cache\CacheBackendInterface; */ protected $cache; /** * Entity manager. @@ -68,15 +70,15 @@ public function getRelationUri($entity_type, $bundle, $field_name, $context = ar // a documentation page. Therefore, we return a URI assembled relative to // the site's base URL, which is sufficient to uniquely identify the site's // entity type + bundle + field for use in hypermedia formats, but we do // not take into account unclean URLs, language prefixing, or anything else // that would be required for Drupal to be able to respond with content // at this URL. If a module is installed that adds such content, but - // requires this URL to be different (e.g., include a language prefix), - // then the module must also override the RelationLinkManager class/service - // to return the desired URL. + // requires this URL to be different (for instance, include a language + // prefix), then the module must also override the RelationLinkManager + // class/service to return the desired URL. $uri = $this->getLinkDomain() . "/rest/relation/$entity_type/$bundle/$field_name"; $this->moduleHandler->alter('rest_relation_uri', $uri, $context); return $uri; } /** @@ -88,22 +90,23 @@ public function getRelationInternalIds($relation_uri, $context = array()) { return $relations[$relation_uri]; } return FALSE; } /** - * Get the array of relation links. + * Gets the array of relation links. * * Any field can be handled as a relation simply by changing how it is - * normalized. Therefore, there is no prior knowledge that can be used here - * to determine which fields to assign relation URIs. Instead, each field, - * even primitives, are given a relation URI. It is up to the caller to - * determine which URIs to use. + * normalized. Therefore, there is no prior knowledge that can be used here to + * determine which fields to assign relation URIs. Instead, each field, even + * primitives, are given a relation URI. It is up to the caller to determine + * which URIs to use. * * @param array $context - * Context from the normalizer/serializer operation. + * (optional) Context from the normalizer/serializer operation. Defaults to + * an empty array. * * @return array * An array of typed data ids (entity_type, bundle, and field name) keyed * by corresponding relation URI. */ protected function getRelations($context = array()) { diff --git a/core/modules/rest/src/LinkManager/TypeLinkManager.php b/core/modules/rest/src/LinkManager/TypeLinkManager.php index 27fdf3f..e6a6e9b 100644 --- a/core/modules/rest/src/LinkManager/TypeLinkManager.php +++ b/core/modules/rest/src/LinkManager/TypeLinkManager.php @@ -58,15 +58,15 @@ public function getTypeUri($entity_type, $bundle, $context = array()) { // a documentation page. Therefore, we return a URI assembled relative to // the site's base URL, which is sufficient to uniquely identify the site's // entity type and bundle for use in hypermedia formats, but we do not // take into account unclean URLs, language prefixing, or anything else // that would be required for Drupal to be able to respond with content // at this URL. If a module is installed that adds such content, but - // requires this URL to be different (e.g., include a language prefix), - // then the module must also override the TypeLinkManager class/service to - // return the desired URL. + // requires this URL to be different (for instance, include a language + // prefix), then the module must also override the TypeLinkManager + // class/service to return the desired URL. $uri = $this->getLinkDomain() . "/rest/type/$entity_type/$bundle"; $this->moduleHandler->alter('rest_type_uri', $uri, $context); return $uri; } /** @@ -78,16 +78,17 @@ public function getTypeInternalIds($type_uri, $context = array()) { return $types[$type_uri]; } return FALSE; } /** - * Get the array of type links. + * Gets the array of type links. * * @param array $context - * Context from the normalizer/serializer operation. + * (optional) Context from the normalizer/serializer operation. Defaults to + * an empty array. * * @return array * An array of typed data ids (entity_type and bundle) keyed by * corresponding type URI. */ protected function getTypes($context = array()) { @@ -101,13 +102,14 @@ protected function getTypes($context = array()) { } /** * Writes the cache of type links. * * @param array $context - * Context from the normalizer/serializer operation. + * (optional) Context from the normalizer/serializer operation. Defaults to + * an empty array. */ protected function writeCache($context = array()) { $data = array(); // Type URIs correspond to bundles. Iterate through the bundles to get the // URI and data for them. diff --git a/core/modules/rest/src/RequestHandler.php b/core/modules/rest/src/RequestHandler.php index 5a04cd8..b4c0e5c 100644 --- a/core/modules/rest/src/RequestHandler.php +++ b/core/modules/rest/src/RequestHandler.php @@ -101,17 +101,17 @@ public function handle(RouteMatchInterface $route_match, Request $request) { $headers = $e->getHeaders() + array('Content-Type' => $request->getMimeType($format)); return new Response($content, $e->getStatusCode(), $headers); } // Serialize the outgoing data for the response, if available. if ($response instanceof ResourceResponse && $data = $response->getResponseData()) { - // Serialization can invoke rendering (e.g., generating URLs), but the - // serialization API does not provide a mechanism to collect the - // bubbleable metadata associated with that (e.g., language and other - // contexts), so instead, allow those to "leak" and collect them here in - // a render context. + // Serialization can invoke rendering (for example, generating URLs), but + // the serialization API does not provide a mechanism to collect the + // bubbleable metadata associated with that (for instance, language and + // other contexts), so instead, allow those to "leak" and collect them + // here in a render context. // @todo Add test coverage for language negotiation contexts in // https://www.drupal.org/node/2135829. $context = new RenderContext(); $output = $this->container->get('renderer')->executeInRenderContext($context, function() use ($serializer, $data, $format) { return $serializer->serialize($data, $format); }); diff --git a/core/modules/rest/src/Tests/RESTTestBase.php b/core/modules/rest/src/Tests/RESTTestBase.php index db7d123..fc3f4af 100644 --- a/core/modules/rest/src/Tests/RESTTestBase.php +++ b/core/modules/rest/src/Tests/RESTTestBase.php @@ -234,21 +234,23 @@ protected function entityValues($entity_type) { } } /** * Enables the REST service interface for a specific entity type. * - * @param string|FALSE $resource_type + * @param string|false $resource_type * The resource type that should get REST API enabled or FALSE to disable all * resource types. * @param string $method - * The HTTP method to enable, e.g. GET, POST etc. - * @param string $format - * (Optional) The serialization format, e.g. hal_json. - * @param array $auth - * (Optional) The list of valid authentication methods. + * (optional) The HTTP method to enable; for example, 'GET' or 'POST'. + * Defaults to 'GET'. + * @param string|null $format + * (optional) The serialization format; for instance, 'hal_json'. Defaults + * to NULL. + * @param array|null $auth + * (optional) The list of valid authentication methods. Defaults to NULL. */ protected function enableService($resource_type, $method = 'GET', $format = NULL, $auth = NULL) { // Enable REST API for this entity type. $config = $this->config('rest.settings'); $settings = array(); @@ -298,13 +300,13 @@ protected function curlExec($curl_options, $redirect = FALSE) { /** * Provides the necessary user permissions for entity operations. * * @param string $entity_type * The entity type. * @param string $operation - * The operation, one of 'view', 'create', 'update' or 'delete'. + * The operation; one of 'view', 'create', 'update' or 'delete'. * * @return array * The set of user permission strings. */ protected function entityPermissions($entity_type, $operation) { switch ($entity_type) { @@ -360,23 +362,23 @@ protected function entityPermissions($entity_type, $operation) { /** * Loads an entity based on the location URL returned in the location header. * * @param string $location_url * The URL returned in the Location header. * - * @return \Drupal\Core\Entity\Entity|FALSE. + * @return \Drupal\Core\Entity\Entity|false * The entity or FALSE if there is no matching entity. */ protected function loadEntityFromLocationHeader($location_url) { $url_parts = explode('/', $location_url); $id = end($url_parts); return entity_load($this->testEntityType, $id); } /** - * Remove node fields that can only be written by an admin user. + * Removes node fields that can only be written by an admin user. * * @param \Drupal\node\NodeInterface $node * The node to remove fields where non-administrative users cannot write. * * @return \Drupal\node\NodeInterface * The node with removed fields. @@ -392,29 +394,29 @@ protected function removeNodeFieldsForNonAdminUsers(NodeInterface $node) { $node->set('uid', NULL); return $node; } /** - * Check to see if the HTTP request response body is identical to the expected - * value. + * Checks if the HTTP request response body is identical to expected value. * - * @param $expected + * @param string $expected * The first value to check. - * @param $message + * @param string $message * (optional) A message to display with the assertion. Do not translate * messages: use \Drupal\Component\Utility\SafeMarkup::format() to embed - * variables in the message text, not t(). If left blank, a default message - * will be displayed. - * @param $group + * variables in the message text, not t(). If left blank (the default), a + * default message will be generated and displayed. + * @param string $group * (optional) The group this message is in, which is displayed in a column * in test output. Use 'Debug' to indicate this is debugging output. Do not - * translate this string. Defaults to 'Other'; most tests do not override - * this default. + * translate this string. Defaults to 'REST Response'; most tests do not + * override this default. * * @return bool * TRUE if the assertion succeeded, FALSE otherwise. */ protected function assertResponseBody($expected, $message = '', $group = 'REST Response') { return $this->assertIdentical($expected, $this->responseBody, $message ? $message : strtr('Response body @expected (expected) is equal to @response (actual).', array('@expected' => var_export($expected, TRUE), '@response' => var_export($this->responseBody, TRUE))), $group); } + }