From 9e6ce06a2441898d7165575c5d8bfe4394f90fbd Mon Sep 17 00:00:00 2001 From: Brandon Shipley Date: Thu, 9 Jan 2025 23:47:18 -0800 Subject: [PATCH] first real commit in standalone repo --- .gitignore | 8 + README.md | 12 +- composer.json | 24 + ...3091420_CreateContactUsFormSubmissions.php | 61 +++ config/app.example.php | 31 ++ phpunit.xml.dist | 30 ++ src/CakeContactUsPlugin.php | 98 ++++ .../ContactUsFormSubmissionsController.php | 88 ++++ src/Controller/AppController.php | 10 + .../Component/ContactUsComponent.php | 160 +++++++ .../ContactUsFormSubmissionsController.php | 34 ++ src/Mailer/ContactUsFormSubmissionsMailer.php | 65 +++ src/Model/Entity/ContactUsFormSubmission.php | 42 ++ .../Table/ContactUsFormSubmissionsTable.php | 157 +++++++ .../Admin/ContactUsFormSubmissions/edit.php | 39 ++ .../Admin/ContactUsFormSubmissions/index.php | 55 +++ .../Admin/ContactUsFormSubmissions/view.php | 61 +++ templates/ContactUsFormSubmissions/add.php | 23 + .../element/ContactUsFormSubmissions/form.php | 16 + templates/email/html/backend.php | 32 ++ templates/email/html/confirmation.php | 9 + templates/email/text/backend.php | 25 ++ templates/email/text/confirmation.php | 17 + .../ContactUsFormSubmissionsFixture.php | 35 ++ .../Component/ContactUsComponentTest.php | 45 ++ ...ContactUsFormSubmissionsControllerTest.php | 418 ++++++++++++++++++ .../ContactUsFormSubmissionsTableTest.php | 91 ++++ tests/bootstrap.php | 55 +++ tests/schema.sql | 1 + webroot/.gitkeep | 0 30 files changed, 1741 insertions(+), 1 deletion(-) create mode 100644 .gitignore create mode 100644 composer.json create mode 100644 config/Migrations/20250103091420_CreateContactUsFormSubmissions.php create mode 100644 config/app.example.php create mode 100644 phpunit.xml.dist create mode 100644 src/CakeContactUsPlugin.php create mode 100644 src/Controller/Admin/ContactUsFormSubmissionsController.php create mode 100644 src/Controller/AppController.php create mode 100644 src/Controller/Component/ContactUsComponent.php create mode 100644 src/Controller/ContactUsFormSubmissionsController.php create mode 100644 src/Mailer/ContactUsFormSubmissionsMailer.php create mode 100644 src/Model/Entity/ContactUsFormSubmission.php create mode 100644 src/Model/Table/ContactUsFormSubmissionsTable.php create mode 100644 templates/Admin/ContactUsFormSubmissions/edit.php create mode 100644 templates/Admin/ContactUsFormSubmissions/index.php create mode 100644 templates/Admin/ContactUsFormSubmissions/view.php create mode 100644 templates/ContactUsFormSubmissions/add.php create mode 100644 templates/element/ContactUsFormSubmissions/form.php create mode 100644 templates/email/html/backend.php create mode 100644 templates/email/html/confirmation.php create mode 100644 templates/email/text/backend.php create mode 100644 templates/email/text/confirmation.php create mode 100644 tests/Fixture/ContactUsFormSubmissionsFixture.php create mode 100644 tests/TestCase/Controller/Component/ContactUsComponentTest.php create mode 100644 tests/TestCase/Controller/ContactUsFormSubmissionsControllerTest.php create mode 100644 tests/TestCase/Model/Table/ContactUsFormSubmissionsTableTest.php create mode 100644 tests/bootstrap.php create mode 100644 tests/schema.sql create mode 100644 webroot/.gitkeep diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..244d127 --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +/composer.lock +/composer.phar +/phpunit.xml +/.phpunit.result.cache +/phpunit.phar +/config/Migrations/schema-dump-default.lock +/vendor/ +/.idea/ diff --git a/README.md b/README.md index 4ea0e26..afd50e3 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,12 @@ -# CakeContactUs +# CakeContactUs 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 hi-powereddev/cake-contact-us +``` diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..04f5c36 --- /dev/null +++ b/composer.json @@ -0,0 +1,24 @@ +{ + "name": "hi-powered-dev/cake-contact-us", + "description": "Contact Us plugin for CakePHP", + "type": "cakephp-plugin", + "license": "UNLICENSE", + "require": { + "php": ">=8.1", + "cakephp/cakephp": "^5.0.1" + }, + "require-dev": { + "phpunit/phpunit": "^10.1" + }, + "autoload": { + "psr-4": { + "CakeContactUs\\": "src/" + } + }, + "autoload-dev": { + "psr-4": { + "CakeContactUs\\Test\\": "tests/", + "Cake\\Test\\": "vendor/cakephp/cakephp/tests/" + } + } +} diff --git a/config/Migrations/20250103091420_CreateContactUsFormSubmissions.php b/config/Migrations/20250103091420_CreateContactUsFormSubmissions.php new file mode 100644 index 0000000..52a0ad0 --- /dev/null +++ b/config/Migrations/20250103091420_CreateContactUsFormSubmissions.php @@ -0,0 +1,61 @@ +table('contact_us_form_submissions', ['id' => false, 'primary_key' => ['id']]); + + $table->addColumn('id', 'uuid', [ + 'default' => null, + 'null' => false, + ]); + $table->addColumn('submitted_at', 'datetime', [ + 'default' => null, + 'null' => false, + ]); + $table->addColumn('client_ip', 'string', [ + 'default' => null, + 'limit' => 45, + 'null' => false, + ]); + $table->addColumn('name', 'string', [ + 'default' => null, + 'limit' => 255, + 'null' => false, + ]); + $table->addColumn('email', 'string', [ + 'default' => null, + 'limit' => 255, + 'null' => true, + ]); + $table->addColumn('subject', 'string', [ + 'default' => null, + 'limit' => 255, + 'null' => true, + ]); + $table->addColumn('message', 'text', [ + 'default' => null, + 'null' => false, + ]); + $table->addColumn('confirm_email_sent', 'datetime', [ + 'default' => null, + 'null' => true, + ]); + $table->addColumn('backend_email_sent', 'datetime', [ + 'default' => null, + 'null' => true, + ]); + $table->create(); + } +} diff --git a/config/app.example.php b/config/app.example.php new file mode 100644 index 0000000..46175fd --- /dev/null +++ b/config/app.example.php @@ -0,0 +1,31 @@ + [ + 'fields' => [ + 'subject' => true, + 'email' => true, + 'captcha' => true, + ], + 'sendConfirmationEmail' => true, + 'sendBackendEmail' => true, + 'email' => [ + 'mailerClass' => 'CakeContactUs.ContactUsFormSubmissions', + 'confirmation' => [ + 'enabled' => true, + ], + 'backend' => [ + 'enabled' => true, + 'to' => 'bshipley@hipowered.dev', + ], + ], + 'addIdToRedirect' => true, + 'redirectUrl' => [ + 'prefix' => 'Admin', + 'plugin' => 'CakeContactUs', + 'controller' => 'ContactUsFormSubmissions', + 'action' => 'view', + ], + ], +]; diff --git a/phpunit.xml.dist b/phpunit.xml.dist new file mode 100644 index 0000000..d4da298 --- /dev/null +++ b/phpunit.xml.dist @@ -0,0 +1,30 @@ + + + + + + + + + + + tests/TestCase/ + + + + + + + + + + + src/ + + + diff --git a/src/CakeContactUsPlugin.php b/src/CakeContactUsPlugin.php new file mode 100644 index 0000000..65d719a --- /dev/null +++ b/src/CakeContactUsPlugin.php @@ -0,0 +1,98 @@ +prefix('Admin', function (RouteBuilder $routes): void { + $routes->plugin('CakeContactUs', function (RouteBuilder $routes): void { + $routes->connect('/', ['controller' => 'ContactUsFormSubmissions', 'action' => 'index']); + + $routes->fallbacks(); + }); + }); + $routes->plugin('CakeContactUs', ['path' => '/contact-us'], function (RouteBuilder $routes): void { + $routes->connect('/', ['controller' => 'ContactUsFormSubmissions', 'action' => 'add']); + }); + + 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 + } +} diff --git a/src/Controller/Admin/ContactUsFormSubmissionsController.php b/src/Controller/Admin/ContactUsFormSubmissionsController.php new file mode 100644 index 0000000..6a94f51 --- /dev/null +++ b/src/Controller/Admin/ContactUsFormSubmissionsController.php @@ -0,0 +1,88 @@ +ContactUsFormSubmissions->find(); + $contactUsFormSubmissions = $this->paginate($query); + + $this->set(compact('contactUsFormSubmissions')); + } + + /** + * View method + * + * @param string|null $id Contact Us Form Submission id. + * @return \Cake\Http\Response|null|void Renders view + * @throws \Cake\Datasource\Exception\RecordNotFoundException When record not found. + */ + public function view($id = null) + { + $contactUsFormSubmission = $this->ContactUsFormSubmissions->get($id, contain: []); + $this->set(compact('contactUsFormSubmission')); + } + + + /** + * Edit method + * + * @param string|null $id Contact Us Form Submission id. + * @return \Cake\Http\Response|null|void Redirects on successful edit, renders view otherwise. + * @throws \Cake\Datasource\Exception\RecordNotFoundException When record not found. + */ + public function edit($id = null) + { + $contactUsFormSubmission = $this->ContactUsFormSubmissions->get($id, contain: []); + if ($this->request->is(['patch', 'post', 'put'])) { + $contactUsFormSubmission = $this->ContactUsFormSubmissions->patchEntity($contactUsFormSubmission, $this->request->getData()); + if ($this->ContactUsFormSubmissions->save($contactUsFormSubmission)) { + $this->Flash->success(__('The contact us form submission has been saved.')); + + return $this->redirect(['action' => 'index']); + } + $this->Flash->error(__('The contact us form submission could not be saved. Please, try again.')); + } + $this->set(compact('contactUsFormSubmission')); + } + + /** + * Delete method + * + * @param string|null $id Contact Us Form Submission id. + * @return \Cake\Http\Response|null Redirects to index. + * @throws \Cake\Datasource\Exception\RecordNotFoundException When record not found. + */ + public function delete($id = null) + { + $this->request->allowMethod(['post', 'delete']); + $contactUsFormSubmission = $this->ContactUsFormSubmissions->get($id); + if ($this->ContactUsFormSubmissions->delete($contactUsFormSubmission)) { + $this->Flash->success(__('The contact us form submission has been deleted.')); + } else { + $this->Flash->error(__('The contact us form submission could not be deleted. Please, try again.')); + } + + return $this->redirect(['action' => 'index']); + } +} diff --git a/src/Controller/AppController.php b/src/Controller/AppController.php new file mode 100644 index 0000000..9a3b37d --- /dev/null +++ b/src/Controller/AppController.php @@ -0,0 +1,10 @@ + + */ + protected array $_defaultConfig = []; + + /** + * @var array|string[] + */ + protected array $components = ['Flash']; + + /** + * @param array $config + * @return void + * + * @throws Exception + */ + public function initialize(array $config): void + { + parent::initialize($config); // TODO: Change the autogenerated stub + + $this->ContactUsFormSubmissions = TableRegistry::getTableLocator()->get('CakeContactUs.ContactUsFormSubmissions'); + + $requireCaptcha = Configure::readOrFail('ContactUs.fields.captcha'); + $this->setConfig('redirectUrl', Configure::read('ContactUs.redirectUrl', '/')); + $this->setConfig('addIdToRedirect', Configure::read('ContactUs.addIdToRedirect', false)); + $this->setConfig('requireEmail', Configure::readOrFail('ContactUs.fields.email')); + $this->setConfig('requireCaptcha', $requireCaptcha); + if ($requireCaptcha) { + $this->_registry->load('Captcha.Captcha'); + } + } + + /** + * @return EntityInterface|ContactUsFormSubmission + */ + public function newContactUsForm() + { + if ($this->getConfig('requireCaptcha')) { + $this->ContactUsFormSubmissions->addBehavior('Captcha.Captcha'); + } + return $this->ContactUsFormSubmissions->newEmptyEntity(); + } + + /** + * @return EntityInterface|ContactUsFormSubmission + */ + public function processContactUsForm(EntityInterface $contactUsFormSubmission, array $postData = null) + { + if (!isset($postData)) { + $postData = $this->getController()->getRequest()->getData(); + } + $postData['client_ip'] = array_key_exists('client_ip', $postData) && $postData['client_ip'] ? $postData['client_ip'] : $this->getController()->getRequest()->clientIp(); + $postData['submitted_at'] = DateTime::now(); + + $event = $this->getController()->dispatchEvent(CakeContactUsPlugin::EVENT_BEFORE_CONTACT_US_FORM_SAVED, [ + 'contactUsFormSubmission' => $contactUsFormSubmission, + ], $this->getController()); + $result = $event->getResult(); + + Log::debug(print_r('$result', true)); + Log::debug(print_r($result, true)); + if ($result instanceof EntityInterface) { + $postData = $result->toArray(); + $contactUsFormSubmission = $this->ContactUsFormSubmissions->patchEntity($contactUsFormSubmission, $postData); + if ($contactUsFormSubmission->getErrors()) { + Log::debug(print_r('$contactUsFormSubmission->getErrors()', true)); + Log::debug(print_r($contactUsFormSubmission->getErrors(), true)); + } + $contactUsFormSubmissionSaved = $this->ContactUsFormSubmissions->save($contactUsFormSubmission); + if ($contactUsFormSubmissionSaved) { + return $this->_afterFormSaved($contactUsFormSubmissionSaved); + } + + // @TODO contact us form submission failed - handle here + } + + if ($event->isStopped()) { + return $this->getController()->redirect($event->getResult()); + } + + if (!$this->getController()->getRequest()->is('post')) { + return; + } + + $contactUsFormSubmission = $this->ContactUsFormSubmissions->patchEntity($contactUsFormSubmission, $postData); + if ($contactUsFormSubmission->getErrors()) { + Log::debug(print_r('$contactUsFormSubmission->getErrors()', true)); + Log::debug(print_r($contactUsFormSubmission->getErrors(), true)); + } + $contactUsFormSubmissionSaved = $this->ContactUsFormSubmissions->save($contactUsFormSubmission); + if ($contactUsFormSubmissionSaved) { + return $this->_afterFormSaved($contactUsFormSubmissionSaved); + } + $message = __d('cake_contact_us', 'Something doesn\'t look quite right. Please try again.'); + + $this->Flash->error($message); + + // @TODO contact us form submission failed - handle here + $this->getController()->set(['contactUsFormSubmission' => $contactUsFormSubmission]); + } + + /** + * Prepare flash messages after registration, and dispatch afterRegister event + * + * @param \Cake\Datasource\EntityInterface|ContactUsFormSubmission $contactUsFormSubmissionSaved Contact us form submission entity + * @return \Cake\Http\Response + */ + protected function _afterFormSaved(EntityInterface $contactUsFormSubmissionSaved) + { + $message = __d('cake_contact_us', 'Message received, thank you. We will be in touch soon.'); + + $event = $this->getController()->dispatchEvent(CakeContactUsPlugin::EVENT_AFTER_CONTACT_US_FORM_SAVED, [ + 'contactUsFormSubmission' => $contactUsFormSubmissionSaved, + ], $this->getController()); + $result = $event->getResult(); + if ($result instanceof Response) { + return $result; + } + $this->Flash->success($message); + + $redirectUrl = $this->getConfig('redirectUrl'); + Log::debug(print_r('$contactUsFormSubmissionSaved after save', true)); + Log::debug(print_r($contactUsFormSubmissionSaved, true)); + if ($this->getConfig('addIdToRedirect')) { + $redirectUrl[] = $contactUsFormSubmissionSaved->get($this->ContactUsFormSubmissions->getPrimaryKey()); + } + return $this->getController()->redirect($redirectUrl); + } +} diff --git a/src/Controller/ContactUsFormSubmissionsController.php b/src/Controller/ContactUsFormSubmissionsController.php new file mode 100644 index 0000000..29cebf4 --- /dev/null +++ b/src/Controller/ContactUsFormSubmissionsController.php @@ -0,0 +1,34 @@ +loadComponent('CakeContactUs.ContactUs'); + } + + /** + * Add method + * + * @return \Cake\Http\Response|null|void Redirects on successful add, renders view otherwise. + */ + public function add() + { + $contactUsFormSubmission = $this->ContactUs->newContactUsForm(); + if ($this->request->is('post')) { + return $this->ContactUs->processContactUsForm($contactUsFormSubmission, $this->request->getData()); + } + $this->set(compact('contactUsFormSubmission')); + } +} diff --git a/src/Mailer/ContactUsFormSubmissionsMailer.php b/src/Mailer/ContactUsFormSubmissionsMailer.php new file mode 100644 index 0000000..68e65f0 --- /dev/null +++ b/src/Mailer/ContactUsFormSubmissionsMailer.php @@ -0,0 +1,65 @@ +setTo($contactUsFormSubmission['email']) + ->setSubject($name . $subject) + ->setEmailFormat(Message::MESSAGE_BOTH) + ->setViewVars([ + 'contactUsFormSubmission' => $contactUsFormSubmission, + ]); + + $this->viewBuilder() + ->setTemplate('CakeContactUs.confirmation'); + } + + /** + * Send to backoffice to take action + * + * @param \Cake\Datasource\EntityInterface $user User entity + * @return void + */ + protected function backend(EntityInterface $contactUsFormSubmission, array $options = []) + { + $name = isset($contactUsFormSubmission['name']) ? ' by ' . $contactUsFormSubmission['name'] : ''; + // un-hide the token to be able to send it in the email content + $subject = __d('cake_contact_us', 'Contact Us Form Submitted'); + + + $this + ->setTo(Configure::readOrFail('ContactUs.email.backend.to')) + ->setSubject($subject . $name) + ->setEmailFormat(Message::MESSAGE_BOTH) + ->setViewVars([ + 'contactUsFormSubmission' => $contactUsFormSubmission, + ]); + + $this->viewBuilder() + ->setTemplate('CakeContactUs.backend'); + } +} diff --git a/src/Model/Entity/ContactUsFormSubmission.php b/src/Model/Entity/ContactUsFormSubmission.php new file mode 100644 index 0000000..3012554 --- /dev/null +++ b/src/Model/Entity/ContactUsFormSubmission.php @@ -0,0 +1,42 @@ + + */ + protected array $_accessible = [ + 'submitted_at' => true, + 'client_ip' => true, + 'name' => true, + 'email' => true, + 'subject' => true, + 'message' => true, + 'confirm_email_sent' => true, + 'backend_email_sent' => true, + ]; +} diff --git a/src/Model/Table/ContactUsFormSubmissionsTable.php b/src/Model/Table/ContactUsFormSubmissionsTable.php new file mode 100644 index 0000000..bf4ad1d --- /dev/null +++ b/src/Model/Table/ContactUsFormSubmissionsTable.php @@ -0,0 +1,157 @@ + newEntities(array $data, array $options = []) + * @method ContactUsFormSubmission get(mixed $primaryKey, array|string $finder = 'all', CacheInterface|string|null $cache = null, Closure|string|null $cacheKey = null, mixed ...$args) + * @method ContactUsFormSubmission findOrCreate($search, ?callable $callback = null, array $options = []) + * @method ContactUsFormSubmission patchEntity(EntityInterface $entity, array $data, array $options = []) + * @method array patchEntities(iterable $entities, array $data, array $options = []) + * @method ContactUsFormSubmission|false save(EntityInterface $entity, array $options = []) + * @method ContactUsFormSubmission saveOrFail(EntityInterface $entity, array $options = []) + * @method iterable|ResultSetInterface|false saveMany(iterable $entities, array $options = []) + * @method iterable|ResultSetInterface saveManyOrFail(iterable $entities, array $options = []) + * @method iterable|ResultSetInterface|false deleteMany(iterable $entities, array $options = []) + * @method iterable|ResultSetInterface deleteManyOrFail(iterable $entities, array $options = []) + */ +class ContactUsFormSubmissionsTable extends Table +{ + use MailerAwareTrait; + + /** + * Initialize method + * + * @param array $config The configuration for the Table. + * @return void + */ + public function initialize(array $config): void + { + parent::initialize($config); + + $this->setTable('contact_us_form_submissions'); + $this->setDisplayField('name'); + $this->setPrimaryKey('id'); + } + + /** + * Default validation rules. + * + * @param Validator $validator Validator instance. + * @return Validator + */ + public function validationDefault(Validator $validator): Validator + { + $fields = Configure::readOrFail('ContactUs.fields'); + $validator + ->dateTime('submitted_at') + ->requirePresence('submitted_at', 'create') + ->notEmptyDateTime('submitted_at'); + + $validator + ->scalar('client_ip') + ->maxLength('client_ip', 45) + ->requirePresence('client_ip', 'create') + ->notEmptyString('client_ip'); + + $validator + ->scalar('name') + ->maxLength('name', 255) + ->requirePresence('name', 'create') + ->notEmptyString('name'); + + // email + $validator->email('email'); + if ($fields['email']) { + $validator->notEmptyString('email'); + } else { + $validator->allowEmptyString('email'); + } + + // subject + $validator + ->scalar('subject') + ->maxLength('subject', 255); + if ($fields['subject']) { + $validator->notEmptyString('subject'); + } else { + $validator->allowEmptyString('subject'); + } + + $validator + ->scalar('message') + ->requirePresence('message', 'create') + ->notEmptyString('message'); + + $validator + ->dateTime('confirm_email_sent') + ->allowEmptyDateTime('confirm_email_sent'); + + $validator + ->dateTime('backend_email_sent') + ->allowEmptyDateTime('backend_email_sent'); + + return $validator; + } + + /** + * @param EventInterface $event + * @param EntityInterface|ContactUsFormSubmission $contactUsFormSubmission + * @param \ArrayObject $options + * @return void + */ + public function afterSave(EventInterface $event, EntityInterface|ContactUsFormSubmission $contactUsFormSubmission, \ArrayObject $options) + { + if (!$contactUsFormSubmission->isNew()) { + return; + } + $now = DateTime::now()->format(DATETIME_MYSQL); + $updateData = []; + if (Configure::read('ContactUs.email.confirmation.enabled') && isset($contactUsFormSubmission->email)) { + $mailer = Configure::read('ContactUs.email.mailerClass', 'CakeContactUs.ContactUsFormSubmissions'); + try { + $this->getMailer($mailer)->send('confirmation', [$contactUsFormSubmission]); + $updateData['confirm_email_sent'] = $now; + } catch (CakeException $exception) { + + } + } + + if (Configure::readOrFail('ContactUs.email.backend.enabled')) { + $mailer = Configure::read('ContactUs.email.mailerClass', 'CakeContactUs.ContactUsFormSubmissions'); + try { + $this->getMailer($mailer)->send('backend', [$contactUsFormSubmission]); + $updateData['backend_email_sent'] = $now; + } catch (CakeException $exception) { + + } + } + Log::debug(print_r('$updateData', true)); + Log::debug(print_r($updateData, true)); + if ($updateData) { + $contactUsFormSubmission = $this->patchEntity($contactUsFormSubmission, $updateData, ['validate' => false]); + $this->saveOrFail($contactUsFormSubmission); + } + } +} diff --git a/templates/Admin/ContactUsFormSubmissions/edit.php b/templates/Admin/ContactUsFormSubmissions/edit.php new file mode 100644 index 0000000..f288a22 --- /dev/null +++ b/templates/Admin/ContactUsFormSubmissions/edit.php @@ -0,0 +1,39 @@ + +
+ +
+
+ Form->create($contactUsFormSubmission) ?> +
+ + Form->control('submitted_at'); + echo $this->Form->control('client_ip'); + echo $this->Form->control('name'); + echo $this->Form->control('email'); + echo $this->Form->control('subject'); + echo $this->Form->control('message'); + echo $this->Form->control('confirm_email_sent', ['empty' => true]); + echo $this->Form->control('backend_email_sent', ['empty' => true]); + ?> +
+ Form->button(__('Submit')) ?> + Form->end() ?> +
+
+
diff --git a/templates/Admin/ContactUsFormSubmissions/index.php b/templates/Admin/ContactUsFormSubmissions/index.php new file mode 100644 index 0000000..3606b9a --- /dev/null +++ b/templates/Admin/ContactUsFormSubmissions/index.php @@ -0,0 +1,55 @@ + $contactUsFormSubmissions + */ +?> +
+

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Paginator->sort('id') ?>Paginator->sort('submitted_at') ?>Paginator->sort('client_ip') ?>Paginator->sort('name') ?>Paginator->sort('email') ?>Paginator->sort('subject') ?>Paginator->sort('confirm_email_sent') ?>Paginator->sort('backend_email_sent') ?>
id) ?>submitted_at) ?>client_ip) ?>name) ?>email) ?>subject) ?>confirm_email_sent) ?>backend_email_sent) ?> + Html->link(__('View'), ['action' => 'view', $contactUsFormSubmission->id]) ?> + Html->link(__('Edit'), ['action' => 'edit', $contactUsFormSubmission->id]) ?> + Form->postLink(__('Delete'), ['action' => 'delete', $contactUsFormSubmission->id], ['confirm' => __('Are you sure you want to delete # {0}?', $contactUsFormSubmission->id)]) ?> +
+
+
+
    + Paginator->first('<< ' . __('first')) ?> + Paginator->prev('< ' . __('previous')) ?> + Paginator->numbers() ?> + Paginator->next(__('next') . ' >') ?> + Paginator->last(__('last') . ' >>') ?> +
+

Paginator->counter(__('Page {{page}} of {{pages}}, showing {{current}} record(s) out of {{count}} total')) ?>

+
+
diff --git a/templates/Admin/ContactUsFormSubmissions/view.php b/templates/Admin/ContactUsFormSubmissions/view.php new file mode 100644 index 0000000..f6815c9 --- /dev/null +++ b/templates/Admin/ContactUsFormSubmissions/view.php @@ -0,0 +1,61 @@ + +
+ +
+
+

name) ?>

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
id) ?>
client_ip) ?>
name) ?>
email) ?>
subject) ?>
submitted_at) ?>
confirm_email_sent) ?>
backend_email_sent) ?>
+
+ +
+ Text->autoParagraph(h($contactUsFormSubmission->message)); ?> +
+
+
+
+
diff --git a/templates/ContactUsFormSubmissions/add.php b/templates/ContactUsFormSubmissions/add.php new file mode 100644 index 0000000..d633cee --- /dev/null +++ b/templates/ContactUsFormSubmissions/add.php @@ -0,0 +1,23 @@ + +
+ +
+
+ Form->create($contactUsFormSubmission) ?> +
+ + element('ContactUsFormSubmissions/form'); ?> +
+ Form->button(__('Submit')) ?> + Form->end() ?> +
+
+
diff --git a/templates/element/ContactUsFormSubmissions/form.php b/templates/element/ContactUsFormSubmissions/form.php new file mode 100644 index 0000000..2bef41d --- /dev/null +++ b/templates/element/ContactUsFormSubmissions/form.php @@ -0,0 +1,16 @@ + +Form->control('name'); +echo $fields['email'] ? $this->Form->control('email', ['required' => true]) : ''; +echo $fields['subject'] ? $this->Form->control('subject', ['required' => true]) : ''; +echo $this->Form->control('message'); +echo $fields['captcha'] ? $this->Captcha->render(['placeholder' => __('Please solve the riddle')]) : ''; + +?> diff --git a/templates/email/html/backend.php b/templates/email/html/backend.php new file mode 100644 index 0000000..1070ed5 --- /dev/null +++ b/templates/email/html/backend.php @@ -0,0 +1,32 @@ + +

+ submitted_at) ?>, +

+

+ name); ?> +

+email)) : ?> +

+ + Html->link($contactUsFormSubmission->email, 'mailto:' . $contactUsFormSubmission->email); ?> +

+ + +subject)) : ?> +

+ + subject); ?> +

+ +

+ + message); ?> +

+ diff --git a/templates/email/html/confirmation.php b/templates/email/html/confirmation.php new file mode 100644 index 0000000..2a5126d --- /dev/null +++ b/templates/email/html/confirmation.php @@ -0,0 +1,9 @@ +

+ name) ? $contactUsFormSubmission->name : '') ?>, +

+

+ +

+

+ , +

diff --git a/templates/email/text/backend.php b/templates/email/text/backend.php new file mode 100644 index 0000000..136ea08 --- /dev/null +++ b/templates/email/text/backend.php @@ -0,0 +1,25 @@ + +submitted_at) ?>, + + +name); ?> + +email)) : ?> + + email; ?> + + +subject)) : ?> + + subject); ?> + + + +message); ?> diff --git a/templates/email/text/confirmation.php b/templates/email/text/confirmation.php new file mode 100644 index 0000000..5332911 --- /dev/null +++ b/templates/email/text/confirmation.php @@ -0,0 +1,17 @@ + +, + + + +, + diff --git a/tests/Fixture/ContactUsFormSubmissionsFixture.php b/tests/Fixture/ContactUsFormSubmissionsFixture.php new file mode 100644 index 0000000..9b12016 --- /dev/null +++ b/tests/Fixture/ContactUsFormSubmissionsFixture.php @@ -0,0 +1,35 @@ +records = [ + [ + 'id' => '76fbe7fb-1949-4670-a3d2-c0b48eb98e8d', + 'submitted_at' => '2025-01-03 09:16:50', + 'client_ip' => 'Lorem ipsum dolor sit amet', + 'name' => 'Lorem ipsum dolor sit amet', + 'email' => 'Lorem ipsum dolor sit amet', + 'subject' => 'Lorem ipsum dolor sit amet', + 'message' => 'Lorem ipsum dolor sit amet, aliquet feugiat. Convallis morbi fringilla gravida, phasellus feugiat dapibus velit nunc, pulvinar eget sollicitudin venenatis cum nullam, vivamus ut a sed, mollitia lectus. Nulla vestibulum massa neque ut et, id hendrerit sit, feugiat in taciti enim proin nibh, tempor dignissim, rhoncus duis vestibulum nunc mattis convallis.', + 'confirm_email_sent' => '2025-01-03 09:16:50', + 'backend_email_sent' => '2025-01-03 09:16:50', + ], + ]; + parent::init(); + } +} diff --git a/tests/TestCase/Controller/Component/ContactUsComponentTest.php b/tests/TestCase/Controller/Component/ContactUsComponentTest.php new file mode 100644 index 0000000..b1e1ba9 --- /dev/null +++ b/tests/TestCase/Controller/Component/ContactUsComponentTest.php @@ -0,0 +1,45 @@ +ContactUs = new ContactUsComponent($registry); + } + + /** + * tearDown method + * + * @return void + */ + protected function tearDown(): void + { + unset($this->ContactUs); + + parent::tearDown(); + } +} diff --git a/tests/TestCase/Controller/ContactUsFormSubmissionsControllerTest.php b/tests/TestCase/Controller/ContactUsFormSubmissionsControllerTest.php new file mode 100644 index 0000000..39b310d --- /dev/null +++ b/tests/TestCase/Controller/ContactUsFormSubmissionsControllerTest.php @@ -0,0 +1,418 @@ + + */ + protected array $fixtures = [ + 'plugin.CakeContactUs.ContactUsFormSubmissions', + ]; + + /** + * setUp method + * + * @return void + */ + protected function setUp(): void + { + parent::setUp(); + $this->ContactUsFormSubmissions = $this->getTableLocator()->get('ContactUsFormSubmissions'); + } + + /** + * tearDown method + * + * @return void + */ + protected function tearDown(): void + { + unset($this->ContactUsFormSubmissions); + + parent::tearDown(); + } + + /** + * Test index method + * + * Tests the index action with an unauthenticated user (not logged in) + * + * @uses \CakeContactUs\Controller\ContactUsFormSubmissionsController::index() + * @throws Exception + * + * @return void + */ + public function testIndexGetUnauthenticated(): void + { + $url = [ + 'plugin' => 'CakeContactUs', + 'controller' => 'ContactUsFormSubmissions', + 'action' => 'index', + ]; + $this->get($url); + $this->assertResponseCode(302); + $this->assertRedirectContains('login'); + } + + /** + * Test index method + * + * Tests the index action with a logged in user + * + * @uses \CakeContactUs\Controller\ContactUsFormSubmissionsController::index() + * @throws Exception + * + * @return void + */ + public function testIndexGetLoggedIn(): void + { + // $this->loginUserByRole('admin'); + $url = [ + 'plugin' => 'CakeContactUs', + 'controller' => 'ContactUsFormSubmissions', + 'action' => 'index', + ]; + $this->get($url); + $this->assertResponseCode(200); + } + + /** + * Test view method + * + * Tests the view action with an unauthenticated user (not logged in) + * + * @uses \CakeContactUs\Controller\ContactUsFormSubmissionsController::view() + * @throws Exception + * + * @return void + */ + public function testViewGetUnauthenticated(): void + { + $id = 1; + $url = [ + 'plugin' => 'CakeContactUs', + 'controller' => 'ContactUsFormSubmissions', + 'action' => 'view', + $id, + ]; + $this->get($url); + $this->assertResponseCode(302); + $this->assertRedirectContains('login'); + } + + /** + * Test view method + * + * Tests the view action with a logged in user + * + * @uses \CakeContactUs\Controller\ContactUsFormSubmissionsController::view() + * @throws Exception + * + * @return void + */ + public function testViewGetLoggedIn(): void + { + $id = 1; + // $this->loginUserByRole('admin'); + $url = [ + 'plugin' => 'CakeContactUs', + 'controller' => 'ContactUsFormSubmissions', + 'action' => 'view', + $id, + ]; + $this->get($url); + $this->assertResponseCode(200); + } + + /** + * Test add method + * + * Tests the add action with an unauthenticated user (not logged in) + * + * @uses \CakeContactUs\Controller\ContactUsFormSubmissionsController::add() + * @throws Exception + * + * @return void + */ + public function testAddGetUnauthenticated(): void + { + $cntBefore = $this->ContactUsFormSubmissions->find()->count(); + $url = [ + 'plugin' => 'CakeContactUs', + 'controller' => 'ContactUsFormSubmissions', + 'action' => 'add', + ]; + $this->get($url); + $this->assertResponseCode(302); + $this->assertRedirectContains('login'); + + $cntAfter = $this->ContactUsFormSubmissions->find()->count(); + $this->assertEquals($cntBefore, $cntAfter); + } + + /** + * Test add method + * + * Tests the add action with a logged in user + * + * @uses \CakeContactUs\Controller\ContactUsFormSubmissionsController::add() + * @throws Exception + * + * @return void + */ + public function testAddGetLoggedIn(): void + { + $cntBefore = $this->ContactUsFormSubmissions->find()->count(); + + // $this->loginUserByRole('admin'); + $url = [ + 'plugin' => 'CakeContactUs', + 'controller' => 'ContactUsFormSubmissions', + 'action' => 'add', + ]; + $this->get($url); + $this->assertResponseCode(200); + + $cntAfter = $this->ContactUsFormSubmissions->find()->count(); + $this->assertEquals($cntBefore, $cntAfter); + } + + /** + * Test add method + * + * Tests a POST request to the add action with a logged in user + * + * @uses \CakeContactUs\Controller\ContactUsFormSubmissionsController::add() + * @throws Exception + * + * @return void + */ + public function testAddPostLoggedInSuccess(): void + { + $cntBefore = $this->ContactUsFormSubmissions->find()->count(); + + // $this->loginUserByRole('admin'); + $url = [ + 'plugin' => 'CakeContactUs', + 'controller' => 'ContactUsFormSubmissions', + 'action' => 'add', + ]; + $data = []; + $this->post($url, $data); + $this->assertResponseCode(302); + $this->assertRedirectContains('contactusformsubmissions/view'); + + $cntAfter = $this->ContactUsFormSubmissions->find()->count(); + $this->assertEquals($cntBefore + 1, $cntAfter); + } + + /** + * Test add method + * + * Tests a POST request to the add action with a logged in user + * + * @uses \CakeContactUs\Controller\ContactUsFormSubmissionsController::add() + * @throws Exception + * + * @return void + */ + public function testAddPostLoggedInFailure(): void + { + $cntBefore = $this->ContactUsFormSubmissions->find()->count(); + + // $this->loginUserByRole('admin'); + $url = [ + 'plugin' => 'CakeContactUs', + 'controller' => 'ContactUsFormSubmissions', + 'action' => 'add', + ]; + $data = []; + $this->post($url, $data); + $this->assertResponseCode(200); + + $cntAfter = $this->ContactUsFormSubmissions->find()->count(); + $this->assertEquals($cntBefore, $cntAfter); + } + + /** + * Test edit method + * + * Tests the edit action with an unauthenticated user (not logged in) + * + * @uses \CakeContactUs\Controller\ContactUsFormSubmissionsController::edit() + * @throws Exception + * + * @return void + */ + public function testEditGetUnauthenticated(): void + { + $url = [ + 'plugin' => 'CakeContactUs', + 'controller' => 'ContactUsFormSubmissions', + 'action' => 'edit', + 1, + ]; + $this->get($url); + $this->assertResponseCode(302); + $this->assertRedirectContains('login'); + } + + /** + * Test edit method + * + * Tests the edit action with a logged in user + * + * @uses \CakeContactUs\Controller\ContactUsFormSubmissionsController::edit() + * @throws Exception + * + * @return void + */ + public function testEditGetLoggedIn(): void + { + // $this->loginUserByRole('admin'); + $url = [ + 'plugin' => 'CakeContactUs', + 'controller' => 'ContactUsFormSubmissions', + 'action' => 'edit', + 1, + ]; + $this->get($url); + $this->assertResponseCode(200); + } + + /** + * Test edit method + * + * Tests a PUT request to the edit action with a logged in user + * + * @uses \CakeContactUs\Controller\ContactUsFormSubmissionsController::edit() + * @throws Exception + * + * @return void + */ + public function testEditPutLoggedInSuccess(): void + { + // $this->loginUserByRole('admin'); + $id = 1; + $before = $this->ContactUsFormSubmissions->get($id); + $url = [ + 'plugin' => 'CakeContactUs', + 'controller' => 'ContactUsFormSubmissions', + 'action' => 'edit', + $id, + ]; + $data = [ + // test new data here + ]; + $this->put($url, $data); + + $this->assertResponseCode(302); + $this->assertRedirectContains('contactusformsubmissions/view'); + + $after = $this->ContactUsFormSubmissions->get($id); + // assert saved properly below + } + + /** + * Test edit method + * + * Tests a PUT request to the edit action with a logged in user + * + * @uses \CakeContactUs\Controller\ContactUsFormSubmissionsController::edit() + * @throws Exception + * + * @return void + */ + public function testEditPutLoggedInFailure(): void + { + // $this->loginUserByRole('admin'); + $id = 1; + $before = $this->ContactUsFormSubmissions->get($id); + $url = [ + 'plugin' => 'CakeContactUs', + 'controller' => 'ContactUsFormSubmissions', + 'action' => 'edit', + $id, + ]; + $data = []; + $this->put($url, $data); + $this->assertResponseCode(200); + $after = $this->ContactUsFormSubmissions->get($id); + + // assert save failed below + } + + /** + * Test delete method + * + * Tests the delete action with an unauthenticated user (not logged in) + * + * @uses \CakeContactUs\Controller\ContactUsFormSubmissionsController::delete() + * @throws Exception + * + * @return void + */ + public function testDeleteUnauthenticated(): void + { + $cntBefore = $this->ContactUsFormSubmissions->find()->count(); + + $url = [ + 'plugin' => 'CakeContactUs', + 'controller' => 'ContactUsFormSubmissions', + 'action' => 'delete', + 1, + ]; + $this->delete($url); + $this->assertResponseCode(302); + $this->assertRedirectContains('login'); + + $cntAfter = $this->ContactUsFormSubmissions->find()->count(); + $this->assertEquals($cntBefore, $cntAfter); + } + + /** + * Test delete method + * + * Tests the delete action with a logged in user + * + * @uses \CakeContactUs\Controller\ContactUsFormSubmissionsController::delete() + * @throws Exception + * + * @return void + */ + public function testDeleteLoggedIn(): void + { + $cntBefore = $this->ContactUsFormSubmissions->find()->count(); + + // $this->loginUserByRole('admin'); + $url = [ + 'plugin' => 'CakeContactUs', + 'controller' => 'ContactUsFormSubmissions', + 'action' => 'delete', + 1, + ]; + $this->delete($url); + $this->assertResponseCode(302); + $this->assertRedirectContains('contactusformsubmissions'); + + $cntAfter = $this->ContactUsFormSubmissions->find()->count(); + $this->assertEquals($cntBefore - 1, $cntAfter); + } +} diff --git a/tests/TestCase/Model/Table/ContactUsFormSubmissionsTableTest.php b/tests/TestCase/Model/Table/ContactUsFormSubmissionsTableTest.php new file mode 100644 index 0000000..90d4dcd --- /dev/null +++ b/tests/TestCase/Model/Table/ContactUsFormSubmissionsTableTest.php @@ -0,0 +1,91 @@ + + */ + protected array $fixtures = [ + 'plugin.CakeContactUs.ContactUsFormSubmissions', + ]; + + /** + * setUp method + * + * @return void + */ + protected function setUp(): void + { + parent::setUp(); + $config = $this->getTableLocator()->exists('ContactUsFormSubmissions') ? [] : ['className' => ContactUsFormSubmissionsTable::class]; + $this->ContactUsFormSubmissions = $this->getTableLocator()->get('ContactUsFormSubmissions', $config); + } + + /** + * tearDown method + * + * @return void + */ + protected function tearDown(): void + { + unset($this->ContactUsFormSubmissions); + + parent::tearDown(); + } + + /** + * TestInitialize method + * + * @return void + * @uses \CakeContactUs\Model\Table\ContactUsFormSubmissionsTable::initialize() + */ + public function testInitialize(): void + { + // verify all associations loaded + $expectedAssociations = []; + $associations = $this->ContactUsFormSubmissions->associations(); + + $this->assertCount(count($expectedAssociations), $associations); + foreach ($expectedAssociations as $expectedAssociation) { + $this->assertTrue($this->ContactUsFormSubmissions->hasAssociation($expectedAssociation)); + } + + // verify all behaviors loaded + $expectedBehaviors = []; + $behaviors = $this->ContactUsFormSubmissions->behaviors(); + + $this->assertCount(count($expectedBehaviors), $behaviors); + foreach ($expectedBehaviors as $expectedBehavior) { + $this->assertTrue($this->ContactUsFormSubmissions->hasBehavior($expectedBehavior)); + } + } + + /** + * Test validationDefault method + * + * @return void + * @uses \CakeContactUs\Model\Table\ContactUsFormSubmissionsTable::validationDefault() + */ + public function testValidationDefault(): void + { + $this->markTestIncomplete('Not implemented yet.'); + } +} diff --git a/tests/bootstrap.php b/tests/bootstrap.php new file mode 100644 index 0000000..3437b66 --- /dev/null +++ b/tests/bootstrap.php @@ -0,0 +1,55 @@ +loadSqlFiles('tests/schema.sql', 'test'); diff --git a/tests/schema.sql b/tests/schema.sql new file mode 100644 index 0000000..ec83b63 --- /dev/null +++ b/tests/schema.sql @@ -0,0 +1 @@ +-- Test database schema for CakeContactUs diff --git a/webroot/.gitkeep b/webroot/.gitkeep new file mode 100644 index 0000000..e69de29