djoudi / Laravel-H5P

src/LaravelH5p/LaravelH5p.php

<?php

/*
 *
 * @Project        djoudi/laravel-h5p
 * @Copyright      Djoudi
 * @Created        2017-02-21
 * @Filename       LaravelH5p.php
 * @Description
 *
 */

namespace Djoudi\LaravelH5p;

use Djoudi\LaravelH5p\Repositories\EditorAjaxRepository;
use Djoudi\LaravelH5p\Repositories\LaravelH5pRepository;
use Djoudi\LaravelH5p\Storages\EditorStorage;
use Djoudi\LaravelH5p\Storages\LaravelH5pStorage;
use H5PContentValidator;
use H5PCore;
//use H5PDevelopment;
//use H5PDefaultStorage;
//use H5PEditorEndpoints;
//use H5PEditorAjax;
//use H5PEditorAjaxInterface;
//use H5peditorFile;
//use H5peditorStorage;
use H5peditor;
use H5PExport;
use H5PStorage;
use H5PValidator;
use Illuminate\Support\Facades\Auth;

//H5P_Plugin
class LaravelH5p
{
    /**
     * Instance of H5P WordPress Framework Interface.
     *
     * @since 1.0.0
     *
     * @var \LaravelH5pFramwork

The type LaravelH5pFramwork was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public static $core = null;
    public static $h5peditor = null;
    public static $interface = null;
    public static $validator = null;
    public static $storage = null;
    public static $contentvalidator = null;
    public static $export = null;
    public static $settings = null;

    public function __construct()
    {
        self::$interface = new LaravelH5pRepository();
        self::$core = new H5PCore(self::$interface, self::get_h5p_storage('', true), self::get_h5p_url(), config('laravel-h5p.language'), config('laravel-h5p.h5p_export'));

It seems like new H5PCore(self::interface, self::get_h5p_storage('', true), self::get_h5p_url(), config('laravel-h5p.language'), config('laravel-h5p.h5p_export')) of type H5PCore is incompatible with the declared type LaravelH5pFramwork of property $core.

        self::$core->aggregateAssets = config('laravel-h5p.H5P_DISABLE_AGGREGATION');

The property aggregateAssets does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        self::$validator = new H5PValidator(self::$interface, self::$core);
        self::$storage = new H5PStorage(self::$interface, self::$core);
        self::$contentvalidator = new H5PContentValidator(self::$interface, self::$core);
        self::$export = new H5PExport(self::$interface, self::$core);
        self::$h5peditor = new H5peditor(self::$core, new EditorStorage(), new EditorAjaxRepository());
        // self::$h5peditor = new H5peditor(self::$core, new EditorStorage(), new EditorAjaxRepository());
    }

    /**
     * Parse version string into smaller components.
     *
     * @since 1.7.9
     *
     * @param string $version
     *
     * @return stdClass|bool False on failure to parse

The type Djoudi\LaravelH5p\stdClass was not found. Did you mean stdClass? If so, make sure to prefix the type with \.

     */
    public static function split_version($version)
    {
        $version_parts = explode('.', $version);
        if (count($version_parts) !== 3) {
            return false;
        }

        return (object) [
            'major' => (int) $version_parts[0],
            'minor' => (int) $version_parts[1],
            'patch' => (int) $version_parts[2],
        ];
    }

    public static function get_url($path = '')
    {
        return url('/assets/vendor'.$path);
    }

    public static function get_h5p_storage($path = '', $absolute = false)
    {
        if ($absolute) {
            return new LaravelH5pStorage(storage_path('h5p'.$path));
//            return storage_path('h5p' . $path);
        } else {
            return self::get_url('/h5p'.$path);
        }
    }

    public static function get_laravelh5p_url($path = '')
    {
        return self::get_url('/laravel-h5p'.$path);
    }

    public static function get_h5p_url($path = '')
    {
        return self::get_url('/h5p'.$path);
    }

    public static function get_h5pcore_url($path = '')
    {
        return self::get_h5p_url('/h5p-core'.$path);
    }

    public static function get_h5peditor_url($path = '')
    {
        return self::get_h5p_url('/h5p-editor'.$path);
    }

    public static function get_h5plibrary_url($path = '', $absolute = false)
    {
        $return = self::get_url('/h5p'.$path);

        if ($absolute) {
            return storage_path('h5p/'.realpath($return));
//            return storage('/h5p/libraries' . $path);
        } else {
            return $return;
        }
    }

    public static function get_service_url($path = '')

The parameter $path is not used and could be removed.

    {
        return route('h5p.index', [], false);
    }

    public static function get_core($settings = [])
    {
        $settings = self::get_core_settings($settings);

The call to Djoudi\LaravelH5p\LaravelH5p::get_core_settings() has too many arguments starting with $settings.

        $settings = self::get_core_files($settings);

        return $settings;
    }

    public static function get_editor($content = null)
    {
        $settings = self::get_editor_settings($content);
        $settings = self::get_editor_assets($settings, $content);

        return $settings;
    }

    /**
     * Include settings and assets for the given content.
     *
     * @since 1.0.0
     *
     * @param array $content
     * @param bool  $no_cache
     *
     * @return string Embed code
     */
    public function get_embed($content, $settings, $no_cache = false)

The parameter $no_cache is not used and could be removed.

    {
        // Detemine embed type
        $embed = H5PCore::determineEmbedType($content['embedType'], $content['library']['embedTypes']);
        // Make sure content isn't added twice
        $cid = 'cid-'.$content['id'];
        if (!isset($settings['contents'][$cid])) {
            $settings['contents'][$cid] = self::get_content_settings($content);

$content of type array is incompatible with the type Djoudi\LaravelH5p\type expected by parameter $content of Djoudi\LaravelH5p\LaravelH5p::get_content_settings().

            $core = self::$core;
            // Get assets for this content
            $preloaded_dependencies = $core->loadContentDependencies($content['id'], 'preloaded');
            $files = $core->getDependenciesFiles($preloaded_dependencies);
            self::alter_assets($files, $preloaded_dependencies, $embed);
            if ($embed === 'div') {
                foreach ($files['scripts'] as $script) {
                    $url = $script->path.$script->version;
                    if (!in_array($url, $settings['loadedJs'])) {
                        $settings['loadedJs'][] = self::get_h5plibrary_url($url);
                    }
                }
                foreach ($files['styles'] as $style) {
                    $url = $style->path.$style->version;
                    if (!in_array($url, $settings['loadedCss'])) {
                        $settings['loadedCss'][] = self::get_h5plibrary_url($url);
                    }
                }
            } elseif ($embed === 'iframe') {
                $settings['contents'][$cid]['scripts'] = $core->getAssetsUrls($files['scripts']);
                $settings['contents'][$cid]['styles'] = $core->getAssetsUrls($files['styles']);
            }
        }

        if ($embed === 'div') {
            return [

The expression return array('settings' => $settings, 'embed' => '<div class="h5p-content" data-content-id="' . $content['id'] . '"></div>') returns the type array<string,mixed|string> which is incompatible with the documented return type string.

                'settings' => $settings,
                'embed'    => '<div class="h5p-content" data-content-id="'.$content['id'].'"></div>',
            ];
        } else {
            return [

The expression return array('settings' => $settings, 'embed' => '<div class="h5p-iframe-wrapper"><iframe id="h5p-iframe-' . $content['id'] . '" class="h5p-iframe" data-content-id="' . $content['id'] . '" style="height:1px" src="about:blank" frameBorder="0" scrolling="no"></iframe></div>') returns the type array<string,mixed|string> which is incompatible with the documented return type string.

                'settings' => $settings,
                'embed'    => '<div class="h5p-iframe-wrapper"><iframe id="h5p-iframe-'.$content['id'].'" class="h5p-iframe" data-content-id="'.$content['id'].'" style="height:1px" src="about:blank" frameBorder="0" scrolling="no"></iframe></div>',
            ];
        }
    }

    /**
     * The most basic settings.
     *
     * @param type $content

The type Djoudi\LaravelH5p\type was not found. Maybe you did not declare it correctly or list all dependencies?

     *
     * @return type
     */
    private static function get_core_settings()
    {
        $settings = [
            'baseUrl'            => config('laravel-h5p.domain'),
            'url'                => self::get_h5p_storage(), // for uploaded
            'postUserStatistics' => (config('laravel-h5p.h5p_track_user', true) === '1') && Auth::check(),
            'ajax'               => [
                'setFinished'     => route('h5p.ajax.finish'),
                'contentUserData' => route('h5p.ajax.content-user-data'),
                // 'contentUserData' => route('h5p.ajax.content-user-data', ['content_id' => ':contentId', 'data_type' => ':dataType', 'sub_content_id' => ':subContentId']),
            ],
            'saveFreq' => config('laravel-h5p.h5p_save_content_state', false) ? config('laravel-h5p.h5p_save_content_frequency', 30) : false,
            'siteUrl'  => config('laravel-h5p.domain'),
            'l10n'     => [
                'H5P' => trans('laravel-h5p.h5p'),
            ],
            'hubIsEnabled' => config('laravel-h5p.h5p_hub_is_enabled'),
        ];

        if (Auth::check()) {
            $settings['user'] = [
                'name' => Auth::user()->name,

Accessing name on the interface Illuminate\Contracts\Auth\Authenticatable suggest that you code against a concrete implementation. How about adding an instanceof check?

                'mail' => Auth::user()->email,

Accessing email on the interface Illuminate\Contracts\Auth\Authenticatable suggest that you code against a concrete implementation. How about adding an instanceof check?

            ];
        }

        return $settings;
    }

    private static function get_core_files($settings = [])
    {
        $settings['loadedJs'] = [];
        $settings['loadedCss'] = [];

        $settings['core'] = [
            'styles'  => [],
            'scripts' => [],
        ];

        $settings['core']['styles'][] = self::get_laravelh5p_url('/css/laravel-h5p.css');

        foreach (H5PCore::$styles as $style) {
            $settings['core']['styles'][] = self::get_h5pcore_url('/'.$style);
        }
        foreach (H5PCore::$scripts as $script) {
            $settings['core']['scripts'][] = self::get_h5pcore_url('/'.$script);
        }

        $settings['core']['scripts'][] = self::get_h5peditor_url('/scripts/h5peditor-editor.js');

        $settings['core']['scripts'][] = self::get_laravelh5p_url('/js/laravel-h5p.js');

        return $settings;
    }

    private static function get_editor_settings($content = null)
    {
        $settings = self::get_core_settings();

        $settings['editor'] = [
            'filesPath' => self::get_h5p_storage('/editor'),
            'fileIcon'  => [
                'path'   => self::get_h5peditor_url('/images/binary-file.png'),
                'width'  => 50,
                'height' => 50,
            ],
            'ajaxPath' => route('h5p.ajax').'/',
            // for checkeditor,
            'libraryUrl'         => self::get_h5peditor_url(),
            'copyrightSemantics' => self::$contentvalidator->getCopyrightSemantics(),
            'metadataSemantics'  => self::$contentvalidator->getMetadataSemantics(),
            'assets'             => [],
            'deleteMessage'      => trans('laravel-h5p.content.destoryed'),
            'apiVersion'         => H5PCore::$coreApi,
        ];

        // contents
        if ($content !== null) {
            $settings['editor']['nodeVersionId'] = $content['id'];
        }

        return $settings;
    }

    private static function get_editor_assets($settings = [], $content = null)
    {
        $settings = self::get_core_files($settings);

        // load core assets
        $settings['editor']['assets']['css'] = $settings['core']['styles'];
        $settings['editor']['assets']['js'] = $settings['core']['scripts'];

        $settings['editor']['assets']['js'][] = self::get_laravelh5p_url('/js/laravel-h5p-editor.js');

        // add editor styles
        foreach (H5peditor::$styles as $style) {
            $settings['editor']['assets']['css'][] = self::get_h5peditor_url('/'.$style);
        }
        // Add editor JavaScript
        foreach (H5peditor::$scripts as $script) {
            // We do not want the creator of the iframe inside the iframe
            if ($script !== 'scripts/h5peditor-editor.js') {
                $settings['editor']['assets']['js'][] = self::get_h5peditor_url('/'.$script);
            }
        }

        $language_script = '/language/'.self::get_language().'.js';
        $settings['editor']['assets']['js'][] = self::get_h5peditor_url($language_script);

        if ($content) {
            $settings = self::get_content_files($settings, $content);
        }

        return $settings;
    }

    /**
     * @param type $content
     *
     * @return type
     */
    public static function get_content_settings($content)
    {
        $safe_parameters = self::$core->filterParameters($content);
//        if (has_action('h5p_alter_filtered_parameters')) {
        //            // Parse the JSON parameters
        //            $decoded_parameters = json_decode($safe_parameters);
        //            /**
        //             * Allows you to alter the H5P content parameters after they have been
        //             * filtered. This hook only fires before view.
        //             *
        //             * @since 1.5.3
        //             *
        //             * @param object &$parameters
        //             * @param string $libraryName
        //             * @param int $libraryMajorVersion
        //             * @param int $libraryMinorVersion
        //             */
        //            // Stringify the JSON parameters
        //            $safe_parameters = json_encode($decoded_parameters);
        //        }
        // Getting author's user id
        $author_id = (int) (is_array($content) ? $content['user_id'] : $content->user_id);

The condition is_array($content) is always false.

        // Add JavaScript settings for this content
        $settings = [
            'library'         => H5PCore::libraryToString($content['library']),
            'jsonContent'     => $safe_parameters,
            'fullScreen'      => $content['library']['fullscreen'],
            'exportUrl'       => config('laravel-h5p.h5p_export') ? route('h5p.export', [$content['id']]) : '',
            'embedCode'       => '<iframe src="'.route('h5p.embed', ['id' => $content['id']]).'" width=":w" height=":h" frameborder="0" allowfullscreen="allowfullscreen"></iframe>',
            'resizeCode'      => '<script src="'.self::get_h5pcore_url('/js/h5p-resizer.js').'" charset="UTF-8"></script>',
            'url'             => route('h5p.embed', ['id' => $content['id']]),
            'title'           => $content['title'],
            'displayOptions'  => self::$core->getDisplayOptionsForView($content['disable'], $author_id),
            'contentUserData' => [
                0 => [
                    'state' => '{}',
                ],
            ],
        ];

        // Get preloaded user data for the current user
        if (config('laravel-h5p.h5p_save_content_state') && Auth::check()) {
            $results = DB::select('

The type Djoudi\LaravelH5p\DB was not found. Did you mean DB? If so, make sure to prefix the type with \.

                SELECT

                hcud.sub_content_id,

                hcud.data_id,

                hcud.data

                FROM h5p_contents_user_data hcud

                WHERE user_id = ?

                AND content_id = ?

                AND preload = 1', [Auth::user()->id, $content['id']]

Accessing id on the interface Illuminate\Contracts\Auth\Authenticatable suggest that you code against a concrete implementation. How about adding an instanceof check?

            );

            if ($results) {
                foreach ($results as $result) {
                    $settings['contentUserData'][$result->sub_content_id][$result->data_id] = $result->data;
                }
            }
        }

        return $settings;

The expression return $settings returns the type array<string,array<integer,array<string,string>>|mixed|string> which is incompatible with the documented return type Djoudi\LaravelH5p\type.

    }

    /**
     * @param type $settings
     * @param type $content
     *
     * @return type
     */
    public static function get_content_files($settings, $content)
    {
        $embed = H5PCore::determineEmbedType($content['embedType'], $content['library']['embedTypes']);

        // Make sure content isn't added twice
        $cid = 'cid-'.$content['id'];
        if (!isset($settings['contents'][$cid])) {

            // Load File
            $settings['contents'][$cid] = self::get_content_settings($content);

            $core = self::$core;

            // Get assets for this content
            $preloaded_dependencies = $core->loadContentDependencies($content['id'], 'preloaded');

            $files = $core->getDependenciesFiles($preloaded_dependencies);

            self::alter_assets($files, $preloaded_dependencies, $embed);

            if ($embed === 'div') {
//                $this->enqueue_assets($files);
                foreach ($files['scripts'] as $script) {
                    $url = $script->path.$script->version;
                    if (!in_array($url, $settings['loadedJs'])) {
                        $settings['loadedJs'][] = self::get_h5plibrary_url($url);
                    }
                }
                foreach ($files['styles'] as $style) {
                    $url = $style->path.$style->version;
                    if (!in_array($url, $settings['loadedCss'])) {
                        $settings['loadedCss'][] = self::get_h5plibrary_url($url);
                    }
                }
            } elseif ($embed === 'iframe') {
                $settings['contents'][$cid]['scripts'] = $core->getAssetsUrls($files['scripts']);
                $settings['contents'][$cid]['styles'] = $core->getAssetsUrls($files['styles']);
            }
        }

        return $settings;
    }

    public static function alter_assets(&$files, &$dependencies, $embed)

The parameter $embed is not used and could be removed.

The parameter $files is not used and could be removed.

    {
        $libraries = [];
        foreach ($dependencies as $dependency) {
            $libraries[$dependency['machineName']] = [
                'majorVersion' => $dependency['majorVersion'],
                'minorVersion' => $dependency['minorVersion'],
            ];
        }

        return $libraries;
    }

    /**
     * Get content with given id.
     *
     * @since 1.0.0
     *
     * @param int $id
     *
     * @throws Exception
     *
     * @return array
     */
    public static function get_content($id = null)
    {
        if ($id === false || $id === null) {

The condition $id === null is always false.

            return trans('h5p.content.missing_h5p_identifier');
        }

        // Try to find content with $id.
        $content = self::$core->loadContent($id);

        if (!$content) {
            return trans('h5p.content.can_not_find_content', ['id' => $id]);

The expression return trans('h5p.content.can_not_find_content', array('id' => $id)) also could return the type string which is incompatible with the documented return type array.

        }
        $content['language'] = self::get_language();

        return $content;
    }

    public static function get_language()
    {
        return config('laravel-h5p.language');
    }
}