initial commit
This commit is contained in:
Brandon Shipley
commit
89c6d6d867
|
|
@ -0,0 +1,9 @@
|
|||
/composer.lock
|
||||
/composer.phar
|
||||
/phpunit.xml
|
||||
/.phpunit.result.cache
|
||||
/.phpunit.cache
|
||||
/phpunit.phar
|
||||
/config/Migrations/schema-dump-default.lock
|
||||
/vendor/
|
||||
/.idea/
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
# CakeHtmx plugin for CakePHP
|
||||
|
||||
## Installation
|
||||
|
||||
You can install this plugin into your CakePHP application using [composer](https://getcomposer.org).
|
||||
|
||||
The recommended way to install composer packages is:
|
||||
|
||||
```
|
||||
composer require your-name-here/cake-htmx
|
||||
```
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
{
|
||||
"name": "hi-powered-dev/cake-htmx",
|
||||
"description": "CakeHtmx plugin for CakePHP",
|
||||
"type": "cakephp-plugin",
|
||||
"license": "MIT",
|
||||
"require": {
|
||||
"php": ">=8.1",
|
||||
"cakephp/cakephp": "^5.0.1"
|
||||
},
|
||||
"require-dev": {
|
||||
"phpunit/phpunit": "^10.1"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"CakeHtmx\\": "src/"
|
||||
}
|
||||
},
|
||||
"autoload-dev": {
|
||||
"psr-4": {
|
||||
"CakeHtmx\\Test\\": "tests/",
|
||||
"Cake\\Test\\": "vendor/cakephp/cakephp/tests/"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
<?php
|
||||
// The following configs can be globally configured, copy the array content over to your ROOT/config
|
||||
|
||||
return [
|
||||
'CakeHtmx' => [
|
||||
'boostLinks' => true,
|
||||
'usePaginator' => true,
|
||||
],
|
||||
];
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
<?php
|
||||
use Cake\Core\Configure;
|
||||
|
||||
$paginatorContainer = Configure::read('CakeHtmx.paginatorContainer', '#table-container');
|
||||
$hxTarget = 'hx-target="' . $paginatorContainer . '" ';
|
||||
|
||||
return [
|
||||
'nextActive' => '<li class="next"><a rel="next" href="javascript:void(0);" hx-get="{{url}}" ' . $hxTarget . '>{{text}}</a></li>',
|
||||
'nextDisabled' => '<li class="next disabled"><a href="" onclick="return false;">{{text}}</a></li>',
|
||||
'prevActive' => '<li class="prev"><a rel="prev" href="javascript:void(0);" hx-get="{{url}}" ' . $hxTarget . '>{{text}}</a></li>',
|
||||
'prevDisabled' => '<li class="prev disabled"><a href="" onclick="return false;">{{text}}</a></li>',
|
||||
'counterRange' => '{{start}} - {{end}} of {{count}}',
|
||||
'counterPages' => '{{page}} of {{pages}}',
|
||||
'first' => '<li class="first"><a href="javascript:void(0);" hx-get="{{url}}" ' . $hxTarget . '>{{text}}</a></li>',
|
||||
'last' => '<li class="last"><a href="javascript:void(0);" hx-get="{{url}}" ' . $hxTarget . '>{{text}}</a></li>',
|
||||
'number' => '<li><a href="javascript:void(0);" hx-get="{{url}}" ' . $hxTarget . '>{{text}}</a></li>',
|
||||
'current' => '<li class="active"><a href="" onclick="return false;">{{text}}</a></li>',
|
||||
'ellipsis' => '<li class="ellipsis">…</li>',
|
||||
'sort' => '<a href="javascript:void(0);" hx-get="{{url}}" ' . $hxTarget . '>{{text}}</a>',
|
||||
'sortAsc' => '<a class="asc" href="javascript:void(0);" hx-get="{{url}}" ' . $hxTarget . '>{{text}}</a>',
|
||||
'sortDesc' => '<a class="desc" href="javascript:void(0);" hx-get="{{url}}" ' . $hxTarget . '>{{text}}</a>',
|
||||
'sortAscLocked' => '<a class="asc locked" href="javascript:void(0);" hx-get="{{url}}" ' . $hxTarget . '>{{text}}</a>',
|
||||
'sortDescLocked' => '<a class="desc locked" href="javascript:void(0);" hx-get="{{url}}" ' . $hxTarget . '>{{text}}</a>',
|
||||
];
|
||||
|
|
@ -0,0 +1,30 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<phpunit
|
||||
colors="true"
|
||||
processIsolation="false"
|
||||
stopOnFailure="false"
|
||||
bootstrap="tests/bootstrap.php"
|
||||
>
|
||||
<php>
|
||||
<ini name="memory_limit" value="-1"/>
|
||||
<ini name="apc.enable_cli" value="1"/>
|
||||
</php>
|
||||
|
||||
<!-- Add any additional test suites you want to run here -->
|
||||
<testsuites>
|
||||
<testsuite name="CakeHtmx">
|
||||
<directory>tests/TestCase/</directory>
|
||||
</testsuite>
|
||||
</testsuites>
|
||||
|
||||
<!-- Setup fixture extension -->
|
||||
<extensions>
|
||||
<bootstrap class="Cake\TestSuite\Fixture\Extension\PHPUnitExtension"/>
|
||||
</extensions>
|
||||
|
||||
<source>
|
||||
<include>
|
||||
<directory suffix=".php">src/</directory>
|
||||
</include>
|
||||
</source>
|
||||
</phpunit>
|
||||
|
|
@ -0,0 +1,93 @@
|
|||
<?php
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace CakeHtmx;
|
||||
|
||||
use Cake\Console\CommandCollection;
|
||||
use Cake\Core\BasePlugin;
|
||||
use Cake\Core\ContainerInterface;
|
||||
use Cake\Core\PluginApplicationInterface;
|
||||
use Cake\Http\MiddlewareQueue;
|
||||
use Cake\Routing\RouteBuilder;
|
||||
|
||||
/**
|
||||
* Plugin for CakeHtmx
|
||||
*/
|
||||
class CakeHtmxPlugin extends BasePlugin
|
||||
{
|
||||
/**
|
||||
* Load all the plugin configuration and bootstrap logic.
|
||||
*
|
||||
* The host application is provided as an argument. This allows you to load
|
||||
* additional plugin dependencies, or attach events.
|
||||
*
|
||||
* @param \Cake\Core\PluginApplicationInterface $app The host application
|
||||
* @return void
|
||||
*/
|
||||
public function bootstrap(PluginApplicationInterface $app): void
|
||||
{
|
||||
}
|
||||
|
||||
/**
|
||||
* Add routes for the plugin.
|
||||
*
|
||||
* If your plugin has many routes and you would like to isolate them into a separate file,
|
||||
* you can create `$plugin/config/routes.php` and delete this method.
|
||||
*
|
||||
* @param \Cake\Routing\RouteBuilder $routes The route builder to update.
|
||||
* @return void
|
||||
*/
|
||||
public function routes(RouteBuilder $routes): void
|
||||
{
|
||||
$routes->plugin(
|
||||
'CakeHtmx',
|
||||
['path' => '/cake-htmx'],
|
||||
function (RouteBuilder $builder) {
|
||||
// Add custom routes here
|
||||
|
||||
$builder->fallbacks();
|
||||
}
|
||||
);
|
||||
parent::routes($routes);
|
||||
}
|
||||
|
||||
/**
|
||||
* Add middleware for the plugin.
|
||||
*
|
||||
* @param \Cake\Http\MiddlewareQueue $middlewareQueue The middleware queue to update.
|
||||
* @return \Cake\Http\MiddlewareQueue
|
||||
*/
|
||||
public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue
|
||||
{
|
||||
// Add your middlewares here
|
||||
|
||||
return $middlewareQueue;
|
||||
}
|
||||
|
||||
/**
|
||||
* Add commands for the plugin.
|
||||
*
|
||||
* @param \Cake\Console\CommandCollection $commands The command collection to update.
|
||||
* @return \Cake\Console\CommandCollection
|
||||
*/
|
||||
public function console(CommandCollection $commands): CommandCollection
|
||||
{
|
||||
// Add your commands here
|
||||
|
||||
$commands = parent::console($commands);
|
||||
|
||||
return $commands;
|
||||
}
|
||||
|
||||
/**
|
||||
* Register application container services.
|
||||
*
|
||||
* @param \Cake\Core\ContainerInterface $container The Container to update.
|
||||
* @return void
|
||||
* @link https://book.cakephp.org/4/en/development/dependency-injection.html#dependency-injection
|
||||
*/
|
||||
public function services(ContainerInterface $container): void
|
||||
{
|
||||
// Add your services here
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,269 @@
|
|||
<?php
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace CakeHtmx\Command\Bake;
|
||||
|
||||
use Bake\Command\BakeCommand;
|
||||
use Bake\Command\TemplateCommand;
|
||||
use Bake\Utility\TableScanner;
|
||||
use Cake\Console\Arguments;
|
||||
use Cake\Console\ConsoleIo;
|
||||
use Cake\Core\App;
|
||||
use Cake\Core\Configure;
|
||||
use Cake\Datasource\ConnectionManager;
|
||||
use Cake\Datasource\EntityInterface;
|
||||
use Cake\Utility\Inflector;
|
||||
use Cake\View\Exception\MissingTemplateException;
|
||||
use function Cake\Core\namespaceSplit;
|
||||
|
||||
/**
|
||||
* TemplateTableElement command.
|
||||
*/
|
||||
class TableElementCommand extends TemplateCommand
|
||||
{
|
||||
/**
|
||||
* Actions to use for scaffolding
|
||||
*
|
||||
* @var array<string>
|
||||
*/
|
||||
public array $scaffoldActions = ['index'];
|
||||
/**
|
||||
* Execute the command.
|
||||
*
|
||||
* @param \Cake\Console\Arguments $args The command arguments.
|
||||
* @param \Cake\Console\ConsoleIo $io The console io
|
||||
* @return int|null The exit code or null for success
|
||||
*/
|
||||
public function execute(Arguments $args, ConsoleIo $io): ?int
|
||||
{
|
||||
$this->extractCommonProperties($args);
|
||||
$name = $args->getArgument('name') ?? '';
|
||||
$name = $this->_getName($name);
|
||||
|
||||
if (empty($name)) {
|
||||
$io->out('Possible tables to bake view templates for based on your current database:');
|
||||
/** @var \Cake\Database\Connection $connection */
|
||||
$connection = ConnectionManager::get($this->connection);
|
||||
$scanner = new TableScanner($connection);
|
||||
foreach ($scanner->listUnskipped() as $table) {
|
||||
$io->out('- ' . $this->_camelize($table));
|
||||
}
|
||||
|
||||
return static::CODE_SUCCESS;
|
||||
}
|
||||
$action = $args->getArgument('action');
|
||||
$template = 'index';
|
||||
$controller = $args->getOption('controller');
|
||||
$this->controller($args, $name, $controller);
|
||||
$this->model($name);
|
||||
|
||||
if ($template && $action === null) {
|
||||
$action = $template;
|
||||
}
|
||||
$this->bake($args, $io, $template, true, $action); // update index file
|
||||
$this->bakeElementFile($args, $io, $template, true, $action); // add/update element table file
|
||||
|
||||
return static::CODE_SUCCESS;
|
||||
}
|
||||
|
||||
/**
|
||||
* Assembles and writes bakes the view file.
|
||||
*
|
||||
* @param \Cake\Console\Arguments $args CLI arguments
|
||||
* @param \Cake\Console\ConsoleIo $io Console io
|
||||
* @param string $template Template file to use.
|
||||
* @param string|true $content Content to write.
|
||||
* @param ?string $outputFile The output file to create. If null will use `$template`
|
||||
* @return void
|
||||
*/
|
||||
public function bake(
|
||||
Arguments $args,
|
||||
ConsoleIo $io,
|
||||
string $template,
|
||||
string|bool $content = '',
|
||||
?string $outputFile = null
|
||||
): void {
|
||||
if ($outputFile === null) {
|
||||
$outputFile = $template;
|
||||
}
|
||||
if ($content === true) {
|
||||
$content = $this->getContent($args, $io, $template);
|
||||
}
|
||||
if (empty($content)) {
|
||||
// phpcs:ignore Generic.Files.LineLength
|
||||
$io->err("<warning>No generated content for '{$template}.{$this->ext}', not generating template.</warning>");
|
||||
|
||||
return;
|
||||
}
|
||||
$path = $this->getTemplatePath($args);
|
||||
$filename = $path . Inflector::underscore($outputFile) . '.' . $this->ext;
|
||||
|
||||
$io->out("\n" . sprintf('Baking `%s` view template file...', $outputFile), 1, ConsoleIo::NORMAL);
|
||||
$io->createFile($filename, $content, $this->force);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the path base for view templates.
|
||||
*
|
||||
* @param \Cake\Console\Arguments $args The arguments
|
||||
* @param string|null $container Unused.
|
||||
* @return string
|
||||
*/
|
||||
public function getElementPath(Arguments $args, ?string $container = null): string
|
||||
{
|
||||
$path = BakeCommand::getTemplatePath($args, $container) . 'element' . DS;
|
||||
$path .= $this->controllerName . DS . 'index' . DS;
|
||||
|
||||
return $path;
|
||||
}
|
||||
|
||||
/**
|
||||
* Assembles and writes bakes the view file.
|
||||
*
|
||||
* @param \Cake\Console\Arguments $args CLI arguments
|
||||
* @param \Cake\Console\ConsoleIo $io Console io
|
||||
* @param string $template Template file to use.
|
||||
* @param string|true $content Content to write.
|
||||
* @param ?string $outputFile The output file to create. If null will use `$template`
|
||||
* @return void
|
||||
*/
|
||||
public function bakeElementFile(
|
||||
Arguments $args,
|
||||
ConsoleIo $io,
|
||||
string $template,
|
||||
string|bool $content = '',
|
||||
?string $outputFile = null
|
||||
): void {
|
||||
if ($outputFile === null) {
|
||||
$outputFile = $template;
|
||||
}
|
||||
if ($content === true) {
|
||||
$content = $this->getElementContent($args, $io, $template);
|
||||
}
|
||||
if (empty($content)) {
|
||||
// phpcs:ignore Generic.Files.LineLength
|
||||
$io->err("<warning>No generated content for '{$template}.{$this->ext}', not generating template.</warning>");
|
||||
|
||||
return;
|
||||
}
|
||||
$path = $this->getElementPath($args);
|
||||
$filename = $path . 'table.' . $this->ext;
|
||||
|
||||
$io->out("\n" . sprintf('Baking `%s` view template file...', $outputFile), 1, ConsoleIo::NORMAL);
|
||||
$io->createFile($filename, $content, $this->force);
|
||||
}
|
||||
|
||||
public function getElementContent(Arguments $args, ConsoleIo $io, string $action, ?array $vars = null): string
|
||||
{
|
||||
if (!$vars) {
|
||||
$vars = $this->_loadController($io);
|
||||
}
|
||||
|
||||
if (empty($vars['primaryKey'])) {
|
||||
$io->error('Cannot generate views for models with no primary key');
|
||||
$this->abort();
|
||||
}
|
||||
|
||||
if (in_array($action, $this->excludeHiddenActions)) {
|
||||
$vars['fields'] = array_diff($vars['fields'], $vars['hidden']);
|
||||
}
|
||||
|
||||
$renderer = $this->createTemplateRenderer()
|
||||
->set('action', $action)
|
||||
->set('plugin', $this->plugin)
|
||||
->set($vars);
|
||||
|
||||
$indexColumns = 0;
|
||||
if ($action === 'index' && $args->getOption('index-columns') !== null) {
|
||||
$indexColumns = $args->getOption('index-columns');
|
||||
}
|
||||
$renderer->set('indexColumns', $indexColumns);
|
||||
|
||||
return $renderer->generate('Bake.Template/Element/table');
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads Controller and sets variables for the template
|
||||
* Available template variables:
|
||||
*
|
||||
* - 'modelObject'
|
||||
* - 'modelClass'
|
||||
* - 'entityClass'
|
||||
* - 'primaryKey'
|
||||
* - 'displayField'
|
||||
* - 'singularVar'
|
||||
* - 'pluralVar'
|
||||
* - 'singularHumanName'
|
||||
* - 'pluralHumanName'
|
||||
* - 'fields'
|
||||
* - 'keyFields'
|
||||
* - 'schema'
|
||||
*
|
||||
* @param \Cake\Console\ConsoleIo $io Instance of the ConsoleIO
|
||||
* @return array Returns variables to be made available to a view template
|
||||
*/
|
||||
protected function _loadController(ConsoleIo $io): array
|
||||
{
|
||||
if ($this->getTableLocator()->exists($this->modelName)) {
|
||||
$modelObject = $this->getTableLocator()->get($this->modelName);
|
||||
} else {
|
||||
$modelObject = $this->getTableLocator()->get($this->modelName, [
|
||||
'connectionName' => $this->connection,
|
||||
]);
|
||||
}
|
||||
|
||||
$namespace = Configure::read('App.namespace');
|
||||
|
||||
$primaryKey = $displayField = $singularVar = $singularHumanName = null;
|
||||
$schema = $fields = $hidden = $modelClass = null;
|
||||
try {
|
||||
$primaryKey = (array)$modelObject->getPrimaryKey();
|
||||
$displayField = $modelObject->getDisplayField();
|
||||
$singularVar = $this->_singularName($this->controllerName);
|
||||
$singularHumanName = $this->_singularHumanName($this->controllerName);
|
||||
$schema = $modelObject->getSchema();
|
||||
$fields = $schema->columns();
|
||||
$hidden = $modelObject->newEmptyEntity()->getHidden() ?: ['token', 'password', 'passwd'];
|
||||
$modelClass = $this->modelName;
|
||||
} catch (Exception $exception) {
|
||||
$io->error($exception->getMessage());
|
||||
$this->abort();
|
||||
}
|
||||
|
||||
[, $entityClass] = namespaceSplit($this->_entityName($this->modelName));
|
||||
$entityClass = sprintf('%s\Model\Entity\%s', $namespace, $entityClass);
|
||||
if (!class_exists($entityClass)) {
|
||||
$entityClass = EntityInterface::class;
|
||||
}
|
||||
$associations = $this->_filteredAssociations($modelObject);
|
||||
$keyFields = [];
|
||||
if (!empty($associations['BelongsTo'])) {
|
||||
foreach ($associations['BelongsTo'] as $assoc) {
|
||||
$keyFields[$assoc['foreignKey']] = $assoc['variable'];
|
||||
}
|
||||
}
|
||||
|
||||
$pluralVar = Inflector::variable($this->controllerName);
|
||||
$pluralHumanName = $this->_pluralHumanName($this->controllerName);
|
||||
$controllerName = $this->controllerName;
|
||||
return compact(
|
||||
'modelObject',
|
||||
'modelClass',
|
||||
'entityClass',
|
||||
'schema',
|
||||
'primaryKey',
|
||||
'displayField',
|
||||
'singularVar',
|
||||
'pluralVar',
|
||||
'singularHumanName',
|
||||
'pluralHumanName',
|
||||
'fields',
|
||||
'hidden',
|
||||
'associations',
|
||||
'keyFields',
|
||||
'namespace',
|
||||
'controllerName'
|
||||
);
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
<?php
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace CakeHtmx\Controller;
|
||||
|
||||
use App\Controller\AppController as BaseController;
|
||||
|
||||
class AppController extends BaseController
|
||||
{
|
||||
}
|
||||
|
|
@ -0,0 +1,140 @@
|
|||
<?php
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace CakeHtmx\Controller\Component;
|
||||
|
||||
use Cake\Controller\Component;
|
||||
use Cake\Log\Log;
|
||||
use Cake\Routing\Router;
|
||||
|
||||
/**
|
||||
* Htmx component
|
||||
*/
|
||||
class HtmxComponent extends Component
|
||||
{
|
||||
/**
|
||||
* Default configuration.
|
||||
*
|
||||
* @var array<string, mixed>
|
||||
*/
|
||||
protected array $_defaultConfig = [];
|
||||
|
||||
/**
|
||||
* @var \Cake\Controller\Controller
|
||||
*/
|
||||
protected $controller;
|
||||
|
||||
/**
|
||||
* @param array $config
|
||||
* @return void
|
||||
*/
|
||||
public function initialize(array $config): void {
|
||||
parent::initialize($config);
|
||||
|
||||
$this->controller = $this->getController();
|
||||
}
|
||||
|
||||
/**
|
||||
* Convenience method to check if request is from HTMX
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function isHtmx()
|
||||
{
|
||||
return $this->controller->getRequest()->getHeaderLine('HX-Request') === 'true';
|
||||
}
|
||||
|
||||
/**
|
||||
* Convenience method to check if request is Boosted
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function isBoosted()
|
||||
{
|
||||
return $this->controller->getRequest()->getHeaderLine('HX-Boosted') === 'true';
|
||||
}
|
||||
|
||||
/**
|
||||
* Get HTMX target id
|
||||
*
|
||||
* @return string|null
|
||||
*/
|
||||
public function getHtmxTarget()
|
||||
{
|
||||
$target = $this->controller->getRequest()->getHeaderLine('HX-Target');
|
||||
|
||||
return $target ?: null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get HTMX trigger id
|
||||
*
|
||||
* @return string|null
|
||||
*/
|
||||
public function getHtmxTrigger()
|
||||
{
|
||||
$trigger = $this->controller->getRequest()->getHeaderLine('HX-Trigger');
|
||||
|
||||
return $trigger ?: null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get HTMX trigger name
|
||||
*
|
||||
* @return string|null
|
||||
*/
|
||||
public function getHtmxTriggerName()
|
||||
{
|
||||
$trigger = $this->controller->getRequest()->getHeaderLine('HX-Trigger-Name');
|
||||
|
||||
return $trigger ?: null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set headers to cache this request.
|
||||
* Opposite of Controller::disableCache()
|
||||
*
|
||||
* @param array|string $redirectTo
|
||||
* @param bool $full if client side redirect should be a full page reload or not
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function clientSideRedirect(array|string $redirectTo, bool $full = false): void
|
||||
{
|
||||
$response = $this->controller->getResponse();
|
||||
if (is_array($redirectTo)) {
|
||||
$redirectTo = Router::url($redirectTo);
|
||||
}
|
||||
$header = $full ? 'HX-Redirect' : 'HX-Location';
|
||||
$response = $response->withHeader($header, $redirectTo);
|
||||
|
||||
$this->controller->setResponse($response);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set headers to cache this request.
|
||||
* Opposite of Controller::disableCache()
|
||||
*
|
||||
* @param array|string $redirectTo
|
||||
* @param bool $full if client side redirect should be a full page reload or not
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function clientSideRefresh(): void
|
||||
{
|
||||
$response = $this->controller->getResponse();
|
||||
$response = $response->withHeader('HX-Refresh', 'true');
|
||||
|
||||
$this->controller->setResponse($response);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return void
|
||||
*/
|
||||
public function indexHtmx()
|
||||
{
|
||||
if ($this->isHtmx() && $this->getHtmxTarget() == 'table-container') {
|
||||
return $this->render('/element/' . $this->request->getParam('controller') . '/index/table', 'ajax');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,78 @@
|
|||
{#
|
||||
/**
|
||||
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
|
||||
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
|
||||
*
|
||||
* Licensed under The MIT License
|
||||
* For full copyright and license information, please see the LICENSE.txt
|
||||
* Redistributions of files must retain the above copyright notice.
|
||||
*
|
||||
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
|
||||
* @link https://cakephp.org CakePHP(tm) Project
|
||||
* @since 2.0.0
|
||||
* @license https://www.opensource.org/licenses/mit-license.php MIT License
|
||||
*/
|
||||
#}
|
||||
<?php
|
||||
/**
|
||||
* @var \{{ namespace }}\View\AppView $this
|
||||
* @var iterable<\{{ entityClass }}> ${{ pluralVar }}
|
||||
*/
|
||||
?>
|
||||
<div id="table-container">
|
||||
<div class="table-responsive">
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
{% for field in fields %}
|
||||
<th><?= $this->Paginator->sort('{{ field }}') ?></th>
|
||||
{% endfor %}
|
||||
<th class="actions"><?= __('Actions') ?></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<?php foreach (${{ pluralVar }} as ${{ singularVar }}): ?>
|
||||
<tr>
|
||||
{% for field in fields %}
|
||||
{% set isKey = false %}
|
||||
{% if associations.BelongsTo is defined %}
|
||||
{% for alias, details in associations.BelongsTo %}
|
||||
{% if field == details.foreignKey %}
|
||||
{% set isKey = true %}
|
||||
<td><?= ${{ singularVar }}->hasValue('{{ details.property }}') ? $this->Html->link(${{ singularVar }}->{{ details.property }}->{{ details.displayField }}, ['controller' => '{{ details.controller }}', 'action' => 'view', ${{ singularVar }}->{{ details.property }}->{{ details.primaryKey[0] }}]) : '' ?></td>
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
{% if isKey is not same as(true) %}
|
||||
{% set columnData = Bake.columnData(field, schema) %}
|
||||
{% if columnData.type not in ['integer', 'float', 'decimal', 'biginteger', 'smallinteger', 'tinyinteger'] %}
|
||||
<td><?= h(${{ singularVar }}->{{ field }}) ?></td>
|
||||
{% elseif columnData.null %}
|
||||
<td><?= ${{ singularVar }}->{{ field }} === null ? '' : $this->Number->format(${{ singularVar }}->{{ field }}) ?></td>
|
||||
{% else %}
|
||||
<td><?= $this->Number->format(${{ singularVar }}->{{ field }}) ?></td>
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
{% set pk = '$' ~ singularVar ~ '->' ~ primaryKey[0] %}
|
||||
<td class="actions">
|
||||
<?= $this->Html->link(__('View'), ['action' => 'view', {{ pk|raw }}]) ?>
|
||||
<?= $this->Html->link(__('Edit'), ['action' => 'edit', {{ pk|raw }}]) ?>
|
||||
<?= $this->Form->postLink(__('Delete'), ['action' => 'delete', {{ pk|raw }}], ['confirm' => __('Are you sure you want to delete # {0}?', {{ pk|raw }})]) ?>
|
||||
</td>
|
||||
</tr>
|
||||
<?php endforeach; ?>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="paginator">
|
||||
<ul class="pagination">
|
||||
<?= $this->Paginator->first('<< ' . __('first')) ?>
|
||||
<?= $this->Paginator->prev('< ' . __('previous')) ?>
|
||||
<?= $this->Paginator->numbers() ?>
|
||||
<?= $this->Paginator->next(__('next') . ' >') ?>
|
||||
<?= $this->Paginator->last(__('last') . ' >>') ?>
|
||||
</ul>
|
||||
<p><?= $this->Paginator->counter(__('Page {{ '{{' }}page{{ '}}' }} of {{ '{{' }}pages{{ '}}' }}, showing {{ '{{' }}current{{ '}}' }} record(s) out of {{ '{{' }}count{{ '}}' }} total')) ?></p>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
{#
|
||||
/**
|
||||
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
|
||||
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
|
||||
*
|
||||
* Licensed under The MIT License
|
||||
* For full copyright and license information, please see the LICENSE.txt
|
||||
* Redistributions of files must retain the above copyright notice.
|
||||
*
|
||||
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
|
||||
* @link https://cakephp.org CakePHP(tm) Project
|
||||
* @since 2.0.0
|
||||
* @license https://www.opensource.org/licenses/mit-license.php MIT License
|
||||
*/
|
||||
#}
|
||||
<?php
|
||||
/**
|
||||
* @var \{{ namespace }}\View\AppView $this
|
||||
* @var \{{ entityClass }} ${{ singularVar }}
|
||||
{{- "\n" }}
|
||||
{%- if associations.BelongsTo is defined %}
|
||||
{%- for assocName, assocData in associations.BelongsTo %}
|
||||
* @var \Cake\Collection\CollectionInterface|string[] ${{ assocData.variable }}
|
||||
{{- "\n" }}
|
||||
{%- endfor %}
|
||||
{% endif %}
|
||||
{%- if associations.BelongsToMany is defined %}
|
||||
{%- for assocName, assocData in associations.BelongsToMany %}
|
||||
* @var \Cake\Collection\CollectionInterface|string[] ${{ assocData.variable }}
|
||||
{{- "\n" }}
|
||||
{%- endfor %}
|
||||
{% endif %}
|
||||
*/
|
||||
?>
|
||||
{{ element('Bake.form') }}
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
{#
|
||||
/**
|
||||
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
|
||||
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
|
||||
*
|
||||
* Licensed under The MIT License
|
||||
* For full copyright and license information, please see the LICENSE.txt
|
||||
* Redistributions of files must retain the above copyright notice.
|
||||
*
|
||||
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
|
||||
* @link https://cakephp.org CakePHP(tm) Project
|
||||
* @since 2.0.0
|
||||
* @license https://www.opensource.org/licenses/mit-license.php MIT License
|
||||
*/
|
||||
#}
|
||||
<?php
|
||||
/**
|
||||
* @var \{{ namespace }}\View\AppView $this
|
||||
* @var \{{ entityClass }} ${{ singularVar }}
|
||||
{{- "\n" }}
|
||||
{%- if associations.BelongsTo is defined %}
|
||||
{%- for assocName, assocData in associations.BelongsTo %}
|
||||
* @var string[]|\Cake\Collection\CollectionInterface ${{ assocData.variable }}
|
||||
{{- "\n" }}
|
||||
{%- endfor %}
|
||||
{% endif %}
|
||||
{%- if associations.BelongsToMany is defined %}
|
||||
{%- for assocName, assocData in associations.BelongsToMany %}
|
||||
* @var string[]|\Cake\Collection\CollectionInterface ${{ assocData.variable }}
|
||||
{{- "\n" }}
|
||||
{%- endfor %}
|
||||
{% endif %}
|
||||
*/
|
||||
?>
|
||||
{{ element('Bake.form') }}
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
{#
|
||||
/**
|
||||
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
|
||||
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
|
||||
*
|
||||
* Licensed under The MIT License
|
||||
* For full copyright and license information, please see the LICENSE.txt
|
||||
* Redistributions of files must retain the above copyright notice.
|
||||
*
|
||||
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
|
||||
* @link https://cakephp.org CakePHP(tm) Project
|
||||
* @since 2.0.0
|
||||
* @license https://www.opensource.org/licenses/mit-license.php MIT License
|
||||
*/
|
||||
#}
|
||||
<?php
|
||||
/**
|
||||
* @var \{{ namespace }}\View\AppView $this
|
||||
* @var iterable<\{{ entityClass }}> ${{ pluralVar }}
|
||||
*/
|
||||
?>
|
||||
<div class="{{ pluralVar }} index content">
|
||||
{% set fields = Bake.filterFields(fields, schema, modelObject, indexColumns, ['binary', 'text']) %}
|
||||
<?= $this->Html->link(__('New {{ singularHumanName }}'), ['action' => 'add'], ['class' => 'button float-right']) ?>
|
||||
{% set done = [] %}
|
||||
<h3><?= __('{{ pluralHumanName }}') ?></h3>
|
||||
<?= $this->element('{{ controllerName }}/index/table'); ?>
|
||||
</div>
|
||||
|
|
@ -0,0 +1,141 @@
|
|||
{#
|
||||
/**
|
||||
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
|
||||
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
|
||||
*
|
||||
* Licensed under The MIT License
|
||||
* For full copyright and license information, please see the LICENSE.txt
|
||||
* Redistributions of files must retain the above copyright notice.
|
||||
*
|
||||
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
|
||||
* @link https://cakephp.org CakePHP(tm) Project
|
||||
* @since 2.0.0
|
||||
* @license https://www.opensource.org/licenses/mit-license.php MIT License
|
||||
*/
|
||||
#}
|
||||
<?php
|
||||
/**
|
||||
* @var \{{ namespace }}\View\AppView $this
|
||||
* @var \{{ entityClass }} ${{ singularVar }}
|
||||
*/
|
||||
?>
|
||||
{% set associations = {'BelongsTo': [], 'HasOne': [], 'HasMany': [], 'BelongsToMany': []}|merge(associations) %}
|
||||
{% set fieldsData = Bake.getViewFieldsData(fields, schema, associations) %}
|
||||
{% set associationFields = fieldsData.associationFields %}
|
||||
{% set groupedFields = fieldsData.groupedFields %}
|
||||
{% set pK = '$' ~ singularVar ~ '->' ~ primaryKey[0] %}
|
||||
<div class="row">
|
||||
<aside class="column">
|
||||
<div class="side-nav">
|
||||
<h4 class="heading"><?= __('Actions') ?></h4>
|
||||
<?= $this->Html->link(__('Edit {{ singularHumanName }}'), ['action' => 'edit', {{ pK|raw }}], ['class' => 'side-nav-item']) ?>
|
||||
<?= $this->Form->postLink(__('Delete {{ singularHumanName }}'), ['action' => 'delete', {{ pK|raw }}], ['confirm' => __('Are you sure you want to delete # {0}?', {{ pK|raw }}), 'class' => 'side-nav-item']) ?>
|
||||
<?= $this->Html->link(__('List {{ pluralHumanName }}'), ['action' => 'index'], ['class' => 'side-nav-item']) ?>
|
||||
<?= $this->Html->link(__('New {{ singularHumanName }}'), ['action' => 'add'], ['class' => 'side-nav-item']) ?>
|
||||
{% set done = [] %}
|
||||
</div>
|
||||
</aside>
|
||||
<div class="column column-80">
|
||||
<div class="{{ pluralVar }} view content">
|
||||
<h3><?= h(${{ singularVar }}->{{ displayField }}) ?></h3>
|
||||
<table>
|
||||
{% if groupedFields['string'] %}
|
||||
{% for field in groupedFields['string'] %}
|
||||
{% if associationFields[field] is defined %}
|
||||
{% set details = associationFields[field] %}
|
||||
<tr>
|
||||
<th><?= __('{{ details.property|humanize }}') ?></th>
|
||||
<td><?= ${{ singularVar }}->hasValue('{{ details.property }}') ? $this->Html->link(${{ singularVar }}->{{ details.property }}->{{ details.displayField }}, ['controller' => '{{ details.controller }}', 'action' => 'view', ${{ singularVar }}->{{ details.property }}->{{ details.primaryKey[0] }}]) : '' ?></td>
|
||||
</tr>
|
||||
{% else %}
|
||||
<tr>
|
||||
<th><?= __('{{ field|humanize }}') ?></th>
|
||||
<td><?= h(${{ singularVar }}->{{ field }}) ?></td>
|
||||
</tr>
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
{% if associations.HasOne %}
|
||||
{% for alias, details in associations.HasOne %}
|
||||
<tr>
|
||||
<th><?= __('{{ alias|underscore|singularize|humanize }}') ?></th>
|
||||
<td><?= ${{ singularVar }}->hasValue('{{ details.property }}') ? $this->Html->link(${{ singularVar }}->{{ details.property }}->{{ details.displayField }}, ['controller' => '{{ details.controller }}', 'action' => 'view', ${{ singularVar }}->{{ details.property }}->{{ details.primaryKey[0] }}]) : '' ?></td>
|
||||
</tr>
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
{% if groupedFields.number %}
|
||||
{% for field in groupedFields.number %}
|
||||
<tr>
|
||||
<th><?= __('{{ field|humanize }}') ?></th>
|
||||
{% set columnData = Bake.columnData(field, schema) %}
|
||||
{% if columnData.null %}
|
||||
<td><?= ${{ singularVar }}->{{ field }} === null ? '' : $this->Number->format(${{ singularVar }}->{{ field }}) ?></td>
|
||||
{% else %}
|
||||
<td><?= $this->Number->format(${{ singularVar }}->{{ field }}) ?></td>
|
||||
{% endif %}
|
||||
</tr>
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
{% if groupedFields.date %}
|
||||
{% for field in groupedFields.date %}
|
||||
<tr>
|
||||
<th><?= __('{{ field|humanize }}') ?></th>
|
||||
<td><?= h(${{ singularVar }}->{{ field }}) ?></td>
|
||||
</tr>
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
{% if groupedFields.boolean %}
|
||||
{% for field in groupedFields.boolean %}
|
||||
<tr>
|
||||
<th><?= __('{{ field|humanize }}') ?></th>
|
||||
<td><?= ${{ singularVar }}->{{ field }} ? __('Yes') : __('No'); ?></td>
|
||||
</tr>
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
</table>
|
||||
{% if groupedFields.text %}
|
||||
{% for field in groupedFields.text %}
|
||||
<div class="text">
|
||||
<strong><?= __('{{ field|humanize }}') ?></strong>
|
||||
<blockquote>
|
||||
<?= $this->Text->autoParagraph(h(${{ singularVar }}->{{ field }})); ?>
|
||||
</blockquote>
|
||||
</div>
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
{% set relations = associations.BelongsToMany|merge(associations.HasMany) %}
|
||||
{% for alias, details in relations %}
|
||||
{% set otherSingularVar = alias|variable %}
|
||||
{% set otherPluralHumanName = details.controller|underscore|humanize %}
|
||||
<div class="related">
|
||||
<h4><?= __('Related {{ otherPluralHumanName }}') ?></h4>
|
||||
<?php if (!empty(${{ singularVar }}->{{ details.property }})) : ?>
|
||||
<div class="table-responsive">
|
||||
<table>
|
||||
<tr>
|
||||
{% for field in details.fields %}
|
||||
<th><?= __('{{ field|humanize }}') ?></th>
|
||||
{% endfor %}
|
||||
<th class="actions"><?= __('Actions') ?></th>
|
||||
</tr>
|
||||
<?php foreach (${{ singularVar }}->{{ details.property }} as ${{ otherSingularVar }}) : ?>
|
||||
<tr>
|
||||
{% for field in details.fields %}
|
||||
<td><?= h(${{ otherSingularVar }}->{{ field }}) ?></td>
|
||||
{% endfor %}
|
||||
{% set otherPk = '$' ~ otherSingularVar ~ '->' ~ details.primaryKey[0] %}
|
||||
<td class="actions">
|
||||
<?= $this->Html->link(__('View'), ['controller' => '{{ details.controller }}', 'action' => 'view', {{ otherPk|raw }}]) ?>
|
||||
<?= $this->Html->link(__('Edit'), ['controller' => '{{ details.controller }}', 'action' => 'edit', {{ otherPk|raw }}]) ?>
|
||||
<?= $this->Form->postLink(__('Delete'), ['controller' => '{{ details.controller }}', 'action' => 'delete', {{ otherPk|raw }}], ['confirm' => __('Are you sure you want to delete # {0}?', {{ otherPk|raw }})]) ?>
|
||||
</td>
|
||||
</tr>
|
||||
<?php endforeach; ?>
|
||||
</table>
|
||||
</div>
|
||||
<?php endif; ?>
|
||||
</div>
|
||||
{% endfor %}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -0,0 +1,55 @@
|
|||
<?php
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* Test suite bootstrap for CakeHtmx.
|
||||
*
|
||||
* This function is used to find the location of CakePHP whether CakePHP
|
||||
* has been installed as a dependency of the plugin, or the plugin is itself
|
||||
* installed as a dependency of an application.
|
||||
*/
|
||||
$findRoot = function ($root) {
|
||||
do {
|
||||
$lastRoot = $root;
|
||||
$root = dirname($root);
|
||||
if (is_dir($root . '/vendor/cakephp/cakephp')) {
|
||||
return $root;
|
||||
}
|
||||
} while ($root !== $lastRoot);
|
||||
|
||||
throw new Exception('Cannot find the root of the application, unable to run tests');
|
||||
};
|
||||
$root = $findRoot(__FILE__);
|
||||
unset($findRoot);
|
||||
|
||||
chdir($root);
|
||||
|
||||
require_once $root . '/vendor/autoload.php';
|
||||
|
||||
/**
|
||||
* Define fallback values for required constants and configuration.
|
||||
* To customize constants and configuration remove this require
|
||||
* and define the data required by your plugin here.
|
||||
*/
|
||||
require_once $root . '/vendor/cakephp/cakephp/tests/bootstrap.php';
|
||||
|
||||
if (file_exists($root . '/config/bootstrap.php')) {
|
||||
require $root . '/config/bootstrap.php';
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Load schema from a SQL dump file.
|
||||
*
|
||||
* If your plugin does not use database fixtures you can
|
||||
* safely delete this.
|
||||
*
|
||||
* If you want to support multiple databases, consider
|
||||
* using migrations to provide schema for your plugin,
|
||||
* and using \Migrations\TestSuite\Migrator to load schema.
|
||||
*/
|
||||
use Cake\TestSuite\Fixture\SchemaLoader;
|
||||
|
||||
// Load a schema dump file.
|
||||
(new SchemaLoader())->loadSqlFiles('tests/schema.sql', 'test');
|
||||
|
|
@ -0,0 +1 @@
|
|||
-- Test database schema for CakeHtmx
|
||||
Loading…
Reference in New Issue