-
Notifications
You must be signed in to change notification settings - Fork 12
/
LinkPreview.php
106 lines (92 loc) · 2.29 KB
/
LinkPreview.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
<?php
namespace yii2mod\linkpreview;
use yii\base\InvalidConfigException;
use yii\base\Widget;
use yii\helpers\Json;
/**
* LinkPreview widget renders page preview
*
* ~~~
* 1. Define preview action in your controller:
* public function actions()
* {
* return [
* 'link-preview' => \yii2mod\linkpreview\actions\LinkPreview::className()
* ];
* }
*
* 2. Add widget to your page as follows:
* echo \yii2mod\linkpreview\LinkPreview::widget([
* 'selector' => '#your-input-id or .someclass',
* 'clientOptions' => [
* 'previewActionUrl' => \yii\helpers\Url::to(['link-preview'])
* ],
* ])
* ~~~
*/
class LinkPreview extends Widget
{
/**
* @var string input selector
*/
public $selector;
/**
* Template view name
*
* @var string
*/
public $view = 'template';
/**
* @var array
*/
public $clientOptions = [];
/**
* @var string pjax container id
*/
public $pjaxContainerId = 'link-preview-container';
/**
* Init function
*/
public function init()
{
parent::init();
if (empty($this->id)) {
throw new InvalidConfigException("The 'id' property is required.");
}
if (empty($this->pjaxContainerId)) {
throw new InvalidConfigException("The 'pjaxContainerId' property is required.");
}
$this->registerAssets();
}
/**
* Executes the widget.
*
* @return string the result of widget execution to be outputted
*/
public function run()
{
return $this->render($this->view, [
'pjaxContainerId' => $this->pjaxContainerId,
]);
}
/**
* Register assets
*/
protected function registerAssets()
{
$view = $this->getView();
LinkPreviewAsset::register($view);
$options = $this->getClientOptions();
$view->registerJs("$('{$this->selector}').linkPreview({$options});", $view::POS_END);
}
/**
* Get client options
*
* @return string
*/
protected function getClientOptions()
{
$this->clientOptions['pjaxContainer'] = '#' . $this->pjaxContainerId;
return Json::encode($this->clientOptions);
}
}