melting-server/schema-dot-org-laravel

Provides melting-server/schema-dot-org-tree into laravel.

Maintainers

Details

github.com/melting-server/schema-dot-org-laravel

Homepage

Source

Issues

Installs: 0

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 0

dev-master 2019-11-10 20:26 UTC

Requires

MIT f14512805c48567500a4dbbd1cb27bc5ecaaac6a

  • Jason Steelman

This package is auto-updated.

Last update: 2024-04-11 13:38:24 UTC

README

This library grabs and parses Schema.org into a structured array for Laravel 5+ which is cached according to your application's caching preferences.

https://github.com/spatie/schema-org is a more friendly tool for using Schema.org within your IDE. Spatie's schema tool comes with IDE autocomplete and loads of other goodies to help you work with Schema.org.

Install

composer require melting-server\schema-dot-org-laravel

Optional | You can publish the configuration file to tweak the caching settings.

php artisan vendor:publish --provider="Schema\SchemaServiceProvider"

Usage

Initialize:

use SchemaDotOrgTree\Tree;

$tree = app()->make(Tree::class);

By default, the first time the application builds the tree - it will download the jsonld from schema.org's github repository and parse it into a tree. The tree is then cached within the application (however you've setup your default Laravel caching). The whole process takes ~2seconds but its cached anyway to be nice.

The Tree

//For the latest schema.org (default):
$tree = new Tree(); 

//For "all" of the latest schemas:
$tree = new Tree('5.0-all');

//For a specific version:
$tree = new Tree('3.7-core');

You can now access the structured tree:

var_dump($tree->getTree()); //Structured tree

Entities

Get an entity:

$entity = $tree->getEntity("http://schema.org/Thing");

Entities can have a parent Entity and may have children Entities:

$parent = $entity->getParent(); // returns Entity or null
$children = $entity->getChildren(); // returns Entity[] (the array might be empty)

You can test to see if an Entity exists anywhere in the tree:

$tree->isLocatable("http://schema.org/Thing");

Entities provide these public properties (not to be confused with the Entity's Schema Properties, below):

// The Entity Property            The schema.org "field"
public $id;                    // from "@id"
public $type;                  // from "@type"
public $supersededBy;          // from "http://schema.org/supersededBy"
public $comment;               // from "rdfs:comment"
public $label;                 // from "rdfs:label"
public $subClassOf;            // from "rdfs:subClassOf"
public $purlSource;            // from "http://purl.org/dc/terms/source"
public $owlEquivalentProperty; // from "http://www.w3.org/2002/07/owl#equivalentClass"
public $category;              // from "http://schema.org/category"
public $closeMatch;            // from "http://www.w3.org/2004/02/skos/core#closeMatch"

/** @var string $version */
public $version;

/** @var Entity[] */
public $children = [];

/** @var Property[] */
public $properties = [];

Properties

Get an entity's properties

$properties = $entity->getProperties();      //with inherited properties
$properties = $entity->getProperties(false); //without inherited properties

Properties provide these public properties

// The Entity Property            The schema.org "field"
public $id;                       // from @id
public $type;                     // from @type
public $domainIncludes = [];      // from http://schema.org/domainIncludes
public $rangeIncludes = [];       // from http://schema.org/rangeIncludes
public $comment = "";             // from rdfs:comment
public $label = "";               // from rdfs:label
public $purlSource;               // from http://purl.org/dc/terms/source
public $owlEquivalentProperty;    // from http://www.w3.org/2002/07/owl#equivalentProperty
public $subPropertyOf;            // from rdfs:subPropertyOf
public $category;                 // from http://schema.org/category
public $inverseOf;                // from http://schema.org/inverseOf
public $supersededBy;             // from http://schema.org/supersededBy

/** @var string */
public $version;

/** @var bool */
public $inherited;

Advanced Usage

Most developers should probably not need these things, but you're your own person.

Reader Data

Access the underlying json data from schema.org via

$tree->reader->getJson();

Multiple Version Support

Specify the version you wish by using the config file which will outline an environment variable (.env) you can use.

SCHEMA_DOT_ORG_VERSION=3.7-all

You can get a list of the available versions with:

$tree->reader::VERSIONS

Currently supported versions:

You can compare versions to see what is included/excluded between versions. Most implementations should just stick with the default "latest".

new Tree('latest');
new Tree('4.0-core');
new Tree('3.7-core');
var_dump(Tree::$trees);

/** 
Outputs: [
    'latest' => {Tree}
    '4.0-core' => {Tree}
    '3.7-core' => {Tree}
]
*/

With multiple trees in memory, you can retrieve specfic entities from specific versions.

$entity = Tree::getEntityReference('latest', 'http://schema.org/Thing');

Each class/property/dataType is loaded with knowledge about which version from which it was loaded.

$entity->version;