ilBibliograficFileReaderBase Class Reference

Class ilBibliograficFileReaderBase. More...

Inheritance diagram for ilBibliograficFileReaderBase:

Collaboration diagram for ilBibliograficFileReaderBase:

Public Member Functions
	readContent ($path_to_file)
	getFileContent ()
	setFileContent ($file_content)
	getPathToFile ()
	setPathToFile ($path_to_file)
Public Member Functions inherited from ilBibliograficFileReader
	readContent ($path_to_file)
	parseContent ()

Data Fields
const	ENCODING_UTF_8 = 'UTF-8'
const	ENCODING_ASCII = 'ASCII'
const	ENCODING_ISO_8859_1 = 'ISO-8859-1'

Protected Member Functions
	convertFiletoUTF8 ()
	convertStringToUTF8 ($string)

Protected Attributes
	$file_content = ''
	$path_to_file = ''

Detailed Description

Class ilBibliograficFileReaderBase.

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 9 of file class.ilBibliograficFileReaderBase.php.

Member Function Documentation

convertFiletoUTF8()

ilBibliograficFileReaderBase::convertFiletoUTF8 ( )

protected

Definition at line 38 of file class.ilBibliograficFileReaderBase.php.

                                               {
                file_put_contents($this->getPathToFile(), $this->convertStringToUTF8(file_get_contents($this->getPathToFile())));
        }

References convertStringToUTF8(), and getPathToFile().

Here is the call graph for this function:

convertStringToUTF8()

ilBibliograficFileReaderBase::convertStringToUTF8 (   $string )

protected

Parameters

$string

Returns

string

Definition at line 48 of file class.ilBibliograficFileReaderBase.php.

                                                        {
                if (!function_exists('mb_detect_encoding') || !function_exists('mb_detect_order')
                    || !function_exists("mb_convert_encoding")
                ) {
                        return $string;
                }
                ob_end_clean();
                $mb_detect_encoding = mb_detect_encoding($string);
                mb_detect_order(array( self::ENCODING_UTF_8, self::ENCODING_ISO_8859_1 ));
                switch ($mb_detect_encoding) {
                        case self::ENCODING_UTF_8:
                                break;
                        case self::ENCODING_ASCII:
                                $string = utf8_encode(iconv(self::ENCODING_ASCII, 'UTF-8//IGNORE', $string));
                                break;
                        default:
                                $string = mb_convert_encoding($string, self::ENCODING_UTF_8, $mb_detect_encoding);
                                break;
                }
 
                return $string;
        }

References ENCODING_ASCII, and ENCODING_UTF_8.

Referenced by convertFiletoUTF8(), and readContent().

Here is the caller graph for this function:

getFileContent()

ilBibliograficFileReaderBase::getFileContent

(

)

Returns

string

Definition at line 75 of file class.ilBibliograficFileReaderBase.php.

                                         {
                return $this->file_content;
        }

References $file_content.

Referenced by ilBibTex\convertBibSpecialChars(), ilBibTex\normalizeContent(), and ilBibTex\parseContent().

Here is the caller graph for this function:

getPathToFile()

ilBibliograficFileReaderBase::getPathToFile

(

)

Returns

string

Definition at line 91 of file class.ilBibliograficFileReaderBase.php.

                                        {
                return $this->path_to_file;
        }

References $path_to_file.

Referenced by convertFiletoUTF8().

Here is the caller graph for this function:

readContent()

ilBibliograficFileReaderBase::readContent

(

$path_to_file

)

Parameters

$path_to_file

Returns

bool

Implements ilBibliograficFileReader.

Definition at line 29 of file class.ilBibliograficFileReaderBase.php.

                                                   {
                $this->setPathToFile($path_to_file);
                //              $this->convertFiletoUTF8();
                $this->setFileContent($this->convertStringToUTF8(file_get_contents($path_to_file)));
 
                return true;
        }

References $path_to_file, convertStringToUTF8(), setFileContent(), and setPathToFile().

Here is the call graph for this function:

setFileContent()

ilBibliograficFileReaderBase::setFileContent

(

$file_content

)

Parameters

string

$file_content

Definition at line 83 of file class.ilBibliograficFileReaderBase.php.

                                                      {
                $this->file_content = $file_content;
        }

References $file_content.

Referenced by ilBibTex\convertBibSpecialChars(), ilBibTex\normalizeContent(), and readContent().

Here is the caller graph for this function:

setPathToFile()

ilBibliograficFileReaderBase::setPathToFile

(

$path_to_file

)

Parameters

string

$path_to_file

Definition at line 99 of file class.ilBibliograficFileReaderBase.php.

                                                     {
                $this->path_to_file = $path_to_file;
        }

References $path_to_file.

Referenced by readContent().

Here is the caller graph for this function:

Field Documentation

$file_content

ilBibliograficFileReaderBase::$file_content = ''

protected

Definition at line 17 of file class.ilBibliograficFileReaderBase.php.

Referenced by getFileContent(), and setFileContent().

$path_to_file

ilBibliograficFileReaderBase::$path_to_file = ''

protected

Definition at line 21 of file class.ilBibliograficFileReaderBase.php.

Referenced by getPathToFile(), readContent(), and setPathToFile().

ENCODING_ASCII

const ilBibliograficFileReaderBase::ENCODING_ASCII = 'ASCII'

Definition at line 12 of file class.ilBibliograficFileReaderBase.php.

Referenced by convertStringToUTF8().

ENCODING_ISO_8859_1

const ilBibliograficFileReaderBase::ENCODING_ISO_8859_1 = 'ISO-8859-1'

Definition at line 13 of file class.ilBibliograficFileReaderBase.php.

ENCODING_UTF_8

const ilBibliograficFileReaderBase::ENCODING_UTF_8 = 'UTF-8'

Definition at line 11 of file class.ilBibliograficFileReaderBase.php.

Referenced by convertStringToUTF8().

---

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

• Modules/Bibliographic/classes/Types/class.ilBibliograficFileReaderBase.php