OpenGraphURLCollection Class Reference
Inheritance diagram for OpenGraphURLCollection:
Public Member Functions | |
| getClassName () | |
| render ($with_wrapper=true) | |
 Public Member Functions inherited from SimpleORMapCollection | |
| __construct (Closure $finder=null, array $options=null, SimpleORMap $record=null) | |
| offsetSet ($index, $newval) | |
| setClassName ($class_name) | |
| setRelatedRecord (SimpleORMap $record) | |
| getClassName () | |
| refresh () | |
| find ($value) | |
| toGroupedArray ($group_by='id', $only_these_fields=null, callable $group_func=null) | |
| unsetByPk ($id) | |
| merge (SimpleCollection $a_collection, string $mode='ignore') | |
| Public Member Functions inherited from SimpleCollection | |
| __construct ($data=[]) | |
| exchangeArray ($input) | |
| toArray () | |
| append ($newval) | |
| offsetSet ($index, $newval) | |
| offsetUnset ($index) | |
| setFinder (callable $finder) | |
| getDeleted () | |
| refresh () | |
| findBy ($key, $values, $op='==') | |
| findOneBy ($key, $values, $op='==') | |
| each (callable $func) | |
| map (callable $func) | |
| filter (callable $func=null, $limit=null) | |
| any (callable $func) | |
| every (callable $func) | |
| pluck ($columns) | |
| toGroupedArray ($group_by='id', $only_these_fields=null, callable $group_func=null) | |
| first () | |
| last () | |
| val ($key) | |
| unsetBy ($key, $values, $op='==') | |
| orderBy ($order, $sort_flags=SORT_LOCALE_STRING) | |
| limit ($arg1, $arg2=null) | |
| sendMessage ($method, $params=[]) | |
| __call ($method, $params) | |
| merge (SimpleCollection $a_collection) | |
| Public Member Functions inherited from StudipArrayObject | |
| __construct ($input=[], $flags=self::STD_PROP_LIST, $iteratorClass='ArrayIterator') | |
| __isset ($key) | |
| __set ($key, $value) | |
| __unset ($key) | |
| __get ($key) | |
| append ($value) | |
| asort () | |
| count () | |
| exchangeArray ($data) | |
| getArrayCopy () | |
| getFlags () | |
| getIterator () | |
| getIteratorClass () | |
| ksort () | |
| natcasesort () | |
| natsort () | |
| offsetExists ($key) | |
| offsetGet ($key) | |
| offsetSet ($key, $value) | |
| offsetUnset ($key) | |
| serialize () | |
| setFlags ($flags) | |
| setIteratorClass ($class) | |
| uasort ($function) | |
| uksort ($function) | |
| unserialize ($data) | |
| contains ($value) | |
Additional Inherited Members | |
| Static Public Member Functions inherited from SimpleORMapCollection | |
| static | createFromArray (array $data, $strict=true) |
| Static Public Member Functions inherited from SimpleCollection | |
| static | createFromArray (array $data) |
| static | arrayToArrayObject ($a) |
| static | getCompFunc ($operator, $args) |
| static | translitLatin1 ($text) |
| Data Fields inherited from SimpleORMapCollection | |
| const | WRONG_OBJECT_TYPE = 1 |
| const | OBJECT_EXISTS = 2 |
| Data Fields inherited from StudipArrayObject | |
| const | STD_PROP_LIST = 1 |
| const | ARRAY_AS_PROPS = 2 |
| Protected Member Functions inherited from StudipArrayObject | |
| validateKeyUsage ($key) | |
| Protected Attributes inherited from SimpleORMapCollection | |
| $related_record | |
| $relation_options = [] | |
| Protected Attributes inherited from SimpleCollection | |
| $finder | |
| $last_count | |
| $deleted | |
| Protected Attributes inherited from StudipArrayObject | |
| $storage | |
| $flag | |
| $iteratorClass | |
| $protectedProperties | |
Detailed Description
Specialized version of SimpleORMapCollection that accepts only OpenGraphURL objects and provides a method that renders the collection to html.
Member Function Documentation
◆ getClassName()
| getClassName | ( | ) |
Returns the class name of the object this collection accepts.
- Returns
- String containing the provided class name 'OpenGraphURL'
◆ render()
| render | ( | $with_wrapper = true | ) |
Renders the collection to html. The collection is usually wrapped in a wrapper element but in some edge cases you might want to choose not to do so. This is enabled by the only parameter this method accepts.
Note: I advice you not to exclude the wrapper. The javascript that handles the collection will fail!
- Parameters
-
bool $with_wrapper Should the collection be wrapped in a wrapper element (optional, defaults to true)
- Returns
- String containing the rendered collection as a html chunk
The documentation for this class was generated from the following file:
- lib/models/OpenGraphURLCollection.class.php
