simialbi / yii2-schema-org
Schema.org yii2 representation and helpers for json-ld generation in Yii framework
Installs: 84 828
Dependents: 4
Suggesters: 0
Security: 0
Stars: 17
Watchers: 2
Forks: 4
Open Issues: 1
Type:yii2-extension
Requires
- php: >=7.3
- yiisoft/yii2: ^2.0.5
Requires (Dev)
- composer/composer: ^2.1.9
- phpunit/phpunit: ^9.5.21
- yiisoft/yii2-coding-standards: ~2.0
README
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
$ php composer.phar require --prefer-dist simialbi/yii2-schema-org
or add
"simialbi/yii2-schema-org": "^2.0.0"
to the require
section of your composer.json
Usage
In order to use this module, you will need to:
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.
'modules' => [ 'schema' => [ 'class' => 'simialbi\yii2\schemaorg\Module', //'autoCreate' => false, //'autoRender' => false ] ]
Also add the module schema
to the bootstrap section of your configuration file:
'bootstrap' => ['log', 'schema']
If you don't use autoRender
, be sure to manually call JsonLDHelper::render()
in your layout file, like so:
<?php /* @var $this \yii\web\View */ /* @var $content string */ use yii\helpers\Html; use app\assets\AppAsset; use simialbi\yii2\schemaorg\helpers\JsonLDHelper; AppAsset::register($this); ?> <?php $this->beginPage() ?> <!DOCTYPE html> <html lang="<?= Yii::$app->language ?>"> <head> <meta charset="<?= Yii::$app->charset ?>"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> <?= Html::csrfMetaTags() ?> <title><?= Html::encode($this->title) ?></title> <?php JsonLDHelper::render(); ?> <?php $this->head() ?> </head>
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
.
$ php yii schema/models/generate
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:
$ php yii schema/models/generate 'latest' --schemas=Car,AutoDealer --namespace='common\schemas' --folder='@common/schemas/'
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:
{ // [...] "require": { "yiisoft/yii2": "^2.0.13", "simialbi/yii2-schema-org": "^2.0.0" }, "scripts": { "post-update-cmd": [ "simialbi\\yii2\\schemaorg\\composer\\Installer::postInstallUpdate" ] }, "extra": { "simialbi\\yii2\\schemaorg\\composer\\Installer::postInstallUpdate": { "generateModels": { "schemas": ["Car", "AutoDealer"], // optional "namespace": "common\\schemas", // optional "folder": "common/schema" // optional } } } // [...] }
Example Usage
To e.g. add a person to json+ld, you can do the following:
use simialbi\yii2\schemaorg\helpers\JsonLDHelper; use simialbi\yii2\schemaorg\models\Person; $child = new Person(); $child->name = 'George W. Bush'; $child->disambiguatingDescription = '43rd President of the United States'; $person = new Person(); $person->name = 'George Bush'; $person->disambiguatingDescription = '41st President of the United States'; $person->children = [$child]; JsonLDHelper::add($person);
License
yii2-schema-org is released under MIT license. See bundled LICENSE for details.