chamilo
/
chamilo-lms
mirror of https://github.com/chamilo/chamilo-lms/tree/1.11.x
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Plugin: TopLinks: Start plugin - refs BT#18747

Browse Source
pull/3831/head
Angel Fernando Quiroz Campos 5 years ago
parent 625f18428e
commit e596b0b50d
8 changed files with 503 additions and 0 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 178
      plugin/toplinks/admin.php
  2. 2
      plugin/toplinks/index.php
  3. 6
      plugin/toplinks/lang/english.php
  4. 5
      plugin/toplinks/plugin.php
  5. 26
      plugin/toplinks/src/Entity/Repository/TopLinkRepository.php
  6. 145
      plugin/toplinks/src/Entity/TopLink.php
  7. 96
      plugin/toplinks/src/LinkForm.php
  8. 45
      plugin/toplinks/src/TopLinksPlugin.php

178
plugin/toplinks/admin.php
Unescape View File

@ -0,0 +1,178 @@
<?php
/* For license terms, see /license.txt */
use Chamilo\PluginBundle\Entity\TopLinks\TopLink;
use Chamilo\PluginBundle\TopLinks\Form\LinkForm as TopLinkForm;
require_once __DIR__.'/../../main/inc/global.inc.php';
api_protect_admin_script();
$plugin = TopLinksPlugin::create();
$httpRequest = \Symfony\Component\HttpFoundation\Request::createFromGlobals();
$pageBaseUrl = api_get_self();
$em = Database::getManager();
$linkRepo = $em->getRepository(TopLink::class);
$pageActions = Display::url(
Display::return_icon('back.png', get_lang('Back'), [], ICON_SIZE_MEDIUM),
$pageBaseUrl
);
$pageContent = '';
$interbreadcrumb[] = [
'name' => get_lang('Administration'),
'url' => api_get_path(WEB_CODE_PATH).'admin/index.php',
];
$interbreadcrumb[] = ['name' => $plugin->get_title(), 'url' => $pageBaseUrl];
switch ($httpRequest->query->getAlpha('action', 'list')) {
case 'list':
default:
array_pop($interbreadcrumb); // Only show link to administration in breadcrumb
$pageActions = Display::url(
Display::return_icon('add.png', get_lang('AddLink'), [], ICON_SIZE_MEDIUM),
"$pageBaseUrl?".http_build_query(['action' => 'add'])
);
$table = new SortableTable(
'toplinks',
function () use ($linkRepo) {
return $linkRepo->count([]);
},
function ($offset, $limit, $column, $direction) use ($linkRepo) {
$links = $linkRepo->all($offset, $limit, $column, $direction);
return array_map(
function (TopLink $link) {
return [
[$link->getTitle(), $link->getUrl()],
$link->getId(),
];
},
$links
);
},
0
);
$table->set_header(0, get_lang('LinkName'));
$table->set_header(1, get_lang('Actions'), false, ['class' => 'th-head text-right'], ['class' => 'text-right']);
$table->set_column_filter(
0,
function (array $params) {
[$title, $url] = $params;
return "$title<br>".Display::url($url, $url);
}
);
$table->set_column_filter(
1,
function (int $id) use ($pageBaseUrl) {
return Display::url(
Display::return_icon('edit.png', get_lang('Edit')),
"$pageBaseUrl?".http_build_query(['action' => 'edit', 'link' => $id])
)
.PHP_EOL
.Display::url(
Display::return_icon('delete.png', get_lang('Delete')),
"$pageBaseUrl?".http_build_query(['action' => 'delete', 'link' => $id])
);
}
);
$pageContent = $table->return_table();
break;
case 'add':
$form = new TopLinkForm();
$form->createElements();
if ($form->validate()) {
$values = $form->exportValues();
$link = new TopLink();
$link
->setTitle($values['title'])
->setUrl($values['url'])
->setTarget($values['target']);
$em->persist($link);
$em->flush();
Display::addFlash(
Display::return_message(get_lang('LinkAdded'), 'success')
);
header("Location: $pageBaseUrl");
exit;
}
$pageContent = $form->returnForm();
break;
case 'edit':
$link = $em->find(TopLink::class, $httpRequest->query->getInt('link'));
if (null === $link) {
Display::addFlash(
Display::return_message(get_lang('NotFound'), 'error')
);
header("Location: $pageBaseUrl");
exit;
}
$form = new TopLinkForm($link);
$form->createElements();
if ($form->validate()) {
$values = $form->exportValues();
$link
->setTitle($values['title'])
->setUrl($values['url'])
->setTarget($values['target']);
$em->persist($link);
$em->flush();
Display::addFlash(
Display::return_message(get_lang('LinkModded'), 'success')
);
header("Location: $pageBaseUrl");
exit;
}
$form->setDefaults();
$pageContent = $form->returnForm();
break;
case 'delete':
$link = $em->find(TopLink::class, $httpRequest->query->getInt('link'));
if (null === $link) {
Display::addFlash(
Display::return_message(get_lang('NotFound'), 'error')
);
header("Location: $pageBaseUrl");
exit;
}
$em->remove($link);
$em->flush();
Display::addFlash(
Display::return_message(get_lang('LinkDeleted'), 'success')
);
header("Location: $pageBaseUrl");
exit;
}
$view = new Template($plugin->get_title());
$view->assign('actions', Display::toolbarAction('xapi_actions', [$pageActions]));
$view->assign('content', $pageContent);
$view->display_one_col_template();

2
plugin/toplinks/index.php
Unescape View File

@ -0,0 +1,2 @@
<?php

6
plugin/toplinks/lang/english.php
Unescape View File

@ -0,0 +1,6 @@
<?php
/* For license terms, see /license.txt */
$strings['plugin_title'] = 'Top Links';
$strings['plugin_comment'] = 'Create links in all courses.';

5
plugin/toplinks/plugin.php
Unescape View File

@ -0,0 +1,5 @@
<?php
/* For license terms, see /license.txt */
$plugin_info = TopLinksPlugin::create()->get_info();

26
plugin/toplinks/src/Entity/Repository/TopLinkRepository.php
Unescape View File

@ -0,0 +1,26 @@
<?php
/* For license terms, see /license.txt */
namespace Chamilo\PluginBundle\Entity\TopLinks\Repository;
use Doctrine\ORM\EntityRepository;
/**
* Class TopLinkRepository.
*
* @package Chamilo\PluginBundle\Entity\TopLinks
*/
class TopLinkRepository extends EntityRepository
{
public function all($offset, $limit, $column, $direction): array
{
$orderBy = ['title' => $direction];
if (1 == $column) {
$orderBy = ['url' => $direction];
}
return parent::findBy([], $orderBy, $limit, $offset);
}
}

145
plugin/toplinks/src/Entity/TopLink.php
Unescape View File

@ -0,0 +1,145 @@
<?php
/* For license terms, see /license.txt */
namespace Chamilo\PluginBundle\Entity\TopLinks;
use Doctrine\ORM\Mapping as ORM;
/**
* Class TopLink.
*
* @package Chamilo\PluginBundle\Entity\TopLinks
*
* @ORM\Table(name="toplinks_link")
* @ORM\Entity(repositoryClass="Chamilo\PluginBundle\Entity\TopLinks\Repository\TopLinkRepository")
*/
class TopLink
{
/**
* @var int
*
* @ORM\Column(type="integer", name="id")
* @ORM\Id()
* @ORM\GeneratedValue()
*/
private $id;
/**
* @var string
*
* @ORM\Column(name="title", type="string")
*/
private $title;
/**
* @var string
*
* @ORM\Column(name="url", type="text")
*/
private $url;
/**
* @var string
*
* @ORM\Column(name="target", type="string", length=10, options={"default":"_blank"})
*/
private $target;
/**
* @var string
*
* @ORM\Column(name="icon", type="string", nullable=true)
*/
private $icon;
public function __construct()
{
$this->target = '_blank';
$this->icon = null;
}
/**
* @return int
*/
public function getId(): int
{
return $this->id;
}
/**
* @return string
*/
public function getTitle(): string
{
return $this->title;
}
/**
* @param string $title
*
* @return TopLink
*/
public function setTitle(string $title): TopLink
{
$this->title = $title;
return $this;
}
/**
* @return string
*/
public function getUrl(): string
{
return $this->url;
}
/**
* @param string $url
*
* @return TopLink
*/
public function setUrl(string $url): TopLink
{
$this->url = $url;
return $this;
}
/**
* @return string
*/
public function getTarget(): string
{
return $this->target;
}
/**
* @param string $target
*
* @return TopLink
*/
public function setTarget(string $target): TopLink
{
$this->target = $target;
return $this;
}
/**
* @return string
*/
public function getIcon(): string
{
return $this->icon;
}
/**
* @param string $icon
*
* @return TopLink
*/
public function setIcon(string $icon): TopLink
{
$this->icon = $icon;
return $this;
}
}

96
plugin/toplinks/src/LinkForm.php
Unescape View File

@ -0,0 +1,96 @@
<?php
/* For license terms, see /license.txt */
namespace Chamilo\PluginBundle\TopLinks\Form;
use Chamilo\PluginBundle\Entity\TopLinks\TopLink;
use FormValidator;
use Security;
/**
* Class LinkForm.
*
* @package Chamilo\PluginBundle\TopLinks\Form
*/
class LinkForm extends FormValidator
{
/**
* @var TopLink
*/
private $link;
/**
* LinkForm constructor.
*
* @param \Chamilo\PluginBundle\Entity\TopLinks\TopLink|null $link
*/
public function __construct(TopLink $link = null)
{
$this->link = $link;
$actionParams = [
'action' => 'add',
'sec_token' => Security::get_existing_token(),
];
if ($this->link) {
$actionParams['action'] = 'edit';
$actionParams['link'] = $this->link->getId();
}
$action = api_get_self().'?'.http_build_query($actionParams);
parent::__construct('frm_link', 'post', $action, '');
}
public function validate(): bool
{
return parent::validate() && Security::check_token('get');
}
public function exportValues($elementList = null)
{
Security::clear_token();
return parent::exportValues($elementList);
}
public function createElements()
{
if ($this->link) {
$this->addHeader(get_lang('LinkMod'));
} else {
$this->addHeader(get_lang('LinkAdd'));
}
$this->addText('title', get_lang('LinkName'));
$this->addUrl('url', 'URL');
$this->addRule('url', get_lang('GiveURL'), 'url');
$this->addSelect(
'target',
[
get_lang('LinkTarget'),
get_lang('AddTargetOfLinkOnHomepage'),
],
[
'_blank' => get_lang('LinkOpenBlank'),
'_self' => get_lang('LinkOpenSelf'),
]
);
$this->addButtonSave(get_lang('SaveLink'), 'submitLink');
}
public function setDefaults($defaultValues = null, $filter = null)
{
$defaults = [];
if ($this->link) {
$defaults['title'] = $this->link->getTitle();
$defaults['url'] = $this->link->getUrl();
$defaults['target'] = $this->link->getTarget();
}
parent::setDefaults($defaults, null);
}
}

45
plugin/toplinks/src/TopLinksPlugin.php
Unescape View File

@ -0,0 +1,45 @@
<?php
/* For license terms, see /license.txt */
/**
* Class TopLinksPlugin.
*/
class TopLinksPlugin extends Plugin
{
/**
* TopLinksPlugin constructor.
*/
protected function __construct()
{
$settings = [
'enable' => 'boolean',
];
parent::__construct(
'0.1',
'Angel Fernando Quiroz Campos <angel.quiroz@beeznest.com>',
$settings
);
}
/**
* @return \TopLinksPlugin
*/
public static function create(): TopLinksPlugin
{
static $result = null;
return $result ? $result : $result = new self();
}
/**
* {@inheritdoc}
*/
public function getAdminUrl()
{
$webPath = api_get_path(WEB_PLUGIN_PATH).$this->get_name();
return "$webPath/admin.php";
}
}
Write Preview
Loading…
Cancel
Save