ILIAS\ContentPage\PageMetrics\PageMetricsService Class Reference

Inheritance diagram for ILIAS\ContentPage\PageMetrics\PageMetricsService:

Collaboration diagram for ILIAS\ContentPage\PageMetrics\PageMetricsService:

Public Member Functions
	__construct (PageMetricsRepository $pageMetricsRepository, Factory $refinery)
	PageMetricsService constructor. More...
	store (StorePageMetricsCommand $command)
	get (GetPageMetricsCommand $command)

Protected Member Functions
	doesPageExistsForLanguage (int $contentPageId, string $language)
	ensurePageObjectExists (int $contentPageId, string $language)

Private Attributes
	$pageMetricsRepository
	$refinery

Additional Inherited Members
Data Fields inherited from ilContentPageObjectConstants
const	OBJ_TYPE = 'copa'
const	HTTP_PARAM_PAGE_EDITOR_STYLE_CONTEXT = 'page_editor_style'
const	UI_CMD_VIEW = 'view'
const	UI_CMD_EDIT = 'edit'
const	UI_CMD_UPDATE = 'update'
const	UI_CMD_COPAGE_EDIT = 'edit'
const	UI_CMD_COPAGE_DOWNLOAD_FILE = 'downloadFile'
const	UI_CMD_COPAGE_DISPLAY_FULLSCREEN = 'displayMediaFullscreen'
const	UI_CMD_COPAGE_DISPLAY_MEDIA = 'displayMedia'
const	UI_CMD_COPAGE_DOWNLOAD_PARAGRAPH = 'download_paragraph'
const	UI_CMD_STYLES_EDIT = 'editStyleProperties'
const	UI_TAB_ID_CONTENT = 'content'
const	UI_TAB_ID_INFO = 'info_short'
const	UI_TAB_ID_SETTINGS = 'settings'
const	UI_TAB_ID_ICON = 'icon'
const	UI_TAB_ID_STYLE = 'style'
const	UI_TAB_ID_I18N = 'i18n'
const	UI_TAB_ID_LP = 'learning_progress'
const	UI_TAB_ID_EXPORT = 'export'
const	UI_TAB_ID_PERMISSIONS = 'perm_settings'

Detailed Description

Definition at line 20 of file PageMetricsService.php.

Constructor & Destructor Documentation

__construct()

ILIAS\ContentPage\PageMetrics\PageMetricsService::__construct	(	PageMetricsRepository	$pageMetricsRepository,
		Factory	$refinery
	)

PageMetricsService constructor.

Parameters

PageMetricsRepository	$pageMetricsRepository
Factory	$refinery

Definition at line 32 of file PageMetricsService.php.

    {
        $this->pageMetricsRepository = $pageMetricsRepository;
        $this->refinery = $refinery;
    }

References ILIAS\ContentPage\PageMetrics\PageMetricsService\$pageMetricsRepository, and ILIAS\ContentPage\PageMetrics\PageMetricsService\$refinery.

Member Function Documentation

doesPageExistsForLanguage()

ILIAS\ContentPage\PageMetrics\PageMetricsService::doesPageExistsForLanguage ( int  $contentPageId, string  $language  )

protected

Parameters

int	$contentPageId
string	$language

Returns

bool

Definition at line 43 of file PageMetricsService.php.

                                                                                       : bool
    {
        return ilContentPagePage::_exists(self::OBJ_TYPE, $contentPageId, $language, true);
    }

References ilPageObject\_exists().

Referenced by ILIAS\ContentPage\PageMetrics\PageMetricsService\ensurePageObjectExists().

Here is the call graph for this function:

Here is the caller graph for this function:

ensurePageObjectExists()

ILIAS\ContentPage\PageMetrics\PageMetricsService::ensurePageObjectExists ( int  $contentPageId, string  $language  )

protected

Parameters

int	$contentPageId
string	$language

Definition at line 52 of file PageMetricsService.php.

                                                                                    : void
    {
        if (!$this->doesPageExistsForLanguage($contentPageId, $language)) {
            $pageObject = new ilContentPagePage();
            $pageObject->setParentId($contentPageId);
            $pageObject->setId($contentPageId);
            $pageObject->setLanguage($language);
            $pageObject->createFromXML();
        }
    }

References ILIAS\ContentPage\PageMetrics\PageMetricsService\doesPageExistsForLanguage().

Referenced by ILIAS\ContentPage\PageMetrics\PageMetricsService\store().

Here is the call graph for this function:

Here is the caller graph for this function:

get()

ILIAS\ContentPage\PageMetrics\PageMetricsService::get

(

GetPageMetricsCommand

$command

)

Parameters

GetPageMetricsCommand

$command

Returns

PageMetrics

Exceptions

CouldNotFindPageMetrics

Definition at line 96 of file PageMetricsService.php.

                                                        : PageMetrics
    {
        return $this->pageMetricsRepository->findBy(
            $command->getContentPageId(),
            $command->getContentPageId(),
            $command->getLanguage()
        );
    }

store()

ILIAS\ContentPage\PageMetrics\PageMetricsService::store

(

StorePageMetricsCommand

$command

)

Parameters

StorePageMetricsCommand

$command

Exceptions

ilException

Definition at line 67 of file PageMetricsService.php.

                                                            : void
    {
        $this->ensurePageObjectExists($command->getContentPageId(), $command->getLanguage());
 
        $pageObjectGUI = new ilContentPagePageGUI($command->getContentPageId(), 0, false, $command->getLanguage());
        $pageObjectGUI->setEnabledTabs(false);
        $pageObjectGUI->setFileDownloadLink(ILIAS_HTTP_PATH);
        $pageObjectGUI->setFullscreenLink(ILIAS_HTTP_PATH);
        $pageObjectGUI->setSourcecodeDownloadScript(ILIAS_HTTP_PATH);
        $pageObjectGUI->setProfileBackUrl(ILIAS_HTTP_PATH);
        $text = $pageObjectGUI->getHTML();
 
        $readingTimeTransformation = $this->refinery->string()->estimatedReadingTime();
        $readingTime = new PageReadingTime($readingTimeTransformation->transform($text));
 
        $pageMetrics = new PageMetrics(
            $command->getContentPageId(),
            $command->getContentPageId(),
            $command->getLanguage(),
            $readingTime
        );
        $this->pageMetricsRepository->store($pageMetrics);
    }

References ILIAS\ContentPage\PageMetrics\PageMetricsService\ensurePageObjectExists(), ILIAS\ContentPage\PageMetrics\Command\StorePageMetricsCommand\getContentPageId(), and ILIAS\ContentPage\PageMetrics\Command\StorePageMetricsCommand\getLanguage().

Here is the call graph for this function:

Field Documentation

$pageMetricsRepository

ILIAS\ContentPage\PageMetrics\PageMetricsService::$pageMetricsRepository

private

Definition at line 23 of file PageMetricsService.php.

Referenced by ILIAS\ContentPage\PageMetrics\PageMetricsService\__construct().

$refinery

ILIAS\ContentPage\PageMetrics\PageMetricsService::$refinery

private

Definition at line 25 of file PageMetricsService.php.

Referenced by ILIAS\ContentPage\PageMetrics\PageMetricsService\__construct().

---

The documentation for this class was generated from the following file:

• Modules/ContentPage/classes/PageMetrics/PageMetricsService.php