Server : Apache/2.4.41 (Ubuntu) System : Linux absol.cf 5.4.0-198-generic #218-Ubuntu SMP Fri Sep 27 20:18:53 UTC 2024 x86_64 User : www-data ( 33) PHP Version : 7.4.33 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, Directory : /var/www/html/webtrees/app/Module/
Upload File :
Current File : /var/www/html/webtrees/app/Module/CensusAssistantModule.php
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2023 webtrees development team
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees\Module;
use Fisharebest\Webtrees\Census\CensusInterface;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Individual;
use Fisharebest\Webtrees\Registry;
use Fisharebest\Webtrees\Validator;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use function array_keys;
use function count;
use function e;
use function response;
use function str_repeat;
use function str_replace;
use function view;
/**
* Class CensusAssistantModule
*/
class CensusAssistantModule extends AbstractModule
{
/**
* How should this module be identified in the control panel, etc.?
*
* @return string
*/
public function title(): string
{
/* I18N: Name of a module */
return I18N::translate('Census assistant');
}
/**
* A sentence describing what this module does.
*
* @return string
*/
public function description(): string
{
/* I18N: Description of the “Census assistant” module */
return I18N::translate('An alternative way to enter census transcripts and link them to individuals.');
}
/**
* @param ServerRequestInterface $request
*
* @return ResponseInterface
*/
public function postCensusHeaderAction(ServerRequestInterface $request): ResponseInterface
{
$census_class = Validator::parsedBody($request)->string('census');
$html = $this->censusTableHeader(new $census_class());
return response($html);
}
/**
* @param ServerRequestInterface $request
*
* @return ResponseInterface
*/
public function postCensusIndividualAction(ServerRequestInterface $request): ResponseInterface
{
$tree = Validator::attributes($request)->tree();
$indi_xref = Validator::parsedBody($request)->isXref()->string('xref', '');
$head_xref = Validator::parsedBody($request)->isXref()->string('head', '');
$individual = Registry::individualFactory()->make($indi_xref, $tree);
$head = Registry::individualFactory()->make($head_xref, $tree);
$census_class = Validator::parsedBody($request)->string('census');
$census = new $census_class();
// No head of household? Create a fake one.
$head ??= Registry::individualFactory()->new('X', '0 @X@ INDI', null, $tree);
// Generate columns (e.g. relationship name) using the correct language.
I18N::init($census->censusLanguage());
if ($individual instanceof Individual && $head instanceof Individual) {
$html = $this->censusTableRow($census, $individual, $head);
} else {
$html = $this->censusTableEmptyRow($census);
}
return response($html);
}
/**
* @param Individual $individual
*
* @return string
*/
public function createCensusAssistant(Individual $individual): string
{
return view('modules/census-assistant', [
'individual' => $individual,
]);
}
/**
* @param ServerRequestInterface $request
* @param Individual $individual
* @param string $fact_id
* @param string $newged
* @param bool $keep_chan
*
* @return string
*/
public function updateCensusAssistant(ServerRequestInterface $request, Individual $individual, string $fact_id, string $newged, bool $keep_chan): string
{
$ca_title = Validator::parsedBody($request)->string('ca_title');
$ca_place = Validator::parsedBody($request)->string('ca_place');
$ca_citation = Validator::parsedBody($request)->string('ca_citation');
$ca_individuals = Validator::parsedBody($request)->array('ca_individuals');
$ca_notes = Validator::parsedBody($request)->string('ca_notes');
$ca_census = Validator::parsedBody($request)->string('ca_census');
if ($ca_census !== '' && $ca_individuals !== []) {
$census = new $ca_census();
$note_text = $this->createNoteText($census, $ca_title, $ca_place, $ca_citation, $ca_individuals, $ca_notes);
$note_gedcom = '0 @@ NOTE ' . str_replace("\n", "\n1 CONT ", $note_text);
$note = $individual->tree()->createRecord($note_gedcom);
$newged .= "\n2 NOTE @" . $note->xref() . '@';
// Add the census fact to the rest of the household
foreach ($ca_individuals['xref'] ?? [] as $xref) {
if ($xref !== '' && $xref !== $individual->xref()) {
Registry::individualFactory()->make($xref, $individual->tree())
->updateFact($fact_id, $newged, !$keep_chan);
}
}
}
return $newged;
}
/**
* @param CensusInterface $census
* @param string $ca_title
* @param string $ca_place
* @param string $ca_citation
* @param array<array<string>> $ca_individuals
* @param string $ca_notes
*
* @return string
*/
private function createNoteText(CensusInterface $census, string $ca_title, string $ca_place, string $ca_citation, array $ca_individuals, string $ca_notes): string
{
$text = $ca_title;
if ($ca_citation !== '') {
$text .= "\n" . $ca_citation;
}
if ($ca_place !== '') {
$text .= "\n" . $ca_place;
}
$text .= "\n\n|";
foreach ($census->columns() as $column) {
$text .= ' ' . $column->abbreviation() . ' |';
}
$text .= "\n|" . str_repeat(' ----- |', count($census->columns()));
foreach (array_keys($ca_individuals['xref'] ?? []) as $key) {
$text .= "\n|";
foreach ($census->columns() as $n => $column) {
$text .= ' ' . $ca_individuals[$n][$key] . ' |';
}
}
if ($ca_notes !== '') {
$text .= "\n\n" . strtr($ca_notes, ["\r" => '']);
}
return $text;
}
/**
* Generate an HTML row of data for the census header
* Add prefix cell (store XREF and drag/drop)
* Add suffix cell (delete button)
*
* @param CensusInterface $census
*
* @return string
*/
protected function censusTableHeader(CensusInterface $census): string
{
$html = '';
foreach ($census->columns() as $column) {
$html .= '<th class="wt-census-assistant-field" title="' . $column->title() . '">' . $column->abbreviation() . '</th>';
}
return '<tr class="wt-census-assistant-row"><th hidden></th>' . $html . '<th></th></tr>';
}
/**
* Generate an HTML row of data for the census
* Add prefix cell (store XREF and drag/drop)
* Add suffix cell (delete button)
*
* @param CensusInterface $census
*
* @return string
*/
public function censusTableEmptyRow(CensusInterface $census): string
{
$html = '<td class="wt-census-assistant-field" hidden><input type="hidden" name="ca_individuals[xref][]"></td>';
foreach ($census->columns() as $n => $column) {
$html .= '<td class="wt-census-assistant-field p-0"><input class="form-control wt-census-assistant-form-control p-0" type="text" name="ca_individuals[' . $n . '][]"></td>';
}
$html .= '<td class="wt-census-assistant-field"><a href="#" title="' . I18N::translate('Remove') . '">' . view('icons/delete') . '</a></td>';
return '<tr class="wt-census-assistant-row">' . $html . '</tr>';
}
/**
* Generate an HTML row of data for the census
* Add prefix cell (store XREF and drag/drop)
* Add suffix cell (delete button)
*
* @param CensusInterface $census
* @param Individual $individual
* @param Individual $head
*
* @return string
*/
public function censusTableRow(CensusInterface $census, Individual $individual, Individual $head): string
{
$html = '<td class="wt-census-assistant-field" hidden><input type="hidden" name="ca_individuals[xref][]" value="' . e($individual->xref()) . '"></td>';
foreach ($census->columns() as $n => $column) {
$html .= '<td class="wt-census-assistant-field p-0"><input class="form-control wt-census-assistant-form-control p-0" type="text" value="' . $column->generate($individual, $head) . '" name="ca_individuals[' . $n . '][]"></td>';
}
$html .= '<td class="wt-census-assistant-field"><a href="#" title="' . I18N::translate('Remove') . '">' . view('icons/delete') . '</a></td>';
return '<tr class="wt-census-assistant-row">' . $html . '</tr>';
}
}
Server : Apache/2.4.41 (Ubuntu)