mirror of
https://github.com/alchemy-fr/Phraseanet.git
synced 2025-10-13 04:53:26 +00:00
e79f2cb4f2
- multiple pagination methods - "include" parameter in /search route : -- facets : facets are no more returned by default -- results.stories.children : to populate the children of stories - "story_children_limit" parameter in /search route will limit the number of children populated by story - "count" (for results) and "children_count" (for stories in results) is the number of items in the current page - "total" (for results) and "children_total" (for stories in results) is the total number of items todo: swagger doc (but impossible to describe related/excluded parameters (like pagination methods in /search)
111 lines
2.2 KiB
PHP
111 lines
2.2 KiB
PHP
<?php
|
|
/*
|
|
* This file is part of Phraseanet
|
|
*
|
|
* (c) 2005-2016 Alchemy
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Alchemy\Phrasea\Search;
|
|
|
|
use Assert\Assertion;
|
|
|
|
/**
|
|
* used as a (temporary / specific) view of a story
|
|
* WARNING : the children DO NOT NECESSARILY reflect the whole content of a story
|
|
* children may contain only a subset :
|
|
* - visible for a specific user
|
|
* - paginated
|
|
*
|
|
* Class StoryView
|
|
* @package Alchemy\Phrasea\Search
|
|
*/
|
|
|
|
class StoryView
|
|
{
|
|
use SubdefsAware;
|
|
use CaptionAware;
|
|
|
|
/**
|
|
* @var \record_adapter
|
|
*/
|
|
private $story;
|
|
|
|
/**
|
|
* @var RecordView[]
|
|
* may be a subset of all children (only visibles for a user and/or paginated)
|
|
*/
|
|
private $children = [];
|
|
|
|
/**
|
|
* @var mixed[]
|
|
* "personal use" data to be stored/retreived for a specific usage
|
|
* e.g. api V3 will store pagination infos to be rendered on output
|
|
*/
|
|
private $_data = [];
|
|
|
|
/**
|
|
* @param \record_adapter $story
|
|
*/
|
|
public function __construct(\record_adapter $story)
|
|
{
|
|
$this->story = $story;
|
|
}
|
|
|
|
/**
|
|
* @return \record_adapter
|
|
*/
|
|
public function getStory()
|
|
{
|
|
return $this->story;
|
|
}
|
|
|
|
/**
|
|
* @param RecordView[] $children
|
|
* @return self
|
|
*/
|
|
public function setChildren($children)
|
|
{
|
|
Assertion::allIsInstanceOf($children, RecordView::class);
|
|
|
|
$this->children = $children instanceof \Traversable ? iterator_to_array($children, false) : array_values($children);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @return RecordView[]
|
|
*/
|
|
public function getChildren()
|
|
{
|
|
return $this->children;
|
|
}
|
|
|
|
/**
|
|
* set a "personal usage" data
|
|
*
|
|
* @param string $k
|
|
* @param mixed $v
|
|
* @return self
|
|
*/
|
|
public function setData($k, $v)
|
|
{
|
|
$this->_data[$k] = $v;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* get a "personal usage" data (null if not found)
|
|
*
|
|
* @param string $k
|
|
* @return mixed|null
|
|
*/
|
|
public function getData($k)
|
|
{
|
|
return isset($this->_data[$k]) ? $this->_data[$k] : null;
|
|
}
|
|
}
|