public static function Resource::photo in Drupal 10

Same name and namespace in other branches

8 core/modules/media/src/OEmbed/Resource.php \Drupal\media\OEmbed\Resource::photo()
9 core/modules/media/src/OEmbed/Resource.php \Drupal\media\OEmbed\Resource::photo()

Creates a photo resource.

Parameters

string $url: The URL of the photo.

int $width: The width of the photo, in pixels.

int $height: (optional) The height of the photo, in pixels.

\Drupal\media\OEmbed\Provider $provider: (optional) The resource provider.

string $title: (optional) A text title, describing the resource.

string $author_name: (optional) The name of the author/owner of the resource.

string $author_url: (optional) A URL for the author/owner of the resource.

int $cache_age: (optional) The suggested cache lifetime for this resource, in seconds.

string $thumbnail_url: (optional) A URL to a thumbnail image representing the resource. If this parameter is present, $thumbnail_width and $thumbnail_height must also be present.

int $thumbnail_width: (optional) The width of the thumbnail, in pixels. If this parameter is present, $thumbnail_url and $thumbnail_height must also be present.

int $thumbnail_height: (optional) The height of the thumbnail, in pixels. If this parameter is present, $thumbnail_url and $thumbnail_width must also be present.

Return value

static

1 call to Resource::photo()

ResourceFetcher::createResource in core/modules/media/src/OEmbed/ResourceFetcher.php: Creates a Resource object from raw resource data.

File

core/modules/media/src/OEmbed/Resource.php, line 263

Class

Resource: Value object representing an oEmbed resource.

Namespace

Drupal\media\OEmbed

Code

public static function photo($url, $width, $height = NULL, Provider $provider = NULL, $title = NULL, $author_name = NULL, $author_url = NULL, $cache_age = NULL, $thumbnail_url = NULL, $thumbnail_width = NULL, $thumbnail_height = NULL) {
  if (empty($url)) {
    throw new \InvalidArgumentException('Photo resources must provide a URL.');
  }
  $resource = static::link($url, $provider, $title, $author_name, $author_url, $cache_age, $thumbnail_url, $thumbnail_width, $thumbnail_height);
  $resource->type = self::TYPE_PHOTO;
  $resource
    ->setDimensions($width, $height);
  return $resource;
}

You are here