Saved searches
Use saved searches to filter your results more quickly
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.
PHP template allows linking to any folder or file without manually navigating up directories with ../
SleekPanther/php-magic-linking
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Sign In Required
Please sign in to use Codespaces.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching Xcode
If nothing happens, download Xcode and try again.
Launching Visual Studio Code
Your codespace will open once ready.
There was a problem preparing your codespace, please try again.
Latest commit
Git stats
Files
Failed to load latest commit information.
README.md
PHP Magic Linking Template
NEVER WORRY ABOUT PUTTING ../ BEFORE LINKS EVER AGAIN!
You often store each page in a separate folder to allow more readable URLs. Instead of mySite.com/about_us_page.php , you want mySite.com/about . So put an index.php in the folder about/ ( mySite.com/about is equivalent to mySite.com/about/index.php )
You can have multiple sub-directories: a main Gallery Page mySite.com/gallery that lists the individual sub-galleries like mySite.com/gallery/indoor or mySite.com/gallery/outdoor
But you run into trouble linking between pages. Small sites can get away with index.php , about.php , gallery1.php , gallery2.php etc. in the same folder, but it’s not organized or scalable. If all pages were in the same folder, you could use 1 copy of global navigation called nav.php & use a php include to keep the navigation consistent. But nested sub-directories cause problems.
A cheater «solution» is to have a copy of nav.php for each level of directories
DON’T TRY THIS! Trust me, it’s a pain to maintain 3 copies of nav.php when you just want to change 1 link.
The Situation (Problematic Linking)
- Act as if all links start in the root folder (where theHomepageis)
- This code analyzes the URL to find how many folders below the root directory the current page is
- Add before any link
- The manual link fromAbouttoHomeHome
- Becomes Home & will work from any level directory
- Code in top.php magically prints the correct number of ../ in your link
Major Features (click link to jump to section)
- Link to any page without using ../ EVER AGAIN!
(also applies to css, images & any files on your site) - Consistent nav on all pages (using the same php include )
- Identify the current page & highlight the current link in nav menu (so the user knows where they are)
- Automatic Breadcrumb links
- Automatic Meta descriptions stored in easily-editable text file
- Tags that match the current page
- Print the page name in automatically (no hard-coding)
- Print unique IDs for each page in tags
Use css toapply styles to only 1 page
- Every viewable page should be called index.php
- But MUST HAVE UNIQUE PARENT FOLDER
(Since all pages are index.php , a file’s parent folder/containing folder is VERY important to identify the current page) - Folder names should be lowercase, NO SPACES
- Folder names BECOME thePage Title (stored in $pageTitle
- — (hyphen characters) will be replaced with / (forward-slashes)
- _ (underscores) will be replaced with spaces
- First letter of each word will be Capitalized
Example:
The folder «our_prices-services» becomes «Our Prices / Services»
Search/ Ctrl+F «convFolder2PgTitle» in top.php to edit the function. (Maybe you don’t want to replace underscores)
This Project’s Default Folder Setup (what files go where)
- The Homepage goes in your site’s root directory (default is php-magic-linking for THIS project)
- about/index.php gets its own folder since it’s on the same level of the nav as Home
- portfolio/index.php and tests/index.php are also on the same level of the nav as Home
(They’re mostly placeholder pages used for breadcrumb trails) - portfolio/portfolio_1/index.php and tests/test_1/index.php are 1-level dropdown pages
- portfolio/examples/example_1/index.php is a 2nd-level dropdown page
- images/ contains ALL images
There are many ways to organize your images, so modify as you wish - non-pages/ contains anything that ISN’T a complete page
- php-include/ has partial components that are assembled to create complete pages
- css/ has the stylesheets
- descriptions/ has a text file for Meta tag page descriptions
Finding Your Root directory ( $ROOT_DIRECTORY variable)
- Upload setup.php to your web server & view the page
- Or just view setup.php on localhost
- This tells you the containing folder (like pwd in command line ), the value you should store in $ROOT_DIRECTORY
- Some common folders are public_html or www-root
THINGS YOU MUST EDIT!
- Rename php-magic-linking to your site’s root directory(found just above)
- Edit line 12 in top.php to match
$ROOT_DIRECTORY = «php-magic-linking»; (this should match, or be changed) - IF YOUR ROOT DIRECTORY HAS A PARENT FOLDER WITH THEEXACT SAME NAME
- (e.g. $ROOT_DIRECTORY is my-folder but the complete path is mysite.com/my-folder/dev/site1/my-folder
- Notice 2 occurrences of my-folder
- Search/ Ctrl+F for the line: for ($i = 0; $i < count($split_url); $i++)
- Look 3 lines later for break;
- COMMENT OUT OR REMOVE the break;
- Every page must manually link to top.php BEFORE ANY OTHER PHP CODE!
This allows you to use $upFolderPlaceholder later in the page - Homepage link:
- 1 folder Level below homepage (e.g. /about/index.php , /portfolio/index.php etc.) is
- 2 Levels below (e.g. /portfolio/examples/index.php ) is
- 3 Levels below (e.g. /portfolio/examples/example_1/index.php ) is
- Search/ Ctrl+F «36714768356» in top.php (section to list all YOUR pages)
- Put all top-level pages (including $ROOT_DIRECTORY for Homepage) in $pageArrayTop
$pageArrayTop = array($ROOT_DIRECTORY, ‘portfolio’, ‘tests’, ‘about’); //this is the default code
Replace with your pages, EXACT FOLDER NAMES (case sensitive) - Put ALL 1st-level-dropdown pages in $pageArrayDropDown1
$pageArrayDropDown1 = array (‘portfolio_1’, ‘portfolio_2’, ‘examples’, ‘test_1’, ‘test_2’); //default code - Put ALL 2nd-level-dropdown pages in $pageArrayDropDown1
$pageArrayDropDown2 = array (‘example_1’); //default code
- ORDER DOESN’T MATTER, but don’t leave out any pages!
More Optional Things To Edit
- Replace default Favicon in images/0_components/favicon.png
images/0_components/favicon.png»> in top.php - Replace default logo in images/logo/logo.png
Search for in nav.php to see where it’s used - Update to your name/company in top.php
- Add your site’s tagline
$tagLine = » — Your Tagline»; in top.php
This appears in the tag. Like » — Wikipedia, the free encyclopedia» at the end of every Wikipedia Page - Breadcrumbs are optional. To remove: Simply delete or move the
. tag in header.php
- Add page descriptions to appear in
(You edit non-pages/descriptions/descriptions.txt JUMP TO DETAILS SECTION ⇓)
Page Structure (Anatomy of a Page, PHP Includes)
Viewable pages constructed from partials in non-pages/php-include/ as follows:
- top.php begins the HTML file. It has everything in the section & important URL magic happens here
It uses 2 php includes at the end to render nav.php and header.php - nav.php contains Global Navigation (1 copy for all pages)
- header.php can contain a Global logo, site title, slideshow, etc.
CURRENTLY IT ALSO CONTAINS Breadcrumbs. See details to remove them ⇓
tag is opened in header.php but closed in each index.php page - Unique page content goes in each index.php file (e.g. homepage, about, etc.)
Must include the Footer near end - footer.php is for any content you want at the bottom of every page
- Feel free to rearrange the php includes but make sure the tags are nested correctly
- Notably, opening in header.php , currently closed in each index.php page**
- View Page Source & look for HTML comments like and
If the PHP includes are confusing, this helps show how render the actual page
</em></li></ul><p>Consistent Navigation ( nav.php )</h3></p><p>Highlight Current Page in Nav</h3></p><ul><li>. ‘ ‘; ?>>Portfolio 1 (this is the 2nd part of the LINK FROM JUST ABOVE)</li><li>It will yield class=»activePage» <strong>if the folder in the nav matches a folder in the CURRENT URL</strong></li><li>$activePageArrayDropDown1 is created in top.php</li><li>It’s an associative array with <strong>keys</strong> matching the <em>1st-level dropdown folders</em></li><li>Its <strong>values</strong> should be empty, EXCEPT for 1 key which will have <strong>activePage</strong> stored in it</li><li>If <strong>Portfolio 1</strong> is in the path in the URL (the portfolio_1 folder ), $activePageArrayDropDown1[‘portfolio_1’] will have the value <strong>activePage</strong> stored in it</li><li><strong>Use CSS to style the activePage class background differently</strong><br/><em>currently accomplished in last lines of</em><strong>non-pages/css/menu.css</strong></li></ul><ul><li>non-pages/css/menu.less can be ignored if you aren’t familiar with .less files. Basically it’s a fancy version of CSS which is compiled to normal CSS yielding the non-pages/css/menu.css file <br/>Check out Less.js to learn more</li></ul><ul><li>Located in non-pages/php-include/header.php</li><li>Prints <strong>breadcrumbs</strong> to show how to user got to the current page (breadcrumbs explained)</li><li><strong>None appear on the</strong><em><strong>Homepage</strong></em><br/>(I mean, what’s the point. It’s the highest level page)</li><li>If you <strong>don’t</strong> want breadcrumbs, just remove the php code inside<br/><section >.</section><p> in header.php</li><li>Or move that code anywhere else to display <strong>breadcrumbs</strong> in a different location on the page</li><li><strong>I recommend keeping<br/><section >.</section><p> in some type of php include</strong> That way you only have to change 1 file (e.g. header.php ) to modify links in the future</li><li>Uses $split_url_adjusted array</li></ul><ol><li>Breaks apart the URL into folders</li><li>Starts at the beginning & prints an href link to each folder</li><li>Actual link text is found by calling the function convFolder2PgTitle() <br/>This converts a folder like portfolio_1 to a human readable title like <strong>Portfolio 1</strong> (exact rules described earlier ⇈)</li><li>The final «crumb» in the chain is the current page. This is <strong>bolded</strong>, BUT NOT A LINK!</li></ol><p>Meta Tag Page Descriptions</h3></p><ul><li>These are tags for <strong>search engines</strong></li><li><strong>Based on</strong> $pageArrayTop , $pageArrayDropDown1 , $pageArrayDropDown2 etc.</li><li><strong>SO MAKE SURE YOU ADDED ALL YOUR PAGES TO THESE ARRAYS</strong></li><li>As long as your pages are in these arrays, you just need to edit the text file</li></ul><p>non-pages/descriptions/descriptions.txt is very simple:</p><ul><li>top.php will print the human-readable Page Title (based on the containing folder)</li><li>Then it will append your tagline to the end <br/>Search for $tagLine = » — Your Tagline»; in top.php if you need to change the tagline</li><li>actually prints it</li></ul><p>Print Automatic Page Name in</p><ul><li>Similar to tags, you can just print the $pageTitle variable in an to start every page</li><li>It’s a good practice for text & for the Page Title to match. <br/>This helps search engine as well as visitors <br/><em>This is the whole purpose for the $pageTitle variable</em></li><li></li><li>This is from 1 of the index.php pages, but you choose to add it to header.php or move it elsewhere</li></ul><ul><li>Ever need to apply a css rule to <strong>just 1 specific page</strong>?</li><li>It’s easily accomplished with an <strong>ID</strong> in the tag</li><li>Since all pages are called index.php you can’t use filenames</li><li>So you <strong>use $containing_folder as the ID since they’re all unique</strong></li><li>echo »; (from the end of top.php )</li><li><strong>The $containing_folder for $ROOT_DIRECTORY (the <em>Homepage</em>) has been adjusted to «index»</strong><br/>This is to allow easy migration of the site. Nothing relies directly on the value of $ROOT_DIRECTORY, we always access it via the variable so it can easily be changed</li><li>IDs have higher CSS specificity than classes, so overriding a global rule <strong>only on the</strong><em><strong>Portfolio 1 Page</strong></em></li><li>echo »; in top.php will become</li></ul><pre><code>#portfolio_1 /*optionally add more CSS selectors here */ < /*new css rules here*/ >#index < /*CSS rules to override stuff for the HOMEPAGE only*/ ></code></pre><ul><li>This is a readme to demo <strong>usage</strong>, more detailed comments in actual code</li><li><strong>Search «454521» using Ctrl+F or Cmd+F to skip to important sections in top.php</strong></li><li>The nav menu is adapted from Pure CSS Mobile-compatible Responsive Dropdown Menu<br/>or check out My adapted version on GitHub</li></ul><h2>About</h2><p>PHP template allows linking to any folder or file without manually navigating up directories with ../</p><p><a href=){kind=logo}
Источник