1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 <?php
/*-----8<--------------------------------------------------------------------
*
* BEdita - a semantic content management framework
*
* Copyright 2014-2015 ChannelWeb Srl, Chialab Srl
*
* This file is part of BEdita: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* BEdita is distributed WITHOUT ANY WARRANTY; without even the implied
* warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with BEdita (see LICENSE.LGPL).
* If not, see <http://gnu.org/licenses/lgpl-3.0.html>.
*
*------------------------------------------------------------------->8-----
*/
/**
* ApiFormatter class
*
* Format data to be consumed by client or to be saved
*
*/
class ApiFormatterComponent extends Object {
/**
* Controller instance
*
* @var Controller
*/
public $controller = null;
/**
* Components used
*
* @var array
*/
public $components = array('ApiValidator');
/**
* Fields that must be removed from object/s
*
* @var array
*/
protected $objectFieldsToRemove = array(
'UserCreated',
'ObjectProperty',
'ObjectType',
'RelatedObject',
'bindings',
'fixed',
'valid',
'ip_created',
'pathSection',
// areas
'stats_code',
'stats_provider',
'stats_provider_url',
// sections
'syndicate',
'priority_order',
'last_modified',
'map_priority',
'map_changefreq',
// trees fields
'area_id',
'object_path',
'priority',
'menu',
'Category' => array(
'id',
'object_type_id',
'area_id',
'status',
'priority',
'parent_id',
'parent_path',
'url_label'
),
'Tag' => array(
'id',
'object_type_id',
'area_id',
'status',
'priority',
'parent_id',
'parent_path',
'url_label'
),
'DateItem' => array(
'object_id',
'params'
)
);
/**
* Contain fields transformation as `field` => `type`
* It used for cast string in other types.
* Some special types act on fields instead of values. See below.
*
* Possible types values are:
*
* - `date`
* - `datetime`
* - `integer`
* - `float`
* - `boolean`
*
* Special types:
*
* - `underscoreField` underscorize field. Note that the value of field remains unchanged
* - `integerArray` cast to integer all array values
*
*
* The `object` key contains transformation merged with all BEdita objects
*
* @see self::transformObject(), self::transformItem()
* @var array
*/
protected $transformers = array(
'object' => array(
'publication_date' => 'datetime',
'customProperties' => 'underscoreField',
'canonicalPath' => 'underscoreField',
'parentAuthorized' => 'underscoreField'
)
);
/**
* The URL query string parameters formatted
*
* @see self::formatUrlParams()
* @var array
*/
protected $urlParams = array();
/**
* A list of custom properties divided by object type
*
* ```
* array(
* 'document' => array(
* id_custom_1 => 'custom1',
* id_custom_2 => 'custom2',
* ),
* ...
* )
* ```
*
* @var array
*/
protected $customPropertiesList = array();
/**
* Initialize function
*
* @param Controller $controller
* @return void
*/
public function initialize(Controller $controller, array $settings = array()) {
$this->controller = &$controller;
if (isset($settings['objectFieldsToRemove']) && is_array($settings['objectFieldsToRemove'])) {
$this->objectFieldsToRemove($settings['objectFieldsToRemove'], true);
}
$confFields = Configure::read('api.formatting.fields');
if (!empty($confFields)) {
$this->objectFieldsToRemove($confFields);
}
}
/**
* Call without parameters to return the acutal self::objectFieldsToRemove
* Pass paramteres to setup new self::objectFieldsToRemove and return it
*
* If $override is true $confFields replaces self::objectFieldsToRemove
*
* If $override is false (default) then $confFields has to be an array like
*
* ```
* array(
* 'remove' => array(
* 'fieldToRemove_1',
* 'fieldToRemove_2',
* 'fieldOnWhichRemoveFields' => array(
* 'fieldToRemove_3',
* 'fieldToRemove_4'
* )
* ),
* 'keep' => array(
* 'fieldToKeep_1',
* 'fieldToKeep_2',
* 'fieldOnWhichKeepFields' => array(
* 'fieldToKeep_3'
* )
* )
* )
* ```
*
* All fields in 'remove' will be added to self::objectFieldsToRemove
* All fields in 'keep' will be removed from self::objectFieldsToRemove
*
* @param array $confFields
* @param boolean $override
* @return array
*/
public function objectFieldsToRemove(array $confFields = array(), $override = false) {
if ($override) {
$this->objectFieldsToRemove = $confFields;
return $this->objectFieldsToRemove;
}
if (empty($confFields)) {
return $this->objectFieldsToRemove;
}
// add fields to remove
if (isset($confFields['remove']) && is_array($confFields['remove'])) {
foreach ($confFields['remove'] as $key => $field) {
if (is_array($field)) {
if (is_string($key)) {
if (isset($this->objectFieldsToRemove[$key])) {
$this->objectFieldsToRemove[$key] = array_unique(array_merge($this->objectFieldsToRemove[$key], $field));
} else {
$this->objectFieldsToRemove[$key] = $field;
}
}
} else {
if (isset($this->objectFieldsToRemove[$field])) {
unset($this->objectFieldsToRemove[$field]);
}
if (!in_array($field, $this->objectFieldsToRemove)) {
$this->objectFieldsToRemove[] = $field;
}
}
}
}
// keep fields
if (isset($confFields['keep']) && is_array($confFields['keep'])) {
foreach ($confFields['keep'] as $key => $field) {
if (is_array($field)) {
if (is_string($key)) {
if (isset($this->objectFieldsToRemove[$key])) {
$this->objectFieldsToRemove[$key] = array_values(
array_diff($this->objectFieldsToRemove[$key], $field)
);
}
}
} else {
$found = array_search($field, $this->objectFieldsToRemove);
if ($found !== false) {
unset($this->objectFieldsToRemove[$found]);
} elseif (isset($this->objectFieldsToRemove[$field])) {
unset($this->objectFieldsToRemove[$field]);
}
}
}
}
return $this->objectFieldsToRemove;
}
/**
* Transform the item passed using a transformer
* The transformer must be an array of 'fields' => 'type' or 'key' => array('field1' => 'type') for example
*
* ```
* array(
* 'id' => 'integer',
* 'start_date' => 'datetime',
* 'GeoTag' => array(
* 'id' => 'integer',
* ...
* )
* )
* ```
*
* The keys that correspond to array as `GeoTag` will be underscorized and pluralized.
* So `GeoTag` become `geo_tags` in the $item array
*
* @see self::transformers comments to all 'type' possibility
* @param array $transformer the transformer array
* @param array &$item the item to transform
* @return void
*/
protected function transformItem(array $transformer, array &$item) {
if (!empty($item[0]) && is_array($item[0])) {
foreach ($item as &$i) {
$this->transformItem($transformer, $i);
}
} else {
foreach ($transformer as $field => $type) {
if (isset($item[$field])) {
if (is_array($type)) {
// underscore and pluralize $field
$newField = Inflector::pluralize(Inflector::underscore($field));
if ($newField != $field) {
$item[$newField] = $item[$field];
unset($item[$field]);
}
if (is_array($item[$newField])) {
$this->transformItem($transformer[$field], $item[$newField]);
}
} else {
switch ($type) {
case 'integer':
$item[$field] = (int) $item[$field];
break;
case 'float':
$item[$field] = (float) $item[$field];
break;
case 'boolean':
$item[$field] = (bool) $item[$field];
break;
case 'date':
case 'datetime':
if (!empty($item[$field])) {
$item[$field] = $this->dateFromDb($item[$field]);
}
break;
case 'underscoreField':
$newField = Inflector::underscore($field);
$item[$newField] = $item[$field];
unset($item[$field]);
break;
case 'integerArray':
if (is_array($item[$field])) {
$item[$field] = array_map('intval', $item[$field]);
}
break;
}
}
}
}
}
}
/**
* Convert a date from db to ISO-8601 format
* Use DateTime::ATOM format i.e. 2005-08-15T15:52:01+00:00
*
* @param string $date the date string to convert
* @return string
*/
public function dateFromDb($date) {
$dateTime = new DateTime($date);
return $dateTime->format(DateTime::ATOM);
}
/**
* Convert a date from ISO-8601 to $dbFormat
* The format supported are:
* - 2005-08-15T15:52:01+02:00
* - 2005-08-15T13:52:01.467Z (js Date().toISOString())
*
* @param string $date the ISO-8601 date string
* @param string $dbFormat the db format (default 'datetime' db type)
* @return string
*/
public function dateToDb($date, $dbFormat = 'Y-m-d H:i:s') {
$dateTime = $this->ApiValidator->checkDate($date);
return $dateTime->format($dbFormat);
}
/**
* Transform an item using a transformer from self::transformers
*
* @param string $subject the transformer name to use
* @param array &$item the item to transform
* @return void
*/
public function transform($subject, array &$item) {
if (!empty($this->transformers[$subject])) {
$this->transformItem($this->transformers[$subject], $item);
}
}
/**
* Return the BEdita object transformer
* Used to know the fields to cast and the type
*
* @param array $object the BEdita object
* @return array
*/
public function getObjectTransformer(array $object) {
$objectType = !empty($object['object_type']) ? $object['object_type'] : $object['object_type_id'];
$modelName = Configure::read('objectTypes.' . $objectType . '.model');
$Object = ClassRegistry::init($modelName);
$modelName = $Object->name;
$transformer = array();
if (!isset($this->transformers[$modelName])) {
$cacheName = 'apiTransformer' . $modelName;
$debugMode = Configure::read('debug');
if (!$debugMode) {
$transformer = Cache::read($cacheName);
}
if (empty($transformer)) {
$transformer = $Object->apiTransformer();
$transformer = array_merge($this->transformers['object'], $transformer);
if (!$debugMode) {
Cache::write($cacheName, $transformer);
}
}
// add transformer to self::transformers to reuse it in case
$this->transformers[$modelName] = $transformer;
} else {
$transformer = $this->transformers[$modelName];
}
return $transformer;
}
/**
* Transform a BEdita object type casting fields to the right type
* Use BEAppObjectModel::apiTransformer() to get the transformer and merge it with self::transformers['object']
*
* The transformer is cached
*
* @param array &$object
* @return void
*/
public function transformObject(array &$object) {
$transformer = $this->getObjectTransformer($object);
$this->transformItem($transformer, $object);
}
/**
* Prepare self::$transformer['object'] adding 'custom_properties' formatting info
* It is expected that $object contains the 'ObjectProperty' with custom properties details
*
* @param array $object the object on which prepare the custom properties transformer
*/
public function setCustomPropertiesTransformer(array $object) {
$this->transformers['object']['custom_properties'] = array();
if (!empty($object['ObjectProperty'])) {
foreach ($object['ObjectProperty'] as $name => $customProp) {
if ($customProp['property_type'] == 'number') {
$this->transformers['object']['custom_properties'][$name] = 'float';
} elseif ($customProp['property_type'] == 'date') {
$this->transformers['object']['custom_properties'][$name] = 'date';
}
}
}
}
/**
* Count $object relations and return a formatted array as
*
* ```
* array(
* 'attach' => array(
* 'count' => 8,
* 'url' => 'https://example.com/api/v1/objects/1/relations/attach'
* ),
* 'seealso' => array(
* 'count' => 2,
* 'url' => 'https://example.com/api/v1/objects/1/relations/seealso'
* )
* )
* ```
*
* It uses self::controller::relatedObjectsFilter() to eventually add conditions
*
* @param array $object the object on which to count the relations
* @return array
*/
public function formatRelationsCount(array $object) {
$relations = array();
$objectRelation = ClassRegistry::init('ObjectRelation');
$relationsFilter = $this->controller->relatedObjectsFilter();
// count all relations
$countRel = null;
if ($this->controller->BeObjectCache) {
$cacheOpts = array($this->controller->getStatus(), $relationsFilter);
$countRel = $this->controller->BeObjectCache->read($object['id'], $cacheOpts, 'relations-count');
}
$conditions = array('ObjectRelation.id' => $object['id']) + $relationsFilter;
if (empty($countRel)) {
$countRel = $objectRelation->find('all', array(
'fields' => array('COUNT(ObjectRelation.id) as count', 'ObjectRelation.switch'),
'conditions' => $conditions,
'group' => 'ObjectRelation.switch',
'joins' => array(
array(
'table' => 'objects',
'alias' => 'BEObject',
'type' => 'inner',
'conditions' => array(
'ObjectRelation.object_id = BEObject.id',
'BEObject.status' => $this->controller->getStatus()
)
)
)
));
if ($this->controller->BeObjectCache) {
$this->controller->BeObjectCache->write($object['id'], $cacheOpts,
$countRel, 'relations-count');
}
}
// count not accessible relations
if (!$this->controller->getShowUnauthorized() && !$this->controller->getSkipCheck()) {
$permission = ClassRegistry::init('Permission');
$user = $this->controller->ApiAuth->getUser();
if (!$user) {
$user = array();
}
$conditionsForbidden = array('BEObject.status' => $this->controller->getStatus()) + $relationsFilter;
$countForbidden = $permission->relatedObjectsNotAccessibile(
$object['id'],
array(
'count' => true,
'objectConditions' => $conditionsForbidden
),
$user
);
}
$excludeRelations = Configure::read('excludeRelationsFrontend');
$url = $this->controller->baseUrl() . '/objects/' . $object['id'] . '/relations/';
if (!empty($countRel)) {
foreach ($countRel as $cDetail) {
$count = $cDetail[0]['count'];
$switch = $cDetail['ObjectRelation']['switch'];
if ($excludeRelations && in_array($switch, $excludeRelations)) {
continue;
}
if (isset($countForbidden[$switch])) {
$count -= $countForbidden[$switch];
}
if ($count == 0) {
continue;
}
$relations[$switch] = array(
'count' => (int) $count,
'url' => $url . $switch
);
}
}
return $relations;
}
/**
* Count $object children and return a formatted array as
*
* ```
* array(
* 'count' => 14, // total children
* 'url' => 'https://example.com/api/v1/objects/1/children',
* 'contents' => array(
* 'count' => 12, // contents children
* 'url' => 'https://example.com/api/v1/objects/1/contents'
* ),
* 'sections' => array(
* 'count' => 2, // sections children
* 'url' => 'https://example.com/api/v1/objects/1/sections'
* )
* )
* ```
*
* It uses self::controller::childrenFilter() to eventually add conditions
*
* @param array $object the object on which to count children
* @return array
*/
public function formatChildrenCount(array $object) {
$tree = ClassRegistry::init('Tree');
$conditions = array('BEObject.status' => $this->controller->getStatus()) + $this->controller->childrenFilter();
$options = array(
'conditions' => $conditions,
'joins' => array()
);
$countContents = $tree->countChildrenContents($object['id'], $options);
$countSections = $tree->countChildrenSections($object['id'], $options);
if (!$this->controller->getShowUnauthorized() && !$this->controller->getSkipCheck()) {
$permissionJoin = array(
'table' => 'permissions',
'alias' => 'Permission',
'type' => 'inner',
'conditions' => array(
'Permission.object_id = Tree.id',
'Permission.flag' => Configure::read('objectPermissions.frontend_access_with_block'),
'Permission.switch' => 'group',
)
);
$options['joins'][] = $permissionJoin;
$countContentsForbidden = $tree->countChildrenContents($object['id'], $options);
$countSectionsForbidden = $tree->countChildrenSections($object['id'], $options);
$user = $this->controller->ApiAuth->getUser();
if (!empty($user)) {
$groupsIds = (!empty($user['groupsIds'])) ? $user['groupsIds'] : array();
$options['conditions']['NOT']['Permission.ugid'] = $groupsIds;
$countContentsForbidden -= $tree->countChildrenContents($object['id'], $options);
$countSectionsForbidden -= $tree->countChildrenSections($object['id'], $options);
}
$countContents -= $countContentsForbidden;
$countSections -= $countSectionsForbidden;
}
$countChildren = $countContents + $countSections;
$url = $this->controller->baseUrl() . '/objects/' . $object['id'] . '/';
if ($countChildren == 0) {
return array();
}
$result = array(
'count' => (int) $countChildren,
'url' => $url . 'children'
);
if ($countContents > 0) {
$result['contents'] = array(
'count' => (int) $countContents,
'url' => $url . 'contents'
);
}
if ($countSections > 0) {
$result['sections'] = array(
'count' => (int) $countSections,
'url' => $url . 'sections'
);
}
return $result;
}
/**
* Return a list of custom properties of specific object type id
*
* @param int $objectTypeId the object type id
* @return array
*/
public function getCustomPropertiesList($objectTypeId) {
$objectType = Configure::read('objectTypes.' . $objectTypeId . '.name');
if (!isset($this->customPropertiesList[$objectType])) {
$property = ClassRegistry::init('Property');
$this->customPropertiesList[$objectType] = $property->propertyNames($objectTypeId);
}
return $this->customPropertiesList[$objectType];
}
/**
* Given an object return the formatted data ready for api response
*
* The $result is normally located in 'data' key of api response
* and it's in the form
*
* ```
* 'object' => array(...) // object data
* ```
*
* $options is used to personalize the object formatted.
* Possible values are:
*
* - 'countRelations' (default false) to add a count of relations with url to reach them
* - 'countChildren' (default false) to add a count of children with url to reach them
*
* @param array $object representation of a BEdita object
* @param array $options
* @return array
*/
public function formatObject(array $object, $options = array()) {
$options += array('countRelations' => false, 'countChildren' => false);
$object['object_type'] = Configure::read('objectTypes.' . $object['object_type_id'] . '.name');
// adjust 'uri' in multimedia objects
$multimediaObjectTypeIds = Configure::read('objectTypes.multimedia.id');
if (in_array($object['object_type_id'], $multimediaObjectTypeIds)) {
if (!empty($object['uri']) && filter_var($object['uri'], FILTER_VALIDATE_URL) === false) {
$object['uri'] = Configure::read('mediaUrl') . $object['uri'];
}
}
// before clean prepare custom properties adding not populated and preparing transformer
if (!empty($object['ObjectProperty'])) {
foreach ($object['ObjectProperty'] as $propName => $objPropValue) {
if (!isset($object['customProperties'][$propName])) {
$object['customProperties'][$propName] = null;
}
}
} else {
$propList = $this->getCustomPropertiesList($object['object_type_id']);
$object['customProperties'] = array_fill_keys($propList, null);
}
$this->setCustomPropertiesTransformer($object);
$this->cleanObject($object);
$this->transformObject($object);
if ($options['countRelations']) {
$object['relations'] = $this->formatRelationsCount($object);
}
if ($options['countChildren']) {
$branches = array(
Configure::read('objectTypes.area.id'),
Configure::read('objectTypes.section.id')
);
if (in_array($object['object_type_id'], $branches)) {
$object['children'] = $this->formatChildrenCount($object);
}
}
return array('object' => $object);
}
/**
* Given an array of objects return the formatted data ready for api response
* Iteratively call self::formatObject() on every object of the list
*
* ```
* 'objects' => array(...), // object data
* ```
*
* $options is used to personalize the object formatted.
*
* @see self::formatObject()
* @param array $objects array of BEdita objects
* @param array $options
* @return array
*/
public function formatObjects(array $objects, $options = array()) {
$result = array('objects' => array());
foreach ($objects as $obj) {
$objectFormatted = $this->formatObject($obj, $options);
$result['objects'][] = $objectFormatted['object'];
}
return $result;
}
/**
* Starting from BEdita toolbar it returns the paging item as
*
* ```
* 'page' => int, // the current page
* 'page_size' => int|null, // the maximum number of items in the response
* 'page_count' => int, // the total number of items in the page
* 'total' => int, // the total number of items
* 'total_pages' => int // the total number of pages
* ```
*
* @param array $toolbar
* @return array
*/
public function formatPaging(array $toolbar) {
if (empty($toolbar)) {
return array();
}
$pageCount = ($toolbar['end'] > 0) ? $toolbar['end'] - $toolbar['start'] + 1 : $toolbar['size'];
$paging = array(
'page' => (int) $toolbar['page'],
'page_size' => (!empty($toolbar['dim'])) ? (int) $toolbar['dim'] : null,
'page_count' => (int) $pageCount,
'total' => (int) $toolbar['size'],
'total_pages' => (int) $toolbar['pages']
);
return $paging;
}
/**
* Clean BEdita object array from useless fields
* Use self::objectFieldsToRemove
*
* @param array &$object
* @return void
*/
public function cleanObject(array &$object) {
foreach ($this->objectFieldsToRemove as $key => $value) {
if (is_array($value)) {
$fieldsToRemove = array_flip($value);
if (!empty($object[$key][0])) {
foreach ($object[$key] as &$detail) {
$detail = array_diff_key($detail, $fieldsToRemove);
}
} elseif (isset($object[$key])) {
$object[$key] = array_diff_key($object[$key], $fieldsToRemove);
}
} elseif (array_key_exists($value, $object)) {
unset($object[$value]);
}
}
}
/**
* Arrange $object data to save
*
* - clean fields
* - transform date ISO8601 in SQL format
*
* @param array $object the $object data to save
* @return array
*/
public function formatObjectForSave(array $object) {
if (!empty($object['relations'])) {
$object['RelatedObject'] = $this->formatRelationsForSave($object['relations']);
unset($object['relations']);
}
if (!empty($object['categories'])) {
$object['Category'] = $this->formatCategoriesForSave($object['categories'], $object['object_type_id']);
unset($object['categories']);
}
if (!empty($object['tags'])) {
$tags = $this->formatTagsForSave($object['tags']);
$object['Category'] = (!empty($object['Category'])) ? array_merge($object['Category'], $tags) : $tags;
unset($object['tags']);
}
if (!empty($object['geo_tags'])) {
$object['GeoTag'] = $object['geo_tags'];
unset($object['geo_tags']);
}
if (!empty($object['date_items'])) {
$object['DateItem'] = $this->formatDateItemsForSave($object['date_items']);
unset($object['date_items']);
}
if (!empty($object['custom_properties'])) {
$object['custom_properties'] = $this->formatCustomPropertiesForSave($object['custom_properties'], $object['object_type_id']);
}
$transformer = $this->getObjectTransformer($object);
foreach ($object as $key => $value) {
if (array_key_exists($key, $transformer)) {
if ($transformer[$key] == 'date') {
$object[$key] = $this->dateToDb($value, 'Y-m-d');
} elseif ($transformer[$key] == 'datetime') {
$object[$key] = $this->dateToDb($value, 'Y-m-d H:i:s');
}
}
}
return $object;
}
/**
* Arrange relations data to save.
* The data returned are suitable to saving an object
*
* The $relations array has to be in the form
* ```
* array(
* 'attach' => array(
* array(
* 'related_id' => 1,
* ...
* ),
* array(...)
* ),
* 'seealso' => array(...)
* )
* ```
*
* @param array $relations array of relations
* @return array
*/
public function formatRelationsForSave(array $relations) {
$relationsFormatted = array();
foreach ($relations as $name => $relList) {
$r = array(
0 => array('switch' => $name)
);
foreach ($relList as $key => $relData) {
$r[$relData['related_id']]['id'] = $relData['related_id'];
$r[$relData['related_id']]['priority'] = empty($relData['priority']) ? $key + 1 : $relData['priority'];
if (!empty($relData['params'])) {
$r[$relData['related_id']]['params'] = $relData['params'];
}
}
$relationsFormatted[$name] = $r;
}
return $relationsFormatted;
}
/**
* Arrange categories data for save.
* The data returned are suitable to saving an object.
* Return an array of ids
*
* @param array $categories an array of category names
* @param int $objectTypeId the object type id
* @return array
*/
public function formatCategoriesForSave(array $categories, $objectTypeId = null) {
$categoryModel = ClassRegistry::init('Category');
$categoryModel->Behaviors->disable('CompactResult');
$result = $categoryModel->find('list', array(
'fields' => array('name', 'id'),
'conditions' => array(
'name' => $categories,
'object_type_id' => $objectTypeId,
'status' => $this->controller->getStatus()
)
));
$categoryModel->Behaviors->enable('CompactResult');
return array_values($result);
}
/**
* Arrange tags data for save.
* The data returned are suitable to saving an object.
* Return an array of ids
*
* @param array $tags an array of tag names
* @return array
*/
public function formatTagsForSave(array $tags) {
return $this->formatCategoriesForSave($tags);
}
/**
* Arrange date items for save:
* - format 'start_date' and 'end_date'
*
*/
public function formatDateItemsForSave(array $dateItems) {
foreach ($dateItems as &$item) {
foreach ($item as $field => &$value) {
if (($field == 'start_date' || $field == 'end_date') && !empty($value)) {
$value = $this->dateToDb($value, 'Y-m-d H:i:s');
} elseif ($field == 'days') {
sort($value);
}
}
}
return $dateItems;
}
/**
* Format custom properties for save
* Array as
*
* ```
* array(
* 'custom_name_1' => 'value_1',
* 'custom_name_2' => array('value_2', 'value_3')
* )
* ```
*
* become
*
* ```
* array(
* 0 => array(
* 'property_id' => 1, // id of custom_name_1
* 'property_value' => 'value_1'
* ),
* 1 => array(
* 'property_id' => 2, // id of custom_name_2
* 'property_value' => 'value_2'
* ),
* 2 => array(
* 'property_id' => 2, // id of custom_name_2
* 'property_value' => 'value_3'
* )
* )
* ```
*
* @param array $customProperties array of custom properties to format
* @param int $objectTypeId the object type id
* @return array
*/
public function formatCustomPropertiesForSave(array $customProperties, $objectTypeId) {
$property = ClassRegistry::init('Property');
$result = array();
$cp = $property->find('all', array(
'conditions' => array(
'name' => array_keys($customProperties),
'object_type_id' => $objectTypeId
),
'contain' => array()
));
$cp = Set::combine($cp, '{n}.name', '{n}');
if (!empty($customProperties)) {
foreach ($customProperties as $cpName => $value) {
if (!empty($cp[$cpName])) {
$value = (!is_array($value)) ? array($value) : $value;
foreach ($value as $v) {
if ($cp[$cpName]['property_type'] == 'date') {
$v = $this->dateToDb($v);
}
$result[] = array(
'property_id' => $cp[$cpName]['id'],
'property_value' => $v,
);
}
}
}
}
return $result;
}
/**
* Format $this->controller->params['url'] building array of values starting from $separator separated values.
* By default $separator is ',' char and 'query' is excluded because it represents a full text search.
*
* For example in a request as:
*
* https://example.com/objects?filter[object_type]=document,event&page=2
*
* the url params are formatted as
*
* ```
* array(
* 'filter' => array(
* 'object_type' => array('document', 'event')
* ),
* 'page' => 2
* )
* ```
*
* Once url params has been formatted that value is returned to every next call without parse again the url
* unless $reset params is true
*
* @param string $separator the separator char that explode string in array
* @param array $exclude the array of url params to exclude to the formatting
* @param boolean $reset true if the url params have to be formatted again also if it had already been done
* @return array
*/
public function formatUrlParams($separator = ',', array $exclude = array('query'), $reset = false) {
if (empty($this->urlParams) || $reset) {
$this->urlParams = $this->controller->params['url'];
array_shift($this->urlParams);
if (!empty($this->urlParams)) {
foreach ($this->urlParams as $name => &$value) {
if (is_array($value)) {
foreach ($value as $k => &$v) {
if (!in_array($k, $exclude)) {
if ($name == 'embed' && $k == 'relations') {
$rel = explode($separator, trim($v, $separator));
$v = array();
foreach ($rel as $relInfo) {
$relInfoArr = explode('|', $relInfo);
$v[$relInfoArr[0]] = (!empty($relInfoArr[1])) ? $relInfoArr[1] : 1;
}
} elseif (!is_array($v)) {
$v = trim($v, $separator);
if (strpos($v, $separator) !== false) {
$v = explode($separator, $v);
}
}
}
}
} else {
$value = trim($value, $separator);
if (strpos($value, $separator) !== false && !in_array($name, $exclude)) {
$value = explode($separator, $value);
}
}
}
}
}
return $this->urlParams;
}
}