BUG 9180 Correct coding convention

Correct coding convention and replace json_encode to G::json_encode and
json_decode to G::json_decode
This commit is contained in:
Herbert Saal Gutierrez
2012-05-30 17:47:28 -04:00
parent 1b2747987e
commit 01d65b3ff1
17 changed files with 1677 additions and 1355 deletions

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -4,30 +4,34 @@ require_once ('Base.php');
/**
* Application Solr Queue
*/
class Entity_AppSolrQueue extends Entity_Base {
class Entity_AppSolrQueue extends Entity_Base
{
public $appUid = '';
public $appUpdated = 0;
private function __construct() {
private function __construct()
{
}
static function CreateEmpty() {
static function createEmpty()
{
$obj = new Entity_AppSolrQueue ();
return $obj;
}
static function CreateForRequest($data) {
static function createForRequest($data)
{
$obj = new Entity_AppSolrQueue ();
$obj->initializeObject ( $data );
$obj->initializeObject ($data);
$requiredFields = array (
"appUid",
"appUpdated"
);
$obj->validateRequiredFields ( $requiredFields );
$obj->validateRequiredFields ($requiredFields);
return $obj;
}

View File

@@ -1,17 +1,19 @@
<?php
class Entity_Base {
class Entity_Base
{
/**
* this function check if a field is in the data sent in the constructor
* you can specify an array, and this function will use like alias
*/
protected function validateField($field, $default = false) {
protected function validateField($field, $default = false)
{
$fieldIsEmpty = true;
// this is a trick, if $fields is a string, $fields will be an array with
// one element
if (is_array ( $field )) {
if (is_array ($field)) {
$fields = $field;
}
else {
@@ -21,8 +23,8 @@ class Entity_Base {
// if there are aliases for this field, evaluate all aliases and take the
// first occurence
foreach ( $fields as $k => $f ) {
if (isset ( $this->temp [$f] )) {
foreach ($fields as $k => $f) {
if (isset ($this->temp [$f])) {
$fieldIsEmpty = false;
return $this->temp [$f];
}
@@ -37,16 +39,18 @@ class Entity_Base {
}
}
protected function validateRequiredFields($requiredFields = array()) {
foreach ( $requiredFields as $k => $field ) {
protected function validateRequiredFields($requiredFields = array())
{
foreach ($requiredFields as $k => $field) {
if ($this->{$field} === NULL) {
throw (new Exception ( "Field $field is required in " . get_class ( $this ) ));
throw (new Exception ("Field $field is required in " . get_class ($this)));
die ();
}
}
}
/**
*
*
*
* Copy the values of the Entity to the array of aliases
@@ -54,15 +58,19 @@ class Entity_Base {
*
* @return Array of alias with the Entity values
*/
public function getAliasDataArray() {
public function getAliasDataArray()
{
$aAlias = array ();
// get aliases from class
$className = get_class ( $this );
if (method_exists ( $className, 'GetAliases' )) {
$aliases = call_user_func(array($className, 'GetAliases'));
//$aliases = $className::GetAliases ();
foreach ( $this as $field => $value )
if (isset ( $aliases [$field] )) {
$className = get_class ($this);
if (method_exists ($className, 'GetAliases')) {
$aliases = call_user_func (array (
$className,
'GetAliases'
));
// $aliases = $className::GetAliases ();
foreach ($this as $field => $value)
if (isset ($aliases [$field])) {
// echo "Field exists in Aliases: " . $field . "\n";
// echo "Alias Name:" . $aliases[$field] . "\n";
// echo "Alias value:" . $value . "\n";
@@ -74,6 +82,7 @@ class Entity_Base {
}
/**
*
*
*
* Set the data from array of alias to Entity
@@ -81,57 +90,68 @@ class Entity_Base {
* @param $aAliasData array
* of data of aliases
*/
public function setAliasDataArray($aAliasData) {
public function setAliasDataArray($aAliasData)
{
// get aliases from class
$className = get_class ( $this );
if (method_exists ( $className, 'GetAliases' )) {
$aliases = call_user_func(array($className, 'GetAliases'));
//$aliases = $className::GetAliases ();
foreach ( $this as $field => $value )
if (isset ( $aliases [$field] ))
$className = get_class ($this);
if (method_exists ($className, 'GetAliases')) {
$aliases = call_user_func (array (
$className,
'GetAliases'
));
// $aliases = $className::GetAliases ();
foreach ($this as $field => $value)
if (isset ($aliases [$field]))
$this->{$field} = $aAliasData [$aliases [$field]];
}
}
/**
*
*
*
* Initialize object with values from $data.
* The values from data use properties or alias array.
*
*
* @param
* $data
*/
protected function initializeObject($data) {
protected function initializeObject($data)
{
// get aliases from class
$className = get_class ( $this );
$className = get_class ($this);
$aliases = array ();
$swAliases = false;
if (method_exists ( $className, 'GetAliases' )) {
$aliases = call_user_func(array($className, 'GetAliases'));
//$aliases = $className::GetAliases ();
if (method_exists ($className, 'GetAliases')) {
$aliases = call_user_func (array (
$className,
'GetAliases'
));
// $aliases = $className::GetAliases ();
$swAliases = true;
}
// use object properties or aliases to initialize
foreach ( $this as $field => $value )
if (isset ( $data [$field] )) {
foreach ($this as $field => $value)
if (isset ($data [$field])) {
$this->$field = $data [$field];
}
elseif ($swAliases && isset ( $aliases [$field] ) && isset ( $data [$aliases [$field]] )) {
elseif ($swAliases && isset ($aliases [$field]) && isset ($data [$aliases [$field]])) {
$this->$field = $data [$aliases [$field]];
}
}
public function serialize() {
if (isset ( $this->temp ))
unset ( $this->temp );
return serialize ( $this );
public function serialize()
{
if (isset ($this->temp))
unset ($this->temp);
return serialize ($this);
}
public function unserialize($str) {
$className = get_class ( $this );
$data = unserialize ( $str );
return new $className ( $data );
public function unserialize($str)
{
$className = get_class ($this);
$data = unserialize ($str);
return new $className ($data);
}
}

View File

@@ -2,10 +2,8 @@
require_once ('Base.php');
/**
*
*
* Facet group entity that represent a facet group
*
*
* @property $facetGroupName: The name of the facet (field name in solr index)
* @property $facetGroupPrintName: The print name of the facet (Human readable
* description)
@@ -16,32 +14,36 @@ require_once ('Base.php');
* @author dev-HebertSaak
*
*/
class Entity_FacetGroup extends Entity_Base {
class Entity_FacetGroup extends Entity_Base
{
public $facetGroupName = '';
public $facetGroupPrintName = '';
public $facetGroupType = ''; // field, daterange, query
public $facetGroupId = '';
public $facetItems = array ();
private function __construct() {
private function __construct()
{
}
static function CreateEmpty() {
static function createEmpty()
{
$obj = new Entity_FacetGroup ();
return $obj;
}
static function CreateForInsert($data) {
static function createForInsert($data)
{
$obj = new Entity_FacetGroup ();
$obj->initializeObject ( $data );
$obj->initializeObject ($data);
$requiredFields = array (
"facetGroupName",
"facetItems"
);
$obj->validateRequiredFields ( $requiredFields );
$obj->validateRequiredFields ($requiredFields);
return $obj;
}

View File

@@ -1,34 +1,38 @@
<?php
require_once ('Base.php');
class Entity_FacetInterfaceRequest extends Entity_Base {
class Entity_FacetInterfaceRequest extends Entity_Base
{
public $searchText = '';
public $selectedFacetsString = ''; // string of selected facet groups and
// items in format:
// groupkey1::groupdesc1:::itemkey1::itemdesc1,groupkey2::groupdesc2:::itemkey2::itemdesc2,
// groupkey3::groupdesc3:::itemkey3::itemdesc3
// var $selectedFacetFields = array();
// var $selectedFacetTypes = array();
// items in format:
// groupkey1::groupdesc1:::itemkey1::itemdesc1,groupkey2::groupdesc2:::itemkey2::itemdesc2,
// groupkey3::groupdesc3:::itemkey3::itemdesc3
// var $selectedFacetFields = array();
// var $selectedFacetTypes = array();
private function __construct() {
private function __construct()
{
}
static function CreateEmpty() {
static function createEmpty()
{
$obj = new Entity_FacetInterfaceRequest ();
return $obj;
}
static function CreateForRequest($data) {
static function createForRequest($data)
{
$obj = new Entity_FacetInterfaceRequest ();
$obj->initializeObject ( $data );
$obj->initializeObject ($data);
$requiredFields = array (
"searchText",
"selectedFacetsString"
);
$obj->validateRequiredFields ( $requiredFields );
$obj->validateRequiredFields ($requiredFields);
return $obj;
}

View File

@@ -1,25 +1,29 @@
<?php
require_once ('Base.php');
class Entity_FacetInterfaceResult extends Entity_Base {
class Entity_FacetInterfaceResult extends Entity_Base
{
// array of facetsgroups, array of Entity_SelectedFacetGroupItem, filter text
public $aFacetGroup = array ();
public $aSelectedFacetGroupItem = array ();
public $sFilterText = '';
private function __construct() {
private function __construct()
{
}
static function CreateEmpty() {
static function createEmpty()
{
$obj = new Entity_FacetInterfaceResult ();
return $obj;
}
static function CreateForRequest($data) {
static function createForRequest($data)
{
$obj = new Entity_FacetInterfaceResult ();
$obj->initializeObject ( $data );
$obj->initializeObject ($data);
$requiredFields = array (
"aFacetGroup",
@@ -27,7 +31,7 @@ class Entity_FacetInterfaceResult extends Entity_Base {
"sFilterText"
);
$obj->validateRequiredFields ( $requiredFields );
$obj->validateRequiredFields ($requiredFields);
return $obj;
}

View File

@@ -2,39 +2,44 @@
require_once ('Base.php');
/**
*
*
*
* Entity Face item, represent an option in a facet group
*
*
* @author dev-HebertSaak
*
*/
class Entity_FacetItem extends Entity_Base {
class Entity_FacetItem extends Entity_Base
{
public $facetName = '';
public $facetPrintName = '';
public $facetCount = '';
public $facetSelectCondition = ''; // selected condition used to select
// this facet
// this facet
private function __construct() {
private function __construct()
{
}
static function CreateEmpty() {
static function createEmpty()
{
$obj = new Entity_FacetItem ();
return $obj;
}
static function CreateForInsert($data) {
static function createForInsert($data)
{
$obj = new Entity_FacetItem ();
$obj->initializeObject ( $data );
$obj->initializeObject ($data);
$requiredFields = array (
"facetName",
"facetCount"
);
$obj->validateRequiredFields ( $requiredFields );
$obj->validateRequiredFields ($requiredFields);
return $obj;
}

View File

@@ -1,7 +1,8 @@
<?php
require_once ('Base.php');
class Entity_FacetRequest extends Entity_Base {
class Entity_FacetRequest extends Entity_Base
{
public $workspace = '';
public $searchText = '';
public $facetFields = array ();
@@ -14,24 +15,27 @@ class Entity_FacetRequest extends Entity_Base {
public $filters = array ();
public $selectedFacetsString = '';
private function __construct() {
private function __construct()
{
}
static function CreateEmpty() {
static function createEmpty()
{
$obj = new Entity_FacetRequest ();
return $obj;
}
static function CreateForRequest($data) {
static function createForRequest($data)
{
$obj = new Entity_FacetRequest ();
$obj->initializeObject ( $data );
$obj->initializeObject ($data);
$requiredFields = array (
"workspace"
);
$obj->validateRequiredFields ( $requiredFields );
$obj->validateRequiredFields ($requiredFields);
return $obj;
}

View File

@@ -1,23 +1,27 @@
<?php
require_once ('Base.php');
class Entity_FacetResult extends Entity_Base {
class Entity_FacetResult extends Entity_Base
{
public $aFacetGroups = array ();
public $aSelectedFacetGroups = array ();
public $sFilterText = '';
private function __construct() {
private function __construct()
{
}
static function CreateEmpty() {
static function createEmpty()
{
$obj = new Entity_FacetResult ();
return $obj;
}
static function CreateForRequest($data) {
static function createForRequest($data)
{
$obj = new Entity_FacetResult ();
$obj->initializeObject ( $data );
$obj->initializeObject ($data);
$requiredFields = array (
"aFacetGroups",
@@ -25,7 +29,7 @@ class Entity_FacetResult extends Entity_Base {
"sFilterText"
);
$obj->validateRequiredFields ( $requiredFields );
$obj->validateRequiredFields ($requiredFields);
return $obj;
}

View File

@@ -1,34 +1,38 @@
<?php
require_once ('Base.php');
class Entity_SelectedFacetGroupItem extends Entity_Base {
class Entity_SelectedFacetGroupItem extends Entity_Base
{
public $selectedFacetGroupName = '';
public $selectedFacetGroupPrintName = '';
public $selectedFacetItemName = '';
public $selectedFacetItemPrintName = '';
public $selectedFacetRemoveCondition = ''; // remove condition, string of
// selected facets without this
// facet
// selected facets without this
// facet
private function __construct() {
private function __construct()
{
}
static function CreateEmpty() {
static function createEmpty()
{
$obj = new Entity_SelectedFacetGroupItem ();
return $obj;
}
static function CreateForRequest($data) {
static function createForRequest($data)
{
$obj = new Entity_SelectedFacetGroupItem ();
$obj->initializeObject ( $data );
$obj->initializeObject ($data);
$requiredFields = array (
"selectedFacetGroupName",
"selectedFacetItemName"
);
$obj->validateRequiredFields ( $requiredFields );
$obj->validateRequiredFields ($requiredFields);
return $obj;
}

View File

@@ -1,25 +1,29 @@
<?php
require_once ('Base.php');
class Entity_SolrQueryResult extends Entity_Base {
class Entity_SolrQueryResult extends Entity_Base
{
public $sEcho = '';
public $iTotalRecords = 0;
public $iTotalDisplayRecords = 10;
public $aaData = array (); // array of arrays of records to
// display
// display
private function __construct() {
private function __construct()
{
}
static function CreateEmpty() {
static function createEmpty()
{
$obj = new Entity_SolrQueryResult ();
return $obj;
}
static function CreateForRequest($data) {
static function createForRequest($data)
{
$obj = new Entity_SolrQueryResult ();
$obj->initializeObject ( $data );
$obj->initializeObject ($data);
$requiredFields = array (
'sEcho',
@@ -28,7 +32,7 @@ class Entity_SolrQueryResult extends Entity_Base {
'aaData'
);
$obj->validateRequiredFields ( $requiredFields );
$obj->validateRequiredFields ($requiredFields);
return $obj;
}

View File

@@ -1,7 +1,8 @@
<?php
require_once ('Base.php');
class Entity_SolrRequestData extends Entity_Base {
class Entity_SolrRequestData extends Entity_Base
{
public $workspace = '';
public $startAfter = 0;
public $pageSize = 10;
@@ -9,32 +10,35 @@ class Entity_SolrRequestData extends Entity_Base {
public $filterText = ''; // comma separated list of filters field:value
public $numSortingCols = 0; // number of columns that are sorted
public $sortableCols = array (); // array of booleans indicating if column is
// sortable (true, false)
// sortable (true, false)
public $sortCols = array (); // array of indices of sorted columns index
// based in the total number of sorting cols
// based in the total number of sorting cols
public $sortDir = array (); // array of direction of sorting for each
// column (desc, asc)
// column (desc, asc)
public $includeCols = array ();
public $resultFormat = 'xml'; // json, xml, php
private function __construct() {
private function __construct()
{
}
static function CreateEmpty() {
static function createEmpty()
{
$obj = new Entity_SolrRequestData ();
return $obj;
}
static function CreateForRequestPagination($data) {
static function createForRequestPagination($data)
{
$obj = new Entity_SolrRequestData ();
$obj->initializeObject ( $data );
$obj->initializeObject ($data);
$requiredFields = array (
'workspace'
);
$obj->validateRequiredFields ( $requiredFields );
$obj->validateRequiredFields ($requiredFields);
return $obj;
}

View File

@@ -1,29 +1,33 @@
<?php
require_once ('Base.php');
class Entity_SolrUpdateDocument extends Entity_Base {
class Entity_SolrUpdateDocument extends Entity_Base
{
var $workspace = '';
var $document = '';
private function __construct() {
private function __construct()
{
}
static function CreateEmpty() {
static function createEmpty()
{
$obj = new Entity_SolrUpdateDocument ();
return $obj;
}
static function CreateForRequest($data) {
static function createForRequest($data)
{
$obj = new Entity_SolrUpdateDocument ();
$obj->initializeObject ( $data );
$obj->initializeObject ($data);
$requiredFields = array (
"workspace",
"document"
);
$obj->validateRequiredFields ( $requiredFields );
$obj->validateRequiredFields ($requiredFields);
return $obj;
}

View File

@@ -109,7 +109,7 @@ class AppSolrQueue extends BaseAppSolrQueue {
$row = $rs->getRow();
while (is_array($row)) {
$appSolrQueue = Entity_AppSolrQueue::CreateEmpty();
$appSolrQueue = Entity_AppSolrQueue::createEmpty();
$appSolrQueue->appUid = $row['APP_UID'];
$appSolrQueue->appUpdated = $row['APP_UPDATED'];
$updatedApplications[] = $appSolrQueue;