XoopsModules25x / suico

class/VideoHandler.php

<?php declare(strict_types=1);

namespace XoopsModules\Suico;

/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*/

/**
 * @category        Module
 * @copyright       {@link https://xoops.org/ XOOPS Project}
 * @license         GNU GPL 2.0 or later (https://www.gnu.org/licenses/gpl-2.0.html)
 * @author          Marcello Brandão aka  Suico, Mamba, LioMJ  <https://xoops.org>
 */

use CriteriaElement;
use XoopsDatabase;
use XoopsFormButton;
use XoopsFormHidden;
use XoopsFormLabel;
use XoopsFormText;
use XoopsFormTextArea;
use XoopsObject;
use XoopsPersistableObjectHandler;
use XoopsThemeForm;

/**
 * suico_videohandler class.
 * This class provides simple mechanism for Video object
 */
class VideoHandler extends XoopsPersistableObjectHandler
{
    public Helper $helper;
    public        $isAdmin;

    /**
     * Constructor
     * @param \XoopsDatabase|null             $xoopsDatabase
     * @param \XoopsModules\Suico\Helper|null $helper
     */
    public function __construct(
        ?XoopsDatabase $xoopsDatabase = null,
        $helper = null
    ) {
        /** @var \XoopsModules\Suico\Helper $this- >helper */
        if (null === $helper) {
            $this->helper = Helper::getInstance();
        } else {
            $this->helper = $helper;
        }
        $this->isAdmin = $this->helper->isUserAdmin();
        parent::__construct($xoopsDatabase, 'suico_videos', Video::class, 'video_id', 'video_title', 'video_desc');

The call to XoopsPersistableObjectHandler::__construct() has too many arguments starting with 'video_desc'.

    }

    /**
     * create a new Groups
     *
     * @param bool $isNew flag the new objects as "new"?
     * @return \XoopsObject Groups
     */
    public function create(
        $isNew = true
    ) {
        $obj = parent::create($isNew);
        if ($isNew) {
            $obj->setNew();
        } else {
            $obj->unsetNew();
        }
        if ($isNew) {
            $obj->helper = $this->helper;
        }

        return $obj;
    }

    /**
     * retrieve a Video
     *
     * @param int|null $id of the Video
     * @param null     $fields

Are you sure the doc-type for parameter $fields is correct as it would always require null to be passed?

     * @return false|\XoopsModules\Suico\Video reference to the {@link Video} object, FALSE if failed
     */
    public function get2(
        $id = null,
        $fields = null

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

    ) {
        $sql = 'SELECT * FROM ' . $this->db->prefix('suico_videos') . ' WHERE video_id=' . $id;
        if (!$result = $this->db->query($sql)) {
            return false;
        }
        $numrows = $this->db->getRowsNum($result);
        if (1 === $numrows) {
            $video = new Video();
            $video->assignVars($this->db->fetchArray($result));

            return $video;
        }

        return false;
    }

    /**
     * insert a new Video in the database
     *
     * @param \XoopsObject $object    reference to the {@link Video}
     *                                     object
     * @param bool         $force
     * @return bool FALSE if failed, TRUE if already present and unchanged or successful
     */
    public function insert2(
        XoopsObject $object,
        $force = false
    ) {
        global $xoopsConfig;
        if (!$object instanceof Video) {
            return false;
        }
        if (!$object->isDirty()) {
            return true;
        }
        if (!$object->cleanVars()) {
            return false;
        }
        $uid_owner = '';
        $video_id  = '';
        foreach ($object->cleanVars as $k => $v) {
            ${$k} = $v;
        }
        //        $now = 'date_add(now(), interval ' . $xoopsConfig['server_TZ'] . ' hour)';
        if ($object->isNew()) {
            // ajout/modification d'un Video
            $object = new Video();
            $format      = 'INSERT INTO %s (video_id, uid_owner, video_title, video_desc, youtube_code, featured_video)';
            $format      .= 'VALUES (%u, %u, %s, %s, %s, %s)';
            $sql         = \sprintf(
                $format,
                $this->db->prefix('suico_videos'),
                $video_id,
                $uid_owner,
                $this->db->quoteString($video_title),

The variable $video_title does not exist. Did you maybe mean $video_id?

                $this->db->quoteString($video_desc),

The variable $video_desc does not exist. Did you maybe mean $video_id?

                $this->db->quoteString($youtube_code),

The variable $youtube_code seems to be never defined.

                $this->db->quoteString($featured_video)

The variable $featured_video seems to be never defined.

            );
            $force       = true;
        } else {
            $format = 'UPDATE %s SET ';
            $format .= 'video_id=%u, uid_owner=%u, video_title=%s, video_desc=%s, youtube_code=%s, featured_video=%s';
            $format .= ' WHERE video_id = %u';
            $sql    = \sprintf(
                $format,
                $this->db->prefix('suico_videos'),
                $video_id,
                $uid_owner,
                $this->db->quoteString($video_title),
                $this->db->quoteString($video_desc),
                $this->db->quoteString($youtube_code),
                $this->db->quoteString($featured_video),
                $video_id
            );
        }
        if ($force) {
            $result = $this->db->queryF($sql);
        } else {
            $result = $this->db->query($sql);
        }
        if (!$result) {
            return false;
        }
        if (empty($video_id)) {
            $video_id = $this->db->getInsertId();
        }
        $object->assignVar('video_id', $video_id);

        return true;
    }

    /**
     * delete a Video from the database
     *
     * @param \XoopsObject $object reference to the Video to delete
     * @param bool         $force
     * @return bool FALSE if failed.
     */
    public function delete(
        XoopsObject $object,
        $force = false
    ) {
        if (!$object instanceof Video) {
            return false;
        }
        $sql = \sprintf(
            'DELETE FROM %s WHERE video_id = %u',
            $this->db->prefix('suico_videos'),
            (int)$object->getVar('video_id')
        );
        if ($force) {
            $result = $this->db->queryF($sql);
        } else {
            $result = $this->db->query($sql);
        }
        if (!$result) {
            return false;
        }

        return true;
    }

    /**
     * retrieve suico_videos from the database
     *
     * @param \CriteriaElement|\CriteriaCompo|null $criteria {@link \CriteriaElement} conditions to be met
     * @param bool                                 $id_as_key       use the UID as key for the array?
     * @param bool                                 $as_object
     * @return array array of {@link Video} objects
     */
    public function &getObjects(
        ?CriteriaElement $criteria = null,
        $id_as_key = false,
        $as_object = true
    ) {
        $ret   = [];
        $start = 0;
        $limit = 0;
        $sql   = 'SELECT * FROM ' . $this->db->prefix('suico_videos');
        if (isset($criteria) && is_subclass_of($criteria, 'CriteriaElement')) {
            $sql   .= ' ' . $criteria->renderWhere();

The method renderWhere() does not exist on CriteriaElement. Did you maybe mean render()?

            $sort  = 'video_id';
            $order = 'DESC';
            //if ('' !== $criteria->getSort()) {
            //    $sql .= ' ORDER BY ' . $criteria->getSort() . ' ' . $criteria->getOrder();
            //}
            if ('' !== $sort) {

The condition '' !== $sort is always true.

                $sql .= ' ORDER BY ' . $sort . ' ' . $order;
            }
            $limit = $criteria->getLimit();
            $start = $criteria->getStart();
        }
        $result = $this->db->query($sql, $limit, $start);
        if (!$result) {
            return $ret;
        }
        while (false !== ($myrow = $this->db->fetchArray($result))) {
            $video = new Video();
            $video->assignVars($myrow);
            if ($id_as_key) {
                $ret[$myrow['video_id']] = &$video;
            } else {
                $ret[] = &$video;
            }
            unset($video);
        }

        return $ret;
    }

    /**
     * count suico_videos matching a condition
     *
     * @param \CriteriaElement|\CriteriaCompo|null $criteria {@link \CriteriaElement} to match
     * @return int count of suico_videos
     */
    public function getCount(
        ?CriteriaElement $criteria = null
    ) {
        $sql = 'SELECT COUNT(*) FROM ' . $this->db->prefix('suico_videos');
        if (isset($criteria) && is_subclass_of($criteria, 'CriteriaElement')) {
            $sql .= ' ' . $criteria->renderWhere();
        }
        $result = $this->db->query($sql);
        if (!$result) {
            return 0;
        }
        [$count] = $this->db->fetchRow($result);

        return (int)$count;
    }

    /**
     * delete suico_videos matching a set of conditions
     *
     * @param \CriteriaElement|\CriteriaCompo|null $criteria {@link \CriteriaElement}
     * @param bool                                 $force
     * @param bool                                 $asObject
     * @return bool FALSE if deletion failed
     */
    public function deleteAll(
        ?CriteriaElement $criteria = null,
        $force = true,
        $asObject = false
    ) {
        $sql = 'DELETE FROM ' . $this->db->prefix('suico_videos');
        if (isset($criteria) && is_subclass_of($criteria, 'CriteriaElement')) {
            $sql .= ' ' . $criteria->renderWhere();
        }
        if (!$result = $this->db->query($sql)) {

The assignment to $result is dead and can be removed.

            return false;
        }

        return true;
    }

    /**
     * Render a form to send videos
     *
     * @param \XoopsTpl $xoopsTpl the one in which the form will be rendered
     * @return bool TRUE
     *
     * obs: Some functions wont work on php 4 so edit lines down under acording to your version
     */
    public function renderFormSubmit(
        $xoopsTpl
    ) {
        $form       = new XoopsThemeForm(\_MD_SUICO_ADDFAVORITEVIDEOS, 'form_videos', 'submitVideo.php', 'post', true);
        $field_code = new XoopsFormText(\_MD_SUICO_YOUTUBECODE, 'videourl', 50, 250);
        $field_desc = new XoopsFormTextArea(\_MD_SUICO_CAPTION, 'caption');
        $form->setExtra('enctype="multipart/form-data"');
        $buttonSend = new XoopsFormButton('', 'submit_button', \_MD_SUICO_ADDVIDEO, 'submit');
        $form->addElement($field_warning);

The variable $field_warning seems to be never defined.

        $form->addElement($field_code, true);
        $form->addElement($field_desc);
        $form->addElement($buttonSend);
        $form->assign($xoopsTpl); //If your server is php 5
        //$form->display();
        return true;
    }

    /**
     * Render a form to edit the description of the pictures
     *
     * @param        $title
     * @param string $caption  The description of the picture
     * @param int    $video_id the id of the image in database
     * @param string $filename the url to the thumb of the image so it can be displayed
     * @return bool TRUE
     */
    public function renderFormEdit(
        $title,
        $caption,
        $video_id,
        $filename
    ) {
        $form        = new XoopsThemeForm(\_MD_SUICO_EDIT_VIDEO, 'form_picture', 'editvideo.php', 'post', true);
        $field_title = new XoopsFormText($title, 'title', 35, 55);
        $field_desc  = new XoopsFormText($caption, 'caption', 35, 55);
        $form->setExtra('enctype="multipart/form-data"');
        $buttonSend     = new XoopsFormButton('', 'submit_button', \_MD_SUICO_SUBMIT, 'submit');
        $field_warning  = new XoopsFormLabel(
            '<object width="425" height="353">
<param name="movie" value="https://www.youtube.com/v/' . $filename . '"></param>
<param name="wmode" value="transparent"></param>
<embed src="https://www.youtube.com/v/' . $filename . '" type="application/x-shockwave-flash" wmode="transparent" width="425" height="353"></embed>
</object>'
        );
        $field_video_id = new XoopsFormHidden('video_id', $video_id);
        $field_marker   = new XoopsFormHidden('marker', 1);
        $form->addElement($field_warning);
        $form->addElement($field_title);
        $form->addElement($field_desc);
        $form->addElement($field_video_id, true);
        $form->addElement($field_marker);
        $form->addElement($buttonSend);
        $form->display();

        return true;
    }

    /**
     * @param null $uid_owner

Are you sure the doc-type for parameter $uid_owner is correct as it would always require null to be passed?

     * @return bool
     */
    public function unsetAllMainsbyID($uid_owner = null)
    {
        $sql = 'UPDATE ' . $this->db->prefix('suico_videos') . ' SET featured_video=0 WHERE uid_owner=' . $uid_owner;
        if (!$result = $this->db->query($sql)) {

The assignment to $result is dead and can be removed.

            return false;
        }

        return true;
    }
}