Download the PHP package simialbi/yii2-schema-org without Composer
On this page you can find all versions of the php package simialbi/yii2-schema-org. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download simialbi/yii2-schema-org
More information about simialbi/yii2-schema-org
Files in simialbi/yii2-schema-org
Package yii2-schema-org
Short Description Schema.org yii2 representation and helpers for json-ld generation in Yii framework
License MIT
Informations about the package yii2-schema-org
yii2-schema-org
Schema.org yii2 representation and helpers for json-ld generation.
Resources
- JSON-LD documentation
- Google Structured Data Testing Tool
Installation
The preferred way to install this extension is through composer.
Either run
or add
to the section of your composer.json
Usage
In order to use this module, you will need to:
- Configure your application so that the module is available.
- Generate the Schemas you intend to use.
Setup Module
Configure the module named schema
in the modules section of your Yii configuration file.
Remember to do this for console and for web application configuration file.
Also add the module schema
to the bootstrap section of your configuration file:
Parameter | Description |
---|---|
autoCreate |
Automatically create breadcrumbs json+ld data. |
autoRender |
Automatically render json+ld data at the end of body section. |
mergeModels |
Merge models into one script tag instead of rendering one for each of them. |
If you don't use autoRender
, be sure to manually call JsonLDHelper::render()
in your layout file, like so:
Model generation
Minimal (standard) configuration
Without passing any parameters all schemas will be generated in the folder @vendor/simialbi/yii2-schema-org/src/models
.
The namespace of the models will be simialbi\yii2\schemaorg\models
.
Customized
If you want to customize the namespace and path you can do it via --namespace
and --folder
parameters. E.g. to generate
schemas Car
and AutoDealer
in common/schemas
with common\schemas
namespace:
Parameter | Description |
---|---|
version |
The schemas.org version to use. Defaults to latest |
--schemas |
A comma separated list of schemas you intend to use. Empty means all. Defaults to [] |
--namespace |
The namespace to use for the generated classes and traits. Defaults to simialbi\yii2\schemaorg\models |
--folder |
The folder where to put the generated files. Defaults to @simialbi/yii2/schemaorg/src/models |
--remove-old |
Whether to remove old files before generating. Defaults to false |
The console command will take care of computing schemas dependencies and will generate the classes based on your needs.
Automatic model update on composer update
If you'd like to always update your schema when you run composer update
you can configure your composer.json like this:
Example Usage
To e.g. add a person to json+ld, you can do the following:
License
yii2-schema-org is released under MIT license. See bundled LICENSE for details.