π¦Β Packagist | π₯Β TYPO3 extension repository | πΎΒ Repository | πΒ Issue tracker
An extension for TYPO3 CMS that integrates jobs from Personio Recruiting API into TYPO3. It provides a console command to import jobs into modern-typed value objects. In addition, plugins for list and detail views are provided with preconfigured support for Bootstrap v5 components.
- Console command to import jobs from Personio Recruiting API
- Usage of modern-typed value objects during the import process
- Plugins for list and detail view
- Optional support for JSON Schema on job detail pages using EXT:schema
- Compatible with TYPO3 12.4 LTS and 13.0
composer require cpsit/typo3-personio-jobsπ‘ If you want to use the JSON schema feature, you must
additionally require the schema extension:
composer require brotkrueml/schemaAlternatively, you can download the extension via the TYPO3 extension repository (TER).
Once installed, make sure to include the TypoScript setup at
EXT:personio_jobs/Configuration/TypoScript in your root template.
The extension provides two plugins:
typo3 personio-jobs:import <storage-pid> [options]The following command parameters are available:
| Command parameter | Description | Required | Default |
|---|---|---|---|
storage-pid |
Storage pid of imported jobs | β | β |
-f, --force |
Enforce re-import of unchanged jobs | β | no |
--no-delete |
Do not delete orphaned jobs | β | no |
--no-update |
Do not update imported jobs that have been changed | β | no |
--dry-run |
Do not perform database operations, only display changes | β | no |
π‘ Increase verbosity with --verbose or -v to show all changes,
even unchanged jobs that were skipped.
The Personio job import process can also be triggered directly within PHP. For this, two services exist:
PersonioApiServiceprovides the main functionality to fetch jobs from Personio API and return them as hydratedJobmodels. Note that these jobs are not yet persisted. Instead, they only represent the current Personio job feed as strong-typed value objects.PersonioImportServiceprovides additional functionality to actually persist imported jobs. Under the hood, the previously mentionedPersonioApiServiceis called to fetch jobs, followed by their actual persistence. For the import process, a set of import settings is available:int $storagePid: Page ID where to persist new or updated jobs.bool $updateExistingJobs = true: Define whether to update jobs that were already imported, but have changed in the meantime.bool $deleteOrphans = true: Define whether to delete jobs that are no longer available on Personio.bool $forceImport = false: Select whether existing, unchanged jobs should be re-imported.bool $dryRun = false: Do not perform any persistence operations, just fetch and validate jobs.
use CPSIT\Typo3PersonioJobs\Service\PersonioApiService;
use TYPO3\CMS\Core\Utility\GeneralUtility;
$apiService = GeneralUtility::makeInstance(PersonioApiService::class);
$jobs = $apiService->getJobs();
foreach ($jobs as $job) {
echo 'Successfully fetched job: ' . $job->getName() . PHP_EOL;
}use CPSIT\Typo3PersonioJobs\Service\PersonioImportService;
use TYPO3\CMS\Core\Utility\GeneralUtility;
$importService = GeneralUtility::makeInstance(PersonioImportService::class);
$result = $importService->import();
foreach ($result->getNewJobs() as $newJob) {
echo 'Imported new job: ' . $newJob->getName() . PHP_EOL;
}
foreach ($result->getUpdatedJobs() as $updatedJob) {
echo 'Updated job: ' . $updatedJob->getName() . PHP_EOL;
}
foreach ($result->getRemovedJobs() as $removedJob) {
echo 'Removed job: ' . $removedJob->getName() . PHP_EOL;
}
foreach ($result->getSkippedJobs() as $skippedJob) {
echo 'Skipped job: ' . $skippedJob->getName() . PHP_EOL;
}In combination with EXT:schema, a JSON schema for a single job is included
on job detail pages. It is rendered as type JobPosting and includes some
generic job properties.
schema extension must be installed to use this feature. Read more in
the installation section above.
The following TypoScript constants are available:
| TypoScript constant | Description | Required | Default |
|---|---|---|---|
plugin.tx_personiojobs.view.templateRootPath |
Path to template root | β | β |
plugin.tx_personiojobs.view.partialRootPath |
Path to template partials | β | β |
plugin.tx_personiojobs.view.layoutRootPath |
Path to template layouts | β | β |
The following extension configuration options are available:
| Configuration key | Description | Required | Default |
|---|---|---|---|
apiUrl |
URL to Personio job page, e.g. https://my-company.jobs.personio.de |
β | β |
On each import, a slug is generated. The slug can be used for an advanced routing configuration of job detail pages.
Example:
# config/sites/<identifier>/config.yaml
routeEnhancers:
PersonioJobDetail:
type: Extbase
limitToPages:
# Replace with the actual detail page id
- 10
extension: PersonioJobs
plugin: Show
routes:
-
routePath: '/job/{job_title}'
_controller: 'Job::show'
_arguments:
job_title: job
defaultController: 'Job::show'
aspects:
job_title:
type: PersistedAliasMapper
tableName: tx_personiojobs_domain_model_job
routeFieldName: slugPSR-14 events can be used to modify jobs and job schemas. The following events are available:
Import process is moved to a separate service class.
- All import operations are now performed by the new
PersonioImportServiceclass. PersonioServicewas renamed toPersonioApiService. Replace all usages of this class by the new class name.- Import results are now properly displayed by objects of the new
ImportResultclass. - Public methods in
AfterJobsImportedEventhave changed to match the newImportResultclass. Use the new public methodAfterJobsImportedEvent::getImportResult()instead of previously available methods.
SchemaFactory is now final and cannot
be extended anymore.
- Remove classes extending from
SchemaFactory. - Replace customizations of the
SchemaFactoryby an event listener for theEnrichJobPostingSchemaEventPSR-14 event.
Please have a look at CONTRIBUTING.md.
The Personio logo as part of all distributed icons is a trademark of Personio SE & Co. KG.
This project is licensed under GNU General Public License 2.0 (or later).