README

A php library to getting the subtitle data and files from subscene.com website with smart filter.

Installation

Using Composer

It's recomended to install this library by Composer :

composer require "hsnfirdaus/subscene-sdk"

or you can just manually download this repository as zip and extract to your project directory.

Notice

If you are using the V1 of this library, please read the (README.v1.md)

Usage

Calling Class

To begin, just require the autoloader of composer :

require __DIR__ . '/vendor/autoload.php';

or if you download this script manually, require the /src/Subscene.php file :

require __DIR__ . '/subscene-sdk/src/Subscene.php';

then you just call the Subscene class like this :

$subscene = new Hsnfirdaus\Subscene();

Getting Result

This class support to get result as Array or JSON. Just call getArray() method or getJSON() method. All method will response three object/array : type,info, and result.

Error Handling

You can use try{ } catch() { } Exception to handling error.

Exception Name	Description
`CURLError`	Something wrong with cURL
`PageStructurError`	Cannot match content from cURL Result, maybe subscene page structure has been changed.
`FunctionError`	Error when running method, maybe you wrong call the method.

Search

This method is using to search movie or series that subtitle is available in subscene.

Example Request

$subscene = new Hsnfirdaus\Subscene();
$search = $subscene->search($query);
print_r($search->getArray());

Parameters

Parameter	Type	Default Value	Details
`$query`	`string`	null	The title for movie/series that you want to search.

Example Response

Example $subscene->search('ncis')->getArray() response :

Array
(
    [type] => SEARCH
    [info] => Array
        (
            [search_query] => ncis
        )

    [result] => Array
        (
            [0] => Array
                (
                    [permalink] => ncis-los-angeles-twelfth-season
                    [title] => NCIS: Los Angeles - Twelfth Season
                    [year] => 
                    [count] => 27
                    [in_heading] => TV-Series
                    [season] => 12
                )

            [1] => Array
                (
                    [permalink] => ncis-new-orleans-seventh-season
                    [title] => NCIS: New Orleans - Seventh Season
                    [year] => 
                    [count] => 11
                    [in_heading] => TV-Series
                    [season] => 7
                )

            [2] => Array
                (
                    [permalink] => ncis-eighteenth-season
                    [title] => NCIS: Naval Criminal Investigative Service (Navy CIS) - Eighteenth Season
                    [year] => 
                    [count] => 37
                    [in_heading] => TV-Series
                    [season] => 18
                )
        )

)

listSubtitle

This method is using to listing subtitle from specific permalink.

Example Request

$subscene = new Hsnfirdaus\Subscene();
$listSubtitle = $subscene->listSubtitle($permalink);
print_r($listSubtitle->getArray());

Parameters

Parameter	Type	Default Value	Details
`$permalink`	`string`	null	The permalink of page that you will looking for list subtitle.

Example Response

Example $subscene->listSubtitle('ncis-eighteenth-season')->getArray() response :

getSubtitle

This method is using to generate download link and information of specific subtitle.

Example Request

$subscene = new Hsnfirdaus\Subscene();
$getSubtitle = $subscene->getSubtitle($permalink,$lang_code,$id)
print_r($getSubtitle->getArray());

Parameters

Parameter	Type	Default Value	Details
`$permalink`	`string`	null	The permalink of page that you will get the subtitle.
`$lang_code`	`string`	null	The language code of subtitle.
`$id`	`integer`	null	The id of subtitle.

Example Response

Example $subscene->getSubtitle('ncis-eighteenth-season','english',2391412)->getArray() response :

smartFilterSeries

This method is using to smart filtering result from listSubtitle, to get episode from specific release from tv series.

Example Request

$subscene = new Hsnfirdaus\Subscene();
$listSubtitle=$subscene->listSubtitle('ncis-eighteenth-season');
$filter = $listSubtitle->smartFilterSeries($language,$primary_type,$option);
print_r($search->getArray());

Parameters

Parameter	Type	Default Value	Details
`$language`	`string`	english	The language code/name that you will looking for (example : english).
`$primary_type`	`array`	`['hdtv']`	Primary subtitle type (example : ['amzn','web','hdtv']).
`$option`	`array`	null	Optional Option : `season` : Season number of series, default will getting season from title. `start_episode` : Start episode that will looking for, default : 1. `end_episode` : End episode that will looking for, default is loop until end. `hearing_impaired` : Is looking for hi subtitle? set true or false, default : false.

Example Response

Example :

$listSubtitle=$subscene->listSubtitle('ncis-eighteenth-season');
$filter=$listSubtitle->smartFilterSeries('english',['amzn','web'],[
    'start_episode'=>1,
    'end_episode'=>3,
    'hearing_impaired'=>FALSE
]);
print_r($filter->getArray());

Response :

smartDownloadSeries

This method is try to download and unzip subtitle from smartFilterSeries result.

Example Request

$subscene = new Hsnfirdaus\Subscene();
$listSubtitle=$subscene->listSubtitle('ncis-eighteenth-season');
$filter=$listSubtitle->smartFilterSeries('english',['amzn','web'],[
    'start_episode'=>1,
    'end_episode'=>3,
    'hearing_impaired'=>FALSE
]);
$download=$filter->smartDownloadSeries($folder_target,$name_format);
print_r($download->getArray());

Parameters

Parameter	Type	Default Value	Details
`$folder_target`	`string`	`__DIR__.'/../../../../`	The target folder that downloaded srt subtitle will saved.
`$name_format`	`string`	Rename subtitle to this string, example : 'NCIS - S%sE%s'

Example Response

Example :

$listSubtitle=$subscene->listSubtitle('ncis-eighteenth-season');
$filter=$listSubtitle->smartFilterSeries('english',['amzn','web'],[
    'start_episode'=>1,
    'end_episode'=>3,
    'hearing_impaired'=>FALSE
]);
$download=$filter->smartDownloadSeries(__DIR__,'NCIS - S%sE%s');
print_r($filter->getArray());

Response :

Array
(
    [type] => SMART_DOWNLOAD_SERIES
    [info] => Array
        (
            [permalink] => ncis-eighteenth-season
            [title] => NCIS: Naval Criminal Investigative Service (Navy CIS) - Eighteenth Season
            [year] => 2020
            [poster] => https://i.jeded.com/i/ncis-eighteenth-season.196526.jpg
            [imdb_id] => tt0364845
            [season] => 18
            [total_episode] => 2
            [language] => english
            [primary_type] => Array
                (
                    [0] => amzn
                    [1] => web
                )

            [missing_episode] => Array
                (
                )

        )

    [result] => Array
        (
            [folder_target] => /htdocs/subtitle
            [file_failed] => Array
                (
                )

            [file_saved] => Array
                (
                    [0] => NCIS - S18E01.srt
                    [1] => NCIS - S18E02.srt
                    [2] => NCIS - S18E03.srt
                )

        )

)

hsnfirdaus / subscene-sdk

Maintainers

Details

README

Installation

Using Composer

Notice

Usage

Calling Class

Getting Result

Error Handling

List Of Method

Search

Example Request

Parameters

Example Response

listSubtitle

Example Request

Parameters

Example Response

getSubtitle

Example Request

Parameters

Example Response

smartFilterSeries

Example Request

Parameters

Example Response

smartDownloadSeries

Example Request

Parameters

Example Response