PHP Класс Captioning\File

Наследование: implements captioning\FileInterface
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$cues array
$encoding string
$fileContent string
$filename string
$lineEnding string
$stats array
$useIconv boolean

Открытые методы

Метод Описание
__construct ( null $_filename = null, null $_encoding = null, boolean | false $_useIconv = false ) File constructor.
addCue ( mixed $_mixed, string $_start = null, string $_stop = null ) : File Add a cue
build ( )
changeFPS ( float $_old_fps, float $_new_fps ) : File Converts timecodes based on the specified FPS ratio
convertTo ( string $_output_format ) : mixed
getCue ( integer $_index ) : Cue | null
getCueFromStart ( $_start )
getCues ( ) : array
getCuesCount ( ) : integer
getEncoding ( ) : string
getExpectedCueClass ( captioning\FileInterface $_file, boolean | true $_full_namespace = true ) : string
getFileContent ( ) : string
getFilename ( ) : string
getFirstCue ( ) : Cue | null
getFormat ( captioning\FileInterface $_file ) : mixed
getLastCue ( ) : Cue | null
getStats ( ) Computes reading speed statistics
getUseIconv ( ) : boolean | false
loadFromFile ( null $_filename = null )
loadFromString ( string $_str )
merge ( captioning\FileInterface $_file )
removeCue ( integer $_index ) : File Removes a cue
save ( string $filename = null, boolean $writeBOM = false ) Saves the file
search ( string $_word, boolean $_case_sensitive = false, boolean $_strict = false ) : array Searches a word/expression and returns ids of the matched entries
setEncoding ( string $_encoding )
setFilename ( string $_filename )
setLineEnding ( string $_lineEnding )
setUseIconv ( boolean $_useIconv )
shift ( integer $_time, integer $_startIndex = null, integer $_endIndex = null ) Shifts a range of subtitles a specified amount of time.
sortCues ( ) Sorts cues
sync ( integer $_startIndex, integer $_startTime, integer $_endIndex, integer $_endTime, boolean $_syncLast = true ) : boolean Auto syncs a range of subtitles given their first and last correct times.

Защищенные методы

Метод Описание
encode ( ) Encode file content
getFileContentAsArray ( ) : array
getNextValueFromArray ( array &$array ) : mixed

Описание методов

__construct() публичный Метод

File constructor.
public __construct ( null $_filename = null, null $_encoding = null, boolean | false $_useIconv = false )
$_filename null
$_encoding null
$_useIconv boolean | false

addCue() публичный Метод

Add a cue
public addCue ( mixed $_mixed, string $_start = null, string $_stop = null ) : File
$_mixed mixed An cue instance or a string representing the text
$_start string A timecode
$_stop string A timecode
Результат File

build() публичный Метод

public build ( )

changeFPS() публичный Метод

Converts timecodes based on the specified FPS ratio
public changeFPS ( float $_old_fps, float $_new_fps ) : File
$_old_fps float
$_new_fps float
Результат File

convertTo() публичный Метод

public convertTo ( string $_output_format ) : mixed
$_output_format string
Результат mixed

encode() защищенный Метод

Encode file content
protected encode ( )

getCue() публичный Метод

public getCue ( integer $_index ) : Cue | null
$_index integer
Результат Cue | null

getCueFromStart() публичный Метод

public getCueFromStart ( $_start )

getCues() публичный Метод

public getCues ( ) : array
Результат array

getCuesCount() публичный Метод

public getCuesCount ( ) : integer
Результат integer

getEncoding() публичный Метод

public getEncoding ( ) : string
Результат string

getExpectedCueClass() публичный статический Метод

public static getExpectedCueClass ( captioning\FileInterface $_file, boolean | true $_full_namespace = true ) : string
$_file captioning\FileInterface
$_full_namespace boolean | true
Результат string

getFileContent() публичный Метод

public getFileContent ( ) : string
Результат string

getFileContentAsArray() защищенный Метод

protected getFileContentAsArray ( ) : array
Результат array

getFilename() публичный Метод

public getFilename ( ) : string
Результат string

getFirstCue() публичный Метод

public getFirstCue ( ) : Cue | null
Результат Cue | null

getFormat() публичный статический Метод

public static getFormat ( captioning\FileInterface $_file ) : mixed
$_file captioning\FileInterface
Результат mixed

getLastCue() публичный Метод

public getLastCue ( ) : Cue | null
Результат Cue | null

getNextValueFromArray() защищенный Метод

protected getNextValueFromArray ( array &$array ) : mixed
$array array
Результат mixed

getStats() публичный Метод

Computes reading speed statistics
public getStats ( )

getUseIconv() публичный Метод

public getUseIconv ( ) : boolean | false
Результат boolean | false

loadFromFile() публичный Метод

public loadFromFile ( null $_filename = null )
$_filename null

loadFromString() публичный Метод

public loadFromString ( string $_str )
$_str string

merge() публичный Метод

public merge ( captioning\FileInterface $_file )
$_file captioning\FileInterface

removeCue() публичный Метод

Removes a cue
public removeCue ( integer $_index ) : File
$_index integer
Результат File

save() публичный Метод

Saves the file
public save ( string $filename = null, boolean $writeBOM = false )
$filename string
$writeBOM boolean

setEncoding() публичный Метод

public setEncoding ( string $_encoding )
$_encoding string

setFilename() публичный Метод

public setFilename ( string $_filename )
$_filename string The filename

setLineEnding() публичный Метод

public setLineEnding ( string $_lineEnding )
$_lineEnding string

setUseIconv() публичный Метод

public setUseIconv ( boolean $_useIconv )
$_useIconv boolean

shift() публичный Метод

Shifts a range of subtitles a specified amount of time.
public shift ( integer $_time, integer $_startIndex = null, integer $_endIndex = null )
$_time integer The time to use (ms), which can be positive or negative.
$_startIndex integer The subtitle index the range begins with.
$_endIndex integer The subtitle index the range ends with.

sortCues() публичный Метод

Sorts cues
public sortCues ( )

sync() публичный Метод

The subtitles are first shifted to the first subtitle's correct time, and then proportionally adjusted using the last subtitle's correct time. Based on gnome-subtitles (https://git.gnome.org/browse/gnome-subtitles/)
public sync ( integer $_startIndex, integer $_startTime, integer $_endIndex, integer $_endTime, boolean $_syncLast = true ) : boolean
$_startIndex integer The subtitle index to start the adjustment with.
$_startTime integer The correct start time for the first subtitle.
$_endIndex integer The subtitle index to end the adjustment with.
$_endTime integer The correct start time for the last subtitle.
$_syncLast boolean Whether to sync the last subtitle.
Результат boolean Whether the subtitles could be adjusted

Описание свойств

$cues защищенное свойство

protected array $cues
Результат array

$encoding защищенное свойство

protected string $encoding
Результат string

$fileContent защищенное свойство

protected string $fileContent
Результат string

$filename защищенное свойство

protected string $filename
Результат string

$lineEnding защищенное свойство

protected string $lineEnding
Результат string

$stats защищенное свойство

protected array $stats
Результат array

$useIconv защищенное свойство

protected bool $useIconv
Результат boolean