Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

improvements to doc file

  • Loading branch information...
commit d6c5593633a252ce66527b713830c96d5b7d2e98 1 parent a395435
@kaviththiranga authored
Showing with 8 additions and 2 deletions.
  1. +8 −2 docs/manual/en-US/chapters/packages/media.md
View
10 docs/manual/en-US/chapters/packages/media.md
@@ -32,8 +32,11 @@ Abstract class `JMediaCompressor` defines functions to compress contents of a fi
```
##### Available static functions in JMediaCompressor
+1. static function getInstance() can be used to obtain a compressor object. This function takes an array of options as the
+argument.
-Static function compressString() can be used to compress a string without creating and getting a compressor object.
+
+2. static function compressString() can be used to compress a string without creating and getting a compressor object.
It needs two arguments, source string and options.
*Example* : How to use JMediaCompressor::compressString()
@@ -48,7 +51,9 @@ It needs two arguments, source string and options.
```
-Static function compressFiles() takes three arguments, source file, options and destination file.
+3. static function compressFiles() takes three arguments, source file, options and destination file. It will compress the contents of source
+file using the given options and write the compressed contents into destination file.
+static function isSupported() can be used to check whether there is a compressor supported for a particular file type.
*Example* : How to use JMediaCompressor::compressFile()
@@ -133,3 +138,4 @@ Abstract class `JMediaCollection` defines functions to combine several files int
file_put_contents(__DIR__.'combined.min.css', $collection->getCombined());
```
+##### Available static functions in JMediaCollection
Please sign in to comment.
Something went wrong with that request. Please try again.