class/ExtrasHandler.php
<?php declare(strict_types=1);
namespace XoopsModules\Songlist;
use XoopsDatabase;
use XoopsObject;
use XoopsPersistableObjectHandler;
/**
* @copyright copyright © 2000 XOOPS.org
*/
class ExtrasHandler extends XoopsPersistableObjectHandler
{
/**
* holds reference to {@link ObjectsFieldHandler} object
*/
public $_fHandler;
/**
* Array of {@link XoopsObjectsField} objects
* @var array
*/
public $_fields = [];
/**
* ExtrasHandler constructor.
* @param \XoopsDatabase $db
*/
public function __construct(XoopsDatabase $db)
{
parent::__construct($db, 'songlist_extra', Extras::class, 'sid');
$this->_fHandler = \XoopsModules\Songlist\Helper::getInstance()->getHandler('Field');
}
/**
* create a new {@link Extras}
*
* @param bool $isNew Flag the new objects as "new"?
*
* @return object {@link Extras}
*/
public function &create($isNew = true): object
{
$obj = new $this->className($this->loadFields());
$obj->handler = $this;
$obj->setNew();
return $obj;
}
/**
* Get a {@link Extras}
*
* @param null $id
* @param null $fields
* @return object <a href='psi_element://Extras'>Extras</a>
*/
public function get($id = null, $fields = null): object //get($uid, $createOnFailure = true)
{
if (null === $fields) {
$fields = true;
}
$obj = parent::get($id);
if (!\is_object($obj) && $fields) {
$obj = $this->create();
}
return $obj;
}
/**
* Create new {@link ObjectsField} object
*
* @param bool $isNew
*
* @return object
*/
public function &createField($isNew = true): object
{
$return = $this->_fHandler->create($isNew);
return $return;
}
/**
* Load field information
*
* @return array|false
*/
public function loadFields()
{
if (0 == \count($this->_fields)) {
$this->_fields = $this->_fHandler->loadFields();
}
return (0 == $this->_fields || empty($this->_fields) ? false : $this->_fields);
}
/**
* @return array
*/
public function getPostVars(): array
{
return ['sid', 'cid', 'gid', 'aids', 'abid', 'songid', 'title', 'lyrics', 'hits', 'rank', 'votes', 'tags', 'created', 'updated'];
}
/**
* @param $criteria
* @param bool $id_as_key
* @param bool $as_object
* @return array
*/
public function getFields($criteria, $id_as_key = true, $as_object = true): array
{
return $this->_fHandler->getObjects($criteria, $id_as_key, $as_object);
}
/**
* Insert a field in the database
*
* @param XoopsObject $field
* @param bool $force
* @return mixed|void
*/
public function insertField($field, $force = false)
{
return $this->_fHandler->insert($field, $force);
}
/**
* Delete a field from the database
*
* @param XoopsObject $field
* @param bool $force
* @return bool
*/
public function deleteField($field, $force = false)
{
return $this->_fHandler->delete($field, $force);
}
/**
* Save a new field in the database
*
* @param array $vars array of variables, taken from $module->loadInfo('Extras')['field']
* @param int $weight
* @return string
* @internal param int $categoryid ID of the category to add it to
* @internal param int $type valuetype of the field
* @internal param int $moduleid ID of the module, this field belongs to
*/
public function saveField($vars, $weight = 0): string
{
$field = $this->createField();
$field->setVar('field_name', $vars['name']);
$field->setVar('field_valuetype', $vars['valuetype']);
$field->setVar('field_type', $vars['type']);
$field->setVar('field_weight', $weight);
if (isset($vars['title'])) {
$field->setVar('field_title', $vars['title']);
}
if (isset($vars['description'])) {
$field->setVar('field_description', $vars['description']);
}
if (isset($vars['required'])) {
$field->setVar('field_required', $vars['required']); //0 = no, 1 = yes
}
if (isset($vars['maxlength'])) {
$field->setVar('field_maxlength', $vars['maxlength']);
}
if (isset($vars['default'])) {
$field->setVar('field_default', $vars['default']);
}
if (isset($vars['notnull'])) {
$field->setVar('field_notnull', $vars['notnull']);
}
if (isset($vars['show'])) {
$field->setVar('field_show', $vars['show']);
}
if (isset($vars['edit'])) {
$field->setVar('field_edit', $vars['edit']);
}
if (isset($vars['config'])) {
$field->setVar('field_config', $vars['config']);
}
if (isset($vars['options'])) {
$field->setVar('field_options', $vars['options']);
} else {
$field->setVar('field_options', []);
}
if ($this->insertField($field)) {
$msg = ' Field <b>' . $vars['name'] . '</b> added to the database';
} else {
$msg = ' <span style="color:#ff0000;">ERROR: Could not insert field <b>' . $vars['name'] . '</b> into the database. ' . \implode(' ', $field->getErrors()) . $this->db->error() . '</span>';
}
unset($field);
return $msg;
}
/**
* insert a new object in the database
*
* @param \XoopsObject $obj reference to the object
* @param bool $force whether to force the query execution despite security settings
* @param bool $checkObject check if the object is dirty and clean the attributes
*
* @return bool FALSE if failed, TRUE if already present and unchanged or successful
*/
public function insert(XoopsObject $obj, $force = false, $checkObject = true): bool
{
$uservars = $this->getPostVars();
foreach ($uservars as $var) {
if ('sid' != $var) {
unset($obj->vars[$var]);
}
}
if (0 == \count($obj->vars)) {
return true;
}
return (bool)parent::insert($obj, $force, $checkObject);
}
}