%PDF-
%PDF-
Mini Shell
Mini Shell
<?php
/**
* @package FOF
* @copyright 2010-2017 Nicholas K. Dionysopoulos / Akeeba Ltd
* @license GNU GPL version 2 or later
*/
namespace FOF30\Configuration\Domain;
use SimpleXMLElement;
defined('_JEXEC') or die;
/**
* Configuration parser for the models-specific settings
*
* @since 2.1
*/
class Models implements DomainInterface
{
/**
* Parse the XML data, adding them to the $ret array
*
* @param SimpleXMLElement $xml The XML data of the component's configuration area
* @param array &$ret The parsed data, in the form of a hash array
*
* @return void
*/
public function parseDomain(SimpleXMLElement $xml, array &$ret)
{
// Initialise
$ret['models'] = array();
// Parse model configuration
$modelsData = $xml->xpath('model');
// Sanity check
if (empty($modelsData))
{
return;
}
foreach ($modelsData as $aModel)
{
$key = (string) $aModel['name'];
$ret['models'][ $key ]['behaviors'] = array();
$ret['models'][ $key ]['behaviorsMerge'] = false;
$ret['models'][ $key ]['tablealias'] = $aModel->xpath('tablealias');
$ret['models'][ $key ]['fields'] = array();
$ret['models'][ $key ]['relations'] = array();
$ret['models'][ $key ]['config'] = array();
// Parse configuration
$optionData = $aModel->xpath('config/option');
if (!empty($optionData))
{
foreach ($optionData as $option)
{
$k = (string) $option['name'];
$ret['models'][ $key ]['config'][ $k ] = (string) $option;
}
}
// Parse field aliases
$fieldData = $aModel->xpath('field');
if (!empty($fieldData))
{
foreach ($fieldData as $field)
{
$k = (string) $field['name'];
$ret['models'][ $key ]['fields'][ $k ] = (string) $field;
}
}
// Parse behaviours
$behaviorsData = (string) $aModel->behaviors;
$behaviorsMerge = (string) $aModel->behaviors['merge'];
if (!empty($behaviorsMerge))
{
$behaviorsMerge = trim($behaviorsMerge);
$behaviorsMerge = strtoupper($behaviorsMerge);
if (in_array($behaviorsMerge, array('1', 'YES', 'ON', 'TRUE')))
{
$ret['models'][ $key ]['behaviorsMerge'] = true;
}
}
if (!empty($behaviorsData))
{
$behaviorsData = explode(',', $behaviorsData);
foreach ($behaviorsData as $behavior)
{
$behavior = trim($behavior);
if (empty($behavior))
{
continue;
}
$ret['models'][ $key ]['behaviors'][] = $behavior;
}
}
// Parse relations
$relationsData = $aModel->xpath('relation');
if (!empty($relationsData))
{
foreach ($relationsData as $relationData)
{
$type = (string) $relationData['type'];
$itemName = (string) $relationData['name'];
if (empty($type) || empty($itemName))
{
continue;
}
$modelClass = (string) $relationData['foreignModelClass'];
$localKey = (string) $relationData['localKey'];
$foreignKey = (string) $relationData['foreignKey'];
$pivotTable = (string) $relationData['pivotTable'];
$ourPivotKey = (string) $relationData['pivotLocalKey'];
$theirPivotKey = (string) $relationData['pivotForeignKey'];
$relation = array(
'type' => $type,
'itemName' => $itemName,
'foreignModelClass' => empty($modelClass) ? null : $modelClass,
'localKey' => empty($localKey) ? null : $localKey,
'foreignKey' => empty($foreignKey) ? null : $foreignKey,
);
if (!empty($ourPivotKey) || !empty($theirPivotKey) || !empty($pivotTable))
{
$relation['pivotLocalKey'] = empty($ourPivotKey) ? null : $ourPivotKey;
$relation['pivotForeignKey'] = empty($theirPivotKey) ? null : $theirPivotKey;
$relation['pivotTable'] = empty($pivotTable) ? null : $pivotTable;
}
$ret['models'][ $key ]['relations'][] = $relation;
}
}
}
}
/**
* Return a configuration variable
*
* @param string &$configuration Configuration variables (hashed array)
* @param string $var The variable we want to fetch
* @param mixed $default Default value
*
* @return mixed The variable's value
*/
public function get(&$configuration, $var, $default)
{
$parts = explode('.', $var);
$view = $parts[0];
$method = 'get' . ucfirst($parts[1]);
if (!method_exists($this, $method))
{
return $default;
}
array_shift($parts);
array_shift($parts);
$ret = $this->$method($view, $configuration, $parts, $default);
return $ret;
}
/**
* Internal method to return the magic field mapping
*
* @param string $model The model for which we will be fetching a field map
* @param array &$configuration The configuration parameters hash array
* @param array $params Extra options
* @param string $default Default magic field mapping; empty if not defined
*
* @return array Field map
*/
protected function getField($model, &$configuration, $params, $default = '')
{
$fieldmap = array();
if (isset($configuration['models']['*']) && isset($configuration['models']['*']['fields']))
{
$fieldmap = $configuration['models']['*']['fields'];
}
if (isset($configuration['models'][ $model ]) && isset($configuration['models'][ $model ]['fields']))
{
$fieldmap = array_merge($fieldmap, $configuration['models'][ $model ]['fields']);
}
$map = $default;
if (empty($params[0]) || ($params[0] == '*'))
{
$map = $fieldmap;
}
elseif (isset($fieldmap[ $params[0] ]))
{
$map = $fieldmap[ $params[0] ];
}
return $map;
}
/**
* Internal method to get model alias
*
* @param string $model The model for which we will be fetching table alias
* @param array &$configuration The configuration parameters hash array
* @param array $params Ignored
* @param string $default Default table alias
*
* @return string Table alias
*/
protected function getTablealias($model, &$configuration, $params, $default = '')
{
$tableMap = array();
if (isset($configuration['models']['*']['tablealias']))
{
$tableMap = $configuration['models']['*']['tablealias'];
}
if (isset($configuration['models'][ $model ]['tablealias']))
{
$tableMap = array_merge($tableMap, $configuration['models'][ $model ]['tablealias']);
}
if (empty($tableMap))
{
return null;
}
return $tableMap[0];
}
/**
* Internal method to get model behaviours
*
* @param string $model The model for which we will be fetching behaviours
* @param array &$configuration The configuration parameters hash array
* @param array $params Unused
* @param string $default Default behaviour
*
* @return string Model behaviours
*/
protected function getBehaviors($model, &$configuration, $params, $default = '')
{
$behaviors = $default;
if (isset($configuration['models']['*'])
&& isset($configuration['models']['*']['behaviors'])
)
{
$behaviors = $configuration['models']['*']['behaviors'];
}
if (isset($configuration['models'][ $model ])
&& isset($configuration['models'][ $model ]['behaviors'])
)
{
$merge = false;
if (isset($configuration['models'][ $model ])
&& isset($configuration['models'][ $model ]['behaviorsMerge'])
)
{
$merge = (bool) $configuration['models'][ $model ]['behaviorsMerge'];
}
if ($merge)
{
$behaviors = array_merge($behaviors, $configuration['models'][ $model ]['behaviors']);
}
else
{
$behaviors = $configuration['models'][ $model ]['behaviors'];
}
}
return $behaviors;
}
/**
* Internal method to get model relations
*
* @param string $model The model for which we will be fetching relations
* @param array &$configuration The configuration parameters hash array
* @param array $params Unused
* @param string $default Default relations
*
* @return array Model relations
*/
protected function getRelations($model, &$configuration, $params, $default = '')
{
$relations = $default;
if (isset($configuration['models']['*'])
&& isset($configuration['models']['*']['relations'])
)
{
$relations = $configuration['models']['*']['relations'];
}
if (isset($configuration['models'][ $model ])
&& isset($configuration['models'][ $model ]['relations'])
)
{
$relations = $configuration['models'][ $model ]['relations'];
}
return $relations;
}
/**
* Internal method to return the a configuration option for the Model.
*
* @param string $model The view for which we will be fetching a task map
* @param array &$configuration The configuration parameters hash array
* @param array $params Extra options; key 0 defines the option variable we want to fetch
* @param mixed $default Default option; null if not defined
*
* @return string The setting for the requested option
*/
protected function getConfig($model, &$configuration, $params, $default = null)
{
$ret = $default;
$config = array();
if (isset($configuration['models']['*']['config']))
{
$config = $configuration['models']['*']['config'];
}
if (isset($configuration['models'][ $model ]['config']))
{
$config = array_merge($config, $configuration['models'][ $model ]['config']);
}
if (empty($params) || empty($params[0]))
{
return $config;
}
if (isset($config[ $params[0] ]))
{
$ret = $config[ $params[0] ];
}
return $ret;
}
}
Zerion Mini Shell 1.0