Skip to content

Commit

Permalink
Merge branch 'master' into master
Browse files Browse the repository at this point in the history
  • Loading branch information
buggedcom committed Sep 7, 2017
2 parents 90addca + 3dc1e0c commit df86fab
Show file tree
Hide file tree
Showing 11 changed files with 71 additions and 70 deletions.
6 changes: 3 additions & 3 deletions src/PHPVideoToolkit/AnimatedGif.php
Expand Up @@ -52,7 +52,7 @@ class AnimatedGif
* @access public
* @author Oliver Lillie
* @param mixed $gif_path If a gif is given then the string path, otherwise if a gif is to be generated, null.
* @param PHPVideoToolkit\Config $config The PHPVideoToolkit\Config object
* @param Config $config The PHPVideoToolkit\Config object
* @throws \RuntimeException If the gif path is set but doesn't exist.
* @throws \RuntimeException If the gif is not readable.
* @throws \InvalidArgumentException If the image supplied is not an image.
Expand Down Expand Up @@ -171,8 +171,8 @@ public function __call($name, $arguments)
* @param array $image_object_array An array of PHPVideoToolkit\Image objects to use to create the animated gif.
* @param mixed $frame_delay An integer or float value to determine the delay between gif frames.
* @param integer $loop_count The number of times the animated gif should loop. Specify -1 for an endless loop.
* @param PHPVideoToolkit\Config $config The PHPVideoToolkit\Config object.
* @return PHPVideoToolkit\AnimatedGif Returns a PHPVideoToolkit\AnimatedGif object.
* @param Config $config The PHPVideoToolkit\Config object.
* @return AnimatedGif Returns a PHPVideoToolkit\AnimatedGif object.
* @throws \InvalidArgumentException If the $image_object_array is empty.
* @throws \InvalidArgumentException If the $frame_delay is less than 0 or not an integer or float.
* @throws \InvalidArgumentException If any of the values within $image_object_array is not an instance of PHPVideoToolkit\Image.
Expand Down
6 changes: 3 additions & 3 deletions src/PHPVideoToolkit/AnimatedGifTranscoderConvert.php
Expand Up @@ -27,8 +27,8 @@ class AnimatedGifTranscoderConvert extends AnimatedGifTranscoderAbstract
* @access public
* @author Oliver Lillie
* @param string $save_path The path to save the animated gif to.
* @return PHPVideoToolkit\Image Returns a new instance of PHPVideoToolkit\Image with the new animated gif as the src.
* @throws PHPVideoToolkit\AnimatedGifException If the convert process encounters an error.
* @return Image Returns a new instance of PHPVideoToolkit\Image with the new animated gif as the src.
* @throws AnimatedGifException If the convert process encounters an error.
*/
public function save($save_path)
{
Expand Down Expand Up @@ -85,7 +85,7 @@ public function save($save_path)
* @access public
* @static
* @author Oliver Lillie
* @param PHPVideoToolkit\Config $config The configuration object.
* @param Config $config The configuration object.
* @return boolean Returns true if this engine can be used, otherwise false.
*/
public static function available(Config $config)
Expand Down
24 changes: 12 additions & 12 deletions src/PHPVideoToolkit/AnimatedGifTranscoderGifsicle.php
Expand Up @@ -32,7 +32,7 @@ class AnimatedGifTranscoderGifsicle extends AnimatedGifTranscoderAbstract
*
* @access public
* @author Oliver Lillie
* @param PHPVideoToolkit\Config $config The PHPVideoToolit\Config object.
* @param Config $config The PHPVideoToolit\Config object.
*/
public function __construct(Config $config=null)
{
Expand Down Expand Up @@ -65,8 +65,8 @@ public function __destruct()
*
* @access public
* @author Oliver Lillie
* @param PHPVideoToolkit\Image $image The image source that you wish to add as a frame to the gif.
* @return PHPVideoToolkit\AnimatedGifTranscoderGifsicle Returns the current object.
* @param Image $image The image source that you wish to add as a frame to the gif.
* @return AnimatedGifTranscoderGifsicle Returns the current object.
*/
public function addFrame(Image $image)
{
Expand All @@ -87,13 +87,13 @@ public function addFrame(Image $image)
* @author Oliver Lillie
* @param string $frame_path The file paht of the image to convert.
* @return string Returns the new file path if the image was converted, otherwise returns the old file path.
* @throws PHPVideoToolkit\AnimatedGifException If imagemagick convert is user but encounters an error.
* @throws AnimatedGifException If imagemagick convert is user but encounters an error.
* @throws \RuntimeException If PHP GD is used and imagegif is not available on the current system.
* @throws PHPVideoToolkit\AnimatedGifException If the image given to convert is not supported by PHP GD.
* @throws PHPVideoToolkit\AnimatedGifException If the image fails to convert to a gif using PHP GD.
* @throws PHPVideoToolkit\AnimatedGifException If the image fails to convert.
* @throws PHPVideoToolkit\AnimatedGifException If the image fails to convert but a path was generated.
* @throws PHPVideoToolkit\AnimatedGifException If the image fails to convert but a file was generated by 0 bytes in size.
* @throws AnimatedGifException If the image given to convert is not supported by PHP GD.
* @throws AnimatedGifException If the image fails to convert to a gif using PHP GD.
* @throws AnimatedGifException If the image fails to convert.
* @throws AnimatedGifException If the image fails to convert but a path was generated.
* @throws AnimatedGifException If the image fails to convert but a file was generated by 0 bytes in size.
*/
protected function _convertFrameToGif($frame_path)
{
Expand Down Expand Up @@ -195,8 +195,8 @@ protected function _convertFrameToGif($frame_path)
* @access public
* @author Oliver Lillie
* @param string $save_path The path to save the animated gif to.
* @return PHPVideoToolkit\Image Returns a new instance of PHPVideoToolkit\Image with the new animated gif as the src.
* @throws PHPVideoToolkit\AnimatedGifException If the convert process encounters an error.
* @return Image Returns a new instance of PHPVideoToolkit\Image with the new animated gif as the src.
* @throws AnimatedGifException If the convert process encounters an error.
*/
public function save($save_path)
{
Expand Down Expand Up @@ -250,7 +250,7 @@ public function save($save_path)
* @access public
* @static
* @author Oliver Lillie
* @param PHPVideoToolkit\Config $config The configuration object.
* @param Config $config The configuration object.
* @return boolean Returns true if this engine can be used, otherwise false.
*/
public static function available(Config $config)
Expand Down
2 changes: 1 addition & 1 deletion src/PHPVideoToolkit/AudioFormat/Wav.php
Expand Up @@ -27,7 +27,7 @@ class AudioFormat_Wav extends AudioFormat
* @author Oliver Lillie
* @param constant $input_output_type Determines the input/output type of the Format. Either PHPVideoToolkit\Format::INPUT
* or PHPVideoToolkit\Format::OUTPUT
* @param PHPVideoToolkit\Config $config The config object.
* @param Config $config The config object.
*/
public function __construct($input_output_type=Format::OUTPUT, Config $config=null)
{
Expand Down
2 changes: 1 addition & 1 deletion src/PHPVideoToolkit/Binary.php
Expand Up @@ -33,7 +33,7 @@ class Binary
* @author Stig Bakken <ssb@php.net>
* @author Oliver Lillie
* @throws \RuntimeException If it's not possible to guess the enviroment paths.
* @throws PHPVideoToolkit\BinaryLocateException If it is not possible to locate the specific programme.
* @throws BinaryLocateException If it is not possible to locate the specific programme.
*/
public static function locate($program, $fallback=null)
{
Expand Down
20 changes: 10 additions & 10 deletions src/PHPVideoToolkit/ExecBuffer.php
Expand Up @@ -237,7 +237,7 @@ public function __construct($exec_command_string, $temp_directory=null, $php_exe
* @access public
* @author Oliver Lillie
* @param string $temp_directory The file path to the temp directory to use.
* @return PHPVideoToolkit\ExecBuffer Returns the current object.
* @return ExecBuffer Returns the current object.
* @throws \InvalidArgumentException If the temp directory path is not a directory.
* @throws \InvalidArgumentException If the temp directory path is not readable.
* @throws \InvalidArgumentException If the temp directory path is not writable.
Expand Down Expand Up @@ -272,7 +272,7 @@ public function setTempDirectory($temp_directory=null)
* @access public
* @author Oliver Lillie
* @param boolean $gc True determines that the temp files are garbage collected. False means they are not.
* @return PHPVideoToolkit\ExecBuffer Returns the current object.
* @return ExecBuffer Returns the current object.
* @throws \InvalidArgumentException If the $gc value is not a boolean.
*/
public function setGarbageCollection($gc)
Expand Down Expand Up @@ -314,7 +314,7 @@ public function __destruct()
* @author Oliver Lillie
* @param mixed $callback A function if provided is called when the exec() call is completed. Otherwise null.
* It should be noted that if a callback is supplied the resulting call to exec() is made blocking.
* @return PHPVideoToolkit\ExecBuffer Returns the current object.
* @return ExecBuffer Returns the current object.
* @throws \InvalidArgumentException If a callback is supplied but not callable.
*/
public function execute($callback=null)
Expand Down Expand Up @@ -412,7 +412,7 @@ protected function _callCompletionCallbacks()
* @access public
* @author Oliver Lillie
* @param mixed $callback A callable callback function.
* @return PHPVideoToolkit\ExecBuffer Returns the current object.
* @return ExecBuffer Returns the current object.
* @throws \InvalidArgumentException If a callback is supplied but not callable.
*/
public function registerCompletionCallback($callback)
Expand Down Expand Up @@ -501,7 +501,7 @@ protected function _run($callback)
*
* @access public
* @author Oliver Lillie
* @return PHPVideoToolkit\ExecBuffer Returns the current object.
* @return ExecBuffer Returns the current object.
*/
public function wait($seconds=1)
{
Expand All @@ -514,7 +514,7 @@ public function wait($seconds=1)
*
* @access public
* @author Oliver Lillie
* @return PHPVideoToolkit\ExecBuffer Returns the current object.
* @return ExecBuffer Returns the current object.
*/
public function stop()
{
Expand Down Expand Up @@ -826,7 +826,7 @@ public function getCommand()
* @access public
* @author Oliver Lillie
* @param boolean $enable_failure_tracking True means that failure tracking is enabled, false turns it off.
* @return PHPVideoToolkit\ExecBuffer Returns the current object.
* @return ExecBuffer Returns the current object.
*/
public function setFailureTracking($enable_failure_tracking)
{
Expand Down Expand Up @@ -857,7 +857,7 @@ public function getFailureTracking()
* @access public
* @author Oliver Lillie
* @param integer $callback_period_interval
* @return PHPVideoToolkit\ExecBuffer Returns the current object.
* @return ExecBuffer Returns the current object.
* @throws \InvalidArgumentException If the callback period interval is not an integer.
*/
public function setCallbackWaitInterval($callback_period_interval)
Expand Down Expand Up @@ -889,7 +889,7 @@ public function getCallbackWaitInterval()
* @access public
* @author Oliver Lillie
* @param boolean $enable_blocking If true the exec() call is made blocking, false means it is non-blocking.
* @return PHPVideoToolkit\ExecBuffer Returns the current object.
* @return ExecBuffer Returns the current object.
* @throws \InvalidArgumentException If the blocking value is not a boolean.
*/
public function setBlocking($enable_blocking)
Expand Down Expand Up @@ -934,7 +934,7 @@ public function getBoundary()
* @author Oliver Lillie
* @param mixed $buffer_output Can be one of the following constants. ExecBuffer::DEV_NULL, ExecBuffer::TEMP,
* a string will be interpretted as a file or null will output everything to sdout.
* @return PHPVideoToolkit\ExecBuffer Returns the current object.
* @return ExecBuffer Returns the current object.
* @throws \InvalidArgumentException If the buffer output value is not null, ExecBuffer::DEV_NULL or ExecBuffer::TEMP
* and the directory path supplied is not a directory.
* @throws \InvalidArgumentException If the buffer output value is not null, ExecBuffer::DEV_NULL or ExecBuffer::TEMP
Expand Down
2 changes: 1 addition & 1 deletion src/PHPVideoToolkit/FfmpegParser.php
Expand Up @@ -29,7 +29,7 @@ class FfmpegParser
*
* @access public
* @author: Oliver Lillie
* @param PHPVideoToolkit\Config $config The config object.
* @param Config $config The config object.
*/
public function __construct(Config $config=null)
{
Expand Down
6 changes: 3 additions & 3 deletions src/PHPVideoToolkit/FfmpegParserGeneric.php
Expand Up @@ -61,7 +61,7 @@ public function getRawCodecData($read_from_cache=true)
* @param boolean $read_from_cache If true and the data exists within a cache then that data is used. If false
* then the data is re-read from ffmpeg.
* @return string Returns the raw buffer data from ffmpeg.
* @throws PHPVideoToolkit\FfmpegProcessException If the call to ffmpeg encounters an error.
* @throws FfmpegProcessException If the call to ffmpeg encounters an error.
*/
public function getRawFiltersData($read_from_cache=true)
{
Expand Down Expand Up @@ -94,7 +94,7 @@ public function getRawFiltersData($read_from_cache=true)
* @param boolean $read_from_cache If true and the data exists within a cache then that data is used. If false
* then the data is re-read from ffmpeg.
* @return string Returns the raw buffer data from ffmpeg.
* @throws PHPVideoToolkit\FfmpegProcessException If the call to ffmpeg encounters an error.
* @throws FfmpegProcessException If the call to ffmpeg encounters an error.
*/
public function getRawBitstreamFiltersData($read_from_cache=true)
{
Expand Down Expand Up @@ -127,7 +127,7 @@ public function getRawBitstreamFiltersData($read_from_cache=true)
* @param boolean $read_from_cache If true and the data exists within a cache then that data is used. If false
* then the data is re-read from ffmpeg.
* @return string Returns the raw buffer data from ffmpeg.
* @throws PHPVideoToolkit\FfmpegProcessException If the call to ffmpeg encounters an error.
* @throws FfmpegProcessException If the call to ffmpeg encounters an error.
*/
public function getRawProtocolsData($read_from_cache=true)
{
Expand Down

0 comments on commit df86fab

Please sign in to comment.