https://github.com/indieweb/php-comments
Helper for parsing and presenting comments from external sites
https://github.com/indieweb/php-comments
Last synced: 6 months ago
JSON representation
Helper for parsing and presenting comments from external sites
- Host: GitHub
- URL: https://github.com/indieweb/php-comments
- Owner: indieweb
- License: apache-2.0
- Created: 2014-02-21T19:57:09.000Z (about 11 years ago)
- Default Branch: main
- Last Pushed: 2024-05-12T19:14:29.000Z (about 1 year ago)
- Last Synced: 2024-10-29T19:03:19.990Z (7 months ago)
- Language: PHP
- Homepage: http://indiewebcamp.com/comments-presentation
- Size: 39.1 KB
- Stars: 18
- Watchers: 20
- Forks: 4
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Comments Presentation
=====================
Given an [h-entry](http://indiewebcamp.com/h-entry), returns author info as well as truncated post text suitable for display.
Installation
------------
Install via composer:
```json
{
"indieweb/comments": "0.1.*",
}
```
Or just require the one file:
```php
require_once('src/indieweb/comments.php');
```
Usage
-----
The function accepts a PHP array in the format returned by the [microformats2 parser](https://github.com/indieweb/php-mf2)
and returns a new array that looks like the following:
Original HTML:
```html
```
Parsed Microformats:
```json
{
"type": [
"h-entry"
],
"properties": {
"author": [
{
"type": [
"h-card"
],
"properties": {
"photo": [
"http:\/\/aaronparecki.com\/images\/aaronpk.png"
],
"name": [
"Aaron Parecki"
],
"url": [
"http:\/\/aaronparecki.com"
]
},
"value": "Aaron Parecki"
}
],
"name": [
"Example Note"
],
"published": [
"2014-02-16T18:48:17-0800"
],
"in-reply-to": [
"http:\/\/caseorganic.com\/post\/1"
],
"content": [
{
"html": "this text is displayed as the comment",
"value": "this text is displayed as the comment"
}
]
}
}
```
Parse for comment display:
```php
$result = IndieWeb\comments\parse($input, $refURL, $maxLength, $maxLines);
```
Resulting PHP array:
```php
$result = array(
'type' => 'reply',
'author' => array(
'name' => 'Aaron Parecki',
'photo' => 'http://aaronparecki.com/images/aaronpk.png',
'url' => 'http://aaronparecki.com/'
),
'published' => '2014-02-16T18:48:17-0800',
'name' => 'Example Note',
'text' => 'this text is displayed as the comment',
'url' => 'http://aaronparecki.com/post/1'
)
```
This function will return an array with all of the keys above. One or more values may
be empty depending on what information was available in the post, such as author name/photo.
The `text` property will always be within your maximum desired length as passed to the `parse()` function.
The function follows the algorithm described at [comments-presentation](http://indiewebcamp.com/comments-presentation#How_to_display)
for deciding whether to show the `p-name`, `p-summary` or `e-content` properties and truncating appropriately.
Post Types
----------
The parser also attempts to determine what type of post this is relative to the primary URL.
A key named `type` will always be returned with one of the following values:
* mention - default
* reply - when the post contains explicit `in-reply-to` markup
* rsvp - if the post contains an RSVP yes/no/maybe value
* like
* repost
When the type is "rsvp", there will also be an `rsvp` key set to the value of the RSVP, usually "yes", "no" or "maybe".
Post Names
----------
If the post has a "name" property that is not the same as the content, then it will also
be included in the parsed result. This is so that the calling code can choose to display
the post name linked to the full post rather than the content.
```php
$result = array(
'type' => 'mention',
'author' => array(
'name' => 'Aaron Parecki',
'photo' => 'http://aaronparecki.com/images/aaronpk.png',
'url' => 'http://aaronparecki.com/'
),
'published' => '2014-02-16T18:48:17-0800',
'name' => 'Post Name',
'text' => 'this is the text of the article',
'url' => 'http://aaronparecki.com/post/1'
)
```
Tests
-----
Please see the [tests](tests/BasicTest.php) for more complete examples of parsing different posts.
License
-------
Copyright 2014 by Aaron Parecki
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
