mysociety / theyworkforyou

classes/Url.php

<?php
/**
 * URL Class
 *
 * @package TheyWorkForYou
 */

namespace MySociety\TheyWorkForYou;

/**
 * URL Class
 *
 * The URL class is used for generating URLs and other related things.
 * Relies on there being a get_http_var() function.
 *
 * This is probably how you'll use it most:
 *
 * ```php
 * $URL = new \MySociety\TheyWorkForYou\Url("YOURPAGENAME");
 * print $URL->generate();
 * ```
 *
 * In the metadata you should set a session_vars variable, an array.
 * The default page session_vars may be just array("debug").
 * These can then be overridden on a per-page basis.
 * Session vars are GET/POST vars that will be passed by default to that page.
 * ie, if "foo=bar" is in the current URL and you generate a URL to a page that has "foo"
 * as a session_var, "foo=bar" will be automatically added to the generated URL.
 * You can modify the session vars that will be included in the URL generated using the functions below.
 *
 * @author Phil Gyford <phil@gyford.com>
 */

class Url {
    public function __construct($pagename) {
        // Initialise.
        global $DATA;

        // The page we're going to be generating URL(s) for.
        $this->destinationpage = $pagename;

The property destinationpage does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        // These stores an associative array of key/value pairs that
        // we'll want passed on to other pages.
        $this->session_vars =  [];

The property session_vars does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        // Prevent things using $DATA running if it hasn't been set, ie in testing
        if (isset($DATA)) {

            // Set the contents of $this->session_vars.
            // session_vars are variables we generally want to pass between pages, if any.
            // Will only be added as vars if they have values.

            $keys = $DATA->page_metadata($this->destinationpage, "session_vars");
            foreach ($keys as $key) {
                if (get_http_var($key) != "") {
                    $this->session_vars[$key] = get_http_var($key);
                }
            }

            // Some pages have the same URL, modified by a "pg" variable.
            // See if this page is one such, and add the variable if so.
            if ($pg = $DATA->page_metadata($this->destinationpage, "pg")) {
                $this->session_vars["pg"] = $pg;
            }

        }

        // So we can restore the originals.
        $this->original_session_vars = $this->session_vars;

The property original_session_vars does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

    }

    /**
     * Restore Session Variables
     *
     * Restores the session variables to their state when the object was
     * instantiated.
     */

    public function restore() {
        // Call this to reset the session vars to how they were when
        // the object was instantiated.
        $this->session_vars = $this->original_session_vars;

The property session_vars does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

    }

    /**
     * Reset Session Variables
     *
     * Removes all session variables.
     */

    public function reset() {
        // Call this to remove all the session_vars.
        $this->session_vars =  [];

The property session_vars does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

    }

    /**
     * Insert Session Key/Value Pairs
     *
     * @param array $arr An associative array of key/value pairs
     */

    public function insert($arr) {
        // $arr is an associative array of key/value pairs.
        // These will be used as session_vars in addition to any that
        // already exist.
        foreach ($arr as $key => $val) {
            $this->session_vars[$key] = $val;

The property session_vars does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        }
    }

    /**
     * Remove Session Key/Value Pair
     *
     * @param array $arr A list array of key names to remove
     */

    public function remove($arr) {
        // $arr is a list array of key names. Any key/value pairs
        // in session_vars with keys found in $arr will be removed.
        foreach ($arr as $key) {
            if (isset($this->session_vars[$key])) {
                unset($this->session_vars[$key]);
            }
        }
    }

    /**
     * Update Values
     *
     * Any keys in session_vars that are also in $arr
     * will have their values overwritten by those in $arr.
     * Other session_var key/vals are not affected.
     *
     * @param array $arr An associative array of key/value pairs.
     */

    public function update($arr) {
        //
        //
        foreach ($arr as $key => $val) {
            if (isset($this->session_vars[$key])) {
                $this->session_vars[$key] = $arr[$key];

The property session_vars does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

            }
        }
    }

    /**
     * Generate URL
     *
     * Generate a URL to the page specified with session vars.
     *
     * @param string encode       "html" will make the URL suitable for inclusion

The type MySociety\TheyWorkForYou\encode was not found. Maybe you did not declare it correctly or list all dependencies?

     *                            in a page directly, "none" will leave it alone,
     *                            "url" will do exactly the same.
     * @param array  overrideVars A key=>value mapping which allows some specific

The type MySociety\TheyWorkForYou\overrideVars was not found. Maybe you did not declare it correctly or list all dependencies?

     *                            variable/value pairs to be overridden/inserted
     *                            into the query. Use this when you want to keep
     *                            the standard 'session vars' in a url, but
     *                            override just one or two of them.
     */

    public function generate($encode = "html", $overrideVars = []) {

        global $DATA;

        $url_args =  [];

        foreach (array_merge($this->session_vars, $overrideVars) as $key => $var) {
            if (is_array($var)) {
                foreach ($var as $v) {
                    $url_args[] = "$key=" . urlencode(stripslashes($v));
                }
            } elseif ($var != null) {
                $url_args[] = "$key=" . urlencode(stripslashes($var));
            }
        }

        $page_url = WEBPATH . $DATA->page_metadata($this->destinationpage, "url");

        if (sizeof($url_args) == 0) {
            return $page_url;
        } else {
            if ($encode == "html") {
                return $page_url . "?" . implode("&", $url_args);
            } elseif ($encode == "none" || $encode == "url") {
                return $page_url . "?" . implode("&", $url_args);
            }
        }
    }

    /**
     * Generate a URL for the social image with the given header and subheader.
     *
     * @param string $header The header text for the social image.
     * @param string $subheader The subheader text for the social image.
     * @param string $parliament The parliament to use (default is "uk").
     * @return string The URL to the generated social image.
     */
    public static function generateSocialImageUrl(string $header, string $subheader = "", string $parliament = "uk"): string {

        function chamber_to_parliament($chamber) {
            switch ($chamber) {
                case 'uk-commons':
                    return 'uk';
                case 'uk-lords':
                    return 'uk';
                case 'wales':
                    return 'senedd';
                case 'house-of-commons':
                    return 'uk';
                case 'scottish-parliament':
                    return 'scotland';
                case 'senedd':
                    return 'senedd';
                case 'northern-ireland-assembly':
                    return 'ni';
                default:
                    return $chamber;
            }
        }

        $parliament = chamber_to_parliament($parliament);

        $protocol = 'https://';
        if (defined('DEVSITE') && DEVSITE) {

The constant MySociety\TheyWorkForYou\DEVSITE was not found. Maybe you did not declare it correctly or list all dependencies?

            $protocol = 'http://';
        }
        // Update the path for the social image URL
        $base_url = $protocol . DOMAIN . '/opengraph/image.php';

        // Generate a hash for validation
        $hash = substr(hash_hmac('sha256', $header . $subheader, OPENGRAPH_IMAGE_SALT), 0, 10);

The constant MySociety\TheyWorkForYou\OPENGRAPH_IMAGE_SALT was not found. Maybe you did not declare it correctly or list all dependencies?

        // Append the truncated hash to the query parameters
        $query = http_build_query(['heading' => $header,
            'subheading' => $subheader,
            'parl' => $parliament,
            'hash' => $hash]);

        return $base_url . '?' . $query;
    }

}