Inheritance diagram for ilTermsOfServiceFileSystemDocument:

Collaboration diagram for ilTermsOfServiceFileSystemDocument:

Public Member Functions
	__construct (ilLanguage $lng)

	determine ()

	exists ()
	{ Returns bool } More...

	setLanguageAdapter ($lng)

	getLanguageAdapter ()

	setSourceFiles ($source_directories)

	getSourceFiles ()

	hasContent ()

	getContent ()

	getSource ()

	getSourceType ()

	getIso2LanguageCode ()

Protected Member Functions
	initSourceFiles ()

Protected Attributes
	$lng

	$has_content = false

	$content = ''

	$iso2_language_code = ''

	$source = ''

	$source_files = array()

Additional Inherited Members
Data Fields inherited from ilTermsOfServiceSignableDocument
const	SRC_TYPE_FILE_SYSTEM_PATH = 0

const	SRC_TYPE_OBJECT = 1

Detailed Description

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Version: $Id$

Definition at line 10 of file class.ilTermsOfServiceFileSystemDocument.php.

Constructor & Destructor Documentation

◆ __construct()

ilTermsOfServiceFileSystemDocument::__construct ( ilLanguage $lng )

Parameters

ilLanguage $lng

Definition at line 45 of file class.ilTermsOfServiceFileSystemDocument.php.

References initSourceFiles(), and setLanguageAdapter().

         {
                 $this->setLanguageAdapter($lng);
                 $this->initSourceFiles();
         }

Here is the call graph for this function:

Member Function Documentation

◆ determine()

ilTermsOfServiceFileSystemDocument::determine ( )

Exceptions

ilTermsOfServiceNoSignableDocumentFoundException

Implements ilTermsOfServiceSignableDocument.

Definition at line 54 of file class.ilTermsOfServiceFileSystemDocument.php.

References $content, $file, $iso2_language_code, file, and getSourceFiles().

Referenced by ilTermsOfServiceFileSystemDocumentTest\testClientDocumentCouldBeRetrievedByCurrentLanguage(), ilTermsOfServiceFileSystemDocumentTest\testClientDocumentCouldBeRetrievedByDefaultLanguage(), ilTermsOfServiceFileSystemDocumentTest\testClientDocumentCouldBeRetrievedByEnglishLanguage(), ilTermsOfServiceFileSystemDocumentTest\testGlobalDocumentCouldBeRetrievedByCurrentLanguage(), ilTermsOfServiceFileSystemDocumentTest\testGlobalDocumentCouldBeRetrievedByDefaultLanguage(), and ilTermsOfServiceFileSystemDocumentTest\testGlobalDocumentCouldBeRetrievedByEnglishLanguage().

         {
                 foreach($this->getSourceFiles() as $file => $iso2_language_code)
                 {
                         if(is_file($file) && is_readable($file))
                         {
                                 $this->content = '';
 
                                 $content = file_get_contents($file);
                                 if(strip_tags($content) === $content)
                                 {
                                         $lines         = file($file);
                                         foreach($lines as $line)
                                         {
                                                 $this->content .= nl2br(trim($line));
                                         }
                                 }
                                 else
                                 {
                                         $this->content = $content;
                                 }
 
                                 $this->source             = $file;
                                 $this->has_content        = (bool)strlen($this->content);
                                 $this->iso2_language_code = $iso2_language_code;
                                 return;
                         }
                 }
 
                 require_once 'Services/TermsOfService/exceptions/class.ilTermsOfServiceNoSignableDocumentFoundException.php';
                 throw new ilTermsOfServiceNoSignableDocumentFoundException('Could not find any terms of service document for the passed language object');
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exists()

ilTermsOfServiceFileSystemDocument::exists ( )

{

Returns: bool

}

Implements ilTermsOfServiceSignableDocument.

Definition at line 90 of file class.ilTermsOfServiceFileSystemDocument.php.

         {
                 return true;
         }

◆ getContent()

ilTermsOfServiceFileSystemDocument::getContent ( )

Returns: string

Implements ilTermsOfServiceSignableDocument.

Definition at line 153 of file class.ilTermsOfServiceFileSystemDocument.php.

References $content.

Referenced by ilTermsOfServiceFileSystemDocumentTest\testClientDocumentCouldBeRetrievedByCurrentLanguage(), ilTermsOfServiceFileSystemDocumentTest\testClientDocumentCouldBeRetrievedByDefaultLanguage(), ilTermsOfServiceFileSystemDocumentTest\testClientDocumentCouldBeRetrievedByEnglishLanguage(), ilTermsOfServiceFileSystemDocumentTest\testGlobalDocumentCouldBeRetrievedByCurrentLanguage(), ilTermsOfServiceFileSystemDocumentTest\testGlobalDocumentCouldBeRetrievedByDefaultLanguage(), and ilTermsOfServiceFileSystemDocumentTest\testGlobalDocumentCouldBeRetrievedByEnglishLanguage().

         {
                 return $this->content;
         }

Here is the caller graph for this function:

◆ getIso2LanguageCode()

ilTermsOfServiceFileSystemDocument::getIso2LanguageCode ( )

Returns: string

Implements ilTermsOfServiceSignableDocument.

Definition at line 177 of file class.ilTermsOfServiceFileSystemDocument.php.

References $iso2_language_code.

Referenced by ilTermsOfServiceFileSystemDocumentTest\testClientDocumentCouldBeRetrievedByCurrentLanguage(), ilTermsOfServiceFileSystemDocumentTest\testClientDocumentCouldBeRetrievedByDefaultLanguage(), ilTermsOfServiceFileSystemDocumentTest\testClientDocumentCouldBeRetrievedByEnglishLanguage(), ilTermsOfServiceFileSystemDocumentTest\testGlobalDocumentCouldBeRetrievedByCurrentLanguage(), ilTermsOfServiceFileSystemDocumentTest\testGlobalDocumentCouldBeRetrievedByDefaultLanguage(), and ilTermsOfServiceFileSystemDocumentTest\testGlobalDocumentCouldBeRetrievedByEnglishLanguage().

         {
                 return $this->iso2_language_code;
         }

Here is the caller graph for this function:

◆ getLanguageAdapter()

ilTermsOfServiceFileSystemDocument::getLanguageAdapter ( )

Returns: ilLanguage

Definition at line 121 of file class.ilTermsOfServiceFileSystemDocument.php.

References $lng.

Referenced by initSourceFiles().

         {
                 return $this->lng;
         }

Here is the caller graph for this function:

◆ getSource()

ilTermsOfServiceFileSystemDocument::getSource ( )

Returns: mixed

Implements ilTermsOfServiceSignableDocument.

Definition at line 161 of file class.ilTermsOfServiceFileSystemDocument.php.

References $source.

Referenced by ilTermsOfServiceFileSystemDocumentTest\testClientDocumentCouldBeRetrievedByCurrentLanguage(), ilTermsOfServiceFileSystemDocumentTest\testClientDocumentCouldBeRetrievedByDefaultLanguage(), ilTermsOfServiceFileSystemDocumentTest\testClientDocumentCouldBeRetrievedByEnglishLanguage(), ilTermsOfServiceFileSystemDocumentTest\testGlobalDocumentCouldBeRetrievedByCurrentLanguage(), ilTermsOfServiceFileSystemDocumentTest\testGlobalDocumentCouldBeRetrievedByDefaultLanguage(), and ilTermsOfServiceFileSystemDocumentTest\testGlobalDocumentCouldBeRetrievedByEnglishLanguage().

         {
                 return $this->source;
         }

Here is the caller graph for this function:

◆ getSourceFiles()

ilTermsOfServiceFileSystemDocument::getSourceFiles ( )

Returns: array

Definition at line 137 of file class.ilTermsOfServiceFileSystemDocument.php.

References $source_files.

Referenced by determine().

         {
                 return $this->source_files;
         }

Here is the caller graph for this function:

◆ getSourceType()

ilTermsOfServiceFileSystemDocument::getSourceType ( )

Returns: int

Implements ilTermsOfServiceSignableDocument.

Definition at line 169 of file class.ilTermsOfServiceFileSystemDocument.php.

Referenced by ilTermsOfServiceFileSystemDocumentTest\testClientDocumentCouldBeRetrievedByCurrentLanguage(), ilTermsOfServiceFileSystemDocumentTest\testClientDocumentCouldBeRetrievedByDefaultLanguage(), ilTermsOfServiceFileSystemDocumentTest\testClientDocumentCouldBeRetrievedByEnglishLanguage(), ilTermsOfServiceFileSystemDocumentTest\testGlobalDocumentCouldBeRetrievedByCurrentLanguage(), ilTermsOfServiceFileSystemDocumentTest\testGlobalDocumentCouldBeRetrievedByDefaultLanguage(), and ilTermsOfServiceFileSystemDocumentTest\testGlobalDocumentCouldBeRetrievedByEnglishLanguage().

         {
                 return self::SRC_TYPE_FILE_SYSTEM_PATH;
         }

Here is the caller graph for this function:

◆ hasContent()

ilTermsOfServiceFileSystemDocument::hasContent ( )

Returns: bool

Implements ilTermsOfServiceSignableDocument.

Definition at line 145 of file class.ilTermsOfServiceFileSystemDocument.php.

References $has_content.

Referenced by ilTermsOfServiceFileSystemDocumentTest\testClientDocumentCouldBeRetrievedByCurrentLanguage(), ilTermsOfServiceFileSystemDocumentTest\testClientDocumentCouldBeRetrievedByDefaultLanguage(), ilTermsOfServiceFileSystemDocumentTest\testClientDocumentCouldBeRetrievedByEnglishLanguage(), ilTermsOfServiceFileSystemDocumentTest\testGlobalDocumentCouldBeRetrievedByCurrentLanguage(), ilTermsOfServiceFileSystemDocumentTest\testGlobalDocumentCouldBeRetrievedByDefaultLanguage(), and ilTermsOfServiceFileSystemDocumentTest\testGlobalDocumentCouldBeRetrievedByEnglishLanguage().

         {
                 return $this->has_content;
         }

Here is the caller graph for this function:

◆ initSourceFiles()

ilTermsOfServiceFileSystemDocument::initSourceFiles ( )

protected

Definition at line 98 of file class.ilTermsOfServiceFileSystemDocument.php.

References array, and getLanguageAdapter().

Referenced by __construct().

         {
                 $this->source_files = array(
                         implode('/', array('.', 'Customizing', 'clients', CLIENT_ID, 'agreement', 'agreement_' . $this->getLanguageAdapter()->getLangKey() . '.html'))         => $this->getLanguageAdapter()->getLangKey(),
                         implode('/', array('.', 'Customizing', 'clients', CLIENT_ID, 'agreement', 'agreement_' . $this->getLanguageAdapter()->getDefaultLanguage() . '.html')) => $this->getLanguageAdapter()->getDefaultLanguage(),
                         implode('/', array('.', 'Customizing', 'clients', CLIENT_ID, 'agreement', 'agreement_en.html'))                                                        => 'en',
                         implode('/', array('.', 'Customizing', 'global', 'agreement', 'agreement_' . $this->getLanguageAdapter()->getLangKey() . '.html'))                     => $this->getLanguageAdapter()->getLangKey(),
                         implode('/', array('.', 'Customizing', 'global', 'agreement', 'agreement_' . $this->getLanguageAdapter()->getDefaultLanguage() . '.html'))             => $this->getLanguageAdapter()->getDefaultLanguage(),
                         implode('/', array('.', 'Customizing', 'global', 'agreement', 'agreement_en.html'))                                                                    => 'en'
                 );
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setLanguageAdapter()

ilTermsOfServiceFileSystemDocument::setLanguageAdapter ( $lng )

Parameters

ilLanguage $lng

Definition at line 113 of file class.ilTermsOfServiceFileSystemDocument.php.

References $lng.

Referenced by __construct().

         {
                 $this->lng = $lng;
         }

Here is the caller graph for this function:

◆ setSourceFiles()

ilTermsOfServiceFileSystemDocument::setSourceFiles ( $source_directories )

Parameters

array $source_directories

Definition at line 129 of file class.ilTermsOfServiceFileSystemDocument.php.

         {
                 $this->source_files = $source_directories;
         }

Field Documentation

◆ $content

ilTermsOfServiceFileSystemDocument::$content = ''

protected

Definition at line 25 of file class.ilTermsOfServiceFileSystemDocument.php.

Referenced by determine(), and getContent().

◆ $has_content

ilTermsOfServiceFileSystemDocument::$has_content = false

protected

Definition at line 20 of file class.ilTermsOfServiceFileSystemDocument.php.

Referenced by hasContent().

◆ $iso2_language_code

ilTermsOfServiceFileSystemDocument::$iso2_language_code = ''

protected

Definition at line 30 of file class.ilTermsOfServiceFileSystemDocument.php.

Referenced by determine(), and getIso2LanguageCode().

◆ $lng

ilTermsOfServiceFileSystemDocument::$lng

protected

Definition at line 15 of file class.ilTermsOfServiceFileSystemDocument.php.

Referenced by getLanguageAdapter(), and setLanguageAdapter().

◆ $source

ilTermsOfServiceFileSystemDocument::$source = ''

protected

Definition at line 35 of file class.ilTermsOfServiceFileSystemDocument.php.

Referenced by getSource().

◆ $source_files

ilTermsOfServiceFileSystemDocument::$source_files = array()

protected

Definition at line 40 of file class.ilTermsOfServiceFileSystemDocument.php.

Referenced by getSourceFiles().

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

Services/TermsOfService/classes/class.ilTermsOfServiceFileSystemDocument.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ determine()

◆ exists()

◆ getContent()

◆ getIso2LanguageCode()

◆ getLanguageAdapter()

◆ getSource()

◆ getSourceFiles()

◆ getSourceType()

◆ hasContent()

◆ initSourceFiles()

◆ setLanguageAdapter()

◆ setSourceFiles()

Field Documentation

◆ $content

◆ $has_content

◆ $iso2_language_code

◆ $lng

◆ $source

◆ $source_files