Download the PHP package mixerapi/json-ld-view without Composer
On this page you can find all versions of the php package mixerapi/json-ld-view. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mixerapi/json-ld-view
More information about mixerapi/json-ld-view
Files in mixerapi/json-ld-view
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package json-ld-view
MixerAPI JsonLdView
A JSON-LD View for CakePHP. Read more at MixerAPI.com.
Installation
!!! info "" You can skip this step if MixerAPI is installed.
Alternatively after composer installing you can manually load the plugin in your Application:
Setup
Setup for this plugin is very easy. Just load the RequestHandler component and create a route for contexts and
vocab. Then create a config/jsonld_config.php config file (recommended) and implement JsonLdDataInterface on your
entities.
Config (recommended)
Create a config/jsonld_config. If you skip this step then the defaults listed in the sample config will be used.
RequestHandler
Your controllers must be using the RequestHandler component. This is typically loaded in your AppController. In
most cases this is already loaded.
Routes
The contexts route displays your JSON-LD schema for an entity, while the vocab route will display all entities and additional metadata.
You should now be able see entities JSON-LD schema by browsing to /contexts/{entity-name}. For further customization
you can copy the JsonLdController into your own project.
Route Extension (optional)
If you would like to request JSON-LD by extension (e.g. /index.jsonld) you'll need to set the extension in your
config/routes.php, example:
Usage
Once setup is complete request types of application/ld+json will automatically be rendered as JSON-LD.
Entity Schema
This plugin will map basic types (int, string, decimal etc.) to their corresponding schema.org values. For instance,
int is mapped to https://schema.org/Number. You can improve the mappings by defining proper Validations on your
Table class. For instance, fields with the email rule will be mapped to https://schema.org/email. For a full list
of default mappings refer to MixerApi\JsonLdView\SchemaMapper.
You can further customize the schema mapping by implementing MixerApi\JsonLdView\JsonLdDataInterface on your
applications Entities:
Collections
We get the @id and @context properties because these Entities implement JsonLdDataInterface. This interface is
of course optional and data will return without it minus the aforementioned properties. Pagination data is added in
the view property per the Hydra PartialCollectionView
specification.
Example:
Items
Output:
Contexts
Browsing to the contexts route will display information about that entity. To fine tune to the data you will need to
implement JsonLdDataInterface. Using the Film entity as an example, the context looks like this when browsing to
/contexts/Film:
Vocab
Any entities implementing the JsonLdDataInterface will appear when browsing to the route you created for vocab (e.g. /vocab):
Sample:
Serializing
Optionally, you can manually serialize data into JSON-LD using JsonSerializer. Example:
