Content Sharing DTO

DTO is a simple object that represents a complex object in a way that can be easily passed around between different applications.

The key advantage of using DTOs lies in their ability to simplify the interaction between different applications, irrespective of their underlying technologies or platforms.

These DTOs have been designed specifically for use with the Content Sharing API.

Installation

composer config repositories.content-sharing-dto vcs https://www.github.com/immediate-media/content-sharing-dto.git
composer require immediate-media/content-sharing-dto "^1.0.0"

DTO usage examples

Recipe DTO

$recipeDTO = new RecipeDTO();

$recipeDTO->setAuthor(new Author(name: 'Firstname Lastname', email: 'example@email.com', url: 'https://www.example.com', image: 'https://www.example.com/image.jpg'));
$recipeDTO->setClientRef('ABC123');
$recipeDTO->setDrm(new DRM(status: DRM::GREEN, notes: 'Recipe can be used Worldwide'));
$recipeDTO->setLocale('en');
$recipeDTO->setSlug('example-recipe-slug');
$recipeDTO->setSiteName('Best Food Site');
$recipeDTO->setPublishedDate('2023-02-08T15:00:39+00:00');
$recipeDTO->setUpdatedDate('2023-02-08T17:00:39+00:00');
$recipeDTO->setTitle('Example Recipe');
$recipeDTO->setDescription('Example Recipe Description');
$recipeDTO->setUrl('https://www.example.com/recipe');
$recipeDTO->setIntroduction('This is an introduction to the recipe.');
$recipeDTO->setSummary('This is a summary of the recipe.');

// NB: This image is optional and can be set conditionally
$recipeDTO->setHeroImage(new Image(
    url: 'https://www.example.com/image.jpg',
    alt: 'Hero Image',
    title: 'Image title',
    width: 800, height: 600,
    drm: new DRM(status: DRM::GREEN, notes: 'Free to use worldwide', creator: 'Copyright Holder', agency: 'Copyright Agency', damId: '12345')));

// NB: This image is optional and can be set conditionally
$recipeDTO->setThumbnailImage(new Image(
    url: 'https://www.example.com/image.jpg',
    alt: 'Thumb Image',
    title: 'Image title',
    width: 80, height: 60,
    drm: new DRM(status: DRM::YELLOW, notes: 'Restricted to UK only', creator: 'Copyright Holder', agency: 'Copyright Agency',  damId: '12346')));

$recipeDTO->setIngredientsGroups(['sauce', 'pasta']);
$recipeDTO->setIngredients(new Ingredient(name: 'first Ingredient', quantity: '1.5', unit: 'kg', slug: 'my-ingredient', notes: 'My Notes', group: 'sauce'));
$recipeDTO->setIngredients(new Ingredient(name: 'second Ingredient', quantity: '2', unit: 'kg', slug: 'my-ingredient', notes: 'My Notes', group: 'pasta'));

$recipeDTO->setMethodSteps(new MethodStep(stepNumber: 1, description: 'first step'));
$recipeDTO->setMethodSteps(new MethodStep(stepNumber: 2, description: 'second step'));

$recipeDTO->setNutrition(new Nutrition(label: 'Calories', value: '100', unit: Nutrition::KCALS, high: false, low: false));
$recipeDTO->setNutrition(new Nutrition(label: 'Salt', value: '100', unit: Nutrition::GRAMS, high: false, low: false));

// NB: These tags are optional and can be set conditionally
$recipeDTO->setTags(new Tag(name: 'recipe tag 1', slug: 'recipe-tag-1', notes: 'tag notes'));
$recipeDTO->setTags(new Tag(name: 'recipe tag 2', slug: 'recipe-tag-2', notes: 'tag notes'));

$recipeDTO->setCategories(new Category(name: 'Recipes', slug: 'recipes-slug', notes: 'category notes'));
$recipeDTO->setCategories(new Category(name: 'Food', slug: 'food-slug', notes: 'category notes'));

$recipeDTO->setTiming(new Timing(cookingMax: 20, maxCookingTime: 20, cookingMin: 10, minCookingTime: 10, preparationMax: 5, maxPreparationTime: 5, preparationMin: 3, minPreparationTime: 3, note: '', total: 45, totalTime: 45));

$recipeDTO->setSkillLevel(SKILL::EASY);
$recipeDTO->setServings(4);

$recipeDTO->setCuisine(new Cuisine(name: 'British', slug: 'british-cuisine'));
$recipeDTO->setCuisine(new Cuisine(name: 'Indian', slug: 'indian-cuisine'));

$recipeDTO->setDiet(new Diet(name: 'Vegetarian', slug: 'vegetarian-diet'));
$recipeDTO->setDiet(new Diet(name: 'Vegan', slug: 'vegan-diet'));

// NB: This is optional and can be set conditionally
$recipeDTO->setSEO(new SEO(
    metaTitle: 'Example Recipe SEO Title',
    metaDescription: 'Example Recipe SEO Description',
    openGraph: new OpenGraph(
        title: 'Example Recipe OpenGraph Title',
        description: 'Example Recipe OpenGraph Description',
        image: new Image(
            url: 'https://www.example.com/og-image.jpg',
            alt: 'OpenGraph Image',
            title: 'OpenGraph Image Title',
            width: 1200,
            height: 630,
            drm: new DRM(status: DRM::GREEN, notes: 'Free to use worldwide')
        )
    )
));

// Throws exception if the DTO is not valid
$recipeDTO->validate();

// Returns the DTO as a JSON string
echo $recipeDTO->toJSON();

Recipe JSON Output

{
  "BASE_DTO_VERSION": "1.0.5",
  "RECIPE_DTO_VERSION": "1.0.6",
  "author": {
    "name": "Firstname Lastname",
    "email": "example@email.com",
    "url": "https://www.example.com",
    "image": "https://www.example.com/image.jpg"
  },
  "categories": [
    {
      "name": "Recipes",
      "slug": "recipes-slug",
      "notes": "category notes"
    },
    {
      "name": "Food",
      "slug": "food-slug",
      "notes": "category notes"
    }
  ],
  "clientRef": "ABC123",
  "cuisines": [
    {
      "name": "British",
      "slug": "british-cuisine"
    },
    {
      "name": "Indian",
      "slug": "indian-cuisine"
    }
  ],
  "description": "Example Recipe Description",
  "diets": [
    {
      "name": "Vegetarian",
      "slug": "vegetarian-diet"
    },
    {
      "name": "Vegan",
      "slug": "vegan-diet"
    }
  ],
  "drm": {
    "status": 1,
    "notes": "Recipe can be used Worldwide",
    "creator": "unknown",
    "agency": "unknown",
    "damId": ""
  },
  "embedImages": [],
  "heroImage": {
    "url": "https://www.example.com/image.jpg",
    "alt": "Hero Image",
    "title": "Image title",
    "width": 800,
    "height": 600,
    "isUpscaled": false,
    "isPlaceholder": false,
    "srcImage": "https://www.example.com/src-image.jpg",
    "exif": {
      "camera": "Canon EOS 5D Mark IV",
      "lens": "EF24-70mm f/2.8L II USM"
    },
    "labels": [
      "food",
      "recipe"
    ],
    "objects": [
      "plate",
      "fork"
    ],
    "assetId": "CS-12345",
    "drm": {
      "status": 1,
      "notes": "Free to use worldwide",
      "creator": "Copyright Holder",
      "agency": "Copyright Agency",
      "damId": "12345"
    }
  },
  "ingredients": [
    {
      "name": "first Ingredient",
      "quantity": "1.5",
      "unit": "kg",
      "slug": "my-ingredient",
      "notes": "My Notes",
      "group": "sauce"
    },
    {
      "name": "second Ingredient",
      "quantity": "2",
      "unit": "kg",
      "slug": "my-ingredient",
      "notes": "My Notes",
      "group": "pasta"
    }
  ],
  "ingredientsGroups": [
    "sauce",
    "pasta"
  ],
  "introduction": "Introduction to the recipe",
  "locale": "en",
  "methodSteps": [
    {
      "stepNumber": 1,
      "description": "first step"
    },
    {
      "stepNumber": 2,
      "description": "second step"
    }
  ],
  "nutrition": [
    {
      "label": "Calories",
      "value": "100",
      "unit": "kcal",
      "high": false,
      "low": false
    },
    {
      "label": "Salt",
      "value": "100",
      "unit": "g",
      "high": false,
      "low": false
    }
  ],
  "publishedDate": "2023-02-08T15:00:39+00:00",
  "servings": 4,
  "servingsDisplayText": "",
  "siteName": "Best Food Site",
  "skillLevel": "easy",
  "slug": "example-recipe-slug",
  "summary": "Summary of the recipe",
  "seo": {
    "metaTitle": "Example Recipe SEO Title",
    "metaDescription": "Example Recipe SEO Description",
    "openGraph": {
      "title": "Example Recipe OpenGraph Title",
      "description": "Example Recipe OpenGraph Description",
      "image": {
        "url": "https://www.example.com/og-image.jpg",
        "alt": "OpenGraph Image",
        "title": "OpenGraph Image Title",
        "width": 1200,
        "height": 630,
        "isUpscaled": false,
        "isPlaceholder": false,
        "srcImage": "",
        "exif": [],
        "labels": [],
        "objects": [],
        "assetId": "",
        "drm": {
          "status": 1,
          "notes": "Free to use worldwide",
          "creator": "unknown",
          "agency": "unknown",
          "damId": ""
        }
      }
    }
  },
  "tags": [
    {
      "name": "recipe tag 1",
      "slug": "recipe-tag-1",
      "notes": "tag notes"
    },
    {
      "name": "recipe tag 2",
      "slug": "recipe-tag-2",
      "notes": "tag notes"
    }
  ],
  "thumbnailImage": {
    "url": "https://www.example.com/thumb-image.jpg",
    "alt": "Thumbnail Image",
    "title": "Thumbnail Image title",
    "width": 80,
    "height": 60,
    "isUpscaled": false,
    "isPlaceholder": false,
    "srcImage": "",
    "exif": [],
    "labels": [],
    "objects": [],
    "assetId": "",
    "drm": {
      "status": 2,
      "notes": "Restricted to UK only",
      "creator": "Copyright Holder",
      "agency": "Copyright Agency",
      "damId": "12346"
    }
  },
  "timing": {
    "cookingMax": 20,
    "maxCookingTime": 20,
    "cookingMin": 10,
    "minCookingTime": 10,
    "preparationMax": 5,
    "maxPreparationTime": 5,
    "preparationMin": 3,
    "minPreparationTime": 3,
    "note": "",
    "total": 45,
    "totalTime": 45
  },
  "title": "Example Recipe",
  "trackingId": "CS-2d5bf4a54bd6a70411bbe0fd0eea85fc",
  "type": "recipe",
  "updatedDate": "2023-02-08T17:00:39+00:00",
  "url": "https://www.example.com/recipe",
  "version": 2
}

Article DTO

$articleDTO = new ArticleDTO();

$articleDTO->setAuthor(new Author(name: 'Firstname Lastname', email: 'example@email.com', url: 'https://www.example.com', image: 'https://www.example.com/image.jpg'));
$articleDTO->setClientRef('ABC123');
$articleDTO->setDrm(new DRM(status: DRM::GREEN, notes: 'Article can be used Worldwide'));
$articleDTO->setLocale('en');
$articleDTO->setSlug('example-article-slug');
$articleDTO->setSiteName('Good News Site');
$articleDTO->setPublishedDate('2023-02-08T15:00:39+00:00');
$articleDTO->setUpdatedDate('2023-02-08T17:00:39+00:00');
$articleDTO->setTitle('Example Article Title');
$articleDTO->setDescription('Example Article Description');
$articleDTO->setUrl('https://www.example.com/recipe');

// NB: This image is optional and can be set conditionally
$articleDTO->setHeroImage(new Image(
    url: 'https://www.example.com/image.jpg',
    alt: 'Hero Image',
    title: 'Image title',
    width: 800, height: 600,
    drm: new DRM(status: DRM::GREEN, notes: 'Free to use worldwide', creator: 'Copyright Holder', agency: 'Copyright Agency', damId: '12345')));

// NB: This image is optional and can be set conditionally
$articleDTO->setThumbnailImage(new Image(
    url: 'https://www.example.com/image.jpg',
    alt: 'Thumb Image',
    title: 'Image title',
    width: 80, height: 60,
    drm: new DRM(status: DRM::YELLOW, notes: 'Restricted to UK only', creator: 'Copyright Holder', agency: 'Copyright Agency', damId: '12346')));

// NB: These tags are optional and can be set conditionally
$articleDTO->setTags(new Tag(name: 'article tag 1', slug: 'article-tag-1', notes: 'optional tag notes'));
$articleDTO->setTags(new Tag(name: 'article tag 2', slug: 'article-tag-2', notes: 'optional tag notes'));

$articleDTO->setCategories(new Category(name: 'TV', slug: 'tv', notes: 'optional category notes'));
$articleDTO->setCategories(new Category(name: 'News', slug: 'news', notes: 'optional category notes'));

$articleDTO->setHtml('<p>Example Article Body with full markup</p>');
$articleDTO->setMarkdown('Example Article Body in Markdown');

$articleDTO->setEmbedImage(new Image(
    url: 'https://www.example.com/image.jpg',
    alt: 'Article Image',
    title: 'Article title',
    width: 800, height: 600,
    drm: new DRM(status: DRM::GREEN, notes: 'Free to use worldwide', creator: 'Copyright Holder', agency: 'Copyright Agency', damId: '12345')));

// NB: This is optional and can be set conditionally
$articleDTO->setSEO(new SEO(
    metaTitle: 'Example Article SEO Title',
    metaDescription: 'Example Article SEO Description',
    openGraph: new OpenGraph(
        title: 'Example Article OpenGraph Title',
        description: 'Example Article OpenGraph Description',
        image: new Image(
            url: 'https://www.example.com/og-article-image.jpg',
            alt: 'OpenGraph Article Image',
            title: 'OpenGraph Article Image Title',
            width: 1200,
            height: 630,
            drm: new DRM(status: DRM::GREEN, notes: 'Free to use worldwide')
        )
    )
));

// Throws exception if the DTO is not valid
$articleDTO->validate();

// Returns the DTO as a JSON string
echo $articleDTO->toJSON();

Article JSON Output

{
  "ARTICLE_DTO_VERSION": "1.0.1",
  "BASE_DTO_VERSION": "1.0.5",
  "author": {
    "name": "Firstname Lastname",
    "email": "example@email.com",
    "url": "https://www.example.com",
    "image": "https://www.example.com/image.jpg"
  },
  "categories": [
    {
      "name": "TV",
      "slug": "tv",
      "notes": "optional category notes"
    },
    {
      "name": "News",
      "slug": "news",
      "notes": "optional category notes"
    }
  ],
  "clientRef": "ABC123",
  "description": "Example Article Description",
  "drm": {
    "status": 1,
    "notes": "Article can be used Worldwide",
    "creator": "unknown",
    "agency": "unknown",
    "damId": ""
  },
  "embedImages": [
    {
      "url": "https://www.example.com/image.jpg",
      "alt": "Article Image",
      "title": "Article title",
      "width": 800,
      "height": 600,
      "isUpscaled": false,
      "isPlaceholder": false,
      "srcImage": "",
      "exif": [],
      "labels": [],
      "objects": [],
      "assetId": "",
      "drm": {
        "status": 1,
        "notes": "Free to use worldwide",
        "creator": "Copyright Holder",
        "agency": "Copyright Agency",
        "damId": "12345"
      }
    }
  ],
  "heroImage": {
    "url": "https://www.example.com/image.jpg",
    "alt": "Hero Image",
    "title": "Image title",
    "width": 800,
    "height": 600,
    "isUpscaled": false,
    "isPlaceholder": false,
    "srcImage": "https://www.example.com/src-image.jpg",
    "exif": {
      "camera": "Canon EOS 5D Mark IV",
      "lens": "EF24-70mm f/2.8L II USM"
    },
    "labels": [
      "food",
      "recipe"
    ],
    "objects": [
      "plate",
      "fork"
    ],
    "assetId": "asset-12345",
    "drm": {
      "status": 1,
      "notes": "Free to use worldwide",
      "creator": "Copyright Holder",
      "agency": "Copyright Agency",
      "damId": "12345"
    }
  },
  "html": "<p>Example Article Body with full markup</p>",
  "locale": "en",
  "publishedDate": "2023-02-08T15:00:39+00:00",
  "siteName": "Good News Site",
  "slug": "example-article-slug",
  "seo": {
    "metaTitle": "Example Article SEO Title",
    "metaDescription": "Example Article SEO Description",
    "openGraph": {
      "title": "Example Article OpenGraph Title",
      "description": "Example Article OpenGraph Description",
      "image": {
        "url": "https://www.example.com/og-article-image.jpg",
        "alt": "OpenGraph Article Image",
        "title": "OpenGraph Article Image Title",
        "width": 1200,
        "height": 630,
        "isUpscaled": false,
        "isPlaceholder": false,
        "srcImage": "",
        "exif": [],
        "labels": [],
        "objects": [],
        "assetId": "",
        "drm": {
          "status": 1,
          "notes": "Free to use worldwide",
          "creator": "unknown",
          "agency": "unknown",
          "damId": ""
        }
      }
    }
  },
  "tags": [
    {
      "name": "article tag 1",
      "slug": "article-tag-1",
      "notes": "optional tag notes"
    },
    {
      "name": "article tag 2",
      "slug": "article-tag-2",
      "notes": "optional tag notes"
    }
  ],
  "text": "Example Article Body with full markup",
  "thumbnailImage": {
    "url": "https://www.example.com/thumb-image.jpg",
    "alt": "Thumbnail Image",
    "title": "Thumbnail Image title",
    "width": 80,
    "height": 60,
    "isUpscaled": false,
    "isPlaceholder": false,
    "srcImage": "",
    "exif": [],
    "labels": [],
    "objects": [],
    "assetId": "",
    "drm": {
      "status": 2,
      "notes": "Restricted to UK only",
      "creator": "Copyright Holder",
      "agency": "Copyright Agency",
      "damId": "12346"
    }
  },
  "title": "Example Article Title",
  "trackingId": "CS-2d5bf4a54bd6a70411bbe0fd0eea85fc",
  "type": "article",
  "updatedDate": "2023-02-08T17:00:39+00:00",
  "url": "https://www.example.com/recipe",
  "version": 3
}

Map JSON to DTO

Map received JSON to DTO

$recipeDTO = new RecipeDTO();
$recipeDTO->map($jsonData);
$recipeDTO->validate();

Name		Name	Last commit message	Last commit date
Latest commit History 93 Commits
src		src
tests		tests
.gitignore		.gitignore
Example.php		Example.php
README.md		README.md
composer.json		composer.json
composer.lock		composer.lock
phpunit.xml		phpunit.xml

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Content Sharing DTO

Installation

DTO usage examples

Recipe DTO

Article DTO

Map JSON to DTO

About

Uh oh!

Releases 19

Packages

Uh oh!

Uh oh!

Contributors

Uh oh!

Languages

Folders and files

Latest commit

History

Repository files navigation

Content Sharing DTO

Installation

DTO usage examples

Recipe DTO

Article DTO

Map JSON to DTO

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases 19

Packages 0

Uh oh!

Uh oh!

Contributors

Uh oh!

Languages

Packages