forked from pkp/pkp-lib
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
pkp#10292 Controlled Vocab DAO to Eloquent Model
- Loading branch information
1 parent
cbf8b01
commit e9c27fc
Showing
13 changed files
with
317 additions
and
236 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| <?php | ||
|
|
||
| namespace PKP\controlledVocab; | ||
|
|
||
| use PKP\db\DAORegistry; | ||
| use Illuminate\Support\Facades\DB; | ||
| use PKP\controlledVocab\ControlledVocab; | ||
| use PKP\controlledVocab\ControlledVocabEntryDAO; | ||
|
|
||
| class Repository | ||
| { | ||
| /** | ||
| * Fetch a Controlled Vocab by symbolic info, building it if needed. | ||
| */ | ||
| public function build(string $symbolic, int $assocType = 0, int $assocId = 0): ControlledVocab | ||
| { | ||
| return ControlledVocab::withSymbolic($symbolic) | ||
| ->withAssoc($assocType, $assocId) | ||
| ->firstOr(fn() => ControlledVocab::create([ | ||
| 'assocType' => $assocType, | ||
| 'assocId' => $assocId, | ||
| 'symbolic' => $symbolic, | ||
| ])); | ||
| } | ||
|
|
||
| /** | ||
| * Return the Controlled Vocab Entry DAO for this Controlled Vocab. | ||
| * Can be subclassed to provide extended DAOs. | ||
| * | ||
| * Will be removed once the eloquent based settings table relations task completes. | ||
| */ | ||
| public function getEntryDAO(): ControlledVocabEntryDAO | ||
| { | ||
| return DAORegistry::getDAO('ControlledVocabEntryDAO'); | ||
| } | ||
|
|
||
| public function getEntryDaoBySymbolic(string $symbolic): ControlledVocabEntryDAO | ||
| { | ||
| return DAORegistry::getDAO(ucfirst($symbolic) . 'EntryDAO'); | ||
| } | ||
|
|
||
| public function getBySymbolic( | ||
| string $symbolic, | ||
| int $assocType, | ||
| int $assocId, | ||
| array $locales = [], | ||
| ?string $entryDaoClassName = null): array | ||
| { | ||
| $result = []; | ||
|
|
||
| $controlledVocab = $this->build($symbolic, $assocType, $assocId); | ||
|
|
||
| /** @var ControlledVocabEntryDAO $entryDao */ | ||
| $entryDao = $entryDaoClassName | ||
| ? DAORegistry::getDAO($entryDaoClassName) | ||
| : $this->getEntryDaoBySymbolic($symbolic); | ||
|
|
||
| $controlledVocabEntries = $entryDao->getByControlledVocabId($controlledVocab->id); | ||
|
|
||
| while ($vocabEntry = $controlledVocabEntries->next()) { | ||
| $vocabs = $vocabEntry->getData($symbolic); | ||
| foreach ($vocabs as $locale => $value) { | ||
| if (empty($locales) || in_array($locale, $locales)) { | ||
| $result[$locale][] = $value; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return $result; | ||
| } | ||
|
|
||
| /** | ||
| * Get an array of all of the vocabs for given symbolic | ||
| */ | ||
| public function getAllUniqueBySymbolic(string $symbolic): array | ||
| { | ||
| return DB::table('controlled_vocab_entry_settings') | ||
| ->select('setting_value') | ||
| ->where('setting_name', $symbolic) | ||
| ->distinct() | ||
| ->get() | ||
| ->pluck('setting_value') | ||
| ->toArray(); | ||
| } | ||
|
|
||
| /** | ||
| * Add an array of vocabs | ||
| */ | ||
| public function insertBySymbolic( | ||
| string $symbolic, | ||
| array $vocabs, | ||
| int $assocType, | ||
| int $assocId, | ||
| bool $deleteFirst = true, | ||
| ?string $entryDaoClassName = null): void | ||
| { | ||
| /** @var ControlledVocabEntryDAO $entryDao */ | ||
| $entryDao = $entryDaoClassName | ||
| ? DAORegistry::getDAO($entryDaoClassName) | ||
| : $this->getEntryDaoBySymbolic($symbolic); | ||
|
|
||
| $currentControlledVocab = $this->build($symbolic, $assocType, $assocId); | ||
|
|
||
| if ($deleteFirst) { | ||
| collect($currentControlledVocab->enumerate( $symbolic)) | ||
| ->keys() | ||
| ->each(fn (int $id) => $entryDao->deleteObjectById($id)); | ||
| } | ||
|
|
||
| if (is_array($vocabs)) { // localized, array of arrays | ||
| foreach ($vocabs as $locale => $list) { | ||
| if (is_array($list)) { | ||
| $list = array_unique($list); // Remove any duplicate keywords | ||
| $i = 1; | ||
| foreach ($list as $vocab) { | ||
| $vocabEntry = $entryDao->newDataObject(); | ||
| $vocabEntry->setControlledVocabId($currentControlledVocab->id); | ||
| $vocabEntry->setData($symbolic, $vocab, $locale); | ||
| $vocabEntry->setSequence($i); | ||
| $i++; | ||
| $entryDao->insertObject($vocabEntry); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.