My Sample Add-On

bj.lewis221 · Feb 5th 2019

I am trying to wrap my head around creating custom Add-Ons, and without tweaking anything from the download when I implement

PHP

<?php my_sample_detail(); ?>

it throws this error

Code

Warning: Missing argument 1 for my_sample_detail(), called in /public_html/page/index.php on line 54 and defined in public_html/login/addons/apps/my_sample/runtime.php on line 71

I am unsure how to fix.

drewm · Feb 5th 2019

It sounds like that function is expecting at least one argument and you’re not passing any arguments to it.

bj.lewis221 · Feb 6th 2019

What is an example of an argument in the Sample Add-on?

it doesn't seem to work with

Code

perch_get('title')

or anything similar

drewm · Feb 6th 2019

Have you looked at the definition of that function? What does it say?

bj.lewis221 · Feb 7th 2019

Here is what is in the runtime.php

Code

function my_sample_detail($thingID, $opts=array(), $return=false)
{
$default_opts = array(
'template' => 'thing.html',
'skip-template' => false,
);
if (is_array($opts)) {
$opts = array_merge($default_opts, $opts);
}else{
$opts = $default_opts;
}
$API = new PerchAPI(1.0, 'my_sample');
$Things = new MySample_Things($API);
$Thing = $Things->find($thingID, true);
if ($opts['skip-template']) {
return $Thing->to_array();
}
$Template = $API->get('Template');
$Template->set('sample/'.$opts['template'], 'sample');
$r = $Template->render($Thing);
if ($return) return $r;
echo $r;
return false;
}

Display More

hus_hmd · Feb 7th 2019

Hi bj.lewis221

When you call my_sample_detail(), you need to pass the first argument $thingID as a minimum. Assuming you have a Thing with ID 2:

PHP

my_sample_detail(2);

bj.lewis221 · Feb 7th 2019

Thank you! I tried doing <?php $project_id = perch_get('s'); ?> previously and it didn't work I have since made changes and must have had something else making it not work

thank you thank you!

bj.lewis221 · Feb 12th 2019

Hello! Me again!

I am finally starting to get my head around this! But I have run into another snag. Sorry in advance for being a pain! Just trying to learn everything perch has to offer!

I have added a my_sample_listing_custom to the runtime.php

Code

function my_sample_listing_custom($opts=false, $return=false)
{
return my_sample_listing($opts, $return);
}

But When I do the Function on the index.php the only thing is seems to listen to is the template

Code

my_sample_listing_custom(array(
'filter' => 'thingTitle',
'match' => 'contains',
'value' => '1',
'template' => 'listing_custom.html',
'count' => '2',
));

It doesn't throw and error or anything it just returns everything as it would for my_sample_listing, except it will change to the template I specify.

What am I missing?

Again, sorry for being a pain!

hus_hmd · Feb 12th 2019

What does the function my_sample_listing() look like?

bj.lewis221 · Feb 12th 2019

This is it! TYIA!

Code

function my_sample_listing($opts=array(), $return=false)
{
$default_opts = array(
'template' => 'listing.html',
'skip-template' => false,
);
if (is_array($opts)) {
$opts = array_merge($default_opts, $opts);
}else{
$opts = $default_opts;
}
$API = new PerchAPI(1.0, 'my_sample');
$Things = new MySample_Things($API);
$list = $Things->all();
if ($opts['skip-template']) {
$out = array();
if (PerchUtil::count($list)) {
foreach($list as $item) {
$out[] = $item->to_array();
}
}
return $out;
}
$Template = $API->get('Template');
$Template->set('sample/'.$opts['template'], 'sample');
$r = $Template->render_group($list, true);
if ($return) return $r;
echo $r;
return false;
}

Display More

hus_hmd · Feb 12th 2019

You're always fetching all $Things:

PHP

$list = $Things->all();

So your filter options aren't being used when fetching $Things.

bj.lewis221 · Feb 12th 2019

hus_hmd

Thank you for pointing this out! Do you have any suggestions on how to fix this? I have tried multiple things and I just can't get it.

My full runtime.php is below

PHP

<?php
include('MySample_Things.class.php');
include('MySample_Thing.class.php');
function my_sample_listing_custom($opts=false, $return=false)
{
return my_sample_listing($opts, $return);
}
function my_sample_listing($opts=array(), $return=false)
{
$default_opts = array(
'template' => 'listing.html',
'skip-template' => false,
);
if (is_array($opts)) {
$opts = array_merge($default_opts, $opts);
}else{
$opts = $default_opts;
}
$API = new PerchAPI(1.0, 'my_sample');
$Things = new MySample_Things($API);
$list = $Things->all();
if ($opts['skip-template']) {
$out = array();
if (PerchUtil::count($list)) {
foreach($list as $item) {
$out[] = $item->to_array();
}
}
return $out;
}
$Template = $API->get('Template');
$Template->set('sample/'.$opts['template'], 'sample');
$r = $Template->render_group($list, true);
if ($return) return $r;
echo $r;
return false;
}
function my_sample_detail($thingID, $opts=array(), $return=false)
{
$default_opts = array(
'template' => 'thing.html',
'skip-template' => false,
);
if (is_array($opts)) {
$opts = array_merge($default_opts, $opts);
}else{
$opts = $default_opts;
}
$API = new PerchAPI(1.0, 'my_sample');
$Things = new MySample_Things($API);
$Thing = $Things->find($thingID, true);
if ($opts['skip-template']) {
return $Thing->to_array();
}
$Template = $API->get('Template');
$Template->set('sample/'.$opts['template'], 'sample');
$r = $Template->render($Thing);
if ($return) return $r;
echo $r;
return false;
}

Display More

hus_hmd · Feb 12th 2019

You can either write your own database queries (check the database API reference) or you can use PerchFactory's get_filtered_listing().

A simplified version of what your code could be:

PHP

$Things = new MySample_Things($API);
$filtered_things = $Things->get_filtered_listing($opts);

bj.lewis221 · Feb 12th 2019

I replaced

PHP

$Things = new MySample_Things($API);
$list = $Things->all();

with

PHP

$Things = new MySample_Things($API);
$filtered_things = $Things->get_filtered_listing($opts);

and it didn't return anything

I also tried

PHP

$filtered_things = $Things->get_filtered_listing($opts);
if ($opts['skip-template']) {
$out = array();
if (PerchUtil::count($list)) {
foreach($filtered_things as $item) {
$out[] = $item->to_array();
}
}
return $out;
}
$Template = $API->get('Template');
$Template->set('sample/'.$opts['template'], 'sample');
$r = $Template->render_group($filtered_things, true);
if ($return) return $r;
echo $r;
return false;
}

Display More

hus_hmd · Feb 12th 2019

If you enable debug mode, what does the debug message say?

You can add marks to the debug message so it's easier to spot the relevant lines:

PHP

PerchUtil::mark('Start');
$Things = new MySample_Things($API);
$filtered_things = $Things->get_filtered_listing($opts);
PerchUtil::mark('End');

You can refer to first-party apps like the Blog app to see how they handle the filtered listing. Though they may include code that isn't relevant to your app.

bj.lewis221 · Feb 12th 2019

Code

------------------------------ Start ------------------------------
[2] SELECT SQL_CALC_FOUND_ROWS DISTINCT main.* FROM perch3_my_sample_things main WHERE 1=1 ORDER BY thingDateTime ASC LIMIT 0, 2
[3] SELECT FOUND_ROWS() AS `count`
[2] Using template: /addons/apps/my_sample/templates/listing.html
------------------------------ End ------------------------------
[0] Using template: /addons/apps/my_sample/templates/sample/listing.html
Array
(
[type] => 8
[message] => Undefined variable: list
[file] => /home1/twoperc6/public_html/login/addons/apps/my_sample/runtime.php
[line] => 61
)

Display More

This is the messages that comes out

and when I change to

PHP

$Things = new MySample_Things($API);
$filtered_things = $Things->get_filtered_listing($opts);
PerchUtil::mark('End');
if ($opts['skip-template']) {
$out = array();
if (PerchUtil::count($list)) {
foreach($filtered_things as $item) {
$out[] = $item->to_array();
}
}
return $out;
}
$Template = $API->get('Template');
$Template->set('sample/'.$opts['template'], 'sample');
$r = $Template->render_group($filtered_things, true);
if ($return) return $r;
echo $r;
return false;

Display More

the debug message returns this

Code

Array
( [type] => 8 [message] => Use of undefined constant my_sample - assumed 'my_sample' [file] => /home1/twoperc6/public_html/login/config/apps.php [line] => 2
)

bj.lewis221 · Feb 13th 2019

Ok I fixed all those errors but It's still not returning anything.

Debug

Code

------------------------------ Start ------------------------------
[2] SELECT SQL_CALC_FOUND_ROWS DISTINCT main.* FROM perch3_my_sample_things main WHERE 1=1 ORDER BY thingDateTime ASC LIMIT 0, 2
[3] SELECT FOUND_ROWS() AS `count`
[2] Using template: /addons/apps/my_sample/templates/listing.html
------------------------------ End ------------------------------
[0] Using template: /addons/apps/my_sample/templates/sample/listing.html

Current runtime.php

PHP

<?php
include('MySample_Things.class.php');
include('MySample_Thing.class.php');
function my_sample_listing_custom($opts=false, $return=false)
{
return my_sample_listing($opts, $return);
}
function my_sample_listing($opts=array(), $return=false)
{
$default_opts = array(
'template' => 'listing.html',
'skip-template' => false,
);
if (is_array($opts)) {
$opts = array_merge($default_opts, $opts);
}else{
$opts = $default_opts;
}
$API = new PerchAPI(1.0, 'my_sample');
PerchUtil::mark('Start');
$Things = new MySample_Things($API);
$filtered_things = $Things->get_filtered_listing($opts);
PerchUtil::mark('End');
if ($opts['skip-template']) {
$out = array();
if (PerchUtil::count($filtered_things)) {
foreach($filtered_things as $item) {
$out[] = $item->to_array();
}
}
return $out;
}
$Template = $API->get('Template');
$Template->set('sample/'.$opts['template'], 'sample');
$r = $Template->render_group($filtered_things, true);
if ($return) return $r;
echo $r;
return false;
}
function my_sample_detail($thingID, $opts=array(), $return=false)
{
$default_opts = array(
'template' => 'thing.html',
'skip-template' => false,
);
if (is_array($opts)) {
$opts = array_merge($default_opts, $opts);
}else{
$opts = $default_opts;
}
$API = new PerchAPI(1.0, 'my_sample');
$Things = new MySample_Things($API);
$Thing = $Things->find($thingID, true);
if ($opts['skip-template']) {
return $Thing->to_array();
}
$Template = $API->get('Template');
$Template->set('sample/'.$opts['template'], 'sample');
$r = $Template->render($Thing);
if ($return) return $r;
echo $r;
return false;
}

Display More

hus_hmd · Feb 13th 2019

get_filtered_listing() should render the template for you. So you don't need to render it inside my_sample_listing().

Take it one step at a time and iterate on your changes. You've added get_filtered_listing() and you can see the database query it's making in your debug message. I'm assuming you have some rows in the table perch3_my_sample_things.

The next step for you would be to check what get_filtered_listing() returns. You're assigning what it returns to the variable $filtered_things. Inspect what this variable holds. Is it what you expect?

This may help:

PHP

if ($opts['skip-template']) {
$return = true;
}
PerchUtil::mark('Start');
$Things = new MySample_Things($API);
$filtered_things = $Things->get_filtered_listing($opts);
PerchUtil::mark('End');
if ($return) return $filtered_things;
echo $filtered_things;

Display More

bj.lewis221 · Feb 13th 2019

Its returning empty rows, its weird, its returning the right number 'things' just not returning whats in the tags

bj.lewis221 · Feb 15th 2019

So I reverted back to clean my_sample files to try and locate the issue and tried to rework with your above code. And it does return items it just returns them empty.

PHP

function my_sample_listing($opts=array(), $return=false)
{
$default_opts = array(
'template' => 'listing.html',
'skip-template' => false,
);
if (is_array($opts)) {
$opts = array_merge($default_opts, $opts);
}else{
$opts = $default_opts;
}
$API = new PerchAPI(1.0, 'my_sample');
if ($opts['skip-template']) {
$return = true;
}
PerchUtil::mark('Start');
$Things = new MySample_Things($API);
$filtered_things = $Things->get_filtered_listing($opts);
PerchUtil::mark('End');
if ($return) return $filtered_things;
echo $filtered_things;
}

Display More

Debug

SQL

SELECT main.* FROM perch3_my_sample_things main WHERE 1=1 ORDER BY thingDateTime ASC
[3] Using template: /addons/apps/my_sample/templates/listing.html

drewm Feb 5th 2019