ilExternalMediaAnalyzer Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilExternalMediaAnalyzer:

Static Public Member Functions
static	isYouTube (string $a_location)
	Identify YouTube links. More...
static	extractYouTubeParameters (string $a_location)
	Extract YouTube Parameter. More...
static	isFlickr (string $a_location)
	Identify Flickr links. More...
static	extractFlickrParameters (string $a_location)
	Extract Flickr Parameter. More...
static	isGoogleVideo (string $a_location)
	Identify GoogleVideo links. More...
static	extractGoogleVideoParameters (string $a_location)
	Extract GoogleVideo Parameter. More...
static	isVimeo (string $a_location)
	Identify Vimeo links. More...
static	extractVimeoParameters (string $a_location)
	Extract Vimeo Parameter. More...
static	getVimeoMetadata (string $vid)
static	getYoutubeMetadata (string $vid)
static	isGoogleDocument (string $a_location)
	Identify Google Document links. More...
static	extractGoogleDocumentParameters (string $a_location)
	Extract GoogleDocument Parameter. More...
static	extractUrlParameters (string $a_location, array $a_parameter)
	Extract URL information to parameter array. More...

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Analyzes external media locations and extracts important information into parameter field.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 25 of file class.ilExternalMediaAnalyzer.php.

Member Function Documentation

extractFlickrParameters()

static ilExternalMediaAnalyzer::extractFlickrParameters ( string  $a_location )

static

Extract Flickr Parameter.

Returns

array<string,string>

Definition at line 81 of file class.ilExternalMediaAnalyzer.php.

     : array {
        $par = array();
        $pos1 = strpos($a_location, "flickr.com/photos/");
        $pos2 = strpos($a_location, "/", $pos1 + 18);
        if ($pos1 > 0) {
            $len = ($pos2 > 0)
                ? $pos2
                : $a_location;
            $par["user_id"] = substr($a_location, $pos1 + 18, $len - ($pos1 + 18));
        }
 
        // tags
        $pos1 = strpos($a_location, "/tags/");
        $pos2 = strpos($a_location, "/", $pos1 + 6);
        if ($pos1 > 0) {
            $len = ($pos2 > 0)
                ? $pos2
                : strlen($a_location);
            $par["tags"] = substr($a_location, $pos1 + 6, $len - ($pos1 + 6));
        }
 
        // sets
        $pos1 = strpos($a_location, "/sets/");
        $pos2 = strpos($a_location, "/", $pos1 + 6);
        if ($pos1 > 0) {
            $len = ($pos2 > 0)
                ? $pos2
                : $a_location;
            $par["sets"] = substr($a_location, $pos1 + 6, $len - ($pos1 + 6));
        }
 
        return $par;
    }

extractGoogleDocumentParameters()

static ilExternalMediaAnalyzer::extractGoogleDocumentParameters ( string  $a_location )

static

Extract GoogleDocument Parameter.

Returns

array<string,string>

Definition at line 238 of file class.ilExternalMediaAnalyzer.php.

     : array {
        $par = array();
        $pos1 = strpos($a_location, "id=");
        $pos2 = strpos($a_location, "&", $pos1 + 3);
        if ($pos1 > 0) {
            $len = ($pos2 > 0)
                ? $pos2
                : strlen($a_location);
            $par["docid"] = substr($a_location, $pos1 + 3, $len - ($pos1 + 3));
        }
        $pos1 = strpos($a_location, "docID=");
        $pos2 = strpos($a_location, "&", $pos1 + 6);
        if ($pos1 > 0) {
            $len = ($pos2 > 0)
                ? $pos2
                : strlen($a_location);
            $par["docid"] = substr($a_location, $pos1 + 6, $len - ($pos1 + 6));
        }
        if (strpos($a_location, "Presentation?") > 0) {
            $par["type"] = "Presentation";
        }
        if (strpos($a_location, "View?") > 0) {
            $par["type"] = "Document";
        }
 
        return $par;
    }

extractGoogleVideoParameters()

static ilExternalMediaAnalyzer::extractGoogleVideoParameters ( string  $a_location )

static

Extract GoogleVideo Parameter.

Returns

array<string,string>

Definition at line 133 of file class.ilExternalMediaAnalyzer.php.

     : array {
        $par = array();
        $pos1 = strpos($a_location, "docid=");
        $pos2 = strpos($a_location, "&", $pos1 + 6);
        if ($pos1 > 0) {
            $len = ($pos2 > 0)
                ? $pos2
                : strlen($a_location);
            $par["docid"] = substr($a_location, $pos1 + 6, $len - ($pos1 + 6));
        }
 
        return $par;
    }

extractUrlParameters()

static ilExternalMediaAnalyzer::extractUrlParameters ( string  $a_location, array  $a_parameter  )

static

Extract URL information to parameter array.

Returns

array<string,string>

Definition at line 272 of file class.ilExternalMediaAnalyzer.php.

     : array {
        $ext_par = array();
 
        // YouTube
        if (ilExternalMediaAnalyzer::isYouTube($a_location)) {
            $ext_par = ilExternalMediaAnalyzer::extractYouTubeParameters($a_location);
            $a_parameter = array();
        }
 
        // Flickr
        if (ilExternalMediaAnalyzer::isFlickr($a_location)) {
            $ext_par = ilExternalMediaAnalyzer::extractFlickrParameters($a_location);
            $a_parameter = array();
        }
 
        // GoogleVideo
        if (ilExternalMediaAnalyzer::isGoogleVideo($a_location)) {
            $ext_par = ilExternalMediaAnalyzer::extractGoogleVideoParameters($a_location);
            $a_parameter = array();
        }
 
        // GoogleDocs
        if (ilExternalMediaAnalyzer::isGoogleDocument($a_location)) {
            $ext_par = ilExternalMediaAnalyzer::extractGoogleDocumentParameters($a_location);
            $a_parameter = array();
        }
 
        foreach ($ext_par as $name => $value) {
            $a_parameter[$name] = $value;
        }
 
        return $a_parameter;
    }

References extractYouTubeParameters().

Referenced by ilMediaItem\extractUrlParameters().

Here is the call graph for this function:

Here is the caller graph for this function:

extractVimeoParameters()

static ilExternalMediaAnalyzer::extractVimeoParameters ( string  $a_location )

static

Extract Vimeo Parameter.

Returns

array<string,string>

Definition at line 165 of file class.ilExternalMediaAnalyzer.php.

     : array {
        $par = array();
        $pos1 = strpos($a_location, "vimeo.com/");
        $pos2 = strpos($a_location, "&", $pos1 + 10);
        if ($pos1 > 0) {
            $len = ($pos2 > 0)
                ? $pos2
                : strlen($a_location);
            $par["id"] = substr($a_location, $pos1 + 10, $len - ($pos1 + 10));
        }
 
        return $par;
    }

Referenced by ilMediaItem\determineDuration(), ilObjMediaObject\getExternalMetadata(), ilMediaItem\getLocationSrc(), and ilObjMediaObject\getXML().

Here is the caller graph for this function:

extractYouTubeParameters()

static ilExternalMediaAnalyzer::extractYouTubeParameters ( string  $a_location )

static

Extract YouTube Parameter.

Returns

array<string,string>

Definition at line 44 of file class.ilExternalMediaAnalyzer.php.

     : array {
        $par = array();
        $pos1 = strpos($a_location, "v=");
        $pos2 = strpos($a_location, "&", $pos1);
        if ($pos1 > 0) {
            $len = ($pos2 > 0)
                ? $pos2
                : strlen($a_location);
            $par["v"] = substr($a_location, $pos1 + 2, $len - ($pos1 + 2));
        } elseif (strpos($a_location, "youtu.be") > 0) {
            $par["v"] = substr($a_location, strrpos($a_location, "/") + 1);
        }
        $qpos = strpos($par["v"] ?? "", "?");
        if (is_int($qpos)) {
            $par["v"] = substr($par["v"], 0, $qpos);
        }
        return $par;
    }

Referenced by extractUrlParameters(), and ilMediaItem\getLocationSrc().

Here is the caller graph for this function:

getVimeoMetadata()

static ilExternalMediaAnalyzer::getVimeoMetadata ( string  $vid )

static

Definition at line 181 of file class.ilExternalMediaAnalyzer.php.

                                                        : array
    {
        $json_url = 'https://vimeo.com/api/oembed.json?url=https%3A//vimeo.com/' . $vid;
 
        $curl = curl_init($json_url);
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
        curl_setopt($curl, CURLOPT_TIMEOUT, 10);
        curl_setopt($curl, CURLOPT_FOLLOWLOCATION, 1);
        curl_setopt($curl, CURLOPT_REFERER, ILIAS_HTTP_PATH);
 
        $return = curl_exec($curl);
        curl_close($curl);
 
        $r = json_decode($return, true);
 
        if ($return === false || is_null($r)) {
            throw new ilExternalMediaApiException("Could not connect to vimeo API at $json_url.");
        }
        return $r;
    }

Referenced by ilMediaItem\determineDuration(), and ilObjMediaObject\getExternalMetadata().

Here is the caller graph for this function:

getYoutubeMetadata()

static ilExternalMediaAnalyzer::getYoutubeMetadata ( string  $vid )

static

Definition at line 202 of file class.ilExternalMediaAnalyzer.php.

                                                          : array
    {
        $json_url = 'https://www.youtube.com/oembed?url=http%3A//youtube.com/watch%3Fv%3D' . $vid . '&format=json';
        $curl = curl_init($json_url);
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
        curl_setopt($curl, CURLOPT_TIMEOUT, 10);
        curl_setopt($curl, CURLOPT_FOLLOWLOCATION, 1);
        curl_setopt($curl, CURLOPT_REFERER, ILIAS_HTTP_PATH);
 
        $return = curl_exec($curl);
        curl_close($curl);
 
        $r = json_decode($return, true);
 
        if ($return === false || is_null($r)) {
            throw new ilExternalMediaApiException("Could not connect to youtube API at $json_url.");
        }
        return $r;
    }

Referenced by ilObjMediaObject\getExternalMetadata().

Here is the caller graph for this function:

isFlickr()

static ilExternalMediaAnalyzer::isFlickr ( string  $a_location )

static

Identify Flickr links.

Definition at line 68 of file class.ilExternalMediaAnalyzer.php.

     : bool {
        if (strpos($a_location, "flickr.com") > 0) {
            return true;
        }
        return false;
    }

isGoogleDocument()

static ilExternalMediaAnalyzer::isGoogleDocument ( string  $a_location )

static

Identify Google Document links.

Definition at line 225 of file class.ilExternalMediaAnalyzer.php.

     : bool {
        if (strpos($a_location, "docs.google") > 0) {
            return true;
        }
        return false;
    }

isGoogleVideo()

static ilExternalMediaAnalyzer::isGoogleVideo ( string  $a_location )

static

Identify GoogleVideo links.

Definition at line 120 of file class.ilExternalMediaAnalyzer.php.

     : bool {
        if (strpos($a_location, "video.google") > 0) {
            return true;
        }
        return false;
    }

isVimeo()

static ilExternalMediaAnalyzer::isVimeo ( string  $a_location )

static

Identify Vimeo links.

Definition at line 152 of file class.ilExternalMediaAnalyzer.php.

     : bool {
        if (strpos($a_location, "vimeo.com") > 0) {
            return true;
        }
        return false;
    }

Referenced by ilMediaItem\determineDuration(), and ilObjMediaObject\getExternalMetadata().

Here is the caller graph for this function:

isYouTube()

static ilExternalMediaAnalyzer::isYouTube ( string  $a_location )

static

Identify YouTube links.

Definition at line 30 of file class.ilExternalMediaAnalyzer.php.

     : bool {
        if (strpos($a_location, "youtube.com") > 0 ||
                strpos($a_location, "youtu.be") > 0) {
            return true;
        }
        return false;
    }

---

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

• components/ILIAS/MediaObjects/classes/class.ilExternalMediaAnalyzer.php